Load KFileItemAction plugins with json metadata

[dolphin.git] / src / dolphinviewcontainer.h

diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h
index 1f8f1caf6259dc56082ece151bbc02f683f40aa9..62f91100e9e5d457edd6f4d927c87610335834d7 100644 (file)
--- a/src/dolphinviewcontainer.h
+++ b/src/dolphinviewcontainer.h
@@ -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  *
  *                                                                         *
  *   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  *


@@ -17,40 +17,39 @@
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 
  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  ***************************************************************************/
 

-

 #ifndef DOLPHINVIEWCONTAINER_H
 #define DOLPHINVIEWCONTAINER_H
 
 #ifndef DOLPHINVIEWCONTAINER_H
 #define DOLPHINVIEWCONTAINER_H
 

-#include "dolphinview.h"
+#include <KFileItem>
+#include <KCompletion>
+#include <KIO/Job>
+
+#include <KUrlNavigator>

 
 

-#include <kfileitem.h>
-#include <kfileitemdelegate.h>
-#include <kglobalsettings.h>
-#include <kio/job.h>
+#include <QElapsedTimer>
+#include <QWidget>

 
 

-#include <kurlnavigator.h>
+#include <views/dolphinview.h>
+#include <config-dolphin.h>

 
 

-#include <QtGui/QKeyEvent>
-#include <QtCore/QLinkedList>
-#include <QtGui/QListView>
-#include <QtGui/QBoxLayout>
-#include <QtGui/QWidget>
+#ifdef KF5Activities_FOUND
+namespace KActivities {
+    class ResourceInstance;
+}
+#endif

 
 class FilterBar;
 
 class FilterBar;

-class KUrl;
-class DolphinModel;
+class KMessageWidget;
+class QUrl;

 class KUrlNavigator;
 class KUrlNavigator;

-class DolphinDirLister;
-class DolphinMainWindow;
-class DolphinSortFilterProxyModel;
+class DolphinSearchBox;

 class DolphinStatusBar;
 class DolphinStatusBar;

-class QModelIndex;

 
 /**
  * @short Represents a view for the directory content
  *        including the navigation bar, filter bar and status bar.
  *
 
 /**
  * @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
  * Dolphin allows to have up to two views inside the main window.
  *
  * @see DolphinView


@@ -63,26 +62,21 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
     Q_OBJECT
 
 public:

-    DolphinViewContainer(DolphinMainWindow* mainwindow,
-                         QWidget *parent,
-                         const KUrl& url);
-
+    enum MessageType
+    {
+        Information,
+        Warning,
+        Error
+    };
+
+    DolphinViewContainer(const QUrl& url, QWidget* parent);

     virtual ~DolphinViewContainer();
 
     virtual ~DolphinViewContainer();
 

-    /**
-     * Sets the current active URL, where all actions are applied. The
-     * URL navigator is synchronized with this URL. The signals
-     * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
-     * are emitted.
-     * @see DolphinViewContainer::urlNavigator()
-     */
-    void setUrl(const KUrl& url);
-

     /**
      * Returns the current active URL, where all actions are applied.
      * The URL navigator is synchronized with this URL.
      */
     /**
      * Returns the current active URL, where all actions are applied.
      * The URL navigator is synchronized with this URL.
      */

-    const KUrl& url() const;
+    QUrl url() const;

 
     /**
      * If \a active is true, the view container will marked as active. The active
 
     /**
      * If \a active is true, the view container will marked as active. The active


@@ -91,14 +85,16 @@ public:
     void setActive(bool active);
     bool isActive() const;
 
     void setActive(bool active);
     bool isActive() const;
 

-    const DolphinStatusBar* statusBar() const;
-    DolphinStatusBar* statusBar();
-

     /**
     /**

-     * Returns true, if the URL shown by the navigation bar is editable.
-     * @see KUrlNavigator
+     * 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.

      */
      */

-    bool isUrlEditable() const;
+    void setAutoGrabFocus(bool grab);
+    bool autoGrabFocus() const;
+
+    const DolphinStatusBar* statusBar() const;
+    DolphinStatusBar* statusBar();

 
     const KUrlNavigator* urlNavigator() const;
     KUrlNavigator* urlNavigator();
 
     const KUrlNavigator* urlNavigator() const;
     KUrlNavigator* urlNavigator();


@@ -106,19 +102,49 @@ public:
     const DolphinView* view() const;
     DolphinView* view();
 
     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.
      */
     /**
      * 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;
 
 
     /** Returns true, if the filter bar is visible. */
     bool isFilterBarVisible() const;
 

+    /**
+     * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
+     * will be hidden and replaced by a line editor that allows to enter a search term.
+     */
+    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;
+

 public slots:
     /**
 public slots:
     /**

-     * Popups the filter bar above the status bar if \a show is true.
+     * Sets the current active URL, where all actions are applied. The
+     * URL navigator is synchronized with this URL. The signals
+     * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
+     * are emitted.
+     * @see DolphinViewContainer::urlNavigator()

      */
      */

-    void showFilterBar(bool show);
+    void setUrl(const QUrl& url);
+
+    /**
+     * 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 setFilterBarVisible(bool visible);

 
 signals:
     /**
 
 signals:
     /**


@@ -126,13 +152,23 @@ signals:
      */
     void showFilterBarChanged(bool shown);
 
      */
     void showFilterBarChanged(bool shown);
 

