1 /***************************************************************************
2 * Copyright (C) 2006-2009 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 DolphinColumnViewContainer
;
46 class DolphinDetailsView
;
47 class DolphinIconsView
;
49 class DolphinSortFilterProxyModel
;
50 class KFilePreviewGenerator
;
52 class KActionCollection
;
56 class DolphinDetailsViewExpander
;
59 * @short Represents a view for the directory content.
61 * View modes for icons, details and columns are supported. It's
68 * @see DolphinIconsView
69 * @see DolphinDetailsView
70 * @see DolphinColumnView
72 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
78 * Defines the view mode for a directory. The view mode
79 * can be defined when constructing a DolphinView. The
80 * view mode is automatically updated if the directory itself
81 * defines a view mode (see class ViewProperties for details).
86 * The directory items are shown as icons including an
92 * The icon, the name and at least the size of the directory
93 * items are shown in a table. It is possible to add columns
94 * for date, group and permissions.
99 * Each folder is shown in a separate column.
102 MaxModeEnum
= ColumnView
105 /** Defines the sort order for the items of a directory. */
115 MaxSortEnum
= SortByType
119 * @param parent Parent widget of the view.
120 * @param url Specifies the content which should be shown.
121 * @param proxyModel Used proxy model which specifies the sorting. The
122 * model is not owned by the view and won't get
125 DolphinView(QWidget
* parent
,
127 DolphinSortFilterProxyModel
* proxyModel
);
129 virtual ~DolphinView();
132 * Returns the current active URL, where all actions are applied.
133 * The URL navigator is synchronized with this URL.
135 const KUrl
& url() const;
138 * Returns the root URL of the view, which is defined as the first
139 * visible path of DolphinView::url(). Usually the root URL is
140 * equal to DolphinView::url(), but in the case of the column view
141 * when 2 columns are shown, the root URL might be:
142 * /home/peter/Documents
143 * and DolphinView::url() might return
144 * /home/peter/Documents/Music/
146 KUrl
rootUrl() const;
149 * If \a active is true, the view will marked as active. The active
150 * view is defined as view where all actions are applied to.
152 void setActive(bool active
);
153 bool isActive() const;
156 * Changes the view mode for the current directory to \a mode.
157 * If the view properties should be remembered for each directory
158 * (GeneralSettings::globalViewProps() returns false), then the
159 * changed view mode will be stored automatically.
161 void setMode(Mode mode
);
164 /** See setShowPreview */
165 bool showPreview() const;
167 /** See setShowHiddenFiles */
168 bool showHiddenFiles() const;
170 /** See setCategorizedSorting */
171 bool categorizedSorting() const;
174 * Returns true, if the categorized sorting is supported by the current
175 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
176 * supports categorizations. To check whether the categorized
177 * sorting is set, use DolphinView::categorizedSorting().
179 bool supportsCategorizedSorting() const;
182 * Marks the items indicated by \p urls to get selected after the
183 * directory DolphinView::url() has been loaded. Note that nothing
184 * gets selected if no loading of a directory has been triggered
185 * by DolphinView::setUrl() or DolphinView::reload().
187 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
190 * Returns the selected items. The list is empty if no item has been
192 * @see DolphinView::selectedUrls()
194 KFileItemList
selectedItems() const;
197 * Returns a list of URLs for all selected items. An empty list
198 * is returned, if no item is selected.
199 * @see DolphinView::selectedItems()
201 KUrl::List
selectedUrls() const;
204 * Returns the number of selected items (this is faster than
205 * invoking selectedItems().count()).
207 int selectedItemsCount() const;
209 QItemSelectionModel
* selectionModel() const;
212 * Sets the upper left position of the view content
213 * to (x,y). The content of the view might be larger than the visible area
214 * and hence a scrolling must be done.
216 void setContentsPosition(int x
, int y
);
219 * Sets the upper left position of the view content
220 * to (x,y) after the directory loading is finished.
221 * This is useful when going back or forward in history.
223 void setRestoredContentsPosition(const QPoint
& pos
);
225 /** Returns the upper left position of the view content. */
226 QPoint
contentsPosition() const;
229 * Sets the zoom level to \a level. It is assured that the used
230 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
231 * ZoomLevelInfo::maximumLevel().
233 void setZoomLevel(int level
);
234 int zoomLevel() const;
237 * Returns true, if zooming in is possible. If false is returned,
238 * the maximum zooming level has been reached.
240 bool isZoomInPossible() const;
243 * Returns true, if zooming out is possible. If false is returned,
244 * the minimum zooming level has been reached.
246 bool isZoomOutPossible() const;
248 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
249 void setSorting(Sorting sorting
);
251 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
252 Sorting
sorting() const;
254 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
255 void setSortOrder(Qt::SortOrder order
);
257 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
258 Qt::SortOrder
sortOrder() const;
260 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
261 void setSortFoldersFirst(bool foldersFirst
);
263 /** Returns if files and folders are sorted separately or not. */
264 bool sortFoldersFirst() const;
266 /** Sets the additional information which should be shown for the items. */
267 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
269 /** Returns the additional information which should be shown for the items. */
270 KFileItemDelegate::InformationList
additionalInfo() const;
272 /** Reloads the current directory. */
276 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
277 * This method only needs to get invoked if the view settings for the Icons View,
278 * Details View or Columns View have been changed.
283 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
284 * properties from \a url are used for adjusting the view mode and the other properties.
285 * If \a rootUrl is not empty, the view properties from the root URL are considered
286 * instead. Specifying a root URL is only required if a view having a different root URL
287 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
288 * is enough for changing the current URL.
290 void updateView(const KUrl
& url
, const KUrl
& rootUrl
);
293 * Filters the currently shown items by \a nameFilter. All items
294 * which contain the given filter string will be shown.
296 void setNameFilter(const QString
& nameFilter
);
299 * Calculates the number of currently shown files into
300 * \a fileCount and the number of folders into \a folderCount.
301 * The size of all files is written into \a totalFileSize.
302 * It is recommend using this method instead of asking the
303 * directory lister or the model directly, as it takes
304 * filtering and hierarchical previews into account.
306 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
309 * Returns a textual representation of the state of the current
310 * folder or selected items, suitable for use in the status bar.
312 QString
statusBarText() const;
315 * Returns the version control actions that are provided for the items \p items.
316 * Usually the actions are presented in the context menu.
318 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
321 * Updates the state of the 'Additional Information' actions in \a collection.
323 void updateAdditionalInfoActions(KActionCollection
* collection
);
326 * Returns the state of the paste action:
327 * first is whether the action should be enabled
328 * second is the text for the action
330 QPair
<bool, QString
> pasteInfo() const;
333 * If \a tabsForFiles is true, the signal tabRequested() will also
334 * emitted also for files. Per default tabs for files is disabled
335 * and hence the signal tabRequested() will only be emitted for
338 void setTabsForFilesEnabled(bool tabsForFiles
);
339 bool isTabsForFilesEnabled() const;
342 * Marks the item \a url as active item as soon as it has
343 * been loaded by the directory lister. This is useful mark
344 * the previously visited directory as active when going
345 * back in history (the URL is known, but the item is not
348 void activateItem(const KUrl
& url
);
351 * Returns true if the current view allows folders to be expanded,
352 * i.e. presents a hierarchical view to the user.
354 bool itemsExpandable() const;
357 * Restores the view state (current item, contents position, details view expansion state)
359 void restoreState(QDataStream
&stream
);
362 * Saves the view state (current item, contents position, details view expansion state)
364 void saveState(QDataStream
&stream
);
368 * Changes the directory to \a url. If the current directory is equal to
369 * \a url, nothing will be done (use DolphinView::reload() instead).
371 void setUrl(const KUrl
& url
);
375 * @see DolphinView::selectedItems()
380 * Inverts the current selection: selected items get unselected,
381 * unselected items get selected.
382 * @see DolphinView::selectedItems()
384 void invertSelection();
386 /** Returns true, if at least one item is selected. */
387 bool hasSelection() const;
389 void clearSelection();
392 * Triggers the renaming of the currently selected items, where
393 * the user must input a new name for the items.
395 void renameSelectedItems();
398 * Moves all selected items to the trash.
400 void trashSelectedItems();
403 * Deletes all selected items.
405 void deleteSelectedItems();
408 * Copies all selected items to the clipboard and marks
411 void cutSelectedItems();
413 /** Copies all selected items to the clipboard. */
414 void copySelectedItems();
416 /** Pastes the clipboard data to this view. */
420 * Pastes the clipboard data into the currently selected
421 * folder. If the current selection is not exactly one folder, no
422 * paste operation is done.
424 void pasteIntoFolder();
427 * Turns on the file preview for the all files of the current directory,
428 * if \a show is true.
429 * If the view properties should be remembered for each directory
430 * (GeneralSettings::globalViewProps() returns false), then the
431 * preview setting will be stored automatically.
433 void setShowPreview(bool show
);
436 * Shows all hidden files of the current directory,
437 * if \a show is true.
438 * If the view properties should be remembered for each directory
439 * (GeneralSettings::globalViewProps() returns false), then the
440 * show hidden file setting will be stored automatically.
442 void setShowHiddenFiles(bool show
);
445 * Summarizes all sorted items by their category \a categorized
447 * If the view properties should be remembered for each directory
448 * (GeneralSettings::globalViewProps() returns false), then the
449 * categorized sorting setting will be stored automatically.
451 void setCategorizedSorting(bool categorized
);
453 /** Switches between an ascending and descending sorting order. */
454 void toggleSortOrder();
456 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
457 void toggleSortFoldersFirst();
460 * Switches on or off the displaying of additional information
461 * as specified by \a action.
463 void toggleAdditionalInfo(QAction
* action
);
467 * Is emitted if the view has been activated by e. g. a mouse click.
471 /** Is emitted if URL of the view has been changed to \a url. */
472 void urlChanged(const KUrl
& url
);
475 * Is emitted if the view requests a changing of the current
476 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
478 void requestUrlChange(const KUrl
& url
);
481 * Is emitted when clicking on an item with the left mouse button.
483 void itemTriggered(const KFileItem
& item
);
486 * Is emitted if a new tab should be opened for the URL \a url.
488 void tabRequested(const KUrl
& url
);
491 * Is emitted if the view mode (IconsView, DetailsView,
492 * PreviewsView) has been changed.
496 /** Is emitted if the 'show preview' property has been changed. */
497 void showPreviewChanged();
499 /** Is emitted if the 'show hidden files' property has been changed. */
500 void showHiddenFilesChanged();
502 /** Is emitted if the 'categorized sorting' property has been changed. */
503 void categorizedSortingChanged();
505 /** Is emitted if the sorting by name, size or date has been changed. */
506 void sortingChanged(DolphinView::Sorting sorting
);
508 /** Is emitted if the sort order (ascending or descending) has been changed. */
509 void sortOrderChanged(Qt::SortOrder order
);
511 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
512 void sortFoldersFirstChanged(bool foldersFirst
);
514 /** Is emitted if the additional information shown for this view has been changed. */
515 void additionalInfoChanged();
517 /** Is emitted if the zoom level has been changed by zooming in or out. */
518 void zoomLevelChanged(int level
);
521 * Is emitted if information of an item is requested to be shown e. g. in the panel.
522 * If item is null, no item information request is pending.
524 void requestItemInfo(const KFileItem
& item
);
526 /** Is emitted if the contents has been moved to \a x, \a y. */
527 void contentsMoved(int x
, int y
);
530 * Is emitted whenever the selection has been changed.
532 void selectionChanged(const KFileItemList
& selection
);
535 * Is emitted if a context menu is requested for the item \a item,
536 * which is part of \a url. If the item is null, the context menu
537 * for the URL should be shown and the custom actions \a customActions
540 void requestContextMenu(const KFileItem
& item
,
542 const QList
<QAction
*>& customActions
);
545 * Is emitted if an information message with the content \a msg
548 void infoMessage(const QString
& msg
);
551 * Is emitted if an error message with the content \a msg
554 void errorMessage(const QString
& msg
);
557 * Is emitted if an "operation completed" message with the content \a msg
560 void operationCompletedMessage(const QString
& msg
);
563 * Is emitted after DolphinView::setUrl() has been invoked and
564 * the path \a url is currently loaded. If this signal is emitted,
565 * it is assured that the view contains already the correct root
566 * URL and property settings.
568 void startedPathLoading(const KUrl
& url
);
571 * Emitted when KDirLister emits redirection.
572 * Testcase: fish://localhost
574 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
577 /** @see QWidget::mouseReleaseEvent */
578 virtual void mouseReleaseEvent(QMouseEvent
* event
);
579 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
583 * Marks the view as active (DolphinView:isActive() will return true)
584 * and emits the 'activated' signal if it is not already active.
589 * If the item \a item is a directory, then this
590 * directory will be loaded. If the item is a file, the corresponding
591 * application will get started.
593 void triggerItem(const KFileItem
& index
);
596 * Emits the signal \a selectionChanged() with a small delay. This is
597 * because getting all file items for the signal can be an expensive
598 * operation. Fast selection changes are collected in this case and
599 * the signal is emitted only after no selection change has been done
600 * within a small delay.
602 void slotSelectionChanged(const QItemSelection
& selected
, const QItemSelection
& deselected
);
605 * Is called by emitDelayedSelectionChangedSignal() and emits the
606 * signal \a selectionChanged() with all selected file items as parameter.
608 void emitSelectionChangedSignal();
611 * Opens the context menu on position \a pos. The position
612 * is used to check whether the context menu is related to an
613 * item or to the viewport.
615 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
618 * Drops dragged URLs to the destination path \a destPath. If
619 * the URLs are dropped above an item inside the destination path,
620 * the item is indicated by \a destItem.
622 void dropUrls(const KFileItem
& destItem
,
623 const KUrl
& destPath
,
627 * Updates the view properties of the current URL to the
628 * sorting given by \a sorting.
630 void updateSorting(DolphinView::Sorting sorting
);
633 * Updates the view properties of the current URL to the
634 * sort order given by \a order.
636 void updateSortOrder(Qt::SortOrder order
);
639 * Updates the view properties of the current URL to the
640 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
642 void updateSortFoldersFirst(bool foldersFirst
);
645 * Updates the view properties of the current URL to the
646 * additional information given by \a info.
648 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
651 * Emits the signal contentsMoved with the current coordinates
652 * of the viewport as parameters.
654 void emitContentsMoved();
657 * Updates the status bar to show hover information for the
658 * item \a item. If currently other items are selected,
659 * no hover information is shown.
660 * @see DolphinView::clearHoverInformation()
662 void showHoverInformation(const KFileItem
& item
);
665 * Clears the hover information shown in the status bar.
666 * @see DolphinView::showHoverInformation().
668 void clearHoverInformation();
671 * Indicates in the status bar that the delete operation
672 * of the job \a job has been finished.
674 void slotDeleteFileFinished(KJob
* job
);
677 * Is emitted if the controller requests a changing of the current
680 void slotRequestUrlChange(const KUrl
& url
);
683 * Invoked when the directory lister has completed the loading of
684 * items. Assures that pasted items and renamed items get seleced.
686 void slotDirListerCompleted();
689 * Invoked when the loading of the directory is finished.
690 * Restores the active item and the scroll position if possible.
692 void slotLoadingCompleted();
695 * Is invoked when the KDirLister indicates refreshed items.
697 void slotRefreshItems();
700 * Observes the item with the URL \a url. As soon as the directory
701 * model indicates that the item is available, the item will
702 * get selected and it is assure that the item stays visible.
704 * @see selectAndScrollToCreatedItem()
706 void observeCreatedItem(const KUrl
& url
);
709 * Selects and scrolls to the item that got observed
710 * by observeCreatedItem().
712 void selectAndScrollToCreatedItem();
715 * Called when a redirection happens.
716 * Testcase: fish://localhost
718 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
721 * Restores the contents position, if history information about the old position is available.
723 void restoreContentsPosition();
726 void loadDirectory(const KUrl
& url
, bool reload
= false);
729 * Applies the view properties which are defined by the current URL
730 * to the DolphinView properties.
732 void applyViewProperties();
735 * Creates a new view representing the given view mode (DolphinView::mode()).
736 * The current view will get deleted.
743 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
744 * Pastes the clipboard data into the URL \a url.
746 void pasteToUrl(const KUrl
& url
);
749 * Checks whether the current item view has the same zoom level
750 * as \a oldZoomLevel. If this is not the case, the zoom level
751 * of the controller is updated and a zoomLevelChanged() signal
754 void updateZoomLevel(int oldZoomLevel
);
757 * Returns a list of URLs for all selected items. The list is
758 * simplified, so that when the URLs are part of different tree
759 * levels, only the parent is returned.
761 KUrl::List
simplifiedSelectedUrls() const;
764 * Returns the MIME data for all selected items.
766 QMimeData
* selectionMimeData() const;
769 * Is invoked after a paste operation or a drag & drop
770 * operation and adds the filenames of all URLs from \a mimeData to
771 * m_newFileNames. This allows to select all newly added
772 * items in slotDirListerCompleted().
774 void addNewFileNames(const QMimeData
* mimeData
);
778 * Abstracts the access to the different view implementations
779 * for icons-, details- and column-view.
784 ViewAccessor(DolphinSortFilterProxyModel
* proxyModel
);
787 void createView(QWidget
* parent
, DolphinController
* controller
, Mode mode
);
791 * Must be invoked before the URL has been changed and allows view implementations
792 * like the column view to create a new column.
794 void prepareUrlChange(const KUrl
& url
);
796 QAbstractItemView
* itemView() const;
797 KFileItemDelegate
* itemDelegate() const;
800 * Returns the widget that should be added to the layout as target. Usually
801 * the item view itself is returned, but in the case of the column view
802 * a container widget is returned.
804 QWidget
* layoutTarget() const;
806 KUrl
rootUrl() const;
807 KDirLister
* rootDirLister() const;
809 bool supportsCategorizedSorting() const;
810 bool itemsExpandable() const;
811 QSet
<KUrl
> expandedUrls() const;
812 const DolphinDetailsViewExpander
* setExpandedUrls(const QSet
<KUrl
>& urlsToExpand
);
815 * Returns true, if a reloading of the items is required
816 * when the additional information properties have been changed
819 bool reloadOnAdditionalInfoChange() const;
821 DolphinModel
* dirModel() const;
822 DolphinSortFilterProxyModel
* proxyModel() const;
823 KDirLister
* dirLister() const;
826 DolphinIconsView
* m_iconsView
;
827 DolphinDetailsView
* m_detailsView
;
828 DolphinColumnViewContainer
* m_columnsContainer
;
829 DolphinSortFilterProxyModel
* m_proxyModel
;
830 QAbstractItemView
* m_dragSource
;
831 QPointer
<DolphinDetailsViewExpander
> m_detailsViewExpander
;
835 bool m_showPreview
: 1;
836 bool m_loadingDirectory
: 1;
837 bool m_storedCategorizedSorting
: 1;
838 bool m_tabsForFiles
: 1;
839 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
840 bool m_ignoreViewProperties
: 1;
841 bool m_assureVisibleCurrentIndex
: 1;
842 bool m_expanderActive
: 1;
846 QVBoxLayout
* m_topLayout
;
848 DolphinController
* m_controller
;
849 ViewAccessor m_viewAccessor
;
851 QItemSelectionModel
* m_selectionModel
; // allow to switch views without losing the selection
852 QTimer
* m_selectionChangedTimer
;
855 KUrl m_activeItemUrl
;
856 QPoint m_restoredContentsPosition
;
857 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
858 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
861 * Remembers the filenames that have been added by a paste operation
862 * or a drag & drop operation. Allows to select the items in
863 * slotDirListerCompleted().
865 QSet
<QString
> m_newFileNames
;
868 /// Allow using DolphinView::Mode in QVariant
869 Q_DECLARE_METATYPE(DolphinView::Mode
)
871 #endif // DOLPHINVIEW_H