]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinviewcontainer.h
[KStandardItemListWidget] Pass icon state to overlay painter
[dolphin.git] / src / dolphinviewcontainer.h
index 417aa27c9fdb85554b2158301a0ef1523b00d766..b5bcc78ad344c55ddc0c1720cec0a1b887085851 100644 (file)
@@ -1,5 +1,5 @@
 /***************************************************************************
- *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
+ *   Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com>             *
  *                                                                         *
  *   This program is free software; you can redistribute it and/or modify  *
  *   it under the terms of the GNU General Public License as published by  *
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
-
 #ifndef DOLPHINVIEWCONTAINER_H
 #define DOLPHINVIEWCONTAINER_H
 
-#include <kfileitem.h>
-#include <kfileitemdelegate.h>
-#include <kglobalsettings.h>
-#include <kio/job.h>
+#include "config-dolphin.h"
+#include "views/dolphinview.h"
 
-#include <kurlnavigator.h>
+#include <KCompletion>
+#include <KFileItem>
+#include <KIO/Job>
+#include <KUrlNavigator>
 
 #include <QElapsedTimer>
+#include <QPushButton>
 #include <QWidget>
 
-#include <views/dolphinview.h>
+#ifdef KF5Activities_FOUND
+namespace KActivities {
+    class ResourceInstance;
+}
+#endif
 
 class FilterBar;
-class KUrl;
-class DolphinModel;
+class KMessageWidget;
+class QUrl;
 class KUrlNavigator;
-class DolphinDirLister;
 class DolphinSearchBox;
-class DolphinSortFilterProxyModel;
 class DolphinStatusBar;
 
 /**
  * @short Represents a view for the directory content
  *        including the navigation bar, filter bar and status bar.
  *
- * View modes for icons, details and columns are supported. Currently
+ * View modes for icons, compact and details are supported. Currently
  * Dolphin allows to have up to two views inside the main window.
  *
  * @see DolphinView
@@ -59,14 +62,21 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
-    DolphinViewContainer(const KUrl& url, QWidget* parent);
-    virtual ~DolphinViewContainer();
+    enum MessageType
+    {
+        Information,
+        Warning,
+        Error
+    };
+
+    DolphinViewContainer(const QUrl& url, QWidget* parent);
+    ~DolphinViewContainer() override;
 
     /**
      * Returns the current active URL, where all actions are applied.
      * The URL navigator is synchronized with this URL.
      */
-    KUrl url() const;
+    QUrl url() const;
 
     /**
      * If \a active is true, the view container will marked as active. The active
@@ -75,6 +85,16 @@ public:
     void setActive(bool active);
     bool isActive() const;
 
+    /**
+     * If \a grab is set to true, the container automatically grabs the focus
+     * as soon as the URL has been changed. Per default the grabbing
+     * of the focus is enabled.
+     */
+    void setAutoGrabFocus(bool grab);
+    bool autoGrabFocus() const;
+
+    QString currentSearchText() const;
+
     const DolphinStatusBar* statusBar() const;
     DolphinStatusBar* statusBar();
 
@@ -84,10 +104,16 @@ public:
     const DolphinView* view() const;
     DolphinView* view();
 
+    /**
+     * Shows the message \msg with the given type non-modal above
+     * the view-content.
+     */
+    void showMessage(const QString& msg, MessageType type);
+
     /**
      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
      */
-    void refresh();
+    void readSettings();
 
     /** Returns true, if the filter bar is visible. */
     bool isFilterBarVisible() const;
@@ -99,6 +125,17 @@ public:
     void setSearchModeEnabled(bool enabled);
     bool isSearchModeEnabled() const;
 
+    /**
+     * @return Text that should be used for the current URL when creating
+     *         a new place.
+     */
+    QString placesText() const;
+
+    /**
+     * Reload the view of this container. This will also hide messages in a messagewidget.
+     */
+    void reload();
+
 public slots:
     /**
      * Sets the current active URL, where all actions are applied. The
@@ -107,12 +144,14 @@ public slots:
      * are emitted.
      * @see DolphinViewContainer::urlNavigator()
      */
