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 DolphinColumnViewContainer
;
45 class DolphinDetailsView
;
46 class DolphinIconsView
;
48 class DolphinSortFilterProxyModel
;
49 class DolphinViewController
;
51 class KActionCollection
;
54 class ViewModeController
;
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. */
117 MaxSortingEnum
= SortByPath
121 * @param parent Parent widget of the view.
122 * @param url Specifies the content which should be shown.
123 * @param proxyModel Used proxy model which specifies the sorting. The
124 * model is not owned by the view and won't get
127 DolphinView(QWidget
* parent
,
129 DolphinSortFilterProxyModel
* proxyModel
);
131 virtual ~DolphinView();
134 * Returns the current active URL, where all actions are applied.
135 * The URL navigator is synchronized with this URL.
140 * Returns the root URL of the view, which is defined as the first
141 * visible path of DolphinView::url(). Usually the root URL is
142 * equal to DolphinView::url(), but in the case of the column view
143 * when 2 columns are shown, the root URL might be:
144 * /home/peter/Documents
145 * and DolphinView::url() might return
146 * /home/peter/Documents/Music/
148 KUrl
rootUrl() const;
151 * If \a active is true, the view will marked as active. The active
152 * view is defined as view where all actions are applied to.
154 void setActive(bool active
);
155 bool isActive() const;
158 * Changes the view mode for the current directory to \a mode.
159 * If the view properties should be remembered for each directory
160 * (GeneralSettings::globalViewProps() returns false), then the
161 * changed view mode will be stored automatically.
163 void setMode(Mode mode
);
166 /** See setShowPreview */
167 bool showPreview() const;
169 /** See setShowHiddenFiles */
170 bool showHiddenFiles() const;
172 /** See setCategorizedSorting */
173 bool categorizedSorting() const;
176 * Returns true, if the categorized sorting is supported by the current
177 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
178 * supports categorizations. To check whether the categorized
179 * sorting is set, use DolphinView::categorizedSorting().
181 bool supportsCategorizedSorting() const;
184 * Marks the items indicated by \p urls to get selected after the
185 * directory DolphinView::url() has been loaded. Note that nothing
186 * gets selected if no loading of a directory has been triggered
187 * by DolphinView::setUrl() or DolphinView::reload().
189 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
192 * Returns the selected items. The list is empty if no item has been
194 * @see DolphinView::selectedUrls()
196 KFileItemList
selectedItems() 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 zoom level to \a level. It is assured that the used
208 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
209 * ZoomLevelInfo::maximumLevel().
211 void setZoomLevel(int level
);
212 int zoomLevel() const;
215 * Returns true, if zooming in is possible. If false is returned,
216 * the maximum zooming level has been reached.
218 bool isZoomInPossible() const;
221 * Returns true, if zooming out is possible. If false is returned,
222 * the minimum zooming level has been reached.
224 bool isZoomOutPossible() const;
226 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
227 void setSorting(Sorting sorting
);
229 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
230 Sorting
sorting() const;
232 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
233 void setSortOrder(Qt::SortOrder order
);
235 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
236 Qt::SortOrder
sortOrder() const;
238 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
239 void setSortFoldersFirst(bool foldersFirst
);
241 /** Returns if files and folders are sorted separately or not. */
242 bool sortFoldersFirst() const;
244 /** Sets the additional information which should be shown for the items. */
245 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
247 /** Returns the additional information which should be shown for the items. */
248 KFileItemDelegate::InformationList
additionalInfo() const;
250 /** Reloads the current directory. */
256 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
257 * This method only needs to get invoked if the view settings for the Icons View,
258 * Details View or Columns View have been changed.
263 * Filters the currently shown items by \a nameFilter. All items
264 * which contain the given filter string will be shown.
266 void setNameFilter(const QString
& nameFilter
);
269 * Calculates the number of currently shown files into
270 * \a fileCount and the number of folders into \a folderCount.
271 * The size of all files is written into \a totalFileSize.
272 * It is recommend using this method instead of asking the
273 * directory lister or the model directly, as it takes
274 * filtering and hierarchical previews into account.
276 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
279 * Returns a textual representation of the state of the current
280 * folder or selected items, suitable for use in the status bar.
282 QString
statusBarText() const;
285 * Returns the version control actions that are provided for the items \p items.
286 * Usually the actions are presented in the context menu.
288 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
291 * Updates the state of the 'Additional Information' actions in \a collection.
293 void updateAdditionalInfoActions(KActionCollection
* collection
);
296 * Returns the state of the paste action:
297 * first is whether the action should be enabled
298 * second is the text for the action
300 QPair
<bool, QString
> pasteInfo() const;
303 * If \a tabsForFiles is true, the signal tabRequested() will also
304 * emitted also for files. Per default tabs for files is disabled
305 * and hence the signal tabRequested() will only be emitted for
308 void setTabsForFilesEnabled(bool tabsForFiles
);
309 bool isTabsForFilesEnabled() const;
312 * Returns true if the current view allows folders to be expanded,
313 * i.e. presents a hierarchical view to the user.
315 bool itemsExpandable() const;
318 * Restores the view state (current item, contents position, details view expansion state)
320 void restoreState(QDataStream
& stream
);
323 * Saves the view state (current item, contents position, details view expansion state)
325 void saveState(QDataStream
& stream
);
328 * Returns all the items in the current view.
330 KFileItemList
allItems() const;
334 * Changes the directory to \a url. If the current directory is equal to
335 * \a url, nothing will be done (use DolphinView::reload() instead).
337 void setUrl(const KUrl
& url
);
341 * @see DolphinView::selectedItems()
346 * Inverts the current selection: selected items get unselected,
347 * unselected items get selected.
348 * @see DolphinView::selectedItems()
350 void invertSelection();
352 /** Returns true, if at least one item is selected. */
353 bool hasSelection() const;
355 void clearSelection();
358 * Triggers the renaming of the currently selected items, where
359 * the user must input a new name for the items.
361 void renameSelectedItems();
364 * Moves all selected items to the trash.
366 void trashSelectedItems();
369 * Deletes all selected items.
371 void deleteSelectedItems();
374 * Copies all selected items to the clipboard and marks
377 void cutSelectedItems();
379 /** Copies all selected items to the clipboard. */
380 void copySelectedItems();
382 /** Pastes the clipboard data to this view. */
386 * Pastes the clipboard data into the currently selected
387 * folder. If the current selection is not exactly one folder, no
388 * paste operation is done.
390 void pasteIntoFolder();
393 * Turns on the file preview for the all files of the current directory,
394 * if \a show is true.
395 * If the view properties should be remembered for each directory
396 * (GeneralSettings::globalViewProps() returns false), then the
397 * preview setting will be stored automatically.
399 void setShowPreview(bool show
);
402 * Shows all hidden 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 * show hidden file setting will be stored automatically.
408 void setShowHiddenFiles(bool show
);
411 * Summarizes all sorted items by their category \a categorized
413 * If the view properties should be remembered for each directory
414 * (GeneralSettings::globalViewProps() returns false), then the
415 * categorized sorting setting will be stored automatically.
417 void setCategorizedSorting(bool categorized
);
421 * Is emitted if the view has been activated by e. g. a mouse click.
425 /** Is emitted if URL of the view has been changed to \a url. */
426 void urlChanged(const KUrl
& url
);
429 * Is emitted when clicking on an item with the left mouse button.
431 void itemTriggered(const KFileItem
& item
);
434 * Is emitted if a new tab should be opened for the URL \a url.
436 void tabRequested(const KUrl
& url
);
439 * Is emitted if the view mode (IconsView, DetailsView,
440 * PreviewsView) has been changed.
444 /** Is emitted if the 'show preview' property has been changed. */
445 void showPreviewChanged();
447 /** Is emitted if the 'show hidden files' property has been changed. */
448 void showHiddenFilesChanged();
450 /** Is emitted if the 'categorized sorting' property has been changed. */
451 void categorizedSortingChanged();
453 /** Is emitted if the sorting by name, size or date has been changed. */
454 void sortingChanged(DolphinView::Sorting sorting
);
456 /** Is emitted if the sort order (ascending or descending) has been changed. */
457 void sortOrderChanged(Qt::SortOrder order
);
459 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
460 void sortFoldersFirstChanged(bool foldersFirst
);
462 /** Is emitted if the additional information shown for this view has been changed. */
463 void additionalInfoChanged();
465 /** Is emitted if the zoom level has been changed by zooming in or out. */
466 void zoomLevelChanged(int level
);
469 * Is emitted if information of an item is requested to be shown e. g. in the panel.
470 * If item is null, no item information request is pending.
472 void requestItemInfo(const KFileItem
& item
);
475 * Is emitted whenever the selection has been changed.
477 void selectionChanged(const KFileItemList
& selection
);
480 * Is emitted if a context menu is requested for the item \a item,
481 * which is part of \a url. If the item is null, the context menu
482 * for the URL should be shown and the custom actions \a customActions
485 void requestContextMenu(const KFileItem
& item
,
487 const QList
<QAction
*>& customActions
);
490 * Is emitted if an information message with the content \a msg
493 void infoMessage(const QString
& msg
);
496 * Is emitted if an error message with the content \a msg
499 void errorMessage(const QString
& msg
);
502 * Is emitted if an "operation completed" message with the content \a msg
505 void operationCompletedMessage(const QString
& msg
);
508 * Is emitted after DolphinView::setUrl() has been invoked and
509 * the path \a url is currently loaded. If this signal is emitted,
510 * it is assured that the view contains already the correct root
511 * URL and property settings.
513 void startedPathLoading(const KUrl
& url
);
516 * Is emitted after the path triggered by DolphinView::setUrl()
519 void finishedPathLoading(const KUrl
& url
);
522 * Emitted when KDirLister emits redirection.
523 * Testcase: fish://localhost
525 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
528 /** @see QWidget::mouseReleaseEvent */
529 virtual void mouseReleaseEvent(QMouseEvent
* event
);
530 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
534 * Marks the view as active (DolphinView:isActive() will return true)
535 * and emits the 'activated' signal if it is not already active.
540 * If the item \a item is a directory, then this
541 * directory will be loaded. If the item is a file, the corresponding
542 * application will get started.
544 void triggerItem(const KFileItem
& index
);
547 * Emits the signal \a selectionChanged() with a small delay. This is
548 * because getting all file items for the signal can be an expensive
549 * operation. Fast selection changes are collected in this case and
550 * the signal is emitted only after no selection change has been done
551 * within a small delay.
553 void slotSelectionChanged(const QItemSelection
& selected
, const QItemSelection
& deselected
);
556 * Is called by emitDelayedSelectionChangedSignal() and emits the
557 * signal \a selectionChanged() with all selected file items as parameter.
559 void emitSelectionChangedSignal();
562 * Opens the context menu on position \a pos. The position
563 * is used to check whether the context menu is related to an
564 * item or to the viewport.
566 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
569 * Drops dragged URLs to the destination path \a destPath. If
570 * the URLs are dropped above an item inside the destination path,
571 * the item is indicated by \a destItem.
573 void dropUrls(const KFileItem
& destItem
,
574 const KUrl
& destPath
,
578 * Updates the view properties of the current URL to the
579 * sorting given by \a sorting.
581 void updateSorting(DolphinView::Sorting sorting
);
584 * Updates the view properties of the current URL to the
585 * sort order given by \a order.
587 void updateSortOrder(Qt::SortOrder order
);
590 * Updates the view properties of the current URL to the
591 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
593 void updateSortFoldersFirst(bool foldersFirst
);
596 * Updates the view properties of the current URL to the
597 * additional information given by \a info.
599 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
602 * Updates the status bar to show hover information for the
603 * item \a item. If currently other items are selected,
604 * no hover information is shown.
605 * @see DolphinView::clearHoverInformation()
607 void showHoverInformation(const KFileItem
& item
);
610 * Clears the hover information shown in the status bar.
611 * @see DolphinView::showHoverInformation().
613 void clearHoverInformation();
616 * Indicates in the status bar that the delete operation
617 * of the job \a job has been finished.
619 void slotDeleteFileFinished(KJob
* job
);
622 * Invoked when the directory lister has completed the loading of
623 * items. Assures that pasted items and renamed items get seleced.
625 void slotDirListerCompleted();
628 * Invoked when the loading of the directory is finished.
629 * Restores the active item and the scroll position if possible.
631 void slotLoadingCompleted();
634 * Is invoked when the KDirLister indicates refreshed items.
636 void slotRefreshItems();
639 * Observes the item with the URL \a url. As soon as the directory
640 * model indicates that the item is available, the item will
641 * get selected and it is assure that the item stays visible.
643 * @see selectAndScrollToCreatedItem()
645 void observeCreatedItem(const KUrl
& url
);
648 * Selects and scrolls to the item that got observed
649 * by observeCreatedItem().
651 void selectAndScrollToCreatedItem();
654 * Called when a redirection happens.
655 * Testcase: fish://localhost
657 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
660 * Restores the contents position, if history information about the old position is available.
662 void restoreContentsPosition();
665 void loadDirectory(const KUrl
& url
, bool reload
= false);
668 * Applies the view properties which are defined by the current URL
669 * to the DolphinView properties.
671 void applyViewProperties();
674 * Creates a new view representing the given view mode (DolphinView::mode()).
675 * The current view will get deleted.
682 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
683 * Pastes the clipboard data into the URL \a url.
685 void pasteToUrl(const KUrl
& url
);
688 * Checks whether the current item view has the same zoom level
689 * as \a oldZoomLevel. If this is not the case, the zoom level
690 * of the controller is updated and a zoomLevelChanged() signal
693 void updateZoomLevel(int oldZoomLevel
);
696 * Returns a list of URLs for all selected items. The list is
697 * simplified, so that when the URLs are part of different tree
698 * levels, only the parent is returned.
700 KUrl::List
simplifiedSelectedUrls() const;
703 * Returns the MIME data for all selected items.
705 QMimeData
* selectionMimeData() const;
708 * Is invoked after a paste operation or a drag & drop
709 * operation and adds the filenames of all URLs from \a mimeData to
710 * m_newFileNames. This allows to select all newly added
711 * items in slotDirListerCompleted().
713 void addNewFileNames(const QMimeData
* mimeData
);
717 * Abstracts the access to the different view implementations
718 * for icons-, details- and column-view.
723 ViewAccessor(DolphinSortFilterProxyModel
* proxyModel
);
726 void createView(QWidget
* parent
,
727 DolphinViewController
* dolphinViewController
,
728 const ViewModeController
* viewModeController
,
733 * Must be invoked before the URL has been changed and allows view implementations
734 * like the column view to create a new column.
736 void prepareUrlChange(const KUrl
& url
);
738 QAbstractItemView
* itemView() const;
739 KFileItemDelegate
* itemDelegate() const;
742 * Returns the widget that should be added to the layout as target. Usually
743 * the item view itself is returned, but in the case of the column view
744 * a container widget is returned.
746 QWidget
* layoutTarget() const;
748 KUrl
rootUrl() const;
750 bool supportsCategorizedSorting() const;
751 bool itemsExpandable() const;
752 QSet
<KUrl
> expandedUrls() const;
753 const DolphinDetailsViewExpander
* setExpandedUrls(const QSet
<KUrl
>& urlsToExpand
);
756 * Returns true, if a reloading of the items is required
757 * when the additional information properties have been changed
760 bool reloadOnAdditionalInfoChange() const;
762 DolphinModel
* dirModel() const;
763 DolphinSortFilterProxyModel
* proxyModel() const;
764 KDirLister
* dirLister() const;
767 DolphinIconsView
* m_iconsView
;
768 DolphinDetailsView
* m_detailsView
;
769 DolphinColumnViewContainer
* m_columnsContainer
;
770 DolphinSortFilterProxyModel
* m_proxyModel
;
771 QAbstractItemView
* m_dragSource
;
772 QPointer
<DolphinDetailsViewExpander
> m_detailsViewExpander
;
776 bool m_showPreview
: 1;
777 bool m_storedCategorizedSorting
: 1;
778 bool m_tabsForFiles
: 1;
779 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
780 bool m_assureVisibleCurrentIndex
: 1;
781 bool m_expanderActive
: 1;
785 QVBoxLayout
* m_topLayout
;
787 DolphinViewController
* m_dolphinViewController
;
788 ViewModeController
* m_viewModeController
;
789 ViewAccessor m_viewAccessor
;
791 QTimer
* m_selectionChangedTimer
;
794 KUrl m_activeItemUrl
;
795 QPoint m_restoredContentsPosition
;
796 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
797 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
800 * Remembers the filenames that have been added by a paste operation
801 * or a drag & drop operation. Allows to select the items in
802 * slotDirListerCompleted().
804 QSet
<QString
> m_newFileNames
;
807 friend class TestBase
;
810 /// Allow using DolphinView::Mode in QVariant
811 Q_DECLARE_METATYPE(DolphinView::Mode
)
813 #endif // DOLPHINVIEW_H