X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/d49c258910739bcd4e96d3e48701c97d604ddc04..ec00f379dc42b00a64ab1af25bb4bb1a06bd7449:/src/dolphinview.h diff --git a/src/dolphinview.h b/src/dolphinview.h index f23460fec..fa47ba8a5 100644 --- a/src/dolphinview.h +++ b/src/dolphinview.h @@ -19,55 +19,52 @@ ***************************************************************************/ -#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 class DolphinController; -class FilterBar; +class KDirLister; class KFileItemDelegate; class KUrl; class KDirModel; -class KUrlNavigator; class DolphinColumnView; class DolphinDetailsView; -class DolphinDirLister; class DolphinIconsView; class DolphinMainWindow; class DolphinSortFilterProxyModel; -class DolphinStatusBar; class QModelIndex; -class QPainter; -class QTimer; class ViewProperties; /** - * @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 @@ -109,31 +106,52 @@ 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 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. + */ + DolphinView(QWidget* parent, const KUrl& url, - Mode mode = IconsView, - bool showHiddenFiles = false); + KDirLister* dirLister, + KDirModel* dirModel, + DolphinSortFilterProxyModel* proxyModel); virtual ~DolphinView(); /** - * Sets the current active URL. - * The signals KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged() - * are emitted. + * Returns the current active URL, where all actions are applied. + * The URL navigator is synchronized with this URL. */ - void setUrl(const KUrl& url); - - /** Returns the current active URL. */ const KUrl& url() const; /** - * Returns true if the view is active and hence all actions are - * applied to this view. + * Returns the root URL of the view, which is defined as the first + * visible path of DolphinView::url(). Usually the root URL is + * equal to DolphinView::url(), but in the case of the column view + * when 2 columns are shown, the root URL might be: + * /home/peter/Documents + * and DolphinView::url() might return + * /home/peter/Documents/Music/ */ + KUrl rootUrl() const; + + /** + * 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; /** @@ -183,12 +201,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() @@ -202,40 +214,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; @@ -246,7 +224,7 @@ public: * selected. * @see DolphinView::selectedUrls() */ - KFileItemList selectedItems() const; + QList selectedItems() const; /** * Returns a list of URLs for all selected items. An empty list @@ -258,36 +236,17 @@ public: /** * Returns the file item for the given model index \a index. */ - 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 - * and hence a scrolling must be done. - */ - int contentsX() const; + KFileItem fileItem(const QModelIndex& index) const; /** - * Returns the y-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 contentsY() const; + void setContentsPosition(int x, int y); - /** - * 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(); @@ -325,50 +284,22 @@ public: /** 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; - } - - /** - * Triggers to request user information for the item given - * by the URL \a url. The signal requestItemInfo is emitted, - * which provides a way for widgets to get an indication to update - * the item information. - */ - void emitRequestItemInfo(const KUrl& url); - - /** 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 ; - /** Reloads the current directory. */ void reload(); -public slots: /** - * Popups the filter bar above the status bar if \a show is true. + * 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 showFilterBar(bool show); - - /** - * 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. - */ - void updateStatusBar(); + void refresh(); +public slots: /** - * Requests the main window to set this view as active view, which - * means that all actions are applied to this view. + * Changes the directory to \a url. If the current directory is equal to + * \a url, nothing will be done (use DolphinView::reload() instead). */ - void requestActivation(); + void setUrl(const KUrl& url); /** * Request of a selection change. The view will do its best to accommodate @@ -376,12 +307,22 @@ public slots: * will actually get selected. The view will e.g. not select items which * are not in the currently displayed folder. */ - void changeSelection(const KFileItemList& selection); + void changeSelection(const QList& selection); 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. @@ -403,14 +344,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. */ + /** Is emitted if the additional information for an item has been changed. */ void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info); /** * 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); @@ -418,34 +359,59 @@ signals: /** * Is emitted whenever the selection has been changed. */ - void selectionChanged(const KFileItemList& selection); + void selectionChanged(const QList& selection); + + /** + * 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 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. + */ + void urlsDropped(const KUrl::List& urls, const KUrl& destination); + + /** + * Is emitted if an information message with the content \a msg + * should be shown. + */ + void infoMessage(const QString& msg); /** - * Is emitted whenever the filter bar has been turned show or hidden. + * Is emitted if an error message with the content \a msg + * should be shown. */ - void showFilterBarChanged(bool shown); + void errorMessage(const QString& msg); 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 specified by \a index 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 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); + void generatePreviews(const QList& items); /** * Replaces the icon of the item \a item by the preview pixmap @@ -453,26 +419,7 @@ private slots: */ 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 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 @@ -513,29 +460,40 @@ private slots: */ void emitContentsMoved(); + /** Applies an item effect to all cut items of the clipboard. */ + void updateCutItems(); + /** - * Updates the activation state of the view by checking whether - * the currently active view is this view. + * Updates the status bar to show hover information for the + * item with the index \a index. If currently other items are selected, + * no hover information is shown. + * @see DolphinView::clearHoverInformation() */ - void updateActivationState(); + void showHoverInformation(const QModelIndex& index); - /** Applies an item effect to all cut items of the clipboard. */ - void updateCutItems(); + /** + * Clears the hover information shown in the status bar. + * @see DolphinView::showHoverInformation(). + */ + void clearHoverInformation(); private: void startDirLister(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()). @@ -543,12 +501,6 @@ 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); - /** * Returns a pointer to the currently used item view, which is either * a ListView or a TreeView. @@ -570,6 +522,12 @@ private: /** Applies an item effect to all cut items. */ void applyCutItemEffect(); + /** + * Updates the color of the viewport depending from the + * activation state (see DolphinView::isActive()). + */ + void updateViewportColor(); + /** * Returns true, if the ColumnView is activated. As the column view * requires some special handling for iterating through directories, @@ -591,18 +549,13 @@ private: QPixmap pixmap; }; - bool m_showProgress; - bool m_blockContentsMovedSignal; + bool m_active; + bool m_loadingDirectory; bool m_initializeColumnView; 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; @@ -610,14 +563,11 @@ private: DolphinColumnView* m_columnView; KFileItemDelegate* m_fileItemDelegate; - FilterBar* m_filterBar; - DolphinStatusBar* m_statusBar; - KDirModel* m_dirModel; - DolphinDirLister* m_dirLister; + KDirLister* m_dirLister; DolphinSortFilterProxyModel* m_proxyModel; QList m_cutItemsCache; }; -#endif // _DOLPHINVIEW_H_ +#endif // DOLPHINVIEW_H