]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinview.h
Reanimated drag & drop support again after introducing the DolphinController. It...
[dolphin.git] / src / dolphinview.h
index fbde8245c0f3936be2d36db69d7cf1546cf61309..5b820fe8e631b02220afebc2420e4f366d7ee8e7 100644 (file)
  *   You should have received a copy of the GNU General Public License     *
  *   along with this program; if not, write to the                         *
  *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
 
 #ifndef _DOLPHINVIEW_H_
 #define _DOLPHINVIEW_H_
 
-#include <qwidget.h>
-//Added by qt3to4:
-#include <QDropEvent>
-#include <Q3ValueList>
-#include <QMouseEvent>
-#include <Q3VBoxLayout>
 #include <kparts/part.h>
 #include <kfileitem.h>
 #include <kfileiconview.h>
 #include <kio/job.h>
+
 #include <urlnavigator.h>
 
-class QPainter;
+#include <QDropEvent>
+#include <QLinkedList>
+#include <QListView>
+#include <QMouseEvent>
+#include <QVBoxLayout>
+#include <QWidget>
+
+class DolphinController;
+class FilterBar;
 class KUrl;
-class QLineEdit;
-class URLNavigator;
-class QTimer;
-class Q3IconViewItem;
-class Q3ListViewItem;
-class Q3VBoxLayout;
-class KFileView;
-class Dolphin;
+class KDirModel;
+class UrlNavigator;
+class DolphinDetailsView;
 class DolphinDirLister;
-class DolphinStatusBar;
 class DolphinIconsView;
-class DolphinDetailsView;
+class DolphinMainWindow;
+class DolphinSortFilterProxyModel;
+class DolphinStatusBar;
+class QModelIndex;
+class QPainter;
+class QTimer;
 class ViewProperties;
-class Q3ScrollView;
-class KProgress;
-class ItemEffectsManager;
-class FilterBar;
+
 /**
  * @short Represents a view for the directory content
- * including the navigation bar and status bar.
+ *        including the navigation bar, filter bar and status bar.
  *
- * View modes for icons, details and previews are supported. Currently
+ * View modes for icons and details are supported. Currently
  * Dolphin allows to have up to two views inside the main window.
  *
  * @see DolphinIconsView
  * @see DolphinDetailsView
- * @see URLNavigator
+ * @see UrlNavigator
  * @see DolphinStatusBar
- *
- * @author Peter Penz <peter.penz@gmx.at>
  */
 class DolphinView : public QWidget
 {
@@ -91,25 +88,23 @@ public:
          * for date, group and permissions.
          */
         DetailsView = 1,
-
-        /**
-         * The directory items are shown as preview if possible. As
-         * fallback the items are shown as icons.
-         */
-        PreviewsView = 2,
-        MaxModeEnum = PreviewsView
+        MaxModeEnum = DetailsView
     };
 
     /** Defines the sort order for the items of a directory. */
     enum Sorting
     {
         SortByName = 0,
-        SortBySize = 1,
-        SortByDate = 2,
-        MaxSortEnum = SortByDate
+        SortBySize,
+        SortByDate,
+        SortByPermissions,
+        SortByOwner,
+        SortByGroup,
+        MaxSortEnum = SortByGroup
     };
 
-    DolphinView(QWidget* parent,
+    DolphinView(DolphinMainWindow* mainwindow,
+                QWidget *parent,
                 const KUrl& url,
                 Mode mode = IconsView,
                 bool showHiddenFiles = false);
@@ -118,23 +113,48 @@ public:
 
     /**
      * Sets the current active URL.
-     * The signals URLNavigator::urlChanged and URLNavigator::historyChanged
-     * are submitted.
+     * The signals UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
+     * are emitted.
      */
-    void setURL(const KUrl& url);
+    void setUrl(const KUrl& url);
 
     /** Returns the current active URL. */
     const KUrl& url() const;
 
-    void requestActivation();
+    /**
+     * Returns true if the view is active and hence all actions are
+     * applied to this view.
+     */
     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.
+     */
     void setMode(Mode mode);
     Mode mode() const;
-    void setShowHiddenFilesEnabled(bool show);
-    bool isShowHiddenFilesEnabled() const;
 
-    void setViewProperties(const ViewProperties& props);
+    /**
+     * 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);
+    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);
+    bool showHiddenFiles() const;
 
     /**
      * Triggers the renaming of the currently selected items, where
@@ -157,28 +177,28 @@ public:
 
     /**
      * Goes back one step in the URL history. The signals
-     * URLNavigator::urlChanged and URLNavigator::historyChanged
+     * UrlNavigator::urlChanged() and UrlNavigator::historyChanged()
      * are submitted.
      */
     void goBack();
 
     /**
-     * Goes forward one step in the URL history. The signals
-     * URLNavigator::urlChanged and URLNavigator::historyChanged
+     * 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
+     * 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.
+     * Goes to the home URL. The signals UrlNavigator::urlChanged()
+     * and UrlNavigator::historyChanged() are submitted.
      */
     void goHome();
 
@@ -187,7 +207,7 @@ public:
      * 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);
