X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2FbuttonGroup.h;h=386be4b5f6729c562c03f9e87d986ad174e60b22;hb=HEAD;hp=920dfd260c997c763b178566ed485531aae8aa41;hpb=4b092ee0b1bcda4d298e5ffc3b58b599e273db20;p=creaMaracasVisu.git diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h index 920dfd2..386be4b 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonGroup.h @@ -1,51 +1,129 @@ -/*************************************************************** - * Name: ButtonGroup.h - * Purpose: Defines a group of buttons in wxWidgets - * Author: Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) - * Modified: 2011-05-09 - * Copyright: Diego CACERES (http://www.creatis.insa-lyon.fr/~caceres/) - * License: - **************************************************************/ +/*# --------------------------------------------------------------------- +# +# Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image +# pour la Sant�) +# Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton +# Previous Authors : Laurent Guigues, Jean-Pierre Roux +# CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil +# +# This software is governed by the CeCILL-B license under French law and +# abiding by the rules of distribution of free software. You can use, +# modify and/ or redistribute the software under the terms of the CeCILL-B +# license as circulated by CEA, CNRS and INRIA at the following URL +# http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html +# or in the file LICENSE.txt. +# +# As a counterpart to the access to the source code and rights to copy, +# modify and redistribute granted by the license, users are provided only +# with a limited warranty and the software's author, the holder of the +# economic rights, and the successive licensors have only limited +# liability. +# +# The fact that you are presently reading this means that you have had +# 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 BUTTONGROUP_H #define BUTTONGROUP_H //Library Definition +#include + #include #include -#include +#include #include "button.h" +/*! @namespace + * @brief Contains the creaButtonContainer library included in creaMaracasVisu. + */ namespace creaButtonContainer { + /*! @namespace + * @brief Contains the implementation of the view in creaButtonContainer library. + * @see MVC Software Architecture + */ namespace view { - //Typedef definition - typedef creaButtonContainer::view::Button Button; - typedef std::map< long, Button* > ButtonContainer; - typedef std::list< long > IdButtonContainer; - - /** - Class Description: This class defines a ButtonGroup. - **/ + /*! @class ButtonGroup buttonGroup.h "buttonGroup.h" + * @brief This class contains the group of buttons. + */ class ButtonGroup { public: + //Typedef definition + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::view::Button Button; + * @brief Defines the Button type. + */ + typedef creaButtonContainer::view::Button Button; + // ---------------------------------------------------------------------------------- + /*! @typedef std::map< long, Button* > ButtonContainer; + * @brief Defines the ButtonContainer type. + */ + typedef std::map< long, Button* > ButtonContainer; + // ---------------------------------------------------------------------------------- + /*! typedef std::list< long > IdButtonContainer; + * @brief Defines the IdButtonContainer type. + */ + typedef std::list< long > IdButtonContainer; + public: + // ---------------------------------------------------------------------------------- + /*! @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. + */ ButtonGroup( wxStaticText* groupName, ButtonContainer buttons ); + // ---------------------------------------------------------------------------------- + /*! @fn ~ButtonGroup( ); + * @brief This is the destructor. + */ virtual ~ButtonGroup( ); + // ---------------------------------------------------------------------------------- + /*! @fn GetButton( long id ); + * @brief This method returns a Button* + * @param id The ID of the button. + * @return Button* + */ Button* GetButton( long id ); + // ---------------------------------------------------------------------------------- + /*! @fn GetButtonContainer( ); + * @brief This method returns the button container. + * @exception std::bad_alloc + * @return ButtonContainer. + */ ButtonContainer GetButtonContainer( ); + // ---------------------------------------------------------------------------------- + /*! @fn GetButtonIdContainer( ); + * @brief This method returns a list of button IDs. + * @exception std::bad_alloc + * @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; //!