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
  21 #ifndef DOLPHINVIEWCONTAINER_H
  22 #define DOLPHINVIEWCONTAINER_H
  23
  24 #include "dolphinview.h"
  25
  26 #include <kfileitem.h>
  27 #include <kfileitemdelegate.h>
  28 #include <kio/job.h>
  29
  30 #include <kurlnavigator.h>
  31
  32 #include <QtGui/QKeyEvent>
  33 #include <QtCore/QLinkedList>
  34 #include <QtGui/QListView>
  35 #include <QtGui/QBoxLayout>
  36 #include <QtGui/QWidget>
  37
  38 class FilterBar;
  39 class KUrl;
  40 class DolphinModel;
  41 class KUrlNavigator;
  42 class DolphinDirLister;
  43 class DolphinMainWindow;
  44 class DolphinSortFilterProxyModel;
  45 class DolphinStatusBar;
  46 class QModelIndex;
  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, details and columns 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     DolphinViewContainer(DolphinMainWindow* mainwindow,
  66                          QWidget *parent,
  67                          const KUrl& url);
  68
  69     virtual ~DolphinViewContainer();
  70
  71     /**
  72      * Sets the current active URL, where all actions are applied. The
  73      * URL navigator is synchronized with this URL. The signals
  74      * KUrlNavigator::urlChanged() and KUrlNavigator::historyChanged()
  75      * are emitted.
  76      * @see DolphinViewContainer::urlNavigator()
  77      */
  78     void setUrl(const KUrl& url);
  79
  80     /**
  81      * Returns the current active URL, where all actions are applied.
  82      * The URL navigator is synchronized with this URL.
  83      */
  84     const KUrl& url() const;
  85
  86     /**
  87      * If \a active is true, the view container will marked as active. The active
  88      * view container is defined as view where all actions are applied to.
  89      */
  90     void setActive(bool active);
  91     bool isActive() const;
  92
  93     KFileItem fileItem(const QModelIndex& index) const;
  94
  95     const DolphinStatusBar* statusBar() const;
  96     DolphinStatusBar* statusBar();
  97
  98     /**
  99      * Returns true, if the URL shown by the navigation bar is editable.
 100      * @see KUrlNavigator
 101      */
 102     bool isUrlEditable() const;
 103
 104     const KUrlNavigator* urlNavigator() const;
 105     KUrlNavigator* urlNavigator();
 106
 107     const DolphinView* view() const;
 108     DolphinView* view();
 109
 110     /** Returns true, if the filter bar is visible. */
 111     bool isFilterBarVisible() const;
 112
 113     /**
 114      * Return the DolphinMainWindow this View belongs to. It is guaranteed
 115      * that we have one.
 116      */
 117     const DolphinMainWindow* mainWindow() const;
 118
 119 public slots:
 120     /**
 121      * Popups the filter bar above the status bar if \a show is true.
 122      */
 123     void showFilterBar(bool show);
 124
 125     /**
 126      * Updates the number of items (= number of files + number of
 127      * directories) in the statusbar. If files are selected, the number
 128      * of selected files and the sum of the filesize is shown.
 129      */
 130     void updateStatusBar();
 131
 132 signals:
 133     /**
 134      * Is emitted whenever the filter bar has changed its visibility state.
 135      */
 136     void showFilterBarChanged(bool shown);
 137
 138 private slots:
 139     void updateProgress(int percent);
 140
 141     /**
 142      * Assures that the viewport position is restored and updates the
 143      * statusbar to reflect the current content.
 144      */
 145     void slotDirListerCompleted();
 146
 147     /**
 148      * Handles clicking on an item
 149      */
 150     void slotItemTriggered(const KFileItem& item);
 151
 152     /**
 153      * Shows the information for the item \a item inside the statusbar. If the
 154      * item is null, the default statusbar information is shown.
 155      */
 156     void showItemInfo(const KFileItem& item);
 157
 158     /** Shows the information \a msg inside the statusbar. */
 159     void showInfoMessage(const QString& msg);
 160
 161     /** Shows the error message \a msg inside the statusbar. */
 162     void showErrorMessage(const QString& msg);
 163
 164     /** Shows the "operation completed" message \a msg inside the statusbar. */
 165     void showOperationCompletedMessage(const QString& msg);
 166
 167     void closeFilterBar();
 168
 169     /**
 170      * Filters the currently shown items by \a nameFilter. All items
 171      * which contain the given filter string will be shown.
 172      */
 173     void setNameFilter(const QString& nameFilter);
 174
 175     /**
 176      * Opens the context menu on the current mouse position.
 177      * @item  File item context. If item is 0, the context menu
 178      *        should be applied to \a url.
 179      * @url   URL which contains \a item.
 180      */
 181     void openContextMenu(const KFileItem& item, const KUrl& url);
 182
 183     /**
 184      * Saves the position of the contents to the
 185      * current history element.
 186      */
 187     void saveContentsPos(int x, int y);
 188
 189     /**
 190      * Restores the contents position of the view, if the view
 191      * is part of the history.
 192      */
 193     void restoreContentsPos();
 194
 195     /**
 196      * Marks the view container as active
 197      * (see DolphinViewContainer::setActive()).
 198      */
 199     void activate();
 200
 201     /**
 202      * Restores the current view to show \a url and assures
 203      * that the root URL of the view is respected.
 204      */
 205     void restoreView(const KUrl& url);
 206
 207     /**
 208      * Saves the root URL of the current URL \a url
 209      * into the URL navigator.
 210      */
 211     void saveRootUrl(const KUrl& url);
 212
 213 private:
 214     /**
 215      * Returns the default text of the status bar, if no item is
 216      * selected.
 217      */
 218     QString defaultStatusBarText() const;
 219
 220     /**
 221      * Returns the text for the status bar, if at least one item
 222      * is selected.
 223      */
 224     QString selectionStatusBarText() const;
 225
 226 private:
 227     bool m_showProgress;
 228
 229     DolphinMainWindow* m_mainWindow;
 230     QVBoxLayout* m_topLayout;
 231     KUrlNavigator* m_urlNavigator;
 232
 233     DolphinView* m_view;
 234
 235     FilterBar* m_filterBar;
 236     DolphinStatusBar* m_statusBar;
 237
 238     DolphinModel* m_dolphinModel;
 239     DolphinDirLister* m_dirLister;
 240     DolphinSortFilterProxyModel* m_proxyModel;
 241 };
 242
 243 inline const DolphinStatusBar* DolphinViewContainer::statusBar() const
 244 {
 245     return m_statusBar;
 246 }
 247
 248 inline DolphinStatusBar* DolphinViewContainer::statusBar()
 249 {
 250     return m_statusBar;
 251 }
 252
 253 inline const KUrlNavigator* DolphinViewContainer::urlNavigator() const
 254 {
 255     return m_urlNavigator;
 256 }
 257
 258 inline KUrlNavigator* DolphinViewContainer::urlNavigator()
 259 {
 260     return m_urlNavigator;
 261 }
 262
 263 inline const DolphinView* DolphinViewContainer::view() const
 264 {
 265     return m_view;
 266 }
 267
 268 inline DolphinView* DolphinViewContainer::view()
 269 {
 270     return m_view;
 271 }
 272
 273 inline const DolphinMainWindow* DolphinViewContainer::mainWindow() const
 274 {
 275     return m_mainWindow;
 276 }
 277
 278 #endif // DOLPHINVIEWCONTAINER_H