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 "dolphintabwidget.h"
25 #include "dolphin_export.h"
26 #include "tooltips/tooltipmanager.h"
30 #include <config-baloo.h>
31 #include <kio/fileundomanager.h>
32 #include <kparts/part.h>
38 typedef KIO::FileUndoManager::CommandType CommandType
;
40 class DolphinItemListView
;
42 class KItemListContainer
;
46 class VersionControlObserver
;
48 class QGraphicsSceneDragDropEvent
;
49 class QRegularExpression
;
52 * @short Represents a view for the directory content.
54 * View modes for icons, compact and details are supported. It's
62 class DOLPHIN_EXPORT DolphinView
: public QWidget
68 * Defines the view mode for a directory. The
69 * view mode is automatically updated if the directory itself
70 * defines a view mode (see class ViewProperties for details).
75 * The items are shown as icons with a name-label below.
80 * The icon, the name and the size of the items are
81 * shown per default as a table.
86 * The items are shown as icons with the name-label aligned
93 * @param url Specifies the content which should be shown.
94 * @param parent Parent widget of the view.
96 DolphinView(const QUrl
& url
, QWidget
* parent
);
98 ~DolphinView() override
;
101 * Returns the current active URL, where all actions are applied.
102 * The URL navigator is synchronized with this URL.
107 * If \a active is true, the view will marked as active. The active
108 * view is defined as view where all actions are applied to.
110 void setActive(bool active
);
111 bool isActive() const;
114 * Changes the view mode for the current directory to \a mode.
115 * If the view properties should be remembered for each directory
116 * (GeneralSettings::globalViewProps() returns false), then the
117 * changed view mode will be stored automatically.
119 void setMode(Mode mode
);
123 * Turns on the file preview for the all files of the current directory,
124 * if \a show is true.
125 * If the view properties should be remembered for each directory
126 * (GeneralSettings::globalViewProps() returns false), then the
127 * preview setting will be stored automatically.
129 void setPreviewsShown(bool show
);
130 bool previewsShown() const;
133 * Shows all hidden files of the current directory,
134 * if \a show is true.
135 * If the view properties should be remembered for each directory
136 * (GeneralSettings::globalViewProps() returns false), then the
137 * show hidden file setting will be stored automatically.
139 void setHiddenFilesShown(bool show
);
140 bool hiddenFilesShown() const;
143 * Turns on sorting by groups if \a enable is true.
145 void setGroupedSorting(bool grouped
);
146 bool groupedSorting() const;
149 * Returns the items of the view.
151 KFileItemList
items() const;
154 * @return The number of items. itemsCount() is faster in comparison
155 * to items().count().
157 int itemsCount() const;
160 * Returns the selected items. The list is empty if no item has been
163 KFileItemList
selectedItems() const;
166 * Returns the number of selected items (this is faster than
167 * invoking selectedItems().count()).
169 int selectedItemsCount() const;
172 * Marks the items indicated by \p urls to get selected after the
173 * directory DolphinView::url() has been loaded. Note that nothing
174 * gets selected if no loading of a directory has been triggered
175 * by DolphinView::setUrl() or DolphinView::reload().
177 void markUrlsAsSelected(const QList
<QUrl
> &urls
);
180 * Marks the item indicated by \p url to be scrolled to and as the
181 * current item after directory DolphinView::url() has been loaded.
183 void markUrlAsCurrent(const QUrl
& url
);
186 * All items that match the regular expression \a regexp will get selected
187 * if \a enabled is true and deselected if \a enabled is false.
189 * Note that to match the whole string the pattern should be anchored:
190 * - you can anchor the pattern with QRegularExpression::anchoredPattern()
191 * - if you use QRegularExpresssion::wildcardToRegularExpression(), don't use
192 * QRegularExpression::anchoredPattern() as the former already returns an
195 void selectItems(const QRegularExpression
®exp
, bool enabled
);
198 * Sets the zoom level to \a level. It is assured that the used
199 * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and
200 * ZoomLevelInfo::maximumLevel().
202 void setZoomLevel(int level
);
203 int zoomLevel() const;
206 * Resets the view's icon size to the default value
208 void resetZoomLevel();
210 void setSortRole(const QByteArray
& role
);
211 QByteArray
sortRole() const;
213 void setSortOrder(Qt::SortOrder order
);
214 Qt::SortOrder
sortOrder() const;
216 /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */
217 void setSortFoldersFirst(bool foldersFirst
);
218 bool sortFoldersFirst() const;
220 /** Sets the additional information which should be shown for the items. */
221 void setVisibleRoles(const QList
<QByteArray
>& roles
);
223 /** Returns the additional information which should be shown for the items. */
224 QList
<QByteArray
> visibleRoles() const;
229 * Refreshes the view to get synchronized with the settings (e.g. icons size,
235 * Saves the current settings (e.g. icons size, font, ..).
237 void writeSettings();
240 * Filters the currently shown items by \a nameFilter. All items
241 * which contain the given filter string will be shown.
243 void setNameFilter(const QString
& nameFilter
);
244 QString
nameFilter() const;
247 * Filters the currently shown items by \a filters. All items
248 * whose content-type matches those given by the list of filters
251 void setMimeTypeFilters(const QStringList
& filters
);
252 QStringList
mimeTypeFilters() const;
255 * Returns a textual representation of the state of the current
256 * folder or selected items, suitable for use in the status bar.
258 QString
statusBarText() const;
261 * Returns the version control actions that are provided for the items \p items.
262 * Usually the actions are presented in the context menu.
264 QList
<QAction
*> versionControlActions(const KFileItemList
& items
) const;
267 * Returns the state of the paste action:
268 * first is whether the action should be enabled
269 * second is the text for the action
271 QPair
<bool, QString
> pasteInfo() const;
274 * If \a tabsForFiles is true, the signal tabRequested() will also
275 * emitted also for files. Per default tabs for files is disabled
276 * and hence the signal tabRequested() will only be emitted for
279 void setTabsForFilesEnabled(bool tabsForFiles
);
280 bool isTabsForFilesEnabled() const;
283 * Returns true if the current view allows folders to be expanded,
284 * i.e. presents a hierarchical view to the user.
286 bool itemsExpandable() const;
289 * Restores the view state (current item, contents position, details view expansion state)
291 void restoreState(QDataStream
& stream
);
294 * Saves the view state (current item, contents position, details view expansion state)
296 void saveState(QDataStream
& stream
);
299 * Returns the root item which represents the current URL.
301 KFileItem
rootItem() const;
304 * Sets a context that is used for remembering the view-properties.
305 * Per default the context is empty and the path of the currently set URL
306 * is used for remembering the view-properties. Setting a custom context
307 * makes sense if specific types of URLs (e.g. search-URLs) should
308 * share common view-properties.
310 void setViewPropertiesContext(const QString
& context
);
311 QString
viewPropertiesContext() const;
314 * Checks if the given \a item can be opened as folder (e.g. archives).
315 * This function will also adjust the \a url (e.g. change the protocol).
316 * @return a valid and adjusted url if the item can be opened as folder,
317 * otherwise return an empty url.
319 static QUrl
openItemAsFolderUrl(const KFileItem
& item
, const bool browseThroughArchives
= true);
322 * Hides tooltip displayed over element.
324 void hideToolTip(const ToolTipManager::HideBehavior behavior
= ToolTipManager::HideBehavior::Later
);
328 * Changes the directory to \a url. If the current directory is equal to
329 * \a url, nothing will be done (use DolphinView::reload() instead).
331 void setUrl(const QUrl
& url
);
335 * @see DolphinView::selectedItems()
340 * Inverts the current selection: selected items get unselected,
341 * unselected items get selected.
342 * @see DolphinView::selectedItems()
344 void invertSelection();
346 void clearSelection();
349 * Triggers the renaming of the currently selected items, where
350 * the user must input a new name for the items.
352 void renameSelectedItems();
355 * Moves all selected items to the trash.
357 void trashSelectedItems();
360 * Deletes all selected items.
362 void deleteSelectedItems();
365 * Copies all selected items to the clipboard and marks
368 void cutSelectedItemsToClipboard();
370 /** Copies all selected items to the clipboard. */
371 void copySelectedItemsToClipboard();
374 * Copies all selected items to @p destinationUrl.
376 void copySelectedItems(const KFileItemList
&selection
, const QUrl
&destinationUrl
);
379 * Moves all selected items to @p destinationUrl.
381 void moveSelectedItems(const KFileItemList
&selection
, const QUrl
&destinationUrl
);
383 /** Pastes the clipboard data to this view. */
387 * Pastes the clipboard data into the currently selected
388 * folder. If the current selection is not exactly one folder, no
389 * paste operation is done.
391 void pasteIntoFolder();
394 * Copies the path of the first selected KFileItem into Clipboard.
396 void copyPathToClipboard();
399 * Creates duplicates of selected items, appending "copy"
402 void duplicateSelectedItems();
405 * Handles a drop of @p dropEvent onto widget @p dropWidget and destination @p destUrl
407 void dropUrls(const QUrl
&destUrl
, QDropEvent
*dropEvent
, QWidget
*dropWidget
);
412 * Applies the state that has been restored by restoreViewState()
415 void updateViewState();
417 /** Activates the view if the item list container gets focus. */
418 bool eventFilter(QObject
* watched
, QEvent
* event
) override
;
422 * Is emitted if the view has been activated by e. g. a mouse click.
426 /** Is emitted if the URL of the view has been changed to \a url. */
427 void urlChanged(const QUrl
& url
);
430 * Is emitted when clicking on an item with the left mouse button.
432 void itemActivated(const KFileItem
& item
);
435 * Is emitted when multiple items have been activated by e. g.
436 * context menu open with.
438 void itemsActivated(const KFileItemList
& items
);
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 QUrl
& url
, DolphinTabWidget::TabPlacement tabPlacement
);
451 * Is emitted if the view mode (IconsView, DetailsView,
452 * PreviewsView) has been changed.
454 void modeChanged(DolphinView::Mode current
, DolphinView::Mode previous
);
456 /** Is emitted if the 'show preview' property has been changed. */
457 void previewsShownChanged(bool shown
);
459 /** Is emitted if the 'show hidden files' property has been changed. */
460 void hiddenFilesShownChanged(bool shown
);
462 /** Is emitted if the 'grouped sorting' property has been changed. */
463 void groupedSortingChanged(bool groupedSorting
);
465 /** Is emitted if the sorting by name, size or date has been changed. */
466 void sortRoleChanged(const QByteArray
& role
);
468 /** Is emitted if the sort order (ascending or descending) has been changed. */
469 void sortOrderChanged(Qt::SortOrder order
);
472 * Is emitted if the sorting of files and folders (separate with folders
473 * first or mixed) has been changed.
475 void sortFoldersFirstChanged(bool foldersFirst
);
477 /** Is emitted if the additional information shown for this view has been changed. */
478 void visibleRolesChanged(const QList
<QByteArray
>& current
,
479 const QList
<QByteArray
>& previous
);
481 /** Is emitted if the zoom level has been changed by zooming in or out. */
482 void zoomLevelChanged(int current
, int previous
);
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 QPoint
& pos
,
502 const KFileItem
& item
,
504 const QList
<QAction
*>& customActions
);
507 * Is emitted if an information message with the content \a msg
510 void infoMessage(const QString
& msg
);
513 * Is emitted if an error message with the content \a msg
516 void errorMessage(const QString
& msg
);
519 * Is emitted if an "operation completed" message with the content \a msg
522 void operationCompletedMessage(const QString
& msg
);
525 * Is emitted after DolphinView::setUrl() has been invoked and
526 * the current directory is loaded. If this signal is emitted,
527 * it is assured that the view contains already the correct root
528 * URL and property settings.
530 void directoryLoadingStarted();
533 * Is emitted after the directory triggered by DolphinView::setUrl()
536 void directoryLoadingCompleted();
539 * Is emitted after the directory loading triggered by DolphinView::setUrl()
542 void directoryLoadingCanceled();
545 * Is emitted after DolphinView::setUrl() has been invoked and provides
546 * the information how much percent of the current directory have been loaded.
548 void directoryLoadingProgress(int percent
);
551 * Is emitted if the sorting is done asynchronously and provides the
552 * progress information of the sorting.
554 void directorySortingProgress(int percent
);
557 * Emitted when the file-item-model emits redirection.
558 * Testcase: fish://localhost
560 void redirection(const QUrl
& oldUrl
, const QUrl
& newUrl
);
563 * Is emitted when the URL set by DolphinView::setUrl() represents a file.
564 * In this case no signal errorMessage() will be emitted.
566 void urlIsFileError(const QUrl
& url
);
569 * Is emitted when the write state of the folder has been changed. The application
570 * should disable all actions like "Create New..." that depend on the write
573 void writeStateChanged(bool isFolderWritable
);
576 * Is emitted if the URL should be changed to the previous URL of the
577 * history (e.g. because the "back"-mousebutton has been pressed).
579 void goBackRequested();
582 * Is emitted if the URL should be changed to the next URL of the
583 * history (e.g. because the "next"-mousebutton has been pressed).
585 void goForwardRequested();
588 * Is emitted when the user wants to move the focus to another view.
590 void toggleActiveViewRequested();
593 * Is emitted when the user clicks a tag or a link
594 * in the metadata widget of a tooltip.
596 void urlActivated(const QUrl
& url
);
599 /** Changes the zoom level if Control is pressed during a wheel event. */
600 void wheelEvent(QWheelEvent
* event
) override
;
602 void hideEvent(QHideEvent
* event
) override
;
603 bool event(QEvent
* event
) override
;
607 * Marks the view as active (DolphinView:isActive() will return true)
608 * and emits the 'activated' signal if it is not already active.
612 void slotItemActivated(int index
);
613 void slotItemsActivated(const KItemSet
& indexes
);
614 void slotItemMiddleClicked(int index
);
615 void slotItemContextMenuRequested(int index
, const QPointF
& pos
);
616 void slotViewContextMenuRequested(const QPointF
& pos
);
617 void slotHeaderContextMenuRequested(const QPointF
& pos
);
618 void slotHeaderColumnWidthChangeFinished(const QByteArray
& role
, qreal current
);
619 void slotItemHovered(int index
);
620 void slotItemUnhovered(int index
);
621 void slotItemDropEvent(int index
, QGraphicsSceneDragDropEvent
* event
);
622 void slotModelChanged(KItemModelBase
* current
, KItemModelBase
* previous
);
623 void slotMouseButtonPressed(int itemIndex
, Qt::MouseButtons buttons
);
624 void slotRenameDialogRenamingFinished(const QList
<QUrl
>& urls
);
625 void slotSelectedItemTextPressed(int index
);
626 void slotCopyingDone(KIO::Job
*, const QUrl
&, const QUrl
&to
);
629 * Is called when new items get pasted or dropped.
631 void slotItemCreated(const QUrl
&url
);
633 * Is called after all pasted or dropped items have been copied to destination.
635 void slotJobResult(KJob
*job
);
638 * Emits the signal \a selectionChanged() with a small delay. This is
639 * because getting all file items for the selection can be an expensive
640 * operation. Fast selection changes are collected in this case and
641 * the signal is emitted only after no selection change has been done
642 * within a small delay.
644 void slotSelectionChanged(const KItemSet
& current
, const KItemSet
& previous
);
647 * Is called by emitDelayedSelectionChangedSignal() and emits the
648 * signal \a selectionChanged() with all selected file items as parameter.
650 void emitSelectionChangedSignal();
653 * Updates the view properties of the current URL to the
654 * sorting given by \a role.
656 void updateSortRole(const QByteArray
& role
);
659 * Updates the view properties of the current URL to the
660 * sort order given by \a order.
662 void updateSortOrder(Qt::SortOrder order
);
665 * Updates the view properties of the current URL to the
666 * sorting of files and folders (separate with folders first or mixed) given by \a foldersFirst.
668 void updateSortFoldersFirst(bool foldersFirst
);
671 * Indicates in the status bar that the delete operation
672 * of the job \a job has been finished.
674 void slotDeleteFileFinished(KJob
* job
);
677 * Indicates in the status bar that the trash operation
678 * of the job \a job has been finished.
680 void slotTrashFileFinished(KJob
* job
);
683 * Invoked when the rename job is done, for error handling.
685 void slotRenamingResult(KJob
* job
);
688 * Invoked when the file item model has started the loading
689 * of the directory specified by DolphinView::url().
691 void slotDirectoryLoadingStarted();
694 * Invoked when the file item model indicates that the loading of a directory has
695 * been completed. Assures that pasted items and renamed items get selected.
697 void slotDirectoryLoadingCompleted();
700 * Is invoked when items of KFileItemModel have been changed.
702 void slotItemsChanged();
705 * Is invoked when the sort order has been changed by the user by clicking
706 * on a header item. The view properties of the directory will get updated.
708 void slotSortOrderChangedByHeader(Qt::SortOrder current
, Qt::SortOrder previous
);
711 * Is invoked when the sort role has been changed by the user by clicking
712 * on a header item. The view properties of the directory will get updated.
714 void slotSortRoleChangedByHeader(const QByteArray
& current
, const QByteArray
& previous
);
717 * Is invoked when the visible roles have been changed by the user by dragging
718 * a header item. The view properties of the directory will get updated.
720 void slotVisibleRolesChangedByHeader(const QList
<QByteArray
>& current
,
721 const QList
<QByteArray
>& previous
);
723 void slotRoleEditingCanceled();
724 void slotRoleEditingFinished(int index
, const QByteArray
& role
, const QVariant
& value
);
727 * Observes the item with the URL \a url. As soon as the directory
728 * model indicates that the item is available, the item will
729 * get selected and it is assured that the item stays visible.
731 void observeCreatedItem(const QUrl
&url
);
734 * Called when a redirection happens.
735 * Testcase: fish://localhost
737 void slotDirectoryRedirection(const QUrl
& oldUrl
, const QUrl
& newUrl
);
740 * Calculates the number of currently shown files into
741 * \a fileCount and the number of folders into \a folderCount.
742 * The size of all files is written into \a totalFileSize.
743 * It is recommend using this method instead of asking the
744 * directory lister or the model directly, as it takes
745 * filtering and hierarchical previews into account.
747 void calculateItemCount(int& fileCount
, int& folderCount
, KIO::filesize_t
& totalFileSize
) const;
749 void slotTwoClicksRenamingTimerTimeout();
752 void loadDirectory(const QUrl
& url
, bool reload
= false);
755 * Applies the view properties which are defined by the current URL
756 * to the DolphinView properties. The view properties are read from a
757 * .directory file either in the current directory, or in the
758 * share/apps/dolphin/view_properties/ subfolder of the user's .kde folder.
760 void applyViewProperties();
763 * Applies the given view properties to the DolphinView.
765 void applyViewProperties(const ViewProperties
& props
);
768 * Applies the m_mode property to the corresponding
769 * itemlayout-property of the KItemListView.
771 void applyModeToView();
774 * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder().
775 * Pastes the clipboard data into the URL \a url.
777 void pasteToUrl(const QUrl
& url
);
780 * Returns a list of URLs for all selected items. The list is
781 * simplified, so that when the URLs are part of different tree
782 * levels, only the parent is returned.
784 QList
<QUrl
> simplifiedSelectedUrls() const;
787 * Returns the MIME data for all selected items.
789 QMimeData
* selectionMimeData() const;
792 * Updates m_isFolderWritable dependent on whether the folder represented by
793 * the current URL is writable. If the state has changed, the signal
794 * writeableStateChanged() will be emitted.
796 void updateWritableState();
799 * @return The current URL if no viewproperties-context is given (see
800 * DolphinView::viewPropertiesContext(), otherwise the context
803 QUrl
viewPropertiesUrl() const;
806 * Clears the selection and updates current item and selection according to the parameters
808 * @param current URL to be set as current
809 * @param selected list of selected items
811 void forceUrlsSelection(const QUrl
& current
, const QList
<QUrl
>& selected
);
813 void abortTwoClicksRenaming();
816 void updatePalette();
820 bool m_assureVisibleCurrentIndex
;
821 bool m_isFolderWritable
;
822 bool m_dragging
; // True if a dragging is done. Required to be able to decide whether a
823 // tooltip may be shown when hovering an item.
826 QString m_viewPropertiesContext
;
828 QList
<QByteArray
> m_visibleRoles
;
830 QVBoxLayout
* m_topLayout
;
832 KFileItemModel
* m_model
;
833 DolphinItemListView
* m_view
;
834 KItemListContainer
* m_container
;
836 ToolTipManager
* m_toolTipManager
;
838 QTimer
* m_selectionChangedTimer
;
840 QUrl m_currentItemUrl
; // Used for making the view to remember the current URL after F5
841 bool m_scrollToCurrentItem
; // Used for marking we need to scroll to current item or not
842 QPoint m_restoredContentsPosition
;
844 QList
<QUrl
> m_selectedUrls
; // Used for making the view to remember selections after F5
845 bool m_clearSelectionBeforeSelectingNewItems
;
846 bool m_markFirstNewlySelectedItemAsCurrent
;
848 VersionControlObserver
* m_versionControlObserver
;
850 QTimer
* m_twoClicksRenamingTimer
;
851 QUrl m_twoClicksRenamingItemUrl
;
854 friend class TestBase
;
855 friend class DolphinDetailsViewTest
;
856 friend class DolphinPart
; // Accesses m_model
859 /// Allow using DolphinView::Mode in QVariant
860 Q_DECLARE_METATYPE(DolphinView::Mode
)
862 #endif // DOLPHINVIEW_H