X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FwxCDMCMakeListsDescriptionPanel.h;h=e2ca8426dbd19de847ca558c0febc34542bc348a;hb=ef630179c0efdb37f43994958b727f585cf2c3ec;hp=b37d338b07c3cb0ba35d88b812f7bc7c63992bde;hpb=63de854d3d1085c92883328a6fb728d6e5dd2fa4;p=crea.git

diff --git a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
index b37d338..e2ca842 100644
--- a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h
@@ -36,14 +36,27 @@
 #define WXCDMCMAKELISTSDESCRIPTIONPANEL_H_
 
 #include <creaWx.h>
-#include <wx/panel.h>
+#include <wx/hyperlink.h>
 
 #include "modelCDMCMakeListsFile.h"
 
-class wxCDMCMakeListsDescriptionPanel : public wxPanel
+/**
+ * CMakeLists File description panel. Shows the file properties and the available actions for it.
+ */
+class wxCDMCMakeListsDescriptionPanel : public wxScrolledWindow
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * CMakeLists File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param makefile CMakeLists class 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.
+   */
   wxCDMCMakeListsDescriptionPanel(
       wxWindow* parent,
       modelCDMCMakeListsFile* makefile,
@@ -54,11 +67,25 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMCMakeListsDescriptionPanel();
 
+  /**
+   * CMakeLists File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param makefile CMakeLists class 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.
+   * @return True if the creation was successful.
+   */
   bool Create(
       wxWindow* parent,
-      modelCDMCMakeListsFile* blackBox,
+      modelCDMCMakeListsFile* makefile,
       wxWindowID id = -1,
       const wxString& caption = _("Description Frame"),
       const wxPoint& pos = wxDefaultPosition,
@@ -66,15 +93,31 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * CMakeLists file described.
+   */
   modelCDMCMakeListsFile* cMakeLists;
 
   //handlers
 protected:
-  void OnBtnReturn(wxCommandEvent& event);
+  /**
+   * Handles when a return link is pressed.
+   * @param event Has the link reference to know where to return
+   */
+  void OnBtnReturn(wxHyperlinkEvent& event);
+  /**
+   * Handles when the open file in text editor button is pressed.
+   */
   void OnBtnOpenInEditor(wxCommandEvent& event);
+  /**
+   * Handles when the open containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 };