src/dolphinviewcontainer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHINVIEWCONTAINER_H
  21 #define DOLPHINVIEWCONTAINER_H
  22
  23 #include "config-dolphin.h"
  24 #include "views/dolphinview.h"
  25
  26 #include <KCompletion>
  27 #include <KFileItem>
  28 #include <KIO/Job>
  29 #include <KUrlNavigator>
  30
  31 #include <QElapsedTimer>
  32 #include <QPushButton>
  33 #include <QWidget>
  34
  35 #ifdef KF5Activities_FOUND
  36 namespace KActivities {
  37     class ResourceInstance;
  38 }
  39 #endif
  40
  41 class FilterBar;
  42 class KMessageWidget;
  43 class QUrl;
  44 class KUrlNavigator;
  45 class DolphinSearchBox;
  46 class DolphinStatusBar;
  47
  48 /**
  49  * @short Represents a view for the directory content
  50  *        including the navigation bar, filter bar and status bar.
  51  *
  52  * View modes for icons, compact and details are supported. Currently
  53  * Dolphin allows to have up to two views inside the main window.
  54  *
  55  * @see DolphinView
  56  * @see FilterBar
  57  * @see KUrlNavigator
  58  * @see DolphinStatusBar
  59  */
  60 class DolphinViewContainer : public QWidget
  61 {
  62     Q_OBJECT
  63
  64 public:
  65     enum MessageType
  66     {
  67         Information,
  68         Warning,
  69         Error
  70     };
  71
  72     DolphinViewContainer(const QUrl& url, QWidget* parent);
  73     ~DolphinViewContainer() override;
  74
  75     /**
  76      * Returns the current active URL, where all actions are applied.
  77      * The URL navigator is synchronized with this URL.
  78      */
  79     QUrl url() const;
  80
  81     /**
  82      * If \a active is true, the view container will marked as active. The active
  83      * view container is defined as view where all actions are applied to.
  84      */
  85     void setActive(bool active);
  86     bool isActive() const;
  87
  88     /**
  89      * If \a grab is set to true, the container automatically grabs the focus
  90      * as soon as the URL has been changed. Per default the grabbing
  91      * of the focus is enabled.
  92      */
  93     void setAutoGrabFocus(bool grab);
  94     bool autoGrabFocus() const;
  95
  96     QString currentSearchText() const;
  97
  98     const DolphinStatusBar* statusBar() const;
  99     DolphinStatusBar* statusBar();
 100
 101     const KUrlNavigator* urlNavigator() const;
 102     KUrlNavigator* urlNavigator();
 103
 104     const DolphinView* view() const;
 105     DolphinView* view();
 106
 107     /**
 108      * Shows the message \msg with the given type non-modal above
 109      * the view-content.
 110      */
 111     void showMessage(const QString& msg, MessageType type);
 112
 113     /**
 114      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
 115      */
 116     void readSettings();
 117
 118     /** Returns true, if the filter bar is visible. */
 119     bool isFilterBarVisible() const;
 120
 121     /**
 122      * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
 123      * will be hidden and replaced by a line editor that allows to enter a search term.
 124      */
 125     void setSearchModeEnabled(bool enabled);
 126     bool isSearchModeEnabled() const;
 127
 128     /**
 129      * @return Text that should be used for the current URL when creating
 130      *         a new place.
 131      */
 132     QString placesText() const;
 133
 134     /**
 135      * Reload the view of this container. This will also hide messages in a messagewidget.
 136      */
 137     void reload();
 138
 139 public slots:
 140     /**
 141      * Sets the current active URL, where all actions are applied. The
 142      * URL navigator is synchronized with this URL. The signals
 143      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 144      * are emitted.
 145      * @see DolphinViewContainer::urlNavigator()
 146      */
 147     void setUrl(const QUrl& url);
 148
 149     /**
 150      * Popups the filter bar above the status bar if \a visible is true.
 151      * It \a visible is true, it is assured that the filter bar gains
 152      * the keyboard focus.
 153      */
 154     void setFilterBarVisible(bool visible);
 155
 156 signals:
 157     /**
 158      * Is emitted whenever the filter bar has changed its visibility state.
 159      */
 160     void showFilterBarChanged(bool shown);
 161
 162     /**
 163      * Is emitted when the write state of the folder has been changed. The application
 164      * should disable all actions like "Create New..." that depend on the write
 165      * state.
 166      */
 167     void writeStateChanged(bool isFolderWritable);
 168
 169 private slots:
 170     /**
 171      * Updates the number of items (= number of files + number of
 172      * directories) in the statusbar. If files are selected, the number
 173      * of selected files and the sum of the filesize is shown. The update
 174      * is done asynchronously, as getting the sum of the
 175      * filesizes can be an expensive operation.
 176      * Unless a previous OperationCompletedMessage was set very shortly before
 177      * calling this method, it will be overwritten (see DolphinStatusBar::setMessage).
 178      * Previous ErrorMessages however are always preserved.
 179      */
 180     void delayedStatusBarUpdate();
 181
 182     /**
 183      * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and
 184      * updates the status bar synchronously.
 185      */
 186     void updateStatusBar();
 187
 188     void updateDirectoryLoadingProgress(int percent);
 189
 190     void updateDirectorySortingProgress(int percent);
 191
 192     /**
 193      * Updates the statusbar to show an undetermined progress with the correct
 194      * context information whether a searching or a directory loading is done.
 195      */
 196     void slotDirectoryLoadingStarted();
 197
 198     /**
 199      * Assures that the viewport position is restored and updates the
 200      * statusbar to reflect the current content.
 201      */
 202     void slotDirectoryLoadingCompleted();
 203
 204     /**
 205      * Updates the statusbar to show, that the directory loading has
 206      * been canceled.
 207      */
 208     void slotDirectoryLoadingCanceled();
 209
 210     /**
 211      * Is called if the URL set by DolphinView::setUrl() represents
 212      * a file and not a directory. Takes care to activate the file.
 213      */
 214     void slotUrlIsFileError(const QUrl& url);
 215
 216     /**
 217      * Handles clicking on an item. If the item is a directory, the
 218      * directory is opened in the view. If the item is a file, the file
 219      * gets started by the corresponding application.
 220      */
 221     void slotItemActivated(const KFileItem& item);
 222
 223     /**
 224      * Handles activation of multiple files. The files get started by
 225      * the corresponding applications.
 226      */
 227     void slotItemsActivated(const KFileItemList& items);
 228
 229     /**
 230      * Shows the information for the item \a item inside the statusbar. If the
 231      * item is null, the default statusbar information is shown.
 232      */
 233     void showItemInfo(const KFileItem& item);
 234
 235     void closeFilterBar();
 236
 237     /**
 238      * Filters the currently shown items by \a nameFilter. All items
 239      * which contain the given filter string will be shown.
 240      */
 241     void setNameFilter(const QString& nameFilter);
 242
 243     /**
 244      * Marks the view container as active
 245      * (see DolphinViewContainer::setActive()).
 246      */
 247     void activate();
 248
 249     /**
 250      * Is invoked if the signal urlAboutToBeChanged() from the URL navigator
 251      * is emitted. Tries to save the view-state.
 252      */
 253     void slotUrlNavigatorLocationAboutToBeChanged(const QUrl& url);
 254
 255     /**
 256      * Restores the current view to show \a url and assures
 257      * that the root URL of the view is respected.
 258      */
 259     void slotUrlNavigatorLocationChanged(const QUrl& url);
 260
 261     /**
 262      * @see KUrlNavigator::urlSelectionRequested
 263      */
 264     void slotUrlSelectionRequested(const QUrl& url);
 265
 266     /**
 267      * Is invoked when a redirection is done and changes the
 268      * URL of the URL navigator to \a newUrl without triggering
 269      * a reloading of the directory.
 270      */
 271     void redirect(const QUrl& oldUrl, const QUrl& newUrl);
 272
 273     /** Requests the focus for the view \a m_view. */
 274     void requestFocus();
 275
 276     /**
 277      * Saves the currently used URL completion mode of
 278      * the URL navigator.
 279      */
 280     void saveUrlCompletionMode(KCompletion::CompletionMode completion);
 281
 282     void slotReturnPressed();
 283
 284     /**
 285      * Gets the search URL from the searchbox and starts searching.
 286      */
 287     void startSearching();
 288     void closeSearchBox();
 289
 290     /**
 291      * Stops the loading of a directory. Is connected with the "stopPressed" signal
 292      * from the statusbar.
 293      */
 294     void stopDirectoryLoading();
 295
 296     void slotStatusBarZoomLevelChanged(int zoomLevel);
 297
 298     /**
 299      * Slot that calls showMessage(msg, Error).
 300      */
 301     void showErrorMessage(const QString& msg);
 302
 303 private:
 304     /**
 305      * @return True if the URL protocol is a search URL (e. g. baloosearch:// or filenamesearch://).
 306      */
 307     bool isSearchUrl(const QUrl& url) const;
 308
 309     /**
 310      * Saves the state of the current view: contents position,
 311      * root URL, ...
 312      */
 313     void saveViewState();
 314
 315     /**
 316      * Restores the state of the current view iff the URL navigator contains a
 317      * non-empty location state.
 318      */
 319     void tryRestoreViewState();
 320
 321 private:
 322     QVBoxLayout* m_topLayout;
 323     QWidget* m_navigatorWidget;
 324     KUrlNavigator* m_urlNavigator;
 325     QPushButton* m_emptyTrashButton;
 326     DolphinSearchBox* m_searchBox;
 327     KMessageWidget* m_messageWidget;
 328
 329     DolphinView* m_view;
 330
 331     FilterBar* m_filterBar;
 332
 333     DolphinStatusBar* m_statusBar;
 334     QTimer* m_statusBarTimer;            // Triggers a delayed update
 335     QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
 336     bool m_autoGrabFocus;
 337
 338 #ifdef KF5Activities_FOUND
 339 private:
 340     KActivities::ResourceInstance * m_activityResourceInstance;
 341 #endif
 342 };
 343
 344 #endif // DOLPHINVIEWCONTAINER_H