Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h
index b059a5cf441112a85c5b09157bffbbe91649ceff..630c7b402291c33c28cec307ba8acc9ae7479912 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h
@@ -41,10 +41,23 @@
 
 #include "modelCDMLib.h"
 
+/**
+ * Library manager description panel. Shows the available libraries in the project and the actions corresponding to library management.
+ */
 class wxCDMLibDescriptionPanel : public wxPanel
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * Library manager description panel Constructor.
+   * @param parent Parent window reference.
+   * @param lib Lib 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.
+   */
   wxCDMLibDescriptionPanel(
       wxWindow* parent,
       modelCDMLib* lib,
@@ -55,8 +68,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMLibDescriptionPanel();
 
+  /**
+   * Library manager description panel Creator.
+   * @param parent Parent window reference.
+   * @param lib Lib 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 was successful.
+   */
   bool Create(
       wxWindow* parent,
       modelCDMLib* lib,
@@ -67,19 +94,66 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 private:
+  /**
+   * Library manager described.
+   */
   modelCDMLib* lib;
 
   //handlers
 protected:
+  /**
+   * Handles when the create library button is pressed.
+   */
   void OnBtnCreateLibrary(wxCommandEvent& event);
+  /**
+   * Handles when the open package cmakelists file button is pressed.
+   */
   void OnBtnEditCMakeLists(wxCommandEvent& event);
+  /**
+   * Handles when a library checkbox is (un)checked.
+   * @param event Has the link reference to know which library was selected.
+   */
+  void OnChBLibraryChange(wxCommandEvent& event);
+  /**
+   * Handles when a library link is pressed.
+   * @param event Has the link reference to know which library was selected.
+   */
   void OnLnkLibrarySelect(wxHyperlinkEvent& event);
-  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 containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
 
+  /**
+   * Handles when a library link is hovered.
+   * @param event Has the link reference to know which library was selected.
+   */
+  void OnMouseEnter(wxMouseEvent& event);
+  /**
+   * Handles when a library link button finishes hover.
+   * @param event Has the link reference to know which library 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);
+
 };
 
 #endif /* WXCDMLIBDESCRIPTIONPANEL_H_ */