Feature #1711 CreaDevManager application implementation

[crea.git] / lib / creaDevManagerLib / wxCDMMainDescriptionPanel.h

diff --git a/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h
index d2f12872ece56cbc02128a9cb9f6aea2694942ba..08490f77a45c4141a4ead2cec04ad1159445ad1d 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h
@@ -2,8 +2,10 @@
 # ---------------------------------------------------------------------
 #
 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
-#                        pour la Santé)
+#                        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, 
@@ -20,25 +22,38 @@
 #
 #  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.
-# ------------------------------------------------------------------------ */ 
+# ------------------------------------------------------------------------ 
+*/ 
 
 
 /*
  * wxCDMMainDescriptionPanel.h
  *
  *  Created on: 13/11/2012
- *      Author: daniel
+ *      Author: Daniel Felipe Gonzalez Obando
  */
 
 #ifndef WXCDMMAINDESCRIPTIONPANEL_H_
 #define WXCDMMAINDESCRIPTIONPANEL_H_
 
 #include <creaWx.h>
-#include <wx/panel.h>
-
-class wxCDMMainDescriptionPanel : public wxPanel
+/**
+ * Main View description panel. Shows the welcome message and allows to open or create Crea projects.
+ */
+class wxCDMMainDescriptionPanel : public wxScrolledWindow
 {
+  DECLARE_EVENT_TABLE()
+
 public:
+  /**
+   * Main description panel Constructor.
+   * @param parent Parent window reference.
+   * @param id Panel ID. By default -1.
+   * @param caption Panel label. By default "Description Frame".
+   * @param pos Panel position. By default wxDefaultPosition.
+   * @param size Panel size. By default wxDefaultSize.
+   * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
+   */
     wxCDMMainDescriptionPanel(
         wxWindow* parent,
         wxWindowID id = -1,
@@ -48,8 +63,20 @@ public:
         long style = wxDEFAULT_FRAME_STYLE
     );
 
+    /**
+     * Destructor.
+     */
     ~wxCDMMainDescriptionPanel();
 
+    /**
+     * Main description panel Constructor.
+     * @param parent Parent window reference.
+     * @param id Panel ID. By default -1.
+     * @param caption Panel label. By default "Description Frame".
+     * @param pos Panel position. By default wxDefaultPosition.
+     * @param size Panel size. By default wxDefaultSize.
+     * @param style Panel style. By default wxDEFAULT_FRAME_STYLE.
+     */
     bool Create(
         wxWindow* parent,
         wxWindowID id = -1,
@@ -59,11 +86,20 @@ public:
         long style = wxDEFAULT_FRAME_STYLE
     );
 
+    /**
+     * Creates all the controls in the panel (property and action controls).
+     */
     void CreateControls();
 
 //handlers
 protected:
+    /**
+     * Handles when the create new project button is pressed.
+     */
     void OnBtnNewProject(wxCommandEvent& event);
+    /**
+     * Handles when the open project button is pressed.
+     */
     void OnBtnOpenProject(wxCommandEvent& event);
 };