Move "Show in Groups" toggle action into Sort menu

[dolphin.git] / src / dolphinviewcontainer.h

diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h
index b3c48ccf98abef977f81978b5dce855a30ad0fa3..a509bab3d91a514517205ed2c24a1865621505a7 100644 (file)
--- a/src/dolphinviewcontainer.h
+++ b/src/dolphinviewcontainer.h
@@ -1,42 +1,43 @@
-/***************************************************************************
- *   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  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   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.,                                       *
- *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2007 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */

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

+#include "config-dolphin.h"
+#include "dolphinurlnavigator.h"
+#include "selectionmode/bottombar.h"
+#include "views/dolphinview.h"
+

 #include <KFileItem>
 #include <KFileItem>

-#include <KFileItemDelegate>
-#include <KGlobalSettings>

 #include <KIO/Job>
 #include <KIO/Job>

-
+#include <KMessageWidget>

 #include <KUrlNavigator>
 
 #include <QElapsedTimer>
 #include <KUrlNavigator>
 
 #include <QElapsedTimer>

+#include <QPushButton>

 #include <QWidget>
 
 #include <QWidget>
 

-#include <views/dolphinview.h>
+#include <initializer_list>

 
 

+namespace Admin
+{
+class Bar;
+}

 class FilterBar;
 class FilterBar;

-class KUrl;
-class KUrlNavigator;
+class QAction;
+class QGridLayout;
+class QUrl;

 class DolphinSearchBox;
 class DolphinStatusBar;
 class DolphinSearchBox;
 class DolphinStatusBar;

+class KFileItemList;
+namespace SelectionMode
+{
+class TopBar;
+}

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


@@ -55,14 +56,15 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
     Q_OBJECT
 
 public:

-    DolphinViewContainer(const KUrl& url, QWidget* parent);
-    virtual ~DolphinViewContainer();
+    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.
      */
 
     /**
      * Returns the current active URL, where all actions are applied.
      * The URL navigator is synchronized with this URL.
      */

-    KUrl url() const;
+    QUrl url() const;
+    KFileItem rootItem() 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


@@ -71,34 +73,138 @@ public:
     void setActive(bool active);
     bool isActive() const;
 
     void setActive(bool active);
     bool isActive() const;
 

-    const DolphinStatusBar* statusBar() const;
-    DolphinStatusBar* statusBar();
+    /**
+     * 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();
+
+    /**
+     * @return  An UrlNavigator that is controlling this view
+     *          or nullptr if there is none.
+     * @see connectUrlNavigator()
+     * @see disconnectUrlNavigator()
+     *
+     * Use urlNavigatorInternalWithHistory() if you want to access the history.
+     * @see urlNavigatorInternalWithHistory()
+     */
+    const DolphinUrlNavigator *urlNavigator() const;
+    /**
+     * @return  An UrlNavigator that is controlling this view
+     *          or nullptr if there is none.
+     * @see connectUrlNavigator()
+     * @see disconnectUrlNavigator()
+     *
+     * Use urlNavigatorInternalWithHistory() if you want to access the history.
+     * @see urlNavigatorInternalWithHistory()
+     */
+    DolphinUrlNavigator *urlNavigator();
+
+    /**
+     * @return An UrlNavigator that contains this view's history.
+     * Use urlNavigator() instead when not accessing the history.
+     */
+    const DolphinUrlNavigator *urlNavigatorInternalWithHistory() const;
+    /**
+     * @return An UrlNavigator that contains this view's history.
+     * Use urlNavigator() instead when not accessing the history.
+     */
+    DolphinUrlNavigator *urlNavigatorInternalWithHistory();
+
+    const DolphinView *view() const;
+    DolphinView *view();
+
+    /**
+     * @param urlNavigator  The UrlNavigator that is supposed to control
+     *                      this view.
+     */
+    void connectUrlNavigator(DolphinUrlNavigator *urlNavigator);

 
 

-    const KUrlNavigator* urlNavigator() const;
-    KUrlNavigator* urlNavigator();
+    /**
+     * Disconnects the navigator that is currently controlling the view.
+     * This method completely reverses connectUrlNavigator().
+     */
+    void disconnectUrlNavigator();

 
 

