Feature #1711 CreaDevManager application implementation

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

diff --git a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
index dd4e3664930710c7d637a80c8a93daf3c47497cb..8eee2eeeb8419877620a430b6bca8194e69a3cd7 100644 (file)
--- a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
+++ b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h
@@ -36,14 +36,27 @@
 #define WXCDMFILEDESCRIPTIONPANEL_H_
 
 #include <creaWx.h>
-#include <wx/panel.h>
+#include <wx/hyperlink.h>
 
 #include "modelCDMFile.h"
 
-class wxCDMFileDescriptionPanel : public wxPanel
+/**
+ * File description panel. Shows the File properties and the available options for it.
+ */
+class wxCDMFileDescriptionPanel : public wxScrolledWindow
 {
   DECLARE_EVENT_TABLE()
 public:
+  /**
+   * File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param file File 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.
+   */
   wxCDMFileDescriptionPanel(
       wxWindow* parent,
       modelCDMFile* file,
@@ -54,8 +67,22 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Destructor.
+   */
   ~wxCDMFileDescriptionPanel();
 
+  /**
+   * File description panel Constructor.
+   * @param parent Parent window reference.
+   * @param file File 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,
       modelCDMFile* file,
@@ -66,16 +93,32 @@ public:
       long style = wxDEFAULT_FRAME_STYLE
   );
 
+  /**
+   * Creates all the controls in the panel (property and action controls).
+   */
   void CreateControls();
 
 
 private:
+  /**
+   * File described.
+   */
   modelCDMFile* file;
 
   //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 containing folder button is pressed.
+   */
   void OnBtnOpenFolder(wxCommandEvent& event);
+  /**
+   * Handles when the Open with command button is pressed.
+   */
   void OnBtnOpenWithCommand(wxCommandEvent& event);
 
 };