lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonManager.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 buttonManager.h
  28  * @brief This contains the ButtonManager class.
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef CARTOBUTTONCONTAINER_H
  34 #define CARTOBUTTONCONTAINER_H
  35
  36 #include <wx/sizer.h>
  37 #include <wx/bmpbuttn.h>
  38 #include <wx/stattext.h>
  39 #include <wx/string.h>
  40
  41 #include <map>
  42 #include <exception>
  43
  44 #include "button.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 ButtonManager buttonManager.h "buttonManager.h"
  59                  *      @brief This class contains the ButtonManager view.
  60                  *  @details This class describes a wxFlexGridSizer with the button manager.
  61                  *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
  62                  */
  63                 class ButtonManager: public wxFlexGridSizer
  64                 {
  65                         public:
  66                                 //typedef definition.
  67                                 // ----------------------------------------------------------------------------------
  68                                 /*!     @typedef creaButtonContainer::view::Button Button;
  69                                  *      @brief Defines the Button type.
  70                                  */
  71                                 typedef creaButtonContainer::view::Button Button;
  72                                 // ----------------------------------------------------------------------------------
  73                                 /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  74                                  *      @brief Defines the ButtonGroup type.
  75                                  */
  76                                 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  77                                 // ----------------------------------------------------------------------------------
  78                                 /*!     @typedef std::map< long, Button* > ButtonContainer;
  79                                  *      @brief Defines the ButtonContainer type.
  80                                  */
  81                                 typedef std::map<long, Button*> ButtonContainer;
  82                                 // ----------------------------------------------------------------------------------
  83
  84                                 //end of typedef definition.
  85                         public:
  86                                 // ----------------------------------------------------------------------------------
  87                                 /*! @fn ButtonManager( );
  88                                  * @brief This is the default constructor.
  89                                  * @exception std::bad_alloc
  90                                  */
  91                                 ButtonManager();
  92                                 // ----------------------------------------------------------------------------------
  93                                 /*! @fn ButtonManager( ButtonGroup* buttonGroup );
  94                                  * @brief This is the parameterized constructor
  95                                  * @param buttonGroup The group of buttons.
  96                                  */
  97                                 ButtonManager(ButtonGroup* buttonGroup);
  98
  99                                 // ----------------------------------------------------------------------------------
 100
 101                                 /*! @fn ~ButtonManager( );
 102                                  * @brief This is the destructor.
 103                                  */
 104                                 virtual
 105                                 ~ButtonManager();
 106                                 // ----------------------------------------------------------------------------------
 107                                 /*! @fn SetGroupName( wxStaticText* groupName );
 108                                  * @details Sets the groupName.
 109                                  * @param groupName
 110                                  */
 111                                 void
 112                                 SetGroupName(wxStaticText* groupName);
 113                                 // ----------------------------------------------------------------------------------
 114                                 /*! @fn ShowButtonManager( );
 115                                  * @brief This method shows the ButtonManager
 116                                  */
 117
 118                                 void
 119                                 ShowButtonManager();
 120                                 // ----------------------------------------------------------------------------------
 121                                 /*! @fn HideButtonManager( );
 122                                  * @brief This method hides the ButtonManager.
 123                                  * @exception std::bad_alloc
 124                                  */
 125                                 void
 126                                 HideButtonManager();
 127                                 // ----------------------------------------------------------------------------------
 128                         private:
 129                                 // ----------------------------------------------------------------------------------
 130                                 /*! @fn SetButtonManager( ButtonContainer buttonContainer );
 131                                  * @brief This method set the buttons and it is private.
 132                                  * @param buttonContainer
 133                                  */
 134                                 void
 135                                 SetButtonManager(ButtonContainer buttonContainer);
 136                                 // ----------------------------------------------------------------------------------
 137
 138                         private:
 139                                 wxStaticText* m_GroupName; //!<The name of the group.
 140                                 wxGridSizer* m_GridSizer; //!<The sizer that contains the buttons.
 141                 };
 142         } //ecapseman
 143 } //ecapseman
 144
 145 #endif // CARTOBUTTONCONTAINER_H