-    const DolphinView* view() const;
-    DolphinView* view();
+    /**
+     * 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;

 
 

-    const DolphinSearchBox* searchBox() const;
-    DolphinSearchBox* searchBox();
+    /**
+     * 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 &message, KMessageWidget::MessageType messageType, std::initializer_list<QAction *> buttonActions = {});

 
     /**
      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
      */
     void readSettings();
 
 
     /**
      * 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;
 
     bool isFilterBarVisible() const;
 

+    /** Returns true if the search mode is enabled. */
+    bool isSearchModeEnabled() 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.
+     * @return Text that should be used for the current URL when creating
+     *         a new place.

      */
      */

-    void setSearchModeEnabled(bool enabled);
-    bool isSearchModeEnabled() const;
+    QString placesText() const;
+
+    /**
+     * Reload the view of this container. This will also hide messages in a messagewidget.
+     */
+    void reload();
+
+    /**
+     * @return Returns a Caption suitable for display in the window title.
+     * It is calculated depending on GeneralSettings::showFullPathInTitlebar().
+     * If it's false, it calls caption().
+     */
+    QString captionWindowTitle() const;
+
+    /**
+     * @return Returns a Caption suitable for display to the user. It is
+     * calculated depending on settings, if a search is active and other
+     * factors.
+     */
+    QString caption() const;
+
+    /**
+     * Disable/enable the behavior of "select child when moving to parent folder"
+     * offered by KUrlNavigator.
+     *
+     * See KUrlNavigator::urlSelectionRequested
+     */
+    void disableUrlNavigatorSelectionRequests();
+    void enableUrlNavigatorSelectionRequests();
+    void clearFilterBar();

 
 

-public slots:
+public Q_SLOTS:

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


@@ -106,7 +212,7 @@ public slots:
      * are emitted.
      * @see DolphinViewContainer::urlNavigator()
      */
      * 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 visible is true.
 
     /**
      * Popups the filter bar above the status bar if \a visible is true.


@@ -115,11 +221,26 @@ public slots:
      */
     void setFilterBarVisible(bool visible);
 
      */
     void setFilterBarVisible(bool visible);
 

-signals:
+    /**
+     * 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);
+
+    /** 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.
      */
     void showFilterBarChanged(bool shown);
     /**
      * Is emitted whenever the filter bar has changed its visibility state.
      */
     void showFilterBarChanged(bool shown);

+    /**
+     * Is emitted whenever the search mode has changed its state.
+     */
+    void searchModeEnabledChanged(bool enabled);
+
+    void selectionModeChanged(bool enabled);

 
     /**
      * Is emitted when the write state of the folder has been changed. The application
 
     /**
      * Is emitted when the write state of the folder has been changed. The application


@@ -129,13 +250,22 @@ signals:
     void writeStateChanged(bool isFolderWritable);
 
     /**
     void writeStateChanged(bool isFolderWritable);
 
     /**

-     * Is emitted if the search mode has been enabled or disabled.
-     * (see DolphinViewContainer::setSearchModeEnabled() and
-     * DolphinViewContainer::isSearchModeEnabled())
+     * Is emitted when the Caption has been changed.
+     * @see DolphinViewContainer::caption()
+     */
+    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 searchModeChanged(bool enabled);
+    void activeTabRequested(const QUrl &url);

 
 

-private slots:
+private Q_SLOTS:

     /**
      * Updates the number of items (= number of files + number of
      * directories) in the statusbar. If files are selected, the number
     /**
      * Updates the number of items (= number of files + number of
      * directories) in the statusbar. If files are selected, the number


@@ -154,10 +284,6 @@ private slots:
      */
     void updateStatusBar();
 
      */
     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.
     /**
      * Updates the statusbar to show an undetermined progress with the correct
      * context information whether a searching or a directory loading is done.


@@ -170,27 +296,41 @@ private slots:
      */
     void slotDirectoryLoadingCompleted();
 
      */
     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 slotItemActivated(const KFileItem& item);
