]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/dolphinviewcontainer.h
Apply 1 suggestion(s) to 1 file(s)
[dolphin.git] / src / dolphinviewcontainer.h
index 304c9958d9646dc77b0888275d6286b6626f81e8..a509bab3d91a514517205ed2c24a1865621505a7 100644 (file)
@@ -7,29 +7,37 @@
 #ifndef DOLPHINVIEWCONTAINER_H
 #define DOLPHINVIEWCONTAINER_H
 
-#include "config-kactivities.h"
+#include "config-dolphin.h"
 #include "dolphinurlnavigator.h"
+#include "selectionmode/bottombar.h"
 #include "views/dolphinview.h"
 
 #include <KFileItem>
 #include <KIO/Job>
+#include <KMessageWidget>
 #include <KUrlNavigator>
 
 #include <QElapsedTimer>
 #include <QPushButton>
 #include <QWidget>
 
-#ifdef HAVE_KACTIVITIES
-namespace KActivities {
-    class ResourceInstance;
-}
-#endif
+#include <initializer_list>
 
+namespace Admin
+{
+class Bar;
+}
 class FilterBar;
-class KMessageWidget;
+class QAction;
+class QGridLayout;
 class QUrl;
 class DolphinSearchBox;
 class DolphinStatusBar;
+class KFileItemList;
+namespace SelectionMode
+{
+class TopBar;
+}
 
 /**
  * @short Represents a view for the directory content
@@ -48,14 +56,7 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
-    enum MessageType
-    {
-        Information,
-        Warning,
-        Error
-    };
-
-    DolphinViewContainer(const QUrl& url, QWidget* parent);
+    DolphinViewContainer(const QUrl &url, QWidget *parent);
     ~DolphinViewContainer() override;
 
     /**
@@ -63,6 +64,7 @@ public:
      * The URL navigator is synchronized with this URL.
      */
     QUrl url() const;
+    KFileItem rootItem() const;
 
     /**
      * If \a active is true, the view container will marked as active. The active
@@ -81,8 +83,8 @@ public:
 
     QString currentSearchText() const;
 
-    const DolphinStatusBarstatusBar() const;
-    DolphinStatusBarstatusBar();
+    const DolphinStatusBar *statusBar() const;
+    DolphinStatusBar *statusBar();
 
     /**
      * @return  An UrlNavigator that is controlling this view
@@ -116,8 +118,8 @@ public:
      */
     DolphinUrlNavigator *urlNavigatorInternalWithHistory();
 
-    const DolphinViewview() const;
-    DolphinViewview();
+    const DolphinView *view() const;
+    DolphinView *view();
 
     /**
      * @param urlNavigator  The UrlNavigator that is supposed to control
@@ -126,26 +128,44 @@ public:
     void connectUrlNavigator(DolphinUrlNavigator *urlNavigator);
 
     /**
-     * Disconnects the navigator that is currently controling the view.
+     * Disconnects the navigator that is currently controlling the view.
      * This method completely reverses connectUrlNavigator().
      */
     void disconnectUrlNavigator();
 
     /**
-     * Shows the message \msg with the given type non-modal above
-     * the view-content.
+     * Sets a selection mode that is useful for quick and easy selecting or deselecting of files.
+     * This method is the central authority about enabling or disabling selection mode:
+     * All other classes that want to enable or disable selection mode should trigger a call of this method.
+     *
+     * This method sets the selection mode for the view of this viewContainer and sets the visibility of the
+     * selection mode top and bottom bar which also belong to this viewContainer.
+     *
+     * @param enabled           Whether to enable or disable selection mode.
+     * @param actionCollection  The collection of actions from which the actions on the bottom bar are retrieved.
+     * @param bottomBarContents The contents the bar is supposed to show after this call.
+     */
+    void setSelectionModeEnabled(bool enabled,
+                                 KActionCollection *actionCollection = nullptr,
+                                 SelectionMode::BottomBar::Contents bottomBarContents = SelectionMode::BottomBar::Contents::GeneralContents);
+    /** @see setSelectionModeEnabled() */
+    bool isSelectionModeEnabled() const;
+
+    /**
+     * Shows the message \message with the given type \messageType non-modal above the view-content.
+     * \buttonActions defines actions which the user can trigger as a response to this message. They are presented as buttons below the \message.
      */
