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