X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/623c19e042cd19c147bc27f50b62c22b4986e6b6..293e65797afd44a530df3435a8cc5b1b024aa3bb:/src/dolphinview.h diff --git a/src/dolphinview.h b/src/dolphinview.h index 0569ba400..ebca53e99 100644 --- a/src/dolphinview.h +++ b/src/dolphinview.h @@ -19,65 +19,58 @@ ***************************************************************************/ -#ifndef _DOLPHINVIEW_H_ -#define _DOLPHINVIEW_H_ +#ifndef DOLPHINVIEW_H +#define DOLPHINVIEW_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 UrlNavigator; 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 UrlNavigator - * @see DolphinStatusBar */ class 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 { /** @@ -108,31 +101,54 @@ public: SortByPermissions, SortByOwner, SortByGroup, - MaxSortEnum = SortByGroup + SortByType, + MaxSortEnum = SortByType }; - 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. + * @param mode Used display mode (IconsView, DetailsView or ColumnsView). + * @param showHiddenFiles If true, hidden files will be shown in the view. + */ + DolphinView(QWidget* parent, const KUrl& url, - Mode mode = IconsView, - bool showHiddenFiles = false); + KDirLister* dirLister, + KDirModel* dirModel, + DolphinSortFilterProxyModel* proxyModel, + Mode mode); virtual ~DolphinView(); /** - * Sets the current active URL. - * The signals UrlNavigator::urlChanged() and UrlNavigator::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; /** @@ -165,10 +181,22 @@ public: bool showHiddenFiles() const; /** - * Triggers the renaming of the currently selected items, where - * the user must input a new name for the items. + * 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); + bool categorizedSorting() const; + + /** + * Returns true, if the categorized sorting is supported by the current + * used mode (see DolphinView::setMode()). Currently only DolphinView::IconsView + * supports categorizations. To check whether the categorized + * sorting is set, use DolphinView::categorizedSorting(). */ - void renameSelectedItems(); + bool supportsCategorizedSorting() const; /** * Selects all items. @@ -183,40 +211,6 @@ public: */ void invertSelection(); - /** - * Goes back one step in the URL history. The signals - * UrlNavigator::urlChanged() and UrlNavigator::historyChanged() - * are submitted. - */ - void goBack(); - - /** - * Goes forward one step in the Url history. The signals - * UrlNavigator::urlChanged() and UrlNavigator::historyChanged() - * are submitted. - */ - void goForward(); - - /** - * Goes up one step of the Url path. The signals - * UrlNavigator::urlChanged() and UrlNavigator::historyChanged() - * are submitted. - */ - void goUp(); - - /** - * Goes to the home URL. The signals UrlNavigator::urlChanged() - * and UrlNavigator::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; @@ -242,33 +236,14 @@ public: 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 UrlNavigator - */ - 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(); @@ -306,53 +281,25 @@ public: /** Returns the additional information which should be shown for the items. */ KFileItemDelegate::AdditionalInformation additionalInfo() const; - /** Refreshs the view settings by reading out the stored settings. */ - void refreshSettings(); - - /** Returns the UrlNavigator of the view for read access. */ - const UrlNavigator* 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. - */ - 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. + * Refreshs 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 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 accomodate + * Request of a selection change. The view will do its best to accommodate * the request, but it is not guaranteed that all items in \a selection * will actually get selected. The view will e.g. not select items which * are not in the currently displayed folder. @@ -360,6 +307,11 @@ public slots: void changeSelection(const KFileItemList& 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); @@ -375,13 +327,16 @@ signals: /** Is emitted if the 'show hidden files' property has been changed. */ void showHiddenFilesChanged(); + /** Is emitted if the 'categorized sorting' property has been changed. */ + void categorizedSortingChanged(); + /** Is emitted if the sorting by name, size or date has been changed. */ void sortingChanged(DolphinView::Sorting sorting); /** 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); /** @@ -399,24 +354,49 @@ 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 showFilterBarChanged(bool shown); + void requestContextMenu(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 if an error message with the content \a msg + * should be shown. + */ + void errorMessage(const QString& msg); protected: /** @see QWidget::mouseReleaseEvent */ virtual void mouseReleaseEvent(QMouseEvent* event); private slots: - void loadDirectory(const KUrl& kurl); - 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. @@ -429,28 +409,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 showPreview(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 @@ -491,29 +452,25 @@ private slots: */ void emitContentsMoved(); - /** - * Updates the activation state of the view by checking whether - * the currently active view is this view. - */ - void updateActivationState(); - /** Applies an item effect to all cut items of the clipboard. */ void updateCutItems(); -private: - void startDirLister(const KUrl& url, bool reload = false); - /** - * Returns the default text of the status bar, if no item is - * selected. + * 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() */ - QString defaultStatusBarText() const; + void showHoverInformation(const QModelIndex& index); /** - * Returns the text for the status bar, if at least one item - * is selected. + * Clears the hover information shown in the status bar. + * @see DolphinView::showHoverInformation(). */ - QString selectionStatusBarText() const; + void clearHoverInformation(); + +private: + void startDirLister(const KUrl& url, bool reload = false); /** * Creates a new view representing the given view mode (DolphinView::mode()). @@ -553,29 +510,29 @@ private: * 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 + { + return m_columnView != 0; + } private: /** * Remembers the original pixmap for an item before * the cut effect is applied. */ - struct CutItem { + struct CutItem + { KUrl url; QPixmap pixmap; }; - bool m_showProgress; + bool m_active; bool m_blockContentsMovedSignal; + bool m_initializeColumnView; Mode m_mode; - int m_iconSize; - int m_folderCount; - int m_fileCount; - DolphinMainWindow* m_mainWindow; QVBoxLayout* m_topLayout; - UrlNavigator* m_urlNavigator; DolphinController* m_controller; DolphinIconsView* m_iconsView; @@ -583,14 +540,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