X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=lib%2FcreaDevManagerLib%2FwxCDMFolderDescriptionPanel.h;h=fafe66ed5cfd2985b3d25900cfa8a1369d7511b9;hb=741b9c1d03c7984f7ac4a39188e2bb114471f579;hp=e273114db8d0aa726b95f915d70cf46bb68f8a73;hpb=5af1633cdea030f5189c57c51bd843685eecd8b6;p=crea.git

diff --git a/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h
index e273114..fafe66e 100644
--- a/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h
@@ -37,13 +37,27 @@
 
 #include <creaWx.h>
 #include <wx/panel.h>
+#include <wx/hyperlink.h>
 
 #include "modelCDMFolder.h"
 
+/**
+ * Folder description panel. Shows the properties of the referenced folder and the available actions.
+ */
 class wxCDMFolderDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Folder description panel Constructor.
+   * @param parent Parent window reference.
+   * @param folder Folder 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.
+   */
   wxCDMFolderDescriptionPanel(
       wxWindow* parent,
       modelCDMFolder* folder,
@@ -54,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMFolderDescriptionPanel();
 
+  /**
+   * Folder description panel Creator.
+   * @param parent Parent window reference.
+   * @param folder Folder 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 creation is successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMFolder* folder,
@@ -66,20 +94,48 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Folder described.
+   */
   modelCDMFolder* folder;
 
   //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 package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when the create class button is pressed.
+   */
   void OnBtnCreateClass(wxCommandEvent& event);
+  /**
+   * Handles when the create folder button is pressed.
+   */
   void OnBtnCreateFolder(wxCommandEvent& event);
+  /**
+   * Handles when the open in explorer button is pressed.
+   */
   void OnBtnOpenInExplorer(wxCommandEvent& event);
 
+  /**
+   * Handles when the open cmakelists file button is hovered.
+   */
   void OnCMakeMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when the open cmakelists file button finishes hover.
+   */
   void OnCMakeMouseExit(wxMouseEvent& event);
 
 };