-private slots: 
+    /**
+     * 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);
+
+private slots:

     /**
      * 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. The update
      * is done asynchronously, as getting the sum of the
      * filesizes can be an expensive operation.
     /**
      * 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. 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();
 
      */
     void delayedStatusBarUpdate();
 


@@ -142,27 +178,46 @@ private slots:
      */
     void updateStatusBar();
 
      */
     void updateStatusBar();
 

-    void updateProgress(int percent);
+    void updateDirectoryLoadingProgress(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.
      */
 
     /**
      * 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.
      */
 
     /**
      * 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
 
     /**
      * Shows the information for the item \a item inside the statusbar. If the


@@ -170,15 +225,6 @@ private slots:
      */
     void showItemInfo(const KFileItem& item);
 
      */
     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();
 
     /**
     void closeFilterBar();
 
     /**


@@ -187,30 +233,6 @@ private slots:
      */
     void setNameFilter(const QString& nameFilter);
 
      */
     void setNameFilter(const QString& nameFilter);
 

-    /**
-     * Opens the context menu on the current mouse position.
-     * @item          File item context. If item is null, the context menu
-     *                should be applied to \a url.
-     * @url           URL which contains \a item.
-     * @customActions Actions that should be added to the context menu,
-     *                if the file item is null.
-     */
-    void openContextMenu(const KFileItem& item,
-                         const KUrl& url,
-                         const QList<QAction*>& customActions);
-
-    /**
-     * Saves the position of the contents to the
-     * current history element.
-     */
-    void saveContentsPos(int x, int y);
-
-    /**
-     * Restores the contents position of the view, if the view
-     * is part of the history.
-     */
-    void restoreContentsPos();
-

     /**
      * Marks the view container as active
      * (see DolphinViewContainer::setActive()).
     /**
      * Marks the view container as active
      * (see DolphinViewContainer::setActive()).


@@ -218,29 +240,29 @@ private slots:
     void activate();
 
     /**
     void activate();
 
     /**

-     * Restores the current view to show \a url and assures
-     * that the root URL of the view is respected.
+     * Is invoked if the signal urlAboutToBeChanged() from the DolphinView
+     * is emitted. Tries to save the view-state.

      */
      */

-    void restoreView(const KUrl& url);
+    void slotViewUrlAboutToBeChanged(const QUrl& url);

 
     /**
 
     /**

-     * Saves the root URL of the current URL \a url
-     * into the URL navigator.
+     * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
+     * is emitted. Tries to save the view-state.

      */
      */

-    void saveRootUrl(const KUrl& url);
+    void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);

 
     /**
 
     /**

-     * Is connected with the URL navigator and drops the URLs
-     * above the destination \a destination.
+     * Restores the current view to show \a url and assures
+     * that the root URL of the view is respected.

      */
      */

-    void dropUrls(const KUrl& destination, QDropEvent* event);
+    void slotUrlNavigatorLocationChanged(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.
      */
 
     /**
      * 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();
 
     /** Requests the focus for the view \a m_view. */
     void requestFocus();


@@ -249,58 +271,62 @@ private slots:
      * Saves the currently used URL completion mode of
      * the URL navigator.
      */
      * Saves the currently used URL completion mode of
      * the URL navigator.
      */

-    void saveUrlCompletionMode(KGlobalSettings::Completion completion);
+    void saveUrlCompletionMode(KCompletion::CompletionMode completion);

 
     void slotHistoryChanged();
 
 
     void slotHistoryChanged();
 

+    void slotReturnPressed();
+
+    /**
+     * Gets the search URL from the searchbox and starts searching.
+     */
+    void startSearching();
+    void closeSearchBox();
+
+    /**
+     * Stops the loading of a directory. Is connected with the "stopPressed" signal
+     * from the statusbar.
+     */
+    void stopDirectoryLoading();
+
+    void slotStatusBarZoomLevelChanged(int zoomLevel);
+
+    /**
+     * Slot that calls showMessage(msg, Error).
+     */
+    void showErrorMessage(const QString& msg);
+

 private:
 private:

-    bool m_showProgress;
-    bool m_isFolderWritable;
+    /**
+     * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+     */
+    bool isSearchUrl(const QUrl& url) const;

 
 

-    DolphinMainWindow* m_mainWindow;
+    /**
+     * Saves the state of the current view: contents position,
+     * root URL, ...
+     */
+    void saveViewState();
+
+private:

     QVBoxLayout* m_topLayout;
     KUrlNavigator* m_urlNavigator;
     QVBoxLayout* m_topLayout;
     KUrlNavigator* m_urlNavigator;

+    DolphinSearchBox* m_searchBox;
+    KMessageWidget* m_messageWidget;

 
     DolphinView* m_view;
 
     FilterBar* m_filterBar;
 
     DolphinStatusBar* m_statusBar;
 
     DolphinView* m_view;
 
     FilterBar* m_filterBar;
 
     DolphinStatusBar* m_statusBar;

-    QTimer* m_statusBarTimer;
+    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
 #endif // DOLPHINVIEWCONTAINER_H