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
;
48 class DolphinMainWindow
;
50 class DolphinSortFilterProxyModel
;
51 class KFilePreviewGenerator
;
53 class KActionCollection
;
57 class DolphinDetailsViewExpander
;
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 proxyModel Used proxy model which specifies the sorting. The
125 * model is not owned by the view and won't get
128 DolphinView(QWidget
* parent
,
130 DolphinSortFilterProxyModel
* proxyModel
);
132 virtual ~DolphinView();
135 * Returns the current active URL, where all actions are applied.
136 * The URL navigator is synchronized with this URL.
138 const KUrl
& url() const;
141 * Returns the root URL of the view, which is defined as the first
142 * visible path of DolphinView::url(). Usually the root URL is
143 * equal to DolphinView::url(), but in the case of the column view
144 * when 2 columns are shown, the root URL might be:
145 * /home/peter/Documents
146 * and DolphinView::url() might return
147 * /home/peter/Documents/Music/
149 KUrl
rootUrl() const;
152 * If \a active is true, the view will marked as active. The active
153 * view is defined as view where all actions are applied to.
155 void setActive(bool active
);
156 bool isActive() const;
159 * Changes the view mode for the current directory to \a mode.
160 * If the view properties should be remembered for each directory
161 * (GeneralSettings::globalViewProps() returns false), then the
162 * changed view mode will be stored automatically.
164 void setMode(Mode mode
);
167 /** See setShowPreview */
168 bool showPreview() const;
170 /** See setShowHiddenFiles */
171 bool showHiddenFiles() const;
173 /** See setCategorizedSorting */
174 bool categorizedSorting() const;
177 * Returns true, if the categorized sorting is supported by the current
178 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
179 * supports categorizations. To check whether the categorized
180 * sorting is set, use DolphinView::categorizedSorting().
182 bool supportsCategorizedSorting() const;
185 * Returns the selected items. The list is empty if no item has been
187 * @see DolphinView::selectedUrls()
189 KFileItemList
selectedItems() const;
192 * Returns a list of URLs for all selected items. An empty list
193 * is returned, if no item is selected.
194 * @see DolphinView::selectedItems()
196 KUrl::List
selectedUrls() const;
199 * Returns the number of selected items (this is faster than
200 * invoking selectedItems().count()).
202 int selectedItemsCount() const;
204 QItemSelectionModel
* selectionModel() const;
207 * Sets the upper left position of the view content
208 * to (x,y). The content of the view might be larger than the visible area
209 * and hence a scrolling must be done.
211 void setContentsPosition(int x
, int y
);
214 * Sets the upper left position of the view content
215 * to (x,y) after the directory loading is finished.
216 * This is useful when going back or forward in history.
218 void setRestoredContentsPosition(const QPoint
& pos
);
220 /** Returns the upper left position of the view content. */
221 QPoint
contentsPosition() const;
224 * Sets the zoom level to \a level. It is assured that the used
225 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
226 * ZoomLevelInfo::maximumLevel().
228 void setZoomLevel(int level
);
229 int zoomLevel() const;
232 * Returns true, if zooming in is possible. If false is returned,
233 * the maximum zooming level has been reached.
235 bool isZoomInPossible() const;
238 * Returns true, if zooming out is possible. If false is returned,
239 * the minimum zooming level has been reached.
241 bool isZoomOutPossible() const;
243 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
244 void setSorting(Sorting sorting
);
246 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
247 Sorting
sorting() const;
249 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
250 void setSortOrder(Qt::SortOrder order
);
252 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
253 Qt::SortOrder
sortOrder() const;
255 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
256 void setSortFoldersFirst(bool foldersFirst
);
258 /** Returns if files and folders are sorted separately or not. */
259 bool sortFoldersFirst() const;
261 /** Sets the additional information which should be shown for the items. */
262 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
264 /** Returns the additional information which should be shown for the items. */
265 KFileItemDelegate::InformationList
additionalInfo() const;
267 /** Reloads the current directory. */
271 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
272 * This method only needs to get invoked if the view settings for the Icons View,
273 * Details View or Columns View have been changed.
278 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
279 * properties from \a url are used for adjusting the view mode and the other properties.
280 * If \a rootUrl is not empty, the view properties from the root URL are considered
281 * instead. Specifying a root URL is only required if a view having a different root URL
282 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
283 * is enough for changing the current URL.
285 void updateView(const KUrl
& url
, const KUrl
& rootUrl
);
288 * Filters the currently shown items by \a nameFilter. All items
289 * which contain the given filter string will be shown.
291 void setNameFilter(const QString
& nameFilter
);
294 * Calculates the number of currently shown files into
295 * \a fileCount and the number of folders into \a folderCount.
296 * The size of all files is written into \a totalFileSize.
297 * It is recommend using this method instead of asking the
298 * directory lister or the model directly, as it takes
299 * filtering and hierarchical previews into account.
301 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
304 * Returns a textual representation of the state of the current
305 * folder or selected items, suitable for use in the status bar.
307 QString
statusBarText() const;
310 * Returns the version control actions that are provided for the items \p items.
311 * Usually the actions are presented in the context menu.
313 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
316 * Updates the state of the 'Additional Information' actions in \a collection.
318 void updateAdditionalInfoActions(KActionCollection
* collection
);
321 * Returns the state of the paste action:
322 * first is whether the action should be enabled
323 * second is the text for the action
325 QPair
<bool, QString
> pasteInfo() const;
328 * If \a tabsForFiles is true, the signal tabRequested() will also
329 * emitted also for files. Per default tabs for files is disabled
330 * and hence the signal tabRequested() will only be emitted for
333 void setTabsForFilesEnabled(bool tabsForFiles
);
334 bool isTabsForFilesEnabled() const;
337 * Marks the item \a url as active item as soon as it has
338 * been loaded by the directory lister. This is useful mark
339 * the previously visited directory as active when going
340 * back in history (the URL is known, but the item is not
343 void activateItem(const KUrl
& url
);
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;
352 * Restores the view state (current item, contents position, details view expansion state)
354 void restoreState(QDataStream
&stream
);
357 * Saves the view state (current item, contents position, details view expansion state)
359 void saveState(QDataStream
&stream
);
363 * Changes the directory to \a url. If the current directory is equal to
364 * \a url, nothing will be done (use DolphinView::reload() instead).
366 void setUrl(const KUrl
& url
);
370 * @see DolphinView::selectedItems()
375 * Inverts the current selection: selected items get unselected,
376 * unselected items get selected.
377 * @see DolphinView::selectedItems()
379 void invertSelection();
381 /** Returns true, if at least one item is selected. */
382 bool hasSelection() const;
384 void clearSelection();
387 * Request of a selection change. The view will do its best to accommodate
388 * the request, but it is not guaranteed that all items in \a selection
389 * will actually get selected. The view will e.g. not select items which
390 * are not in the currently displayed folder.
392 void changeSelection(const KFileItemList
& selection
);
395 * Triggers the renaming of the currently selected items, where
396 * the user must input a new name for the items.
398 void renameSelectedItems();
401 * Moves all selected items to the trash.
403 void trashSelectedItems();
406 * Deletes all selected items.
408 void deleteSelectedItems();
411 * Copies all selected items to the clipboard and marks
414 void cutSelectedItems();
416 /** Copies all selected items to the clipboard. */
417 void copySelectedItems();
419 /** Pastes the clipboard data to this view. */
423 * Pastes the clipboard data into the currently selected
424 * folder. If the current selection is not exactly one folder, no
425 * paste operation is done.
427 void pasteIntoFolder();
430 * Turns on the file preview for the all 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 * preview setting will be stored automatically.
436 void setShowPreview(bool show
);
439 * Shows all hidden files of the current directory,
440 * if \a show is true.
441 * If the view properties should be remembered for each directory
442 * (GeneralSettings::globalViewProps() returns false), then the
443 * show hidden file setting will be stored automatically.
445 void setShowHiddenFiles(bool show
);
448 * Summarizes all sorted items by their category \a categorized
450 * If the view properties should be remembered for each directory
451 * (GeneralSettings::globalViewProps() returns false), then the
452 * categorized sorting setting will be stored automatically.
454 void setCategorizedSorting(bool categorized
);
456 /** Switches between an ascending and descending sorting order. */
457 void toggleSortOrder();
459 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
460 void toggleSortFoldersFirst();
463 * Switches on or off the displaying of additional information
464 * as specified by \a action.
466 void toggleAdditionalInfo(QAction
* action
);
470 * Is emitted if the view has been activated by e. g. a mouse click.
474 /** Is emitted if URL of the view has been changed to \a url. */
475 void urlChanged(const KUrl
& url
);
478 * Is emitted if the view requests a changing of the current
479 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
481 void requestUrlChange(const KUrl
& url
);
484 * Is emitted when clicking on an item with the left mouse button.
486 void itemTriggered(const KFileItem
& item
);
489 * Is emitted if a new tab should be opened for the URL \a url.
491 void tabRequested(const KUrl
& url
);
494 * Is emitted if the view mode (IconsView, DetailsView,
495 * PreviewsView) has been changed.
499 /** Is emitted if the 'show preview' property has been changed. */
500 void showPreviewChanged();
502 /** Is emitted if the 'show hidden files' property has been changed. */
503 void showHiddenFilesChanged();
505 /** Is emitted if the 'categorized sorting' property has been changed. */
506 void categorizedSortingChanged();
508 /** Is emitted if the sorting by name, size or date has been changed. */
509 void sortingChanged(DolphinView::Sorting sorting
);
511 /** Is emitted if the sort order (ascending or descending) has been changed. */
512 void sortOrderChanged(Qt::SortOrder order
);
514 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
515 void sortFoldersFirstChanged(bool foldersFirst
);
517 /** Is emitted if the additional information shown for this view has been changed. */
518 void additionalInfoChanged();
520 /** Is emitted if the zoom level has been changed by zooming in or out. */
521 void zoomLevelChanged(int level
);
524 * Is emitted if information of an item is requested to be shown e. g. in the panel.
525 * If item is null, no item information request is pending.
527 void requestItemInfo(const KFileItem
& item
);
529 /** Is emitted if the contents has been moved to \a x, \a y. */
530 void contentsMoved(int x
, int y
);
533 * Is emitted whenever the selection has been changed.
535 void selectionChanged(const KFileItemList
& selection
);
538 * Is emitted if a context menu is requested for the item \a item,
539 * which is part of \a url. If the item is null, the context menu
540 * for the URL should be shown and the custom actions \a customActions
543 void requestContextMenu(const KFileItem
& item
,
545 const QList
<QAction
*>& customActions
);
548 * Is emitted if an information message with the content \a msg
551 void infoMessage(const QString
& msg
);
554 * Is emitted if an error message with the content \a msg
557 void errorMessage(const QString
& msg
);
560 * Is emitted if an "operation completed" message with the content \a msg
563 void operationCompletedMessage(const QString
& msg
);
566 * Is emitted after DolphinView::setUrl() has been invoked and
567 * the path \a url is currently loaded. If this signal is emitted,
568 * it is assured that the view contains already the correct root
569 * URL and property settings.
571 void startedPathLoading(const KUrl
& url
);
574 * Emitted when KDirLister emits redirection.
575 * Testcase: fish://localhost
577 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
580 /** @see QWidget::mouseReleaseEvent */
581 virtual void mouseReleaseEvent(QMouseEvent
* event
);
582 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
586 * Marks the view as active (DolphinView:isActive() will return true)
587 * and emits the 'activated' signal if it is not already active.
592 * If the item \a item is a directory, then this
593 * directory will be loaded. If the item is a file, the corresponding
594 * application will get started.
596 void triggerItem(const KFileItem
& index
);
599 * Emits the signal \a selectionChanged() with a small delay. This is
600 * because getting all file items for the signal can be an expensive
601 * operation. Fast selection changes are collected in this case and
602 * the signal is emitted only after no selection change has been done
603 * within a small delay.
605 void emitDelayedSelectionChangedSignal();
608 * Is called by emitDelayedSelectionChangedSignal() and emits the
609 * signal \a selectionChanged() with all selected file items as parameter.
611 void emitSelectionChangedSignal();
614 * Opens the context menu on position \a pos. The position
615 * is used to check whether the context menu is related to an
616 * item or to the viewport.
618 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
621 * Drops dragged URLs to the destination path \a destPath. If
622 * the URLs are dropped above an item inside the destination path,
623 * the item is indicated by \a destItem.
625 void dropUrls(const KFileItem
& destItem
,
626 const KUrl
& destPath
,
630 * Updates the view properties of the current URL to the
631 * sorting given by \a sorting.
633 void updateSorting(DolphinView::Sorting sorting
);
636 * Updates the view properties of the current URL to the
637 * sort order given by \a order.
639 void updateSortOrder(Qt::SortOrder order
);
642 * Updates the view properties of the current URL to the
643 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
645 void updateSortFoldersFirst(bool foldersFirst
);
648 * Updates the view properties of the current URL to the
649 * additional information given by \a info.
651 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
654 * Emits the signal contentsMoved with the current coordinates
655 * of the viewport as parameters.
657 void emitContentsMoved();
660 * Updates the status bar to show hover information for the
661 * item \a item. If currently other items are selected,
662 * no hover information is shown.
663 * @see DolphinView::clearHoverInformation()
665 void showHoverInformation(const KFileItem
& item
);
668 * Clears the hover information shown in the status bar.
669 * @see DolphinView::showHoverInformation().
671 void clearHoverInformation();
674 * Indicates in the status bar that the delete operation
675 * of the job \a job has been finished.
677 void slotDeleteFileFinished(KJob
* job
);
680 * Is emitted if the controller requests a changing of the current
683 void slotRequestUrlChange(const KUrl
& url
);
686 * Invoked when the directory lister has completed the loading of
687 * items. Assures that pasted items and renamed items get seleced.
689 void slotDirListerCompleted();
692 * Invoked when the loading of the directory is finished.
693 * Restores the active item and the scroll position if possible.
695 void slotLoadingCompleted();
698 * Is invoked when the KDirLister indicates refreshed items.
700 void slotRefreshItems();
703 * Observes the item with the URL \a url. As soon as the directory
704 * model indicates that the item is available, the item will
705 * get selected and it is assure that the item stays visible.
707 * @see selectAndScrollToCreatedItem()
709 void observeCreatedItem(const KUrl
& url
);
712 * Selects and scrolls to the item that got observed
713 * by observeCreatedItem().
715 void selectAndScrollToCreatedItem();
718 * Called when a redirection happens.
719 * Testcase: fish://localhost
721 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
724 * Restores the contents position, if history information about the old position is available.
726 void restoreContentsPosition();
729 void loadDirectory(const KUrl
& url
, bool reload
= false);
732 * Applies the view properties which are defined by the current URL
733 * to the DolphinView properties.
735 void applyViewProperties();
738 * Creates a new view representing the given view mode (DolphinView::mode()).
739 * The current view will get deleted.
746 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
747 * Pastes the clipboard data into the URL \a url.
749 void pasteToUrl(const KUrl
& url
);
752 * Checks whether the current item view has the same zoom level
753 * as \a oldZoomLevel. If this is not the case, the zoom level
754 * of the controller is updated and a zoomLevelChanged() signal
757 void updateZoomLevel(int oldZoomLevel
);
760 * Returns a list of URLs for all selected items. The list is
761 * simplified, so that when the URLs are part of different tree
762 * levels, only the parent is returned.
764 KUrl::List
simplifiedSelectedUrls() const;
767 * Returns the MIME data for all selected items.
769 QMimeData
* selectionMimeData() const;
772 * Is invoked after a paste operation or a drag & drop
773 * operation and adds the filenames of all URLs from \a mimeData to
774 * m_newFileNames. This allows to select all newly added
775 * items in slotDirListerCompleted().
777 void addNewFileNames(const QMimeData
* mimeData
);
781 * Abstracts the access to the different view implementations
782 * for icons-, details- and column-view.
787 ViewAccessor(DolphinSortFilterProxyModel
* proxyModel
);
790 void createView(QWidget
* parent
, DolphinController
* controller
, Mode mode
);
794 * Must be invoked before the URL has been changed and allows view implementations
795 * like the column view to create a new column.
797 void prepareUrlChange(const KUrl
& url
);
799 QAbstractItemView
* itemView() const;
800 KFileItemDelegate
* itemDelegate() const;
803 * Returns the widget that should be added to the layout as target. Usually
804 * the item view itself is returned, but in the case of the column view
805 * a container widget is returned.
807 QWidget
* layoutTarget() const;
809 KUrl
rootUrl() const;
811 bool supportsCategorizedSorting() const;
812 bool itemsExpandable() const;
813 QSet
<KUrl
> expandedUrls() const;
814 const DolphinDetailsViewExpander
* setExpandedUrls(const QSet
<KUrl
>& urlsToExpand
);
817 * Returns true, if a reloading of the items is required
818 * when the additional information properties have been changed
821 bool reloadOnAdditionalInfoChange() const;
823 DolphinModel
* dirModel() const;
824 DolphinSortFilterProxyModel
* proxyModel() const;
825 KDirLister
* dirLister() const;
828 DolphinIconsView
* m_iconsView
;
829 DolphinDetailsView
* m_detailsView
;
830 DolphinColumnViewContainer
* m_columnsContainer
;
831 DolphinSortFilterProxyModel
* m_proxyModel
;
832 QAbstractItemView
* m_dragSource
;
833 QPointer
<DolphinDetailsViewExpander
> m_detailsViewExpander
;
837 bool m_showPreview
: 1;
838 bool m_loadingDirectory
: 1;
839 bool m_storedCategorizedSorting
: 1;
840 bool m_tabsForFiles
: 1;
841 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
842 bool m_ignoreViewProperties
: 1;
843 bool m_assureVisibleCurrentIndex
: 1;
844 bool m_expanderActive
: 1;
848 DolphinMainWindow
* m_mainWindow
;
849 QVBoxLayout
* m_topLayout
;
851 DolphinController
* m_controller
;
852 ViewAccessor m_viewAccessor
;
854 QItemSelectionModel
* m_selectionModel
; // allow to switch views without losing the selection
855 QTimer
* m_selectionChangedTimer
;
858 KUrl m_activeItemUrl
;
859 QPoint m_restoredContentsPosition
;
860 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
861 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
864 * Remembers the filenames that have been added by a paste operation
865 * or a drag & drop operation. Allows to select the items in
866 * slotDirListerCompleted().
868 QSet
<QString
> m_newFileNames
;
871 /// Allow using DolphinView::Mode in QVariant
872 Q_DECLARE_METATYPE(DolphinView::Mode
)
874 #endif // DOLPHINVIEW_H