src/dolphincontroller.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 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 DOLPHINCONTROLLER_H
  21 #define DOLPHINCONTROLLER_H
  22
  23 #include <dolphinview.h>
  24 #include <kurl.h>
  25 #include <QObject>
  26
  27 class KUrl;
  28 class QModelIndex;
  29 class QPoint;
  30
  31 /**
  32  * @brief Allows to control Dolphin views and to react on state changes.
  33  *
  34  * One instance of a DolphinController can be assigned to a variable number of
  35  * Dolphin views (DolphinIconsView, DolphinDetailsView) by passing it in
  36  * the constructor:
  37  *
  38  * \code
  39  * DolphinController* controller = new DolphinController(parent);
  40  * DolphinDetailsView* detailsView = new DolphinDetailsView(parent, controller);
  41  * DolphinIconsView* iconsView = new DolphinIconsView(parent, controller);
  42  * \endcode
  43  *
  44  * The Dolphin view assures that the controller gets informed about selection changes,
  45  * when an item should be triggered and a lot more. The controller emits the corresponding signals
  46  * so that the receiver may react on those changes.
  47  */
  48 class DolphinController : public QObject
  49 {
  50     Q_OBJECT
  51
  52 public:
  53     explicit DolphinController(QObject* parent);
  54     virtual ~DolphinController();
  55
  56     void setUrl(const KUrl& url) { m_url = url; }
  57     const KUrl& url() const { return m_url; }
  58
  59     void triggerContextMenuRequest(const QPoint& pos);
  60
  61     void triggerActivation();
  62
  63     void indicateDroppedUrls(const KUrl::List& urls,
  64                              const QPoint& pos);
  65
  66     void indicateSortingChange(DolphinView::Sorting sorting);
  67
  68     void indicateSortOrderChange(Qt::SortOrder order);
  69
  70 public slots:
  71     void triggerItem(const QModelIndex& index);
  72     void indicateSelectionChange();
  73
  74 signals:
  75     /**
  76      * Is emitted if a context menu should be opened.
  77      * @param pos       Position relative to the view widget where the
  78      *                  context menu should be opened. It is recommended
  79      *                  to get the corresponding model index from
  80      *                  this position.
  81      */
  82     void requestContextMenu(const QPoint& pos);
  83
  84     /**
  85      * Is emitted if the view has been activated by e. g. a mouse click.
  86      */
  87     void activated();
  88
  89     /**
  90      * Is emitted if the URLs \a urls have been dropped.
  91      * @param pos Position relative to the view widget where the
  92      *            dropping has been done. It is recommended
  93      *            to get the corresponding model index from
  94      *            this position to find out the destination.
  95      */
  96     void urlsDropped(const KUrl::List& urls,
  97                      const QPoint& pos);
  98
  99     /** Is emitted if the sorting has been changed to \a sorting. */
 100     void sortingChanged(DolphinView::Sorting sorting);
 101
 102     /** Is emitted if the sort order has been changed to \a sort order. */
 103     void sortOrderChanged(Qt::SortOrder order);
 104
 105     /**
 106      * Is emitted if the item with the index \a index should be triggered.
 107      * Usually triggering on a directory opens the directory, triggering
 108      * on a file opens the corresponding application.
 109      */
 110     void itemTriggered(const QModelIndex& index);
 111
 112     /** Is emitted if the selection has been changed by the user. */
 113     void selectionChanged();
 114
 115 private:
 116     KUrl m_url;
 117 };
 118
 119 #endif