Rewrite search integration

[dolphin.git] / src / dolphinviewcontainer.h

diff --git a/src/dolphinviewcontainer.h b/src/dolphinviewcontainer.h
index 7c81384d2be019e99c768a2507e11d9206d4eed6..e827c08856e1a740c2e17a8b175d6b116a623b0d 100644 (file)
--- a/src/dolphinviewcontainer.h
+++ b/src/dolphinviewcontainer.h
@@ -1,55 +1,57 @@
-/***************************************************************************
- *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
- *                                                                         *
- *   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 "dolphinview.h"
+#include "config-dolphin.h"
+#include "dolphinurlnavigator.h"
+#include "selectionmode/bottombar.h"
+#include "views/dolphinview.h"

 
 

-#include <kfileitem.h>
-#include <kfileitemdelegate.h>
-#include <kio/job.h>
+#include <KFileItem>
+#include <KIO/Job>
+#include <KMessageWidget>
+#include <KUrlNavigator>

 
 

-#include <kurlnavigator.h>
+#include <QElapsedTimer>
+#include <QPushButton>
+#include <QWidget>

 
 

-#include <QtGui/QKeyEvent>
-#include <QtCore/QLinkedList>
-#include <QtGui/QListView>
-#include <QtGui/QBoxLayout>
-#include <QtGui/QWidget>
+#include <initializer_list>

 
 

+namespace Admin
+{
+class Bar;
+}

 class FilterBar;
 class FilterBar;

-class KUrl;
-class DolphinModel;
-class KUrlNavigator;
-class DolphinDirLister;
-class DolphinMainWindow;
-class DolphinSortFilterProxyModel;
+class QAction;
+class QGridLayout;
+class QUrl;
+namespace Search
+{
+class Bar;
+}

 class DolphinStatusBar;
 class DolphinStatusBar;

-class QModelIndex;
+class KFileItemList;
+namespace SelectionMode
+{
+class TopBar;
+}
+
+/**
+ * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
+ */
+bool isSearchUrl(const QUrl &url);

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


@@ -62,12 +64,171 @@ class DolphinViewContainer : public QWidget
     Q_OBJECT
 
 public:
     Q_OBJECT
 
 public:

-    DolphinViewContainer(DolphinMainWindow* mainwindow,
-                         QWidget *parent,
-                         const KUrl& url);
+    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.
+     */
+    QUrl url() const;
+    KFileItem rootItem() const;
+
+    /**
+     * If \a active is true, the view container will marked as active. The active
+     * view container is defined as view where all actions are applied to.
+     */
+    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 setGrabFocusOnUrlChange(bool grabFocus);
+
+    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);
+
+    /**
+     * Disconnects the navigator that is currently controlling the view.
+     * This method completely reverses connectUrlNavigator().
+     */
+    void disconnectUrlNavigator();
+
+    /**
+     * Sets the visibility of this objects search configuration user interface. This search bar is the primary interface in Dolphin to search for files and
+     * folders.
+     *
+     * The signal searchBarVisibilityChanged will be emitted when the new visibility state is different from the old.
+     *
+     * Typically an animation will play when the search bar is shown or hidden, so the visibility of the bar will not necessarily match @p visible when this
+     * method returns. Instead use isSearchBarVisible(), which will always communicate the visibility state the search bar is heading to.
+     *
+     * @see Search::Bar.
+     * @see isSearchBarVisible().
+     */
+    void setSearchBarVisible(bool visible);
+
+    /** @returns true if the search bar is visible while not being in the process to hide itself. */
+    bool isSearchBarVisible() const;
+
+    /**
+     * Moves keyboard focus to the search bar. The search term is fully selected to allow easy replacing.
+     */
+    void setFocusToSearchBar();

 
 

-    virtual ~DolphinViewContainer();
+    /**
+     * 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 &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.
+     *           false, if it is hidden or currently animating towards a hidden state. */
+    bool isFilterBarVisible() 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();
+
+    /**
+     * @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 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


@@ -75,86 +236,124 @@ public:
      * are emitted.
      * @see DolphinViewContainer::urlNavigator()
      */
      * are emitted.
      * @see DolphinViewContainer::urlNavigator()
      */

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

 
     /**
 
     /**

-     * Returns the current active URL, where all actions are applied.
-     * The URL navigator is synchronized with this 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.

      */
      */

