# knowledge of the CeCILL-B license and that you accept its terms.
# ------------------------------------------------------------------------ */
-/*!
- * @file buttonGroup.h
- * @brief This contains the ButtonGroup class.
- * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-06-02
- */
-
#ifndef LISTGROUP_H
#define LISTGROUP_H
#include "listWx.h"
-/*! @namespace <creaButtonContainer>
- * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
- */
namespace creaButtonContainer
{
- /*! @namespace <creaButtonContainer::view>
- * @brief Contains the implementation of the view in creaButtonContainer library.
- * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
- */
+
namespace view
{
- /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
- * @brief This class contains the group of buttons.
- */
+
class ListGroup
{
public:
- //Typedef definition
- // ----------------------------------------------------------------------------------
- /*! @typedef creaButtonContainer::view::Button Button;
- * @brief Defines the Button type.
- */
- typedef creaButtonContainer::view::ListWx List;
- // ----------------------------------------------------------------------------------
- /*! @typedef std::map< long, Button* > ButtonContainer;
- * @brief Defines the ButtonContainer type.
- */
- typedef std::list< ListWx* > ListContainer;
- // ----------------------------------------------------------------------------------
+ typedef creaButtonContainer::view::ListWx Button;
+
+ typedef std::map< long, Button* > ButtonContainer;
+ typedef std::list< long > IdButtonContainer;
public:
+
+ ListGroup( wxStaticText* groupName, ButtonContainer buttons );
// ----------------------------------------------------------------------------------
- /*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
- * @brief This is the parameterized constructor.
- * @param groupName wxStatigText* with the name of the group.
- * @param buttons A container with buttons.
- */
- ListGroup( wxStaticText* groupName, ListContainer lists );
- // ----------------------------------------------------------------------------------
- /*! @fn ~ButtonGroup( );
- * @brief This is the destructor.
- */
+
virtual
~ListGroup( );
+ // ----------------------------------------------------------------------------------
+ Button*
+ GetButton( long id );
// ----------------------------------------------------------------------------------
- /*! @fn GetButtonContainer( );
- * @brief This method returns the button container.
- * @exception std::bad_alloc
- * @return ButtonContainer.
- */
- ListContainer
- GetListContainer( );
+
+ ButtonContainer
+ GetButtonContainer( );
// ----------------------------------------------------------------------------------
- /*! @fn GetButtonIdContainer( );
- * @brief This method returns a list of button IDs.
- * @exception std::bad_alloc
- * @return
- */
- // IdListContainer
- // GetListIdContainer( );
+
+ IdButtonContainer
+ GetButtonIdContainer( );
// ----------------------------------------------------------------------------------
- /*! @fn GetGroupName( );
- * @brief This method returns the name of the group.
- * @return
- */
+
wxStaticText*
GetGroupName( );
// ----------------------------------------------------------------------------------
private:
wxStaticText* m_GroupName; //!<A pointer with the wxStaticText of name of the group.
- ListContainer m_List; //!<A container with buttons.
+ ButtonContainer m_Buttons; //!<A container with buttons.
};
}//ecapseman
}//ecapseman