git.maemo.org Git - situare/blob - src/ui/tabbedpanel.h

   1 /*
   2     Situare - A location system for Facebook
   3     Copyright (C) 2010  Ixonos Plc. Authors:
   4
   5         Kaj Wallin - kaj.wallin@ixonos.com
   6         Pekka Nissinen - pekka.nissinen@ixonos.com
   7
   8     Situare is free software; you can redistribute it and/or
   9     modify it under the terms of the GNU General Public License
  10     version 2 as published by the Free Software Foundation.
  11
  12     Situare is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with Situare; if not, write to the Free Software
  19     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
  20     USA.
  21 */
  22
  23 #ifndef TABBEDPANEL_H
  24 #define TABBEDPANEL_H
  25
  26 #include <QWidget>
  27
  28 #include "panelcommon.h"
  29
  30 class QPropertyAnimation;
  31 class QSignalTransition;
  32 class QStackedWidget;
  33 class QState;
  34 class QStateMachine;
  35
  36 class PanelBar;
  37 class PanelContent;
  38 class PanelTabBar;
  39
  40 /**
  41  * @brief Class for tabbed panels
  42  *
  43  * @author Kaj Wallin - kaj.wallin (at) ixonos.com
  44  * @author Pekka Nissinen - pekka.nissinen@ixonos.com
  45  */
  46 class TabbedPanel : public QWidget
  47 {
  48     Q_OBJECT
  49
  50 public:
  51     /**
  52      * @brief Constructor
  53      *
  54      * @param parent Parent
  55      */
  56     TabbedPanel(QWidget *parent = 0);
  57
  58 /*******************************************************************************
  59  * MEMBER FUNCTIONS AND SLOTS
  60  ******************************************************************************/
  61 public:
  62     /**
  63      * @brief Adds a tab to the panel
  64      *
  65      * Adds a tab with the given widget and icon into the tabbed panel and returns the index of the
  66      * inserted tab.
  67      *
  68      * @param widget Widget to be added into the tab
  69      * @param icon Icon of the tab
  70      */
  71     int addTab(QWidget *widget, const QIcon& icon);
  72
  73     /**
  74      * @brief Inserts a tab to the panel
  75      *
  76      * Inserts a tab with the given widget and icon into the tabbed panel at the specified index,
  77      * and returns the index of the inserted tab.
  78      *
  79      * If index is out of range, the tab is simply appended. Otherwise it is inserted at the
  80      * specified position.
  81      *
  82      * @param index Index of the tab
  83      * @param widget Widget to be inserted into the tab
  84      * @param icon Icon of the tab
  85      */
  86     int insertTab(int index, QWidget *widget, const QIcon& icon);
  87
  88     /**
  89      * @brief Removes a tab from the panel
  90      *
  91      * Removes a tab and its widget from the panel at index position. The widget itself is not
  92      * deleted.
  93      *
  94      * @param index Index of the tab
  95      */
  96     void removeTab(int index);
  97
  98 public slots:
  99     /**
 100      * @brief Public slot that will close the panel unless already closed
 101      */
 102     void closePanel();
 103
 104     /**
 105      * @brief Public slot that will open the panel unless already open
 106      */
 107     void openPanel();
 108
 109     /**
 110      * @brief Slot to redraw the panel after window resize event
 111      *
 112      * @param size Size of the new window
 113      */
 114     void resizePanel(const QSize &size);
 115
 116     /**
 117      * @brief Shows the tab at given index active
 118      *
 119      * @param index Index of the tab
 120      */
 121     void showTab(int index);
 122
 123 private slots:
 124     /**
 125      * @brief Internal slot used to track statemachine state
 126      */
 127     void stateChanged();
 128
 129 /*******************************************************************************
 130  * SIGNALS
 131  ******************************************************************************/
 132 signals:
 133     /**
 134      * @brief This signal is emitted whenever the current page index changes
 135      */
 136     void currentChanged(int index);
 137
 138     /**
 139      * @brief Signal that is sent when panel is closed
 140      *
 141      * @sa openPanel
 142      * @sa closePanel
 143      */
 144     void panelClosed();
 145
 146     /**
 147      * @brief Signal that is sent when panel is opened
 148      *
 149      * @sa openPanel
 150      * @sa closePanel
 151      */
 152     void panelOpened();
 153
 154     /**
 155      * @brief Signal that is sent to state machine when panel state must be changed
 156      *
 157      * @sa openPanel
 158      * @sa closePanel
 159      */
 160     void toggleState();
 161
 162 /*******************************************************************************
 163  * DATA MEMBERS
 164  ******************************************************************************/
 165 private:
 166     bool m_isOpen;      ///< Boolean used to track the current state of the statemachine
 167
 168     QPropertyAnimation *m_panelAnimation;       ///< Animation for panel state changes
 169
 170     QSignalTransition *m_panelTransitionClose;  ///< Transition signal for closing the panel
 171     QSignalTransition *m_panelTransitionOpen;   ///< Transition signal for opening the panel
 172
 173     QStackedWidget *m_panelWidgetStack;         ///< Stack for panel widgets
 174
 175     QState *m_panelStateClosed;                 ///< State of the closed panel
 176     QState *m_panelStateOpened;                 ///< State of the opened panel
 177
 178     QStateMachine *m_panelStateMachine;         ///< State machine for sliding the panel
 179
 180     PanelBar *m_panelBar;                       ///< Widget for panel bar
 181     PanelContent *m_panelContent;               ///< Widget for panel content
 182     PanelTabBar *m_panelTabBar;                 ///< Widget for panel tab bar
 183 };
 184
 185 #endif // TABBEDPANEL_H