]> Creatis software - creaMaracasVisu.git/blobdiff - lib/maracasVisuLib/src/interface/wxWindows/widgets/creaButtonContainer/view/buttonContainerPanel.h
Code cleaning done
[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaButtonContainer / view / buttonContainerPanel.h
index c65c693691b5f10212f15abf13188b67eb37c62d..86dd513fd4bb5f44f634174ea13b8d0a73090322 100644 (file)
@@ -1,8 +1,33 @@
+/*# ---------------------------------------------------------------------
+ #
+ # 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 buttonContainerController.h
  * @brief This contains the ButtonContainerController class
  * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
- * @date  2011-05-19
+ * @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>
 
 #include "buttonGroup.h"
 #include "groupManager.h"
@@ -33,8 +60,7 @@ namespace creaButtonContainer
        {
                /*! @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;
@@ -46,13 +72,13 @@ namespace creaButtonContainer
         */
        namespace view
        {
-               /*! @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.
-                *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledWindow.html">wxScrolledWindow</a>
+               /*! @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.
+                *  @bug The scrolled it doesn't work! (to be changed soon)
+                *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxscrolledwindow.html">wxScrolledWindow</a>
                 */
-               class ButtonContainerPanel : public wxScrolledWindow
+               class ButtonContainerPanel: public wxScrolledWindow
                {
                        public:
                                //typedef definition
@@ -70,12 +96,12 @@ namespace creaButtonContainer
                                /*!     @typedef std::list< ButtonGroup* > ButtonGroupList;
                                 *      @brief Defines the ButtonGroupList type.
                                 */
-                               typedef std::list< ButtonGroup* > ButtonGroupList;
+                               typedef std::list<ButtonGroup*> ButtonGroupList;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef std::map< long, GroupManager* > GroupManagerList;
                                 *      @brief Defines the GroupManagerList type.
                                 */
-                               typedef std::map< long, GroupManager* > GroupManagerList;
+                               typedef std::map<long, GroupManager*> GroupManagerList;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef wxFlexGridSizer Sizer;
                                 *      @brief Defines the Sizer type.
@@ -85,25 +111,23 @@ namespace creaButtonContainer
                                /*!     @typedef std::list< long > KeyList;
                                 *      @brief Defines the KeyList type.
                                 */
-                               typedef std::list< long > KeyList;
+                               typedef std::list<long> KeyList;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
                                 *      @brief Defines the ButtonGroupSettings type.
                                 */
-                               typedef creaButtonContainer::model::ContainerSettings
-                                   ButtonGroupSettings;
+                               typedef creaButtonContainer::model::ContainerSettings ButtonGroupSettings;
                                // ----------------------------------------------------------------------------------
                                /*!     @typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory;
                                 *      @brief Defines the ButtonGroupFactory type.
                                 */
-                               typedef creaButtonContainer::model::ButtonGroupFactory
-                                   ButtonGroupFactory;
+                               typedef creaButtonContainer::model::ButtonGroupFactory ButtonGroupFactory;
                                // ----------------------------------------------------------------------------------
                                /*!     creaButtonContainer::controller::ButtonContainerController BCController;
                                 *      @brief Defines the BCController type.
                                 */
-                               typedef creaButtonContainer::controller::ButtonContainerController
-                                   BCController;
+                               typedef creaButtonContainer::controller::ButtonContainerController BCController;
+
                                // ----------------------------------------------------------------------------------
                                //end of typedef definition
                        public:
@@ -112,32 +136,37 @@ namespace creaButtonContainer
                                 * @param parent wxWindow pointer to parent.
                                 * @param settings ButtonGroupSettings Pointer to button container settings.
                                 */
-                               ButtonContainerPanel( wxWindow* parent, ButtonGroupSettings* settings );
+                               ButtonContainerPanel(wxWindow* parent, ButtonGroupSettings* settings);
                                // ----------------------------------------------------------------------------------
                                /*! @fn ~ButtonContainerPanel( );
                                 * @brief This is the destructor.
                                 */
                                virtual
-                               ~ButtonContainerPanel( );
+                               ~ButtonContainerPanel();
                                // ----------------------------------------------------------------------------------
                                /*! @fn SetGroupContainer( ButtonGroupList groupContainer );
-                                * @brief This function sets the settings to the container.
+                                * @brief This method sets the settings to the container.
                                 * @param groupContainer
                                 */
                                void
-                               SetGroupContainer( ButtonGroupList groupContainer );
+                               SetButtonGroupContainer(ButtonGroupList groupContainer);
                                // ----------------------------------------------------------------------------------
                                /*! @fn PanelInit( );
-                                *      This function initializes the panel.
+                                *      This method initializes the panel.
+                                *      @exception std::bad_alloc
                                 */
                                void
-                               PanelInit( );
+                               PanelInit();
+                               // ----------------------------------------------------------------------------------
+
+                               //void
+                               //SetListGroupContainer(ListGroupList groupContainer );
                                // ----------------------------------------------------------------------------------
                                /*! @fn FitSizer( );
-                                * This function fits and organizes the sizer.
+                                * This method fits and organizes the sizer.
                                 */
                                void
-                               FitSizer( );
+                               FitSizer();
                                // ----------------------------------------------------------------------------------
                        public:
                                friend class creaButtonContainer::controller::ButtonContainerController;
@@ -146,8 +175,11 @@ namespace creaButtonContainer
                                ButtonGroupList m_ButtonGroupList; //!<The list of button groups.
                                BCController* m_ButtonCController; //!<Pontier to controller.
                                Sizer* m_Sizer; //!<Pointer to wxSizer
+
+                               DECLARE_EVENT_TABLE()
+                               //!<Event Table declaration.
                };
-       }//ecapseman
-}//ecapseman
+       } //ecapseman
+} //ecapseman
 
 #endif // BUTTONCONTAINERPANEL_H