+    void setUrlEditable(bool editable);
 
     /**
      * Returns the complete URL history. The index 0 indicates the oldest
@@ -195,7 +215,7 @@ public:
      * @param index     Output parameter which indicates the current
      *                  index of the location.
      */
-    const Q3ValueList<URLNavigator::HistoryElem> urlHistory(int& index) const;
+    const QLinkedList<UrlNavigator::HistoryElem> urlHistory(int& index) const;
 
     /**
      * Returns true, if at least one item is selected.
@@ -203,33 +223,23 @@ public:
     bool hasSelection() const;
 
     /**
-     * Returns the selected items. 0 is returned, if no item
-     * is selected.
-     * @see DolphinView::selectedURLs()
+     * Returns the selected items. The list is empty if no item has been
+     * selected.
+     * @see DolphinView::selectedUrls()
      */
-    const KFileItemList* selectedItems() const;
+    KFileItemList selectedItems() const;
 
     /**
      * Returns a list of URLs for all selected items. An empty list
      * is returned, if no item is selected.
      * @see DolphinView::selectedItems()
      */
-    KUrl::List selectedURLs() const;
+    KUrl::List selectedUrls() const;
 
     /**
-     * Returns the current item, where the cursor is. 0 is returned, if there is no
-     * current item (e. g. if the view is empty). Note that the current item must
-     * not be a selected item.
-     * @see DolphinView::selectedItems()
-     */
-    const KFileItem* currentFileItem() const;
-
-    /**
-     * Opens the context menu for the item indicated by \a fileInfo
-     * on the position \a pos. If 0 is passed for the file info, a context
-     * menu for the viewport is opened.
+     * Returns the file item for the given model index \a index.
      */
-    void openContextMenu(KFileItem* fileInfo, const QPoint& pos);
+    KFileItem* fileItem(const QModelIndex index) const;
 
     /**
      * Renames the filename of the source URL by the new file name.
@@ -257,9 +267,9 @@ public:
 
     /**
      * Returns true, if the URL shown by the navigation bar is editable.
-     * @see URLNavigator
+     * @see UrlNavigator
      */
-    bool isURLEditable() const;
+    bool isUrlEditable() const;
 
     /** Increases the size of the current set view mode. */
     void zoomIn();
@@ -294,127 +304,160 @@ public:
     /** Refreshs the view settings by reading out the stored settings. */
     void refreshSettings();
 
-    /**
-     * 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();
-
-    /** Returns the URLNavigator of the view for read access. */
-    const URLNavigator* urlNavigator() const { return m_urlNavigator; }
+    /** 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 signalRequestItemInfo is emitted,
+     * 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 requestItemInfo(const KUrl& url);
+    void emitRequestItemInfo(const KUrl& url);
+
+    /** Returns true, if the filter bar is visible. */
+    bool isFilterBarVisible() const;
 
     /**
-     * Checks if the filter bar is visible.
-     *
-     * @return @c true Filter bar is visible.
-     * @return @c false Filter bar is not visible.
+     * Return the DolphinMainWindow this View belongs to. It is guranteed
+     * that we have one.
      */
-    bool isFilterBarVisible();
+    DolphinMainWindow* mainWindow() const ;
 
-public slots:
+    /** Reloads the current directory. */
     void reload();
-    void slotURLListDropped(QDropEvent* event,
-                            const KUrl::List& urls,
-                            const KUrl& url);
 
     /**
-     * Slot that popups the filter bar like FireFox popups his Search bar.
+     * Declare this View as the activeview of the mainWindow()
+     */
+    void declareViewActive();
+
+public slots:
+    /**
+     * Popups the filter bar above the status bar if \a show is true.
      */
-    void slotShowFilterBar(bool show);
+    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();
+
+    /**
+     * Requests the main window to set this view as active view, which
+     * means that all actions are applied to this view.
+     */
+    void requestActivation();
 
 signals:
     /** Is emitted if URL of the view has been changed to \a url. */
-    void signalURLChanged(const KUrl& url);
+    void urlChanged(const KUrl& url);
 
     /**
      * Is emitted if the view mode (IconsView, DetailsView,
      * PreviewsView) has been changed.
      */
-    void signalModeChanged();
+    void modeChanged();
+
+    /** Is emitted if the 'show preview' property has been changed. */
+    void showPreviewChanged();
 
     /** Is emitted if the 'show hidden files' property has been changed. */
-    void signalShowHiddenFilesChanged();
+    void showHiddenFilesChanged();
 
     /** Is emitted if the sorting by name, size or date has been changed. */
-    void signalSortingChanged(DolphinView::Sorting sorting);
+    void sortingChanged(DolphinView::Sorting sorting);
 
     /** Is emitted if the sort order (ascending or descending) has been changed. */
-    void signalSortOrderChanged(Qt::SortOrder order);
+    void sortOrderChanged(Qt::SortOrder order);
 
     /**
      * 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.
      */
