Computer Assisted Medical Intervention Tool Kit  version 5.2
DefaultGUIText.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * $CAMITK_LICENCE_BEGIN$
3  *
4  * CamiTK - Computer Assisted Medical Intervention ToolKit
5  * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
6  *
7  * Visit http://camitk.imag.fr for more information
8  *
9  * This file is part of CamiTK.
10  *
11  * CamiTK is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * CamiTK is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Lesser General Public License version 3 for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * version 3 along with CamiTK. If not, see <http://www.gnu.org/licenses/>.
22  *
23  * $CAMITK_LICENCE_END$
24  ****************************************************************************/
25 
26 #ifndef DefaultGUIText_h
27 #define DefaultGUIText_h
28 
29 /* ------------------------ Generic -------------------------------- */
30 /* ------------------------ Before going further ------------------------- */
31 static const QString defaultBeforeGoingFurther = "Before going further...";
32 
33 /* ------------------------ Enhance error -------------------------------- */
34 static const QString normalStyle = "QLabel { background-color : none; color : black; }";
35 static const QString enhancedStyle = "QLabel { background-color : red; color : yellow; }";
36 
37 /* ------------------------ Use only ASCII characters -------------------- */
38 static const QString defaultAscii = "Please use only ASCII characters: only non accentuated alphanumeric and some other characters [!, \", #, $, %, &, (, ), *, +, -, /...] are supported";
39 
40 
41 /* ------------------------ CEP Description Widget ----------------------- */
42 static const QString defaultCepName = "An example of CEP";
43 static const QString defaultCepDescription = "<html><head></head>\
44 <body>\
45 <p>This CEP is an automatically example generated by CamiTK-Wizard.</p>\
46 <p>It will help you to create Action and Component extensions as well as needed libraries.</p>\
47 <p>This description <span style='font-weight:600;'>should be replaced</span> \
48 by a real description of the <span style='font-style:italic;'>actual</span> project.</p>\
49 </body></html>";
50 static const QString defaultRealCepName = "Please provide a <i>real</i> <b>name</b> for your CEP,\nA CEP name should gives an idea of what your project is about.\n";
51 static const QString defaultRealCepDescription = "Please provide a <i>real</i> <b>description</b> for your CEP,\nA CEP description should explain what your project is about.\n";
52 
53 /* ------------------------ CEP Contact Widget ----------------------- */
54 static const QString defaultContact = "Firstname.Lastname@univ-grenoble-alpes.fr";
55 static const QString defaultUserLicence = "/*****************************************************************************<br/>\
56  * $USERDEF_LICENCE_BEGIN$<br/>\
57  * <br/>\
58  * CamiTK - Computer Assisted Medical Intervention ToolKit <br/>\
59  * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France <br/>\
60  * <br/>\
61  * Visit http://camitk.imag.fr for more information <br/>\
62  * <br/>\
63  * This file is part of CamiTK. <br/>\
64  * <br/>\
65  * @CEP_NAME@ is under the following licence: <br/>\
66  * <br/>\
67  * <br/>\
68  * <br/>\
69  * $USERDEF_LICENCE_END$ <br/>\
70  ****************************************************************************/ <br/>\
71 <br/>\
72 ";
73 static const QString defaultRealContact = "Please provide a <i>real</i> email address for contact\n";
74 
75 
76 /* ------------------- Dependencies ----------------------------- */
77 static const QString defaultDependenciesExplanation = "\
78 <html>\
79  <head/>\
80  <body>\
81  <p>\
82  Please provide here the possible dependencies of your @ELEMENT@: <br/>\
83  does it depend on an library from this CEP, from another CamiTK CEP or an external library?\
84  </p>\
85  <p>\
86  <i>Note</span>: if your @ELEMENT@ is standalone<br/>\
87  (i.e., it does not need any other library to work), you can skip this page.\
88  </p>\
89  </body>\
90 </html>\
91 ";
92 
93 /* ---------------------- Extension Description Widget --------------------- */
94 static const QString defaultRealExtensionName = "Please provide a <i>real</i> <b>name</b> for your extension,\nA real name should express what your extension is about.\n";
95 static const QString defaultRealExtensionDescription = "Please provide a <i>real</i> <b>description</b> for your extension,\nA real description should explain what your extension is about.\n";
96 
97 /* ------------------- Action Extension Description Widget ------------------ */
98 static const QString defaultActionExtensionExplanation = "\
99 <html>\
100  <head/>\
101  <body>\
102  <p>\
103  An <i>Action Extension</i> manages one or a set of actions targeting the same objective.<br/> \
104  There is one directory for each <i>Action Extension</i>. <br/> \
105  Each <i>Action Extension</i> results in one dynamic library (dll, so or dylib).\
106  </p>\
107  <p>Please fill-in the information requested for creating of an <i>Action Extension</i>.</p>\
108  <p>The Actions composing this <i>Action Extension</i> will be added in the next forms.</p>\
109  </body>\
110 </html>\
111 ";
112 
113 /* ------------------- Action Extension Description Widget ------------------ */
114 static const QString defaultViewerExtensionExplanation = "\
115 <html>\
116  <head/>\
117  <body>\
118  <p>\
119  An <i>Viewer Extension</i> manages one or a set of actions targeting the same objective.<br/> \
120  There is one directory for each <i>Viewer Extension</i>. <br/> \
121  Each <i>Viewer Extension</i> results in one dynamic library (dll, so or dylib).\
122  </p>\
123  <p>Please fill-in the information requested for creating of an <i>Viewer Extension</i>.</p>\
124  <p>The Viewer composing this <i>Viewer Extension</i> will be added in the next forms.</p>\
125  </body>\
126 </html>\
127 ";
128 
129 static const QString defaultActionExtensionName = "Example Of An Action Extension";
130 static const QString defaultActionExtensionDescription = "This extension description is automatically generated in order to show new users how to easily write an extension with one or several Action(s).";
131 
132 static const QString defaultViewerExtensionName = "Example Of An Viewer Extension";
133 static const QString defaultViewerExtensionDescription = "This extension description is automatically generated in order to show new users how to easily write an extension with one or several Viewer(s).";
134 
135 /* ------------------- Component Extension Description Widget ------------------ */
136 static const QString defaultComponentExtensionExplanation = "\
137 <html>\
138  <head/>\
139  <body>\
140  <p>\
141  A <i>Component Extension</i> manages one top-level Component.<br/> \
142  A top-level component appears at the first level of the component explorer.<br/> \
143  It can have sub-components, that can also be managed in the same <i>Component Extension</i>. <br/> \
144  There is one directory for each <i>Component Extension</i>.<br/> \
145  Each <i>Component Extension</i> results in one dynamic library (dll, so or dylib).\
146  </p>\
147  <p>Please fill-in the information requested for creating a <i>Component Extension</i>.</p>\
148  <p>The Components composing this <i>Component Extension</i> will be added in the next forms.</p>\
149 </body>\
150 </html>\
151 ";
152 
153 static const QString defaultComponentExtensionName = "Example Of A Component Extension";
154 static const QString defaultComponentExtensionDescription = "This extension description is automatically generated in order to show new users how to easily write an extension with one or several Component(s)";
155 
156 /* ------------------------ Action Description Widget ----------------------- */
157 
158 static const QString defaultActionName = "Example Of An Action";
159 static const QString defaultActionDescription = "This description is automatically generated in order to show new users how to easily write an Action.";
160 
161 static const QStringList defaultPossibleComponents = QStringList() << "ImageComponent" << "MeshComponent" << "CameraComponent" << "PhysicalModelComponent";
162 
163 static const QString defaultRealActionName = "Please provide a <i>real</i> <b>name</b> for your action,\nA real action name should express what your action is about.\n";
164 static const QString defaultRealActionDescription = "Please provide a <i>real</i> <b>description</b> for your action,\nA real description should explain the goal and tell a little bit about the method of your action (for instance, you can reference a/your paper here).\n";
165 static const QString defaultActionNameAndExtension = "Please provide a name that is different from the name of the Action Extension.\n";
166 
167 /* ------------------------ Viewer Description Widget ----------------------- */
168 
169 static const QString defaultViewerName = "Example Of An Viewer";
170 static const QString defaultViewerDescription = "This description is automatically generated in order to show new users how to easily write an Viewer.";
171 
172 static const QString defaultRealViewerName = "Please provide a <i>real</i> <b>name</b> for your viewer,\nA real action name should express what your viewer is about.\n";
173 static const QString defaultRealViewerDescription = "Please provide a <i>real</i> <b>description</b> for your viewer,\nA real description should explain the goal and tell a little bit about the method of your viewer (for instance, you can reference a/your paper here).\n";
174 static const QString defaultViewerNameAndExtension = "Please provide a name that is different from the name of the Viewer Extension.\n";
175 
176 /* ------------------------ Component Description Widget ----------------------- */
177 
178 static const QString defaultComponentName = "Example Of A Component";
179 static const QString defaultComponentDescription = "This description is automatically generated for this component which handles no kind of data.";
180 static const QString defaultComponentSuffix = "example";
181 
182 static const QString defaultRealComponentName = "Please provide a <i>real</i> <b>name</b> for your component,\nA real component name should express what kind of data are handled.\n";
183 static const QString defaultRealComponentDescription = "Please provide a <i>real</i> <b>description</b> for your component,\nA real description should explain the data files or input/output data that are handled.\n";
184 static const QString defaultRealFileSuffix = "Please provide a <i>real</i> file suffix. It is the suffix (also called file extension) that is used in the file names your component will open/support. If your component is not designed to open any file, please leave this suffix empty. Note that in this case, you might consider using a initialization action to instantiate your component.";
185 static const QString defaultComponentNameAndExtension = "Please provide a name different that is different from the name of the Component Extension.\n";
186 
187 /* ------------------------ Action Classification Widget ----------------------- */
188 static const QString defaultFamily = "Test Family";
189 static const QString defaultRealFamily = "Please provide a <i>real</i> family name for your Action. It will allow CamiTK to automatically classify your action: all actions of the same family will be available under the same submenu in the contextual menu/Action menu of the selected component.";
190 
191 static const QString defaultParamNoName = "Please provide a name for <i>all</i> parameters.\n";
192 static const QString defaultPropNoName = "Please provide a name for <i>all</i> properties.\n";
193 
194 /* ----------------------- Actions Creation Widget --------------------------- */
195 static const QString defaultCreatedActionsString = "\
196 <html>\
197 <head/>\
198 <body>\
199 <p align='center'><span style=' font-weight:600; '>Created Action(s):</span></p>\
200 <ul>\
201 </ul>\
202 </body>\
203 </html>";
204 
205 /* ----------------------- Actions Creation Widget --------------------------- */
206 static const QString defaultCreatedViewersString = "\
207 <html>\
208 <head/>\
209 <body>\
210 <p align='center'><span style=' font-weight:600; '>Created Viewer(s):</span></p>\
211 <ul>\
212 </ul>\
213 </body>\
214 </html>";
215 
216 /* ----------------------- Components Creation Widget --------------------------- */
217 static const QString defaultCreatedComponentsString = "\
218 <html>\
219 <head/>\
220 <body>\
221 <p align='center'><span style=' font-weight:600; '>Created Component(s):</span></p>\
222 <ul>\
223 </ul>\
224 </body>\
225 </html>";
226 
227 
228 /* ----------------------- Action Symmary --------------------------- */
229 static const QString defaultActionSummary = "\
230 <html>\
231 <head/> \
232 <body>\
233 <h1>Summary</h1>\
234 <p> You are about to add the following <b>Action</b></p>\
235 <ul>\
236 <li>Name: @NAME@ </li>\
237 <li>Description: @DESCRIPTION@ </li>\
238 <li>Component: @COMPONENT@ </li>\
239 <li>Parameter(s): \
240 <ul> \
241 @PARAMETERS_LIST@ \
242 </ul> \
243 </li>\
244 <li>Family: @FAMILY@ </li>\
245 <li>Tag(s): \
246 <ul> \
247 @TAGS_LIST@ \
248 </ul> \
249 </li>\
250 </ul>\
251 <br/> \
252 <p>If you want to modify some elements of your Action, click on <tt>Previous</tt>. </p> \
253 <p>If you want to cancel the creation of this Action, click on <tt>Cancel</tt>. </p> \
254 <p>Clicking on <tt>Next</tt> will bring you back to the Action Extension page.</p>\
255 </body>\
256 </html>";
257 
258 
259 /* ----------------------- Viewer Symmary --------------------------- */
260 static const QString defaultViewerSummary = "\
261 <html>\
262 <head/> \
263 <body>\
264 <h1>Summary</h1>\
265 <p> You are about to add the following <b>Viewer</b></p>\
266 <ul>\
267 <li>Name: @NAME@ </li>\
268 <li>Description: @DESCRIPTION@ </li>\
269 <li>Type: @TYPE@ </li>\
270 </ul>\
271 <br/> \
272 <p>If you want to modify some elements of your Viewer, click on <tt>Previous</tt>. </p> \
273 <p>If you want to cancel the creation of this Viewer, click on <tt>Cancel</tt>. </p> \
274 <p>Clicking on <tt>Next</tt> will bring you back to the Viewer Extension page.</p>\
275 </body>\
276 </html>";
277 
278 
279 /* ----------------------- Component Symmary --------------------------- */
280 static const QString defaultComponentSummary = "\
281 <html>\
282 <head/> \
283 <body>\
284 <h1>Summary</h1>\
285 <p> You are about to add the following <b>Component</b></p>\
286 <ul>\
287 <li>Name: @NAME@ </li>\
288 <li>Description: @DESCRIPTION@ </li>\
289 <li>Representation: @REPRESENTATION@ </li>\
290 <li>Property(ies): \
291 <ul> \
292 @PROPERTIES_LIST@ \
293 </ul> \
294 </li>\
295 </ul>\
296 <br/> \
297 <p>If you want to modify some elements of your Component, click on <tt>Previous</tt>. </p> \
298 <p>If you want to cancel the creation of this Component, click on <tt>Cancel</tt>. </p> \
299 <p>Clicking on <tt>Next</tt> will bring you back to the Component Extension page.</p>\
300 </body>\
301 </html>";
302 
303 
304 
305 /* ----------------------- Action Extension Summary --------------------------- */
306 static const QString defaultExtensionSummary = "\
307 <html>\
308 <head/> \
309 <body>\
310  <h1>Summary</h1>\
311  <p> You are about to add the following <b>@ELEMENT@ Extensions</b></p>\
312  <ul>\
313  <li>Name: @NAME@ </li>\
314  <li>Description: @DESCRIPTION@ </li>\
315  <li>@ELEMENT@s: \
316  <ul> \
317  @ELEMENTS_LIST@ \
318  </ul> \
319  </li>\
320  <li>Dependencies: \
321  <ul> \
322  @DEPENDENCIES_LIST@ \
323  </ul> \
324  </li>\
325  </ul>\
326  <br/> \
327  <p>If you want to modify some elements of your @ELEMENT@ Extension, click on <tt>Previous</tt>. </p> \
328  <p>If you want to cancel the creation of this @ELEMENT@ Extension, click on <tt>Cancel</tt>. </p> \
329  <p>Clicking on <tt>Next</tt> will bring you back to the CEP sumarry page.</p>\
330 </body>\
331 </html>";
332 
333 
334 /* ----------------------- Libraries --------------------------- */
335 static const QString defaultLibraryExplanation = "\
336 <html>\
337  <head/>\
338  <body>\
339  <p>A CamiTK Component or Action is just a <span style='font-style:italic;'>glue</span>, i.e. an encapsulation of your <br/>\
340  data structures/algorithms to fit them within CamiTK. \
341  </p>\
342  <p>However, you may want to keep the knowledge and know-how of your specialty <br/>\
343  independent of CamiTK.\
344  </p>\
345  <p>This is what Libraries offers you: <span style='font-weight:600;'>the code inside a library is independent of CamiTK</span><br/>\
346  (only the CMakeList provided uses camitk cmake macros to ease your work, <br/>\
347  but you can totally modify them so that they are CamiTK<br/>\
348  independent) and can be used elsewhere.\
349  </p>\
350  </body>\
351 </html>\
352 ";
353 
354 static const QString defaultLibraryName = "My Own Library";
355 
356 static const QString defaultLibraryDescription = "This library is generated automatically and aims at showing CamiTK new users how to easily write a library independent from CamiTK (except for the CMakeList).";
357 static const QString defaultRealLibraryName = "Please provide a <i>real</i> <b>name</b> for your library,\nA real library name should express what your library is about.\n";
358 static const QString defaultRealLibraryDescription = "Please provide a <i>real</i> <b>description</b> for your library,\nA real description should explain the goal and tell a little bit about the method of your library (for instance, you can reference a/your paper here).\n";
359 
360 static const QString defaultCopyFilesExplanation = "\
361 <html>\
362  <head/>\
363  <body>\
364  <h1>Copy Files</h1>\
365  <p>\
366  If you already created files containing the code of your library, you can copy them here.\
367  </p>\
368  <p>\
369  You can of course copy them or create them manually another time. <br/>\
370  However,as CMake automatically parses the directory to include existing .h and .cpp files<br/>\
371  inside your project, you may want to copy/create them before running CMake<br/>\
372  for the first time.\
373  </p>\
374  </body>\
375 </html>\
376 ";
377 
378 static const QString defaultCopiedFiles = "\
379 <html>\
380 <head/>\
381 <body>\
382 <h1>File(s) to copy:</h1>\
383 <ul>\
384 </ul>\
385 </body>\
386 </html>";
387 
388 /* ----------------------- CEP Summary --------------------------- */
389 static const QString defaultCEPSummary = "\
390 <html>\
391  <head/>\
392  <body>\
393  <h2>Congratulations !!</h2>\
394  <h1>You just created a <i>CamiTK Extension Project</i></h1>\
395 \
396  <h2>To Make It Work</h2>\
397  <ol>\
398  <li>Create a <tt>build</tt> directory.<br/>\
399  <i>Note:</i> It is generally created within @WORKING_DIRECTORY@<br/>\
400  But <b>NOT</b> whitin @WORKING_DIRECTORY@/@CEP_DIRECTORY@.<br/>\
401  However, it can be created anywhere else.\
402  </li>\
403  <li>Launch CMake-Gui</li>\
404  <li>Set <tt><i>Where to build the binaries:</i></tt> to @WORKING_DIRECTORY@/build</li>\
405  <li>Set <tt><i>Where is the source code:</i></tt> to @WORKING_DIRECTORY@/@CEP_DIRECTORY@\
406  <li>Click on <tt>Configure</tt> and select your favorite IDE (Visual Studio, KDevelop, XCode, etc.)</li>\
407  <li>Re-click on <tt>Configure</tt> until no red parameter appears.</li>\
408  <li>Click on <tt>Generate</tt>\
409  <li>Open the generated project (located within @WORKING_DIRECTORY@/build) with your favorite IDE\
410  <li>Compile it</li>\
411  <li>Run <tt>camitk-imp</tt> either from your IDE or from command-line <br/>\
412  (after relocated within @WORKING_DIRECTORY@/build directory)\
413  <li>Enjoy !</li>\
414  <ol>\
415  </body>\
416 </html>\
417 ";
418 
419 #endif
static const QString defaultComponentName
Definition: DefaultGUIText.h:178
static const QString defaultViewerName
Definition: DefaultGUIText.h:169
static const QString defaultLibraryName
Definition: DefaultGUIText.h:354
static const QString defaultAscii
Definition: DefaultGUIText.h:38
static const QString defaultCreatedViewersString
Definition: DefaultGUIText.h:206
static const QString defaultViewerDescription
Definition: DefaultGUIText.h:170
static const QString defaultRealContact
Definition: DefaultGUIText.h:73
static const QString defaultContact
Definition: DefaultGUIText.h:54
static const QString defaultRealViewerName
Definition: DefaultGUIText.h:172
static const QString defaultLibraryExplanation
Definition: DefaultGUIText.h:335
static const QString defaultCopiedFiles
Definition: DefaultGUIText.h:378
static const QString defaultRealExtensionName
Definition: DefaultGUIText.h:94
static const QString defaultRealCepName
Definition: DefaultGUIText.h:50
static const QString defaultComponentNameAndExtension
Definition: DefaultGUIText.h:185
static const QString defaultRealActionName
Definition: DefaultGUIText.h:163
static const QString defaultExtensionSummary
Definition: DefaultGUIText.h:306
static const QString defaultRealExtensionDescription
Definition: DefaultGUIText.h:95
static const QString defaultRealLibraryDescription
Definition: DefaultGUIText.h:358
static const QString defaultViewerExtensionDescription
Definition: DefaultGUIText.h:133
static const QString defaultRealFamily
Definition: DefaultGUIText.h:189
static const QString defaultPropNoName
Definition: DefaultGUIText.h:192
static const QString defaultActionDescription
Definition: DefaultGUIText.h:159
static const QString defaultActionExtensionExplanation
Definition: DefaultGUIText.h:98
static const QString defaultCepName
Definition: DefaultGUIText.h:42
static const QString defaultDependenciesExplanation
Definition: DefaultGUIText.h:77
static const QString defaultViewerSummary
Definition: DefaultGUIText.h:260
static const QString defaultCreatedActionsString
Definition: DefaultGUIText.h:195
static const QString defaultActionExtensionName
Definition: DefaultGUIText.h:129
static const QString defaultBeforeGoingFurther
Definition: DefaultGUIText.h:31
static const QString defaultRealFileSuffix
Definition: DefaultGUIText.h:184
static const QString defaultComponentExtensionExplanation
Definition: DefaultGUIText.h:136
static const QString defaultViewerExtensionExplanation
Definition: DefaultGUIText.h:114
static const QString defaultCEPSummary
Definition: DefaultGUIText.h:389
static const QString defaultComponentDescription
Definition: DefaultGUIText.h:179
static const QString defaultLibraryDescription
Definition: DefaultGUIText.h:356
static const QStringList defaultPossibleComponents
Definition: DefaultGUIText.h:161
static const QString defaultRealCepDescription
Definition: DefaultGUIText.h:51
static const QString defaultComponentExtensionName
Definition: DefaultGUIText.h:153
static const QString defaultRealViewerDescription
Definition: DefaultGUIText.h:173
static const QString defaultCepDescription
Definition: DefaultGUIText.h:43
static const QString normalStyle
Definition: DefaultGUIText.h:34
static const QString defaultViewerExtensionName
Definition: DefaultGUIText.h:132
static const QString defaultComponentSuffix
Definition: DefaultGUIText.h:180
static const QString defaultActionName
Definition: DefaultGUIText.h:158
static const QString defaultComponentExtensionDescription
Definition: DefaultGUIText.h:154
static const QString defaultComponentSummary
Definition: DefaultGUIText.h:280
static const QString defaultCreatedComponentsString
Definition: DefaultGUIText.h:217
static const QString defaultFamily
Definition: DefaultGUIText.h:188
static const QString defaultRealLibraryName
Definition: DefaultGUIText.h:357
static const QString defaultActionExtensionDescription
Definition: DefaultGUIText.h:130
static const QString defaultRealActionDescription
Definition: DefaultGUIText.h:164
static const QString defaultActionNameAndExtension
Definition: DefaultGUIText.h:165
static const QString defaultUserLicence
Definition: DefaultGUIText.h:55
static const QString defaultRealComponentDescription
Definition: DefaultGUIText.h:183
static const QString defaultCopyFilesExplanation
Definition: DefaultGUIText.h:360
static const QString defaultViewerNameAndExtension
Definition: DefaultGUIText.h:174
static const QString defaultRealComponentName
Definition: DefaultGUIText.h:182
static const QString enhancedStyle
Definition: DefaultGUIText.h:35
static const QString defaultActionSummary
Definition: DefaultGUIText.h:229
static const QString defaultParamNoName
Definition: DefaultGUIText.h:191