# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL-B license and that you accept its terms.
# ------------------------------------------------------------------------
-*/
+ */
/*
#include "modelCDMLib.h"
+/**
+ * Lib Panel Help Dialog
+ */
class wxCDMLibHelpDialog : public wxDialog
{
DECLARE_EVENT_TABLE()
public:
+ /**
+ * Lib Panel Help Dialog Constructor.
+ * @param parent Parent window.
+ * @param lib Library class reference.
+ * @param id Dialog ID. By default wxID_ANY.
+ * @param caption Dialog label. By default "Managing Libraries".
+ * @param position Dialog position. By default wxDefaultPosition.
+ * @param size Dialog size. By default 350, 600.
+ * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+ */
wxCDMLibHelpDialog(
wxWindow* parent,
modelCDMLib* lib,
const wxSize& size = wxSize(350,600),
long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
);
+ /**
+ * Destructor.
+ */
~wxCDMLibHelpDialog();
+ /**
+ * Lib Panel Help Dialog Creator.
+ * @param parent Parent window.
+ * @param id Dialog ID. By default wxID_ANY.
+ * @param caption Dialog label. By default "Managing Libraries".
+ * @param position Dialog position. By default wxDefaultPosition.
+ * @param size Dialog size. By default 350, 600.
+ * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+ * @return if the creation was successful.
+ */
bool Create(
wxWindow* parent,
wxWindowID id = wxID_ANY,
);
protected:
+ /**
+ * Creates the help controls (text and buttons).
+ */
void CreateControls();
-//attributes
+ //attributes
private:
+ /**
+ * Lib class reference.
+ */
modelCDMLib* lib;
-//handlers
+ //handlers
protected:
+ /**
+ * Handler to close help dialog.
+ * @param event Unused.
+ */
void OnFinish(wxCommandEvent& event);
+ /**
+ * Handler when a cmakelists button is pressed.
+ * @param event cmakelists event.
+ */
void OnEditCMake(wxCommandEvent& event);
+ /**
+ * Handler when a cmakelists button is hovered.
+ * @param event cmakelists event.
+ */
void OnEditCMakeMouseEnter(wxMouseEvent& event);
+ /**
+ * Handler when a cmakelists button hover finishes.
+ * @param event cmakelists event.
+ */
void OnEditCMakeMouseExit(wxMouseEvent& event);
+ /**
+ * Handler when the disable help checkbox is changed.
+ * @param event check box event.
+ */
void OnDisableHelp(wxCommandEvent& event);
};