* @file buttonContainerController.cxx
* @brief This contains the ButtonContainerController class implementation
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "buttonContainerController.h"
!= this->m_BCPanel->m_ButtonGroupList.end( ); ++it )
{
if ( ( *it )->GetButton( event.GetId( ) ) != NULL )
+ {
( *it )->GetButton( event.GetId( ) )->Execute( );
+ }//fi
}//rof
}//yrt
catch ( const std::exception& e )
/*!
* @file buttonContainerController.h
- * @brief This contains the ButtonContainerController class
+ * @brief Contains the ButtonContainerController class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTONCONTAINERCONTROLLER_H_
{
/*! @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.
+ * @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
*/
* @brief Defines the BCPanel type
*/
typedef creaButtonContainer::view::ButtonContainerPanel BCPanel;
+ // ----------------------------------------------------------------------------------
//end of typedef definition
public:
// ----------------------------------------------------------------------------------
// ----------------------------------------------------------------------------------
/*! @fn void AddEvents( );
- * @brief This method connect every buttonEvent to the view.
+ * @brief This method connect every buttonEvents to the view.
* @exception std::bad_alloc
*/
void
* @file buttonGroupFactory.cxx
* @brief Implements the ButtonGroupFactory class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "buttonGroupFactory.h"
ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent,
ButtonGroupModel* settings )
{
+ ButtonGroupContainer groupView;
try
{
- ButtonGroupContainer groupView;
ButtonGroupMap map = settings->GetButtonGroupContainer( );
for( ButtonGroupMap::iterator it = map.begin( ); it != map.end( ); ++it )
{
ButtonGroup* group = new ButtonGroup( wxGroupName,
this->GetButtons( parent, ( *it ).second ) );
groupView.push_back( group );
- }
- return ( groupView );
+ }//rof
}//yrt
catch ( const std::exception& e )
{
<< "ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent, ButtonGroupModel* settings )"
<< " exception: " << e.what( ) << std::endl;
}//chtac
+ return ( groupView );
}
// ----------------------------------------------------------------------------------
ButtonGroupFactory::ButtonContainer
{
long id = wxNewId( );
buttonList[ id ] = new Button( parent, id, *it );
- }
+ }//rof
return ( buttonList );
}//yrt
catch ( const std::exception& e )
* @file buttonGroupFactory.h
* @brief Contains ButtonGroupFactory class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTONGROUPFACTORY_H
#define BUTTONGROUPFACTORY_H
#include <wx/window.h>
-#include <list>
-#include <map>
-#include <iostream>
-#include <exception>
#include "system.h"
#include "button.h"
#include "buttonGroup.h"
#include "containerSettings.h"
-#include "functor.h"
/*! @namespace <creaButtonContainer>
* @brief Contains the creaButtonContainer library included in creaMaracasVisu.
{
public:
//typedef definition
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::view::Button Button;
* @brief Defines the Button type.
*/
virtual
~ButtonGroupFactory( );
/*! @fn ButtonGroupContainer ButtonGroupFactory::CreateButtonGroupContainer( wxWindow* parent, ButtonGroupModel* settings );
- * @brief This method allows to create the ButtonGroupContainer.
+ * @brief This method creates the ButtonGroupContainer.
* @param parent the wxWindow* parent to be attached.
* @param settings The Container settings.
* @exception std::bad_alloc
ButtonGroupModel* settings );
private:
/*! @fn ButtonContainer ButtonGroupFactory::GetButtons( wxWindow* parent, ButtonList buttonModel );
- * @brief This method allows to create a wx button container for a group.
+ * @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
* @file containerSettings.cxx
* @brief Implements the ContainerSettings class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "containerSettings.h"
ButtonGroupMap
ContainerSettings::GetButtonGroupContainer( )
{
- return this->m_ButtonGroupContainer;
+ return ( this->m_ButtonGroupContainer );
}
// ----------------------------------------------------------------------------------
KeyMapList
ContainerSettings::GetGroupNameList( )
{
- return this->m_GroupNameList;
+ return ( this->m_GroupNameList );
}
// ----------------------------------------------------------------------------------
void
}
// ----------------------------------------------------------------------------------
void
- ContainerSettings::AddButton( const std::string & groupName,
- const std::string buttonName, const std::string iconpath,
- const std::string buttonDescription, FunctionEventType event )
+ ContainerSettings::AddButton( const StringType & groupName,
+ const StringType &buttonName, const StringType &iconpath,
+ const StringType &buttonDescription, FunctionEventType event )
{
+ ButtonPair* pair = new ButtonPair(
+ new ButtonInfo( buttonName, iconpath ),
+ new ButtonAction( buttonDescription, event ) );
try
{
- ButtonPair* pair = new ButtonPair(
- new ButtonInfo( buttonName, iconpath ),
- new ButtonAction( buttonDescription, event ) );
for( KeyMapList::iterator it = this->m_GroupNameList.begin( ); it
!= this->m_GroupNameList.end( ); ++it )
{
void
ContainerSettings::AddButton( BCSettingsStruct* info )
{
+ ButtonPair* pair = new ButtonPair(
+ new ButtonInfo( info->buttonName, info->iconpath ),
+ new ButtonAction( info->buttonDescription, info->eventFunction ) );
try
{
- ButtonPair* pair = new ButtonPair(
- new ButtonInfo( info->buttonName, info->iconpath ),
- new ButtonAction( info->buttonDescription, info->eventFunction ) );
for( KeyMapList::iterator it = this->m_GroupNameList.begin( ); it
!= this->m_GroupNameList.end( ); ++it )
{
* @file containerSettings.h
* @brief Contains the ContainerSettings class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTONGROUPSETTINGS_H_
#define BUTTONGROUPSETTINGS_H_
-#include <list>
-#include <map>
#include <vector>
-#include <iostream>
-#include <exception>
+
#include "structBCSettings.h"
#include "system.h"
-#include "functor.h"
/*! @namespace <creaButtonContainer>
* @brief Contains the creaButtonContainer library included in creaMaracasVisu.
* @exception std::bad_alloc
*/
void
- AddButton( const std::string & groupName, const std::string buttonName,
- const std::string iconpath, const std::string buttonDescription,
+ AddButton( const StringType & groupName, const StringType &buttonName,
+ const StringType &iconpath, const StringType &buttonDescription,
FunctionEventType event );
// ----------------------------------------------------------------------------------
/*! @fn void AddButton( BCSettingsStruct* info );
- * @brief This method adds a new button to the container.
+ * @brief This method adds a new button to the container using the
+ * BCSettingsStruct structure.
* @exception std::bad_alloc
* @param info
*/
AddButtons( BCStructVectorType infoList );
// ----------------------------------------------------------------------------------
private:
- ButtonGroupMap m_ButtonGroupContainer; //! <std::map< std::string, ButtonList > View pointer.
- KeyMapList m_GroupNameList; //! <ButtonContainerPanel View pointer.
+ ButtonGroupMap m_ButtonGroupContainer; //! <The container with the group of buttons.
+ KeyMapList m_GroupNameList; //! <The container with the name of the groups of buttons.
};
}
}
* @file functor.h
* @brief Defines TFunctor class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef TFUNCTOR_H_
* @file functor.cxx
* @brief Implements TFunctor class and it propose is Call_Back Functions
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
namespace creaButtonContainer
* @file structBCSettings.h
* @brief Contains BCSettingsStruct structure.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef STRUCTBCSETTINGS_H_
#define STRUCTBCSETTINGS_H_
-#include <string>
#include "system.h"
/*! @namespace <creaButtonContainer>
*/
struct BCSettingsStruct
{
- std::string groupName; //! <The name of the group of buttons.
- std::string buttonName; //! <The name of the button.
- std::string iconpath; //! <The iconPath of the button.
- std::string buttonDescription; //! <The description of the button.
+ StringType groupName; //! <The name of the group of buttons.
+ StringType buttonName; //! <The name of the button.
+ StringType iconpath; //! <The iconPath of the button.
+ StringType buttonDescription; //! <The description of the button.
FunctionEventType eventFunction; //! <The event associated to the button.
};
} //ecapseman
* @file system.h
* @brief Contains a system typedefs used to reuse code.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
-*/
+ * @date 2011-06-02
+ */
#ifndef SYSTEM_H_
#define SYSTEM_H_
#include <map>
#include <iostream>
#include <exception>
+#include <string>
#include "functor.h"
/*! @namespace <creaButtonContainer>
*/
namespace creaButtonContainer
{
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::string* StringType;
+ * @brief Defines the StringType type.
+ */
+ typedef std::string StringType;
+ // ----------------------------------------------------------------------------------
/*! @typedef model::TFunctor* FunctionEventType;
* @brief Defines the FunctionEventType type.
*/
* @brief Defines the ActionButton type.
* First is the button description, Second FunctionEventType
*/
- typedef std::pair< std::string, FunctionEventType > ButtonAction;
+ typedef std::pair< StringType, FunctionEventType > ButtonAction;
// ----------------------------------------------------------------------------------
/*! @typedef std::pair< std::string, std::string > ButtonInfo;
* @brief Defines the ButtonInfo type.
* First is the ButtonName and Second is the IconPath
*/
- typedef std::pair< std::string, std::string > ButtonInfo;
+ typedef std::pair< StringType, StringType > ButtonInfo;
// ----------------------------------------------------------------------------------
/*! @typedef std::pair< ButtonInfo*, ActionButton* > ButtonPair;
* @brief Defines the ButtonPair type.
/*! @typedef std::list< std::string > KeyMapList;
* @brief Defines the KeyMapList type.
*/
- typedef std::list< std::string > KeyMapList;
+ typedef std::list< StringType > KeyMapList;
// ----------------------------------------------------------------------------------
/*! @typedef std::list< ButtonPair* > ButtonList;
* @brief Defines the ButtonList type.
/*! @typedef std::map< std::string, ButtonList > ButtonGroupMap;
* @brief Defines the ButtonGroupMap type.
*/
- typedef std::map< std::string, ButtonList > ButtonGroupMap;
+ typedef std::map< StringType, ButtonList > ButtonGroupMap;
// ----------------------------------------------------------------------------------
}
* @file button.cxx
* @brief Implements the Button class implementation.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "button.h"
Button::Button( wxWindow* parent, long id, ButtonPair* pair )
{
this->m_ButtonPair = pair;
- std::string wXbuttonName = this->m_ButtonPair->first->first;
- std::string wXiconPath = this->m_ButtonPair->first->second;
- std::string wXdescription = this->m_ButtonPair->second->first;
+ StringType wXbuttonName = this->m_ButtonPair->first->first;
+ StringType wXiconPath = this->m_ButtonPair->first->second;
+ StringType wXdescription = this->m_ButtonPair->second->first;
wxString buttonName( wXbuttonName.c_str( ), wxConvUTF8 );
wxString imageIcon( wXiconPath.c_str( ), wxConvUTF8 );
wxString description( wXdescription.c_str( ), wxConvUTF8 );
{
}
// ----------------------------------------------------------------------------------
- std::string
+ StringType
Button::GetButtonName( )
{
return ( this->m_ButtonPair->first->first );
}
// ----------------------------------------------------------------------------------
- std::string
+ StringType
Button::GetIconPath( )
{
return ( this->m_ButtonPair->first->second );
}
// ----------------------------------------------------------------------------------
- std::string
+ StringType
Button::GetDescription( )
{
return ( this->m_ButtonPair->second->first );
{
try
{
- std::cout << "ButtonAction: " << this->m_ButtonPair->first->first
- << std::endl;
TFunctor* vTable[ ] =
{ this->m_ButtonPair->second->second };
vTable[ 0 ]->Call( this->m_ButtonPair->first->first );
* @file button.h
* @brief Contains the Button class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTON_H
#include <wx/bmpbuttn.h>
#include <wx/image.h>
#include <wx/string.h>
-#include <string>
-#include <iostream>
-#include <exception>
-#include "functor.h"
+
#include "system.h"
/*! @namespace <creaButtonContainer>
{
public:
//typedef definition
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::model::TFunctor TFunctor;
* @brief Defines the TFunctor type.
*/
* @brief This method returns the name of the button.
* @return std::string The name of the button.
*/
- std::string
+ StringType
GetButtonName( );
// ----------------------------------------------------------------------------------
/*! @fn std::string Button::GetIconPath( );
* @brief This method returns the iconPath of the button.
* @return std::string The path of the icon.
*/
- std::string
+ StringType
GetIconPath( );
// ----------------------------------------------------------------------------------
/*! @fn std::string Button::GetDescription( );
* @brief This method returns a the description of the button.
* @return std::string The tooltip of the button.
*/
- std::string
+ StringType
GetDescription( );
// ----------------------------------------------------------------------------------
/*! @fn void Button::Execute( );
Execute( );
// ----------------------------------------------------------------------------------
private:
- ButtonPair* m_ButtonPair; //! <ButtonPair* ButtonPair pointer.
+ ButtonPair* m_ButtonPair; //! <The pair with the button information.
};
}//ecapseman
}//ecapseman
* @file buttonGroup.cxx
* @brief Implements the ButtonGroup class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-28
+ * @date 2011-06-02
*/
#include "buttonContainerPanel.h"
* @file buttonContainerController.h
* @brief This contains the ButtonContainerController class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-28
+ * @date 2011-06-02
*/
#ifndef BUTTONCONTAINERPANEL_H
#include <wx/scrolwin.h>
#include <wx/button.h>
#include <wx/sizer.h>
+
#include <list>
#include <map>
#include <exception>
{
/*! @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.
+ * @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;
* @file buttonGroup.cxx
* @brief Implements the ButtonGroup class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "buttonGroup.h"
ButtonGroup::IdButtonContainer
ButtonGroup::GetButtonIdContainer( )
{
+ IdButtonContainer idContainer;
try
{
- IdButtonContainer idContainer;
for( ButtonContainer::iterator it = this->m_Buttons.begin( ); it
!= this->m_Buttons.end( ); ++it )
{
idContainer.push_back( ( *it ).first );
- }
- return ( idContainer );
+ }//rof
}//yrt
catch ( std::exception& e )
{
std::cerr << "ButtonGroup::GetButtonIdContainer( )" << "exception: "
<< e.what( ) << std::endl;
}//hctac
+ return ( idContainer );
}
// ----------------------------------------------------------------------------------
Button*
* @file buttonGroup.h
* @brief This contains the ButtonGroup class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTONGROUP_H
#define BUTTONGROUP_H
//Library Definition
+#include <wx/stattext.h>
+
#include <map>
#include <list>
-#include <wx/stattext.h>
#include <exception>
#include "button.h"
{
public:
//Typedef definition
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::view::Button Button;
* @brief Defines the Button type.
*/
GetGroupName( );
// ----------------------------------------------------------------------------------
private:
- wxStaticText* m_GroupName; //!<A pointer with the name of the group.
+ wxStaticText* m_GroupName; //!<A pointer with the wxStaticText of name of the group.
ButtonContainer m_Buttons; //!<A container with buttons.
};
}//ecapseman
* @file buttonManager.cxx
* @brief Implements the ButtonManager class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "buttonManager.h"
this->m_GridSizer->Add( ( *it ).second, -1,
wxALL | wxALIGN_LEFT | wxALIGN_TOP, 5 );
this->Add( m_GridSizer, -1, wxALL | wxALIGN_LEFT | wxALIGN_TOP, 5 );
- }
+ }//fi
}//yrt
catch ( const std::exception& e )
{
* @file buttonManager.h
* @brief This contains the ButtonManager class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef CARTOBUTTONCONTAINER_H
#include <wx/bmpbuttn.h>
#include <wx/stattext.h>
#include <wx/string.h>
+
#include <map>
#include <exception>
+
#include "button.h"
#include "buttonGroup.h"
{
public:
//typedef definition.
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::view::Button Button;
* @brief Defines the Button type.
*/
* @file groupManager.cxx
* @brief Implements the GroupManager class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "groupManager.h"
wxDefaultValidator, _T("EXPBUTTON") );
this->Add( m_ExpansionButton, 1, wxALL | wxALIGN_LEFT | wxALIGN_TOP, 5 );
this->m_ButtonManager = new ButtonManager( buttonGroup );
- this->Add( this->m_ButtonManager, 1, wxALL | wxALIGN_LEFT | wxALIGN_TOP, 5 );
+ this->Add( this->m_ButtonManager, 1, wxALL | wxALIGN_LEFT | wxALIGN_TOP,
+ 5 );
}
// ----------------------------------------------------------------------------------
GroupManager::~GroupManager( )
GroupManager::HideSubPanel( bool hide )
{
if ( hide == true )
+ {
this->m_ButtonManager->HideButtonManager( );
+ }//fi
else
+ {
this->m_ButtonManager->ShowButtonManager( );
+ }//esle
}
- // ----------------------------------------------------------------------------------
+ // ----------------------------------------------------------------------------------
}//ecapseman
}//ecapseman
* @file groupManager.h
* @brief This contains the GroupManager class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef GROUPMANAGER_H
#include <wx/sizer.h>
#include <wx/button.h>
#include <wx/stattext.h>
-#include <wx/event.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.
{
public:
//typedef definition
+ // ----------------------------------------------------------------------------------
/*! @typedef creaButtonContainer::view::ButtonGroup ButtonGroup;
* @brief Defines the ButtonGroup type.
*/
* @file buttonContainerSettings.cxx
* @brief Implements the ButtonContainerSettings class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#include "buttonContainerSettings.h"
// ----------------------------------------------------------------------------------
//GetButtonPanel returns the panel associated to the buttonAction
ButtonContainerSettings::PanelButton
- ButtonContainerSettings::GetPanelButton( const std::string &buttonName )
+ ButtonContainerSettings::GetPanelButton( const StringType &buttonName )
{
try
{
catch ( std::exception& e )
{
std::cerr
- << "ButtonContainerSettings::GetPanelButton( const std::string &buttonName ) "
+ << "ButtonContainerSettings::GetPanelButton( const StringType &buttonName ) "
<< "exception: " << e.what( ) << std::endl;
}//hctac
return ( NULL );
catch ( std::exception& e )
{
std::cerr
- << "ButtonContainerSettings::GetPanelButton( const std::string &buttonName ) "
+ << "ButtonContainerSettings::GetPanelButton( const StringType &buttonName ) "
<< "exception: " << e.what( ) << std::endl;
}//hctac
}
}
// ----------------------------------------------------------------------------------
void
- ButtonContainerSettings::AddButton( const std::string & groupName,
- const std::string &buttonName, const std::string &iconpath,
- const std::string &buttonDescription, PanelButton panel )
+ ButtonContainerSettings::AddButton( const StringType & groupName,
+ const StringType &buttonName, const StringType &iconpath,
+ const StringType &buttonDescription, PanelButton panel )
{
try
{
catch ( const std::exception& e )
{
std::cerr
- << "ButtonContainerSettings::AddButton( const std::string & groupName,"
- << "const std::string &buttonName, const std::string &iconpath,"
- << "const std::string &buttonDescription, PanelButton panel ) "
+ << "ButtonContainerSettings::AddButton( const StringType & groupName,"
+ << "const StringType &buttonName, const StringType &iconpath,"
+ << "const StringType &buttonDescription, PanelButton panel ) "
<< "exception: " << e.what( ) << std::endl;
}//hctac
}
* @file buttonContainerSettings.h
* @brief This contains the ButtonContainerSettings class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef BUTTONCONTAINERSETTINGS_H_
#define BUTTONCONTAINERSETTINGS_H_
+#include <wx/panel.h>
+
#include <list>
#include <map>
-#include <wx/panel.h>
#include <vector>
#include <iostream>
{
public:
//typedef definition.
+ // ----------------------------------------------------------------------------------
+ /*! @typedef std::string* StringType;
+ * @brief Defines the StringType type.
+ */
+ typedef std::string StringType;
+ // ----------------------------------------------------------------------------------
/*! typedef creaButtonContainer::model::TFunctor TFunctor;
* @brief Defines the TFunctor type.
*/
// ----------------------------------------------------------------------------------
/*! @fn ButtonGroupSettings* GetButtonGroupSettings( TFunctor* functor );
* @brief this method return the settings the generic settings for creaButtonContainer.
- * @param functor
+ * @param functor The function to be called in the action button.
* @exception std::bad_alloc
* @return
*/
const std::string &iconpath, const std::string &buttonDescription,
PanelButton panel );
* @brief This method adds a new button into a group of buttons.
- * @param groupName
- * @param buttonName
- * @param iconpath
- * @param buttonDescription
- * @param panel
+ * @param groupName The button groupName
+ * @param buttonName The buttonName
+ * @param iconpath The path of the icon
+ * @param buttonDescription The button tooltip
+ * @param panel The panel to be called when the button is clicked
* @exception std::bad_alloc
*/
void
// ----------------------------------------------------------------------------------
/*! @fn void AddButton( BCPSettingsStruct* info );
* @brief This method adds a new button into a group of buttons.
- * @param info
+ * @param info The pointer to BCPSettingsStruct.
* @exception std::bad_alloc
*/
void
// ----------------------------------------------------------------------------------
/*! @fn void AddButtons( BCStructVectorType infoList );
* @brief This method adds new buttons into the container.
- * @param infoList
+ * @param infoList The BCStructVectorType
* @exception std::bad_alloc
*/
void
* @file creaPanelButtonContainer.h
* @brief implements PanelButtonContainer class
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-28
+ * @date 2011-06-02
*/
#include "creaPanelButtonContainer.h"
buttonName );
//changing the parent of the panel!
if ( this->m_ButtonPanel->GetParent( ) != this )
+ {
this->m_ButtonPanel->Reparent( this );
+ }//fi
//CartoSettingsPanel Management
this->m_AuiManager->GetPane( _T("ButtonPanel") ).window
= this->m_ButtonPanel;
* @file PanelButtonContainer
* @brief This contains the ButtonContainerSettings class.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-28
+ * @date 2011-06-02
*/
#ifndef PANELBUTTONCONTAINER_H_
{
public:
//typedef definition.
- /*! typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ // ----------------------------------------------------------------------------------
+ /*! typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
+ * @brief Defines the ButtonContainerSettings type.
*/
typedef creaPanelButtonContainer::ButtonContainerSettings
ButtonContainerSettings;
- /*! typedef creaButtonContainer::model::TFunctor TFunctor;
- * @brief Defines the TFunctor type.
+ /*! typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+ * @brief Defines the ButtonContainerPanel type.
*/
typedef creaButtonContainer::view::ButtonContainerPanel
ButtonContainerPanel;
// ----------------------------------------------------------------------------------
/*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
* @brief This is the parameterized constructor.
- * @param parent
- * @param bcSettings
+ * @param parent The wxWindow pointer to parent
+ * @param bcSettings //The buttonContainerSettings
*/
PanelButtonContainer( wxWindow* parent,
ButtonContainerSettings* bcSettings );
~PanelButtonContainer( );
// ----------------------------------------------------------------------------------
/*! @fn void UpdatePanel( const std::string &buttonName );
- * @brief This method Updates the m_ButtonPanel for a panel
+ * @brief This method Updates the m_ButtonPanel to a panel
* of the clicked button in creaButtonContainer.
* @param buttonName
*/
/*! @fn void GenericButtonEvent( const std::string &buttonName );
* @brief This method is the function that calls the panels contained in the buttons
* (in creaButtonContainer is the function contained in the functors to be called back.
- * @param buttonName
+ * @param buttonName The name of the button
*/
void
GenericButtonEvent( const std::string &buttonName );
* @file structBCPSettings.h
* @brief Contains BCPSettingsStruct structure.
* @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date 2011-05-24
+ * @date 2011-06-02
*/
#ifndef STRUCTBCPSETTINGS_H_
git://git.creatis.insa-lyon.fr / creaMaracasVisu.git / commitdiff