]> Creatis software - crea.git/blob - lib/creaDevManagerLib/wxCDMLibraryHelpDialog.cpp
Feature #1711
[crea.git] / lib / creaDevManagerLib / wxCDMLibraryHelpDialog.cpp
1 /*
2 # ---------------------------------------------------------------------
3 #
4 # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image 
5 #                        pour la Sant�)
6 # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
7 # Previous Authors : Laurent Guigues, Jean-Pierre Roux
8 # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
9 #
10 #  This software is governed by the CeCILL-B license under French law and 
11 #  abiding by the rules of distribution of free software. You can  use, 
12 #  modify and/ or redistribute the software under the terms of the CeCILL-B 
13 #  license as circulated by CEA, CNRS and INRIA at the following URL 
14 #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html 
15 #  or in the file LICENSE.txt.
16 #
17 #  As a counterpart to the access to the source code and  rights to copy,
18 #  modify and redistribute granted by the license, users are provided only
19 #  with a limited warranty  and the software's author,  the holder of the
20 #  economic rights,  and the successive licensors  have only  limited
21 #  liability. 
22 #
23 #  The fact that you are presently reading this means that you have had
24 #  knowledge of the CeCILL-B license and that you accept its terms.
25 # ------------------------------------------------------------------------ 
26  */
27
28
29 /*
30  * wxCDMLibraryHelpDialog.cpp
31  *
32  *  Created on: 11/1/2013
33  *      Author: Daniel Felipe Gonzalez Obando
34  */
35
36 #include "wxCDMLibraryHelpDialog.h"
37
38 #include "creaDevManagerIds.h"
39
40 #include "modelCDMLib.h"
41
42 BEGIN_EVENT_TABLE(wxCDMLibraryHelpDialog, wxDialog)
43 EVT_BUTTON(ID_BUTTON_CANCEL, wxCDMLibraryHelpDialog::OnFinish)
44 EVT_BUTTON(ID_BUTTON_OPENPROJECT, wxCDMLibraryHelpDialog::OnCMakeLists)
45 EVT_BUTTON(ID_BUTTON_EDIT_CMAKELISTSFILE, wxCDMLibraryHelpDialog::OnCMakeLists)
46 EVT_CHECKBOX(ID_CHECKBOX_DISABLE_HELP, wxCDMLibraryHelpDialog::OnDisableHelp)
47 END_EVENT_TABLE()
48
49 wxCDMLibraryHelpDialog::wxCDMLibraryHelpDialog(
50     wxWindow* parent,
51     modelCDMLibrary* library,
52     wxWindowID id,
53     const wxString& caption,
54     const wxPoint& position,
55     const wxSize& size,
56     long style
57 )
58 {
59   wxCDMLibraryHelpDialog::Create(parent, id, caption, position, size, style);
60   this->library = library;
61 }
62
63 wxCDMLibraryHelpDialog::~wxCDMLibraryHelpDialog()
64 {
65 }
66
67 bool wxCDMLibraryHelpDialog::Create(
68     wxWindow* parent,
69     wxWindowID id,
70     const wxString& caption,
71     const wxPoint& position,
72     const wxSize& size,
73     long int style
74 )
75 {
76   wxDialog::Create(parent, id, caption, position, size, style);
77
78   this->CreateControls();
79
80   return TRUE;
81 }
82
83 void wxCDMLibraryHelpDialog::CreateControls()
84 {
85
86   wxBoxSizer* v_sizer1 = new wxBoxSizer(wxVERTICAL);
87
88
89   wxStaticText* title = new wxStaticText(this, wxID_ANY, wxT("Working with Libraries"), wxDefaultPosition, wxDefaultSize, wxALIGN_LEFT);//new wxRichTextCtrl(this,wxID_ANY, wxString("Create a new project"), wxDefaultPosition, wxDefaultSize, wxRE_READONLY);
90   v_sizer1->Add(title, 0, wxALIGN_LEFT | wxALL | wxALIGN_CENTER_VERTICAL, 5);
91
92   wxStaticText* instruction = new wxStaticText(
93       this,
94       wxID_ANY,
95       crea::std2wx(
96           "Libraries are made to expose the projects' main functionalities to the applications and black boxes of the project. "
97           "The functions and classes available in the libraries are the core of any project, thus they should implement important "
98           "tasks such as image processing algorithms or point cloud processing algorithms."
99           "Libraries are stored in the project's lib folder and each library has its own dedicated folder. Inside these folders "
100           "each library has its classes.\n"
101           "\n"
102           "To start developing a library, go ahead and create a new class with the button \"Create Class\" and implement the main "
103           "functionalities of your project inside the created files.\n"
104           "If you need to separate classes in folders you can do it by creating a folder with the \"Create Folder\" button.\n"
105           "Then, in order to include your libraries in the project correctly you must include them in the lib's folder "
106           "\"CMakeLists.txt\" file. Also, if you create additional folders in your library you should include them in the library's "
107           "\"CMakeLists.txt\" file.\n"
108           "\n"
109           "You can easily edit the CMakeLists files previously mentioned by clicking on the following buttons."),
110           wxDefaultPosition,
111           wxDefaultSize,
112           wxALIGN_LEFT
113   );
114   v_sizer1->Add(instruction, 0,wxEXPAND | wxALL, 5);
115
116   wxButton* editCMakeLibraryBtn = new wxButton(this, ID_BUTTON_EDIT_CMAKELISTSFILE, wxT("Open Library's directory CMakeLists file"));
117   editCMakeLibraryBtn->Connect(wxEVT_ENTER_WINDOW, (wxObjectEventFunction)(wxEventFunction)(wxMouseEventFunction)&wxCDMLibraryHelpDialog::OnCMakeListsEnter,NULL,this);
118   editCMakeLibraryBtn->Connect(wxEVT_LEAVE_WINDOW, (wxObjectEventFunction)(wxEventFunction)(wxMouseEventFunction)&wxCDMLibraryHelpDialog::OnCMakeListsExit,NULL,this);
119   wxButton* editCMakeLibBtn= new wxButton(this, ID_BUTTON_OPENPROJECT, wxT("Open Lib's directory CMakeLists file"));
120   editCMakeLibBtn->Connect(wxEVT_ENTER_WINDOW, (wxObjectEventFunction)(wxEventFunction)(wxMouseEventFunction)&wxCDMLibraryHelpDialog::OnCMakeListsEnter,NULL,this);
121   editCMakeLibBtn->Connect(wxEVT_LEAVE_WINDOW, (wxObjectEventFunction)(wxEventFunction)(wxMouseEventFunction)&wxCDMLibraryHelpDialog::OnCMakeListsExit,NULL,this);
122
123   v_sizer1->Add(editCMakeLibraryBtn, 0, wxEXPAND | wxLEFT | wxRIGHT, 15);
124   v_sizer1->Add(editCMakeLibBtn, 0, wxEXPAND | wxLEFT | wxRIGHT, 15);
125
126   v_sizer1->Add(new wxCheckBox(this, ID_CHECKBOX_DISABLE_HELP, wxT("&Disable help")), 0, wxALIGN_RIGHT | wxRIGHT, 10);
127
128   v_sizer1->Add(new wxButton(this, ID_BUTTON_CANCEL, wxT("Close")), 0, wxALIGN_RIGHT | wxRIGHT | wxBOTTOM | wxALIGN_CENTER_VERTICAL, 30);
129
130   SetSizer(v_sizer1);
131   //v_sizer1->RecalcSizes();
132 }
133
134 void wxCDMLibraryHelpDialog::OnFinish(wxCommandEvent& event)
135 {
136   this->EndDialog(wxID_CANCEL);
137 }
138
139 void wxCDMLibraryHelpDialog::OnCMakeLists(wxCommandEvent& event)
140 {
141   std::string* result;
142
143   if((int)((wxButton*)event.GetEventObject())->GetId() == (int)ID_BUTTON_EDIT_CMAKELISTSFILE)
144     {
145
146       if(!this->library->OpenCMakeListsFile(result))
147         wxMessageBox(crea::std2wx(*result),_T("Open CMakeLists File - Error!"),wxOK | wxICON_ERROR);
148
149       wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_SELECTED);
150
151       if(this->library->GetCMakeLists() != NULL)
152         {
153           newEvent->SetClientData(this->library->GetCMakeLists());
154           newEvent->SetId(0);
155           wxPostEvent(this->GetParent(), *newEvent);
156         }
157     }
158   else if(((wxButton*)event.GetEventObject())->GetId() == ID_BUTTON_OPENPROJECT)
159     {
160       modelCDMIProjectTreeNode* node = this->library;
161       while (node != NULL && dynamic_cast<modelCDMLib*>(node) == NULL)
162         {
163           node = node->GetParent();
164         }
165       if (node != NULL)
166         {
167           if(!((modelCDMLib*)node)->OpenCMakeListsFile(result))
168             wxMessageBox(crea::std2wx(*result),_T("Open CMakeLists File - Error!"),wxOK | wxICON_ERROR);
169
170           wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_SELECTED);
171
172           if(((modelCDMLib*)node)->GetCMakeLists() != NULL)
173             {
174               newEvent->SetClientData(((modelCDMLib*)node)->GetCMakeLists());
175               newEvent->SetId(0);
176               wxPostEvent(this->GetParent(), *newEvent);
177             }
178         }
179       else
180         {
181           wxMessageBox(crea::std2wx("No project CMakeLists file was found."),_T("Open CMakeLists File - Error!"),wxOK | wxICON_ERROR);
182         }
183     }
184 }
185
186 void wxCDMLibraryHelpDialog::OnCMakeListsEnter(wxMouseEvent& event)
187 {
188   if(((wxButton*)event.GetEventObject())->GetId() == ID_BUTTON_EDIT_CMAKELISTSFILE)
189     {
190       wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED);
191
192       if(this->library->GetCMakeLists() != NULL)
193         {
194           newEvent->SetClientData(this->library->GetCMakeLists());
195           newEvent->SetId(0);
196           wxPostEvent(this->GetParent(), *newEvent);
197         }
198     }
199   else if(((wxButton*)event.GetEventObject())->GetId() == ID_BUTTON_OPENPROJECT)
200     {
201       modelCDMIProjectTreeNode* node = this->library;
202       while (node != NULL && dynamic_cast<modelCDMLib*>(node) == NULL)
203         {
204           node = node->GetParent();
205         }
206       if (node != NULL)
207         {
208           wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED);
209
210           if(((modelCDMLib*)node)->GetCMakeLists() != NULL)
211             {
212               newEvent->SetClientData(((modelCDMLib*)node)->GetCMakeLists());
213               newEvent->SetId(0);
214               wxPostEvent(this->GetParent(), *newEvent);
215             }
216         }
217     }
218   event.Skip();
219 }
220
221 void wxCDMLibraryHelpDialog::OnCMakeListsExit(wxMouseEvent& event)
222 {
223   if(((wxButton*)event.GetEventObject())->GetId() == ID_BUTTON_EDIT_CMAKELISTSFILE)
224       {
225         wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_SELECTED);
226
227         if(this->library->GetCMakeLists() != NULL)
228           {
229             newEvent->SetClientData(this->library->GetCMakeLists());
230             newEvent->SetId(0);
231             wxPostEvent(this->GetParent(), *newEvent);
232           }
233       }
234     else if(((wxButton*)event.GetEventObject())->GetId() == ID_BUTTON_OPENPROJECT)
235       {
236         modelCDMIProjectTreeNode* node = this->library;
237         while (node != NULL && dynamic_cast<modelCDMLib*>(node) == NULL)
238           {
239             node = node->GetParent();
240           }
241         if (node != NULL)
242           {
243             wxCommandEvent* newEvent = new wxCommandEvent(wxEVT_COMMAND_LISTBOX_SELECTED);
244
245             if(((modelCDMLib*)node)->GetCMakeLists() != NULL)
246               {
247                 newEvent->SetClientData(((modelCDMLib*)node)->GetCMakeLists());
248                 newEvent->SetId(0);
249                 wxPostEvent(this->GetParent(), *newEvent);
250               }
251           }
252       }
253     event.Skip();
254 }
255
256 void wxCDMLibraryHelpDialog::OnDisableHelp(wxCommandEvent& event)
257 {
258   wxPostEvent(this->GetParent(), event);
259 }