-    void signalRequestItemInfo(const KUrl& url);
+    void requestItemInfo(const KUrl& url);
 
     /** Is emitted if the contents has been moved to \a x, \a y. */
     void contentsMoved(int x, int y);
 
     /**
      * Is emitted whenever the selection has been changed. The current selection can
-     * be retrieved by Dolphin::mainWin().activeView()->selectedItems() or by
-     * Dolphin::mainWin().activeView()->selectedURLs().
+     * be retrieved by mainWindow()->activeView()->selectedItems() or by
+     * mainWindow()->activeView()->selectedUrls().
      */
-    void signalSelectionChanged();
+    void selectionChanged();
 
     /**
-     * Is emitted whenever the directory view is redirected by an ioslave
+     * Is emitted whenever the filter bar has been turned show or hidden.
      */
-    void redirection(const KUrl& oldUrl, const KUrl& newUrl);
+    void showFilterBarChanged(bool shown);
 
 protected:
     /** @see QWidget::mouseReleaseEvent */
     virtual void mouseReleaseEvent(QMouseEvent* event);
 
 private slots:
-    void slotURLChanged(const KUrl& kurl);
-    void triggerIconsViewItem(Q3IconViewItem *item);
-    void triggerDetailsViewItem(Q3ListViewItem* item,
-                                const QPoint& pos,
-                                int column);
-    void triggerDetailsViewItem(Q3ListViewItem* item);
-    void updateURL();
-
-    void slotPercent(int percent);
-    void slotClear();
-    void slotDeleteItem(KFileItem* item);
-    void slotCompleted();
-    void slotDelayedUpdate();
-    void slotInfoMessage(const QString& msg);
-    void slotErrorMessage(const QString& msg);
-    void slotRefreshItems(const KFileItemList& list);
-    void slotAddItems(const KFileItemList& list);
+    void loadDirectory(const KUrl& kurl);
+    void triggerItem(const QModelIndex& index);
+    void updateProgress(int percent);
 
-    void slotGrabActivation();
+    /**
+     * Updates the number of items (= number of directories + number of files)
+     * and shows this information in the statusbar.
+     */
+    void updateItemCount();
 
     /**
-     * Is invoked shortly before the contents of a view implementation
-     * has been moved and emits the signal contentsMoved. Note that no
-     * signal is emitted when the contents moving is only temporary by
-     * e. g. reloading a directory.
+     * Restores the x- and y-position of the contents if the
+     * current view is part of the history.
      */
-    void slotContentsMoving(int x, int y);
+    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 slotChangeNameFilter(const QString& nameFilter);
+    void changeNameFilter(const QString& nameFilter);
+
+    /**
+     * Opens the context menu on position \a pos. The position
+     * is used to check whether the context menu is related to an
+     * item or to the viewport.
+     */
+    void openContextMenu(const QPoint& pos);
+
+    /**
+     * Drops the URLs \a urls at the position \a pos.
+     * The position is used to check whether the dropping
+     * is done above an item or above the viewport.
+     */
+    void dropUrls(const KUrl::List& urls,
+                  const QPoint& pos);
+
+    /**
+     * Updates the view properties of the current URL to the
+     * sorting given by \a sorting.
+     */
+    void updateSorting(DolphinView::Sorting sorting);
+
+    /**
+     * Updates the view properties of the current URL to the
+     * sort order given by \a order.
+     */
+    void updateSortOrder(Qt::SortOrder order);
 
 private:
-    void createView();
-    KFileView* fileView() const;
-    Q3ScrollView* scrollView() const;
-    ItemEffectsManager* itemEffectsManager() const;
     void startDirLister(const KUrl& url, bool reload = false);
 
     /**
@@ -430,29 +473,50 @@ private:
     QString selectionStatusBarText() const;
 
     /**
-     * Returns the string representation for the index \a index
-     * for renaming \itemCount items.
+     * Creates a new view representing the given view mode (DolphinView::viewMode()).
+     * The current view will get deleted.
+     */
+    void createView();
+
+    /**
+     * Returns the column index used in the KDirModel depending on \a sorting.
+     */
+    int columnIndex(Sorting sorting) const;
+
+    /**
+     * 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.
      */
-    QString renameIndexPresentation(int index, int itemCount) const;
+    QAbstractItemView* itemView() const;
 
-    bool m_refreshing;
+private:
     bool m_showProgress;
     Mode m_mode;
 
-    Q3VBoxLayout* m_topLayout;
-    URLNavigator* m_urlNavigator;
+    int m_iconSize;
+    int m_folderCount;
+    int m_fileCount;
+
+    DolphinMainWindow* m_mainWindow;
+    QVBoxLayout* m_topLayout;
+    UrlNavigator* m_urlNavigator;
 
+    DolphinController* m_controller;
     DolphinIconsView* m_iconsView;
     DolphinDetailsView* m_detailsView;
-    DolphinStatusBar* m_statusBar;
 
-    int m_iconSize;
-    int m_folderCount;
-    int m_fileCount;
+    FilterBar* m_filterBar;
+    DolphinStatusBar* m_statusBar;
 
+    KDirModel* m_dirModel;
     DolphinDirLister* m_dirLister;
-
-    FilterBar *m_filterBar;
+    DolphinSortFilterProxyModel* m_proxyModel;
 };
 
 #endif // _DOLPHINVIEW_H_