/*!
* @file buttonGroupFactory.cxx
- * @brief This contains the ButtonGroupFactory class implementation.
+ * @brief Implements the ButtonGroupFactory class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file buttonGroupFactory.h
- * @brief This contains ButtonGroupFactory class
+ * @brief Contains ButtonGroupFactory class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file containerSettings.cxx
- * @brief This contains the ContainerSettings class implementation
+ * @brief Implements the ContainerSettings class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file containerSettings.h
- * @brief This contains the ContainerSettings class
+ * @brief Contains the ContainerSettings class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file functor.h
- * @brief defines TFunctor class
+ * @brief Defines TFunctor class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file system.h
- * @brief contains a system typedefs used to reuse code.
+ * @brief Contains a system typedefs used to reuse code.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file button.cxx
- * @brief This contains the Button class implementation.
+ * @brief Implements the Button class implementation.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file button.h
- * @brief This contains the Button class.
+ * @brief Contains the Button class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
/*!
* @file buttonGroup.cxx
- * @brief This contains the ButtonGroup class implementation
+ * @brief Implements the ButtonGroup class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
*/
namespace view
{
+ /*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
+ * @brief This class contains the ButtonContainerPanel controller.
+ * @details This class describes the button events, it derives from wxEvtHandler and it is the
+ * controller in the MVC.
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledWindow.html">wxScrolledWindow</a>
+ */
class ButtonContainerPanel : public wxScrolledWindow
{
public:
//typedef definition
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+ * @brief Defines the ButtonGroup type.
*/
typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::view::GroupManager GroupManager;
+ * @brief Defines the GroupManager type.
*/
typedef creaButtonContainer::view::GroupManager GroupManager;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::list< ButtonGroup* > ButtonGroupList;
+ * @brief Defines the ButtonGroupList type.
*/
typedef std::list< ButtonGroup* > ButtonGroupList;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::map< long, GroupManager* > GroupManagerList;
+ * @brief Defines the GroupManagerList type.
*/
typedef std::map< long, GroupManager* > GroupManagerList;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef wxFlexGridSizer Sizer;
+ * @brief Defines the Sizer type.
*/
typedef wxFlexGridSizer Sizer;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::list< long > KeyList;
+ * @brief Defines the KeyList type.
*/
typedef std::list< long > KeyList;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
+ * @brief Defines the ButtonGroupSettings type.
*/
typedef creaButtonContainer::model::ContainerSettings
ButtonGroupSettings;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory;
+ * @brief Defines the ButtonGroupFactory type.
*/
typedef creaButtonContainer::model::ButtonGroupFactory
ButtonGroupFactory;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! creaButtonContainer::controller::ButtonContainerController BCController;
+ * @brief Defines the BCController type.
*/
typedef creaButtonContainer::controller::ButtonContainerController
BCController;
+ // ----------------------------------------------------------------------------------
//end of typedef definition
public:
/*! @fn ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings );
- *
- * @param parent
- * @param settings
+ * @brief This is the parameterized constructor.
+ * @param parent wxWindow pointer to parent.
+ * @param settings ButtonGroupSettings Pointer to button container settings.
*/
ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings );
// ----------------------------------------------------------------------------------
/*! @fn ~ButtonContainerPanel( );
- *
+ * @brief This is the destructor.
*/
virtual
~ButtonContainerPanel( );
// ----------------------------------------------------------------------------------
/*! @fn SetGroupContainer( ButtonGroupList groupContainer );
- *
+ * @brief This function sets the settings to the container.
* @param groupContainer
*/
void
SetGroupContainer( ButtonGroupList groupContainer );
// ----------------------------------------------------------------------------------
/*! @fn PanelInit( );
- *
+ * This function initializes the panel.
*/
void
PanelInit( );
// ----------------------------------------------------------------------------------
/*! @fn FitSizer( );
- *
+ * This function fits and organizes the sizer.
*/
void
FitSizer( );
public:
friend class creaButtonContainer::controller::ButtonContainerController;
private:
- GroupManagerList m_GroupManagerList;
- ButtonGroupList m_ButtonGroupList;
- BCController* m_ButtonCController;
- Sizer* m_Sizer;
+ GroupManagerList m_GroupManagerList; //!<The container of managers.
+ ButtonGroupList m_ButtonGroupList; //!<The list of button groups.
+ BCController* m_ButtonCController; //!<Pontier to controller.
+ Sizer* m_Sizer; //!<Pointer to wxSizer
};
}//ecapseman
}//ecapseman
/*!
* @file buttonGroup.cxx
- * @brief This contains the ButtonGroup class implementation
+ * @brief Implements the ButtonGroup class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
*/
namespace view
{
+ /*! @class ButtonGroup buttonGroup.h "buttonGroup.h"
+ * @brief This class contains the group of buttons.
+ */
class ButtonGroup
{
public:
//Typedef definition
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ /*! @typedef creaButtonContainer::view::Button Button;
+ * @brief Defines the Button type.
*/
typedef creaButtonContainer::view::Button Button;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::map< long, Button* > ButtonContainer;
+ * @brief Defines the ButtonContainer type.
*/
typedef std::map< long, Button* > ButtonContainer;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! typedef std::list< long > IdButtonContainer;
+ * @brief Defines the IdButtonContainer type.
*/
typedef std::list< long > IdButtonContainer;
public:
// ----------------------------------------------------------------------------------
/*! @fn ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
- *
- * @param groupName
- * @param buttons
+ * @brief This is the parameterized constructor.
+ * @param groupName wxStatigText* with the name of the group.
+ * @param buttons A container with buttons.
*/
ButtonGroup( wxStaticText* groupName, ButtonContainer buttons );
// ----------------------------------------------------------------------------------
/*! @fn ~ButtonGroup( );
- *
+ * @brief This is the destructor.
*/
virtual
~ButtonGroup( );
// ----------------------------------------------------------------------------------
/*! @fn GetButton( long id );
- *
- * @param id
- * @return
+ * @brief This method returns a Button*
+ * @param id The ID of the button.
+ * @return Button*
*/
Button*
GetButton( long id );
// ----------------------------------------------------------------------------------
/*! @fn GetButtonContainer( );
- *
- * @return
+ * @brief This method returns the button container.
+ * @return ButtonContainer.
*/
ButtonContainer
GetButtonContainer( );
// ----------------------------------------------------------------------------------
/*! @fn GetButtonIdContainer( );
- *
+ * @brief This method returns a list of button IDs.
* @return
*/
IdButtonContainer
GetButtonIdContainer( );
// ----------------------------------------------------------------------------------
/*! @fn GetGroupName( );
- *
+ * @brief This method returns the name of the group.
* @return
*/
wxStaticText*
GetGroupName( );
// ----------------------------------------------------------------------------------
private:
- wxStaticText* m_GroupName;
- ButtonContainer m_Buttons;
+ wxStaticText* m_GroupName; //!<A pointer with the name of the group.
+ ButtonContainer m_Buttons; //!<A container with buttons.
};
}//ecapseman
}//ecapseman
/*!
* @file buttonManager.cxx
- * @brief This contains the ButtonManager class implementation
+ * @brief Implements the ButtonManager class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
*/
namespace view
{
+ /*! @class ButtonManager buttonManager.h "buttonManager.h"
+ * @brief This class contains the ButtonManager view.
+ * @details This class describes a wxFlexGridSizer with the button manager, it derives from wxFlexGridSizer and it is the
+ * controller in the MVC.
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
+ */
class ButtonManager : public wxFlexGridSizer
{
public:
//typedef definition.
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ /*! @typedef creaButtonContainer::view::Button Button;
+ * @brief Defines the Button type.
*/
typedef creaButtonContainer::view::Button Button;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+ * @brief Defines the ButtonGroup type.
*/
typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::map< long, Button* > ButtonContainer;
+ * @brief Defines the ButtonContainer type.
*/
typedef std::map< long, Button* > ButtonContainer;
+ // ----------------------------------------------------------------------------------
//end of typedef definition.
public:
// ----------------------------------------------------------------------------------
/*! @fn ButtonManager( );
- *
+ * @brief This is the default construuctor.
*/
ButtonManager( );
// ----------------------------------------------------------------------------------
/*! @fn ButtonManager( ButtonGroup* buttonGroup );
- *
- * @param buttonGroup
+ * @brief This is the parameterized constructor
+ * @param buttonGroup The group of buttons.
*/
ButtonManager( ButtonGroup* buttonGroup );
// ----------------------------------------------------------------------------------
/*! @fn ~ButtonManager( );
- *
+ * @brief This is the destructor.
*/
virtual
~ButtonManager( );
// ----------------------------------------------------------------------------------
/*! @fn SetGroupName( wxStaticText* groupName );
- *
+ * @details Sets the groupName.
* @param groupName
*/
void
SetGroupName( wxStaticText* groupName );
// ----------------------------------------------------------------------------------
/*! @fn ShowButtonManager( );
- *
+ * @brief This function shows the ButtonManager
*/
void
ShowButtonManager( );
// ----------------------------------------------------------------------------------
/*! @fn HideButtonManager( );
- *
+ * @brief This function hides the ButtonManager.
*/
void
HideButtonManager( );
private:
// ----------------------------------------------------------------------------------
/*! @fn SetButtonManager( ButtonContainer buttonContainer );
- *
+ * @brief This function set the buttons and it is private.
* @param buttonContainer
*/
void
SetButtonManager( ButtonContainer buttonContainer );
// ----------------------------------------------------------------------------------
private:
- wxStaticText* m_GroupName;
- wxGridSizer* m_GridSizer;
+ wxStaticText* m_GroupName; //!<The name of the group.
+ wxGridSizer* m_GridSizer; //!<The sizer that contains the buttons.
};
}//ecapseman
}//ecapseman
/*!
* @file groupManager.cxx
- * @brief This contains the GroupManager class implementation
+ * @brief Implements the GroupManager class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
* @date 2011-05-19
*/
{
public:
//typedef definition
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+ * @brief Defines the ButtonGroup type.
*/
typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
- /*! @typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef wxButton ExpansionButton;
+ * @brief Defines the ExpansionButton type.
*/
typedef wxButton ExpansionButton;
+ // ----------------------------------------------------------------------------------
//end of typedef definition.
public:
// ----------------------------------------------------------------------------------
/*! @fn GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
- *
- * @param parent
- * @param buttonGroup
+ * @brief This is the parameterized constructor.
+ * @param parent The wxWindow* parent
+ * @param buttonGroup The pointer to the ButtonGroup.
*/
GroupManager( wxWindow* parent, ButtonGroup* buttonGroup );
// ----------------------------------------------------------------------------------
- /*! @fn
- * ~GroupManager( );
+ /*! @fn ~GroupManager( );
+ * @brief This is the destructor.
*/
virtual
~GroupManager( );
- //Getters and Setters
// ----------------------------------------------------------------------------------
- /*! @fn
+ /*! @fn GetButtonID( );
+ * @brief This method returns the Button ID.
* @return
*/
long
GetButtonID( );
// ----------------------------------------------------------------------------------
/*! @fn GetButton( );
- *
+ * @brief This method returns the expansion button.
* @return
*/
ExpansionButton*
GetButton( );
// ----------------------------------------------------------------------------------
/*! @fn GetButtonManager( );
- *
- * @return
+ * @brief This method returns the manager of the buttons.
+ * @return
*/
ButtonManager*
GetButtonManager( );
// ----------------------------------------------------------------------------------
/*! @fn SetButtonID( long id );
- *
+ * @brief This method sets the ID of the expansion button.
* @param id
*/
void
SetButtonID( long id );
// ----------------------------------------------------------------------------------
/*! @fn SetButton( ExpansionButton* button );
- *
+ * @brief This method sets the expansion button.
* @param button
*/
void
SetButton( ExpansionButton* button );
// ----------------------------------------------------------------------------------
/*! @fn SetButtonManager( ButtonManager* manager );
- *
- * @param manager
+ * @brief This method Sets the ButtonManager
+ * @param manager A pointer with the manager.
*/
void
SetButtonManager( ButtonManager* manager );
// ----------------------------------------------------------------------------------
/*! @fn HideSubPanel( bool hide );
- *
- * @param hide
+ * @brief This method hides the subPanel (Hides the buttons).
+ * @param hide True if you need to hide the buttons.
*/
void
HideSubPanel( bool hide );
private:
- long m_IDExpButton;
- ExpansionButton* m_ExpansionButton;
- ButtonManager* m_ButtonManager;
+ long m_IDExpButton; //!<ID of "+""-" expansion button.
+ ExpansionButton* m_ExpansionButton; //!<The expansion button.
+ ButtonManager* m_ButtonManager; //!<The button manager.
};
}//ecapseman
}//ecapseman
git://git.creatis.insa-lyon.fr / creaMaracasVisu.git / commitdiff