-    void setUrl(const KUrl& url);
+    void setUrl(const QUrl& url);
 
     /**
-     * Popups the filter bar above the status bar if \a show is true.
+     * Popups the filter bar above the status bar if \a visible is true.
+     * It \a visible is true, it is assured that the filter bar gains
+     * the keyboard focus.
      */
-    void showFilterBar(bool show);
+    void setFilterBarVisible(bool visible);
 
 signals:
     /**
@@ -127,13 +166,6 @@ signals:
      */
     void writeStateChanged(bool isFolderWritable);
 
-    /**
-     * Is emitted if the search mode has been enabled or disabled.
-     * (see DolphinViewContainer::setSearchModeEnabled() and
-     * DolphinViewContainer::isSearchModeEnabled())
-     */
-    void searchModeChanged(bool enabled);
-
 private slots:
     /**
      * Updates the number of items (= number of files + number of
@@ -141,6 +173,9 @@ private slots:
      * of selected files and the sum of the filesize is shown. The update
      * is done asynchronously, as getting the sum of the
      * filesizes can be an expensive operation.
+     * Unless a previous OperationCompletedMessage was set very shortly before
+     * calling this method, it will be overwritten (see DolphinStatusBar::setMessage).
+     * Previous ErrorMessages however are always preserved.
      */
     void delayedStatusBarUpdate();
 
@@ -150,29 +185,46 @@ private slots:
      */
     void updateStatusBar();
 
-    void initializeProgress();
+    void updateDirectoryLoadingProgress(int percent);
 
-    void updateProgress(int percent);
+    void updateDirectorySortingProgress(int percent);
+
+    /**
+     * Updates the statusbar to show an undetermined progress with the correct
+     * context information whether a searching or a directory loading is done.
+     */
+    void slotDirectoryLoadingStarted();
 
     /**
      * Assures that the viewport position is restored and updates the
      * statusbar to reflect the current content.
      */
-    void slotDirListerCompleted();
+    void slotDirectoryLoadingCompleted();
+
+    /**
+     * Updates the statusbar to show, that the directory loading has
+     * been canceled.
+     */
+    void slotDirectoryLoadingCanceled();
+
+    /**
+     * Is called if the URL set by DolphinView::setUrl() represents
+     * a file and not a directory. Takes care to activate the file.
+     */
+    void slotUrlIsFileError(const QUrl& url);
 
     /**
      * Handles clicking on an item. If the item is a directory, the
      * directory is opened in the view. If the item is a file, the file
      * gets started by the corresponding application.
      */
-    void slotItemTriggered(const KFileItem& item);
+    void slotItemActivated(const KFileItem& item);
 
     /**
-     * Opens a the file \a url by opening the corresponding application.
-     * Is connected with the signal urlIsFile() from DolphinDirLister and will
-     * get invoked if the user manually has entered a file into the URL navigator.
+     * Handles activation of multiple files. The files get started by
+     * the corresponding applications.
      */
-    void openFile(const KUrl& url);
+    void slotItemsActivated(const KFileItemList& items);
 
     /**
      * Shows the information for the item \a item inside the statusbar. If the
@@ -180,15 +232,6 @@ private slots:
      */
     void showItemInfo(const KFileItem& item);
 
-    /** 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);
-
-    /** Shows the "operation completed" message \a msg inside the statusbar. */
-    void showOperationCompletedMessage(const QString& msg);
-
     void closeFilterBar();
 
     /**
@@ -204,29 +247,28 @@ private slots:
     void activate();
 
     /**
-     * Saves the state of the current view: contents position,
-     * root URL, ...
+     * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
+     * is emitted. Tries to save the view-state.
      */
-    void saveViewState();
+    void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);
 
     /**
      * Restores the current view to show \a url and assures
      * that the root URL of the view is respected.
      */
