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