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