Forwardport 773570:

[dolphin.git] / src / dolphinview.h

diff --git a/src/dolphinview.h b/src/dolphinview.h
index 3f5b9f596798d445b7f20ac511a406e685d2610b..215a2a23c35793f5dd40e6cc4e4d76775e36fe4b 100644 (file)
--- a/src/dolphinview.h
+++ b/src/dolphinview.h
@@ -29,6 +29,7 @@
 #include <kparts/part.h>
 #include <kfileitem.h>
 #include <kfileitemdelegate.h>
 #include <kparts/part.h>
 #include <kfileitem.h>
 #include <kfileitemdelegate.h>

+#include <konq_fileundomanager.h>

 #include <kio/job.h>
 
 #include <QBoxLayout>
 #include <kio/job.h>
 
 #include <QBoxLayout>


@@ -37,16 +38,21 @@
 #include <QListView>
 #include <QWidget>
 
 #include <QListView>
 #include <QWidget>
 

+class QActionGroup;

 class DolphinController;
 class DolphinController;

-class KDirLister;
-class KFileItemDelegate;
-class KUrl;
-class DolphinModel;

 class DolphinColumnView;
 class DolphinDetailsView;
 class DolphinIconsView;
 class DolphinMainWindow;
 class DolphinColumnView;
 class DolphinDetailsView;
 class DolphinIconsView;
 class DolphinMainWindow;

+class DolphinModel;

 class DolphinSortFilterProxyModel;
 class DolphinSortFilterProxyModel;

+class IconManager;
+class KAction;
+class KActionCollection;
+class KDirLister;
+class KFileItemDelegate;
+class KUrl;
+class KToggleAction;

 class QModelIndex;
 class ViewProperties;
 
 class QModelIndex;
 class ViewProperties;
 


@@ -112,15 +118,15 @@ public:
     };
 
     /**
     };
 
     /**

-     * @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.
+     * @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,
      */
     DolphinView(QWidget* parent,
                 const KUrl& url,


@@ -136,11 +142,6 @@ public:
      */
     const KUrl& url() const;
 
      */
     const KUrl& url() const;
 

-    /**
-     * Sets the root URL of the view (see also DolphinView::rootUrl())
-     */
-    void setRootUrl(const KUrl& url);
-

     /**
      * Returns the root URL of the view, which is defined as the first
      * visible path of DolphinView::url(). Usually the root URL is
     /**
      * Returns the root URL of the view, which is defined as the first
      * visible path of DolphinView::url(). Usually the root URL is


@@ -163,39 +164,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
      * 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;
 
      */
     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;
 
     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;
 
     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;
 
     /**
     bool categorizedSorting() const;
 
     /**


@@ -229,7 +209,7 @@ public:
      * selected.
      * @see DolphinView::selectedUrls()
      */
      * selected.
      * @see DolphinView::selectedUrls()
      */

-    QList<KFileItem> selectedItems() const;
+    KFileItemList selectedItems() const;

 
     /**
      * Returns a list of URLs for all selected items. An empty list
 
     /**
      * Returns a list of URLs for all selected items. An empty list


@@ -284,10 +264,10 @@ public:
     Qt::SortOrder sortOrder() const;
 
     /** Sets the additional information which should be shown for the items. */
     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. */
 
     /** 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();
 
     /** Reloads the current directory. */
     void reload();


@@ -299,6 +279,66 @@ public:
      */
     void refresh();
 
      */
     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);
+
+    /**
+     * Returns the "switch to icons mode" action.
+     * This code is here to share it between the mainwindow and the part
+     */
+    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<bool, QString> pasteInfo() const;
+

 public slots:
     /**
      * Changes the directory to \a url. If the current directory is equal to
 public slots:
     /**
      * Changes the directory to \a url. If the current directory is equal to


@@ -312,7 +352,71 @@ public slots:
      * will actually get selected. The view will e.g. not select items which
      * are not in the currently displayed folder.
      */
      * will actually get selected. The view will e.g. not select items which
      * are not in the currently displayed folder.
      */

-    void changeSelection(const QList<KFileItem>& selection);
+    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:
     /**
 
 signals:
     /**


@@ -349,8 +453,8 @@ signals:
     /** Is emitted if the sort order (ascending or descending) has been changed. */
     void sortOrderChanged(Qt::SortOrder order);
 
     /** Is emitted if the sort order (ascending or descending) has been changed. */
     void sortOrderChanged(Qt::SortOrder order);
 

-    /** Is emitted if the additional 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.
 
     /**
      * Is emitted if information of an item is requested to be shown e. g. in the sidebar.


@@ -364,7 +468,7 @@ signals:
     /**
      * Is emitted whenever the selection has been changed.
      */
     /**
      * Is emitted whenever the selection has been changed.
      */

