From 6f3279f8b39adedcd231fbad40b0525461ed8691 Mon Sep 17 00:00:00 2001 From: Daniel Gonzalez Date: Mon, 21 Jan 2013 15:34:24 +0100 Subject: [PATCH] Feature #1711 CreaDevManager application implementation - View of model classes documented. --- .../wxCDMAppliDescriptionPanel.h | 61 +++++++++++++++ .../wxCDMApplicationDescriptionPanel.h | 70 +++++++++++++++++ .../wxCDMBlackBoxDescriptionPanel.h | 76 ++++++++++++++++++ .../wxCDMCMakeListsDescriptionPanel.h | 45 ++++++++++- .../wxCDMFileDescriptionPanel.h | 43 ++++++++++ .../wxCDMFolderDescriptionPanel.h | 55 +++++++++++++ .../wxCDMLibDescriptionPanel.h | 64 +++++++++++++++ .../wxCDMLibraryDescriptionPanel.h | 69 ++++++++++++++++ .../wxCDMMainDescriptionPanel.h | 34 +++++++- .../wxCDMPackageDescriptionPanel.h | 78 +++++++++++++++++++ .../wxCDMPackageManagerPanel.h | 6 +- 11 files changed, 598 insertions(+), 3 deletions(-) diff --git a/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h index 2a1a9fe..88c2cf9 100644 --- a/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMAppliDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMAppli.h" +/** + * Application manager description panel. Shows the available applications in the project and the actions corresponding to application management. + */ class wxCDMAppliDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Application manager description panel Constructor. + * @param parent Parent window reference. + * @param appli Application manager 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. + */ wxCDMAppliDescriptionPanel( wxWindow* parent, modelCDMAppli* appli, @@ -57,6 +70,17 @@ public: ~wxCDMAppliDescriptionPanel(); + /** + * Application manager description panel Creator. + * @param parent Parent window reference. + * @param appli Application manager 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 the creation was successful. + */ bool Create( wxWindow* parent, modelCDMAppli* appli, @@ -67,22 +91,59 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Application manager described. + */ modelCDMAppli* appli; //handlers protected: + /** + * Handles when the create application button is pressed. + */ void OnBtnCreateApplication(wxCommandEvent& event); + /** + * Handles when the open package cmakelists file button is pressed. + */ void OnBtnEditCMakeLists(wxCommandEvent& event); + /** + * Handles when an application link is pressed. + * @param event Has the link reference to know which application was selected. + */ void OnLnkApplicationSelect(wxHyperlinkEvent& 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 folder button is pressed. + */ void OnBtnOpenFolder(wxCommandEvent& event); + /** + * Handles when a application link is hovered. + * @param event Has the link reference to know which application was selected. + */ void OnMouseEnter(wxMouseEvent& event); + /** + * Handles when a application link button finishes hover. + * @param event Has the link reference to know which application 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); }; diff --git a/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h index 823272b..741eb44 100644 --- a/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMApplicationDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMApplication.h" +/** + * Application description panel. Shows the properties and actions available for the described application. + */ class wxCDMApplicationDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Application description panel Constructor. + * @param parent Parent window reference. + * @param application Application 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. + */ wxCDMApplicationDescriptionPanel( wxWindow* parent, modelCDMApplication* application, @@ -55,8 +68,21 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMApplicationDescriptionPanel(); + /** + * Application description panel Creator. + * @param parent Parent window reference. + * @param application Application 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. + */ bool Create( wxWindow* parent, modelCDMApplication* application, @@ -67,24 +93,68 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Application described. + */ modelCDMApplication* application; + /** + * described application's executable name control. + */ wxStaticText* executableNametc; //handlers protected: + /** + * 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 set executable name button is pressed. + */ void OnBtnSetExeName(wxCommandEvent& event); + /** + * Handles when the create class button is pressed. + */ void OnBtnCreateClass(wxCommandEvent& event); + /** + * Handles when the create folder button is pressed. + */ void OnBtnCreateFolder(wxCommandEvent& event); + /** + * Handles when the open package cmakelists file button is pressed. + */ void OnBtnEditCMakeLists(wxCommandEvent& event); + /** + * Handles when the open containing folder button is pressed. + */ void OnBtnOpenFolder(wxCommandEvent& 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); + /** + * Handles when the open Main file button is pressed. + */ void OnBtnOpenMain(wxCommandEvent& event); + /** + * Handles when the open Main file button is hovered. + */ void OnMainMouseEnter(wxMouseEvent& event); + /** + * Handles when the open Main file button finishes hover. + */ void OnMainMouseExit(wxMouseEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h index 4eeef1a..94d3071 100644 --- a/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMBlackBoxDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMBlackBox.h" +/** + * Black box description panel. Shows the properties and available actions for the described black box. + */ class wxCDMBlackBoxDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Black box description panel Constructor. + * @param parent Parent window reference. + * @param blackBox Black box 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. + */ wxCDMBlackBoxDescriptionPanel( wxWindow* parent, modelCDMBlackBox* blackBox, @@ -55,8 +68,22 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMBlackBoxDescriptionPanel(); + /** + * Black box description panel Creator. + * @param parent Parent window reference. + * @param blackBox Black box 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 the creatios was successful. + */ bool Create( wxWindow* parent, modelCDMBlackBox* blackBox, @@ -67,27 +94,76 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Black box described. + */ modelCDMBlackBox* blackBox; + /** + * Black box author control. + */ wxStaticText* authortc; + /** + * Black box description control + */ wxStaticText* descriptiontc; + /** + * Black box categories control. + */ wxStaticText* categoriestc; //handlers protected: + /** + * 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 set author button is pressed. + */ void OnBtnSetAuthor(wxCommandEvent& event); + /** + * Handles when the set description button is pressed. + */ void OnBtnSetDescription(wxCommandEvent& event); + /** + * Handles when the set categories button is pressed. + */ void OnBtnSetCategories(wxCommandEvent& event); + /** + * Handles when the open Cxx button is pressed. + */ void OnBtnOpenCxx(wxCommandEvent& event); + /** + * Handles when the open Hxx button is pressed. + */ void OnBtnOpenHxx(wxCommandEvent& event); + /** + * Handles when the open Folder button is pressed. + */ void OnBtnOpenFolder(wxCommandEvent& event); + /** + * Handles when the open Cxx button is hovered. + */ void OnCxxMouseEnter(wxMouseEvent& event); + /** + * Handles when the open Cxx button finishes hover. + */ void OnCxxMouseExit(wxMouseEvent& event); + /** + * Handles when the open Hxx button is hovered. + */ void OnHxxMouseEnter(wxMouseEvent& event); + /** + * Handles when the open Hxx button finishes hover. + */ void OnHxxMouseExit(wxMouseEvent& event); diff --git a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h index 67ac0cc..ac6f73f 100644 --- a/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMCMakeListsDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMCMakeListsFile.h" +/** + * CMakeLists File description panel. Shows the file properties and the available actions for it. + */ class wxCDMCMakeListsDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * CMakeLists File description panel Constructor. + * @param parent Parent window reference. + * @param makefile CMakeLists 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. + */ wxCDMCMakeListsDescriptionPanel( wxWindow* parent, modelCDMCMakeListsFile* makefile, @@ -55,11 +68,25 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMCMakeListsDescriptionPanel(); + /** + * CMakeLists File description panel Constructor. + * @param parent Parent window reference. + * @param makefile CMakeLists 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 the creation was successful. + */ bool Create( wxWindow* parent, - modelCDMCMakeListsFile* blackBox, + modelCDMCMakeListsFile* makefile, wxWindowID id = -1, const wxString& caption = _("Description Frame"), const wxPoint& pos = wxDefaultPosition, @@ -67,15 +94,31 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * CMakeLists file described. + */ modelCDMCMakeListsFile* cMakeLists; //handlers protected: + /** + * 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 file in text editor button is pressed. + */ void OnBtnOpenInEditor(wxCommandEvent& event); + /** + * Handles when the open containing folder button is pressed. + */ void OnBtnOpenFolder(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h index 01ad444..09cc104 100644 --- a/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMFileDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMFile.h" +/** + * File description panel. Shows the File properties and the available options for it. + */ class wxCDMFileDescriptionPanel : public wxPanel { 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, @@ -55,8 +68,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, @@ -67,16 +94,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: + /** + * 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); }; diff --git a/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h index b4f6083..fafe66e 100644 --- a/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMFolderDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMFolder.h" +/** + * Folder description panel. Shows the properties of the referenced folder and the available actions. + */ class wxCDMFolderDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Folder description panel Constructor. + * @param parent Parent window reference. + * @param folder Folder 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. + */ wxCDMFolderDescriptionPanel( wxWindow* parent, modelCDMFolder* folder, @@ -55,8 +68,22 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMFolderDescriptionPanel(); + /** + * Folder description panel Creator. + * @param parent Parent window reference. + * @param folder Folder 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 is successful. + */ bool Create( wxWindow* parent, modelCDMFolder* folder, @@ -67,20 +94,48 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Folder described. + */ modelCDMFolder* folder; //handlers protected: + /** + * 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 package cmakelists file button is pressed. + */ void OnBtnEditCMakeLists(wxCommandEvent& event); + /** + * Handles when the create class button is pressed. + */ void OnBtnCreateClass(wxCommandEvent& event); + /** + * Handles when the create folder button is pressed. + */ void OnBtnCreateFolder(wxCommandEvent& event); + /** + * Handles when the open in explorer button is pressed. + */ void OnBtnOpenInExplorer(wxCommandEvent& 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); }; diff --git a/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMLibDescriptionPanel.h index dca3cea..2483c9a 100644 --- 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,22 +94,59 @@ 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 link is pressed. + * @param event Has the link reference to know which library was selected. + */ void OnLnkLibrarySelect(wxHyperlinkEvent& 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); }; diff --git a/lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.h index 66e3063..724e485 100644 --- a/lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMLibraryDescriptionPanel.h @@ -41,10 +41,24 @@ #include "modelCDMLibrary.h" +/** + * Library description panel. Shows the available actions on the described library. + */ class wxCDMLibraryDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + + /** + * Library description panel Constructor. + * @param parent Parent window reference. + * @param library Project 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. + */ wxCDMLibraryDescriptionPanel( wxWindow* parent, modelCDMLibrary* library, @@ -55,8 +69,22 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMLibraryDescriptionPanel(); + /** + * Library description panel Creator. + * @param parent Parent window reference. + * @param library Project 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, modelCDMLibrary* library, @@ -67,21 +95,62 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Library described. + */ modelCDMLibrary* library; + /** + * Control with the described library name. + */ wxStaticText* libraryNametc; //handlers protected: + /** + * 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 set executable name button is pressed. + * @param event Unused. + */ void OnBtnSetExeName(wxCommandEvent& event); + /** + * Handles when the create class button is pressed. + * @param event Unused. + */ void OnBtnCreateClass(wxCommandEvent& event); + /** + * Handles when the create folder buttonis pressed. + * @param event Unused. + */ void OnBtnCreateFolder(wxCommandEvent& event); + /** + * Handles when Edit Cmakelists button is pressed. + * @param event Unused. + */ void OnBtnEditCMakeLists(wxCommandEvent& event); + /** + * Handles when the open containing folder button is pressed. + * @param event Unused. + */ void OnBtnOpenFolder(wxCommandEvent& event); + /** + * Handles when the edit cmakelists button is hovered. + * @param event Unused. + */ void OnCMakeMouseEnter(wxMouseEvent& event); + /** + * Handles when the edit cmakelists button exits hover. + * @param event Unused. + */ void OnCMakeMouseExit(wxMouseEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h index 0e384fd..fb0defa 100644 --- a/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMMainDescriptionPanel.h @@ -38,12 +38,23 @@ #include #include - +/** + * Main View description panel. Shows the welcome message and allows to open or create Crea projects. + */ class wxCDMMainDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Main description panel Constructor. + * @param parent Parent window 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. + */ wxCDMMainDescriptionPanel( wxWindow* parent, wxWindowID id = -1, @@ -53,8 +64,20 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor. + */ ~wxCDMMainDescriptionPanel(); + /** + * Main description panel Constructor. + * @param parent Parent window 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. + */ bool Create( wxWindow* parent, wxWindowID id = -1, @@ -64,11 +87,20 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); //handlers protected: + /** + * Handles when the create new project button is pressed. + */ void OnBtnNewProject(wxCommandEvent& event); + /** + * Handles when the open project button is pressed. + */ void OnBtnOpenProject(wxCommandEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h b/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h index 1601f04..8e88f9a 100644 --- a/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h +++ b/lib/creaDevManagerLib/wxCDMPackageDescriptionPanel.h @@ -41,10 +41,23 @@ #include "modelCDMPackage.h" +/** + * Package description panel. Shows the package's properties and the available actions for a package. + */ class wxCDMPackageDescriptionPanel : public wxPanel { DECLARE_EVENT_TABLE() public: + /** + * Package description panel Constructor. + * @param parent Parent window reference. + * @param package Package 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. + */ wxCDMPackageDescriptionPanel( wxWindow* parent, modelCDMPackage* package, @@ -55,8 +68,22 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Destructor + */ ~wxCDMPackageDescriptionPanel(); + /** + * Package description panel Creator. + * @param parent Parent window reference. + * @param package Package 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, modelCDMPackage* package, @@ -67,30 +94,81 @@ public: long style = wxDEFAULT_FRAME_STYLE ); + /** + * Creates all the controls in the panel (property and action controls). + */ void CreateControls(); private: + /** + * Package described. + */ modelCDMPackage* package; + /** + * Control with the package author. + */ wxStaticText* authortc; + /** + * Control with the package version. + */ wxStaticText* versiontc; + /** + * Control with the package description. + */ wxStaticText* descriptiontc; //handlers protected: + /** + * Handles when a return link is pressed. + */ void OnBtnReturn(wxHyperlinkEvent& event); + /** + * Handles when the Set author button is pressed. + */ void OnBtnSetAuthor(wxCommandEvent& event); + /** + * Handles when the Set version button is pressed. + */ void OnBtnSetVersion(wxCommandEvent& event); + /** + * Handles when the Change description button is pressed. + */ void OnBtnSetDescription(wxCommandEvent& event); + /** + * Handles when a black box link is pressed. + */ void OnLnkBlackBoxSelect(wxHyperlinkEvent& event); + /** + * Handles when the create black box button is pressed. + */ void OnBtnCreateBlackBox(wxCommandEvent& event); + /** + * Handles when the edit cmakelists file button is pressed. + */ void OnBtnEditCMakeLists(wxCommandEvent& event); + /** + * Handles when the open folder button is pressed. + */ void OnBtnOpenFolder(wxCommandEvent& event); + /** + * Handles when a black box link is hovered. + */ void OnMouseEnter(wxMouseEvent& event); + /** + * Handles when a black box link exits hover. + */ void OnMouseExit(wxMouseEvent& event); + /** + * Handles when the edit cmakelists file button is hovered. + */ void OnCMakeMouseEnter(wxMouseEvent& event); + /** + * Handles when the edit cmakelists file button exits hover. + */ void OnCMakeMouseExit(wxMouseEvent& event); }; diff --git a/lib/creaDevManagerLib/wxCDMPackageManagerPanel.h b/lib/creaDevManagerLib/wxCDMPackageManagerPanel.h index dcf2fd3..66a1d1c 100644 --- a/lib/creaDevManagerLib/wxCDMPackageManagerPanel.h +++ b/lib/creaDevManagerLib/wxCDMPackageManagerPanel.h @@ -108,7 +108,7 @@ public: private: /** - * Project described + * Project described. */ modelCDMProject* project; @@ -116,10 +116,12 @@ private: protected: /** * Handles when a return link is pressed. + * @param event Has the link reference to know where to return */ void OnBtnReturn(wxHyperlinkEvent& event); /** * Handles when a packages link is pressed. + * @param event Has the link reference to know which package was selected. */ void OnLnkPackageSelect(wxHyperlinkEvent& event); /** @@ -133,10 +135,12 @@ protected: /** * Handles when a package link is hovered. + * @param event Has the link reference to know which package was selected. */ void OnMouseEnter(wxMouseEvent& event); /** * Handles when a package link button finishes hover. + * @param event Has the link reference to know which package was selected. */ void OnMouseExit(wxMouseEvent& event); /** -- 2.47.1