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 #include "listWx.h"
  47 #include "listGroup.h"
  48
  49 /*!     @namespace <creaButtonContainer>
  50  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  51  */
  52 namespace creaButtonContainer
  53 {
  54         /*! @namespace <creaButtonContainer::view>
  55          *      @brief Contains the implementation of the view in creaButtonContainer library.
  56          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  57          */
  58         namespace view
  59         {
  60                 /*! @class ButtonManager buttonManager.h "buttonManager.h"
  61                  *      @brief This class contains the ButtonManager view.
  62                  *  @details This class describes a wxFlexGridSizer with the button manager.
  63                  *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
  64                  */
  65                 class ButtonManager : public wxFlexGridSizer
  66                 {
  67                         public:
  68                                 //typedef definition.
  69                                 // ----------------------------------------------------------------------------------
  70                                 /*!     @typedef creaButtonContainer::view::Button Button;
  71                                  *      @brief Defines the Button type.
  72                                  */
  73                                 typedef creaButtonContainer::view::Button Button;
  74                                 // ----------------------------------------------------------------------------------
  75                                 /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  76                                  *      @brief Defines the ButtonGroup type.
  77                                  */
  78                                 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  79                                 // ----------------------------------------------------------------------------------
  80                                 /*!     @typedef std::map< long, Button* > ButtonContainer;
  81                                  *      @brief Defines the ButtonContainer type.
  82                                  */
  83                                 typedef std::map< long, Button* > ButtonContainer;
  84                                 // ----------------------------------------------------------------------------------
  85                                 //MLER
  86                                 typedef creaButtonContainer::view::ListGroup ListGroup;
  87                                 typedef std::map<long, ListWx* > ListContainer;
  88
  89                                 //end of typedef definition.
  90                         public:
  91                                 // ----------------------------------------------------------------------------------
  92                                 /*! @fn ButtonManager( );
  93                                  * @brief This is the default constructor.
  94                                  * @exception std::bad_alloc
  95                                  */
  96                                 ButtonManager( );
  97                                 // ----------------------------------------------------------------------------------
  98                                 /*! @fn ButtonManager( ButtonGroup* buttonGroup );
  99                                  * @brief This is the parameterized constructor
 100                                  * @param buttonGroup The group of buttons.
 101                                  */
 102                                 ButtonManager( ButtonGroup* buttonGroup );
 103                                 // ----------------------------------------------------------------------------------
 104                                 //MLER
 105                                 ButtonManager (ListGroup* buttonGroup);
 106                                 // ----------------------------------------------------------------------------------
 107
 108                                 /*! @fn ~ButtonManager( );
 109                                  * @brief This is the destructor.
 110                                  */
 111                                 virtual
 112                                 ~ButtonManager( );
 113                                 // ----------------------------------------------------------------------------------
 114                                 /*! @fn SetGroupName( wxStaticText* groupName );
 115                                  * @details Sets the groupName.
 116                                  * @param groupName
 117                                  */
 118                                 void
 119                                 SetGroupName( wxStaticText* groupName );
 120                                 // ----------------------------------------------------------------------------------
 121                                 /*! @fn ShowButtonManager( );
 122                                  * @brief This method shows the ButtonManager
 123                                  */
 124
 125                                 void
 126                                 ShowButtonManager( );
 127                                 // ----------------------------------------------------------------------------------
 128                                 /*! @fn HideButtonManager( );
 129                                  * @brief This method hides the ButtonManager.
 130                                  * @exception std::bad_alloc
 131                                  */
 132                                 void
 133                                 HideButtonManager( );
 134                                 // ----------------------------------------------------------------------------------
 135                         private:
 136                                 // ----------------------------------------------------------------------------------
 137                                 /*! @fn SetButtonManager( ButtonContainer buttonContainer );
 138                                  * @brief This method set the buttons and it is private.
 139                                  * @param buttonContainer
 140                                  */
 141                                 void
 142                                 SetButtonManager( ButtonContainer buttonContainer );
 143                                 // ----------------------------------------------------------------------------------
 144                                 //MLER
 145                                 void
 146                                 SetListManager( ListContainer buttonContainer );
 147                                 // ----------------------------------------------------------------------------------
 148
 149
 150                         private:
 151                                 wxStaticText* m_GroupName; //!<The name of the group.
 152                                 wxGridSizer* m_GridSizer; //!<The sizer that contains the buttons.
 153                 };
 154         }//ecapseman
 155 }//ecapseman
 156
 157 #endif // CARTOBUTTONCONTAINER_H