]> Creatis software - creaMaracasVisu.git/blobdiff - lib/maracasVisuLib/src/interface/wxWindows/widgets/creaPanelButtonContainer/creaPanelButtonContainer.h
#2532 creaMaracasVisu Feature New Normal - creaPanelButtonContainer All List Contain...
[creaMaracasVisu.git] / lib / maracasVisuLib / src / interface / wxWindows / widgets / creaPanelButtonContainer / creaPanelButtonContainer.h
index d49ac59233d4a230d29cdd6da8411993643a0f28..24e7e783733685512ef26868a8c52c14db652547 100644 (file)
@@ -1,11 +1,34 @@
-/***************************************************************
- * Name:      pCartoGUIManager.h
- * Purpose:   Defines Application Frame
- * 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 PanelButtonContainer
+ * @brief This contains the ButtonContainerSettings class.
+ * @author Diego CACERES (diego.caceres[AT]creatis.insa-lyon.fr)
+ * @date  2011-06-02
+ */
 
 #ifndef PANELBUTTONCONTAINER_H_
 #define PANELBUTTONCONTAINER_H_
 #include <wx/panel.h>
 #include <wx/aui/aui.h>
 #include <string>
+#include <wx/gdicmn.h>
+#include <wx/gbsizer.h>
+#include <wx/bmpbuttn.h>
 
+#include "listConfigDialog.h"
 #include "containerSettings.h"
 #include "buttonContainerPanel.h"
 #include "buttonContainerSettings.h"
 #include "functor.h"
+#include "listWx.h"
+#include "Settings.xpm"
 
+/*!    @namespace <creaPanelButtonContainer>
+ *     @brief Contains the creaPanelButtonContainer library included in creaMaracasVisu.
+ */
 namespace creaPanelButtonContainer
 {
-
-       typedef creaPanelButtonContainer::ButtonContainerSettings
-           ButtonContainerSettings;
-       typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
-       class PanelButtonContainer : public wxPanel
+       /*! @class PanelButtonContainer panelButtonContainer.h "panelButtonContainer.h"
+        *      @brief This class contains the PanelButtonContainer. It derives from wxPanel.
+        *  @see <a href="http://docs.wxwidgets.org/stable/wx_wxpanel.html">wxPanel</a>
+        */
+       class PanelButtonContainer: public wxPanel
        {
                public:
-                       PanelButtonContainer( wxWindow* parent,
-                           ButtonContainerSettings* bcSettings );
+                       //typedef definition.
+                       // ----------------------------------------------------------------------------------
+                       /*!     typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
+                        *      @brief Defines the ButtonContainerSettings type.
+                        */
+                       typedef creaPanelButtonContainer::ButtonContainerSettings ButtonContainerSettings;
+                       /*!     typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+                        *      @brief Defines the ButtonContainerPanel type.
+                        */
+                       typedef creaButtonContainer::view::ButtonContainerPanel ButtonContainerPanel;
+
+                       //MLER
+                       /*!     typedef creaButtonContainer::view::ListWx ListWx;
+                        *      @brief Defines a ListWx for (Configurable) List Container.
+                        *      This class inherits from wxPanel and contains a wxListBox.
+                        */
+                       typedef creaButtonContainer::view::ListWx ListWx;
+                       /*!     typedef creaPanelButtonContainer::ListConfigDialog ListConfigDialog;
+                        *      @brief Defines a ListConfigPanel to configure.
+                        *      This class inherits from wxDialog and contains the wxListBox and wxButton.
+                        */
+                       typedef creaButtonContainer::view::ListConfigDialog ListConfigDialog;
+                       // ----------------------------------------------------------------------------------
+                       //End MLER
+               //end of typedef definition.
+               public:
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn PanelButtonContainer( wxWindow* parent, ButtonContainerSettings* bcSettings );
+                        *      @brief This is the parameterized constructor.
+                        *      @param parent The wxWindow pointer to parent
+                        *      @param bcSettings //The buttonContainerSettings
+                        */
+                       PanelButtonContainer(wxWindow* parent,
+                                       ButtonContainerSettings* bcSettings, int type);
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn virtual PanelButtonContainer( );
+                        *      @brief This is the destructor.
+                        */
                        virtual
-                       ~PanelButtonContainer( );
+                       ~PanelButtonContainer();
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn void UpdatePanel( const std::string &buttonName );
+                        *  @brief This method Updates the m_EventPanel to a panel
+                        *  of the clicked button in creaButtonContainer.
+                        *      @param buttonName
+                        */
+                       void
+                       UpdatePanel(const std::string &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 The name of the button
+                        */
+                       void
+                       GenericButtonEvent(const std::string &buttonName);
+                       // ----------------------------------------------------------------------------------
+                       //MLER
+                       /*! @fn void GenericListEvent( const std::string &buttonName );
+                        *      @brief This method is the function that calls the panels contained in the items list.
+                        *      (in creaButtonContainer is the function contained in the functors to be called back.
+                        *      @param buttonName The name of the button (item list)
+                        */
                        void
-                       UpdatePanel( const std::string &buttonName );
+                       GenericListEvent(const std::string &buttonName);
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn void UpdateListPanel( const std::string &buttonName );
+                        *  @brief This method Updates the m_EventPanel to a panel
+                        *  of the clicked an item in creaButtonContainer.
+                        *      @param buttonName The name of the button (item list)
+                        */
                        void
-                       GenericButtonEvent( const std::string &buttonName );
+                       UpdateListPanel(const std::string &buttonName);
+                       // ----------------------------------------------------------------------------------
+                       /*! @fn void OnConfigButton( wxCommandEvent& event );
+                        *  @brief This method calls the wxDialog when
+                        *  the config button is clicked.
+                        *      @param event
+                        */
+                       void
+                       OnConfigButton(wxCommandEvent& event);
+                       //End MLER
+                       // ----------------------------------------------------------------------------------
                private:
                        //Settings
-                       ButtonContainerSettings* m_ButtonContainerSettings;
+                       ButtonContainerSettings* m_ButtonContainerSettings; //!<This is the buttonContainer settings.
+
                        //Panel
-                       ButtonContainerPanel* m_ButtonContainerPanel;
-                       wxAuiManager* m_AuiManager;
-                       wxPanel* m_ButtonPanel;
+                       ButtonContainerPanel* m_ButtonContainerPanel; //!<This is the panel with of buttons (creaButtonContainer)
+                       wxAuiManager* m_AuiManager; //!<The AUI Manager for the panels.
+                       wxPanel* m_EventPanel; //!<This is the panel used to contain the panels of the buttons. (it changes with the buttonAction)
+
+                       //MLER
+                       ListWx* m_ListWxPanel;//!<This panel contains the list of the elements.
+                       ListConfigDialog* m_ListConfigDialog;//!<This wxDialog shows the list of the elements and allows  modifications.
+
+                       wxPanel* m_PanelUp;//!<This panel contains the list of the elements empty,full and the config button.
+                       wxPanel* m_EmptyPanel; //!<This panel is empty.
+                       ListWx* m_CurrentWxPanel;//!<This panel contains the final list of the elements .
+
+                       wxBitmapButton* m_ConfigButton;//!< "Config" Settings button.
+                       //End MLER
+
+                       DECLARE_EVENT_TABLE()
+                       //!<Event Table declaration.
        };
-}//ecapseman
+} //ecapseman
 
 #endif // PANELBUTTONCONTAINER_H_