lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.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 PanelButtonContainer
  28  * @brief This contains the ButtonContainerSettings class.
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef PANELBUTTONCONTAINER_H_
  34 #define PANELBUTTONCONTAINER_H_
  35
  36 #include <wx/panel.h>
  37 #include <wx/aui/aui.h>
  38 #include <string>
  39 #include <wx/gdicmn.h>
  40 #include <wx/gbsizer.h>
  41 #include <wx/bmpbuttn.h>
  42
  43 #include "listConfigDialog.h"
  44 #include "containerSettings.h"
  45 #include "buttonContainerPanel.h"
  46 #include "buttonContainerSettings.h"
  47 #include "functor.h"
  48 #include "listWx.h"
  49
  50 /*!     @namespace <creaPanelButtonContainer>
  51  *      @brief Contains the creaPanelButtonContainer library included in creaMaracasVisu.
  52  */
  53 namespace creaPanelButtonContainer
  54 {
  55         /*! @class PanelButtonContainer panelButtonContainer.h "panelButtonContainer.h"
  56          *      @brief This class contains the PanelButtonContainer. It derives from wxPanel.
  57          *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxpanel.html">wxPanel</a>
  58          */
  59         class PanelButtonContainer: public wxPanel
  60         {
  61                 public:
  62                         //typedef definition.
  63                         // ----------------------------------------------------------------------------------
  64                         /*!     typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
  65                          *      @brief Defines the ButtonContainerSettings type.
  66                          */
  67                         typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
  68                         /*!     typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
  69                          *      @brief Defines the ButtonContainerPanel type.
  70                          */
  71                         typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
  72
  73                         //MLER
  74                         /*!     typedef creaButtonContainer::view::ListWx ListWx;
  75                          *      @brief Defines a ListWx for (Configurable) List Container.
  76                          *      This class inherits from wxPanel and contains a wxListBox.
  77                          */
  78                         typedef creaButtonContainer::view::ListWx ListWx;
  79                         /*!     typedef creaPanelButtonContainer::ListConfigDialog ListConfigDialog;
  80                          *      @brief Defines a ListConfigPanel to configure.
  81                          *      This class inherits from wxDialog and contains the wxListBox and wxButton.
  82                          */
  83                         typedef creaButtonContainer::view::ListConfigDialog ListConfigDialog;
  84                         // ----------------------------------------------------------------------------------
  85                         //End MLER
  86                 //end of typedef definition.
  87                 public:
  88                         // ----------------------------------------------------------------------------------
  89                         /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
  90                          *      @brief This is the parameterized constructor.
  91                          *      @param parent The wxWindow pointer to parent
  92                          *      @param bcSettings //The buttonContainerSettings
  93                          */
  94                         PanelButtonContainer(wxWindow* parent,
  95                                         ButtonContainerSettings* bcSettings, int type);
  96                         // ----------------------------------------------------------------------------------
  97                         /*! @fn virtual PanelButtonContainer( );
  98                          *      @brief This is the destructor.
  99                          */
 100                         virtual
 101                         ~PanelButtonContainer();
 102                         // ----------------------------------------------------------------------------------
 103                         /*! @fn void UpdatePanel( const std::string &buttonName );
 104                          *  @brief This method Updates the m_EventPanel to a panel
 105                          *  of the clicked button in creaButtonContainer.
 106                          *      @param buttonName
 107                          */
 108                         void
 109                         UpdatePanel(const std::string &buttonName);
 110                         // ----------------------------------------------------------------------------------
 111                         /*! @fn void GenericButtonEvent( const std::string &buttonName );
 112                          *      @brief This method is the function that calls the panels contained in the buttons.
 113                          *      (in creaButtonContainer is the function contained in the functors to be called back.
 114                          *      @param buttonName The name of the button
 115                          */
 116                         void
 117                         GenericButtonEvent(const std::string &buttonName);
 118                         // ----------------------------------------------------------------------------------
 119                         //MLER
 120                         /*! @fn void GenericListEvent( const std::string &buttonName );
 121                          *      @brief This method is the function that calls the panels contained in the items list.
 122                          *      (in creaButtonContainer is the function contained in the functors to be called back.
 123                          *      @param buttonName The name of the button (item list)
 124                          */
 125                         void
 126                         GenericListEvent(const std::string &buttonName);
 127                         // ----------------------------------------------------------------------------------
 128                         /*! @fn void UpdateListPanel( const std::string &buttonName );
 129                          *  @brief This method Updates the m_EventPanel to a panel
 130                          *  of the clicked an item in creaButtonContainer.
 131                          *      @param buttonName The name of the button (item list)
 132                          */
 133                         void
 134                         UpdateListPanel(const std::string &buttonName);
 135                         // ----------------------------------------------------------------------------------
 136                         /*! @fn void OnConfigButton( wxCommandEvent& event );
 137                          *  @brief This method calls the wxDialog when
 138                          *  the config button is clicked.
 139                          *      @param event
 140                          */
 141                         void
 142                         OnConfigButton(wxCommandEvent& event);
 143                         //End MLER
 144                         // ----------------------------------------------------------------------------------
 145                 private:
 146                         //Settings
 147                         ButtonContainerSettings* m_ButtonContainerSettings; //!<This is the buttonContainer settings.
 148
 149                         //Panel
 150                         ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with of buttons (creaButtonContainer)
 151                         wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
 152                         wxPanel* m_EventPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
 153
 154                         //MLER
 155                         ListWx* m_ListWxPanel;//!<This panel contains the list of the elements.
 156                         ListConfigDialog* m_ListConfigDialog;//!<This wxDialog shows the list of the elements and allows  modifications.
 157
 158                         wxPanel* m_PanelUp;//!<This panel contains the list of the elements empty,full and the config button.
 159                         ListWx* m_CurrentWxPanel;//!<This panel contains the final list of the elements .
 160
 161                         wxBitmapButton* m_ConfigButton;//!< "Config" Settings button.
 162                         //End MLER
 163
 164                         DECLARE_EVENT_TABLE()
 165                         //!<Event Table declaration.
 166         };
 167 } //ecapseman
 168
 169 #endif // PANELBUTTONCONTAINER_H_