src/panels/panel.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Cvetoslav Ludmiloff <ludmiloff@gmail.com>       *
   3  *   Copyright (C) 2006-2010 by Peter Penz <peter.penz@gmx.at>             *
   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 <KUrl>
  26 #include <KFileItem>
  27
  28 /**
  29  * @brief Base widget for all panels that can be docked on the window borders.
  30  *
  31  * Derived panels should provide a context menu that at least offers the
  32  * actions from Panel::customContextMenuActions().
  33  */
  34 class Panel : public QWidget
  35 {
  36     Q_OBJECT
  37
  38 public:
  39     explicit Panel(QWidget* parent = 0);
  40     virtual ~Panel();
  41
  42     /** Returns the current set URL of the active Dolphin view. */
  43     KUrl url() const;
  44
  45     /**
  46      * Sets custom context menu actions that are added to the panel specific
  47      * context menu actions. Allows an application to apply custom actions to
  48      * the panel.
  49      */
  50     void setCustomContextMenuActions(const QList<QAction*>& actions);
  51     QList<QAction*> customContextMenuActions() const;
  52
  53     /** @see QWidget::sizeHint() */
  54     virtual QSize sizeHint() const;
  55
  56 public slots:
  57     /**
  58      * This is invoked every time the folder being displayed in the
  59      * active Dolphin view changes.
  60      */
  61     void setUrl(const KUrl& url);
  62
  63 protected:
  64     /**
  65      * Must be implemented by derived classes and is invoked when
  66      * the URL has been changed (see Panel::setUrl()).
  67      * @return True, if the new URL will get accepted by the derived
  68      *         class. If false is returned,
  69      *         the URL will be reset to the previous URL.
  70      */
  71     virtual bool urlChanged() = 0;
  72
  73 private:
  74     KUrl m_url;
  75     QList<QAction*> m_customContextMenuActions;
  76 };
  77
  78 #endif // PANEL_H