X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/c6ab90e776878db783812afa7f63fcbef90dcbca..b1c9b5126d:/src/dolphinview.h diff --git a/src/dolphinview.h b/src/dolphinview.h index b4aef3468..5cedeecfa 100644 --- a/src/dolphinview.h +++ b/src/dolphinview.h @@ -22,9 +22,14 @@ #ifndef DOLPHINVIEW_H #define DOLPHINVIEW_H +#include + +#include "libdolphin_export.h" + #include #include #include +#include #include #include @@ -34,15 +39,20 @@ #include class DolphinController; -class KDirLister; -class KFileItemDelegate; -class KUrl; -class KDirModel; class DolphinColumnView; class DolphinDetailsView; +class DolphinFileItemDelegate; class DolphinIconsView; class DolphinMainWindow; +class DolphinModel; class DolphinSortFilterProxyModel; +class KFilePreviewGenerator; +class KAction; +class KActionCollection; +class KDirLister; +class KUrl; +class KToggleAction; +class ToolTipManager; class QModelIndex; class ViewProperties; @@ -60,22 +70,23 @@ class ViewProperties; * @see DolphinDetailsView * @see DolphinColumnView */ -class DolphinView : public QWidget +class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget { Q_OBJECT public: /** - * Defines the view mode for a directory. The view mode - * can be defined when constructing a DolphinView. The - * view mode is automatically updated if the directory itself - * defines a view mode (see class ViewProperties for details). - */ + * Defines the view mode for a directory. The view mode + * can be defined when constructing a DolphinView. The + * view mode is automatically updated if the directory itself + * defines a view mode (see class ViewProperties for details). + */ enum Mode { /** * The directory items are shown as icons including an - * icon name. */ + * icon name. + */ IconsView = 0, /** @@ -102,29 +113,27 @@ public: SortByOwner, SortByGroup, SortByType, - MaxSortEnum = SortByType + SortByRating, + SortByTags, + MaxSortEnum = SortByTags }; /** - * @param parent Parent widget of the view. - * @param url Specifies the content which should be shown. - * @param dirLister Used directory lister. The lister is not owned - * by the view and won't get deleted. - * @param dirModel Used directory model. The model is not owned - * by the view and won't get deleted. - * @param proxyModel Used proxy model which specifies the sorting. The - * model is not owned by the view and won't get - * deleted. - * @param mode Used display mode (IconsView, DetailsView or ColumnsView). - * @param showHiddenFiles If true, hidden files will be shown in the view. + * @param parent Parent widget of the view. + * @param url Specifies the content which should be shown. + * @param dirLister Used directory lister. The lister is not owned + * by the view and won't get deleted. + * @param dolphinModel Used directory model. The model is not owned + * by the view and won't get deleted. + * @param proxyModel Used proxy model which specifies the sorting. The + * model is not owned by the view and won't get + * deleted. */ DolphinView(QWidget* parent, const KUrl& url, KDirLister* dirLister, - KDirModel* dirModel, - DolphinSortFilterProxyModel* proxyModel, - Mode mode = IconsView, - bool showHiddenFiles = false); + DolphinModel* dolphinModel, + DolphinSortFilterProxyModel* proxyModel); virtual ~DolphinView(); @@ -156,39 +165,18 @@ public: * Changes the view mode for the current directory to \a mode. * If the view properties should be remembered for each directory * (GeneralSettings::globalViewProps() returns false), then the - * changed view mode will be be stored automatically. + * changed view mode will be stored automatically. */ void setMode(Mode mode); Mode mode() const; - /** - * Turns on the file preview for the all files of the current directory, - * if \a show is true. - * If the view properties should be remembered for each directory - * (GeneralSettings::globalViewProps() returns false), then the - * preview setting will be be stored automatically. - */ - void setShowPreview(bool show); + /** See setShowPreview */ bool showPreview() const; - /** - * Shows all hidden files of the current directory, - * if \a show is true. - * If the view properties should be remembered for each directory - * (GeneralSettings::globalViewProps() returns false), then the - * show hidden file setting will be be stored automatically. - */ - void setShowHiddenFiles(bool show); + /** See setShowHiddenFiles */ bool showHiddenFiles() const; - /** - * Summarizes all sorted items by their category \a categorized - * is true. - * If the view properties should be remembered for each directory - * (GeneralSettings::globalViewProps() returns false), then the - * categorized sorting setting will be be stored automatically. - */ - void setCategorizedSorting(bool categorized); + /** See setCategorizedSorting */ bool categorizedSorting() const; /** @@ -232,39 +220,38 @@ public: KUrl::List selectedUrls() const; /** - * Returns the file item for the given model index \a index. + * Returns the number of selected items (this is faster than + * invoking selectedItems().count()). */ - KFileItem* fileItem(const QModelIndex index) const; + int selectedItemsCount() const; /** - * Returns the x-position of the view content. - * The content of the view might be larger than the visible area + * Sets the upper left position of the view content + * to (x,y). The content of the view might be larger than the visible area * and hence a scrolling must be done. */ - int contentsX() const; + void setContentsPosition(int x, int y); + + /** Returns the upper left position of the view content. */ + QPoint contentsPosition() const; /** - * Returns the y-position of the view content. - * The content of the view might be larger than the visible area - * and hence a scrolling must be done. + * Sets the zoom level to \a level. It is assured that the used + * level is adjusted to be inside the range ZoomLevelInfo::minimumLevel() and + * ZoomLevelInfo::maximumLevel(). */ - int contentsY() const; - - /** Increases the size of the current set view mode. */ - void zoomIn(); - - /** Decreases the size of the current set view mode. */ - void zoomOut(); + void setZoomLevel(int level); + int zoomLevel() const; /** * Returns true, if zooming in is possible. If false is returned, - * the minimal zoom size is possible. + * the maximum zooming level has been reached. */ bool isZoomInPossible() const; /** * Returns true, if zooming out is possible. If false is returned, - * the maximum zoom size is possible. + * the minimum zooming level has been reached. */ bool isZoomOutPossible() const; @@ -281,21 +268,80 @@ public: Qt::SortOrder sortOrder() const; /** Sets the additional information which should be shown for the items. */ - void setAdditionalInfo(KFileItemDelegate::AdditionalInformation info); + void setAdditionalInfo(KFileItemDelegate::InformationList info); /** Returns the additional information which should be shown for the items. */ - KFileItemDelegate::AdditionalInformation additionalInfo() const; + KFileItemDelegate::InformationList additionalInfo() const; /** Reloads the current directory. */ void reload(); /** - * Refreshs the view to get synchronized with the (updated) Dolphin settings. + * 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. */ void refresh(); + /** + * Changes the directory of the view to \a url. If \a rootUrl is empty, the view + * properties from \a url are used for adjusting the view mode and the other properties. + * If \a rootUrl is not empty, the view properties from the root URL are considered + * instead. Specifying a root URL is only required if a view having a different root URL + * (e. g. the column view) should be restored. Usually using DolphinView::setUrl() + * is enough for changing the current URL. + */ + void updateView(const KUrl& url, const KUrl& rootUrl); + + /** + * Filters the currently shown items by \a nameFilter. All items + * which contain the given filter string will be shown. + */ + void setNameFilter(const QString& nameFilter); + + /** + * 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 calculateItemCount(int& fileCount, int& folderCount, KIO::filesize_t& totalFileSize) const; + + /** + * Returns a textual representation of the state of the current + * folder or selected items, suitable for use in the status bar. + */ + QString statusBarText() const; + + /** + * Updates the state of the 'Additional Information' actions in \a collection. + */ + void updateAdditionalInfoActions(KActionCollection* collection); + + /** + * Returns the state of the paste action: + * first is whether the action should be enabled + * second is the text for the action + */ + QPair pasteInfo() const; + + /** + * If \a tabsForFiles is true, the signal tabRequested() will also + * emitted also for files. Per default tabs for files is disabled + * and hence the signal tabRequested() will only be emitted for + * directories. + */ + void setTabsForFilesEnabled(bool tabsForFiles); + bool isTabsForFilesEnabled() const; + + /** + * Returns true if the current view allows folders to be expanded, + * i.e. presents a hierarchical view to the user. + */ + bool itemsExpandable() const; + public slots: /** * Changes the directory to \a url. If the current directory is equal to @@ -311,6 +357,77 @@ public slots: */ void changeSelection(const KFileItemList& selection); + /** + * Triggers the renaming of the currently selected items, where + * the user must input a new name for the items. + */ + void renameSelectedItems(); + + /** + * Moves all selected items to the trash. + */ + void trashSelectedItems(); + + /** + * Deletes all selected items. + */ + void deleteSelectedItems(); + + /** + * Copies all selected items to the clipboard and marks + * the items as cutted. + */ + void cutSelectedItems(); + + /** Copies all selected items to the clipboard. */ + void copySelectedItems(); + + /** Pastes the clipboard data to this view. */ + void paste(); + + /** + * Pastes the clipboard data into the currently selected + * folder. If the current selection is not exactly one folder, no + * paste operation is done. + */ + void pasteIntoFolder(); + + /** + * Turns on the file preview for the all files of the current directory, + * if \a show is true. + * If the view properties should be remembered for each directory + * (GeneralSettings::globalViewProps() returns false), then the + * preview setting will be stored automatically. + */ + void setShowPreview(bool show); + + /** + * Shows all hidden files of the current directory, + * if \a show is true. + * If the view properties should be remembered for each directory + * (GeneralSettings::globalViewProps() returns false), then the + * show hidden file setting will be stored automatically. + */ + void setShowHiddenFiles(bool show); + + /** + * Summarizes all sorted items by their category \a categorized + * is true. + * If the view properties should be remembered for each directory + * (GeneralSettings::globalViewProps() returns false), then the + * categorized sorting setting will be stored automatically. + */ + void setCategorizedSorting(bool categorized); + + /** Switches between an ascending and descending sorting order. */ + void toggleSortOrder(); + + /** + * Switches on or off the displaying of additional information + * as specified by \a action. + */ + void toggleAdditionalInfo(QAction* action); + signals: /** * Is emitted if the view has been activated by e. g. a mouse click. @@ -320,6 +437,22 @@ signals: /** Is emitted if URL of the view has been changed to \a url. */ void urlChanged(const KUrl& url); + /** + * Is emitted if the view requests a changing of the current + * URL to \a url (see DolphinController::triggerUrlChangeRequest()). + */ + void requestUrlChange(const KUrl& url); + + /** + * Is emitted when clicking on an item with the left mouse button. + */ + void itemTriggered(const KFileItem& item); + + /** + * Is emitted if a new tab should be opened for the URL \a url. + */ + void tabRequested(const KUrl& url); + /** * Is emitted if the view mode (IconsView, DetailsView, * PreviewsView) has been changed. @@ -341,14 +474,17 @@ signals: /** Is emitted if the sort order (ascending or descending) has been changed. */ void sortOrderChanged(Qt::SortOrder order); - /** Is emitted if the addtional information for an item has been changed. */ - void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info); + /** Is emitted if the additional information shown for this view has been changed. */ + void additionalInfoChanged(); + + /** Is emitted if the zoom level has been changed by zooming in or out. */ + void zoomLevelChanged(int level); /** - * Is emitted if information of an item is requested to be shown e. g. in the sidebar. - * It the URL is empty, no item information request is pending. + * Is emitted if information of an item is requested to be shown e. g. in the panel. + * If item is null, no item information request is pending. */ - void requestItemInfo(const KUrl& url); + void requestItemInfo(const KFileItem& item); /** Is emitted if the contents has been moved to \a x, \a y. */ void contentsMoved(int x, int y); @@ -359,28 +495,52 @@ signals: void selectionChanged(const KFileItemList& selection); /** - * Is emitted whenever the filter bar has been turned show or hidden. + * Is emitted if a context menu is requested for the item \a item, + * which is part of \a url. If the item is null, the context menu + * for the URL should be shown and the custom actions \a customActions + * will be added. */ - void showFilterBarChanged(bool shown); + void requestContextMenu(const KFileItem& item, + const KUrl& url, + const QList& customActions); /** - * Is emitted if a context menu is requested for the item \a item, - * which is part of \a url. If the item is 0, the context menu - * for the URL should be shown. + * Is emitted if an information message with the content \a msg + * should be shown. */ - void requestContextMenu(KFileItem* item, const KUrl& url); + void infoMessage(const QString& msg); /** - * Is emitted if the URLs \a are dropped to the destination URL - * \a destination. No operation is done within the DolphinView, the - * receiver of the signal has to take care about the corresponding - * operation. + * Is emitted if an error message with the content \a msg + * should be shown. */ - void urlsDropped(const KUrl::List& urls, const KUrl& destination); + void errorMessage(const QString& msg); + + /** + * Is emitted if an "operation completed" message with the content \a msg + * should be shown. + */ + void operationCompletedMessage(const QString& msg); + + /** + * Is emitted after DolphinView::setUrl() has been invoked and + * the path \a url is currently 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); + + /** + * Emitted when KDirLister emits redirection. + * Testcase: fish://localhost + */ + void redirection(const KUrl& oldUrl, const KUrl& newUrl); protected: /** @see QWidget::mouseReleaseEvent */ virtual void mouseReleaseEvent(QMouseEvent* event); + virtual void wheelEvent(QWheelEvent* event); + virtual bool eventFilter(QObject* watched, QEvent* event); private slots: /** @@ -390,30 +550,11 @@ private slots: void activate(); /** - * If the item specified by \a index is a directory, then this + * If the item \a item is a directory, then this * directory will be loaded. If the item is a file, the corresponding * application will get started. */ - void triggerItem(const QModelIndex& index); - - /** - * Generates a preview image for each file item in \a items. - * The current preview settings (maximum size, 'Show Preview' menu) - * are respected. - */ - void generatePreviews(const KFileItemList& items); - - /** - * Replaces the icon of the item \a item by the preview pixmap - * \a pixmap. - */ - void showPreview(const KFileItem& item, const QPixmap& pixmap); - - /** - * Restores the x- and y-position of the contents if the - * current view is part of the history. - */ - void restoreContentsPos(); + void triggerItem(const KFileItem& index); void emitSelectionChangedSignal(); @@ -422,22 +563,17 @@ private slots: * is used to check whether the context menu is related to an * item or to the viewport. */ - void openContextMenu(const QPoint& pos); + void openContextMenu(const QPoint& pos, const QList& customActions); /** - * Drops the URLs \a urls to the index \a index. \a source - * indicates the widget where the dragging has been started from. + * Drops dragged URLs to the destination path \a destPath. If + * the URLs are dropped above an item inside the destination path, + * the item is indicated by \a destItem. */ - void dropUrls(const KUrl::List& urls, - const QModelIndex& index, - QWidget* source); + void dropUrls(const KFileItem& destItem, + const KUrl& destPath, + QDropEvent* event); - /** - * Drops the URLs \a urls at the - * destination \a destination. - */ - void dropUrls(const KUrl::List& urls, - const KUrl& destination); /** * Updates the view properties of the current URL to the * sorting given by \a sorting. @@ -450,22 +586,25 @@ private slots: */ void updateSortOrder(Qt::SortOrder order); + /** + * Updates the view properties of the current URL to the + * additional information given by \a info. + */ + void updateAdditionalInfo(const KFileItemDelegate::InformationList& info); + /** * Emits the signal contentsMoved with the current coordinates * of the viewport as parameters. */ void emitContentsMoved(); - /** Applies an item effect to all cut items of the clipboard. */ - void updateCutItems(); - /** * Updates the status bar to show hover information for the - * item with the index \a index. If currently other items are selected, + * item \a item. If currently other items are selected, * no hover information is shown. * @see DolphinView::clearHoverInformation() */ - void showHoverInformation(const QModelIndex& index); + void showHoverInformation(const KFileItem& item); /** * Clears the hover information shown in the status bar. @@ -473,8 +612,48 @@ private slots: */ void clearHoverInformation(); + /** + * Indicates in the status bar that the delete operation + * of the job \a job has been finished. + */ + void slotDeleteFileFinished(KJob* job); + + /** + * Is emitted if the controller requests a changing of the current + * URL to \a url + */ + void slotRequestUrlChange(const KUrl& url); + + /** + * Restores the current item (= item that has the keyboard focus) + * to m_currentItemUrl. + */ + void restoreCurrentItem(); + + /** + * If \a view can be positively identified as not being the source for the + * current drag operation, deleteLater() it immediately. Else stores + * it for later deletion. + */ + void deleteWhenNotDragSource(QAbstractItemView* view); + private: - void startDirLister(const KUrl& url, bool reload = false); + void loadDirectory(const KUrl& url, bool reload = false); + + /** + * Returns the URL where the view properties should be stored. Usually + * DolphinView::url() is returned, but in the case of a Column View the + * view properties are always stored in the directory represented by the + * first column. It is recommendend whenever using the ViewProperties class + * to use DolphinView::viewPropertiesUrl() as URL. + */ + KUrl viewPropertiesUrl() const; + + /** + * Applies the view properties which are defined by the current URL + * m_url to the DolphinView properties. + */ + void applyViewProperties(const KUrl& url); /** * Creates a new view representing the given view mode (DolphinView::mode()). @@ -482,11 +661,7 @@ private: */ void createView(); - /** - * Selects all items by using the selection flags \a flags. This is a helper - * method for the slots DolphinView::selectAll() and DolphinView::invertSelection(). - */ - void selectAll(QItemSelectionModel::SelectionFlags flags); + void deleteView(); /** * Returns a pointer to the currently used item view, which is either @@ -494,45 +669,54 @@ private: */ QAbstractItemView* itemView() const; - /** - * Returns true if the index is valid and represents - * the column KDirModel::Name. - */ - bool isValidNameIndex(const QModelIndex& index) const; - /** * Returns true, if the item \a item has been cut into * the clipboard. */ bool isCutItem(const KFileItem& item) const; - /** Applies an item effect to all cut items. */ - void applyCutItemEffect(); + /** + * Helper method for DolphinView::paste() and DolphinView::pasteIntoFolder(). + * Pastes the clipboard data into the URL \a url. + */ + void pasteToUrl(const KUrl& url); + + /** + * Checks whether the current item view has the same zoom level + * as \a oldZoomLevel. If this is not the case, the zoom level + * of the controller is updated and a zoomLevelChanged() signal + * is emitted. + */ + void updateZoomLevel(int oldZoomLevel); + + /** + * 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; /** * Returns true, if the ColumnView is activated. As the column view * requires some special handling for iterating through directories, * this method has been introduced for convenience. */ - bool isColumnViewActive() const - { - return m_columnView != 0; - } + bool isColumnViewActive() const; -private: /** - * Remembers the original pixmap for an item before - * the cut effect is applied. + * Returns the MIME data for all selected items. */ - struct CutItem - { - KUrl url; - QPixmap pixmap; - }; + QMimeData* selectionMimeData() const; + +private: + bool m_active : 1; + bool m_showPreview : 1; + bool m_loadingDirectory : 1; + bool m_storedCategorizedSorting : 1; + bool m_tabsForFiles : 1; + bool m_isContextMenuOpen : 1; // TODO: workaround for Qt-issue 207192 + bool m_ignoreViewProperties : 1; - bool m_active; - bool m_blockContentsMovedSignal; - bool m_initializeColumnView; Mode m_mode; DolphinMainWindow* m_mainWindow; @@ -542,13 +726,28 @@ private: DolphinIconsView* m_iconsView; DolphinDetailsView* m_detailsView; DolphinColumnView* m_columnView; - KFileItemDelegate* m_fileItemDelegate; + DolphinFileItemDelegate* m_fileItemDelegate; + QItemSelectionModel* m_selectionModel; - KDirModel* m_dirModel; + DolphinModel* m_dolphinModel; KDirLister* m_dirLister; DolphinSortFilterProxyModel* m_proxyModel; - QList m_cutItemsCache; + KFilePreviewGenerator* m_previewGenerator; + ToolTipManager* m_toolTipManager; + + KUrl m_rootUrl; + KUrl m_currentItemUrl; + + QAbstractItemView* m_expandedDragSource; }; +inline bool DolphinView::isColumnViewActive() const +{ + return m_columnView != 0; +} + +/// Allow using DolphinView::Mode in QVariant +Q_DECLARE_METATYPE(DolphinView::Mode) + #endif // DOLPHINVIEW_H