lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h

   1 /*# ---------------------------------------------------------------------
   2  #
   3  # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4  #                        pour la Sant�)
   5  # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6  # Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7  # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8  #
   9  #  This software is governed by the CeCILL-B license under French law and
  10  #  abiding by the rules of distribution of free software. You can  use,
  11  #  modify and/ or redistribute the software under the terms of the CeCILL-B
  12  #  license as circulated by CEA, CNRS and INRIA at the following URL
  13  #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14  #  or in the file LICENSE.txt.
  15  #
  16  #  As a counterpart to the access to the source code and  rights to copy,
  17  #  modify and redistribute granted by the license, users are provided only
  18  #  with a limited warranty  and the software's author,  the holder of the
  19  #  economic rights,  and the successive licensors  have only  limited
  20  #  liability.
  21  #
  22  #  The fact that you are presently reading this means that you have had
  23  #  knowledge of the CeCILL-B license and that you accept its terms.
  24  # ------------------------------------------------------------------------ */
  25
  26 /*!
  27  * @file groupManager.h
  28  * @brief This contains the GroupManager class
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef GROUPMANAGER_H
  34 #define GROUPMANAGER_H
  35
  36 #include <wx/sizer.h>
  37 #include <wx/button.h>
  38 #include <wx/stattext.h>
  39
  40 #include <list>
  41 #include <iostream>
  42 #include <exception>
  43
  44 #include "buttonManager.h"
  45 #include "buttonGroup.h"
  46
  47 /*!     @namespace <creaButtonContainer>
  48  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  49  */
  50 namespace creaButtonContainer
  51 {
  52         /*! @namespace <creaButtonContainer::view>
  53          *      @brief Contains the implementation of the view in creaButtonContainer library.
  54          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  55          */
  56         namespace view
  57         {
  58                 /*! @class GroupManager groupManager.h "groupManager.h"
  59                  *      @brief This class contains the GroupManager.
  60                  *  @details This class describes a wxFlexGridSizer with the group manager.
  61                  *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
  62                  */
  63                 class GroupManager: public wxFlexGridSizer
  64                 {
  65                         public:
  66                                 //typedef definition
  67                                 // ----------------------------------------------------------------------------------
  68                                 /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  69                                  *      @brief Defines the ButtonGroup type.
  70                                  */
  71                                 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  72                                 // ----------------------------------------------------------------------------------
  73                                 /*!     @typedef wxButton ExpansionButton;
  74                                  *      @brief Defines the ExpansionButton type.
  75                                  */
  76                                 typedef wxButton ExpansionButton;
  77                                 // ----------------------------------------------------------------------------------
  78
  79                                 //end of typedef definition.
  80                         public:
  81                                 // ----------------------------------------------------------------------------------
  82                                 /*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
  83                                  *      @brief This is the parameterized constructor.
  84                                  *      @param parent The wxWindow* parent
  85                                  *      @param buttonGroup The pointer to the ButtonGroup.
  86                                  */
  87                                 GroupManager(wxWindow* parent, ButtonGroup* buttonGroup);
  88                                 // ----------------------------------------------------------------------------------
  89                                 /*! @fn ~GroupManager( );
  90                                  *  @brief This is the destructor.
  91                                  */
  92                                 virtual
  93                                 ~GroupManager();
  94                                 // ----------------------------------------------------------------------------------
  95                                 /*! @fn GetButtonID( );
  96                                  *  @brief This method returns the Button ID.
  97                                  *  @return
  98                                  */
  99                                 long
 100                                 GetButtonID();
 101                                 // ----------------------------------------------------------------------------------
 102                                 /*! @fn GetButton( );
 103                                  *      @brief This method returns the expansion button.
 104                                  * @return
 105                                  */
 106                                 ExpansionButton*
 107                                 GetButton();
 108                                 // ----------------------------------------------------------------------------------
 109                                 /*! @fn GetButtonManager( );
 110                                  *      @brief This method returns the manager of the buttons.
 111                                  *      @return
 112                                  */
 113                                 ButtonManager*
 114                                 GetButtonManager();
 115                                 // ----------------------------------------------------------------------------------
 116                                 /*! @fn SetButtonID( long id );
 117                                  *      @brief This method sets the ID of the expansion button.
 118                                  * @param id
 119                                  */
 120                                 void
 121                                 SetButtonID(long id);
 122                                 // ----------------------------------------------------------------------------------
 123                                 /*! @fn SetButton( ExpansionButton* button );
 124                                  *      @brief This method sets the expansion button.
 125                                  * @param button
 126                                  */
 127                                 void
 128                                 SetButton(ExpansionButton* button);
 129                                 // ----------------------------------------------------------------------------------
 130                                 /*! @fn SetButtonManager( ButtonManager* manager );
 131                                  *      @brief This method Sets the ButtonManager
 132                                  * @param manager A pointer with the manager.
 133                                  */
 134                                 void
 135                                 SetButtonManager(ButtonManager* manager);
 136                                 // ----------------------------------------------------------------------------------
 137                                 /*! @fn HideSubPanel( bool hide );
 138                                  *      @brief This method hides the subPanel (Hides the buttons).
 139                                  * @param hide True if you need to hide the buttons.
 140                                  */
 141                                 void
 142                                 HideSubPanel(bool hide);
 143
 144                         private:
 145                                 long m_IDExpButton; //!<ID of "+""-" expansion button.
 146                                 ExpansionButton* m_ExpansionButton; //!<The expansion button.
 147                                 ButtonManager* m_ButtonManager; //!<The button manager.
 148
 149                 };
 150         } //ecapseman
 151 } //ecapseman
 152
 153 #endif // GROUPMANAGER_H