src/dolphinviewcontainer.h

   1 /*
   2  * SPDX-FileCopyrightText: 2007 Peter Penz <peter.penz19@gmail.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-or-later
   5  */
   6
   7 #ifndef DOLPHINVIEWCONTAINER_H
   8 #define DOLPHINVIEWCONTAINER_H
   9
  10 #include "config-kactivities.h"
  11 #include "dolphinurlnavigator.h"
  12 #include "views/dolphinview.h"
  13
  14 #include <KFileItem>
  15 #include <KIO/Job>
  16 #include <KUrlNavigator>
  17
  18 #include <QElapsedTimer>
  19 #include <QPushButton>
  20 #include <QWidget>
  21
  22 #ifdef HAVE_KACTIVITIES
  23 namespace KActivities {
  24     class ResourceInstance;
  25 }
  26 #endif
  27
  28 class FilterBar;
  29 class KMessageWidget;
  30 class QUrl;
  31 class DolphinSearchBox;
  32 class DolphinStatusBar;
  33
  34 /**
  35  * @short Represents a view for the directory content
  36  *        including the navigation bar, filter bar and status bar.
  37  *
  38  * View modes for icons, compact and details are supported. Currently
  39  * Dolphin allows to have up to two views inside the main window.
  40  *
  41  * @see DolphinView
  42  * @see FilterBar
  43  * @see KUrlNavigator
  44  * @see DolphinStatusBar
  45  */
  46 class DolphinViewContainer : public QWidget
  47 {
  48     Q_OBJECT
  49
  50 public:
  51     enum MessageType
  52     {
  53         Information,
  54         Warning,
  55         Error
  56     };
  57
  58     DolphinViewContainer(const QUrl& url, QWidget* parent);
  59     ~DolphinViewContainer() override;
  60
  61     /**
  62      * Returns the current active URL, where all actions are applied.
  63      * The URL navigator is synchronized with this URL.
  64      */
  65     QUrl url() const;
  66
  67     /**
  68      * If \a active is true, the view container will marked as active. The active
  69      * view container is defined as view where all actions are applied to.
  70      */
  71     void setActive(bool active);
  72     bool isActive() const;
  73
  74     /**
  75      * If \a grab is set to true, the container automatically grabs the focus
  76      * as soon as the URL has been changed. Per default the grabbing
  77      * of the focus is enabled.
  78      */
  79     void setAutoGrabFocus(bool grab);
  80     bool autoGrabFocus() const;
  81
  82     QString currentSearchText() const;
  83
  84     const DolphinStatusBar* statusBar() const;
  85     DolphinStatusBar* statusBar();
  86
  87     /**
  88      * @return  An UrlNavigator that is controlling this view
  89      *          or nullptr if there is none.
  90      * @see connectUrlNavigator()
  91      * @see disconnectUrlNavigator()
  92      *
  93      * Use urlNavigatorInternalWithHistory() if you want to access the history.
  94      * @see urlNavigatorInternalWithHistory()
  95      */
  96     const DolphinUrlNavigator *urlNavigator() const;
  97     /**
  98      * @return  An UrlNavigator that is controlling this view
  99      *          or nullptr if there is none.
 100      * @see connectUrlNavigator()
 101      * @see disconnectUrlNavigator()
 102      *
 103      * Use urlNavigatorInternalWithHistory() if you want to access the history.
 104      * @see urlNavigatorInternalWithHistory()
 105      */
 106     DolphinUrlNavigator *urlNavigator();
 107
 108     /**
 109      * @return An UrlNavigator that contains this view's history.
 110      * Use urlNavigator() instead when not accessing the history.
 111      */
 112     const DolphinUrlNavigator *urlNavigatorInternalWithHistory() const;
 113     /**
 114      * @return An UrlNavigator that contains this view's history.
 115      * Use urlNavigator() instead when not accessing the history.
 116      */
 117     DolphinUrlNavigator *urlNavigatorInternalWithHistory();
 118
 119     const DolphinView* view() const;
 120     DolphinView* view();
 121
 122     /**
 123      * @param urlNavigator  The UrlNavigator that is supposed to control
 124      *                      this view.
 125      */
 126     void connectUrlNavigator(DolphinUrlNavigator *urlNavigator);
 127
 128     /**
 129      * Disconnects the navigator that is currently controling the view.
 130      * This method completely reverses connectUrlNavigator().
 131      */
 132     void disconnectUrlNavigator();
 133
 134     /**
 135      * Shows the message \msg with the given type non-modal above
 136      * the view-content.
 137      */
 138     void showMessage(const QString& msg, MessageType type);
 139
 140     /**
 141      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
 142      */
 143     void readSettings();
 144
 145     /** Returns true, if the filter bar is visible. */
 146     bool isFilterBarVisible() const;
 147
 148
 149     /** Returns true if the search mode is enabled. */
 150     bool isSearchModeEnabled() const;
 151
 152     /**
 153      * @return Text that should be used for the current URL when creating
 154      *         a new place.
 155      */
 156     QString placesText() const;
 157
 158     /**
 159      * Reload the view of this container. This will also hide messages in a messagewidget.
 160      */
 161     void reload();
 162
 163     /**
 164      * @return Returns a Caption suitable for display in the window title.
 165      * It is calculated depending on GeneralSettings::showFullPathInTitlebar().
 166      * If it's false, it calls caption().
 167      */
 168     QString captionWindowTitle() const;
 169
 170     /**
 171      * @return Returns a Caption suitable for display to the user. It is
 172      * calculated depending on settings, if a search is active and other
 173      * factors.
 174      */
 175     QString caption() const;
 176
 177 public Q_SLOTS:
 178     /**
 179      * Sets the current active URL, where all actions are applied. The
 180      * URL navigator is synchronized with this URL. The signals
 181      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 182      * are emitted.
 183      * @see DolphinViewContainer::urlNavigator()
 184      */
 185     void setUrl(const QUrl& url);
 186
 187     /**
 188      * Popups the filter bar above the status bar if \a visible is true.
 189      * It \a visible is true, it is assured that the filter bar gains
 190      * the keyboard focus.
 191      */
 192     void setFilterBarVisible(bool visible);
 193
 194     /**
 195      * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
 196      * will be hidden and replaced by a line editor that allows to enter a search term.
 197      */
 198     void setSearchModeEnabled(bool enabled);
 199
 200 Q_SIGNALS:
 201     /**
 202      * Is emitted whenever the filter bar has changed its visibility state.
 203      */
 204     void showFilterBarChanged(bool shown);
 205     /**
 206      * Is emitted whenever the search mode has changed its state.
 207      */
 208     void searchModeEnabledChanged(bool enabled);
 209
 210     /**
 211      * Is emitted when the write state of the folder has been changed. The application
 212      * should disable all actions like "Create New..." that depend on the write
 213      * state.
 214      */
 215     void writeStateChanged(bool isFolderWritable);
 216
 217 private Q_SLOTS:
 218     /**
 219      * Updates the number of items (= number of files + number of
 220      * directories) in the statusbar. If files are selected, the number
 221      * of selected files and the sum of the filesize is shown. The update
 222      * is done asynchronously, as getting the sum of the
 223      * filesizes can be an expensive operation.
 224      * Unless a previous OperationCompletedMessage was set very shortly before
 225      * calling this method, it will be overwritten (see DolphinStatusBar::setMessage).
 226      * Previous ErrorMessages however are always preserved.
 227      */
 228     void delayedStatusBarUpdate();
 229
 230     /**
 231      * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and
 232      * updates the status bar synchronously.
 233      */
 234     void updateStatusBar();
 235
 236     void updateDirectoryLoadingProgress(int percent);
 237
 238     void updateDirectorySortingProgress(int percent);
 239
 240     /**
 241      * Updates the statusbar to show an undetermined progress with the correct
 242      * context information whether a searching or a directory loading is done.
 243      */
 244     void slotDirectoryLoadingStarted();
 245
 246     /**
 247      * Assures that the viewport position is restored and updates the
 248      * statusbar to reflect the current content.
 249      */
 250     void slotDirectoryLoadingCompleted();
 251
 252     /**
 253      * Updates the statusbar to show, that the directory loading has
 254      * been canceled.
 255      */
 256     void slotDirectoryLoadingCanceled();
 257
 258     /**
 259      * Is called if the URL set by DolphinView::setUrl() represents
 260      * a file and not a directory. Takes care to activate the file.
 261      */
 262     void slotUrlIsFileError(const QUrl& url);
 263
 264     /**
 265      * Handles clicking on an item. If the item is a directory, the
 266      * directory is opened in the view. If the item is a file, the file
 267      * gets started by the corresponding application.
 268      */
 269     void slotItemActivated(const KFileItem& item);
 270
 271     /**
 272      * Handles activation of multiple files. The files get started by
 273      * the corresponding applications.
 274      */
 275     void slotItemsActivated(const KFileItemList& items);
 276
 277     /**
 278      * Shows the information for the item \a item inside the statusbar. If the
 279      * item is null, the default statusbar information is shown.
 280      */
 281     void showItemInfo(const KFileItem& item);
 282
 283     void closeFilterBar();
 284
 285     /**
 286      * Filters the currently shown items by \a nameFilter. All items
 287      * which contain the given filter string will be shown.
 288      */
 289     void setNameFilter(const QString& nameFilter);
 290
 291     /**
 292      * Marks the view container as active
 293      * (see DolphinViewContainer::setActive()).
 294      */
 295     void activate();
 296
 297     /**
 298      * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
 299      * is emitted. Tries to save the view-state.
 300      */
 301     void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);
 302
 303     /**
 304      * Restores the current view to show \a url and assures
 305      * that the root URL of the view is respected.
 306      */
 307     void slotUrlNavigatorLocationChanged(const QUrl& url);
 308
 309     /**
 310      * @see KUrlNavigator::urlSelectionRequested
 311      */
 312     void slotUrlSelectionRequested(const QUrl& url);
 313
 314     /**
 315      * Is invoked when a redirection is done and changes the
 316      * URL of the URL navigator to \a newUrl without triggering
 317      * a reloading of the directory.
 318      */
 319     void redirect(const QUrl& oldUrl, const QUrl& newUrl);
 320
 321     /** Requests the focus for the view \a m_view. */
 322     void requestFocus();
 323
 324     /**
 325      * Gets the search URL from the searchbox and starts searching.
 326      */
 327     void startSearching();
 328     void closeSearchBox();
 329
 330     /**
 331      * Stops the loading of a directory. Is connected with the "stopPressed" signal
 332      * from the statusbar.
 333      */
 334     void stopDirectoryLoading();
 335
 336     void slotStatusBarZoomLevelChanged(int zoomLevel);
 337
 338     /**
 339      * Slot that calls showMessage(msg, Error).
 340      */
 341     void showErrorMessage(const QString& msg);
 342
 343 private:
 344     /**
 345      * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
 346      */
 347     bool isSearchUrl(const QUrl& url) const;
 348
 349     /**
 350      * Saves the state of the current view: contents position,
 351      * root URL, ...
 352      */
 353     void saveViewState();
 354
 355     /**
 356      * Restores the state of the current view iff the URL navigator contains a
 357      * non-empty location state.
 358      */
 359     void tryRestoreViewState();
 360
 361 private:
 362     QVBoxLayout* m_topLayout;
 363
 364     /**
 365      * The internal UrlNavigator which is never visible to the user.
 366      * m_urlNavigator is used even when another UrlNavigator is controlling
 367      * the view to keep track of this object's history.
 368      */
 369     std::unique_ptr<DolphinUrlNavigator> m_urlNavigator;
 370
 371     /**
 372      * The UrlNavigator that is currently connected to the view.
 373      * This is a nullptr if no UrlNavigator is connected.
 374      * Otherwise it's one of the UrlNavigators visible in the toolbar.
 375      */
 376     QPointer<DolphinUrlNavigator> m_urlNavigatorConnected;
 377     DolphinSearchBox* m_searchBox;
 378     bool m_searchModeEnabled;
 379     KMessageWidget* m_messageWidget;
 380
 381     DolphinView* m_view;
 382
 383     FilterBar* m_filterBar;
 384
 385     DolphinStatusBar* m_statusBar;
 386     QTimer* m_statusBarTimer;            // Triggers a delayed update
 387     QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
 388     bool m_autoGrabFocus;
 389     /**
 390      * The visual state to be applied to the next UrlNavigator that gets
 391      * connected to this ViewContainer.
 392      */
 393     std::unique_ptr<DolphinUrlNavigator::VisualState> m_urlNavigatorVisualState;
 394
 395 #ifdef HAVE_KACTIVITIES
 396 private:
 397     KActivities::ResourceInstance * m_activityResourceInstance;
 398 #endif
 399 };
 400
 401 #endif // DOLPHINVIEWCONTAINER_H