-/************************************************************************************//*!
- * Name: @file buttonContainerController.h
- * Purpose: @brief This contains the ButtonContainerController class
- * Author: @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * Modified: 2011-05-17
- * Copyright:
- * License:
- ***************************************************************************************/
+/*!
+ * @file buttonContainerController.h
+ * @brief Contains the ButtonContainerController class
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date 2011-06-02
+ */
#ifndef BUTTONCONTAINERCONTROLLER_H_
#define BUTTONCONTAINERCONTROLLER_H_
-//! @include <wx/event.h>
#include <wx/event.h>
-//! @include <iostream>
#include <iostream>
-//! @include <exception>
#include <exception>
-
-//! @include "buttonContainerPanel.h"
#include "buttonContainerPanel.h"
-//! @namespace<creaButtonContainer>
+/*! @namespace <creaButtonContainer>
+ * @brief Contains the creaButtonContainer library included in creaMaracasVisu.
+ */
namespace creaButtonContainer
{
- //! @namespace<view>
+ /*! @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
{
//Predefinition of ButtonContainerPanel FriendClass!!
- //! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
-
+ /*! @class ButtonContainerPanel buttonContainerPanel.h "buttonContainerPanel.h"
+ * @brief This class is the container of the creaButtonContainer.
+ * @details This class derives from wxScrolledWindow and manages the view of the buttonContainer.
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledwindow.html">wxScrolledWindow</a>
+ */
class ButtonContainerPanel;
}
- //! @namespace<controller>
+ /*! @namespace<creaButtonContainer::controller>
+ * @brief Contains the implementation of the controller in creaButtonContainer library.
+ * @see <a href="http://en.wikipedia.org/wiki/Model-view-controller">MVC Software Architecture</a>
+ */
namespace controller
{
/*! @class ButtonContainerController buttonContainerController.h "buttonContainerController.h"
- * @brief This class contains the ButtonContainerPanel controller
- * This class describes button events.
+ * @brief This class contains the ButtonContainerPanel controller.
+ * @details This class describes the button events, it derives from wxEvtHandler.
+ * @see <a href="http://docs.wxwidgets.org/stable/wx_wxevthandler.html">wxEvtHandler</a>
*/
class ButtonContainerController : public wxEvtHandler
{
public:
//typedef definitions
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup
* @brief Defines the ButtonGroup type
*/
typedef std::list< ButtonGroup* > ButtonGroupList;
// ----------------------------------------------------------------------------------
/*! @typedef std::map< long, GroupManager* > GroupManagerList
- * @brief Defines the GroupManagerList type
+ * @brief Defines the GroupManagerList type
*/
typedef std::map< long, GroupManager* > GroupManagerList;
// ----------------------------------------------------------------------------------
* @brief Defines the BCPanel type
*/
typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
+ // ----------------------------------------------------------------------------------
//end of typedef definition
public:
- /*! @fn ButtonContainerController::ButtonContainerController( BCPanel* )
+ // ----------------------------------------------------------------------------------
+ /*! @fn ButtonContainerController( BCPanel* );
* @brief This is the Parameterized constructor.
- * @param BCPanel*
+ * @param BCPanel* The connection with the view (wxPanel link).
*/
ButtonContainerController( BCPanel* );
// ----------------------------------------------------------------------------------
- /*! @fn virtual ButtonContainerController::~ButtonContainerController( )
+ /*! @fn ~ButtonContainerController( );
* @brief This is the destructor.
*/
virtual
~ButtonContainerController( );
+
// ----------------------------------------------------------------------------------
- /*! @fn void ButtonContainerController::AddEvents( )
- * @brief This function connect every buttonEvent to the view.
+ /*! @fn void AddEvents( );
+ * @brief This method connect every buttonEvents to the view.
* @exception std::bad_alloc
*/
void
AddEvents( );
// ----------------------------------------------------------------------------------
- /*! @fn void ButtonContainerController::ButtonExpEvent( wxCommandEvent& event )
- * @brief This function is the button group "+" "-" event.
+ /*! @fn void ButtonExpEvent( wxCommandEvent& event );
+ * @brief This method is the button group "+" "-" event.
* @exception std::bad_alloc
* @param event Button action event.
*/
void
ButtonExpEvent( wxCommandEvent& event );
// ----------------------------------------------------------------------------------
- /*! @fn void ButtonContainerController::ButtonEvent( wxCommandEvent& event )
- * @brief This function calls the events of the buttonContainer buttons
+ /*! @fn void ButtonEvent( wxCommandEvent& event );
+ * @brief This method calls the events of the buttonContainer buttons
* @exception std::bad_alloc
* @param event Button action event.
*/