X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FmaracasVisuLib%2Fsrc%2Finterface%2FwxWindows%2Fwidgets%2FcreaButtonContainer%2Fview%2Fbutton.h;h=b7a8fb6093a95b6d3ab7427ee33cd32d7a063367;hb=b2ac7f59e78e33f8e11065cffa2f2072aa9a9ee5;hp=ea30b2024bf45340c1eb49faa4fb4a4db41e0f31;hpb=ab19f727dc01a9995b16b2a3c82783050728233e;p=creaMaracasVisu.git diff --git a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h index ea30b20..b7a8fb6 100644 --- a/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h +++ b/lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/button.h @@ -1,97 +1,139 @@ -/************************************************************************************//*! - * Name: @file button.h - * Purpose: @brief This contains the Button class - * Author: @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) - * Modified: 2011-05-18 - * Copyright: - * 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 button.h + * @brief Contains the Button class. + * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr) + * @date 2011-06-02 + */ #ifndef BUTTON_H #define BUTTON_H -//! @include #include -//! @include < #include -//! @include #include -//! @include -#include -//! @include -#include -//! @include "functor.h" -#include "functor.h" -//! @include "system.h" +#include + #include "system.h" -//! @namespace +/*! @namespace + * @brief Contains the creaButtonContainer library included in creaMaracasVisu. + */ namespace creaButtonContainer { - //! @namespace + /*! @namespace + * @brief Contains the implementation of the view in creaButtonContainer library. + * @see MVC Software Architecture + */ namespace view { - /*! @class ContainerSettings containerSettings.h "containerSettings.h" - * @brief This class contains the settings of the button container. - * This class describes how to add new buttons to the container. + /*! @class Button button.h "button.h" + * @brief This class contains the Button in the view perspective. + * @details This class contains the information of a button, it derives from wxBitmapButton. + * @see wxBitmapButton */ class Button : public wxBitmapButton { public: - /*! @typedef creaButtonContainer::model::ContainerSettings ButtonGroupModel; - * @brief Defines the ButtonGroupModel type. + //typedef definition + // ---------------------------------------------------------------------------------- + /*! @typedef creaButtonContainer::model::TFunctor TFunctor; + * @brief Defines the TFunctor type. */ typedef creaButtonContainer::model::TFunctor TFunctor; + // ---------------------------------------------------------------------------------- + //end of typedef definition public: + // ---------------------------------------------------------------------------------- - /*! @fn void ContainerSettings::ContainerSettings( ) + /*! @fn Button::Button( wxWindow* parent, long id, ButtonPair* pair ); * @brief This is the constructor. + * @param parent The wxWindow* parent. + * @param id The wxID of the button. + * @param pair The button information. */ Button( wxWindow* parent, long id, ButtonPair* pair ); // ---------------------------------------------------------------------------------- - /*! @fn void ContainerSettings::ContainerSettings( ) - * @brief This is the constructor. + /*! @fn virtual Button::~Button( ); + * @brief This is the destructor. */ virtual ~Button( ); // ---------------------------------------------------------------------------------- - /*! @fn KeyMapList ContainerSettings::GetGroupNameList( ) - * @brief This function returns a container with the name of the groups. - * @return KeyMapList A list with the name of the button groups. + /*! @fn long Button::GetID( ); + * @brief This method gets the wxID of the button. + * @return long wxID of the button. */ long GetID( ); // ---------------------------------------------------------------------------------- - /*! @fn KeyMapList ContainerSettings::GetGroupNameList( ) - * @brief This function returns a container with the name of the groups. - * @return long A list with the name of the button groups. + /*! @fn std::string Button::GetButtonName( ); + * @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. + */ + BitmapType + GetIcon( ); + // ---------------------------------------------------------------------------------- - /*! @fn KeyMapList ContainerSettings::GetGroupNameList( ) - * @brief This function returns a container with the name of the groups. - * @return std::string A list with the name of the button groups. + /*! @fn std::string Button::GetIconPath( ); + * @brief This method returns the iconPath of the button. + * @return std::string The path of the icon. */ - std::string - GetIconPath( ); + //StringType + //GetIconPath( ); // ---------------------------------------------------------------------------------- - /*! @fn KeyMapList ContainerSettings::GetGroupNameList( ) - * @brief This function returns a container with the name of the groups. - * @return std::string A list with the name of the button groups. + /*! @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 KeyMapList ContainerSettings::GetGroupNameList( ) - * @brief This function returns a container with the name of the groups. - * @return std::string A list with the name of the button groups. + /*! @fn void Button::Execute( ); + * @brief This method executes the Functor (Call_Back Function). + * This is the event of the button that it was defined to be called remotely using + * call_back functions. In this project it was implemented using Functors. + * @exception std::bad_alloc + * @see TFunctor */ void Execute( ); // ---------------------------------------------------------------------------------- private: - ButtonPair* m_ButtonPair; //!