lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/model/listGroupFactory.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 buttonGroupFactory.h
  28  * @brief Contains ButtonGroupFactory class
  29  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
  30  * @date  2011-06-02
  31  */
  32
  33 #ifndef LISTGROUPFACTORY_H
  34 #define LISTGROUPFACTORY_H
  35
  36 #include <wx/window.h>
  37 #include <wx/listctrl.h>
  38
  39 #include "listWx.h"
  40 #include "system.h"
  41 #include "listGroup.h"
  42 #include "containerSettings.h"
  43
  44 /*!     @namespace <creaButtonContainer>
  45  *      @brief Contains the creaButtonContainer library included in creaMaracasVisu.
  46  */
  47 namespace creaButtonContainer
  48 {
  49         /*! @namespace <creaButtonContainer::model>
  50          *      @brief Contains the implementation of the model in creaButtonContainer library.
  51          *      @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
  52          */
  53         namespace model
  54         {
  55                 /*! @class ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
  56                  *      @brief This class contains the ButtonGroup factory.
  57                  *  @details This class creates a container of group of buttons.
  58                  *  @see <a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Pattern</a>
  59                  */
  60                 class ListGroupFactory
  61                 {
  62                         public:
  63
  64                                 typedef creaButtonContainer::view::ListWx List;
  65
  66                                 typedef creaButtonContainer::view::ListGroup ListGroup;
  67                                 // ----------------------------------------------------------------------------------
  68                                 /*!     @typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
  69                                  *      @brief Defines the ButtonGroupModel type.
  70                                  */
  71                                 typedef creaButtonContainer::model::ContainerSettings ListModel;
  72                                 // ----------------------------------------------------------------------------------
  73                                 /*!     @typedef std::list< ButtonGroup* > ButtonGroupContainer;
  74                                  *      @brief Defines the ButtonGroupContainer type.
  75                                  */
  76                                 typedef std::list< ListGroup* > ListGroupContainer;
  77                                 // ----------------------------------------------------------------------------------
  78                                 /*!     @typedef std::map< long, Button* > ButtonContainer;
  79                                  *      @brief Defines the ButtonContainer type.
  80                                  */
  81                                 typedef std::list<ListWx> ListContainer;
  82
  83                                 // ----------------------------------------------------------------------------------
  84                                 //end of typedef definition
  85                         public:
  86                                 /*!     @fn ListGroupFactory::ListGroupFactory( );
  87                                  *      @brief This is the default constructor.
  88                                  */
  89                                 ListGroupFactory( );
  90                                 // -------------------------------------------------------------------------------
  91                                 /*!     @fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
  92                                  *      @brief This is the destructor.
  93                                  */
  94                                 virtual
  95                                 ~ListGroupFactory( );
  96
  97                                 /*! @fn ButtonGroupContainer ListGroupFactory::CreateListContainer( wxWindow* parent, ButtonGroupModel* settings );
  98                                  * @brief This method creates the ButtonGroupContainer.
  99                                  * @param parent the wxWindow* parent to be attached.
 100                                  * @param settings The Container settings.
 101                                  * @exception std::bad_alloc
 102                                  * @return ButtonGroupContainer The wx button group container.
 103                                  */
 104                                 ListGroupContainer
 105                                 CreateListGroupContainer( wxWindow* parent,
 106                                     ListModel* settings );
 107                         private:
 108
 109
 110                                 /*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
 111                                  * @brief  This method creates a wx button container for a group.
 112                                  * @param parent the wxWindow* parent to be attached.
 113                                  * @param buttonModel The button list with its own information.
 114                                  * @exception std::bad_alloc
 115                                  * @return ButtonContainer The wx button container.
 116                                  */
 117                                 ListGroupContainer
 118                                 GetList( wxWindow* parent, ListWx lst );
 119                 };
 120         }//ecapseman
 121 }//ecapseman
 122
 123 #endif // CARTOBUTTONFACTORY_H