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>
31 #include <KFileItemDelegate>
32 #include <kio/fileundomanager.h>
37 #include <QLinkedList>
42 typedef KIO::FileUndoManager::CommandType CommandType
;
44 class DolphinColumnViewContainer
;
45 class DolphinDetailsView
;
46 class DolphinDetailsViewExpander
;
47 class DolphinIconsView
;
49 class DolphinSortFilterProxyModel
;
50 class DolphinViewController
;
52 class KActionCollection
;
55 class ViewModeController
;
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 MaxSortingEnum
= SortByPath
122 * @param url Specifies the content which should be shown.
123 * @param parent Parent widget of the view.
125 DolphinView( const KUrl
& url
, QWidget
* parent
);
127 virtual ~DolphinView();
130 * Returns the current active URL, where all actions are applied.
131 * The URL navigator is synchronized with this URL.
136 * Returns the root URL of the view, which is defined as the first
137 * visible path of DolphinView::url(). Usually the root URL is
138 * equal to DolphinView::url(), but in the case of the column view
139 * when 2 columns are shown, the root URL might be:
140 * /home/peter/Documents
141 * and DolphinView::url() might return
142 * /home/peter/Documents/Music/
144 KUrl
rootUrl() const;
147 * If \a active is true, the view will marked as active. The active
148 * view is defined as view where all actions are applied to.
150 void setActive(bool active
);
151 bool isActive() const;
154 * Changes the view mode for the current directory to \a mode.
155 * If the view properties should be remembered for each directory
156 * (GeneralSettings::globalViewProps() returns false), then the
157 * changed view mode will be stored automatically.
159 void setMode(Mode mode
);
162 /** See setShowPreview */
163 bool showPreview() const;
165 /** See setShowHiddenFiles */
166 bool showHiddenFiles() const;
168 /** See setCategorizedSorting */
169 bool categorizedSorting() const;
172 * Returns true, if the categorized sorting is supported by the current
173 * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView
174 * supports categorizations. To check whether the categorized
175 * sorting is set, use DolphinView::categorizedSorting().
177 bool supportsCategorizedSorting() const;
180 * Returns the root item which represents the current URL. Note that the returned
181 * item can be null (KFileItem::isNull() will return true) in case that the directory
182 * has not been loaded.
184 KFileItem
rootItem() const;
187 * Returns the items of the view.
189 KFileItemList
items() const;
192 * Returns the selected items. The list is empty if no item has been
195 KFileItemList
selectedItems() const;
198 * Returns the number of selected items (this is faster than
199 * invoking selectedItems().count()).
201 int selectedItemsCount() const;
204 * Marks the items indicated by \p urls to get selected after the
205 * directory DolphinView::url() has been loaded. Note that nothing
206 * gets selected if no loading of a directory has been triggered
207 * by DolphinView::setUrl() or DolphinView::reload().
209 void markUrlsAsSelected(const QList
<KUrl
>& urls
);
212 * All items that match to the pattern \a pattern will get selected
213 * if \a enabled is true and deselected if \a enabled is false.
215 void setItemSelectionEnabled(const QRegExp
& pattern
, bool enabled
);
218 * Sets the zoom level to \a level. It is assured that the used
219 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
220 * ZoomLevelInfo::maximumLevel().
222 void setZoomLevel(int level
);
223 int zoomLevel() const;
226 * Returns true, if zooming in is possible. If false is returned,
227 * the maximum zooming level has been reached.
229 bool isZoomInPossible() const;
232 * Returns true, if zooming out is possible. If false is returned,
233 * the minimum zooming level has been reached.
235 bool isZoomOutPossible() const;
237 /** Sets the sort order of the items inside a directory (see DolphinView::Sorting). */
238 void setSorting(Sorting sorting
);
240 /** Returns the sort order of the items inside a directory (see DolphinView::Sorting). */
241 Sorting
sorting() const;
243 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
244 void setSortOrder(Qt::SortOrder order
);
246 /** Returns the current used sort order (Qt::Ascending or Qt::Descending). */
247 Qt::SortOrder
sortOrder() const;
249 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
250 void setSortFoldersFirst(bool foldersFirst
);
252 /** Returns if files and folders are sorted separately or not. */
253 bool sortFoldersFirst() const;
255 /** Sets the additional information which should be shown for the items. */
256 void setAdditionalInfo(KFileItemDelegate::InformationList info
);
258 /** Returns the additional information which should be shown for the items. */
259 KFileItemDelegate::InformationList
additionalInfo() const;
261 /** Reloads the current directory. */
267 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
268 * This method only needs to get invoked if the view settings for the Icons View,
269 * Details View or Columns View have been changed.
274 * Filters the currently shown items by \a nameFilter. All items
275 * which contain the given filter string will be shown.
277 void setNameFilter(const QString
& nameFilter
);
278 QString
nameFilter() const;
281 * Calculates the number of currently shown files into
282 * \a fileCount and the number of folders into \a folderCount.
283 * The size of all files is written into \a totalFileSize.
284 * It is recommend using this method instead of asking the
285 * directory lister or the model directly, as it takes
286 * filtering and hierarchical previews into account.
288 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
291 * Returns a textual representation of the state of the current
292 * folder or selected items, suitable for use in the status bar.
294 QString
statusBarText() const;
297 * Returns the version control actions that are provided for the items \p items.
298 * Usually the actions are presented in the context menu.
300 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
303 * Updates the state of the 'Additional Information' actions in \a collection.
305 void updateAdditionalInfoActions(KActionCollection
* collection
);
308 * Returns the state of the paste action:
309 * first is whether the action should be enabled
310 * second is the text for the action
312 QPair
<bool, QString
> pasteInfo() const;
315 * If \a tabsForFiles is true, the signal tabRequested() will also
316 * emitted also for files. Per default tabs for files is disabled
317 * and hence the signal tabRequested() will only be emitted for
320 void setTabsForFilesEnabled(bool tabsForFiles
);
321 bool isTabsForFilesEnabled() const;
324 * Returns true if the current view allows folders to be expanded,
325 * i.e. presents a hierarchical view to the user.
327 bool itemsExpandable() const;
330 * Restores the view state (current item, contents position, details view expansion state)
332 void restoreState(QDataStream
& stream
);
335 * Saves the view state (current item, contents position, details view expansion state)
337 void saveState(QDataStream
& stream
);
339 /** Returns true, if at least one item is selected. */
340 bool hasSelection() const;
344 * Changes the directory to \a url. If the current directory is equal to
345 * \a url, nothing will be done (use DolphinView::reload() instead).
347 void setUrl(const KUrl
& url
);
351 * @see DolphinView::selectedItems()
356 * Inverts the current selection: selected items get unselected,
357 * unselected items get selected.
358 * @see DolphinView::selectedItems()
360 void invertSelection();
362 void clearSelection();
365 * Triggers the renaming of the currently selected items, where
366 * the user must input a new name for the items.
368 void renameSelectedItems();
371 * Moves all selected items to the trash.
373 void trashSelectedItems();
376 * Deletes all selected items.
378 void deleteSelectedItems();
381 * Copies all selected items to the clipboard and marks
384 void cutSelectedItems();
386 /** Copies all selected items to the clipboard. */
387 void copySelectedItems();
389 /** Pastes the clipboard data to this view. */
393 * Pastes the clipboard data into the currently selected
394 * folder. If the current selection is not exactly one folder, no
395 * paste operation is done.
397 void pasteIntoFolder();
400 * Turns on the file preview for the all 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 * preview setting will be stored automatically.
406 void setShowPreview(bool show
);
409 * Shows all hidden files of the current directory,
410 * if \a show is true.
411 * If the view properties should be remembered for each directory
412 * (GeneralSettings::globalViewProps() returns false), then the
413 * show hidden file setting will be stored automatically.
415 void setShowHiddenFiles(bool show
);
418 * Summarizes all sorted items by their category \a categorized
420 * If the view properties should be remembered for each directory
421 * (GeneralSettings::globalViewProps() returns false), then the
422 * categorized sorting setting will be stored automatically.
424 void setCategorizedSorting(bool categorized
);
428 * Is emitted if the view has been activated by e. g. a mouse click.
432 /** Is emitted if URL of the view has been changed to \a url. */
433 void urlChanged(const KUrl
& url
);
436 * Is emitted when clicking on an item with the left mouse button.
438 void itemTriggered(const KFileItem
& item
);
441 * Is emitted if items have been added or deleted.
443 void itemCountChanged();
446 * Is emitted if a new tab should be opened for the URL \a url.
448 void tabRequested(const KUrl
& url
);
451 * Is emitted if the view mode (IconsView, DetailsView,
452 * PreviewsView) has been changed.
456 /** Is emitted if the 'show preview' property has been changed. */
457 void showPreviewChanged();
459 /** Is emitted if the 'show hidden files' property has been changed. */
460 void showHiddenFilesChanged();
462 /** Is emitted if the 'categorized sorting' property has been changed. */
463 void categorizedSortingChanged();
465 /** Is emitted if the sorting by name, size or date has been changed. */
466 void sortingChanged(DolphinView::Sorting sorting
);
468 /** Is emitted if the sort order (ascending or descending) has been changed. */
469 void sortOrderChanged(Qt::SortOrder order
);
471 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
472 void sortFoldersFirstChanged(bool foldersFirst
);
474 /** Is emitted if the additional information shown for this view has been changed. */
475 void additionalInfoChanged();
477 /** Is emitted if the zoom level has been changed by zooming in or out. */
478 void zoomLevelChanged(int level
);
481 * Is emitted if information of an item is requested to be shown e. g. in the panel.
482 * If item is null, no item information request is pending.
484 void requestItemInfo(const KFileItem
& item
);
487 * Is emitted whenever the selection has been changed.
489 void selectionChanged(const KFileItemList
& selection
);
492 * Is emitted if a context menu is requested for the item \a item,
493 * which is part of \a url. If the item is null, the context menu
494 * for the URL should be shown and the custom actions \a customActions
497 void requestContextMenu(const KFileItem
& item
,
499 const QList
<QAction
*>& customActions
);
502 * Is emitted if an information message with the content \a msg
505 void infoMessage(const QString
& msg
);
508 * Is emitted if an error message with the content \a msg
511 void errorMessage(const QString
& msg
);
514 * Is emitted if an "operation completed" message with the content \a msg
517 void operationCompletedMessage(const QString
& msg
);
520 * Is emitted after DolphinView::setUrl() has been invoked and
521 * the path \a url is currently loaded. If this signal is emitted,
522 * it is assured that the view contains already the correct root
523 * URL and property settings.
525 void startedPathLoading(const KUrl
& url
);
528 * Is emitted after the path triggered by DolphinView::setUrl()
531 void finishedPathLoading(const KUrl
& url
);
534 * Is emitted after DolphinView::setUrl() has been invoked and provides
535 * the information how much percent of the current path have been loaded.
537 void pathLoadingProgress(int percent
);
540 * Is emitted if the DolphinView::setUrl() is invoked but the URL is not
543 void urlIsFileError(const KUrl
& file
);
546 * Emitted when KDirLister emits redirection.
547 * Testcase: fish://localhost
549 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
552 * Is emitted when the write state of the folder has been changed. The application
553 * should disable all actions like "Create New..." that depend on the write
556 void writeStateChanged(bool isFolderWritable
);
559 /** @see QWidget::mouseReleaseEvent */
560 virtual void mouseReleaseEvent(QMouseEvent
* event
);
561 virtual bool eventFilter(QObject
* watched
, QEvent
* event
);
565 * Marks the view as active (DolphinView:isActive() will return true)
566 * and emits the 'activated' signal if it is not already active.
571 * If the item \a item is a directory, then this
572 * directory will be loaded. If the item is a file, the corresponding
573 * application will get started.
575 void triggerItem(const KFileItem
& index
);
578 * Emits the signal \a selectionChanged() with a small delay. This is
579 * because getting all file items for the signal can be an expensive
580 * operation. Fast selection changes are collected in this case and
581 * the signal is emitted only after no selection change has been done
582 * within a small delay.
584 void slotSelectionChanged(const QItemSelection
& selected
, const QItemSelection
& deselected
);
587 * Is called by emitDelayedSelectionChangedSignal() and emits the
588 * signal \a selectionChanged() with all selected file items as parameter.
590 void emitSelectionChangedSignal();
593 * Opens the context menu on position \a pos. The position
594 * is used to check whether the context menu is related to an
595 * item or to the viewport.
597 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
600 * Drops dragged URLs to the destination path \a destPath. If
601 * the URLs are dropped above an item inside the destination path,
602 * the item is indicated by \a destItem.
604 void dropUrls(const KFileItem
& destItem
,
605 const KUrl
& destPath
,
609 * Updates the view properties of the current URL to the
610 * sorting given by \a sorting.
612 void updateSorting(DolphinView::Sorting sorting
);
615 * Updates the view properties of the current URL to the
616 * sort order given by \a order.
618 void updateSortOrder(Qt::SortOrder order
);
621 * Updates the view properties of the current URL to the
622 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
624 void updateSortFoldersFirst(bool foldersFirst
);
627 * Updates the view properties of the current URL to the
628 * additional information given by \a info.
630 void updateAdditionalInfo(const KFileItemDelegate::InformationList
& info
);
633 * Updates the status bar to show hover information for the
634 * item \a item. If currently other items are selected,
635 * no hover information is shown.
636 * @see DolphinView::clearHoverInformation()
638 void showHoverInformation(const KFileItem
& item
);
641 * Clears the hover information shown in the status bar.
642 * @see DolphinView::showHoverInformation().
644 void clearHoverInformation();
647 * Indicates in the status bar that the delete operation
648 * of the job \a job has been finished.
650 void slotDeleteFileFinished(KJob
* job
);
653 * Invoked when the directory lister has been started the
656 void slotDirListerStarted(const KUrl
& url
);
659 * Invoked when the directory lister has completed the loading of
660 * items. Assures that pasted items and renamed items get seleced.
662 void slotDirListerCompleted();
665 * Invoked when the loading of the directory is finished.
666 * Restores the active item and the scroll position if possible.
668 void slotLoadingCompleted();
671 * Is invoked when the KDirLister indicates refreshed items.
673 void slotRefreshItems();
676 * Observes the item with the URL \a url. As soon as the directory
677 * model indicates that the item is available, the item will
678 * get selected and it is assure that the item stays visible.
680 * @see selectAndScrollToCreatedItem()
682 void observeCreatedItem(const KUrl
& url
);
685 * Selects and scrolls to the item that got observed
686 * by observeCreatedItem().
688 void selectAndScrollToCreatedItem();
691 * Called when a redirection happens.
692 * Testcase: fish://localhost
694 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
697 * Restores the contents position, if history information about the old position is available.
699 void restoreContentsPosition();
701 void slotUrlChangeRequested(const KUrl
& url
);
704 void loadDirectory(const KUrl
& url
, bool reload
= false);
707 * Applies the view properties which are defined by the current URL
708 * to the DolphinView properties.
710 void applyViewProperties();
713 * Creates a new view representing the given view mode (DolphinView::mode()).
714 * The current view will get deleted.
721 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
722 * Pastes the clipboard data into the URL \a url.
724 void pasteToUrl(const KUrl
& url
);
727 * Checks whether the current item view has the same zoom level
728 * as \a oldZoomLevel. If this is not the case, the zoom level
729 * of the controller is updated and a zoomLevelChanged() signal
732 void updateZoomLevel(int oldZoomLevel
);
735 * Returns a list of URLs for all selected items. The list is
736 * simplified, so that when the URLs are part of different tree
737 * levels, only the parent is returned.
739 KUrl::List
simplifiedSelectedUrls() const;
742 * Returns the MIME data for all selected items.
744 QMimeData
* selectionMimeData() const;
747 * Is invoked after a paste operation or a drag & drop
748 * operation and adds the filenames of all URLs from \a mimeData to
749 * m_newFileNames. This allows to select all newly added
750 * items in slotDirListerCompleted().
752 void addNewFileNames(const QMimeData
* mimeData
);
755 * Helper method for DolphinView::setItemSelectionEnabled(): Returns the selection for
756 * all items of \p parent that match with the regular expression defined by \p pattern.
758 QItemSelection
childrenMatchingPattern(const QModelIndex
& parent
, const QRegExp
& pattern
) const;
760 void connectViewAccessor();
761 void disconnectViewAccessor();
764 * Updates m_isFolderWritable dependent on whether the folder represented by
765 * the current URL is writable. If the state has changed, the signal
766 * writeableStateChanged() will be emitted.
768 void updateWritableState();
772 * Abstracts the access to the different view implementations
773 * for icons-, details- and column-view.
781 void createView(QWidget
* parent
,
782 DolphinViewController
* dolphinViewController
,
783 const ViewModeController
* viewModeController
,
788 * Must be invoked before the URL has been changed and allows view implementations
789 * like the column view to create a new column.
791 void prepareUrlChange(const KUrl
& url
);
793 QAbstractItemView
* itemView() const;
794 KFileItemDelegate
* itemDelegate() const;
797 * Returns the widget that should be added to the layout as target. Usually
798 * the item view itself is returned, but in the case of the column view
799 * a container widget is returned.
801 QWidget
* layoutTarget() const;
803 void setRootUrl(const KUrl
& rootUrl
);
804 KUrl
rootUrl() const;
806 bool supportsCategorizedSorting() const;
807 bool itemsExpandable() const;
808 QSet
<KUrl
> expandedUrls() const;
809 const DolphinDetailsViewExpander
* setExpandedUrls(const QSet
<KUrl
>& urlsToExpand
);
812 * Returns true, if a reloading of the items is required
813 * when the additional information properties have been changed
816 bool reloadOnAdditionalInfoChange() const;
818 DolphinModel
* dirModel() const;
819 DolphinSortFilterProxyModel
* proxyModel() const;
820 KDirLister
* dirLister() const;
824 DolphinIconsView
* m_iconsView
;
825 DolphinDetailsView
* m_detailsView
;
826 DolphinColumnViewContainer
* m_columnsContainer
;
827 DolphinModel
* m_dolphinModel
;
828 DolphinSortFilterProxyModel
* m_proxyModel
;
829 QAbstractItemView
* m_dragSource
;
830 QPointer
<DolphinDetailsViewExpander
> m_detailsViewExpander
;
833 friend class DolphinDetailsViewTest
;
837 bool m_showPreview
: 1;
838 bool m_storedCategorizedSorting
: 1;
839 bool m_tabsForFiles
: 1;
840 bool m_isContextMenuOpen
: 1; // TODO: workaround for Qt-issue 207192
841 bool m_assureVisibleCurrentIndex
: 1;
842 bool m_expanderActive
: 1;
843 bool m_isFolderWritable
: 1;
847 QVBoxLayout
* m_topLayout
;
849 DolphinViewController
* m_dolphinViewController
;
850 ViewModeController
* m_viewModeController
;
851 ViewAccessor m_viewAccessor
;
853 QTimer
* m_selectionChangedTimer
;
855 KUrl m_activeItemUrl
;
856 QPoint m_restoredContentsPosition
;
857 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
858 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
861 * Remembers the filenames that have been added by a paste operation
862 * or a drag & drop operation. Allows to select the items in
863 * slotDirListerCompleted().
865 QSet
<QString
> m_newFileNames
;
868 friend class TestBase
;
869 friend class DolphinDetailsViewTest
;
872 /// Allow using DolphinView::Mode in QVariant
873 Q_DECLARE_METATYPE(DolphinView::Mode
)
875 #endif // DOLPHINVIEW_H