-    void selectionChanged(const QList<KFileItem>& selection);
+    void selectionChanged(const KFileItemList& selection);

 
     /**
      * Is emitted if a context menu is requested for the item \a item,
 
     /**
      * Is emitted if a context menu is requested for the item \a item,


@@ -373,14 +477,6 @@ signals:
      */
     void requestContextMenu(const 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
-     * \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.
     /**
      * Is emitted if an information message with the content \a msg
      * should be shown.


@@ -394,10 +490,24 @@ signals:
     void errorMessage(const QString& msg);
 
     /**
     void errorMessage(const QString& msg);
 
     /**

-     * Is emitted if the root URL of the view has been changed
-     * to \a url (see also DolphinView::rootUrl()).
+     * Is emitted if an "operation completed" message with the content \a msg
+     * should be shown.

      */
      */

-    void rootUrlChanged(const KUrl& url);
+    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 doingOperation(KonqFileUndoManager::CommandType type);

 
 protected:
     /** @see QWidget::mouseReleaseEvent */
 
 protected:
     /** @see QWidget::mouseReleaseEvent */


@@ -411,24 +521,11 @@ private slots:
     void activate();
 
     /**
     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.
      */
      * 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 QList<KFileItem>& items);
-
-    /**
-     * Replaces the icon of the item \a item by the preview pixmap
-     * \a pixmap.
-     */
-    void showPreview(const KFileItem& item, const QPixmap& pixmap);
+    void triggerItem(const KFileItem& index);

 
     void emitSelectionChangedSignal();
 
 
     void emitSelectionChangedSignal();
 


@@ -442,17 +539,15 @@ private slots:
     /**
      * Drops the URLs \a urls to the destination path \a destPath. If
      * the URLs are dropped above an item inside the destination path,
     /**
      * 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.
+     * the item is indicated by \a destItem.

      */
     void dropUrls(const KUrl::List& urls,
                   const KUrl& destPath,
      */
     void dropUrls(const KUrl::List& urls,
                   const KUrl& destPath,

-                  const QModelIndex& destIndex,
-                  QWidget* source);
+                  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);
      */
     void dropUrls(const KUrl::List& urls,
                   const KUrl& destination);


@@ -468,22 +563,25 @@ private slots:
      */
     void updateSortOrder(Qt::SortOrder order);
 
      */
     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();
 
     /**
      * 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
     /**
      * 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()
      */
      * 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.
 
     /**
      * Clears the hover information shown in the status bar.


@@ -491,8 +589,14 @@ private slots:
      */
     void clearHoverInformation();
 
      */
     void clearHoverInformation();
 

+    /**
+     * Indicates in the status bar that the delete operation
+     * of the job \a job has been finished.
+     */
+    void slotDeleteFileFinished(KJob* job);
+

 private:
 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
 
     /**
      * Returns the URL where the view properties should be stored. Usually


@@ -515,33 +619,20 @@ private:
      */
     void createView();
 
      */
     void createView();
 

+    void deleteView();
+

     /**
      * Returns a pointer to the currently used item view, which is either
      * a ListView or a TreeView.
      */
     QAbstractItemView* itemView() const;
 
     /**
      * Returns a pointer to the currently used item view, which is either
      * a ListView or a TreeView.
      */
     QAbstractItemView* itemView() const;
 

-    /**
-     * Returns true if the index is valid and represents
-     * the column DolphinModel::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;
 
     /**
      * 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();
-
-    /**
-     * 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,
     /**
      * Returns true, if the ColumnView is activated. As the column view
      * requires some special handling for iterating through directories,


@@ -553,19 +644,10 @@ private:
     }
 
 private:
     }
 
 private:

-    /**
-     * Remembers the original pixmap for an item before
-     * the cut effect is applied.
-     */
-    struct CutItem
-    {
-        KUrl url;
-        QPixmap pixmap;
-    };
-

     bool m_active;
     bool m_active;

+    bool m_showPreview;

     bool m_loadingDirectory;
     bool m_loadingDirectory;

-    bool m_initializeColumnView;
+    bool m_storedCategorizedSorting;

     Mode m_mode;
 
     DolphinMainWindow* m_mainWindow;
     Mode m_mode;
 
     DolphinMainWindow* m_mainWindow;


@@ -576,14 +658,18 @@ private:
     DolphinDetailsView* m_detailsView;
     DolphinColumnView* m_columnView;
     KFileItemDelegate* m_fileItemDelegate;
     DolphinDetailsView* m_detailsView;
     DolphinColumnView* m_columnView;
     KFileItemDelegate* m_fileItemDelegate;

+    QItemSelectionModel* m_selectionModel;

 
     DolphinModel* m_dolphinModel;
     KDirLister* m_dirLister;
     DolphinSortFilterProxyModel* m_proxyModel;
 
 
     DolphinModel* m_dolphinModel;
     KDirLister* m_dirLister;
     DolphinSortFilterProxyModel* m_proxyModel;
 

-    QList<CutItem> m_cutItemsCache;
+    IconManager* m_iconManager;

 
     KUrl m_rootUrl;
 };
 
 
     KUrl m_rootUrl;
 };
 

+/// Allow using DolphinView::Mode in QVariant
+Q_DECLARE_METATYPE(DolphinView::Mode)
+

 #endif // DOLPHINVIEW_H
 #endif // DOLPHINVIEW_H