# knowledge of the CeCILL-B license and that you accept its terms.
# ------------------------------------------------------------------------ */
-/*!
- * @file buttonGroupFactory.h
- * @brief Contains ButtonGroupFactory class
- * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-06-02
- */
-
#ifndef LISTGROUPFACTORY_H
#define LISTGROUPFACTORY_H
#include <wx/window.h>
-#include <wx/listctrl.h>
-#include "listWx.h"
#include "system.h"
+#include "button.h"
#include "listGroup.h"
#include "containerSettings.h"
-/*! @namespace <creaButtonContainer>
- * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
- */
+
namespace creaButtonContainer
{
- /*! @namespace <creaButtonContainer::model>
- * @brief Contains the implementation of the model in creaButtonContainer library.
- * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
- */
+
namespace model
{
- /*! @class ButtonGroupFactory buttonGroupFactory.h "buttonGroupFactory.h"
- * @brief This class contains the ButtonGroup factory.
- * @details This class creates a container of group of buttons.
- * @see <a href="http://en.wikipedia.org/wiki/Factory_method_pattern">Factory Pattern</a>
- */
+
class ListGroupFactory
{
public:
- typedef creaButtonContainer::view::ListWx List;
+ typedef creaButtonContainer::view::ListWx Button;
+ // ----------------------------------------------------------------------------------
- typedef creaButtonContainer::view::ListGroup ListGroup;
+ typedef creaButtonContainer::view::ListGroup ButtonGroup;
// ----------------------------------------------------------------------------------
- /*! @typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
- * @brief Defines the ButtonGroupModel type.
- */
- typedef creaButtonContainer::model::ContainerSettings ListModel;
+
+ typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel;
// ----------------------------------------------------------------------------------
- /*! @typedef std::list< ButtonGroup* > ButtonGroupContainer;
- * @brief Defines the ButtonGroupContainer type.
- */
- typedef std::list< ListGroup* > ListGroupContainer;
+
+ typedef std::list< ButtonGroup* > ButtonGroupContainer;
// ----------------------------------------------------------------------------------
- /*! @typedef std::map< long, Button* > ButtonContainer;
- * @brief Defines the ButtonContainer type.
- */
- typedef std::list<ListWx> ListContainer;
+ typedef std::map< long, Button* > ButtonContainer;
// ----------------------------------------------------------------------------------
//end of typedef definition
public:
- /*! @fn ListGroupFactory::ListGroupFactory( );
- * @brief This is the default constructor.
- */
+
ListGroupFactory( );
// -------------------------------------------------------------------------------
- /*! @fn virtual ButtonGroupFactory::~ButtonGroupFactory( );
- * @brief This is the destructor.
- */
+
virtual
~ListGroupFactory( );
- /*! @fn ButtonGroupContainer ListGroupFactory::CreateListContainer( wxWindow* parent, ButtonGroupModel* settings );
- * @brief This method creates the ButtonGroupContainer.
- * @param parent the wxWindow* parent to be attached.
- * @param settings The Container settings.
- * @exception std::bad_alloc
- * @return ButtonGroupContainer The wx button group container.
- */
- ListGroupContainer
- CreateListGroupContainer( wxWindow* parent,
- ListModel* settings );
+ ButtonGroupContainer
+ CreateButtonGroupContainer( wxWindow* parent,
+ ButtonGroupModel* settings );
private:
- /*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
- * @brief This method creates a wx button container for a group.
- * @param parent the wxWindow* parent to be attached.
- * @param buttonModel The button list with its own information.
- * @exception std::bad_alloc
- * @return ButtonContainer The wx button container.
- */
- ListGroupContainer
- GetList( wxWindow* parent, ListWx lst );
+ ButtonContainer
+ GetButtons( wxWindow* parent, ButtonList buttonModel );
};
}//ecapseman
}//ecapseman
-#endif // CARTOBUTTONFACTORY_H
+#endif // LISTGROUPFACTORY_H