Update e-mail address from peter.penz@gmx.at to peter.penz19@gmail.com

[dolphin.git] / src / views / dolphinview.h

diff --git a/src/views/dolphinview.h b/src/views/dolphinview.h
index 0c88d27ff522c21a6a8d8295722e0c85d82ee07c..1d1d316ea19f34ef50a2516b249d157328a77cde 100644 (file)
--- a/src/views/dolphinview.h
+++ b/src/views/dolphinview.h
@@ -1,5 +1,5 @@
 /***************************************************************************
 /***************************************************************************

- *   Copyright (C) 2006-2009 by Peter Penz <peter.penz@gmx.at>             *
+ *   Copyright (C) 2006-2009 by Peter Penz <peter.penz19@gmail.com>        *

  *   Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net>          *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   Copyright (C) 2006 by Gregor Kališnik <gregor@podnapisi.net>          *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *


@@ -27,10 +27,10 @@
 #include "libdolphin_export.h"
 
 #include <kparts/part.h>
 #include "libdolphin_export.h"
 
 #include <kparts/part.h>

-#include <kfileitem.h>
-#include <kfileitemdelegate.h>
+#include <KFileItem>
+#include <KFileItemDelegate>

 #include <kio/fileundomanager.h>
 #include <kio/fileundomanager.h>

-#include <kio/job.h>
+#include <KIO/Job>

 
 #include <QBoxLayout>
 #include <QKeyEvent>
 
 #include <QBoxLayout>
 #include <QKeyEvent>


@@ -43,6 +43,7 @@ typedef KIO::FileUndoManager::CommandType CommandType;
 
 class DolphinColumnViewContainer;
 class DolphinDetailsView;
 
 class DolphinColumnViewContainer;
 class DolphinDetailsView;

+class DolphinDetailsViewExpander;

 class DolphinIconsView;
 class DolphinModel;
 class DolphinSortFilterProxyModel;
 class DolphinIconsView;
 class DolphinModel;
 class DolphinSortFilterProxyModel;


@@ -53,7 +54,7 @@ class KDirLister;
 class KUrl;
 class ViewModeController;
 class ViewProperties;
 class KUrl;
 class ViewModeController;
 class ViewProperties;

-class DolphinDetailsViewExpander;
+class QRegExp;

 
 /**
  * @short Represents a view for the directory content.
 
 /**
  * @short Represents a view for the directory content.


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

-     * @param parent           Parent widget of the view.

      * @param url              Specifies the content which should be shown.
      * @param url              Specifies the content which should be shown.

-     * @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.

      */
      */

-    DolphinView(QWidget* parent,
-                const KUrl& url,
-                DolphinSortFilterProxyModel* proxyModel);
+    DolphinView( const KUrl& url, QWidget* parent);

 
     virtual ~DolphinView();
 
 
     virtual ~DolphinView();
 


@@ -181,17 +177,20 @@ public:
     bool supportsCategorizedSorting() const;
 
     /**
     bool supportsCategorizedSorting() const;
 
     /**

-     * Marks the items indicated by \p urls to get selected after the
-     * directory DolphinView::url() has been loaded. Note that nothing
-     * gets selected if no loading of a directory has been triggered
-     * by DolphinView::setUrl() or DolphinView::reload().
+     * Returns the root item which represents the current URL. Note that the returned
+     * item can be null (KFileItem::isNull() will return true) in case that the directory
+     * has not been loaded.

      */
      */

-    void markUrlsAsSelected(const QList<KUrl>& urls);
+    KFileItem rootItem() const;
+
+    /**
+     * Returns the items of the view.
+     */
+    KFileItemList items() const;

 
     /**
      * Returns the selected items. The list is empty if no item has been
      * selected.
 
     /**
      * Returns the selected items. The list is empty if no item has been
      * selected.

-     * @see DolphinView::selectedUrls()

      */
     KFileItemList selectedItems() const;
 
      */
     KFileItemList selectedItems() const;
 


@@ -201,7 +200,19 @@ public:
      */
     int selectedItemsCount() const;
 
      */
     int selectedItemsCount() const;
 

