ground/openpilotgcs/src/plugins/coreplugin/rightpane.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       rightpane.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  *             Parts by Nokia Corporation (qt-info@nokia.com) Copyright (C) 2009.
   7  * @addtogroup GCSPlugins GCS Plugins
   8  * @{
   9  * @addtogroup CorePlugin Core Plugin
  10  * @{
  11  * @brief The Core GCS plugin
  12  *****************************************************************************/
  13 /*
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful, but
  20  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  21  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  22  * for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License along
  25  * with this program; if not, write to the Free Software Foundation, Inc.,
  26  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  */
  28
  29 #ifndef RIGHTPANE_H
  30 #define RIGHTPANE_H
  31
  32 #include "core_global.h"
  33
  34 #include <QWidget>
  35
  36 QT_BEGIN_NAMESPACE
  37 class QSettings;
  38 QT_END_NAMESPACE
  39
  40 namespace Core {
  41 class IMode;
  42 class RightPaneWidget;
  43
  44 // TODO: The right pane works only for the help plugin atm.  It can't cope
  45 // with more than one plugin publishing objects they want in the right pane
  46 // For that the API would need to be different. (Might be that instead of
  47 // adding objects to the pool, there should be a method
  48 // RightPaneWidget::setWidget(QWidget *w) Anyway if a second plugin wants to
  49 // show something there, redesign this API
  50
  51 class CORE_EXPORT RightPanePlaceHolder : public QWidget {
  52     friend class Core::RightPaneWidget;
  53     Q_OBJECT
  54
  55 public:
  56     RightPanePlaceHolder(Core::IMode *mode, QWidget *parent = 0);
  57     ~RightPanePlaceHolder();
  58     static RightPanePlaceHolder *current();
  59
  60 private slots:
  61     void currentModeChanged(Core::IMode *);
  62
  63 private:
  64     void applyStoredSize(int width);
  65     Core::IMode *m_mode;
  66     static RightPanePlaceHolder *m_current;
  67 };
  68
  69
  70 class CORE_EXPORT BaseRightPaneWidget : public QObject {
  71     Q_OBJECT
  72
  73 public:
  74     BaseRightPaneWidget(QWidget *widget);
  75     ~BaseRightPaneWidget();
  76     QWidget *widget() const;
  77
  78 private:
  79     QWidget *m_widget;
  80 };
  81
  82
  83 class CORE_EXPORT RightPaneWidget : public QWidget {
  84     Q_OBJECT
  85
  86 public:
  87     RightPaneWidget();
  88     ~RightPaneWidget();
  89
  90     void saveSettings(QSettings *settings);
  91     void readSettings(QSettings *settings);
  92
  93     bool isShown();
  94     void setShown(bool b);
  95
  96     static RightPaneWidget *instance();
  97
  98     int storedWidth();
  99
 100 protected:
 101     void resizeEvent(QResizeEvent *);
 102
 103 private slots:
 104     void objectAdded(QObject *obj);
 105     void aboutToRemoveObject(QObject *obj);
 106
 107 private:
 108     bool m_shown;
 109     int m_width;
 110     static RightPaneWidget *m_instance;
 111 };
 112 } // namespace Core
 113
 114 #endif // RIGHTPANE_H