Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h
index 2a1a9fe8ca46cb8a027b373860ff911b46520a39..99c8f59944c4b2c0967a2ae6442717f137d97111 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMAppli.h"
 
+/**
+ * Application manager description panel. Shows the available applications in the project and the actions corresponding to application management.
+ */
 class wxCDMAppliDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Application manager description panel Constructor.
+   * @param parent Parent window reference.
+   * @param appli Application manager 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.
+   */
   wxCDMAppliDescriptionPanel(
       wxWindow* parent,
       modelCDMAppli* appli,
@@ -57,6 +70,17 @@ public:
 
   ~wxCDMAppliDescriptionPanel();
 
+  /**
+   * Application manager description panel Creator.
+   * @param parent Parent window reference.
+   * @param appli Application manager 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,
       modelCDMAppli* appli,
@@ -67,22 +91,64 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Application manager described.
+   */
   modelCDMAppli* appli;
 
   //handlers
 protected:
+  /**
+   * Handles when the create application button is pressed.
+   */
   void OnBtnCreateApplication(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when a application checkbox is (un)checked.
+   * @param event Has the link reference to know which application was selected.
+   */
+  void OnChBApplicationChange(wxCommandEvent& event);
+  /**
+   * Handles when an application link is pressed.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnLnkApplicationSelect(wxHyperlinkEvent& 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 folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 
+  /**
+   * Handles when a application link is hovered.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a application link button finishes hover.
+   * @param event Has the link reference to know which application was selected.
+   */
   void OnMouseExit(wxMouseEvent& 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);
 
 };