X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2FgroupManager.h;h=7c9539dd4c4ed5c4df53101b319cd3e78acc99bf;hb=47d49bceea4f93ff4f57c40596960d042171abb4;hp=562da7ae0b82346f6f8b6f0f11f54c92a38cd92c;hpb=4b092ee0b1bcda4d298e5ffc3b58b599e273db20;p=creaMaracasVisu.git diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h index 562da7a..7c9539d 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/groupManager.h @@ -1,11 +1,34 @@ -/*************************************************************** - * 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: - **************************************************************/ +/*# --------------------------------------------------------------------- + # + # 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 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 @@ -13,48 +36,118 @@ #include #include #include + #include +#include +#include + #include "buttonManager.h" #include "buttonGroup.h" -#include +/*! @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 creaButtonContainer::view::ButtonGroup ButtonGroup; - typedef wxButton ExpansionButton; - /** - Class Description: - **/ - class GroupManager : public wxFlexGridSizer + /*! @class GroupManager groupManager.h "groupManager.h" + * @brief This class contains the GroupManager. + * @details This class describes a wxFlexGridSizer with the group manager. + * @see wxFlexGridSizer + */ + class GroupManager: public wxFlexGridSizer { public: - GroupManager( wxWindow* parent, ButtonGroup* buttonGroup ); + //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 + ~GroupManager(); + // ---------------------------------------------------------------------------------- + /*! @fn GetButtonID( ); + * @brief This method returns the Button ID. + * @return + */ long - GetButtonID( ); + GetButtonID(); + // ---------------------------------------------------------------------------------- + /*! @fn GetButton( ); + * @brief This method returns the expansion button. + * @return + */ ExpansionButton* - GetButton( ); + GetButton(); + // ---------------------------------------------------------------------------------- + /*! @fn GetButtonManager( ); + * @brief This method returns the manager of the buttons. + * @return + */ ButtonManager* - GetButtonManager( ); + GetButtonManager(); + // ---------------------------------------------------------------------------------- + /*! @fn SetButtonID( long id ); + * @brief This method sets the ID of the expansion button. + * @param id + */ void - SetButtonID( long id ); + SetButtonID(long id); + // ---------------------------------------------------------------------------------- + /*! @fn SetButton( ExpansionButton* button ); + * @brief This method sets the expansion button. + * @param button + */ void - SetButton( ExpansionButton* button ); + SetButton(ExpansionButton* button); + // ---------------------------------------------------------------------------------- + /*! @fn SetButtonManager( ButtonManager* manager ); + * @brief This method Sets the ButtonManager + * @param manager A pointer with the manager. + */ void - SetButtonManager( ButtonManager* manager ); + 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 ); + HideSubPanel(bool hide); private: - long m_IDExpButton; - ExpansionButton* m_ExpansionButton; - ButtonManager* m_ButtonManager; + long m_IDExpButton; //!