src/panels/panel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
   3  *   Copyright (C) 2006-2010 by Peter Penz <peter.penz19@gmail.com>        *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  19  ***************************************************************************/
  20
  21 #ifndef PANEL_H
  22 #define PANEL_H
  23
  24 #include <QWidget>
  25 #include <QUrl>
  26
  27 /**
  28  * @brief Base widget for all panels that can be docked on the window borders.
  29  *
  30  * Derived panels should provide a context menu that at least offers the
  31  * actions from Panel::customContextMenuActions().
  32  */
  33 class Panel : public QWidget
  34 {
  35     Q_OBJECT
  36
  37 public:
  38     explicit Panel(QWidget* parent = 0);
  39     ~Panel() override;
  40
  41     /** Returns the current set URL of the active Dolphin view. */
  42     QUrl url() const;
  43
  44     /**
  45      * Sets custom context menu actions that are added to the panel specific
  46      * context menu actions. Allows an application to apply custom actions to
  47      * the panel.
  48      */
  49     void setCustomContextMenuActions(const QList<QAction*>& actions);
  50     QList<QAction*> customContextMenuActions() const;
  51
  52     QSize sizeHint() const override;
  53
  54 public slots:
  55     /**
  56      * This is invoked every time the folder being displayed in the
  57      * active Dolphin view changes.
  58      */
  59     void setUrl(const QUrl &url);
  60
  61     /**
  62      * Refreshes the view to get synchronized with the settings.
  63      */
  64     virtual void readSettings();
  65
  66 protected:
  67     /**
  68      * Must be implemented by derived classes and is invoked when
  69      * the URL has been changed (see Panel::setUrl()).
  70      * @return True, if the new URL will get accepted by the derived
  71      *         class. If false is returned,
  72      *         the URL will be reset to the previous URL.
  73      */
  74     virtual bool urlChanged() = 0;
  75
  76 private:
  77     QUrl m_url;
  78     QList<QAction*> m_customContextMenuActions;
  79 };
  80
  81 #endif // PANEL_H