-/***************************************************************
- * Name: GroupManager.h
- * Purpose: Defines the Group Manager
- * Author: Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Created: 2011-05-09
- * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/)
- * License:
- **************************************************************/
+/*!
+ * @file groupManager.h
+ * @brief This contains the GroupManager class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 2011-06-02
+ */
#ifndef GROUPMANAGER_H
#define GROUPMANAGER_H
#include <wx/sizer.h>
#include <wx/button.h>
#include <wx/stattext.h>
+
#include <list>
+#include <iostream>
+#include <exception>
+
#include "buttonManager.h"
#include "buttonGroup.h"
-#include <wx/event.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
{
- typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
- typedef wxButton ExpansionButton;
- /**
- Class Description:
- **/
+ /*! @class GroupManager groupManager.h "groupManager.h"
+ * @brief This class contains the GroupManager.
+ * @details This class describes a wxFlexGridSizer with the group manager.
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxflexGridSizer.html">wxFlexGridSizer</a>
+ */
class GroupManager : public wxFlexGridSizer
{
public:
+ //typedef definition
+ // ----------------------------------------------------------------------------------
+ /*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+ * @brief Defines the ButtonGroup type.
+ */
+ typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
+ // ----------------------------------------------------------------------------------
+ /*! @typedef wxButton ExpansionButton;
+ * @brief Defines the ExpansionButton type.
+ */
+ typedef wxButton ExpansionButton;
+ // ----------------------------------------------------------------------------------
+ //end of typedef definition.
+ public:
+ // ----------------------------------------------------------------------------------
+ /*! @fn GroupManager( wxWindow* parent, ButtonGroup* 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( );
+ * @brief This is the destructor.
+ */
virtual
~GroupManager( );
- //Getters and Setters
+ // ----------------------------------------------------------------------------------
+ /*! @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( );
+ * @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 );
+ * @brief This method Sets the ButtonManager
+ * @param manager A pointer with the manager.
+ */
void
SetButtonManager( ButtonManager* manager );
+ // ----------------------------------------------------------------------------------
+ /*! @fn HideSubPanel( bool 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