X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/f8f5cf8760fbed119c7a171506c9c43b31d56e15..d1a70c0b629b:/src/views/dolphinview.h diff --git a/src/views/dolphinview.h b/src/views/dolphinview.h index 197a41046..b2c66cdc3 100644 --- a/src/views/dolphinview.h +++ b/src/views/dolphinview.h @@ -21,36 +21,32 @@ #ifndef DOLPHINVIEW_H #define DOLPHINVIEW_H -#include +#include "dolphintabwidget.h" +#include "dolphin_export.h" +#include "tooltips/tooltipmanager.h" -#include "libdolphin_export.h" - -#include #include -#include -#include #include +#include +#include +#include -#include -#include -#include -#include +#include +#include #include typedef KIO::FileUndoManager::CommandType CommandType; - -class DolphinDirLister; -class DolphinItemListContainer; -class KAction; -class KActionCollection; +class QVBoxLayout; +class DolphinItemListView; class KFileItemModel; +class KItemListContainer; class KItemModelBase; -class KUrl; +class KItemSet; class ToolTipManager; class VersionControlObserver; class ViewProperties; class QGraphicsSceneDragDropEvent; -class QRegExp; +class QRegularExpression; /** * @short Represents a view for the directory content. @@ -63,7 +59,7 @@ class QRegExp; * - show previews * - enable grouping */ -class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget +class DOLPHIN_EXPORT DolphinView : public QWidget { Q_OBJECT @@ -93,48 +89,19 @@ public: CompactView }; - /** Defines the sort order for the items of a directory. */ - enum Sorting - { - SortByName = 0, - SortBySize, - SortByDate, - SortByPermissions, - SortByOwner, - SortByGroup, - SortByType, - SortByDestination, - SortByPath - }; - - /** Defines the additional information shown for the items of a directory. */ - enum AdditionalInfo - { - NoInfo = 0, - NameInfo, - SizeInfo, - DateInfo, - PermissionsInfo, - OwnerInfo, - GroupInfo, - TypeInfo, - DestinationInfo, - PathInfo - }; - /** * @param url Specifies the content which should be shown. * @param parent Parent widget of the view. */ - DolphinView(const KUrl& url, QWidget* parent); + DolphinView(const QUrl& url, QWidget* parent); - virtual ~DolphinView(); + ~DolphinView() override; /** * Returns the current active URL, where all actions are applied. * The URL navigator is synchronized with this URL. */ - KUrl url() const; + QUrl url() const; /** * If \a active is true, the view will marked as active. The active @@ -183,6 +150,12 @@ public: */ KFileItemList items() const; + /** + * @return The number of items. itemsCount() is faster in comparison + * to items().count(). + */ + int itemsCount() const; + /** * Returns the selected items. The list is empty if no item has been * selected. @@ -201,19 +174,25 @@ public: * gets selected if no loading of a directory has been triggered * by DolphinView::setUrl() or DolphinView::reload(). */ - void markUrlsAsSelected(const QList& urls); + void markUrlsAsSelected(const QList &urls); /** - * Marks the item indicated by \p url as the current item after the - * directory DolphinView::url() has been loaded. + * Marks the item indicated by \p url to be scrolled to and as the + * current item after directory DolphinView::url() has been loaded. */ - void markUrlAsCurrent(const KUrl& url); + void markUrlAsCurrent(const QUrl& url); /** - * All items that match to the pattern \a pattern will get selected - * if \a enabled is true and deselected if \a enabled is false. + * All items that match the regular expression \a regexp will get selected + * if \a enabled is true and deselected if \a enabled is false. + * + * Note that to match the whole string the pattern should be anchored: + * - you can anchor the pattern with QRegularExpression::anchoredPattern() + * - if you use QRegularExpresssion::wildcardToRegularExpression(), don't use + * QRegularExpression::anchoredPattern() as the former already returns an + * anchored pattern */ - void setItemSelectionEnabled(const QRegExp& pattern, bool enabled); + void selectItems(const QRegularExpression ®exp, bool enabled); /** * Sets the zoom level to \a level. It is assured that the used @@ -224,52 +203,38 @@ public: int zoomLevel() const; /** - * Returns true, if zooming in is possible. If false is returned, - * the maximum zooming level has been reached. + * Resets the view's icon size to the default value */ - bool isZoomInPossible() const; + void resetZoomLevel(); - /** - * Returns true, if zooming out is possible. If false is returned, - * the minimum zooming level has been reached. - */ - bool isZoomOutPossible() const; - - /** Sets the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */ - void setSorting(Sorting sorting); - - /** Returns the sorting criterion (e.g., SortByName, SortBySize,...) of the items inside a directory (see DolphinView::Sorting). */ - Sorting sorting() const; + void setSortRole(const QByteArray& role); + QByteArray sortRole() const; - /** Sets the sort order (Qt::Ascending or Qt::Descending) for the items. */ void setSortOrder(Qt::SortOrder order); - - /** Returns the currently used sort order (Qt::Ascending or Qt::Descending). */ Qt::SortOrder sortOrder() const; /** Sets a separate sorting with folders first (true) or a mixed sorting of files and folders (false). */ void setSortFoldersFirst(bool foldersFirst); - - /** Returns if files and folders are sorted separately or not. */ bool sortFoldersFirst() const; /** Sets the additional information which should be shown for the items. */ - void setAdditionalInfoList(const QList& info); + void setVisibleRoles(const QList& roles); /** Returns the additional information which should be shown for the items. */ - QList additionalInfoList() const; + QList visibleRoles() const; - /** Reloads the current directory. */ void reload(); - void stopLoading(); + /** + * Refreshes the view to get synchronized with the settings (e.g. icons size, + * font, ...). + */ + void readSettings(); /** - * Refreshes the view to get synchronized with the (updated) Dolphin settings. - * This method only needs to get invoked if the view settings for the Icons View, - * Details View or Columns View have been changed. + * Saves the current settings (e.g. icons size, font, ..). */ - void refresh(); + void writeSettings(); /** * Filters the currently shown items by \a nameFilter. All items @@ -279,14 +244,12 @@ public: QString nameFilter() const; /** - * Calculates the number of currently shown files into - * \a fileCount and the number of folders into \a folderCount. - * The size of all files is written into \a totalFileSize. - * It is recommend using this method instead of asking the - * directory lister or the model directly, as it takes - * filtering and hierarchical previews into account. + * Filters the currently shown items by \a filters. All items + * whose content-type matches those given by the list of filters + * will be shown. */ - void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const; + void setMimeTypeFilters(const QStringList& filters); + QStringList mimeTypeFilters() const; /** * Returns a textual representation of the state of the current @@ -332,20 +295,40 @@ public: */ void saveState(QDataStream& stream); - /** Returns true, if at least one item is selected. */ - bool hasSelection() const; - /** * Returns the root item which represents the current URL. */ KFileItem rootItem() const; + /** + * Sets a context that is used for remembering the view-properties. + * Per default the context is empty and the path of the currently set URL + * is used for remembering the view-properties. Setting a custom context + * makes sense if specific types of URLs (e.g. search-URLs) should + * share common view-properties. + */ + void setViewPropertiesContext(const QString& context); + QString viewPropertiesContext() const; + + /** + * Checks if the given \a item can be opened as folder (e.g. archives). + * This function will also adjust the \a url (e.g. change the protocol). + * @return a valid and adjusted url if the item can be opened as folder, + * otherwise return an empty url. + */ + static QUrl openItemAsFolderUrl(const KFileItem& item, const bool browseThroughArchives = true); + + /** + * Hides tooltip displayed over element. + */ + void hideToolTip(const ToolTipManager::HideBehavior behavior = ToolTipManager::HideBehavior::Later); + public slots: /** * Changes the directory to \a url. If the current directory is equal to * \a url, nothing will be done (use DolphinView::reload() instead). */ - void setUrl(const KUrl& url); + void setUrl(const QUrl& url); /** * Selects all items. @@ -385,7 +368,7 @@ public slots: void cutSelectedItems(); /** Copies all selected items to the clipboard. */ - void copySelectedItems(); + void copySelectedItemsToClipboard(); /** Pastes the clipboard data to this view. */ void paste(); @@ -397,8 +380,27 @@ public slots: */ void pasteIntoFolder(); + /** + * Creates duplicates of selected items, appending "copy" + * to the end. + */ + void duplicateSelectedItems(); + + /** + * Handles a drop of @p dropEvent onto widget @p dropWidget and destination @p destUrl + */ + void dropUrls(const QUrl &destUrl, QDropEvent *dropEvent, QWidget *dropWidget); + + void stopLoading(); + + /** + * Applies the state that has been restored by restoreViewState() + * to the view. + */ + void updateViewState(); + /** Activates the view if the item list container gets focus. */ - virtual bool eventFilter(QObject* watched, QEvent* event); + bool eventFilter(QObject* watched, QEvent* event) override; signals: /** @@ -406,21 +408,20 @@ signals: */ void activated(); - /** - * Is emitted if the URL of the view will be changed to \a url. - * After the URL has been changed the signal urlChanged() will - * be emitted. - */ - void urlAboutToBeChanged(const KUrl& url); - /** Is emitted if the URL of the view has been changed to \a url. */ - void urlChanged(const KUrl& url); + void urlChanged(const QUrl& url); /** * Is emitted when clicking on an item with the left mouse button. */ void itemActivated(const KFileItem& item); + /** + * Is emitted when multiple items have been activated by e. g. + * context menu open with. + */ + void itemsActivated(const KFileItemList& items); + /** * Is emitted if items have been added or deleted. */ @@ -429,7 +430,7 @@ signals: /** * Is emitted if a new tab should be opened for the URL \a url. */ - void tabRequested(const KUrl& url); + void tabRequested(const QUrl& url, DolphinTabWidget::TabPlacement tabPlacement); /** * Is emitted if the view mode (IconsView, DetailsView, @@ -447,17 +448,20 @@ signals: void groupedSortingChanged(bool groupedSorting); /** Is emitted if the sorting by name, size or date has been changed. */ - void sortingChanged(DolphinView::Sorting sorting); + void sortRoleChanged(const QByteArray& role); /** Is emitted if the sort order (ascending or descending) has been changed. */ void sortOrderChanged(Qt::SortOrder order); - /** Is emitted if the sorting of files and folders (separate with folders first or mixed) has been changed. */ + /** + * Is emitted if the sorting of files and folders (separate with folders + * first or mixed) has been changed. + */ void sortFoldersFirstChanged(bool foldersFirst); /** Is emitted if the additional information shown for this view has been changed. */ - void additionalInfoListChanged(const QList& current, - const QList& previous); + void visibleRolesChanged(const QList& current, + const QList& previous); /** Is emitted if the zoom level has been changed by zooming in or out. */ void zoomLevelChanged(int current, int previous); @@ -481,7 +485,7 @@ signals: */ void requestContextMenu(const QPoint& pos, const KFileItem& item, - const KUrl& url, + const QUrl& url, const QList& customActions); /** @@ -504,35 +508,47 @@ signals: /** * Is emitted after DolphinView::setUrl() has been invoked and - * the path \a url is currently loaded. If this signal is emitted, + * the current directory is loaded. If this signal is emitted, * it is assured that the view contains already the correct root * URL and property settings. */ - void startedPathLoading(const KUrl& url); + void directoryLoadingStarted(); /** - * Is emitted after the path triggered by DolphinView::setUrl() + * Is emitted after the directory triggered by DolphinView::setUrl() * has been loaded. */ - void finishedPathLoading(const KUrl& url); + void directoryLoadingCompleted(); + + /** + * Is emitted after the directory loading triggered by DolphinView::setUrl() + * has been canceled. + */ + void directoryLoadingCanceled(); /** * Is emitted after DolphinView::setUrl() has been invoked and provides - * the information how much percent of the current path have been loaded. + * the information how much percent of the current directory have been loaded. */ - void pathLoadingProgress(int percent); + void directoryLoadingProgress(int percent); /** - * Is emitted if the DolphinView::setUrl() is invoked but the URL is not - * a directory. + * Is emitted if the sorting is done asynchronously and provides the + * progress information of the sorting. */ - void urlIsFileError(const KUrl& file); + void directorySortingProgress(int percent); /** - * Emitted when KDirLister emits redirection. + * Emitted when the file-item-model emits redirection. * Testcase: fish://localhost */ - void redirection(const KUrl& oldUrl, const KUrl& newUrl); + void redirection(const QUrl& oldUrl, const QUrl& newUrl); + + /** + * Is emitted when the URL set by DolphinView::setUrl() represents a file. + * In this case no signal errorMessage() will be emitted. + */ + void urlIsFileError(const QUrl& url); /** * Is emitted when the write state of the folder has been changed. The application @@ -541,9 +557,35 @@ signals: */ void writeStateChanged(bool isFolderWritable); + /** + * Is emitted if the URL should be changed to the previous URL of the + * history (e.g. because the "back"-mousebutton has been pressed). + */ + void goBackRequested(); + + /** + * Is emitted if the URL should be changed to the next URL of the + * history (e.g. because the "next"-mousebutton has been pressed). + */ + void goForwardRequested(); + + /** + * Is emitted when the user wants to move the focus to another view. + */ + void toggleActiveViewRequested(); + + /** + * Is emitted when the user clicks a tag or a link + * in the metadata widget of a tooltip. + */ + void urlActivated(const QUrl& url); + protected: /** Changes the zoom level if Control is pressed during a wheel event. */ - virtual void wheelEvent(QWheelEvent* event); + void wheelEvent(QWheelEvent* event) override; + + void hideEvent(QHideEvent* event) override; + bool event(QEvent* event) override; private slots: /** @@ -553,15 +595,28 @@ private slots: void activate(); void slotItemActivated(int index); - void slotItemsActivated(const QSet& indexes); + void slotItemsActivated(const KItemSet& indexes); void slotItemMiddleClicked(int index); void slotItemContextMenuRequested(int index, const QPointF& pos); void slotViewContextMenuRequested(const QPointF& pos); void slotHeaderContextMenuRequested(const QPointF& pos); + void slotHeaderColumnWidthChangeFinished(const QByteArray& role, qreal current); void slotItemHovered(int index); void slotItemUnhovered(int index); void slotItemDropEvent(int index, QGraphicsSceneDragDropEvent* event); void slotModelChanged(KItemModelBase* current, KItemModelBase* previous); + void slotMouseButtonPressed(int itemIndex, Qt::MouseButtons buttons); + void slotRenameDialogRenamingFinished(const QList& urls); + void slotSelectedItemTextPressed(int index); + + /* + * Is called when new items get pasted or dropped. + */ + void slotItemCreated(const QUrl &url); + /* + * Is called after all pasted or dropped items have been copied to destination. + */ + void slotPasteJobResult(KJob *job); /** * Emits the signal \a selectionChanged() with a small delay. This is @@ -570,7 +625,7 @@ private slots: * the signal is emitted only after no selection change has been done * within a small delay. */ - void slotSelectionChanged(const QSet& current, const QSet& previous); + void slotSelectionChanged(const KItemSet& current, const KItemSet& previous); /** * Is called by emitDelayedSelectionChangedSignal() and emits the @@ -580,9 +635,9 @@ private slots: /** * Updates the view properties of the current URL to the - * sorting given by \a sorting. + * sorting given by \a role. */ - void updateSorting(DolphinView::Sorting sorting); + void updateSortRole(const QByteArray& role); /** * Updates the view properties of the current URL to the @@ -597,43 +652,38 @@ private slots: void updateSortFoldersFirst(bool foldersFirst); /** - * Updates the status bar to show hover information for the - * item \a item. If currently other items are selected, - * no hover information is shown. - * @see DolphinView::clearHoverInformation() + * Indicates in the status bar that the delete operation + * of the job \a job has been finished. */ - void showHoverInformation(const KFileItem& item); + void slotDeleteFileFinished(KJob* job); /** - * Clears the hover information shown in the status bar. - * @see DolphinView::showHoverInformation(). + * Indicates in the status bar that the trash operation + * of the job \a job has been finished. */ - void clearHoverInformation(); + void slotTrashFileFinished(KJob* job); /** - * Indicates in the status bar that the delete operation - * of the job \a job has been finished. + * Invoked when the rename job is done, for error handling. */ - void slotDeleteFileFinished(KJob* job); + void slotRenamingResult(KJob* job); /** - * Invoked when the directory lister has been started the - * loading of \a url. + * Invoked when the file item model has started the loading + * of the directory specified by DolphinView::url(). */ - void slotDirListerStarted(const KUrl& url); + void slotDirectoryLoadingStarted(); /** - * Invoked when the file item model indicates that the directory lister has completed the loading - * of items, and that expanded folders have been restored (if the view mode is 'Details', and the - * view state is restored after navigating back or forward in history). Assures that pasted items - * and renamed items get seleced. + * Invoked when the file item model indicates that the loading of a directory has + * been completed. Assures that pasted items and renamed items get selected. */ - void slotLoadingCompleted(); + void slotDirectoryLoadingCompleted(); /** - * Is invoked when the KDirLister indicates refreshed items. + * Is invoked when items of KFileItemModel have been changed. */ - void slotRefreshItems(); + void slotItemsChanged(); /** * Is invoked when the sort order has been changed by the user by clicking @@ -648,75 +698,80 @@ private slots: void slotSortRoleChangedByHeader(const QByteArray& current, const QByteArray& previous); /** - * Observes the item with the URL \a url. As soon as the directory - * model indicates that the item is available, the item will - * get selected and it is assured that the item stays visible. - * - * @see selectAndScrollToCreatedItem() + * Is invoked when the visible roles have been changed by the user by dragging + * a header item. The view properties of the directory will get updated. */ - void observeCreatedItem(const KUrl& url); + void slotVisibleRolesChangedByHeader(const QList& current, + const QList& previous); + + void slotRoleEditingCanceled(); + void slotRoleEditingFinished(int index, const QByteArray& role, const QVariant& value); /** - * Selects and scrolls to the item that got observed - * by observeCreatedItem(). + * Observes the item with the URL \a url. As soon as the directory + * model indicates that the item is available, the item will + * get selected and it is assured that the item stays visible. */ - void selectAndScrollToCreatedItem(); + void observeCreatedItem(const QUrl &url); /** * Called when a redirection happens. * Testcase: fish://localhost */ - void slotRedirection(const KUrl& oldUrl, const KUrl& newUrl); + void slotDirectoryRedirection(const QUrl& oldUrl, const QUrl& newUrl); /** - * Applies the state that has been restored by restoreViewState() - * to the view. + * Calculates the number of currently shown files into + * \a fileCount and the number of folders into \a folderCount. + * The size of all files is written into \a totalFileSize. + * It is recommend using this method instead of asking the + * directory lister or the model directly, as it takes + * filtering and hierarchical previews into account. */ - void updateViewState(); - - void hideToolTip(); + void calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const; - //void slotUrlChangeRequested(const KUrl& url); + void slotTwoClicksRenamingTimerTimeout(); private: - KFileItemModel* fileItemModel() const; - - void loadDirectory(const KUrl& url, bool reload = false); + void loadDirectory(const QUrl& url, bool reload = false); /** * Applies the view properties which are defined by the current URL - * to the DolphinView properties. + * to the DolphinView properties. The view properties are read from a + * .directory file either in the current directory, or in the + * share/apps/dolphin/view_properties/ subfolder of the user's .kde folder. */ void applyViewProperties(); - void applyAdditionalInfoListToView(); + /** + * Applies the given view properties to the DolphinView. + */ + void applyViewProperties(const ViewProperties& props); + + /** + * Applies the m_mode property to the corresponding + * itemlayout-property of the KItemListView. + */ + void applyModeToView(); /** * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder(). * Pastes the clipboard data into the URL \a url. */ - void pasteToUrl(const KUrl& url); + void pasteToUrl(const QUrl& url); /** * Returns a list of URLs for all selected items. The list is * simplified, so that when the URLs are part of different tree * levels, only the parent is returned. */ - KUrl::List simplifiedSelectedUrls() const; + QList simplifiedSelectedUrls() const; /** * Returns the MIME data for all selected items. */ QMimeData* selectionMimeData() const; - /** - * Is invoked after a paste operation or a drag & drop - * operation and URLs from \a mimeData as selected. - * This allows to select all newly pasted - * items in restoreViewState(). - */ - void markPastedUrlsAsSelected(const QMimeData* mimeData); - /** * Updates m_isFolderWritable dependent on whether the folder represented by * the current URL is writable. If the state has changed, the signal @@ -724,45 +779,65 @@ private: */ void updateWritableState(); - QByteArray sortRoleForSorting(Sorting sorting) const; - Sorting sortingForSortRole(const QByteArray& sortRole) const; + /** + * @return The current URL if no viewproperties-context is given (see + * DolphinView::viewPropertiesContext(), otherwise the context + * is returned. + */ + QUrl viewPropertiesUrl() const; /** - * Returns the text for the filesize by converting it to the best fitting - * unit. + * Clears the selection and updates current item and selection according to the parameters + * + * @param current URL to be set as current + * @param selected list of selected items */ - static QString fileSizeText(KIO::filesize_t fileSize); + void forceUrlsSelection(const QUrl& current, const QList& selected); + + void abortTwoClicksRenaming(); private: - bool m_active : 1; - bool m_tabsForFiles : 1; - bool m_assureVisibleCurrentIndex : 1; - bool m_isFolderWritable : 1; + void updatePalette(); + + bool m_active; + bool m_tabsForFiles; + bool m_assureVisibleCurrentIndex; + bool m_isFolderWritable; + bool m_dragging; // True if a dragging is done. Required to be able to decide whether a + // tooltip may be shown when hovering an item. - KUrl m_url; + QUrl m_url; + QString m_viewPropertiesContext; Mode m_mode; - QList m_additionalInfoList; + QList m_visibleRoles; QVBoxLayout* m_topLayout; - DolphinDirLister* m_dirLister; - DolphinItemListContainer* m_container; + KFileItemModel* m_model; + DolphinItemListView* m_view; + KItemListContainer* m_container; ToolTipManager* m_toolTipManager; QTimer* m_selectionChangedTimer; - KUrl m_currentItemUrl; // Used for making the view to remember the current URL after F5 + QUrl m_currentItemUrl; // Used for making the view to remember the current URL after F5 + bool m_scrollToCurrentItem; // Used for marking we need to scroll to current item or not QPoint m_restoredContentsPosition; - KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu - QList m_selectedUrls; // Used for making the view to remember selections after F5 - + QList m_selectedUrls; // Used for making the view to remember selections after F5 + bool m_clearSelectionBeforeSelectingNewItems; + bool m_markFirstNewlySelectedItemAsCurrent; + VersionControlObserver* m_versionControlObserver; + QTimer* m_twoClicksRenamingTimer; + QUrl m_twoClicksRenamingItemUrl; + // For unit tests friend class TestBase; friend class DolphinDetailsViewTest; + friend class DolphinPart; // Accesses m_model }; /// Allow using DolphinView::Mode in QVariant