1 /***************************************************************************
2 * Copyright (C) 2006-2009 by Peter Penz <peter.penz19@gmail.com> *
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 ***************************************************************************/
24 #include <config-nepomuk.h>
26 #include "libdolphin_export.h"
28 #include <kparts/part.h>
30 #include <KFileItemDelegate>
31 #include <kio/fileundomanager.h>
36 #include <QLinkedList>
40 typedef KIO::FileUndoManager::CommandType CommandType
;
42 class DolphinDirLister
;
43 class DolphinItemListContainer
;
45 class KActionCollection
;
50 class VersionControlObserver
;
52 class QGraphicsSceneDragDropEvent
;
56 * @short Represents a view for the directory content.
58 * View modes for icons, compact and details are supported. It's
66 class LIBDOLPHINPRIVATE_EXPORT DolphinView
: public QWidget
72 * Defines the view mode for a directory. The
73 * view mode is automatically updated if the directory itself
74 * defines a view mode (see class ViewProperties for details).
79 * The items are shown as icons with a name-label below.
84 * The icon, the name and the size of the items are
85 * shown per default as a table.
90 * The items are shown as icons with the name-label aligned
96 /** Defines the sort order for the items of a directory. */
110 /** Defines the additional information shown for the items of a directory. */
126 * @param url Specifies the content which should be shown.
127 * @param parent Parent widget of the view.
129 DolphinView(const KUrl
& url
, QWidget
* parent
);
131 virtual ~DolphinView();
134 * Returns the current active URL, where all actions are applied.
135 * The URL navigator is synchronized with this URL.
140 * If \a active is true, the view will marked as active. The active
141 * view is defined as view where all actions are applied to.
143 void setActive(bool active
);
144 bool isActive() const;
147 * Changes the view mode for the current directory to \a mode.
148 * If the view properties should be remembered for each directory
149 * (GeneralSettings::globalViewProps() returns false), then the
150 * changed view mode will be stored automatically.
152 void setMode(Mode mode
);
155 /** See setPreviewsShown */
156 bool previewsShown() const;
158 /** See setShowHiddenFiles */
159 bool hiddenFilesShown() const;
161 /** See setCategorizedSorting */
162 bool categorizedSorting() const;
165 * Returns the items of the view.
167 KFileItemList
items() const;
170 * Returns the selected items. The list is empty if no item has been
173 KFileItemList
selectedItems() const;
176 * Returns the number of selected items (this is faster than
177 * invoking selectedItems().count()).
179 int selectedItemsCount() 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 * All items that match to the pattern \a pattern will get selected
191 * if \a enabled is true and deselected if \a enabled is false.
193 void setItemSelectionEnabled(const QRegExp
& pattern
, bool enabled
);
196 * Sets the zoom level to \a level. It is assured that the used
197 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
198 * ZoomLevelInfo::maximumLevel().
200 void setZoomLevel(int level
);
201 int zoomLevel() const;
204 * Returns true, if zooming in is possible. If false is returned,
205 * the maximum zooming level has been reached.
207 bool isZoomInPossible() const;
210 * Returns true, if zooming out is possible. If false is returned,
211 * the minimum zooming level has been reached.
213 bool isZoomOutPossible() const;
215 /** Sets the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */
216 void setSorting(Sorting sorting
);
218 /** Returns the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */
219 Sorting
sorting() const;
221 /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */
222 void setSortOrder(Qt::SortOrder order
);
224 /** Returns the currently used sort order (Qt::Ascending or Qt::Descending). */
225 Qt::SortOrder
sortOrder() const;
227 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
228 void setSortFoldersFirst(bool foldersFirst
);
230 /** Returns if files and folders are sorted separately or not. */
231 bool sortFoldersFirst() const;
233 /** Sets the additional information which should be shown for the items. */
234 void setAdditionalInfoList(const QList
<AdditionalInfo
>& info
);
236 /** Returns the additional information which should be shown for the items. */
237 QList
<AdditionalInfo
> additionalInfoList() const;
239 /** Reloads the current directory. */
245 * Refreshes the view to get synchronized with the (updated) Dolphin settings.
246 * This method only needs to get invoked if the view settings for the Icons View,
247 * Details View or Columns View have been changed.
252 * Filters the currently shown items by \a nameFilter. All items
253 * which contain the given filter string will be shown.
255 void setNameFilter(const QString
& nameFilter
);
256 QString
nameFilter() const;
259 * Calculates the number of currently shown files into
260 * \a fileCount and the number of folders into \a folderCount.
261 * The size of all files is written into \a totalFileSize.
262 * It is recommend using this method instead of asking the
263 * directory lister or the model directly, as it takes
264 * filtering and hierarchical previews into account.
266 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
269 * Returns a textual representation of the state of the current
270 * folder or selected items, suitable for use in the status bar.
272 QString
statusBarText() const;
275 * Returns the version control actions that are provided for the items \p items.
276 * Usually the actions are presented in the context menu.
278 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
281 * Returns the state of the paste action:
282 * first is whether the action should be enabled
283 * second is the text for the action
285 QPair
<bool, QString
> pasteInfo() const;
288 * If \a tabsForFiles is true, the signal tabRequested() will also
289 * emitted also for files. Per default tabs for files is disabled
290 * and hence the signal tabRequested() will only be emitted for
293 void setTabsForFilesEnabled(bool tabsForFiles
);
294 bool isTabsForFilesEnabled() const;
297 * Returns true if the current view allows folders to be expanded,
298 * i.e. presents a hierarchical view to the user.
300 bool itemsExpandable() const;
303 * Restores the view state (current item, contents position, details view expansion state)
305 void restoreState(QDataStream
& stream
);
308 * Saves the view state (current item, contents position, details view expansion state)
310 void saveState(QDataStream
& stream
);
312 /** Returns true, if at least one item is selected. */
313 bool hasSelection() const;
316 * Returns the root item which represents the current URL. Note that the returned
317 * item can be null (KFileItem::isNull() will return true) in case that the directory
318 * has not been loaded.
320 KFileItem
rootItem() const;
324 * Changes the directory to \a url. If the current directory is equal to
325 * \a url, nothing will be done (use DolphinView::reload() instead).
327 void setUrl(const KUrl
& url
);
331 * @see DolphinView::selectedItems()
336 * Inverts the current selection: selected items get unselected,
337 * unselected items get selected.
338 * @see DolphinView::selectedItems()
340 void invertSelection();
342 void clearSelection();
345 * Triggers the renaming of the currently selected items, where
346 * the user must input a new name for the items.
348 void renameSelectedItems();
351 * Moves all selected items to the trash.
353 void trashSelectedItems();
356 * Deletes all selected items.
358 void deleteSelectedItems();
361 * Copies all selected items to the clipboard and marks
364 void cutSelectedItems();
366 /** Copies all selected items to the clipboard. */
367 void copySelectedItems();
369 /** Pastes the clipboard data to this view. */
373 * Pastes the clipboard data into the currently selected
374 * folder. If the current selection is not exactly one folder, no
375 * paste operation is done.
377 void pasteIntoFolder();
380 * Turns on the file preview for the all files of the current directory,
381 * if \a show is true.
382 * If the view properties should be remembered for each directory
383 * (GeneralSettings::globalViewProps() returns false), then the
384 * preview setting will be stored automatically.
386 void setPreviewsShown(bool show
);
389 * Shows all hidden files of the current directory,
390 * if \a show is true.
391 * If the view properties should be remembered for each directory
392 * (GeneralSettings::globalViewProps() returns false), then the
393 * show hidden file setting will be stored automatically.
395 void setHiddenFilesShown(bool show
);
398 * Summarizes all sorted items by their category \a categorized
400 * If the view properties should be remembered for each directory
401 * (GeneralSettings::globalViewProps() returns false), then the
402 * categorized sorting setting will be stored automatically.
404 void setCategorizedSorting(bool categorized
);
408 * Is emitted if the view has been activated by e. g. a mouse click.
413 * Is emitted if the URL of the view will be changed to \a url.
414 * After the URL has been changed the signal urlChanged() will
417 void urlAboutToBeChanged(const KUrl
& url
);
419 /** Is emitted if the URL of the view has been changed to \a url. */
420 void urlChanged(const KUrl
& url
);
423 * Is emitted when clicking on an item with the left mouse button.
425 void itemActivated(const KFileItem
& item
);
428 * Is emitted if items have been added or deleted.
430 void itemCountChanged();
433 * Is emitted if a new tab should be opened for the URL \a url.
435 void tabRequested(const KUrl
& url
);
438 * Is emitted if the view mode (IconsView, DetailsView,
439 * PreviewsView) has been changed.
441 void modeChanged(DolphinView::Mode current
, DolphinView::Mode previous
);
443 /** Is emitted if the 'show preview' property has been changed. */
444 void previewsShownChanged(bool shown
);
446 /** Is emitted if the 'show hidden files' property has been changed. */
447 void hiddenFilesShownChanged(bool shown
);
449 /** Is emitted if the 'categorized sorting' property has been changed. */
450 void categorizedSortingChanged(bool sortCategorized
);
452 /** Is emitted if the sorting by name, size or date has been changed. */
453 void sortingChanged(DolphinView::Sorting sorting
);
455 /** Is emitted if the sort order (ascending or descending) has been changed. */
456 void sortOrderChanged(Qt::SortOrder order
);
458 /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */
459 void sortFoldersFirstChanged(bool foldersFirst
);
461 /** Is emitted if the additional information shown for this view has been changed. */
462 void additionalInfoListChanged(const QList
<DolphinView::AdditionalInfo
>& current
,
463 const QList
<DolphinView::AdditionalInfo
>& previous
);
465 /** Is emitted if the zoom level has been changed by zooming in or out. */
466 void zoomLevelChanged(int current
, int previous
);
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 * Is emitted after DolphinView::setUrl() has been invoked and provides
523 * the information how much percent of the current path have been loaded.
525 void pathLoadingProgress(int percent
);
528 * Is emitted if the DolphinView::setUrl() is invoked but the URL is not
531 void urlIsFileError(const KUrl
& file
);
534 * Emitted when KDirLister emits redirection.
535 * Testcase: fish://localhost
537 void redirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
540 * Is emitted when the write state of the folder has been changed. The application
541 * should disable all actions like "Create New..." that depend on the write
544 void writeStateChanged(bool isFolderWritable
);
547 virtual void mouseReleaseEvent(QMouseEvent
* event
);
548 virtual void contextMenuEvent(QContextMenuEvent
* event
);
549 virtual void wheelEvent(QWheelEvent
* event
);
553 * Marks the view as active (DolphinView:isActive() will return true)
554 * and emits the 'activated' signal if it is not already active.
558 void slotItemActivated(int index
);
559 void slotItemMiddleClicked(int index
);
560 void slotContextMenuRequested(int index
, const QPointF
& pos
);
561 void slotItemExpansionToggleClicked(int index
);
562 void slotItemHovered(int index
);
563 void slotItemUnhovered(int index
);
564 void slotItemDropEvent(int index
, QGraphicsSceneDragDropEvent
* event
);
565 void slotModelChanged(KItemModelBase
* current
, KItemModelBase
* previous
);
568 * Emits the signal \a selectionChanged() with a small delay. This is
569 * because getting all file items for the selection can be an expensive
570 * operation. Fast selection changes are collected in this case and
571 * the signal is emitted only after no selection change has been done
572 * within a small delay.
574 void slotSelectionChanged(const QSet
<int>& current
, const QSet
<int>& previous
);
577 * Is called by emitDelayedSelectionChangedSignal() and emits the
578 * signal \a selectionChanged() with all selected file items as parameter.
580 void emitSelectionChangedSignal();
583 * Opens the context menu on position \a pos. The position
584 * is used to check whether the context menu is related to an
585 * item or to the viewport.
587 void openContextMenu(const QPoint
& pos
, const QList
<QAction
*>& customActions
);
590 * Drops dragged URLs to the destination path \a destPath. If
591 * the URLs are dropped above an item inside the destination path,
592 * the item is indicated by \a destItem.
594 void dropUrls(const KFileItem
& destItem
,
595 const KUrl
& destPath
,
599 * Updates the view properties of the current URL to the
600 * sorting given by \a sorting.
602 void updateSorting(DolphinView::Sorting sorting
);
605 * Updates the view properties of the current URL to the
606 * sort order given by \a order.
608 void updateSortOrder(Qt::SortOrder order
);
611 * Updates the view properties of the current URL to the
612 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
614 void updateSortFoldersFirst(bool foldersFirst
);
617 * Updates the status bar to show hover information for the
618 * item \a item. If currently other items are selected,
619 * no hover information is shown.
620 * @see DolphinView::clearHoverInformation()
622 void showHoverInformation(const KFileItem
& item
);
625 * Clears the hover information shown in the status bar.
626 * @see DolphinView::showHoverInformation().
628 void clearHoverInformation();
631 * Indicates in the status bar that the delete operation
632 * of the job \a job has been finished.
634 void slotDeleteFileFinished(KJob
* job
);
637 * Invoked when the directory lister has been started the
640 void slotDirListerStarted(const KUrl
& url
);
643 * Invoked when the file item model indicates that the directory lister has completed the loading
644 * of items, and that expanded folders have been restored (if the view mode is 'Details', and the
645 * view state is restored after navigating back or forward in history). Assures that pasted items
646 * and renamed items get seleced.
648 void slotLoadingCompleted();
651 * Is invoked when the KDirLister indicates refreshed items.
653 void slotRefreshItems();
656 * Observes the item with the URL \a url. As soon as the directory
657 * model indicates that the item is available, the item will
658 * get selected and it is assured that the item stays visible.
660 * @see selectAndScrollToCreatedItem()
662 void observeCreatedItem(const KUrl
& url
);
665 * Selects and scrolls to the item that got observed
666 * by observeCreatedItem().
668 void selectAndScrollToCreatedItem();
671 * Called when a redirection happens.
672 * Testcase: fish://localhost
674 void slotRedirection(const KUrl
& oldUrl
, const KUrl
& newUrl
);
677 * Applies the state that has been restored by restoreViewState()
680 void updateViewState();
682 //void slotUrlChangeRequested(const KUrl& url);
685 KFileItemModel
* fileItemModel() const;
687 void loadDirectory(const KUrl
& url
, bool reload
= false);
690 * Applies the view properties which are defined by the current URL
691 * to the DolphinView properties.
693 void applyViewProperties();
695 void applyAdditionalInfoListToView();
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 URLs from \a mimeData as selected.
726 * This allows to select all newly pasted
727 * items in restoreViewState().
729 void markPastedUrlsAsSelected(const QMimeData
* mimeData
);
732 * Updates m_isFolderWritable dependent on whether the folder represented by
733 * the current URL is writable. If the state has changed, the signal
734 * writeableStateChanged() will be emitted.
736 void updateWritableState();
738 QByteArray
sortRoleForSorting(Sorting sorting
) const;
742 bool m_tabsForFiles
: 1;
743 bool m_assureVisibleCurrentIndex
: 1;
744 bool m_isFolderWritable
: 1;
748 QList
<AdditionalInfo
> m_additionalInfoList
;
750 QVBoxLayout
* m_topLayout
;
752 DolphinDirLister
* m_dirLister
;
753 DolphinItemListContainer
* m_container
;
755 ToolTipManager
* m_toolTipManager
;
757 QTimer
* m_selectionChangedTimer
;
759 int m_currentItemIndex
;
760 QPoint m_restoredContentsPosition
;
761 KUrl m_createdItemUrl
; // URL for a new item that got created by the "Create New..." menu
762 KFileItemList m_selectedItems
; // this is used for making the View to remember selections after F5
764 VersionControlObserver
* m_versionControlObserver
;
767 friend class TestBase
;
768 friend class DolphinDetailsViewTest
;
771 /// Allow using DolphinView::Mode in QVariant
772 Q_DECLARE_METATYPE(DolphinView::Mode
)
774 #endif // DOLPHINVIEW_H