-    const KUrl& url() const;
+    void setFilterBarVisible(bool visible);
+
+    /** Used to notify the m_selectionModeBottomBar that there is no other ViewContainer in the tab. */
+    void slotSplitTabDisabled();

 
 

+Q_SIGNALS:

     /**
     /**

-     * If \a active is true, the view container will marked as active. The active
-     * view container is defined as view where all actions are applied to.
+     * Is emitted whenever the filter bar has changed its visibility state.

      */
      */

-    void setActive(bool active);
-    bool isActive() const;
+    void showFilterBarChanged(bool shown);
+    /**
+     * Is emitted whenever a change to the search bar's visibility is invoked. The visibility change might not have actually already taken effect by the time
+     * this signal is emitted because typically the showing and hiding is animated.
+     * @param visible The visibility state the search bar is going to end up at.
+     * @see Search::Bar.
+     * @see setSearchBarVisible().
+     * @see isSearchBarVisible().
+     */
+    void searchBarVisibilityChanged(bool visible);

 
 

-    const DolphinStatusBar* statusBar() const;
-    DolphinStatusBar* statusBar();
+    void selectionModeChanged(bool enabled);

 
     /**
 
     /**

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

      */
      */

-    bool isUrlEditable() const;
+    void writeStateChanged(bool isFolderWritable);

 
 

-    const KUrlNavigator* urlNavigator() const;
-    KUrlNavigator* urlNavigator();
-
-    const DolphinView* view() const;
-    DolphinView* view();
+    /**
+     * Is emitted when the Caption has been changed.
+     * @see DolphinViewContainer::caption()
+     */
+    void captionChanged();

 
 

-    /** Returns true, if the filter bar is visible. */
-    bool isFilterBarVisible() const;
+    /**
+     * Is emitted if a new tab should be opened in the background for the URL \a url.
+     */
+    void tabRequested(const QUrl &url);

 
 

-public slots:

     /**
     /**

-     * Popups the filter bar above the status bar if \a show is true.
+     * Is emitted if a new tab should be opened for the URL \a url and set as active.

      */
      */

-    void showFilterBar(bool show);
+    void activeTabRequested(const QUrl &url);

 
 

+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

-     * of selected files and the sum of the filesize is shown.
+     * 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 updateStatusBar();
+    void delayedStatusBarUpdate();

 
 

-signals:

     /**
     /**

-     * Is emitted whenever the filter bar has changed its visibility state.
+     * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and
+     * updates the status bar synchronously.

      */
      */

-    void showFilterBarChanged(bool shown);
+    void updateStatusBar();

 
 

-private slots:
-    void updateProgress(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();

 
     /**
 
     /**

-     * Handles clicking on an item
+     * Updates the statusbar to show, that the directory loading has
+     * been canceled.

      */
      */

-    void slotItemTriggered(const KFileItem& item);
+    void slotDirectoryLoadingCanceled();

 
     /**
 
     /**

-     * Shows the information for the item \a item inside the statusbar. If the
-     * item is null, the default statusbar information is shown.
+     * Is called if the URL set by DolphinView::setUrl() represents
+     * a file and not a directory. Takes care to activate the file.

      */
      */

-    void showItemInfo(const KFileItem& item);
+    void slotUrlIsFileError(const QUrl &url);

 
 

-    /** Shows the information \a msg inside the statusbar. */
-    void showInfoMessage(const QString& msg);
+    /**
+     * 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);

 
 

-    /** Shows the error message \a msg inside the statusbar. */
-    void showErrorMessage(const QString& msg);
+    /**
+     * Handles activation of multiple files. The files get started by
+     * the corresponding applications.
+     */
+    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 "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();
 


@@ -162,110 +361,148 @@ 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);

 
     /**
 
     /**

-     * Opens the context menu on the current mouse position.
-     * @item  File item context. If item is 0, the context menu
-     *        should be applied to \a url.
-     * @url   URL which contains \a item.
+     * Marks the view container as active
+     * (see DolphinViewContainer::setActive()).

      */
      */

-    void openContextMenu(const KFileItem& item, const KUrl& url);
+    void activate();

 
     /**
 
     /**

-     * Saves the position of the contents to the
-     * current history element.
+     * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
+     * is emitted. Tries to save the view-state.

      */
      */

