lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.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 buttonGroup.h
  28  * @brief This contains the ButtonGroup class.
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef BUTTONGROUP_H
  34 #define BUTTONGROUP_H
  35
  36 //Library Definition
  37 #include <wx/stattext.h>
  38
  39 #include <map>
  40 #include <list>
  41 #include <exception>
  42
  43 #include "button.h"
  44
  45 /*!     @namespace <creaButtonContainer>
  46  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  47  */
  48 namespace creaButtonContainer
  49 {
  50         /*! @namespace <creaButtonContainer::view>
  51          *      @brief Contains the implementation of the view in creaButtonContainer library.
  52          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  53          */
  54         namespace view
  55         {
  56                 /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
  57                  *      @brief This class contains the group of buttons.
  58                  */
  59                 class ButtonGroup
  60                 {
  61                         public:
  62                                 //Typedef definition
  63                                 // ----------------------------------------------------------------------------------
  64                                 /*!     @typedef creaButtonContainer::view::Button Button;
  65                                  *      @brief Defines the Button type.
  66                                  */
  67                                 typedef creaButtonContainer::view::Button Button;
  68                                 // ----------------------------------------------------------------------------------
  69                                 /*!     @typedef std::map< long, Button* > ButtonContainer;
  70                                  *      @brief Defines the ButtonContainer type.
  71                                  */
  72                                 typedef std::map< long, Button* > ButtonContainer;
  73                                 // ----------------------------------------------------------------------------------
  74                                 /*!     typedef std::list< long > IdButtonContainer;
  75                                  *      @brief Defines the IdButtonContainer type.
  76                                  */
  77                                 typedef std::list< long > IdButtonContainer;
  78                         public:
  79                                 // ----------------------------------------------------------------------------------
  80                                 /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
  81                                  *      @brief This is the parameterized constructor.
  82                                  * @param groupName wxStatigText* with the name of the group.
  83                                  * @param buttons A container with buttons.
  84                                  */
  85                                 ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
  86                                 // ----------------------------------------------------------------------------------
  87                                 /*! @fn ~ButtonGroup( );
  88                                  * @brief This is the destructor.
  89                                  */
  90                                 virtual
  91                                 ~ButtonGroup( );
  92                                 // ----------------------------------------------------------------------------------
  93                                 /*! @fn GetButton( long id );
  94                                  * @brief This method returns a Button*
  95                                  * @param id The ID of the button.
  96                                  * @return Button*
  97                                  */
  98                                 Button*
  99                                 GetButton( long id );
 100                                 // ----------------------------------------------------------------------------------
 101                                 /*! @fn GetButtonContainer( );
 102                                  * @brief This method returns the button container.
 103                                  * @exception std::bad_alloc
 104                                  * @return ButtonContainer.
 105                                  */
 106                                 ButtonContainer
 107                                 GetButtonContainer( );
 108                                 // ----------------------------------------------------------------------------------
 109                                 /*! @fn GetButtonIdContainer( );
 110                                  * @brief This method returns a list of button IDs.
 111                                  * @exception std::bad_alloc
 112                                  * @return
 113                                  */
 114                                 IdButtonContainer
 115                                 GetButtonIdContainer( );
 116                                 // ----------------------------------------------------------------------------------
 117                                 /*! @fn GetGroupName( );
 118                                  * @brief This method returns the name of the group.
 119                                  * @return
 120                                  */
 121                                 wxStaticText*
 122                                 GetGroupName( );
 123                                 // ----------------------------------------------------------------------------------
 124                         private:
 125                                 wxStaticText* m_GroupName; //!<A pointer with the wxStaticText of name of the group.
 126                                 ButtonContainer m_Buttons; //!<A container with buttons.
 127                 };
 128         }//ecapseman
 129 }//ecapseman
 130
 131 #endif // BUTTONGROUP_H