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>
42 typedef KIO::FileUndoManager::CommandType CommandType
;
44 class DolphinController
;
45 class DolphinColumnView
;
46 class DolphinDetailsView
;
47 class DolphinFileItemDelegate
;
48 class DolphinIconsView
;
49 class DolphinMainWindow
;
51 class DolphinSortFilterProxyModel
;
52 class KFilePreviewGenerator
;
54 class KActionCollection
;
58 class RevisionControlObserver
;
64 * @short Represents a view for the directory content.
66 * View modes for icons, details and columns are supported. It's
73 * @see DolphinIconsView
74 * @see DolphinDetailsView
75 * @see DolphinColumnView
77 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
83 * Defines the view mode for a directory. The view mode
84 * can be defined when constructing a DolphinView. The
85 * view mode is automatically updated if the directory itself
86 * defines a view mode (see class ViewProperties for details).
91 * The directory items are shown as icons including an
97 * The icon, the name and at least the size of the directory
98 * items are shown in a table. It is possible to add columns
99 * for date, group and permissions.
104 * Each folder is shown in a separate column.
107 MaxModeEnum
= ColumnView
110 /** Defines the sort order for the items of a directory. */
122 MaxSortEnum
= SortByTags
126 * @param parent Parent widget of the view.
127 * @param url Specifies the content which should be shown.
128 * @param dirLister Used directory lister. The lister is not owned
129 * by the view and won't get deleted.
130 * @param dolphinModel Used directory model. The model is not owned
131 * by the view and won't get deleted.
132 * @param proxyModel Used proxy model which specifies the sorting. The
133 * model is not owned by the view and won't get
136 DolphinView(QWidget
* parent
,
138 KDirLister
* dirLister
,
139 DolphinModel
* dolphinModel
,
140 DolphinSortFilterProxyModel
* proxyModel
);
142 virtual ~DolphinView();
145 * Returns the current active URL, where all actions are applied.
146 * The URL navigator is synchronized with this URL.
148 const KUrl
& url() const;
151 * Returns the root URL of the view, which is defined as the first
152 * visible path of DolphinView::url(). Usually the root URL is
153 * equal to DolphinView::url(), but in the case of the column view
154 * when 2 columns are shown, the root URL might be:
155 * /home/peter/Documents
156 * and DolphinView::url() might return
157 * /home/peter/Documents/Music/
159 KUrl
rootUrl() const;
162 * If \a active is true, the view will marked as active. The active
163 * view is defined as view where all actions are applied to.
165 void setActive(bool active
);
166 bool isActive() const;
169 * Changes the view mode for the current directory to \a mode.
170 * If the view properties should be remembered for each directory
171 * (GeneralSettings::globalViewProps() returns false), then the
172 * changed view mode will be stored automatically.
174 void setMode(Mode mode
);
177 /** See setShowPreview */
178 bool showPreview() const;
180 /** See setShowHiddenFiles */
181 bool showHiddenFiles() const;
183 /** See setCategorizedSorting */
184 bool categorizedSorting() const;
187 * Returns true, if the categorized sorting is supported by the current
188 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
189 * supports categorizations. To check whether the categorized
190 * sorting is set, use DolphinView::categorizedSorting().
192 bool supportsCategorizedSorting() const;
196 * @see DolphinView::selectedItems()
201 * Inverts the current selection: selected items get unselected,
202 * unselected items get selected.
203 * @see DolphinView::selectedItems()
205 void invertSelection();
207 /** Returns true, if at least one item is selected. */
208 bool hasSelection() const;
210 void clearSelection();
213 * Returns the selected items. The list is empty if no item has been
215 * @see DolphinView::selectedUrls()
217 KFileItemList
selectedItems() const;
220 * Returns a list of URLs for all selected items. An empty list
221 * is returned, if no item is selected.
222 * @see DolphinView::selectedItems()
224 KUrl::List
selectedUrls() const;
227 * Returns the number of selected items (this is faster than
228 * invoking selectedItems().count()).
230 int selectedItemsCount() const;
233 * Sets the upper left position of the view content
234 * to (x,y). The content of the view might be larger than the visible area
235 * and hence a scrolling must be done.
237 void setContentsPosition(int x
, int y
);
239 /** Returns the upper left position of the view content. */
240 QPoint
contentsPosition() const;
243 * Sets the zoom level to \a level. It is assured that the used
244 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
245 * ZoomLevelInfo::maximumLevel().
247 void setZoomLevel(int level
);
248 int zoomLevel() const;
251 * Returns true, if zooming in is possible. If false is returned,
252 * the maximum zooming level has been reached.
254 bool isZoomInPossible() const;
257 * Returns true, if zooming out is possible. If false is returned,
258 * the minimum zooming level has been reached.
260 bool isZoomOutPossible() const;
262 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
263 void setSorting(Sorting sorting
);
265 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
266 Sorting
sorting() const;
268 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
269 void setSortOrder(Qt::SortOrder order
);
271 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
272 Qt::SortOrder
sortOrder() const;
274 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
275 void setSortFoldersFirst(bool foldersFirst
);
277 /** Returns if files and folders are sorted separately or not. */
278 bool sortFoldersFirst() const;
280 /** Sets the additional information which should be shown for the items. */
281 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
283 /** Returns the additional information which should be shown for the items. */
284 KFileItemDelegate::InformationList
additionalInfo() const;
286 /** Reloads the current directory. */
290 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
291 * This method only needs to get invoked if the view settings for the Icons View,
292 * Details View or Columns View have been changed.
297 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
298 * properties from \a url are used for adjusting the view mode and the other properties.
299 * If \a rootUrl is not empty, the view properties from the root URL are considered
300 * instead. Specifying a root URL is only required if a view having a different root URL
301 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
302 * is enough for changing the current URL.
304 void updateView(const KUrl
& url
, const KUrl
& rootUrl
);
307 * Filters the currently shown items by \a nameFilter. All items
308 * which contain the given filter string will be shown.
310 void setNameFilter(const QString
& nameFilter
);
313 * Calculates the number of currently shown files into
314 * \a fileCount and the number of folders into \a folderCount.
315 * The size of all files is written into \a totalFileSize.
316 * It is recommend using this method instead of asking the
317 * directory lister or the model directly, as it takes
318 * filtering and hierarchical previews into account.
320 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
323 * Returns a textual representation of the state of the current
324 * folder or selected items, suitable for use in the status bar.
326 QString
statusBarText() const;
329 * Returns the revision control actions that are provided for the items \p items.
330 * Usually the actions are presented in the context menu.
332 QList
<QAction
*> revisionControlActions(const KFileItemList
& items
) const;
335 * Updates the state of the 'Additional Information' actions in \a collection.
337 void updateAdditionalInfoActions(KActionCollection
* collection
);
340 * Returns the state of the paste action:
341 * first is whether the action should be enabled
342 * second is the text for the action
344 QPair
<bool, QString
> pasteInfo() const;
347 * If \a tabsForFiles is true, the signal tabRequested() will also
348 * emitted also for files. Per default tabs for files is disabled
349 * and hence the signal tabRequested() will only be emitted for
352 void setTabsForFilesEnabled(bool tabsForFiles
);
353 bool isTabsForFilesEnabled() const;
356 * Marks the item \a url as active item as soon as it has
357 * been loaded by the directory lister. This is useful mark
358 * the previously visited directory as active when going
359 * back in history (the URL is known, but the item is not
362 void activateItem(const KUrl
& url
);
365 * Returns true if the current view allows folders to be expanded,
366 * i.e. presents a hierarchical view to the user.
368 bool itemsExpandable() const;
372 * Changes the directory to \a url. If the current directory is equal to
373 * \a url, nothing will be done (use DolphinView::reload() instead).
375 void setUrl(const KUrl
& url
);
378 * Request of a selection change. The view will do its best to accommodate
379 * the request, but it is not guaranteed that all items in \a selection
380 * will actually get selected. The view will e.g. not select items which
381 * are not in the currently displayed folder.
383 void changeSelection(const KFileItemList
& selection
);
386 * Triggers the renaming of the currently selected items, where
387 * the user must input a new name for the items.
389 void renameSelectedItems();
392 * Moves all selected items to the trash.
394 void trashSelectedItems();
397 * Deletes all selected items.
399 void deleteSelectedItems();
402 * Copies all selected items to the clipboard and marks
403 * the items as cutted.
405 void cutSelectedItems();
407 /** Copies all selected items to the clipboard. */
408 void copySelectedItems();
410 /** Pastes the clipboard data to this view. */
414 * Pastes the clipboard data into the currently selected
415 * folder. If the current selection is not exactly one folder, no
416 * paste operation is done.
418 void pasteIntoFolder();
421 * Turns on the file preview for the all files of the current directory,
422 * if \a show is true.
423 * If the view properties should be remembered for each directory
424 * (GeneralSettings::globalViewProps() returns false), then the
425 * preview setting will be stored automatically.
427 void setShowPreview(bool show
);
430 * Shows all hidden files of the current directory,
431 * if \a show is true.
432 * If the view properties should be remembered for each directory
433 * (GeneralSettings::globalViewProps() returns false), then the
434 * show hidden file setting will be stored automatically.
436 void setShowHiddenFiles(bool show
);
439 * Summarizes all sorted items by their category \a categorized
441 * If the view properties should be remembered for each directory
442 * (GeneralSettings::globalViewProps() returns false), then the
443 * categorized sorting setting will be stored automatically.
445 void setCategorizedSorting(bool categorized
);
447 /** Switches between an ascending and descending sorting order. */
448 void toggleSortOrder();
450 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
451 void toggleSortFoldersFirst();
454 * Switches on or off the displaying of additional information
455 * as specified by \a action.
457 void toggleAdditionalInfo(QAction
* action
);
461 * Is emitted if the view has been activated by e. g. a mouse click.
465 /** Is emitted if URL of the view has been changed to \a url. */
466 void urlChanged(const KUrl
& url
);
469 * Is emitted if the view requests a changing of the current
470 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
472 void requestUrlChange(const KUrl
& url
);
475 * Is emitted when clicking on an item with the left mouse button.
477 void itemTriggered(const KFileItem
& item
);
480 * Is emitted if a new tab should be opened for the URL \a url.
482 void tabRequested(const KUrl
& url
);
485 * Is emitted if the view mode (IconsView, DetailsView,
486 * PreviewsView) has been changed.
490 /** Is emitted if the 'show preview' property has been changed. */
491 void showPreviewChanged();
493 /** Is emitted if the 'show hidden files' property has been changed. */
494 void showHiddenFilesChanged();
496 /** Is emitted if the 'categorized sorting' property has been changed. */
497 void categorizedSortingChanged();
499 /** Is emitted if the sorting by name, size or date has been changed. */
500 void sortingChanged(DolphinView::Sorting sorting
);
502 /** Is emitted if the sort order (ascending or descending) has been changed. */
503 void sortOrderChanged(Qt::SortOrder order
);
505 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
506 void sortFoldersFirstChanged(bool foldersFirst
);
508 /** Is emitted if the additional information shown for this view has been changed. */
509 void additionalInfoChanged();
511 /** Is emitted if the zoom level has been changed by zooming in or out. */
512 void zoomLevelChanged(int level
);
515 * Is emitted if information of an item is requested to be shown e. g. in the panel.
516 * If item is null, no item information request is pending.
518 void requestItemInfo(const KFileItem
& item
);
520 /** Is emitted if the contents has been moved to \a x, \a y. */
521 void contentsMoved(int x
, int y
);
524 * Is emitted whenever the selection has been changed.
526 void selectionChanged(const KFileItemList
& selection
);
529 * Is emitted if a context menu is requested for the item \a item,
530 * which is part of \a url. If the item is null, the context menu
531 * for the URL should be shown and the custom actions \a customActions
534 void requestContextMenu(const KFileItem
& item
,
536 const QList
<QAction
*>& customActions
);
539 * Is emitted if an information message with the content \a msg
542 void infoMessage(const QString
& msg
);
545 * Is emitted if an error message with the content \a msg
548 void errorMessage(const QString
& msg
);
551 * Is emitted if an "operation completed" message with the content \a msg
554 void operationCompletedMessage(const QString
& msg
);
557 * Is emitted after DolphinView::setUrl() has been invoked and
558 * the path \a url is currently loaded. If this signal is emitted,
559 * it is assured that the view contains already the correct root
560 * URL and property settings.
562 void startedPathLoading(const KUrl
& url
);
565 * Emitted when KDirLister emits redirection.
566 * Testcase: fish://localhost
568 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
571 /** @see QWidget::mouseReleaseEvent */
572 virtual void mouseReleaseEvent(QMouseEvent
* event
);
573 virtual void wheelEvent(QWheelEvent
* event
);
574 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
578 * Marks the view as active (DolphinView:isActive() will return true)
579 * and emits the 'activated' signal if it is not already active.
584 * If the item \a item is a directory, then this
585 * directory will be loaded. If the item is a file, the corresponding
586 * application will get started.
588 void triggerItem(const KFileItem
& index
);
591 * Emits the signal \a selectionChanged() with a small delay. This is
592 * because getting all file items for the signal can be an expensive
593 * operation. Fast selection changes are collected in this case and
594 * the signal is emitted only after no selection change has been done
595 * within a small delay.
597 void emitDelayedSelectionChangedSignal();
600 * Is called by emitDelayedSelectionChangedSignal() and emits the
601 * signal \a selectionChanged() with all selected file items as parameter.
603 void emitSelectionChangedSignal();
606 * Opens the context menu on position \a pos. The position
607 * is used to check whether the context menu is related to an
608 * item or to the viewport.
610 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
613 * Drops dragged URLs to the destination path \a destPath. If
614 * the URLs are dropped above an item inside the destination path,
615 * the item is indicated by \a destItem.
617 void dropUrls(const KFileItem
& destItem
,
618 const KUrl
& destPath
,
622 * Updates the view properties of the current URL to the
623 * sorting given by \a sorting.
625 void updateSorting(DolphinView::Sorting sorting
);
628 * Updates the view properties of the current URL to the
629 * sort order given by \a order.
631 void updateSortOrder(Qt::SortOrder order
);
634 * Updates the view properties of the current URL to the
635 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
637 void updateSortFoldersFirst(bool foldersFirst
);
640 * Updates the view properties of the current URL to the
641 * additional information given by \a info.
643 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
646 * Emits the signal contentsMoved with the current coordinates
647 * of the viewport as parameters.
649 void emitContentsMoved();
652 * Updates the status bar to show hover information for the
653 * item \a item. If currently other items are selected,
654 * no hover information is shown.
655 * @see DolphinView::clearHoverInformation()
657 void showHoverInformation(const KFileItem
& item
);
660 * Clears the hover information shown in the status bar.
661 * @see DolphinView::showHoverInformation().
663 void clearHoverInformation();
666 * Indicates in the status bar that the delete operation
667 * of the job \a job has been finished.
669 void slotDeleteFileFinished(KJob
* job
);
672 * Is emitted if the controller requests a changing of the current
675 void slotRequestUrlChange(const KUrl
& url
);
678 * Invoked when the directory lister has completed the loading of
679 * items. Assures that pasted items and renamed items get seleced.
681 void slotDirListerCompleted();
684 * Is invoked when the KDirLister indicates refreshed items.
686 void slotRefreshItems();
689 * If \a view can be positively identified as not being the source for the
690 * current drag operation, deleteLater() it immediately. Else stores
691 * it for later deletion.
693 void deleteWhenNotDragSource(QAbstractItemView
* view
);
696 * Observes the item with the URL \a url. As soon as the directory
697 * model indicates that the item is available, the item will
698 * get selected and it is assure that the item stays visible.
700 * @see selectAndScrollToCreatedItem()
702 void observeCreatedItem(const KUrl
& url
);
705 * Selects and scrolls to the item that got observed
706 * by observeCreatedItem().
708 void selectAndScrollToCreatedItem();
711 * Restore selection after view refresh.
713 void restoreSelection();
716 void loadDirectory(const KUrl
& url
, bool reload
= false);
719 * Returns the URL where the view properties should be stored. Usually
720 * DolphinView::url() is returned, but in the case of a Column View the
721 * view properties are always stored in the directory represented by the
722 * first column. It is recommendend whenever using the ViewProperties class
723 * to use DolphinView::viewPropertiesUrl() as URL.
725 KUrl
viewPropertiesUrl() const;
728 * Applies the view properties which are defined by the current URL
729 * m_url to the DolphinView properties.
731 void applyViewProperties(const KUrl
& url
);
734 * Creates a new view representing the given view mode (DolphinView::mode()).
735 * The current view will get deleted.
742 * Returns a pointer to the currently used item view, which is either
743 * a ListView or a TreeView.
745 QAbstractItemView
* itemView() const;
748 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
749 * Pastes the clipboard data into the URL \a url.
751 void pasteToUrl(const KUrl
& url
);
754 * Checks whether the current item view has the same zoom level
755 * as \a oldZoomLevel. If this is not the case, the zoom level
756 * of the controller is updated and a zoomLevelChanged() signal
759 void updateZoomLevel(int oldZoomLevel
);
762 * Returns a list of URLs for all selected items. The list is
763 * simplified, so that when the URLs are part of different tree
764 * levels, only the parent is returned.
766 KUrl::List
simplifiedSelectedUrls() const;
769 * Returns true, if the ColumnView is activated. As the column view
770 * requires some special handling for iterating through directories,
771 * this method has been introduced for convenience.
773 bool isColumnViewActive() const;
776 * Returns the MIME data for all selected items.
778 QMimeData
* selectionMimeData() const;
781 * Is invoked after a paste operation or a drag & drop
782 * operation and adds the filenames of all URLs from \a mimeData to
783 * m_newFileNames. This allows to select all newly added
784 * items in slotDirListerCompleted().
786 void addNewFileNames(const QMimeData
* mimeData
);
790 bool m_showPreview
: 1;
791 bool m_loadingDirectory
: 1;
792 bool m_storedCategorizedSorting
: 1;
793 bool m_tabsForFiles
: 1;
794 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
795 bool m_ignoreViewProperties
: 1;
796 bool m_assureVisibleCurrentIndex
: 1;
800 DolphinMainWindow
* m_mainWindow
;
801 QVBoxLayout
* m_topLayout
;
803 DolphinController
* m_controller
;
804 DolphinIconsView
* m_iconsView
;
805 DolphinDetailsView
* m_detailsView
;
806 DolphinColumnView
* m_columnView
;
807 DolphinFileItemDelegate
* m_fileItemDelegate
;
809 QItemSelectionModel
* m_selectionModel
;
810 QTimer
* m_selectionChangedTimer
;
812 DolphinModel
* m_dolphinModel
;
813 KDirLister
* m_dirLister
;
814 DolphinSortFilterProxyModel
* m_proxyModel
;
816 KFilePreviewGenerator
* m_previewGenerator
;
817 ToolTipManager
* m_toolTipManager
;
819 RevisionControlObserver
* m_revisionControlObserver
;
822 KUrl m_activeItemUrl
;
823 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
824 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
827 * Remembers the filenames that have been added by a paste operation
828 * or a drag & drop operation. Allows to select the items in
829 * slotDirListerCompleted().
831 QSet
<QString
> m_newFileNames
;
833 QAbstractItemView
* m_expandedDragSource
;
836 inline bool DolphinView::isColumnViewActive() const
838 return m_columnView
!= 0;
841 /// Allow using DolphinView::Mode in QVariant
842 Q_DECLARE_METATYPE(DolphinView::Mode
)
844 #endif // DOLPHINVIEW_H