-    void slotUrlNavigatorLocationChanged(const KUrl& url);
+    void slotUrlNavigatorLocationChanged(const QUrl& url);
 
     /**
-     * Is connected with the URL navigator and drops the URLs
-     * above the destination \a destination.
+     * @see KUrlNavigator::urlSelectionRequested
      */
-    void dropUrls(const KUrl& destination, QDropEvent* event);
+    void slotUrlSelectionRequested(const QUrl& url);
 
     /**
      * Is invoked when a redirection is done and changes the
      * URL of the URL navigator to \a newUrl without triggering
      * a reloading of the directory.
      */
-    void redirect(const KUrl& oldUrl, const KUrl& newUrl);
+    void redirect(const QUrl& oldUrl, const QUrl& newUrl);
 
     /** Requests the focus for the view \a m_view. */
     void requestFocus();
@@ -235,29 +277,54 @@ private slots:
      * Saves the currently used URL completion mode of
      * the URL navigator.
      */
-    void saveUrlCompletionMode(KGlobalSettings::Completion completion);
+    void saveUrlCompletionMode(KCompletion::CompletionMode completion);
 
-    void slotHistoryChanged();
+    void slotReturnPressed();
 
     /**
      * Gets the search URL from the searchbox and starts searching.
-     * @param text Text the user has entered into the searchbox.
      */
-    void startSearching(const QString& text);
+    void startSearching();
     void closeSearchBox();
 
-private:
     /**
-     * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://).
+     * Stops the loading of a directory. Is connected with the "stopPressed" signal
+     * from the statusbar.
      */
-    bool isSearchUrl(const KUrl& url) const;
+    void stopDirectoryLoading();
+
+    void slotStatusBarZoomLevelChanged(int zoomLevel);
+
+    /**
+     * Slot that calls showMessage(msg, Error).
+     */
+    void showErrorMessage(const QString& msg);
 
 private:
-    bool m_isFolderWritable;
+    /**
+     * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+     */
+    bool isSearchUrl(const QUrl& url) const;
+
+    /**
+     * Saves the state of the current view: contents position,
+     * root URL, ...
+     */
+    void saveViewState();
 
+    /**
+     * Restores the state of the current view iff the URL navigator contains a
+     * non-empty location state.
+     */
+    void tryRestoreViewState();
+
+private:
     QVBoxLayout* m_topLayout;
+    QWidget* m_navigatorWidget;
     KUrlNavigator* m_urlNavigator;
+    QPushButton* m_emptyTrashButton;
     DolphinSearchBox* m_searchBox;
+    KMessageWidget* m_messageWidget;
 
     DolphinView* m_view;
 
@@ -266,40 +333,12 @@ private:
     DolphinStatusBar* m_statusBar;
     QTimer* m_statusBarTimer;            // Triggers a delayed update
     QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
+    bool m_autoGrabFocus;
 
-    DolphinModel* m_dolphinModel;
-    DolphinDirLister* m_dirLister;
-    DolphinSortFilterProxyModel* m_proxyModel;
+#ifdef KF5Activities_FOUND
+private:
+    KActivities::ResourceInstance * m_activityResourceInstance;
+#endif
 };
 
-inline const DolphinStatusBar* DolphinViewContainer::statusBar() const
-{
-    return m_statusBar;
-}
-
-inline DolphinStatusBar* DolphinViewContainer::statusBar()
-{
-    return m_statusBar;
-}
-
-inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const
-{
-    return m_urlNavigator;
-}
-
-inline KUrlNavigator* DolphinViewContainer::urlNavigator()
-{
-    return m_urlNavigator;
-}
-
-inline const DolphinView* DolphinViewContainer::view() const
-{
-    return m_view;
-}
-
-inline DolphinView* DolphinViewContainer::view()
-{
-    return m_view;
-}
-
 #endif // DOLPHINVIEWCONTAINER_H