Computer Assited Medical Intervention Tool Kit  version 4.1
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-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO)
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-2018 Univ. Grenoble Alpes, CNRS, TIMC-IMAG UMR 5525 (GMCAO) <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 static const QString defaultActionExtensionName = "Example Of An Action Extension";
114 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).";
115 
116 /* ------------------- Component Extension Description Widget ------------------ */
117 static const QString defaultComponentExtensionExplanation = "\
118 <html>\
119  <head/>\
120  <body>\
121  <p>\
122  A <i>Component Extension</i> manages one top-level Component.<br/> \
123  A top-level component appears at the first level of the component explorer.<br/> \
124  It can have sub-components, that can also be managed in the same <i>Component Extension</i>. <br/> \
125  There is one directory for each <i>Component Extension</i>.<br/> \
126  Each <i>Component Extension</i> results in one dynamic library (dll, so or dylib).\
127  </p>\
128  <p>Please fill-in the information requested for creating a <i>Component Extension</i>.</p>\
129  <p>The Components composing this <i>Component Extension</i> will be added in the next forms.</p>\
130 </body>\
131 </html>\
132 ";
133 
134 static const QString defaultComponentExtensionName = "Example Of A Component Extension";
135 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)";
136 
137 /* ------------------------ Action Description Widget ----------------------- */
138 
139 static const QString defaultActionName = "Example Of An Action";
140 static const QString defaultActionDescription = "This description is automatically generated in order to show new users how to easily write an Action.";
141 
142 static const QStringList defaultPossibleComponents = QStringList() << "ImageComponent" << "MeshComponent" << "CameraComponent" << "PhysicalModelComponent";
143 
144 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";
145 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";
146 static const QString defaultActionNameAndExtension = "Please provide a name that is different from the name of the Action Extension.\n";
147 
148 /* ------------------------ Component Description Widget ----------------------- */
149 
150 static const QString defaultComponentName = "Example Of A Component";
151 static const QString defaultComponentDescription = "This description is automatically generated for this component which handles no kind of data.";
152 static const QString defaultComponentSuffix = "example";
153 
154 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";
155 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";
156 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 instanciate your component.";
157 static const QString defaultComponentNameAndExtension = "Please provide a name different that is different from the name of the Component Extension.\n";
158 
159 /* ------------------------ Action Classification Widget ----------------------- */
160 static const QString defaultFamily = "Test Family";
161 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.";
162 
163 static const QString defaultParamNoName = "Please provide a name for <i>all</i> parameters.\n";
164 static const QString defaultPropNoName = "Please provide a name for <i>all</i> properties.\n";
165 
166 /* ----------------------- Actions Creation Widget --------------------------- */
167 static const QString defaultCreatedActionsString = "\
168 <html>\
169 <head/>\
170 <body>\
171 <p align='center'><span style=' font-weight:600; '>Created Action(s):</span></p>\
172 <ul>\
173 </ul>\
174 </body>\
175 </html>";
176 
177 /* ----------------------- Components Creation Widget --------------------------- */
178 static const QString defaultCreatedComponentsString = "\
179 <html>\
180 <head/>\
181 <body>\
182 <p align='center'><span style=' font-weight:600; '>Created Component(s):</span></p>\
183 <ul>\
184 </ul>\
185 </body>\
186 </html>";
187 
188 
189 /* ----------------------- Action Symmary --------------------------- */
190 static const QString defaultActionSummary = "\
191 <html>\
192 <head/> \
193 <body>\
194 <h1>Summary</h1>\
195 <p> You are about to add the following <b>Action</b></p>\
196 <ul>\
197 <li>Name: @NAME@ </li>\
198 <li>Description: @DESCRIPTION@ </li>\
199 <li>Component: @COMPONENT@ </li>\
200 <li>Parameter(s): \
201 <ul> \
202 @PARAMETERS_LIST@ \
203 </ul> \
204 </li>\
205 <li>Family: @FAMILY@ </li>\
206 <li>Tag(s): \
207 <ul> \
208 @TAGS_LIST@ \
209 </ul> \
210 </li>\
211 </ul>\
212 <br/> \
213 <p>If you want to modify some elements of your Action, click on <tt>Previous</tt>. </p> \
214 <p>If you want to cancel the creation of this Action, click on <tt>Cancel</tt>. </p> \
215 <p>Clicking on <tt>Next</tt> will bring you back to the Action Extension page.</p>\
216 </body>\
217 </html>";
218 
219 
220 /* ----------------------- Component Symmary --------------------------- */
221 static const QString defaultComponentSummary = "\
222 <html>\
223 <head/> \
224 <body>\
225 <h1>Summary</h1>\
226 <p> You are about to add the following <b>Component</b></p>\
227 <ul>\
228 <li>Name: @NAME@ </li>\
229 <li>Description: @DESCRIPTION@ </li>\
230 <li>Representation: @REPRESENTATION@ </li>\
231 <li>Property(ies): \
232 <ul> \
233 @PROPERTIES_LIST@ \
234 </ul> \
235 </li>\
236 </ul>\
237 <br/> \
238 <p>If you want to modify some elements of your Component, click on <tt>Previous</tt>. </p> \
239 <p>If you want to cancel the creation of this Component, click on <tt>Cancel</tt>. </p> \
240 <p>Clicking on <tt>Next</tt> will bring you back to the Component Extension page.</p>\
241 </body>\
242 </html>";
243 
244 
245 
246 /* ----------------------- Action Extension Summary --------------------------- */
247 static const QString defaultExtensionSummary = "\
248 <html>\
249 <head/> \
250 <body>\
251  <h1>Summary</h1>\
252  <p> You are about to add the following <b>@ELEMENT@ Extensions</b></p>\
253  <ul>\
254  <li>Name: @NAME@ </li>\
255  <li>Description: @DESCRIPTION@ </li>\
256  <li>@ELEMENT@s: \
257  <ul> \
258  @ELEMENTS_LIST@ \
259  </ul> \
260  </li>\
261  <li>Dependencies: \
262  <ul> \
263  @DEPENDENCIES_LIST@ \
264  </ul> \
265  </li>\
266  </ul>\
267  <br/> \
268  <p>If you want to modify some elements of your @ELEMENT@ Extension, click on <tt>Previous</tt>. </p> \
269  <p>If you want to cancel the creation of this @ELEMENT@ Extension, click on <tt>Cancel</tt>. </p> \
270  <p>Clicking on <tt>Next</tt> will bring you back to the CEP sumarry page.</p>\
271 </body>\
272 </html>";
273 
274 
275 /* ----------------------- Libraries --------------------------- */
276 static const QString defaultLibraryExplanation = "\
277 <html>\
278  <head/>\
279  <body>\
280  <p>A CamiTK Component or Action is just a <span style='font-style:italic;'>glue</span>, i.e. an encapsulation of your <br/>\
281  data structures/algorithms to fit them within CamiTK. \
282  </p>\
283  <p>However, you may want to keep the knowledge and know-how of your specialty <br/>\
284  independent of CamiTK.\
285  </p>\
286  <p>This is what Libraries offers you: <span style='font-weight:600;'>the code inside a library is independent of CamiTK</span><br/>\
287  (only the CMakeList provided uses camitk cmake macros to ease your work, <br/>\
288  but you can totally modify them so that they are CamiTK<br/>\
289  independent) and can be used elsewhere.\
290  </p>\
291  </body>\
292 </html>\
293 ";
294 
295 static const QString defaultLibraryName = "My Own Library";
296 
297 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).";
298 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";
299 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";
300 
301 static const QString defaultCopyFilesExplanation = "\
302 <html>\
303  <head/>\
304  <body>\
305  <h1>Copy Files</h1>\
306  <p>\
307  If you already created files containing the code of your library, you can copy them here.\
308  </p>\
309  <p>\
310  You can of course copy them or create them manually another time. <br/>\
311  However,as CMake automatically parses the directory to include existing .h and .cpp files<br/>\
312  inside your project, you may want to copy/create them before running CMake<br/>\
313  for the first time.\
314  </p>\
315  </body>\
316 </html>\
317 ";
318 
319 static const QString defaultCopiedFiles = "\
320 <html>\
321 <head/>\
322 <body>\
323 <h1>File(s) to copy:</h1>\
324 <ul>\
325 </ul>\
326 </body>\
327 </html>";
328 
329 /* ----------------------- CEP Summary --------------------------- */
330 static const QString defaultCEPSummary = "\
331 <html>\
332  <head/>\
333  <body>\
334  <h2>Congratulations !!</h2>\
335  <h1>You just created a <i>CamiTK Extension Project</i></h1>\
336 \
337  <h2>To Make It Work</h2>\
338  <ol>\
339  <li>Create a <tt>build</tt> directory.<br/>\
340  <i>Note:</i> It is generally created within @WORKING_DIRECTORY@<br/>\
341  But <b>NOT</b> whitin @WORKING_DIRECTORY@/@CEP_DIRECTORY@.<br/>\
342  However, it can be created anywhere else.\
343  </li>\
344  <li>Launch CMake-Gui</li>\
345  <li>Set <tt><i>Where to build the binaries:</i></tt> to @WORKING_DIRECTORY@/build</li>\
346  <li>Set <tt><i>Where is the source code:</i></tt> to @WORKING_DIRECTORY@/@CEP_DIRECTORY@\
347  <li>Click on <tt>Configure</tt> and select your favorite IDE (Visual Studio, KDevelop, XCode, etc.)</li>\
348  <li>Re-click on <tt>Configure</tt> until no red parameter appears.</li>\
349  <li>Click on <tt>Generate</tt>\
350  <li>Open the generated project (located within @WORKING_DIRECTORY@/build) with your favorite IDE\
351  <li>Compile it</li>\
352  <li>Run <tt>camitk-imp</tt> either from your IDE or from command-line <br/>\
353  (after relocated within @WORKING_DIRECTORY@/build directory)\
354  <li>Enjoy !</li>\
355  <ol>\
356  </body>\
357 </html>\
358 ";
359 
360 #endif
defaultActionExtensionDescription
static const QString defaultActionExtensionDescription
Definition: DefaultGUIText.h:114
defaultRealFamily
static const QString defaultRealFamily
Definition: DefaultGUIText.h:161
enhancedStyle
static const QString enhancedStyle
Definition: DefaultGUIText.h:35
defaultUserLicence
static const QString defaultUserLicence
Definition: DefaultGUIText.h:55
defaultComponentDescription
static const QString defaultComponentDescription
Definition: DefaultGUIText.h:151
defaultContact
static const QString defaultContact
Definition: DefaultGUIText.h:54
defaultRealCepName
static const QString defaultRealCepName
Definition: DefaultGUIText.h:50
defaultCepName
static const QString defaultCepName
Definition: DefaultGUIText.h:42
defaultCreatedComponentsString
static const QString defaultCreatedComponentsString
Definition: DefaultGUIText.h:178
defaultActionSummary
static const QString defaultActionSummary
Definition: DefaultGUIText.h:190
normalStyle
static const QString normalStyle
Definition: DefaultGUIText.h:34
defaultComponentExtensionName
static const QString defaultComponentExtensionName
Definition: DefaultGUIText.h:134
defaultCEPSummary
static const QString defaultCEPSummary
Definition: DefaultGUIText.h:330
defaultComponentExtensionExplanation
static const QString defaultComponentExtensionExplanation
Definition: DefaultGUIText.h:117
defaultBeforeGoingFurther
static const QString defaultBeforeGoingFurther
Definition: DefaultGUIText.h:31
defaultPropNoName
static const QString defaultPropNoName
Definition: DefaultGUIText.h:164
defaultActionNameAndExtension
static const QString defaultActionNameAndExtension
Definition: DefaultGUIText.h:146
defaultComponentSuffix
static const QString defaultComponentSuffix
Definition: DefaultGUIText.h:152
defaultRealExtensionDescription
static const QString defaultRealExtensionDescription
Definition: DefaultGUIText.h:95
defaultActionName
static const QString defaultActionName
Definition: DefaultGUIText.h:139
defaultAscii
static const QString defaultAscii
Definition: DefaultGUIText.h:38
defaultLibraryName
static const QString defaultLibraryName
Definition: DefaultGUIText.h:295
defaultPossibleComponents
static const QStringList defaultPossibleComponents
Definition: DefaultGUIText.h:142
defaultCepDescription
static const QString defaultCepDescription
Definition: DefaultGUIText.h:43
defaultRealComponentDescription
static const QString defaultRealComponentDescription
Definition: DefaultGUIText.h:155
defaultComponentExtensionDescription
static const QString defaultComponentExtensionDescription
Definition: DefaultGUIText.h:135
defaultRealLibraryDescription
static const QString defaultRealLibraryDescription
Definition: DefaultGUIText.h:299
defaultCopiedFiles
static const QString defaultCopiedFiles
Definition: DefaultGUIText.h:319
defaultFamily
static const QString defaultFamily
Definition: DefaultGUIText.h:160
defaultCreatedActionsString
static const QString defaultCreatedActionsString
Definition: DefaultGUIText.h:167
defaultRealComponentName
static const QString defaultRealComponentName
Definition: DefaultGUIText.h:154
defaultComponentNameAndExtension
static const QString defaultComponentNameAndExtension
Definition: DefaultGUIText.h:157
defaultActionExtensionExplanation
static const QString defaultActionExtensionExplanation
Definition: DefaultGUIText.h:98
defaultLibraryExplanation
static const QString defaultLibraryExplanation
Definition: DefaultGUIText.h:276
defaultRealActionName
static const QString defaultRealActionName
Definition: DefaultGUIText.h:144
defaultRealFileSuffix
static const QString defaultRealFileSuffix
Definition: DefaultGUIText.h:156
defaultCopyFilesExplanation
static const QString defaultCopyFilesExplanation
Definition: DefaultGUIText.h:301
defaultComponentSummary
static const QString defaultComponentSummary
Definition: DefaultGUIText.h:221
defaultExtensionSummary
static const QString defaultExtensionSummary
Definition: DefaultGUIText.h:247
defaultComponentName
static const QString defaultComponentName
Definition: DefaultGUIText.h:150
defaultRealExtensionName
static const QString defaultRealExtensionName
Definition: DefaultGUIText.h:94
defaultRealCepDescription
static const QString defaultRealCepDescription
Definition: DefaultGUIText.h:51
defaultDependenciesExplanation
static const QString defaultDependenciesExplanation
Definition: DefaultGUIText.h:77
defaultRealLibraryName
static const QString defaultRealLibraryName
Definition: DefaultGUIText.h:298
defaultLibraryDescription
static const QString defaultLibraryDescription
Definition: DefaultGUIText.h:297
defaultActionDescription
static const QString defaultActionDescription
Definition: DefaultGUIText.h:140
defaultActionExtensionName
static const QString defaultActionExtensionName
Definition: DefaultGUIText.h:113
defaultParamNoName
static const QString defaultParamNoName
Definition: DefaultGUIText.h:163
defaultRealActionDescription
static const QString defaultRealActionDescription
Definition: DefaultGUIText.h:145
defaultRealContact
static const QString defaultRealContact
Definition: DefaultGUIText.h:73
Generated by   doxygen 1.8.13