-    QItemSelectionModel* selectionModel() const;
+    /**
+     * Marks the items indicated by \p urls to get selected after the
+     * directory DolphinView::url() has been loaded. Note that nothing
+     * gets selected if no loading of a directory has been triggered
+     * by DolphinView::setUrl() or DolphinView::reload().
+     */
+    void markUrlsAsSelected(const QList<KUrl>& urls);
+
+    /**
+     * All items that match to the pattern \a pattern will get selected
+     * if \a enabled is true and deselected if  \a enabled is false.
+     */
+    void setItemSelectionEnabled(const QRegExp& pattern, bool enabled);

 
     /**
      * Sets the zoom level to \a level. It is assured that the used
 
     /**
      * Sets the zoom level to \a level. It is assured that the used


@@ -264,6 +275,7 @@ public:
      * which contain the given filter string will be shown.
      */
     void setNameFilter(const QString& nameFilter);
      * which contain the given filter string will be shown.
      */
     void setNameFilter(const QString& nameFilter);

+    QString nameFilter() const;

 
     /**
      * Calculates the number of currently shown files into
 
     /**
      * Calculates the number of currently shown files into


@@ -324,6 +336,9 @@ public:
      */
     void saveState(QDataStream& stream);
 
      */
     void saveState(QDataStream& stream);
 

+    /** Returns true, if at least one item is selected. */
+    bool hasSelection() 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


@@ -344,9 +359,6 @@ public slots:
      */
     void invertSelection();
 
      */
     void invertSelection();
 

-    /** Returns true, if at least one item is selected. */
-    bool hasSelection() const;
-

     void clearSelection();
 
     /**
     void clearSelection();
 
     /**


@@ -425,6 +437,11 @@ signals:
      */
     void itemTriggered(const KFileItem& item);
 
      */
     void itemTriggered(const KFileItem& item);
 

+    /**
+     * Is emitted if items have been added or deleted.
+     */
+    void itemCountChanged();
+

     /**
      * Is emitted if a new tab should be opened for the URL \a url.
      */
     /**
      * Is emitted if a new tab should be opened for the URL \a url.
      */


@@ -513,12 +530,31 @@ signals:
      */
     void finishedPathLoading(const KUrl& url);
 
      */
     void finishedPathLoading(const KUrl& url);
 

+    /**
+     * Is emitted after DolphinView::setUrl() has been invoked and provides
+     * the information how much percent of the current path have been loaded.
+     */
+    void pathLoadingProgress(int percent);
+
+    /**
+     * Is emitted if the DolphinView::setUrl() is invoked but the URL is not
+     * a directory.
+     */
+    void urlIsFileError(const KUrl& file);
+

     /**
      * Emitted when KDirLister emits redirection.
      * Testcase: fish://localhost
      */
     void redirection(const KUrl& oldUrl, const KUrl& newUrl);
 
     /**
      * Emitted when KDirLister emits redirection.
      * Testcase: fish://localhost
      */
     void redirection(const KUrl& oldUrl, const KUrl& newUrl);
 

+    /**
+     * Is emitted when the write state of the folder has been changed. The application
+     * should disable all actions like "Create New..." that depend on the write
+     * state.
+     */
+    void writeStateChanged(bool isFolderWritable);
+

 protected:
     /** @see QWidget::mouseReleaseEvent */
     virtual void mouseReleaseEvent(QMouseEvent* event);
 protected:
     /** @see QWidget::mouseReleaseEvent */
     virtual void mouseReleaseEvent(QMouseEvent* event);


@@ -613,6 +649,12 @@ private slots:
      */
     void slotDeleteFileFinished(KJob* job);
 
      */
     void slotDeleteFileFinished(KJob* job);
 

+    /**
+     * Invoked when the directory lister has been started the
+     * loading of \a url.
+     */
+    void slotDirListerStarted(const KUrl& url);
+

     /**
      * Invoked when the directory lister has completed the loading of
      * items. Assures that pasted items and renamed items get seleced.
     /**
      * Invoked when the directory lister has completed the loading of
      * items. Assures that pasted items and renamed items get seleced.


@@ -656,6 +698,8 @@ private slots:
      */
     void restoreContentsPosition();
 
      */
     void restoreContentsPosition();
 

+    void slotUrlChangeRequested(const KUrl& url);
+

 private:
     void loadDirectory(const KUrl& url, bool reload = false);
 
 private:
     void loadDirectory(const KUrl& url, bool reload = false);
 