-    void showMessage(const QString& msg, MessageType type);
+    void showMessage(const QString &message, KMessageWidget::MessageType messageType, std::initializer_list<QAction *> buttonActions = {});
 
     /**
      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
      */
     void readSettings();
 
-    /** Returns true, if the filter bar is visible. */
+    /** @returns true, if the filter bar is visible.
+     *           false, if it is hidden or currently animating towards a hidden state. */
     bool isFilterBarVisible() const;
 
-
     /** Returns true if the search mode is enabled. */
     bool isSearchModeEnabled() const;
 
@@ -182,6 +202,7 @@ public:
      */
     void disableUrlNavigatorSelectionRequests();
     void enableUrlNavigatorSelectionRequests();
+    void clearFilterBar();
 
 public Q_SLOTS:
     /**
@@ -191,7 +212,7 @@ public Q_SLOTS:
      * are emitted.
      * @see DolphinViewContainer::urlNavigator()
      */
-    void setUrl(const QUrlurl);
+    void setUrl(const QUrl &url);
 
     /**
      * Popups the filter bar above the status bar if \a visible is true.
@@ -206,6 +227,9 @@ public Q_SLOTS:
      */
     void setSearchModeEnabled(bool enabled);
 
+    /** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */
+    void slotSplitTabDisabled();
+
 Q_SIGNALS:
     /**
      * Is emitted whenever the filter bar has changed its visibility state.
@@ -216,6 +240,8 @@ Q_SIGNALS:
      */
     void searchModeEnabledChanged(bool enabled);
 
+    void selectionModeChanged(bool enabled);
+
     /**
      * 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
@@ -229,6 +255,16 @@ Q_SIGNALS:
      */
     void captionChanged();
 
+    /**
+     * Is emitted if a new tab should be opened in the background for the URL \a url.
+     */
+    void tabRequested(const QUrl &url);
+
+    /**
+     * Is emitted if a new tab should be opened for the URL \a url and set as active.
+     */
+    void activeTabRequested(const QUrl &url);
+
 private Q_SLOTS:
     /**
      * Updates the number of items (= number of files + number of
@@ -248,10 +284,6 @@ private Q_SLOTS:
      */
     void updateStatusBar();
 
-    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.
@@ -274,26 +306,31 @@ private Q_SLOTS:
      * 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 QUrlurl);
+    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 slotItemActivated(const KFileItemitem);
+    void slotItemActivated(const KFileItem &item);
 
     /**
      * Handles activation of multiple files. The files get started by
      * the corresponding applications.
      */
-    void slotItemsActivated(const KFileItemList& items);
+    void slotItemsActivated(const KFileItemList &items);
+
+    /**
+     * Handles middle click of file. It opens the file passed using the second application associated with the file's mimetype.
+     */
+    void slotfileMiddleClickActivated(const KFileItem &item);
 
     /**
      * Shows the information for the item \a item inside the statusbar. If the
      * item is null, the default statusbar information is shown.
      */
-    void showItemInfo(const KFileItemitem);
+    void showItemInfo(const KFileItem &item);
 
     void closeFilterBar();
 
@@ -301,7 +338,7 @@ private Q_SLOTS:
      * Filters the currently shown items by \a nameFilter. All items
      * which contain the given filter string will be shown.
      */
-    void setNameFilter(const QStringnameFilter);
+    void setNameFilter(const QString &nameFilter);
 
     /**
      * Marks the view container as active
@@ -313,25 +350,25 @@ private Q_SLOTS:
      * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
      * is emitted. Tries to save the view-state.
      */
-    void slotUrlNavigatorLocationAboutToBeChanged(const QUrlurl);
+    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 QUrlurl);
+    void slotUrlNavigatorLocationChanged(const QUrl &url);
 
     /**
      * @see KUrlNavigator::urlSelectionRequested
      */
-    void slotUrlSelectionRequested(const QUrlurl);
+    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 QUrl& oldUrl, const QUrl& newUrl);
+    void redirect(const QUrl &oldUrl, const QUrl &newUrl);
 
     /** Requests the focus for the view \a m_view. */
     void requestFocus();
