1 /***************************************************************************
2 * Copyright (C) 2006 by Peter Penz <peter.penz@gmx.at> *
3 * Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net> *
5 * This program is free software; you can redistribute it and/or modify *
6 * it under the terms of the GNU General Public License as published by *
7 * the Free Software Foundation; either version 2 of the License, or *
8 * (at your option) any later version. *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
13 * GNU General Public License for more details. *
15 * You should have received a copy of the GNU General Public License *
16 * along with this program; if not, write to the *
17 * Free Software Foundation, Inc., *
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
19 ***************************************************************************/
25 #include <config-nepomuk.h>
27 #include "libdolphin_export.h"
29 #include <kparts/part.h>
30 #include <kfileitem.h>
31 #include <kfileitemdelegate.h>
32 #include <kio/fileundomanager.h>
37 #include <QLinkedList>
42 typedef KIO::FileUndoManager::CommandType CommandType
;
44 class DolphinController
;
45 class DolphinColumnViewContainer
;
46 class DolphinDetailsView
;
47 class DolphinFileItemDelegate
;
48 class DolphinIconsView
;
49 class DolphinMainWindow
;
51 class DolphinSortFilterProxyModel
;
52 class KFilePreviewGenerator
;
54 class KActionCollection
;
58 class VersionControlObserver
;
62 * @short Represents a view for the directory content.
64 * View modes for icons, details and columns are supported. It's
71 * @see DolphinIconsView
72 * @see DolphinDetailsView
73 * @see DolphinColumnView
75 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
81 * Defines the view mode for a directory. The view mode
82 * can be defined when constructing a DolphinView. The
83 * view mode is automatically updated if the directory itself
84 * defines a view mode (see class ViewProperties for details).
89 * The directory items are shown as icons including an
95 * The icon, the name and at least the size of the directory
96 * items are shown in a table. It is possible to add columns
97 * for date, group and permissions.
102 * Each folder is shown in a separate column.
105 MaxModeEnum
= ColumnView
108 /** Defines the sort order for the items of a directory. */
120 MaxSortEnum
= SortByTags
124 * @param parent Parent widget of the view.
125 * @param url Specifies the content which should be shown.
126 * @param proxyModel Used proxy model which specifies the sorting. The
127 * model is not owned by the view and won't get
130 DolphinView(QWidget
* parent
,
132 DolphinSortFilterProxyModel
* proxyModel
);
134 virtual ~DolphinView();
137 * Returns the current active URL, where all actions are applied.
138 * The URL navigator is synchronized with this URL.
140 const KUrl
& url() const;
143 * Returns the root URL of the view, which is defined as the first
144 * visible path of DolphinView::url(). Usually the root URL is
145 * equal to DolphinView::url(), but in the case of the column view
146 * when 2 columns are shown, the root URL might be:
147 * /home/peter/Documents
148 * and DolphinView::url() might return
149 * /home/peter/Documents/Music/
151 KUrl
rootUrl() const;
154 * If \a active is true, the view will marked as active. The active
155 * view is defined as view where all actions are applied to.
157 void setActive(bool active
);
158 bool isActive() const;
161 * Changes the view mode for the current directory to \a mode.
162 * If the view properties should be remembered for each directory
163 * (GeneralSettings::globalViewProps() returns false), then the
164 * changed view mode will be stored automatically.
166 void setMode(Mode mode
);
169 /** See setShowPreview */
170 bool showPreview() const;
172 /** See setShowHiddenFiles */
173 bool showHiddenFiles() const;
175 /** See setCategorizedSorting */
176 bool categorizedSorting() const;
179 * Returns true, if the categorized sorting is supported by the current
180 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
181 * supports categorizations. To check whether the categorized
182 * sorting is set, use DolphinView::categorizedSorting().
184 bool supportsCategorizedSorting() const;
188 * @see DolphinView::selectedItems()
193 * Inverts the current selection: selected items get unselected,
194 * unselected items get selected.
195 * @see DolphinView::selectedItems()
197 void invertSelection();
199 /** Returns true, if at least one item is selected. */
200 bool hasSelection() const;
202 void clearSelection();
205 * Returns the selected items. The list is empty if no item has been
207 * @see DolphinView::selectedUrls()
209 KFileItemList
selectedItems() const;
212 * Returns a list of URLs for all selected items. An empty list
213 * is returned, if no item is selected.
214 * @see DolphinView::selectedItems()
216 KUrl::List
selectedUrls() const;
219 * Returns the number of selected items (this is faster than
220 * invoking selectedItems().count()).
222 int selectedItemsCount() const;
225 * Sets the upper left position of the view content
226 * to (x,y). The content of the view might be larger than the visible area
227 * and hence a scrolling must be done.
229 void setContentsPosition(int x
, int y
);
231 /** Returns the upper left position of the view content. */
232 QPoint
contentsPosition() const;
235 * Sets the zoom level to \a level. It is assured that the used
236 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
237 * ZoomLevelInfo::maximumLevel().
239 void setZoomLevel(int level
);
240 int zoomLevel() const;
243 * Returns true, if zooming in is possible. If false is returned,
244 * the maximum zooming level has been reached.
246 bool isZoomInPossible() const;
249 * Returns true, if zooming out is possible. If false is returned,
250 * the minimum zooming level has been reached.
252 bool isZoomOutPossible() const;
254 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
255 void setSorting(Sorting sorting
);
257 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
258 Sorting
sorting() const;
260 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
261 void setSortOrder(Qt::SortOrder order
);
263 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
264 Qt::SortOrder
sortOrder() const;
266 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
267 void setSortFoldersFirst(bool foldersFirst
);
269 /** Returns if files and folders are sorted separately or not. */
270 bool sortFoldersFirst() const;
272 /** Sets the additional information which should be shown for the items. */
273 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
275 /** Returns the additional information which should be shown for the items. */
276 KFileItemDelegate::InformationList
additionalInfo() const;
278 /** Reloads the current directory. */
282 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
283 * This method only needs to get invoked if the view settings for the Icons View,
284 * Details View or Columns View have been changed.
289 * Changes the directory of the view to \a url. If \a rootUrl is empty, the view
290 * properties from \a url are used for adjusting the view mode and the other properties.
291 * If \a rootUrl is not empty, the view properties from the root URL are considered
292 * instead. Specifying a root URL is only required if a view having a different root URL
293 * (e. g. the column view) should be restored. Usually using DolphinView::setUrl()
294 * is enough for changing the current URL.
296 void updateView(const KUrl
& url
, const KUrl
& rootUrl
);
299 * Filters the currently shown items by \a nameFilter. All items
300 * which contain the given filter string will be shown.
302 void setNameFilter(const QString
& nameFilter
);
305 * Calculates the number of currently shown files into
306 * \a fileCount and the number of folders into \a folderCount.
307 * The size of all files is written into \a totalFileSize.
308 * It is recommend using this method instead of asking the
309 * directory lister or the model directly, as it takes
310 * filtering and hierarchical previews into account.
312 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
315 * Returns a textual representation of the state of the current
316 * folder or selected items, suitable for use in the status bar.
318 QString
statusBarText() const;
321 * Returns the version control actions that are provided for the items \p items.
322 * Usually the actions are presented in the context menu.
324 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
327 * Updates the state of the 'Additional Information' actions in \a collection.
329 void updateAdditionalInfoActions(KActionCollection
* collection
);
332 * Returns the state of the paste action:
333 * first is whether the action should be enabled
334 * second is the text for the action
336 QPair
<bool, QString
> pasteInfo() const;
339 * If \a tabsForFiles is true, the signal tabRequested() will also
340 * emitted also for files. Per default tabs for files is disabled
341 * and hence the signal tabRequested() will only be emitted for
344 void setTabsForFilesEnabled(bool tabsForFiles
);
345 bool isTabsForFilesEnabled() const;
348 * Marks the item \a url as active item as soon as it has
349 * been loaded by the directory lister. This is useful mark
350 * the previously visited directory as active when going
351 * back in history (the URL is known, but the item is not
354 void activateItem(const KUrl
& url
);
357 * Returns true if the current view allows folders to be expanded,
358 * i.e. presents a hierarchical view to the user.
360 bool itemsExpandable() const;
364 * Changes the directory to \a url. If the current directory is equal to
365 * \a url, nothing will be done (use DolphinView::reload() instead).
367 void setUrl(const KUrl
& url
);
370 * Request of a selection change. The view will do its best to accommodate
371 * the request, but it is not guaranteed that all items in \a selection
372 * will actually get selected. The view will e.g. not select items which
373 * are not in the currently displayed folder.
375 void changeSelection(const KFileItemList
& selection
);
378 * Triggers the renaming of the currently selected items, where
379 * the user must input a new name for the items.
381 void renameSelectedItems();
384 * Moves all selected items to the trash.
386 void trashSelectedItems();
389 * Deletes all selected items.
391 void deleteSelectedItems();
394 * Copies all selected items to the clipboard and marks
395 * the items as cutted.
397 void cutSelectedItems();
399 /** Copies all selected items to the clipboard. */
400 void copySelectedItems();
402 /** Pastes the clipboard data to this view. */
406 * Pastes the clipboard data into the currently selected
407 * folder. If the current selection is not exactly one folder, no
408 * paste operation is done.
410 void pasteIntoFolder();
413 * Turns on the file preview for the all files of the current directory,
414 * if \a show is true.
415 * If the view properties should be remembered for each directory
416 * (GeneralSettings::globalViewProps() returns false), then the
417 * preview setting will be stored automatically.
419 void setShowPreview(bool show
);
422 * Shows all hidden files of the current directory,
423 * if \a show is true.
424 * If the view properties should be remembered for each directory
425 * (GeneralSettings::globalViewProps() returns false), then the
426 * show hidden file setting will be stored automatically.
428 void setShowHiddenFiles(bool show
);
431 * Summarizes all sorted items by their category \a categorized
433 * If the view properties should be remembered for each directory
434 * (GeneralSettings::globalViewProps() returns false), then the
435 * categorized sorting setting will be stored automatically.
437 void setCategorizedSorting(bool categorized
);
439 /** Switches between an ascending and descending sorting order. */
440 void toggleSortOrder();
442 /** Switches between a separate sorting (with folders first) and a mixed sorting of files and folders. */
443 void toggleSortFoldersFirst();
446 * Switches on or off the displaying of additional information
447 * as specified by \a action.
449 void toggleAdditionalInfo(QAction
* action
);
453 * Is emitted if the view has been activated by e. g. a mouse click.
457 /** Is emitted if URL of the view has been changed to \a url. */
458 void urlChanged(const KUrl
& url
);
461 * Is emitted if the view requests a changing of the current
462 * URL to \a url (see DolphinController::triggerUrlChangeRequest()).
464 void requestUrlChange(const KUrl
& url
);
467 * Is emitted when clicking on an item with the left mouse button.
469 void itemTriggered(const KFileItem
& item
);
472 * Is emitted if a new tab should be opened for the URL \a url.
474 void tabRequested(const KUrl
& url
);
477 * Is emitted if the view mode (IconsView, DetailsView,
478 * PreviewsView) has been changed.
482 /** Is emitted if the 'show preview' property has been changed. */
483 void showPreviewChanged();
485 /** Is emitted if the 'show hidden files' property has been changed. */
486 void showHiddenFilesChanged();
488 /** Is emitted if the 'categorized sorting' property has been changed. */
489 void categorizedSortingChanged();
491 /** Is emitted if the sorting by name, size or date has been changed. */
492 void sortingChanged(DolphinView::Sorting sorting
);
494 /** Is emitted if the sort order (ascending or descending) has been changed. */
495 void sortOrderChanged(Qt::SortOrder order
);
497 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
498 void sortFoldersFirstChanged(bool foldersFirst
);
500 /** Is emitted if the additional information shown for this view has been changed. */
501 void additionalInfoChanged();
503 /** Is emitted if the zoom level has been changed by zooming in or out. */
504 void zoomLevelChanged(int level
);
507 * Is emitted if information of an item is requested to be shown e. g. in the panel.
508 * If item is null, no item information request is pending.
510 void requestItemInfo(const KFileItem
& item
);
512 /** Is emitted if the contents has been moved to \a x, \a y. */
513 void contentsMoved(int x
, int y
);
516 * Is emitted whenever the selection has been changed.
518 void selectionChanged(const KFileItemList
& selection
);
521 * Is emitted if a context menu is requested for the item \a item,
522 * which is part of \a url. If the item is null, the context menu
523 * for the URL should be shown and the custom actions \a customActions
526 void requestContextMenu(const KFileItem
& item
,
528 const QList
<QAction
*>& customActions
);
531 * Is emitted if an information message with the content \a msg
534 void infoMessage(const QString
& msg
);
537 * Is emitted if an error message with the content \a msg
540 void errorMessage(const QString
& msg
);
543 * Is emitted if an "operation completed" message with the content \a msg
546 void operationCompletedMessage(const QString
& msg
);
549 * Is emitted after DolphinView::setUrl() has been invoked and
550 * the path \a url is currently loaded. If this signal is emitted,
551 * it is assured that the view contains already the correct root
552 * URL and property settings.
554 void startedPathLoading(const KUrl
& url
);
557 * Emitted when KDirLister emits redirection.
558 * Testcase: fish://localhost
560 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
563 /** @see QWidget::mouseReleaseEvent */
564 virtual void mouseReleaseEvent(QMouseEvent
* event
);
565 virtual void wheelEvent(QWheelEvent
* event
);
566 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
570 * Marks the view as active (DolphinView:isActive() will return true)
571 * and emits the 'activated' signal if it is not already active.
576 * If the item \a item is a directory, then this
577 * directory will be loaded. If the item is a file, the corresponding
578 * application will get started.
580 void triggerItem(const KFileItem
& index
);
583 * Emits the signal \a selectionChanged() with a small delay. This is
584 * because getting all file items for the signal can be an expensive
585 * operation. Fast selection changes are collected in this case and
586 * the signal is emitted only after no selection change has been done
587 * within a small delay.
589 void emitDelayedSelectionChangedSignal();
592 * Is called by emitDelayedSelectionChangedSignal() and emits the
593 * signal \a selectionChanged() with all selected file items as parameter.
595 void emitSelectionChangedSignal();
598 * Opens the context menu on position \a pos. The position
599 * is used to check whether the context menu is related to an
600 * item or to the viewport.
602 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
605 * Drops dragged URLs to the destination path \a destPath. If
606 * the URLs are dropped above an item inside the destination path,
607 * the item is indicated by \a destItem.
609 void dropUrls(const KFileItem
& destItem
,
610 const KUrl
& destPath
,
614 * Updates the view properties of the current URL to the
615 * sorting given by \a sorting.
617 void updateSorting(DolphinView::Sorting sorting
);
620 * Updates the view properties of the current URL to the
621 * sort order given by \a order.
623 void updateSortOrder(Qt::SortOrder order
);
626 * Updates the view properties of the current URL to the
627 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
629 void updateSortFoldersFirst(bool foldersFirst
);
632 * Updates the view properties of the current URL to the
633 * additional information given by \a info.
635 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
638 * Emits the signal contentsMoved with the current coordinates
639 * of the viewport as parameters.
641 void emitContentsMoved();
644 * Updates the status bar to show hover information for the
645 * item \a item. If currently other items are selected,
646 * no hover information is shown.
647 * @see DolphinView::clearHoverInformation()
649 void showHoverInformation(const KFileItem
& item
);
652 * Clears the hover information shown in the status bar.
653 * @see DolphinView::showHoverInformation().
655 void clearHoverInformation();
658 * Indicates in the status bar that the delete operation
659 * of the job \a job has been finished.
661 void slotDeleteFileFinished(KJob
* job
);
664 * Is emitted if the controller requests a changing of the current
667 void slotRequestUrlChange(const KUrl
& url
);
670 * Invoked when the directory lister has completed the loading of
671 * items. Assures that pasted items and renamed items get seleced.
673 void slotDirListerCompleted();
676 * Is invoked when the KDirLister indicates refreshed items.
678 void slotRefreshItems();
681 * If \a view can be positively identified as not being the source for the
682 * current drag operation, deleteLater() it immediately. Else stores
683 * it for later deletion.
685 void deleteWhenNotDragSource(QAbstractItemView
* view
);
688 * Observes the item with the URL \a url. As soon as the directory
689 * model indicates that the item is available, the item will
690 * get selected and it is assure that the item stays visible.
692 * @see selectAndScrollToCreatedItem()
694 void observeCreatedItem(const KUrl
& url
);
697 * Selects and scrolls to the item that got observed
698 * by observeCreatedItem().
700 void selectAndScrollToCreatedItem();
703 * Restore selection after view refresh.
705 void restoreSelection();
708 void loadDirectory(const KUrl
& url
, bool reload
= false);
711 * Applies the view properties which are defined by the current URL
712 * to the DolphinView properties.
714 void applyViewProperties();
717 * Creates a new view representing the given view mode (DolphinView::mode()).
718 * The current view will get deleted.
724 void initializeView();
727 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
728 * Pastes the clipboard data into the URL \a url.
730 void pasteToUrl(const KUrl
& url
);
733 * Checks whether the current item view has the same zoom level
734 * as \a oldZoomLevel. If this is not the case, the zoom level
735 * of the controller is updated and a zoomLevelChanged() signal
738 void updateZoomLevel(int oldZoomLevel
);
741 * Returns a list of URLs for all selected items. The list is
742 * simplified, so that when the URLs are part of different tree
743 * levels, only the parent is returned.
745 KUrl::List
simplifiedSelectedUrls() const;
748 * Returns the MIME data for all selected items.
750 QMimeData
* selectionMimeData() const;
753 * Is invoked after a paste operation or a drag & drop
754 * operation and adds the filenames of all URLs from \a mimeData to
755 * m_newFileNames. This allows to select all newly added
756 * items in slotDirListerCompleted().
758 void addNewFileNames(const QMimeData
* mimeData
);
762 * Abstracts the access to the different view implementations
763 * for icons-, details- and column-view.
768 ViewAccessor(DolphinSortFilterProxyModel
* proxyModel
);
770 void createView(QWidget
* parent
, DolphinController
* controller
, Mode mode
);
772 bool prepareUrlChange(const KUrl
& url
);
773 QAbstractItemView
* itemView() const;
776 * Returns the widget that should be added to the layout as target. Usually
777 * the item view itself is returned, but in the case of the column view
778 * a container widget is returned.
780 QWidget
* layoutTarget() const;
782 KUrl
rootUrl() const;
784 bool supportsCategorizedSorting() const;
785 bool hasExpandableFolders() const;
786 bool itemsExpandable() const;
789 * Returns true, if a reloading of the items is required
790 * when the additional information properties have been changed
793 bool reloadOnAdditionalInfoChange() const;
795 DolphinModel
* dirModel() const;
796 DolphinSortFilterProxyModel
* proxyModel() const;
797 KDirLister
* dirLister() const;
800 DolphinIconsView
* m_iconsView
;
801 DolphinDetailsView
* m_detailsView
;
802 DolphinColumnViewContainer
* m_columnsContainer
;
803 DolphinSortFilterProxyModel
* m_proxyModel
;
807 bool m_showPreview
: 1;
808 bool m_loadingDirectory
: 1;
809 bool m_storedCategorizedSorting
: 1;
810 bool m_tabsForFiles
: 1;
811 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
812 bool m_ignoreViewProperties
: 1;
813 bool m_assureVisibleCurrentIndex
: 1;
817 DolphinMainWindow
* m_mainWindow
;
818 QVBoxLayout
* m_topLayout
;
820 DolphinController
* m_controller
;
821 DolphinFileItemDelegate
* m_fileItemDelegate
;
822 ViewAccessor m_viewAccessor
;
824 QItemSelectionModel
* m_selectionModel
;
825 QTimer
* m_selectionChangedTimer
;
827 KFilePreviewGenerator
* m_previewGenerator
;
828 ToolTipManager
* m_toolTipManager
;
830 VersionControlObserver
* m_versionControlObserver
;
833 KUrl m_activeItemUrl
;
834 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
835 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
838 * Remembers the filenames that have been added by a paste operation
839 * or a drag & drop operation. Allows to select the items in
840 * slotDirListerCompleted().
842 QSet
<QString
> m_newFileNames
;
844 QAbstractItemView
* m_expandedDragSource
; // TODO: move to ViewAccessor
847 /// Allow using DolphinView::Mode in QVariant
848 Q_DECLARE_METATYPE(DolphinView::Mode
)
850 #endif // DOLPHINVIEW_H