From: Daniel Gonzalez Date: Mon, 21 Jan 2013 09:06:13 +0000 (+0100) Subject: Feature #1711 X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=a914149ded6f527f542cf13082103ce328932ae8;p=crea.git Feature #1711 CreaDevManager application implementation - View Help Classes documented. --- diff --git a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h index e788468..21cf046 100644 --- a/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMAppliHelpDialog.h @@ -41,45 +41,91 @@ #include "modelCDMAppli.h" +/** + * Appli Panel Help Dialog + */ class wxCDMAppliHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Appli Panel Help Dialog Constructor. + * @param parent Parent window. + * @param appli Appli class reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Managing Applications". + * @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. + */ wxCDMAppliHelpDialog( wxWindow* parent, modelCDMAppli* appli, wxWindowID id = wxID_ANY, - const wxString& caption = wxT("Managing Packages"), + const wxString& caption = wxT("Managing Applications"), const wxPoint& position = wxDefaultPosition, const wxSize& size = wxSize(350,600), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMAppliHelpDialog(); + /** + * Appli Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Managing Applications". + * @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. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, - const wxString& caption = wxT("Managing Packages"), + const wxString& caption = wxT("Managing Applications"), const wxPoint& position = wxDefaultPosition, const wxSize& size = wxSize(350,600), long style = wxDEFAULT_DIALOG_STYLE ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); //attributes private: + /** + * Appli class reference. + */ modelCDMAppli* appli; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnEditCMake(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnCMakeListsEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnCMakeListsExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h index 084c181..0d891d0 100644 --- a/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMApplicationHelpDialog.h @@ -23,7 +23,7 @@ # 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. # ------------------------------------------------------------------------ -*/ + */ /* @@ -43,10 +43,23 @@ #include +/** + * Application Panel Help Dialog + */ class wxCDMApplicationHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Application Panel Help Dialog Constructor. + * @param parent Parent window. + * @param application Application class reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Applications". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 670. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMApplicationHelpDialog( wxWindow* parent, modelCDMApplication* application, @@ -56,7 +69,19 @@ public: const wxSize& size = wxSize(410,670), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMApplicationHelpDialog(); + /** + * Application Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Applications". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 670. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -67,20 +92,41 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); private: + /** + * Application class reference. + */ modelCDMApplication* application; -//handlers + //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnCMakeLists(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnCMakeListsEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnCMakeListsExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h index 40fca32..25438c6 100644 --- a/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMBlackBoxHelpDialog.h @@ -43,10 +43,23 @@ #include +/** + * Black Box Panel Help Dialog + */ class wxCDMBlackBoxHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Black Box Panel Help Dialog Constructor. + * @param parent Parent window. + * @param blackBox Black Box class reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Black Boxes". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 700. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMBlackBoxHelpDialog( wxWindow* parent, modelCDMBlackBox* blackBox, @@ -56,7 +69,19 @@ public: const wxSize& size = wxSize(410,700), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMBlackBoxHelpDialog(); + /** + * Black Box Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Black Boxes". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 700. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -67,20 +92,41 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); private: + /** + * Black Box class reference. + */ modelCDMBlackBox* blackBox; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnCMakeLists(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnCMakeListsEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnCMakeListsExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h index 59a000f..5620dc9 100644 --- a/lib/creaDevManagerLib/wxCDMLibHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMLibHelpDialog.h @@ -23,7 +23,7 @@ # 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. # ------------------------------------------------------------------------ -*/ + */ /* @@ -41,10 +41,23 @@ #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, @@ -54,7 +67,19 @@ public: 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. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -65,21 +90,42 @@ public: ); 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. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnEditCMake(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnEditCMakeMouseEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnEditCMakeMouseExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h b/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h index 328ee4d..1d327fa 100644 --- a/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMLibraryHelpDialog.h @@ -43,10 +43,23 @@ #include +/** + * Library Panel Help Dialog + */ class wxCDMLibraryHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Library Panel Help Dialog Constructor. + * @param parent Parent window. + * @param library Library class reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Libraries". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 650. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMLibraryHelpDialog( wxWindow* parent, modelCDMLibrary* library, @@ -56,7 +69,19 @@ public: const wxSize& size = wxSize(410,650), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMLibraryHelpDialog(); + /** + * Library Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Libraries". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 410, 650. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -67,20 +92,42 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); private: + /** + * Library class reference. + */ modelCDMLibrary* library; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnCMakeLists(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnCMakeListsEnter(wxMouseEvent& event); + + /** + * Handler when a cmakelists button hover finishes. + */ void OnCMakeListsExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h index 9ac5e71..1fc0e2b 100644 --- a/lib/creaDevManagerLib/wxCDMMainHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMMainHelpDialog.h @@ -41,10 +41,23 @@ #include "wxCDMMainDescriptionPanel.h" +/** + * Main Panel Help Dialog + */ class wxCDMMainHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Main Panel Help Dialog Constructor. + * @param parent Parent window. + * @param packageManager Main panel reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Welcome". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 370. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMMainHelpDialog( wxWindow* parent, wxCDMMainDescriptionPanel* packageManager, @@ -54,7 +67,19 @@ public: const wxSize& size = wxSize(350,370), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMMainHelpDialog(); + /** + * Main Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Welcome". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 370. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -65,19 +90,37 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); //attributes private: + /** + * Main panel reference. + */ wxCDMMainDescriptionPanel* mainDescription; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when new project button is pressed. + */ void OnNewProject(wxCommandEvent& event); + /** + * Handler when open project button is pressed. + */ void OnOpenProject(wxCommandEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h index 1db7ffa..9dd08c6 100644 --- a/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMPackageHelpDialog.h @@ -43,10 +43,23 @@ #include +/** + * Package Panel Help Dialog + */ class wxCDMPackageHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Package Panel Help Dialog Constructor. + * @param parent Parent window. + * @param package Package class reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Packages". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 570. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMPackageHelpDialog( wxWindow* parent, modelCDMPackage* package, @@ -56,7 +69,19 @@ public: const wxSize& size = wxSize(350,570), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMPackageHelpDialog(); + /** + * Package Panel Help Dialog Constructor. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Working with Packages". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 570. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -67,20 +92,41 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); private: + /** + * Package class reference. + */ modelCDMPackage* package; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnCMakeLists(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnCMakeListsEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnCMakeListsExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h b/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h index e20e377..1f03aa0 100644 --- a/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMPackageManagerHelpDialog.h @@ -41,10 +41,23 @@ #include "wxCDMPackageManagerPanel.h" +/** + * Package Manager Panel Help Dialog + */ class wxCDMPackageManagerHelpDialog : public wxDialog { DECLARE_EVENT_TABLE() public: + /** + * Package Manager Panel Help Dialog Constructor. + * @param parent Parent window. + * @param packageManager Package Manager panel reference. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Managing Packages". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 450. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ wxCDMPackageManagerHelpDialog( wxWindow* parent, wxCDMPackageManagerPanel* packageManager, @@ -54,7 +67,19 @@ public: const wxSize& size = wxSize(350,450), long style = wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER ); + /** + * Destructor. + */ ~wxCDMPackageManagerHelpDialog(); + /** + * Package Manager Panel Help Dialog Creator. + * @param parent Parent window. + * @param id Dialog ID. By default wxID_ANY. + * @param caption Dialog label. By default "Managing Packages". + * @param position Dialog position. By default wxDefaultPosition. + * @param size Dialog size. By default 350, 450. + * @param style Dialog style. By default wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -65,22 +90,46 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); //attributes private: + /** + * Package Manager panel reference. + */ wxCDMPackageManagerPanel* packageManager; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when the create package button is pressed. + */ void OnCreatePackage(wxCommandEvent& event); + /** + * Handler when a cmakelists button is pressed. + */ void OnEditCMake(wxCommandEvent& event); + /** + * Handler when a cmakelists button is hovered. + */ void OnEditCMakeMouseEnter(wxMouseEvent& event); + /** + * Handler when a cmakelists button hover finishes. + */ void OnEditCMakeMouseExit(wxMouseEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h index b9631a7..bc79bf9 100644 --- a/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h +++ b/lib/creaDevManagerLib/wxCDMProjectHelpDialog.h @@ -41,10 +41,23 @@ #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, modelCDMProject* project, @@ -54,7 +67,19 @@ public: const wxSize& size = wxSize(350,700), 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. + */ bool Create( wxWindow* parent, wxWindowID id = wxID_ANY, @@ -65,16 +90,28 @@ public: ); protected: + /** + * Creates the help controls (text and buttons). + */ void CreateControls(); //attributes private: + /** + * Project class reference. + */ modelCDMProject* project; //handlers protected: + /** + * Handler to close help dialog. + */ void OnFinish(wxCommandEvent& event); + /** + * Handler when the disable help checkbox is changed. + */ void OnDisableHelp(wxCommandEvent& event); };