@@ -707,6 +751,22 @@ private:
      */
     void addNewFileNames(const QMimeData* mimeData);
 
      */
     void addNewFileNames(const QMimeData* mimeData);
 

+    /**
+     * Helper method for DolphinView::setItemSelectionEnabled(): Returns the selection for
+     * all items of \p parent that match with the regular expression defined by \p pattern.
+     */
+    QItemSelection childrenMatchingPattern(const QModelIndex& parent, const QRegExp& pattern) const;
+
+    void connectViewAccessor();
+    void disconnectViewAccessor();
+
+    /**
+     * Updates m_isFolderWritable dependent on whether the folder represented by
+     * the current URL is writable. If the state has changed, the signal
+     * writeableStateChanged() will be emitted.
+     */
+    void updateWritableState();
+

 private:
     /**
      * Abstracts the access to the different view implementations
 private:
     /**
      * Abstracts the access to the different view implementations


@@ -715,7 +775,7 @@ private:
     class ViewAccessor
     {
     public:
     class ViewAccessor
     {
     public:

-        ViewAccessor(DolphinSortFilterProxyModel* proxyModel);
+        ViewAccessor();

         ~ViewAccessor();
 
         void createView(QWidget* parent,
         ~ViewAccessor();
 
         void createView(QWidget* parent,


@@ -740,6 +800,7 @@ private:
          */
         QWidget* layoutTarget() const;
 
          */
         QWidget* layoutTarget() const;
 

+        void setRootUrl(const KUrl& rootUrl);

         KUrl rootUrl() const;
 
         bool supportsCategorizedSorting() const;
         KUrl rootUrl() const;
 
         bool supportsCategorizedSorting() const;


@@ -759,12 +820,17 @@ private:
         KDirLister* dirLister() const;
 
     private:
         KDirLister* dirLister() const;
 
     private:

+        KUrl m_rootUrl;

         DolphinIconsView* m_iconsView;
         DolphinDetailsView* m_detailsView;
         DolphinColumnViewContainer* m_columnsContainer;
         DolphinIconsView* m_iconsView;
         DolphinDetailsView* m_detailsView;
         DolphinColumnViewContainer* m_columnsContainer;

+        DolphinModel* m_dolphinModel;

         DolphinSortFilterProxyModel* m_proxyModel;
         QAbstractItemView* m_dragSource;
         QPointer<DolphinDetailsViewExpander> m_detailsViewExpander;
         DolphinSortFilterProxyModel* m_proxyModel;
         QAbstractItemView* m_dragSource;
         QPointer<DolphinDetailsViewExpander> m_detailsViewExpander;

+
+        // For unit tests
+        friend class DolphinDetailsViewTest;

     };
 
     bool m_active : 1;
     };
 
     bool m_active : 1;


@@ -774,6 +840,7 @@ private:
     bool m_isContextMenuOpen : 1;   // TODO: workaround for Qt-issue 207192
     bool m_assureVisibleCurrentIndex : 1;
     bool m_expanderActive : 1;
     bool m_isContextMenuOpen : 1;   // TODO: workaround for Qt-issue 207192
     bool m_assureVisibleCurrentIndex : 1;
     bool m_expanderActive : 1;

+    bool m_isFolderWritable : 1;

 
     Mode m_mode;
 
 
     Mode m_mode;
 


@@ -785,7 +852,6 @@ private:
 
     QTimer* m_selectionChangedTimer;
 
 
     QTimer* m_selectionChangedTimer;
 

-    KUrl m_rootUrl;

     KUrl m_activeItemUrl;
     QPoint m_restoredContentsPosition;
     KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu
     KUrl m_activeItemUrl;
     QPoint m_restoredContentsPosition;
     KUrl m_createdItemUrl; // URL for a new item that got created by the "Create New..." menu


@@ -799,7 +865,8 @@ private:
     QSet<QString> m_newFileNames;
 
     // For unit tests
     QSet<QString> m_newFileNames;
 
     // For unit tests

-    friend class TestHelper;
+    friend class TestBase;
+    friend class DolphinDetailsViewTest;

 };
 
 /// Allow using DolphinView::Mode in QVariant
 };
 
 /// Allow using DolphinView::Mode in QVariant