X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/ec4c6d07add47d5295a6f18d681ac879017d0f77..45a1074b0a38f38cfebde8bb65d5a6520b2db3e8:/src/dolphinview.h diff --git a/src/dolphinview.h b/src/dolphinview.h index e58ed31c8..6f0289f62 100644 --- a/src/dolphinview.h +++ b/src/dolphinview.h @@ -19,54 +19,60 @@ ***************************************************************************/ -#ifndef _DOLPHINVIEW_H_ -#define _DOLPHINVIEW_H_ +#ifndef DOLPHINVIEW_H +#define DOLPHINVIEW_H + +#include + +#include "libdolphin_export.h" #include #include #include +#include #include -#include - -#include -#include -#include -#include -#include +#include +#include +#include +#include +#include +class QActionGroup; +class KAction; +class KToggleAction; class DolphinController; -class FilterBar; +class KDirLister; class KFileItemDelegate; class KUrl; -class KDirModel; -class KUrlNavigator; +class DolphinModel; class DolphinColumnView; class DolphinDetailsView; -class DolphinDirLister; class DolphinIconsView; class DolphinMainWindow; class DolphinSortFilterProxyModel; -class DolphinStatusBar; class QModelIndex; -class QPainter; -class QTimer; class ViewProperties; +namespace KIO +{ + class PreviewJob; +} /** - * @short Represents a view for the directory content - * including the navigation bar, filter bar and status bar. + * @short Represents a view for the directory content. * - * View modes for icons, details and columns are supported. Currently - * Dolphin allows to have up to two views inside the main window. + * View modes for icons, details and columns are supported. It's + * possible to adjust: + * - sort order + * - sort type + * - show hidden files + * - show previews * * @see DolphinIconsView * @see DolphinDetailsView * @see DolphinColumnView - * @see KUrlNavigator - * @see DolphinStatusBar */ -class DolphinView : public QWidget +class LIBDOLPHINPRIVATE_EXPORT DolphinView : public QWidget { Q_OBJECT @@ -108,26 +114,30 @@ public: SortByOwner, SortByGroup, SortByType, - MaxSortEnum = SortByType + SortByRating, + SortByTags, + MaxSortEnum = SortByTags }; - DolphinView(DolphinMainWindow* mainwindow, - QWidget *parent, + /** + * @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, - Mode mode = IconsView, - bool showHiddenFiles = false); + KDirLister* dirLister, + DolphinModel* dolphinModel, + DolphinSortFilterProxyModel* proxyModel); virtual ~DolphinView(); - /** - * Sets the current active URL, where all actions are applied. The - * URL navigator is synchronized with this URL. The signals - * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() - * are emitted. - * @see DolphinView::urlNavigator() - */ - void setUrl(const KUrl& url); - /** * Returns the current active URL, where all actions are applied. * The URL navigator is synchronized with this URL. @@ -146,48 +156,28 @@ public: KUrl rootUrl() const; /** - * Returns true if the view is active and hence all actions are - * applied to this view. + * If \a active is true, the view will marked as active. The active + * view is defined as view where all actions are applied to. */ + void setActive(bool active); bool isActive() const; /** * 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; /** @@ -198,12 +188,6 @@ public: */ bool supportsCategorizedSorting() const; - /** - * Triggers the renaming of the currently selected items, where - * the user must input a new name for the items. - */ - void renameSelectedItems(); - /** * Selects all items. * @see DolphinView::selectedItems() @@ -217,40 +201,6 @@ public: */ void invertSelection(); - /** - * Goes back one step in the URL history. The signals - * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() - * are submitted. - */ - void goBack(); - - /** - * Goes forward one step in the Url history. The signals - * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() - * are submitted. - */ - void goForward(); - - /** - * Goes up one step of the Url path. The signals - * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() - * are submitted. - */ - void goUp(); - - /** - * Goes to the home URL. The signals KUrlNavigator::urlChanged() - * and KUrlNavigator::historyChanged() are submitted. - */ - void goHome(); - - /** - * Sets the URL of the navigation bar to an editable state - * if \a editable is true. If \a editable is false, each part of - * the location is presented by a button for a fast navigation. - */ - void setUrlEditable(bool editable); - /** Returns true, if at least one item is selected. */ bool hasSelection() const; @@ -273,36 +223,17 @@ public: /** * Returns the file item for the given model index \a index. */ - KFileItem* fileItem(const QModelIndex index) const; + KFileItem fileItem(const QModelIndex& index) const; /** - * Renames the filename of the source URL by the new file name. - * If the new file name already exists, a dialog is opened which - * asks the user to enter a new name. - */ - void rename(const KUrl& source, const QString& newName); - - DolphinStatusBar* statusBar() 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 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. - */ - int contentsY() const; - - /** - * Returns true, if the URL shown by the navigation bar is editable. - * @see KUrlNavigator - */ - bool isUrlEditable() const; + /** Returns the upper left position of the view content. */ + QPoint contentsPosition() const; /** Increases the size of the current set view mode. */ void zoomIn(); @@ -335,54 +266,87 @@ 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; - - /** Returns the KUrlNavigator of the view for read access. */ - const KUrlNavigator* urlNavigator() const - { - return m_urlNavigator; - } - - /** Returns true, if the filter bar is visible. */ - bool isFilterBarVisible() const; - - /** - * Return the DolphinMainWindow this View belongs to. It is guranteed - * that we have one. - */ - DolphinMainWindow* mainWindow() 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(); -public slots: /** - * Popups the filter bar above the status bar if \a show is true. + * 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 showFilterBar(bool show); + void setNameFilter(const QString& nameFilter); /** - * Updates the number of items (= number of files + number of - * directories) in the statusbar. If files are selected, the number - * of selected files and the sum of the filesize is shown. + * Calculates the number of currently shown files into + * \a fileCount and the number of folders into \a folderCount. + * 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 updateStatusBar(); + void calculateItemCount(int& fileCount, int& folderCount); /** - * Requests the main window to set this view as active view, which - * means that all actions are applied to this view. + * Returns the "switch to icons mode" action. + * This code is here to share it between the mainwindow and the part */ - void requestActivation(); + static KToggleAction* iconsModeAction(KActionCollection* collection); + + /** + * Returns the "switch to details mode" action. + * This code is here to share it between the mainwindow and the part + */ + static KToggleAction* detailsModeAction(KActionCollection* collection); + + /** + * Returns the "switch to columns mode" action. + * This code is here to share it between the mainwindow and the part + */ + static KToggleAction* columnsModeAction(KActionCollection* collection); + + /** + * Updates the state of the 'Additional Information' actions in \a collection. + */ + void updateAdditionalInfoActions(KActionCollection* collection); + + /** + * Returns the action name corresponding to the current view mode + */ + QString currentViewModeActionName() const; + + /** + * 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; + +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); /** * Request of a selection change. The view will do its best to accommodate @@ -392,10 +356,84 @@ 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(); + + /** + * 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. + */ + void activated(); + /** Is emitted if URL of the view has been changed to \a url. */ void urlChanged(const KUrl& url); + /** + * Is emitted when clicking on an item + */ + void itemTriggered(const KFileItem& item); + /** * Is emitted if the view mode (IconsView, DetailsView, * PreviewsView) has been changed. @@ -417,14 +455,14 @@ 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 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. + * 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); @@ -435,24 +473,61 @@ 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 0, the context menu + * for the URL should be shown. + */ + void requestContextMenu(const KFileItem& item, const KUrl& url); + + /** + * Is emitted if an information message with the content \a msg + * should be shown. + */ + void infoMessage(const QString& msg); + + /** + * Is emitted if an error message with the content \a msg + * should be shown. + */ + 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); + + /** + * Is emitted when renaming, copying, moving, linking etc. + * Used for feedback in the mainwindow. */ - void showFilterBarChanged(bool shown); + void doingOperation(KonqFileUndoManager::CommandType type); protected: /** @see QWidget::mouseReleaseEvent */ virtual void mouseReleaseEvent(QMouseEvent* event); private slots: - void changeDirectory(const KUrl& url); - void triggerItem(const QModelIndex& index); - void updateProgress(int percent); + /** + * Marks the view as active (DolphinView:isActive() will return true) + * and emits the 'activated' signal if it is not already active. + */ + void activate(); /** - * Updates the number of items (= number of directories + number of files) - * and shows this information in the statusbar. + * 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 updateItemCount(); + void triggerItem(const KFileItem& index); /** * Generates a preview image for each file item in \a items. @@ -465,28 +540,9 @@ private slots: * 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(); - - /** Shows the information \a msg inside the statusbar. */ - void showInfoMessage(const QString& msg); - - /** Shows the error message \a msg inside the statusbar. */ - void showErrorMessage(const QString& msg); + void replaceIcon(const KFileItem& item, const QPixmap& pixmap); void emitSelectionChangedSignal(); - void closeFilterBar(); - - /** - * Filters the currently shown items by \a nameFilter. All items - * which contain the given filter string will be shown. - */ - void changeNameFilter(const QString& nameFilter); /** * Opens the context menu on position \a pos. The position @@ -496,16 +552,17 @@ private slots: void openContextMenu(const QPoint& pos); /** - * Drops the URLs \a urls to the index \a index. \a source - * indicates the widget where the dragging has been started from. + * Drops the URLs \a 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); + const KUrl& destPath, + const KFileItem& destItem); /** - * Drops the URLs \a urls at the - * destination \a destination. + * Handles the dropping of URLs to the given destination. + * @see DolphinDropController */ void dropUrls(const KUrl::List& urls, const KUrl& destination); @@ -522,27 +579,27 @@ private slots: void updateSortOrder(Qt::SortOrder order); /** - * Emits the signal contentsMoved with the current coordinates - * of the viewport as parameters. + * Updates the view properties of the current URL to the + * additional information given by \a info. */ - void emitContentsMoved(); + void updateAdditionalInfo(const KFileItemDelegate::InformationList& info); /** - * Updates the activation state of the view by checking whether - * the currently active view is this view. + * Emits the signal contentsMoved with the current coordinates + * of the viewport as parameters. */ - void updateActivationState(); + 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. @@ -550,20 +607,35 @@ 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 invoked when the preview job has been finished and + * set m_previewJob to 0. + */ + void slotPreviewJobFinished(KJob* job); + private: - void startDirLister(const KUrl& url, bool reload = false); + void loadDirectory(const KUrl& url, bool reload = false); /** - * Returns the default text of the status bar, if no item is - * selected. + * 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. */ - QString defaultStatusBarText() const; + KUrl viewPropertiesUrl() const; /** - * Returns the text for the status bar, if at least one item - * is selected. + * Applies the view properties which are defined by the current URL + * m_url to the DolphinView properties. */ - QString selectionStatusBarText() const; + void applyViewProperties(const KUrl& url); /** * Creates a new view representing the given view mode (DolphinView::mode()). @@ -571,11 +643,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 @@ -583,12 +651,6 @@ 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. @@ -619,33 +681,34 @@ private: QPixmap pixmap; }; - bool m_showProgress; - bool m_blockContentsMovedSignal; - bool m_initializeColumnView; + bool m_active; + bool m_showPreview; + bool m_loadingDirectory; + bool m_storedCategorizedSorting; Mode m_mode; - int m_iconSize; - int m_folderCount; - int m_fileCount; - DolphinMainWindow* m_mainWindow; QVBoxLayout* m_topLayout; - KUrlNavigator* m_urlNavigator; DolphinController* m_controller; DolphinIconsView* m_iconsView; DolphinDetailsView* m_detailsView; DolphinColumnView* m_columnView; KFileItemDelegate* m_fileItemDelegate; + QItemSelectionModel* m_selectionModel; - FilterBar* m_filterBar; - DolphinStatusBar* m_statusBar; - - KDirModel* m_dirModel; - DolphinDirLister* m_dirLister; + DolphinModel* m_dolphinModel; + KDirLister* m_dirLister; DolphinSortFilterProxyModel* m_proxyModel; + KIO::PreviewJob* m_previewJob; + QList m_cutItemsCache; + + KUrl m_rootUrl; }; -#endif // _DOLPHINVIEW_H_ +/// Allow using DolphinView::Mode in QVariant +Q_DECLARE_METATYPE(DolphinView::Mode) + +#endif // DOLPHINVIEW_H