#include "wxCDMProjectDescriptionPanel.h"
+/**
+ * Project Panel Help Dialog
+ */
class wxCDMProjectHelpDialog : public wxDialog
{
DECLARE_EVENT_TABLE()
public:
+ /**
+ * Project Panel Help Dialog Constructor.
+ * @param parent Parent window.
+ * @param project Project class reference.
+ * @param id Dialog ID. By default wxID_ANY.
+ * @param caption Dialog label. By default "Project Ready".
+ * @param position Dialog position. By default wxDefaultPosition.
+ * @param size Dialog size. By default 350, 700.
+ * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER.
+ */
wxCDMProjectHelpDialog(
wxWindow* parent,
- wxCDMProjectDescriptionPanel* projectDescription,
+ modelCDMProject* project,
wxWindowID id = wxID_ANY,
const wxString& caption = wxT("Project Ready"),
const wxPoint& position = wxDefaultPosition,
- const wxSize& size = wxSize(350,550),
+ const wxSize& size = wxSize(350,730),
long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER
);
+ /**
+ * Destructor.
+ */
~wxCDMProjectHelpDialog();
+ /**
+ * Project Panel Help Dialog Creator.
+ * @param parent Parent window.
+ * @param id Dialog ID. By default wxID_ANY.
+ * @param caption Dialog label. By default "Project Ready".
+ * @param position Dialog position. By default wxDefaultPosition.
+ * @param size Dialog size. By default 350, 700.
+ * @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,
const wxString& caption = wxT("Project Ready"),
const wxPoint& position = wxDefaultPosition,
- const wxSize& size = wxSize(350,550),
+ const wxSize& size = wxSize(350,730),
long style = wxDEFAULT_DIALOG_STYLE
);
protected:
+ /**
+ * Creates the help controls (text and buttons).
+ */
void CreateControls();
//attributes
private:
- wxCDMProjectDescriptionPanel* projectDescription;
+ /**
+ * Project class reference.
+ */
+ modelCDMProject* project;
//handlers
protected:
+ /**
+ * Handler to close help dialog.
+ * @param event Unused.
+ */
void OnFinish(wxCommandEvent& event);
- void OnManagePackages(wxCommandEvent& event);
- void OnManageLibraries(wxCommandEvent& event);
- void OnManageApplications(wxCommandEvent& event);
-
- void OnAppliMouseEnter(wxMouseEvent& event);
- void OnAppliMouseExit(wxMouseEvent& event);
- void OnLibMouseEnter(wxMouseEvent& event);
- void OnLibMouseExit(wxMouseEvent& event);
-
+ /**
+ * Handler when the disable help checkbox is changed.
+ * @param event Check box event.
+ */
void OnDisableHelp(wxCommandEvent& event);
};