-    void saveContentsPos(int x, int y);
+    void slotUrlNavigatorLocationAboutToBeChanged(const QUrl &url);

 
     /**
 
     /**

-     * Restores the contents position of the view, if the view
-     * is part of the history.
+     * Restores the current view to show \a url and assures
+     * that the root URL of the view is respected.

      */
      */

-    void restoreContentsPos();
+    void slotUrlNavigatorLocationChanged(const QUrl &url);

 
     /**
 
     /**

-     * Marks the view container as active
-     * (see DolphinViewContainer::setActive()).
+     * @see KUrlNavigator::urlSelectionRequested

      */
      */

-    void activate();
+    void slotUrlSelectionRequested(const QUrl &url);

 
     /**
 
     /**

-     * Restores the current view to show \a url and assures
-     * that the root URL of the view is respected.
+     * 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 restoreView(const KUrl& url);
+    void redirect(const QUrl &oldUrl, const QUrl &newUrl);
+
+    /** Requests the focus for the view \a m_view. */
+    void requestFocus();
+
+    /**
+     * Stops the loading of a directory. Is connected with the "stopPressed" signal
+     * from the statusbar.
+     */
+    void stopDirectoryLoading();
+
+    void slotStatusBarZoomLevelChanged(int zoomLevel);

 
     /**
 
     /**

-     * Saves the root URL of the current URL \a url
-     * into the URL navigator.
+     * Creates and shows an error message based on \p message and \p kioErrorCode.

      */
      */

-    void saveRootUrl(const KUrl& url);
-    
+    void slotErrorMessageFromView(const QString &message, const int kioErrorCode);
+

     /**
     /**

-     * Is connected with the URL navigator and drops the URLs
-     * above the destination \a destination.
+     * Slot that calls showMessage(message, KMessageWidget::Error).

      */
      */

-    void dropUrls(const KUrl& destination, QDropEvent* event);
+    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:
     /**

-     * Returns the default text of the status bar, if no item is
-     * selected.
+     * Saves the state of the current view: contents position,
+     * root URL, ...

      */
      */

-    QString defaultStatusBarText() const;
+    void saveViewState();

 
     /**
 
     /**

-     * Returns the text for the status bar, if at least one item
-     * is selected.
+     * Restores the state of the current view iff the URL navigator contains a
+     * non-empty location state.

      */
      */

-    QString selectionStatusBarText() const;
+    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:

-    bool m_showProgress;
+    QGridLayout *m_topLayout;

 
 

-    DolphinMainWindow* m_mainWindow;
-    QVBoxLayout* m_topLayout;
-    KUrlNavigator* m_urlNavigator;
+    /**
+     * 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;

 
 

-    DolphinView* m_view;
+    /**
+     * 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;

 
 

-    FilterBar* m_filterBar;
-    DolphinStatusBar* m_statusBar;
+    Search::Bar *m_searchBar;
+    bool m_searchModeEnabled;

 
 

-    DolphinModel* m_dolphinModel;
-    DolphinDirLister* m_dirLister;
-    DolphinSortFilterProxyModel* m_proxyModel;
-};
+    /// 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;

 
 

-inline const DolphinStatusBar* DolphinViewContainer::statusBar() const
-{
-    return m_statusBar;
-}
+    KMessageWidget *m_messageWidget;

 
 

-inline DolphinStatusBar* DolphinViewContainer::statusBar()
-{
-    return m_statusBar;
-}
+    /// A bar shown at the top of the view to signify that selection mode is currently active.
+    SelectionMode::TopBar *m_selectionModeTopBar;

 
 

-inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const
-{
-    return m_urlNavigator;
-}
+    DolphinView *m_view;

 
 

-inline KUrlNavigator* DolphinViewContainer::urlNavigator()
-{
-    return m_urlNavigator;
-}
+    FilterBar *m_filterBar;

 
 

-inline const DolphinView* DolphinViewContainer::view() const
-{
-    return m_view;
-}
+    /// A bar shown at the bottom of the view whose contents depend on what the user is currently doing.
+    SelectionMode::BottomBar *m_selectionModeBottomBar;

 
 

-inline DolphinView* DolphinViewContainer::view()
-{
-    return m_view;
-}
+    DolphinStatusBar *m_statusBar;
+    QTimer *m_statusBarTimer; // Triggers a delayed update
+    QElapsedTimer m_statusBarTimestamp; // Time in ms since last update
+    bool m_grabFocusOnUrlChange;
+    /**
+     * 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