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