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 zoom level to \a level. It is assured that the used
213 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
214 * ZoomLevelInfo::maximumLevel().
216 void setZoomLevel(int level
);
217 int zoomLevel() const;
220 * Returns true, if zooming in is possible. If false is returned,
221 * the maximum zooming level has been reached.
223 bool isZoomInPossible() const;
226 * Returns true, if zooming out is possible. If false is returned,
227 * the minimum zooming level has been reached.
229 bool isZoomOutPossible() const;
231 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
232 void setSorting(Sorting sorting
);
234 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
235 Sorting
sorting() const;
237 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
238 void setSortOrder(Qt::SortOrder order
);
240 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
241 Qt::SortOrder
sortOrder() const;
243 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
244 void setSortFoldersFirst(bool foldersFirst
);
246 /** Returns if files and folders are sorted separately or not. */
247 bool sortFoldersFirst() const;
249 /** Sets the additional information which should be shown for the items. */
250 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
252 /** Returns the additional information which should be shown for the items. */
253 KFileItemDelegate::InformationList
additionalInfo() const;
255 /** Reloads the current directory. */
259 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
260 * This method only needs to get invoked if the view settings for the Icons View,
261 * Details View or Columns View have been changed.
266 * Filters the currently shown items by \a nameFilter. All items
267 * which contain the given filter string will be shown.
269 void setNameFilter(const QString
& nameFilter
);
272 * Calculates the number of currently shown files into
273 * \a fileCount and the number of folders into \a folderCount.
274 * The size of all files is written into \a totalFileSize.
275 * It is recommend using this method instead of asking the
276 * directory lister or the model directly, as it takes
277 * filtering and hierarchical previews into account.
279 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
282 * Returns a textual representation of the state of the current
283 * folder or selected items, suitable for use in the status bar.
285 QString
statusBarText() const;
288 * Returns the version control actions that are provided for the items \p items.
289 * Usually the actions are presented in the context menu.
291 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
294 * Updates the state of the 'Additional Information' actions in \a collection.
296 void updateAdditionalInfoActions(KActionCollection
* collection
);
299 * Returns the state of the paste action:
300 * first is whether the action should be enabled
301 * second is the text for the action
303 QPair
<bool, QString
> pasteInfo() const;
306 * If \a tabsForFiles is true, the signal tabRequested() will also
307 * emitted also for files. Per default tabs for files is disabled
308 * and hence the signal tabRequested() will only be emitted for
311 void setTabsForFilesEnabled(bool tabsForFiles
);
312 bool isTabsForFilesEnabled() const;
315 * Returns true if the current view allows folders to be expanded,
316 * i.e. presents a hierarchical view to the user.
318 bool itemsExpandable() const;
321 * Restores the view state (current item, contents position, details view expansion state)
323 void restoreState(QDataStream
& stream
);
326 * Saves the view state (current item, contents position, details view expansion state)
328 void saveState(QDataStream
& stream
);
332 * Changes the directory to \a url. If the current directory is equal to
333 * \a url, nothing will be done (use DolphinView::reload() instead).
335 void setUrl(const KUrl
& url
);
339 * @see DolphinView::selectedItems()
344 * Inverts the current selection: selected items get unselected,
345 * unselected items get selected.
346 * @see DolphinView::selectedItems()
348 void invertSelection();
350 /** Returns true, if at least one item is selected. */
351 bool hasSelection() const;
353 void clearSelection();
356 * Triggers the renaming of the currently selected items, where
357 * the user must input a new name for the items.
359 void renameSelectedItems();
362 * Moves all selected items to the trash.
364 void trashSelectedItems();
367 * Deletes all selected items.
369 void deleteSelectedItems();
372 * Copies all selected items to the clipboard and marks
375 void cutSelectedItems();
377 /** Copies all selected items to the clipboard. */
378 void copySelectedItems();
380 /** Pastes the clipboard data to this view. */
384 * Pastes the clipboard data into the currently selected
385 * folder. If the current selection is not exactly one folder, no
386 * paste operation is done.
388 void pasteIntoFolder();
391 * Turns on the file preview for the all files of the current directory,
392 * if \a show is true.
393 * If the view properties should be remembered for each directory
394 * (GeneralSettings::globalViewProps() returns false), then the
395 * preview setting will be stored automatically.
397 void setShowPreview(bool show
);
400 * Shows all hidden files of the current directory,
401 * if \a show is true.
402 * If the view properties should be remembered for each directory
403 * (GeneralSettings::globalViewProps() returns false), then the
404 * show hidden file setting will be stored automatically.
406 void setShowHiddenFiles(bool show
);
409 * Summarizes all sorted items by their category \a categorized
411 * If the view properties should be remembered for each directory
412 * (GeneralSettings::globalViewProps() returns false), then the
413 * categorized sorting setting will be stored automatically.
415 void setCategorizedSorting(bool categorized
);
417 /** Switches between an ascending and descending sorting order. */
418 void toggleSortOrder();
420 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
421 void toggleSortFoldersFirst();
424 * Switches on or off the displaying of additional information
425 * as specified by \a action.
427 void toggleAdditionalInfo(QAction
* action
);
431 * Is emitted if the view has been activated by e. g. a mouse click.
435 /** Is emitted if URL of the view has been changed to \a url. */
436 void urlChanged(const KUrl
& url
);
439 * Is emitted if the view requests a changing of the current
440 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
442 void requestUrlChange(const KUrl
& url
);
445 * Is emitted when clicking on an item with the left mouse button.
447 void itemTriggered(const KFileItem
& item
);
450 * Is emitted if a new tab should be opened for the URL \a url.
452 void tabRequested(const KUrl
& url
);
455 * Is emitted if the view mode (IconsView, DetailsView,
456 * PreviewsView) has been changed.
460 /** Is emitted if the 'show preview' property has been changed. */
461 void showPreviewChanged();
463 /** Is emitted if the 'show hidden files' property has been changed. */
464 void showHiddenFilesChanged();
466 /** Is emitted if the 'categorized sorting' property has been changed. */
467 void categorizedSortingChanged();
469 /** Is emitted if the sorting by name, size or date has been changed. */
470 void sortingChanged(DolphinView::Sorting sorting
);
472 /** Is emitted if the sort order (ascending or descending) has been changed. */
473 void sortOrderChanged(Qt::SortOrder order
);
475 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
476 void sortFoldersFirstChanged(bool foldersFirst
);
478 /** Is emitted if the additional information shown for this view has been changed. */
479 void additionalInfoChanged();
481 /** Is emitted if the zoom level has been changed by zooming in or out. */
482 void zoomLevelChanged(int level
);
485 * Is emitted if information of an item is requested to be shown e. g. in the panel.
486 * If item is null, no item information request is pending.
488 void requestItemInfo(const KFileItem
& item
);
491 * Is emitted whenever the selection has been changed.
493 void selectionChanged(const KFileItemList
& selection
);
496 * Is emitted if a context menu is requested for the item \a item,
497 * which is part of \a url. If the item is null, the context menu
498 * for the URL should be shown and the custom actions \a customActions
501 void requestContextMenu(const KFileItem
& item
,
503 const QList
<QAction
*>& customActions
);
506 * Is emitted if an information message with the content \a msg
509 void infoMessage(const QString
& msg
);
512 * Is emitted if an error message with the content \a msg
515 void errorMessage(const QString
& msg
);
518 * Is emitted if an "operation completed" message with the content \a msg
521 void operationCompletedMessage(const QString
& msg
);
524 * Is emitted after DolphinView::setUrl() has been invoked and
525 * the path \a url is currently loaded. If this signal is emitted,
526 * it is assured that the view contains already the correct root
527 * URL and property settings.
529 void startedPathLoading(const KUrl
& url
);
532 * Emitted when KDirLister emits redirection.
533 * Testcase: fish://localhost
535 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
538 /** @see QWidget::mouseReleaseEvent */
539 virtual void mouseReleaseEvent(QMouseEvent
* event
);
540 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
544 * Marks the view as active (DolphinView:isActive() will return true)
545 * and emits the 'activated' signal if it is not already active.
550 * If the item \a item is a directory, then this
551 * directory will be loaded. If the item is a file, the corresponding
552 * application will get started.
554 void triggerItem(const KFileItem
& index
);
557 * Emits the signal \a selectionChanged() with a small delay. This is
558 * because getting all file items for the signal can be an expensive
559 * operation. Fast selection changes are collected in this case and
560 * the signal is emitted only after no selection change has been done
561 * within a small delay.
563 void slotSelectionChanged(const QItemSelection
& selected
, const QItemSelection
& deselected
);
566 * Is called by emitDelayedSelectionChangedSignal() and emits the
567 * signal \a selectionChanged() with all selected file items as parameter.
569 void emitSelectionChangedSignal();
572 * Opens the context menu on position \a pos. The position
573 * is used to check whether the context menu is related to an
574 * item or to the viewport.
576 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
579 * Drops dragged URLs to the destination path \a destPath. If
580 * the URLs are dropped above an item inside the destination path,
581 * the item is indicated by \a destItem.
583 void dropUrls(const KFileItem
& destItem
,
584 const KUrl
& destPath
,
588 * Updates the view properties of the current URL to the
589 * sorting given by \a sorting.
591 void updateSorting(DolphinView::Sorting sorting
);
594 * Updates the view properties of the current URL to the
595 * sort order given by \a order.
597 void updateSortOrder(Qt::SortOrder order
);
600 * Updates the view properties of the current URL to the
601 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
603 void updateSortFoldersFirst(bool foldersFirst
);
606 * Updates the view properties of the current URL to the
607 * additional information given by \a info.
609 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
612 * Updates the status bar to show hover information for the
613 * item \a item. If currently other items are selected,
614 * no hover information is shown.
615 * @see DolphinView::clearHoverInformation()
617 void showHoverInformation(const KFileItem
& item
);
620 * Clears the hover information shown in the status bar.
621 * @see DolphinView::showHoverInformation().
623 void clearHoverInformation();
626 * Indicates in the status bar that the delete operation
627 * of the job \a job has been finished.
629 void slotDeleteFileFinished(KJob
* job
);
632 * Is emitted if the controller requests a changing of the current
635 void slotRequestUrlChange(const KUrl
& url
);
638 * Invoked when the directory lister has completed the loading of
639 * items. Assures that pasted items and renamed items get seleced.
641 void slotDirListerCompleted();
644 * Invoked when the loading of the directory is finished.
645 * Restores the active item and the scroll position if possible.
647 void slotLoadingCompleted();
650 * Is invoked when the KDirLister indicates refreshed items.
652 void slotRefreshItems();
655 * Observes the item with the URL \a url. As soon as the directory
656 * model indicates that the item is available, the item will
657 * get selected and it is assure that the item stays visible.
659 * @see selectAndScrollToCreatedItem()
661 void observeCreatedItem(const KUrl
& url
);
664 * Selects and scrolls to the item that got observed
665 * by observeCreatedItem().
667 void selectAndScrollToCreatedItem();
670 * Called when a redirection happens.
671 * Testcase: fish://localhost
673 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
676 * Restores the contents position, if history information about the old position is available.
678 void restoreContentsPosition();
681 void loadDirectory(const KUrl
& url
, bool reload
= false);
684 * Applies the view properties which are defined by the current URL
685 * to the DolphinView properties.
687 void applyViewProperties();
690 * Creates a new view representing the given view mode (DolphinView::mode()).
691 * The current view will get deleted.
698 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
699 * Pastes the clipboard data into the URL \a url.
701 void pasteToUrl(const KUrl
& url
);
704 * Checks whether the current item view has the same zoom level
705 * as \a oldZoomLevel. If this is not the case, the zoom level
706 * of the controller is updated and a zoomLevelChanged() signal
709 void updateZoomLevel(int oldZoomLevel
);
712 * Returns a list of URLs for all selected items. The list is
713 * simplified, so that when the URLs are part of different tree
714 * levels, only the parent is returned.
716 KUrl::List
simplifiedSelectedUrls() const;
719 * Returns the MIME data for all selected items.
721 QMimeData
* selectionMimeData() const;
724 * Is invoked after a paste operation or a drag & drop
725 * operation and adds the filenames of all URLs from \a mimeData to
726 * m_newFileNames. This allows to select all newly added
727 * items in slotDirListerCompleted().
729 void addNewFileNames(const QMimeData
* mimeData
);
733 * Abstracts the access to the different view implementations
734 * for icons-, details- and column-view.
739 ViewAccessor(DolphinSortFilterProxyModel
* proxyModel
);
742 void createView(QWidget
* parent
, DolphinController
* controller
, Mode mode
);
746 * Must be invoked before the URL has been changed and allows view implementations
747 * like the column view to create a new column.
749 void prepareUrlChange(const KUrl
& url
);
751 QAbstractItemView
* itemView() const;
752 KFileItemDelegate
* itemDelegate() const;
755 * Returns the widget that should be added to the layout as target. Usually
756 * the item view itself is returned, but in the case of the column view
757 * a container widget is returned.
759 QWidget
* layoutTarget() const;
761 KUrl
rootUrl() const;
762 KDirLister
* rootDirLister() const;
764 bool supportsCategorizedSorting() const;
765 bool itemsExpandable() const;
766 QSet
<KUrl
> expandedUrls() const;
767 const DolphinDetailsViewExpander
* setExpandedUrls(const QSet
<KUrl
>& urlsToExpand
);
770 * Returns true, if a reloading of the items is required
771 * when the additional information properties have been changed
774 bool reloadOnAdditionalInfoChange() const;
776 DolphinModel
* dirModel() const;
777 DolphinSortFilterProxyModel
* proxyModel() const;
778 KDirLister
* dirLister() const;
781 DolphinIconsView
* m_iconsView
;
782 DolphinDetailsView
* m_detailsView
;
783 DolphinColumnViewContainer
* m_columnsContainer
;
784 DolphinSortFilterProxyModel
* m_proxyModel
;
785 QAbstractItemView
* m_dragSource
;
786 QPointer
<DolphinDetailsViewExpander
> m_detailsViewExpander
;
790 bool m_showPreview
: 1;
791 bool m_storedCategorizedSorting
: 1;
792 bool m_tabsForFiles
: 1;
793 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
794 bool m_ignoreViewProperties
: 1;
795 bool m_assureVisibleCurrentIndex
: 1;
796 bool m_expanderActive
: 1;
800 QVBoxLayout
* m_topLayout
;
802 DolphinController
* m_controller
;
803 ViewAccessor m_viewAccessor
;
805 QItemSelectionModel
* m_selectionModel
; // allow to switch views without losing the selection
806 QTimer
* m_selectionChangedTimer
;
809 KUrl m_activeItemUrl
;
810 QPoint m_restoredContentsPosition
;
811 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
812 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
815 * Remembers the filenames that have been added by a paste operation
816 * or a drag & drop operation. Allows to select the items in
817 * slotDirListerCompleted().
819 QSet
<QString
> m_newFileNames
;
822 /// Allow using DolphinView::Mode in QVariant
823 Q_DECLARE_METATYPE(DolphinView::Mode
)
825 #endif // DOLPHINVIEW_H