1 /***************************************************************************
2 * Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at> *
3 * Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
25 #include <config-nepomuk.h>
27 #include "libdolphin_export.h"
29 #include <kparts/part.h>
30 #include <kfileitem.h>
31 #include <kfileitemdelegate.h>
32 #include <kio/fileundomanager.h>
37 #include <QLinkedList>
41 class DolphinController
;
42 class DolphinColumnView
;
43 class DolphinDetailsView
;
44 class DolphinFileItemDelegate
;
45 class DolphinIconsView
;
46 class DolphinMainWindow
;
48 class DolphinSortFilterProxyModel
;
49 class KFilePreviewGenerator
;
51 class KActionCollection
;
60 * @short Represents a view for the directory content.
62 * View modes for icons, details and columns are supported. It's
69 * @see DolphinIconsView
70 * @see DolphinDetailsView
71 * @see DolphinColumnView
73 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
79 * Defines the view mode for a directory. The view mode
80 * can be defined when constructing a DolphinView. The
81 * view mode is automatically updated if the directory itself
82 * defines a view mode (see class ViewProperties for details).
87 * The directory items are shown as icons including an
93 * The icon, the name and at least the size of the directory
94 * items are shown in a table. It is possible to add columns
95 * for date, group and permissions.
100 * Each folder is shown in a separate column.
103 MaxModeEnum
= ColumnView
106 /** Defines the sort order for the items of a directory. */
118 MaxSortEnum
= SortByTags
122 * @param parent Parent widget of the view.
123 * @param url Specifies the content which should be shown.
124 * @param dirLister Used directory lister. The lister is not owned
125 * by the view and won't get deleted.
126 * @param dolphinModel Used directory model. The model is not owned
127 * by the view and won't get deleted.
128 * @param proxyModel Used proxy model which specifies the sorting. The
129 * model is not owned by the view and won't get
132 DolphinView(QWidget
* parent
,
134 KDirLister
* dirLister
,
135 DolphinModel
* dolphinModel
,
136 DolphinSortFilterProxyModel
* proxyModel
);
138 virtual ~DolphinView();
141 * Returns the current active URL, where all actions are applied.
142 * The URL navigator is synchronized with this URL.
144 const KUrl
& url() const;
147 * Returns the root URL of the view, which is defined as the first
148 * visible path of DolphinView::url(). Usually the root URL is
149 * equal to DolphinView::url(), but in the case of the column view
150 * when 2 columns are shown, the root URL might be:
151 * /home/peter/Documents
152 * and DolphinView::url() might return
153 * /home/peter/Documents/Music/
155 KUrl
rootUrl() const;
158 * If \a active is true, the view will marked as active. The active
159 * view is defined as view where all actions are applied to.
161 void setActive(bool active
);
162 bool isActive() const;
165 * Changes the view mode for the current directory to \a mode.
166 * If the view properties should be remembered for each directory
167 * (GeneralSettings::globalViewProps() returns false), then the
168 * changed view mode will be stored automatically.
170 void setMode(Mode mode
);
173 /** See setShowPreview */
174 bool showPreview() const;
176 /** See setShowHiddenFiles */
177 bool showHiddenFiles() const;
179 /** See setCategorizedSorting */
180 bool categorizedSorting() const;
183 * Returns true, if the categorized sorting is supported by the current
184 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
185 * supports categorizations. To check whether the categorized
186 * sorting is set, use DolphinView::categorizedSorting().
188 bool supportsCategorizedSorting() const;
192 * @see DolphinView::selectedItems()
197 * Inverts the current selection: selected items get unselected,
198 * unselected items get selected.
199 * @see DolphinView::selectedItems()
201 void invertSelection();
203 /** Returns true, if at least one item is selected. */
204 bool hasSelection() const;
206 void clearSelection();
209 * Returns the selected items. The list is empty if no item has been
211 * @see DolphinView::selectedUrls()
213 KFileItemList
selectedItems() const;
216 * Returns a list of URLs for all selected items. An empty list
217 * is returned, if no item is selected.
218 * @see DolphinView::selectedItems()
220 KUrl::List
selectedUrls() const;
223 * Returns the number of selected items (this is faster than
224 * invoking selectedItems().count()).
226 int selectedItemsCount() const;
229 * Sets the upper left position of the view content
230 * to (x,y). The content of the view might be larger than the visible area
231 * and hence a scrolling must be done.
233 void setContentsPosition(int x
, int y
);
235 /** Returns the upper left position of the view content. */
236 QPoint
contentsPosition() const;
239 * Sets the zoom level to \a level. It is assured that the used
240 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
241 * ZoomLevelInfo::maximumLevel().
243 void setZoomLevel(int level
);
244 int zoomLevel() const;
247 * Returns true, if zooming in is possible. If false is returned,
248 * the maximum zooming level has been reached.
250 bool isZoomInPossible() const;
253 * Returns true, if zooming out is possible. If false is returned,
254 * the minimum zooming level has been reached.
256 bool isZoomOutPossible() const;
258 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
259 void setSorting(Sorting sorting
);
261 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
262 Sorting
sorting() const;
264 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
265 void setSortOrder(Qt::SortOrder order
);
267 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
268 Qt::SortOrder
sortOrder() const;
270 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
271 void setSortFoldersFirst(bool foldersFirst
);
273 /** Returns if files and folders are sorted separately or not. */
274 bool sortFoldersFirst() const;
276 /** Sets the additional information which should be shown for the items. */
277 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
279 /** Returns the additional information which should be shown for the items. */
280 KFileItemDelegate::InformationList
additionalInfo() const;
282 /** Reloads the current directory. */
286 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
287 * This method only needs to get invoked if the view settings for the Icons View,
288 * Details View or Columns View have been changed.
293 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
294 * properties from \a url are used for adjusting the view mode and the other properties.
295 * If \a rootUrl is not empty, the view properties from the root URL are considered
296 * instead. Specifying a root URL is only required if a view having a different root URL
297 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
298 * is enough for changing the current URL.
300 void updateView(const KUrl
& url
, const KUrl
& rootUrl
);
303 * Filters the currently shown items by \a nameFilter. All items
304 * which contain the given filter string will be shown.
306 void setNameFilter(const QString
& nameFilter
);
309 * Calculates the number of currently shown files into
310 * \a fileCount and the number of folders into \a folderCount.
311 * The size of all files is written into \a totalFileSize.
312 * It is recommend using this method instead of asking the
313 * directory lister or the model directly, as it takes
314 * filtering and hierarchical previews into account.
316 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
319 * Returns a textual representation of the state of the current
320 * folder or selected items, suitable for use in the status bar.
322 QString
statusBarText() const;
325 * Updates the state of the 'Additional Information' actions in \a collection.
327 void updateAdditionalInfoActions(KActionCollection
* collection
);
330 * Returns the state of the paste action:
331 * first is whether the action should be enabled
332 * second is the text for the action
334 QPair
<bool, QString
> pasteInfo() const;
337 * If \a tabsForFiles is true, the signal tabRequested() will also
338 * emitted also for files. Per default tabs for files is disabled
339 * and hence the signal tabRequested() will only be emitted for
342 void setTabsForFilesEnabled(bool tabsForFiles
);
343 bool isTabsForFilesEnabled() const;
346 * Returns true if the current view allows folders to be expanded,
347 * i.e. presents a hierarchical view to the user.
349 bool itemsExpandable() const;
353 * Changes the directory to \a url. If the current directory is equal to
354 * \a url, nothing will be done (use DolphinView::reload() instead).
356 void setUrl(const KUrl
& url
);
359 * Request of a selection change. The view will do its best to accommodate
360 * the request, but it is not guaranteed that all items in \a selection
361 * will actually get selected. The view will e.g. not select items which
362 * are not in the currently displayed folder.
364 void changeSelection(const KFileItemList
& selection
);
367 * Triggers the renaming of the currently selected items, where
368 * the user must input a new name for the items.
370 void renameSelectedItems();
373 * Moves all selected items to the trash.
375 void trashSelectedItems();
378 * Deletes all selected items.
380 void deleteSelectedItems();
383 * Copies all selected items to the clipboard and marks
384 * the items as cutted.
386 void cutSelectedItems();
388 /** Copies all selected items to the clipboard. */
389 void copySelectedItems();
391 /** Pastes the clipboard data to this view. */
395 * Pastes the clipboard data into the currently selected
396 * folder. If the current selection is not exactly one folder, no
397 * paste operation is done.
399 void pasteIntoFolder();
402 * Turns on the file preview for the all files of the current directory,
403 * if \a show is true.
404 * If the view properties should be remembered for each directory
405 * (GeneralSettings::globalViewProps() returns false), then the
406 * preview setting will be stored automatically.
408 void setShowPreview(bool show
);
411 * Shows all hidden files of the current directory,
412 * if \a show is true.
413 * If the view properties should be remembered for each directory
414 * (GeneralSettings::globalViewProps() returns false), then the
415 * show hidden file setting will be stored automatically.
417 void setShowHiddenFiles(bool show
);
420 * Summarizes all sorted items by their category \a categorized
422 * If the view properties should be remembered for each directory
423 * (GeneralSettings::globalViewProps() returns false), then the
424 * categorized sorting setting will be stored automatically.
426 void setCategorizedSorting(bool categorized
);
428 /** Switches between an ascending and descending sorting order. */
429 void toggleSortOrder();
431 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
432 void toggleSortFoldersFirst();
435 * Switches on or off the displaying of additional information
436 * as specified by \a action.
438 void toggleAdditionalInfo(QAction
* action
);
442 * Is emitted if the view has been activated by e. g. a mouse click.
446 /** Is emitted if URL of the view has been changed to \a url. */
447 void urlChanged(const KUrl
& url
);
450 * Is emitted if the view requests a changing of the current
451 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
453 void requestUrlChange(const KUrl
& url
);
456 * Is emitted when clicking on an item with the left mouse button.
458 void itemTriggered(const KFileItem
& item
);
461 * Is emitted if a new tab should be opened for the URL \a url.
463 void tabRequested(const KUrl
& url
);
466 * Is emitted if the view mode (IconsView, DetailsView,
467 * PreviewsView) has been changed.
471 /** Is emitted if the 'show preview' property has been changed. */
472 void showPreviewChanged();
474 /** Is emitted if the 'show hidden files' property has been changed. */
475 void showHiddenFilesChanged();
477 /** Is emitted if the 'categorized sorting' property has been changed. */
478 void categorizedSortingChanged();
480 /** Is emitted if the sorting by name, size or date has been changed. */
481 void sortingChanged(DolphinView::Sorting sorting
);
483 /** Is emitted if the sort order (ascending or descending) has been changed. */
484 void sortOrderChanged(Qt::SortOrder order
);
486 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
487 void sortFoldersFirstChanged(bool foldersFirst
);
489 /** Is emitted if the additional information shown for this view has been changed. */
490 void additionalInfoChanged();
492 /** Is emitted if the zoom level has been changed by zooming in or out. */
493 void zoomLevelChanged(int level
);
496 * Is emitted if information of an item is requested to be shown e. g. in the panel.
497 * If item is null, no item information request is pending.
499 void requestItemInfo(const KFileItem
& item
);
501 /** Is emitted if the contents has been moved to \a x, \a y. */
502 void contentsMoved(int x
, int y
);
505 * Is emitted whenever the selection has been changed.
507 void selectionChanged(const KFileItemList
& selection
);
510 * Is emitted if a context menu is requested for the item \a item,
511 * which is part of \a url. If the item is null, the context menu
512 * for the URL should be shown and the custom actions \a customActions
515 void requestContextMenu(const KFileItem
& item
,
517 const QList
<QAction
*>& customActions
);
520 * Is emitted if an information message with the content \a msg
523 void infoMessage(const QString
& msg
);
526 * Is emitted if an error message with the content \a msg
529 void errorMessage(const QString
& msg
);
532 * Is emitted if an "operation completed" message with the content \a msg
535 void operationCompletedMessage(const QString
& msg
);
538 * Is emitted after DolphinView::setUrl() has been invoked and
539 * the path \a url is currently loaded. If this signal is emitted,
540 * it is assured that the view contains already the correct root
541 * URL and property settings.
543 void startedPathLoading(const KUrl
& url
);
546 * Emitted when KDirLister emits redirection.
547 * Testcase: fish://localhost
549 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
552 /** @see QWidget::mouseReleaseEvent */
553 virtual void mouseReleaseEvent(QMouseEvent
* event
);
554 virtual void wheelEvent(QWheelEvent
* event
);
555 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
559 * Marks the view as active (DolphinView:isActive() will return true)
560 * and emits the 'activated' signal if it is not already active.
565 * If the item \a item is a directory, then this
566 * directory will be loaded. If the item is a file, the corresponding
567 * application will get started.
569 void triggerItem(const KFileItem
& index
);
571 void emitSelectionChangedSignal();
574 * Opens the context menu on position \a pos. The position
575 * is used to check whether the context menu is related to an
576 * item or to the viewport.
578 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
581 * Drops dragged URLs to the destination path \a destPath. If
582 * the URLs are dropped above an item inside the destination path,
583 * the item is indicated by \a destItem.
585 void dropUrls(const KFileItem
& destItem
,
586 const KUrl
& destPath
,
590 * Updates the view properties of the current URL to the
591 * sorting given by \a sorting.
593 void updateSorting(DolphinView::Sorting sorting
);
596 * Updates the view properties of the current URL to the
597 * sort order given by \a order.
599 void updateSortOrder(Qt::SortOrder order
);
602 * Updates the view properties of the current URL to the
603 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
605 void updateSortFoldersFirst(bool foldersFirst
);
608 * Updates the view properties of the current URL to the
609 * additional information given by \a info.
611 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
614 * Emits the signal contentsMoved with the current coordinates
615 * of the viewport as parameters.
617 void emitContentsMoved();
620 * Updates the status bar to show hover information for the
621 * item \a item. If currently other items are selected,
622 * no hover information is shown.
623 * @see DolphinView::clearHoverInformation()
625 void showHoverInformation(const KFileItem
& item
);
628 * Clears the hover information shown in the status bar.
629 * @see DolphinView::showHoverInformation().
631 void clearHoverInformation();
634 * Indicates in the status bar that the delete operation
635 * of the job \a job has been finished.
637 void slotDeleteFileFinished(KJob
* job
);
640 * Is emitted if the controller requests a changing of the current
643 void slotRequestUrlChange(const KUrl
& url
);
646 * Restores the current item (= item that has the keyboard focus)
647 * to m_currentItemUrl.
649 void restoreCurrentItem();
652 * Is invoked when the KDirLister indicates refreshed items.
654 void slotRefreshItems();
657 * If \a view can be positively identified as not being the source for the
658 * current drag operation, deleteLater() it immediately. Else stores
659 * it for later deletion.
661 void deleteWhenNotDragSource(QAbstractItemView
* view
);
664 * Observes the item with the URL \a url. As soon as the directory
665 * model indicates that the item is available, the item will
666 * get selected and it is assure that the item stays visible.
668 * @see selectAndScrollToCreatedItem()
670 void observeCreatedItem(const KUrl
& url
);
673 * Selects and scrolls to the item that got observed
674 * by observeCreatedItem().
676 void selectAndScrollToCreatedItem();
679 * Restore selection after view refresh.
681 void restoreSelection();
684 void loadDirectory(const KUrl
& url
, bool reload
= false);
687 * Returns the URL where the view properties should be stored. Usually
688 * DolphinView::url() is returned, but in the case of a Column View the
689 * view properties are always stored in the directory represented by the
690 * first column. It is recommendend whenever using the ViewProperties class
691 * to use DolphinView::viewPropertiesUrl() as URL.
693 KUrl
viewPropertiesUrl() const;
696 * Applies the view properties which are defined by the current URL
697 * m_url to the DolphinView properties.
699 void applyViewProperties(const KUrl
& url
);
702 * Creates a new view representing the given view mode (DolphinView::mode()).
703 * The current view will get deleted.
710 * Returns a pointer to the currently used item view, which is either
711 * a ListView or a TreeView.
713 QAbstractItemView
* itemView() const;
716 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
717 * Pastes the clipboard data into the URL \a url.
719 void pasteToUrl(const KUrl
& url
);
722 * Checks whether the current item view has the same zoom level
723 * as \a oldZoomLevel. If this is not the case, the zoom level
724 * of the controller is updated and a zoomLevelChanged() signal
727 void updateZoomLevel(int oldZoomLevel
);
730 * Returns a list of URLs for all selected items. The list is
731 * simplified, so that when the URLs are part of different tree
732 * levels, only the parent is returned.
734 KUrl::List
simplifiedSelectedUrls() const;
737 * Returns true, if the ColumnView is activated. As the column view
738 * requires some special handling for iterating through directories,
739 * this method has been introduced for convenience.
741 bool isColumnViewActive() const;
744 * Returns the MIME data for all selected items.
746 QMimeData
* selectionMimeData() const;
750 bool m_showPreview
: 1;
751 bool m_loadingDirectory
: 1;
752 bool m_storedCategorizedSorting
: 1;
753 bool m_tabsForFiles
: 1;
754 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
755 bool m_ignoreViewProperties
: 1;
756 bool m_assureVisibleCurrentIndex
: 1;
760 DolphinMainWindow
* m_mainWindow
;
761 QVBoxLayout
* m_topLayout
;
763 DolphinController
* m_controller
;
764 DolphinIconsView
* m_iconsView
;
765 DolphinDetailsView
* m_detailsView
;
766 DolphinColumnView
* m_columnView
;
767 DolphinFileItemDelegate
* m_fileItemDelegate
;
768 QItemSelectionModel
* m_selectionModel
;
770 DolphinModel
* m_dolphinModel
;
771 KDirLister
* m_dirLister
;
772 DolphinSortFilterProxyModel
* m_proxyModel
;
774 KFilePreviewGenerator
* m_previewGenerator
;
775 ToolTipManager
* m_toolTipManager
;
778 KUrl m_currentItemUrl
;
779 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
780 KFileItemList m_selectedItems
; //this is used for making the View to remember selections after F5
782 QAbstractItemView
* m_expandedDragSource
;
785 inline bool DolphinView::isColumnViewActive() const
787 return m_columnView
!= 0;
790 /// Allow using DolphinView::Mode in QVariant
791 Q_DECLARE_METATYPE(DolphinView::Mode
)
793 #endif // DOLPHINVIEW_H