vcs.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     ///< @todo define "out of range"
  74     /**
  75      * @brief Inserts a tab to the panel
  76      *
  77      * Inserts a tab with the given widget and icon into the tabbed panel at the specified index,
  78      * and returns the index of the inserted tab.
  79      *
  80      * If index is out of range, the tab is simply appended. Otherwise it is inserted at the
  81      * specified position.
  82      *
  83      * @param index Index of the tab
  84      * @param widget Widget to be inserted into the tab
  85      * @param icon Icon of the tab
  86      */
  87     int insertTab(int index, QWidget *widget, const QIcon& icon);
  88
  89     /**
  90      * @brief Removes a tab from the panel
  91      *
  92      * Removes a tab and its widget from the panel at index position. The widget itself is not
  93      * deleted.
  94      *
  95      * @param index Index of the tab
  96      */
  97     void removeTab(int index);
  98
  99 public slots:
 100     /**
 101      * @brief Public slot that will close the panel unless already closed
 102      */
 103     void closePanel();
 104
 105     /**
 106      * @brief Public slot that will open the panel unless already open
 107      */
 108     void openPanel();
 109
 110     /**
 111      * @brief Slot to redraw the panel after window resize event
 112      *
 113      * @param size Size of the new window
 114      */
 115     void resizePanel(const QSize &size);
 116
 117     /**
 118      * @brief Shows the tab at given index active
 119      *
 120      * @param index Index of the tab
 121      */
 122     void showTab(int index);
 123
 124 private slots:
 125     /**
 126      * @brief Internal slot used to track statemachine state
 127      */
 128     void stateChanged();
 129
 130 /*******************************************************************************
 131  * SIGNALS
 132  ******************************************************************************/
 133 signals:
 134     /**
 135      * @brief This signal is emitted whenever the current page index changes
 136      */
 137     void currentChanged(int index);
 138
 139     /**
 140      * @brief Signal that is sent when panel is closed
 141      *
 142      * @sa openPanel
 143      * @sa closePanel
 144      */
 145     void panelClosed();
 146
 147     /**
 148      * @brief Signal that is sent when panel is opened
 149      *
 150      * @sa openPanel
 151      * @sa closePanel
 152      */
 153     void panelOpened();
 154
 155     /**
 156      * @brief Signal that is sent to state machine when panel state must be changed
 157      *
 158      * @sa openPanel
 159      * @sa closePanel
 160      */
 161     void toggleState();
 162
 163 /*******************************************************************************
 164  * DATA MEMBERS
 165  ******************************************************************************/
 166 private:
 167     bool m_isOpen;      ///< Boolean used to track the current state of the statemachine
 168
 169     QPropertyAnimation *m_panelAnimation;       ///< Animation for panel state changes
 170
 171     QSignalTransition *m_panelTransitionClose;  ///< Transition signal for closing the panel
 172     QSignalTransition *m_panelTransitionOpen;   ///< Transition signal for opening the panel
 173
 174     QStackedWidget *m_panelWidgetStack;         ///< Stack for panel widgets
 175
 176     QState *m_panelStateClosed;                 ///< State of the closed panel
 177     QState *m_panelStateOpened;                 ///< State of the opened panel
 178
 179     QStateMachine *m_panelStateMachine;         ///< State machine for sliding the panel
 180
 181     PanelBar *m_panelBar;                       ///< Widget for panel bar
 182     PanelContent *m_panelContent;               ///< Widget for panel content
 183     PanelTabBar *m_panelTabBar;                 ///< Widget for panel tab bar
 184 };
 185
 186 #endif // TABBEDPANEL_H