]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinview.h
Allow filtering of items also for the column view. A filtering of directories is...
[dolphin.git] / src / dolphinview.h
index b9fe49f00fcc76ccda885834f86c43dbc1405984..4e76c87c220788d4aaa75c8d3cdbb3de623c6118 100644 (file)
@@ -41,7 +41,7 @@ class DolphinController;
 class KDirLister;
 class KFileItemDelegate;
 class KUrl;
-class KDirModel;
+class DolphinModel;
 class DolphinColumnView;
 class DolphinDetailsView;
 class DolphinIconsView;
@@ -116,7 +116,7 @@ public:
      * @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
+     * @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
@@ -125,7 +125,7 @@ public:
     DolphinView(QWidget* parent,
                 const KUrl& url,
                 KDirLister* dirLister,
-                KDirModel* dirModel,
+                DolphinModel* dolphinModel,
                 DolphinSortFilterProxyModel* proxyModel);
 
     virtual ~DolphinView();
@@ -236,7 +236,7 @@ public:
     /**
      * Returns the file item for the given model index \a index.
      */
-    KFileItem* fileItem(const QModelIndex index) const;
+    KFileItem fileItem(const QModelIndex& index) const;
 
     /**
      * Sets the upper left position of the view content
@@ -279,21 +279,46 @@ 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.
+     * 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);
+
 public slots:
     /**
      * Changes the directory to \a url. If the current directory is equal to
@@ -309,6 +334,7 @@ public slots:
      */
     void changeSelection(const KFileItemList& selection);
 
+
 signals:
     /**
      * Is emitted if the view has been activated by e. g. a mouse click.
@@ -318,6 +344,11 @@ signals:
     /** 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.
@@ -340,7 +371,7 @@ signals:
     void sortOrderChanged(Qt::SortOrder order);
 
     /** Is emitted if the additional information for an item has been changed. */
-    void additionalInfoChanged(KFileItemDelegate::AdditionalInformation info);
+    void additionalInfoChanged(KFileItemDelegate::InformationList info);
 
     /**
      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
@@ -361,7 +392,7 @@ signals:
      * which is part of \a url. If the item is 0, the context menu
      * for the URL should be shown.
      */
-    void requestContextMenu(KFileItem* item, const KUrl& url);
+    void requestContextMenu(const KFileItem& item, const KUrl& url);
 
     /**
      * Is emitted if the URLs \a are dropped to the destination URL
@@ -383,6 +414,14 @@ signals:
      */
     void errorMessage(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);
+
 protected:
     /** @see QWidget::mouseReleaseEvent */
     virtual void mouseReleaseEvent(QMouseEvent* event);
@@ -395,11 +434,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);
+    void triggerItem(const KFileItem& index);
 
     /**
      * Generates a preview image for each file item in \a items.
@@ -424,11 +463,14 @@ private slots:
     void openContextMenu(const QPoint& pos);
 
     /**
-     * Drops the URLs \a urls to the index \a index. \a source
+     * 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 destIndex. \a source
      * indicates the widget where the dragging has been started from.
      */
     void dropUrls(const KUrl::List& urls,
-                  const QModelIndex& index,
+                  const KUrl& destPath,
+                  const QModelIndex& destIndex,
                   QWidget* source);
 
     /**
@@ -460,11 +502,11 @@ private slots:
 
     /**
      * 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,7 +515,16 @@ private slots:
     void clearHoverInformation();
 
 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
@@ -487,12 +538,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.
@@ -501,7 +546,7 @@ private:
 
     /**
      * Returns true if the index is valid and represents
-     * the column KDirModel::Name.
+     * the column DolphinModel::Name.
      */
     bool isValidNameIndex(const QModelIndex& index) const;
 
@@ -537,7 +582,7 @@ private:
 
     bool m_active;
     bool m_loadingDirectory;
-    bool m_initializeColumnView;
+    bool m_storedCategorizedSorting;
     Mode m_mode;
 
     DolphinMainWindow* m_mainWindow;
@@ -549,11 +594,13 @@ private:
     DolphinColumnView* m_columnView;
     KFileItemDelegate* m_fileItemDelegate;
 
-    KDirModel* m_dirModel;
+    DolphinModel* m_dolphinModel;
     KDirLister* m_dirLister;
     DolphinSortFilterProxyModel* m_proxyModel;
 
     QList<CutItem> m_cutItemsCache;
+
+    KUrl m_rootUrl;
 };
 
 #endif // DOLPHINVIEW_H