@@ -340,6 +377,7 @@ private Q_SLOTS:
      * Gets the search URL from the searchbox and starts searching.
      */
     void startSearching();
+    void openSearchBox();
     void closeSearchBox();
 
     /**
@@ -351,9 +389,14 @@ private Q_SLOTS:
     void slotStatusBarZoomLevelChanged(int zoomLevel);
 
     /**
-     * Slot that calls showMessage(msg, Error).
+     * Creates and shows an error message based on \p message and \p kioErrorCode.
+     */
+    void slotErrorMessageFromView(const QString &message, const int kioErrorCode);
+
+    /**
+     * Slot that calls showMessage(message, KMessageWidget::Error).
      */
-    void showErrorMessage(const QString& msg);
+    void showErrorMessage(const QString &message);
 
     /**
      * Is invoked when a KFilePlacesModel has been changed
@@ -361,11 +404,17 @@ private Q_SLOTS:
      */
     void slotPlacesModelChanged();
 
+    void slotHiddenFilesShownChanged(bool showHiddenFiles);
+    void slotSortHiddenLastChanged(bool hiddenLast);
+    void slotCurrentDirectoryRemoved();
+
+    void slotOpenUrlFinished(KJob *job);
+
 private:
     /**
      * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
      */
-    bool isSearchUrl(const QUrlurl) const;
+    bool isSearchUrl(const QUrl &url) const;
 
     /**
      * Saves the state of the current view: contents position,
@@ -379,8 +428,26 @@ private:
      */
     void tryRestoreViewState();
 
+    /**
+     * @return Path of nearest existing ancestor directory.
+     */
+    QString getNearestExistingAncestorOfPath(const QString &path) const;
+
+    /**
+     * Update the geometry of statusbar depending on what mode it is using.
+     */
+    void updateStatusBarGeometry();
+
+    /**
+     * @return Preferred geometry of the small statusbar.
+     */
+    QRect preferredSmallStatusBarGeometry();
+
+protected:
+    bool eventFilter(QObject *object, QEvent *event) override;
+
 private:
-    QVBoxLayout* m_topLayout;
+    QGridLayout *m_topLayout;
 
     /**
      * The internal UrlNavigator which is never visible to the user.
@@ -395,28 +462,36 @@ private:
      * Otherwise it's one of the UrlNavigators visible in the toolbar.
      */
     QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;
-    DolphinSearchBox* m_searchBox;
+
+    DolphinSearchBox *m_searchBox;
     bool m_searchModeEnabled;
-    KMessageWidget* m_messageWidget;
 
-    DolphinView* m_view;
+    /// A bar shown at the top of the view to signify that the view is currently viewed and acted on with elevated privileges.
+    Admin::Bar *m_adminBar;
+    /// An action to switch to the admin protocol. This variable will always be nullptr unless kio-admin was installed. @see Admin::WorkerIntegration.
+    QAction *m_authorizeToEnterFolderAction;
+
+    KMessageWidget *m_messageWidget;
 
-    FilterBar* m_filterBar;
+    /// A bar shown at the top of the view to signify that selection mode is currently active.
+    SelectionMode::TopBar *m_selectionModeTopBar;
 
-    DolphinStatusBar* m_statusBar;
-    QTimer* m_statusBarTimer;            // Triggers a delayed update
-    QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
+    DolphinView *m_view;
+
+    FilterBar *m_filterBar;
+
+    /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing.
+    SelectionMode::BottomBar *m_selectionModeBottomBar;
+
+    DolphinStatusBar *m_statusBar;
+    QTimer *m_statusBarTimer; // Triggers a delayed update
+    QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
     bool m_autoGrabFocus;
     /**
      * The visual state to be applied to the next UrlNavigator that gets
      * connected to this ViewContainer.
      */
     std::unique_ptr<DolphinUrlNavigator::VisualState> m_urlNavigatorVisualState;
-
-#ifdef HAVE_KACTIVITIES
-private:
-    KActivities::ResourceInstance * m_activityResourceInstance;
-#endif
 };
 
 #endif // DOLPHINVIEWCONTAINER_H