+    void slotItemActivated(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.
+     * Handles activation of multiple files. The files get started by
+     * the corresponding applications.

      */
      */

-    void showItemInfo(const KFileItem& item);
+    void slotItemsActivated(const KFileItemList &items);

 
 

-    /** 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);
+    /**
+     * 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 "operation completed" message \a msg inside the statusbar. */
-    void showOperationCompletedMessage(const QString& msg);
+    /**
+     * 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 KFileItem &item);

 
     void closeFilterBar();
 
 
     void closeFilterBar();
 


@@ -198,7 +338,7 @@ private slots:
      * Filters the currently shown items by \a nameFilter. All items
      * which contain the given filter string will be shown.
      */
      * Filters the currently shown items by \a nameFilter. All items
      * which contain the given filter string will be shown.
      */

-    void setNameFilter(const QString& nameFilter);
+    void setNameFilter(const QString &nameFilter);

 
     /**
      * Marks the view container as active
 
     /**
      * Marks the view container as active


@@ -206,66 +346,75 @@ private slots:
      */
     void activate();
 
      */
     void activate();
 

-    /**
-     * Is invoked if the signal urlAboutToBeChanged() from the DolphinView
-     * is emitted. Tries to save the view-state.
-     */
-    void slotViewUrlAboutToBeChanged(const KUrl& url);
-

     /**
      * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
      * is emitted. Tries to save the view-state.
      */
     /**
      * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
      * is emitted. Tries to save the view-state.
      */

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

 
     /**
      * Restores the current view to show \a url and assures
      * that the root URL of the view is respected.
      */
 
     /**
      * 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.
      */
 
     /**
      * 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();
 

-    /**
-     * Saves the currently used URL completion mode of
-     * the URL navigator.
-     */
-    void saveUrlCompletionMode(KGlobalSettings::Completion completion);
-
-    void slotHistoryChanged();
-

     /**
      * Gets the search URL from the searchbox and starts searching.
     /**
      * 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 openSearchBox();

     void closeSearchBox();
 
     /**
      * Stops the loading of a directory. Is connected with the "stopPressed" signal
      * from the statusbar.
      */
     void closeSearchBox();
 
     /**
      * Stops the loading of a directory. Is connected with the "stopPressed" signal
      * from the statusbar.
      */

-    void stopLoading();
+    void stopDirectoryLoading();
+
+    void slotStatusBarZoomLevelChanged(int zoomLevel);
+
+    /**
+     * 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 &message);
+
+    /**
+     * Is invoked when a KFilePlacesModel has been changed
+     * @see DolphinPlacesModelSingleton::instance().placesModel()
+     */
+    void slotPlacesModelChanged();
+
+    void slotHiddenFilesShownChanged(bool showHiddenFiles);
+    void slotSortHiddenLastChanged(bool hiddenLast);
+    void slotCurrentDirectoryRemoved();
+
+    void slotOpenUrlFinished(KJob *job);

 
 private:
     /**
 
 private:
     /**

-     * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://).
+     * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).

      */
      */

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

 
     /**
      * Saves the state of the current view: contents position,
 
     /**
      * Saves the state of the current view: contents position,


@@ -273,18 +422,76 @@ private:
      */
     void saveViewState();
 
      */
     void saveViewState();
 

+    /**
+     * Restores the state of the current view iff the URL navigator contains a
+     * non-empty location state.
+     */
+    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:
 private:

-    QVBoxLayout* m_topLayout;
-    KUrlNavigator* m_urlNavigator;
-    DolphinSearchBox* m_searchBox;
+    QGridLayout *m_topLayout;
+
+    /**
+     * The internal UrlNavigator which is never visible to the user.
+     * m_urlNavigator is used even when another UrlNavigator is controlling
+     * the view to keep track of this object's history.
+     */
+    std::unique_ptr<DolphinUrlNavigator> m_urlNavigator;
+
+    /**
+     * The UrlNavigator that is currently connected to the view.
+     * This is a nullptr if no UrlNavigator is connected.
+     * Otherwise it's one of the UrlNavigators visible in the toolbar.
+     */
+    QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;

 
 

-    DolphinView* m_view;
+    DolphinSearchBox *m_searchBox;
+    bool m_searchModeEnabled;

 
 

-    FilterBar* m_filterBar;
+    /// 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;

 
 

-    DolphinStatusBar* m_statusBar;
-    QTimer* m_statusBarTimer;            // Triggers a delayed update
-    QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
+    KMessageWidget *m_messageWidget;
+
+    /// A bar shown at the top of the view to signify that selection mode is currently active.
+    SelectionMode::TopBar *m_selectionModeTopBar;
+
+    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;

 };
 
 #endif // DOLPHINVIEWCONTAINER_H
 };
 
 #endif // DOLPHINVIEWCONTAINER_H