src/dolphinviewcontainer.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Peter Penz <peter.penz@gmx.at>                  *
   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
  35 class FilterBar;
  36 class KUrl;
  37 class KUrlNavigator;
  38 class DolphinSearchBox;
  39 class DolphinStatusBar;
  40
  41 /**
  42  * @short Represents a view for the directory content
  43  *        including the navigation bar, filter bar and status bar.
  44  *
  45  * View modes for icons, details and columns are supported. Currently
  46  * Dolphin allows to have up to two views inside the main window.
  47  *
  48  * @see DolphinView
  49  * @see FilterBar
  50  * @see KUrlNavigator
  51  * @see DolphinStatusBar
  52  */
  53 class DolphinViewContainer : public QWidget
  54 {
  55     Q_OBJECT
  56
  57 public:
  58     DolphinViewContainer(const KUrl& url, QWidget* parent);
  59     virtual ~DolphinViewContainer();
  60
  61     /**
  62      * Returns the current active URL, where all actions are applied.
  63      * The URL navigator is synchronized with this URL.
  64      */
  65     KUrl 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     const DolphinStatusBar* statusBar() const;
  75     DolphinStatusBar* statusBar();
  76
  77     const KUrlNavigator* urlNavigator() const;
  78     KUrlNavigator* urlNavigator();
  79
  80     const DolphinView* view() const;
  81     DolphinView* view();
  82
  83     /**
  84      * Refreshes the view container to get synchronized with the (updated) Dolphin settings.
  85      */
  86     void refresh();
  87
  88     /** Returns true, if the filter bar is visible. */
  89     bool isFilterBarVisible() const;
  90
  91     /**
  92      * Enables the search mode, if \p enabled is true. In the search mode the URL navigator
  93      * will be hidden and replaced by a line editor that allows to enter a search term.
  94      */
  95     void setSearchModeEnabled(bool enabled);
  96     bool isSearchModeEnabled() const;
  97
  98 public slots:
  99     /**
 100      * Sets the current active URL, where all actions are applied. The
 101      * URL navigator is synchronized with this URL. The signals
 102      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
 103      * are emitted.
 104      * @see DolphinViewContainer::urlNavigator()
 105      */
 106     void setUrl(const KUrl& url);
 107
 108     /**
 109      * Popups the filter bar above the status bar if \a visible is true.
 110      * It \a visible is true, it is assured that the filter bar gains
 111      * the keyboard focus.
 112      */
 113     void setFilterBarVisible(bool visible);
 114
 115 signals:
 116     /**
 117      * Is emitted whenever the filter bar has changed its visibility state.
 118      */
 119     void showFilterBarChanged(bool shown);
 120
 121     /**
 122      * Is emitted when the write state of the folder has been changed. The application
 123      * should disable all actions like "Create New..." that depend on the write
 124      * state.
 125      */
 126     void writeStateChanged(bool isFolderWritable);
 127
 128     /**
 129      * Is emitted if the search mode has been enabled or disabled.
 130      * (see DolphinViewContainer::setSearchModeEnabled() and
 131      * DolphinViewContainer::isSearchModeEnabled())
 132      */
 133     void searchModeChanged(bool enabled);
 134
 135 private slots:
 136     /**
 137      * Updates the number of items (= number of files + number of
 138      * directories) in the statusbar. If files are selected, the number
 139      * of selected files and the sum of the filesize is shown. The update
 140      * is done asynchronously, as getting the sum of the
 141      * filesizes can be an expensive operation.
 142      */
 143     void delayedStatusBarUpdate();
 144
 145     /**
 146      * Is invoked by DolphinViewContainer::delayedStatusBarUpdate() and
 147      * updates the status bar synchronously.
 148      */
 149     void updateStatusBar();
 150
 151     void updateProgress(int percent);
 152
 153     /**
 154      * Updates the statusbar to show an undetermined progress with the correct
 155      * context information whether a searching or a directory loading is done.
 156      */
 157     void slotStartedPathLoading();
 158
 159     /**
 160      * Assures that the viewport position is restored and updates the
 161      * statusbar to reflect the current content.
 162      */
 163     void slotFinishedPathLoading();
 164
 165     /**
 166      * Handles clicking on an item. If the item is a directory, the
 167      * directory is opened in the view. If the item is a file, the file
 168      * gets started by the corresponding application.
 169      */
 170     void slotItemTriggered(const KFileItem& item);
 171
 172     /**
 173      * Opens a the file \a url by opening the corresponding application.
 174      * Is connected with the signal urlIsFile() from DolphinDirLister and will
 175      * get invoked if the user manually has entered a file into the URL navigator.
 176      */
 177     void openFile(const KUrl& url);
 178
 179     /**
 180      * Shows the information for the item \a item inside the statusbar. If the
 181      * item is null, the default statusbar information is shown.
 182      */
 183     void showItemInfo(const KFileItem& item);
 184
 185     /** Shows the information \a msg inside the statusbar. */
 186     void showInfoMessage(const QString& msg);
 187
 188     /** Shows the error message \a msg inside the statusbar. */
 189     void showErrorMessage(const QString& msg);
 190
 191     /** Shows the "operation completed" message \a msg inside the statusbar. */
 192     void showOperationCompletedMessage(const QString& msg);
 193
 194     void closeFilterBar();
 195
 196     /**
 197      * Filters the currently shown items by \a nameFilter. All items
 198      * which contain the given filter string will be shown.
 199      */
 200     void setNameFilter(const QString& nameFilter);
 201
 202     /**
 203      * Marks the view container as active
 204      * (see DolphinViewContainer::setActive()).
 205      */
 206     void activate();
 207
 208     /**
 209      * Saves the state of the current view: contents position,
 210      * root URL, ...
 211      */
 212     void saveViewState();
 213
 214     /**
 215      * Restores the current view to show \a url and assures
 216      * that the root URL of the view is respected.
 217      */
 218     void slotUrlNavigatorLocationChanged(const KUrl& url);
 219
 220     /**
 221      * Is connected with the URL navigator and drops the URLs
 222      * above the destination \a destination.
 223      */
 224     void dropUrls(const KUrl& destination, QDropEvent* event);
 225
 226     /**
 227      * Is invoked when a redirection is done and changes the
 228      * URL of the URL navigator to \a newUrl without triggering
 229      * a reloading of the directory.
 230      */
 231     void redirect(const KUrl& oldUrl, const KUrl& newUrl);
 232
 233     /** Requests the focus for the view \a m_view. */
 234     void requestFocus();
 235
 236     /**
 237      * Saves the currently used URL completion mode of
 238      * the URL navigator.
 239      */
 240     void saveUrlCompletionMode(KGlobalSettings::Completion completion);
 241
 242     void slotHistoryChanged();
 243
 244     /**
 245      * Gets the search URL from the searchbox and starts searching.
 246      * @param text Text the user has entered into the searchbox.
 247      */
 248     void startSearching(const QString& text);
 249     void closeSearchBox();
 250
 251     /**
 252      * Stops the loading of a directory. Is connected with the "stopPressed" signal
 253      * from the statusbar.
 254      */
 255     void stopLoading();
 256
 257 private:
 258     /**
 259      * @return True if the URL protocol is a search URL (e. g. nepomuksearch:// or filenamesearch://).
 260      */
 261     bool isSearchUrl(const KUrl& url) const;
 262
 263 private:
 264     QVBoxLayout* m_topLayout;
 265     KUrlNavigator* m_urlNavigator;
 266     DolphinSearchBox* m_searchBox;
 267
 268     DolphinView* m_view;
 269
 270     FilterBar* m_filterBar;
 271
 272     DolphinStatusBar* m_statusBar;
 273     QTimer* m_statusBarTimer;            // Triggers a delayed update
 274     QElapsedTimer m_statusBarTimestamp;  // Time in ms since last update
 275 };
 276
 277 inline const DolphinStatusBar* DolphinViewContainer::statusBar() const
 278 {
 279     return m_statusBar;
 280 }
 281
 282 inline DolphinStatusBar* DolphinViewContainer::statusBar()
 283 {
 284     return m_statusBar;
 285 }
 286
 287 inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const
 288 {
 289     return m_urlNavigator;
 290 }
 291
 292 inline KUrlNavigator* DolphinViewContainer::urlNavigator()
 293 {
 294     return m_urlNavigator;
 295 }
 296
 297 inline const DolphinView* DolphinViewContainer::view() const
 298 {
 299     return m_view;
 300 }
 301
 302 inline DolphinView* DolphinViewContainer::view()
 303 {
 304     return m_view;
 305 }
 306
 307 #endif // DOLPHINVIEWCONTAINER_H