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

   1 /*!
   2  * @file buttonManager.h
   3  * @brief This contains the ButtonManager class.
   4  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
   5  * @date  2011-05-19
   6  */
   7
   8 #ifndef CARTOBUTTONCONTAINER_H
   9 #define CARTOBUTTONCONTAINER_H
  10
  11 #include <wx/sizer.h>
  12 #include <wx/bmpbuttn.h>
  13 #include <wx/stattext.h>
  14 #include <wx/string.h>
  15 #include <map>
  16 #include "button.h"
  17 #include "buttonGroup.h"
  18
  19 /*!     @namespace <creaButtonContainer>
  20  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  21  */
  22 namespace creaButtonContainer
  23 {
  24         /*! @namespace <creaButtonContainer::view>
  25          *      @brief Contains the implementation of the view in creaButtonContainer library.
  26          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  27          */
  28         namespace view
  29         {
  30                 /*! @class ButtonManager buttonManager.h "buttonManager.h"
  31                  *      @brief This class contains the ButtonManager view.
  32                  *  @details This class describes a wxFlexGridSizer with the button manager, it derives from wxFlexGridSizer and it is the
  33                  *  controller in the MVC.
  34                  *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
  35                  */
  36                 class ButtonManager : public wxFlexGridSizer
  37                 {
  38                         public:
  39                                 //typedef definition.
  40                                 /*!     @typedef creaButtonContainer::view::Button Button;
  41                                  *      @brief Defines the Button type.
  42                                  */
  43                                 typedef creaButtonContainer::view::Button Button;
  44                                 // ----------------------------------------------------------------------------------
  45                                 /*!     @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  46                                  *      @brief Defines the ButtonGroup type.
  47                                  */
  48                                 typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
  49                                 // ----------------------------------------------------------------------------------
  50                                 /*!     @typedef std::map< long, Button* > ButtonContainer;
  51                                  *      @brief Defines the ButtonContainer type.
  52                                  */
  53                                 typedef std::map< long, Button* > ButtonContainer;
  54                                 // ----------------------------------------------------------------------------------
  55                                 //end of typedef definition.
  56                         public:
  57                                 // ----------------------------------------------------------------------------------
  58                                 /*! @fn ButtonManager( );
  59                                  * @brief This is the default construuctor.
  60                                  */
  61                                 ButtonManager( );
  62                                 // ----------------------------------------------------------------------------------
  63                                 /*! @fn ButtonManager( ButtonGroup* buttonGroup );
  64                                  * @brief This is the parameterized constructor
  65                                  * @param buttonGroup The group of buttons.
  66                                  */
  67                                 ButtonManager( ButtonGroup* buttonGroup );
  68                                 // ----------------------------------------------------------------------------------
  69                                 /*! @fn ~ButtonManager( );
  70                                  * @brief This is the destructor.
  71                                  */
  72                                 virtual
  73                                 ~ButtonManager( );
  74                                 // ----------------------------------------------------------------------------------
  75                                 /*! @fn SetGroupName( wxStaticText* groupName );
  76                                  * @details Sets the groupName.
  77                                  * @param groupName
  78                                  */
  79                                 void
  80                                 SetGroupName( wxStaticText* groupName );
  81                                 // ----------------------------------------------------------------------------------
  82                                 /*! @fn ShowButtonManager( );
  83                                  * @brief This function shows the ButtonManager
  84                                  */
  85                                 void
  86                                 ShowButtonManager( );
  87                                 // ----------------------------------------------------------------------------------
  88                                 /*! @fn HideButtonManager( );
  89                                  * @brief This function hides the ButtonManager.
  90                                  */
  91                                 void
  92                                 HideButtonManager( );
  93                                 // ----------------------------------------------------------------------------------
  94                         private:
  95                                 // ----------------------------------------------------------------------------------
  96                                 /*! @fn SetButtonManager( ButtonContainer buttonContainer );
  97                                  * @brief This function set the buttons and it is private.
  98                                  * @param buttonContainer
  99                                  */
 100                                 void
 101                                 SetButtonManager( ButtonContainer buttonContainer );
 102                                 // ----------------------------------------------------------------------------------
 103                         private:
 104                                 wxStaticText* m_GroupName; //!<The name of the group.
 105                                 wxGridSizer* m_GridSizer; //!<The sizer that contains the buttons.
 106                 };
 107         }//ecapseman
 108 }//ecapseman
 109
 110 #endif // CARTOBUTTONCONTAINER_H