Doxygen
Loading...
Searching...
No Matches
translator.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 *
4 *
5 * Copyright (C) 1997-2015 by Dimitri van Heesch.
6 *
7 * Permission to use, copy, modify, and distribute this software and its
8 * documentation under the terms of the GNU General Public License is hereby
9 * granted. No representations are made about the suitability of this software
10 * for any purpose. It is provided "as is" without express or implied warranty.
11 * See the GNU General Public License for more details.
12 *
13 * Documents produced by Doxygen are derivative works derived from the
14 * input used in their production; they are not affected by this license.
15 *
16 */
17
18#ifndef TRANSLATOR_H
19#define TRANSLATOR_H
20
21#include "classdef.h"
22#include "config.h"
23#include "datetime.h"
24#include "index.h"
25#include "construct.h"
26
27/** Abstract base class for all translatable text fragments. */
28class Translator
29{
30 public:
31 ABSTRACT_BASE_CLASS(Translator)
32
33 /*! This method is used to provide warning message that is displayed
34 * if the user chooses a language whose translation is not up to date.
35 * It is implemented by the adapter classes.
36 */
37 virtual DString updateNeededMessage() { return DString(); }
38
39 // Please, have a look at comments inside the translator_en.h file
40 // to learn the meaning of the following methods. The translator_en.h
41 // file contains the TranslatorEnglish implementation, which is
42 // always up-to-date (by definition).
43
44 // --- Language control methods -------------------
45
46 virtual DString idLanguage() = 0;
47 virtual DString latexLanguageSupportCommand() = 0;
48 /*!
49 * Sets the LaTeX font encoding to be used. The default is set to `T1`,
50 * in case another font encoding has to be used this can be specified with
51 * this routine. In case no font encoding is required the empty string
52 * can be returned.
53 */
54 virtual DString latexFontenc() { return DString("T1"); }
55 virtual DString latexFont() {
56 return DString("\\usepackage[scaled=.90]{helvet}\n"
57 "\\usepackage{courier}\n"
58 "\\renewcommand{\\familydefault}{\\sfdefault}\n");
59 }
60 /*!
61 * Sets the commands to be inserted directly after the `\\begin{document}`
62 * in the LaTeX document.
63 */
64 virtual DString latexDocumentPre() { return DString(""); }
65 /*!
66 * Sets the commands to be inserted directly before the `\\end{document}`
67 * in the LaTeX document.
68 */
69 virtual DString latexDocumentPost() { return DString(""); }
70 /*!
71 * Set the name to be used as latex command.
72 */
73 virtual DString latexCommandName()
74 {
75 return p_latexCommandName("pdflatex");
76 }
77 virtual DString trISOLang() = 0;
78
79 /** language codes for Html help
80
81 <pre>
82 0x402 Bulgarian
83 0x405 Czech
84 0x406 Danish
85 0x413 Dutch
86 0xC09 English (Australia)
87 0x809 English (Britain)
88 0x1009 English (Canada)
89 0x1809 English (Ireland)
90 0x1409 English (New Zealand)
91 0x1C09 English (South Africa)
92 0x409 English (United States)
93 0x40B Finnish
94 0x40C French
95 0x407 German
96 0x408 Greece
97 0x439 Hindi
98 0x40E Hungarian
99 0x410 Italian
100 0x814 Norwegian
101 0x415 Polish
102 0x816 Portuguese(Portugal)
103 0x416 Portuguese(Brazil)
104 0x419 Russian
105 0x80A Spanish(Mexico)
106 0xC0A Spanish(Modern Sort)
107 0x40A Spanish(Traditional Sort)
108 0x41D Swedish
109 0x41F Turkey
110 0x411 Japanese
111 0x412 Korean
112 0x804 Chinese (PRC)
113 0x404 Chinese (Taiwan)
114 </pre>
115
116 New LCIDs:
117 <pre>
118 0x421 Indonesian
119 0x41A Croatian
120 0x418 Romanian
121 0x424 Slovenian
122 0x41B Slovak
123 0x422 Ukrainian
124 0x81A Serbian (Serbia, Latin)
125 0x403 Catalan
126 0x426 Latvian
127 0x427 Lithuanian
128 0x436 Afrikaans
129 0x42A Vietnamese
130 0x429 Persian (Iran)
131 0xC01 Arabic (Egypt) - I don't know which version of arabic is used inside translator_ar.h ,
132 so I have chosen Egypt at random
133 </pre>
134
135 Code for Esperanto should be as shown below but the htmlhelp compiler 1.3 does not support this
136 (and no newer version is available).
137 <pre>
138 0x48f Esperanto
139 </pre>
140 So do a fallback to the default language
141 <pre>
142 0x409 English (United States)
143 </pre>
144
145 <pre>
146 0xC1A Serbian (Serbia, Cyrillic)
147 </pre>
148 */
149 virtual DString getLanguageString() = 0;
150
151 /**
152 * add punctuation at the end of a brief description when needed and supported by the language
153 */
154 virtual bool needsPunctuation() { return true; }
155
156 // --- Language translation methods -------------------
157
158 virtual DString trRelatedFunctions() = 0;
159 virtual DString trRelatedSubscript() = 0;
160 virtual DString trDetailedDescription() = 0;
161 virtual DString trDetails() = 0;
162 virtual DString trMemberTypedefDocumentation() = 0;
163 virtual DString trMemberEnumerationDocumentation() = 0;
164 virtual DString trMemberFunctionDocumentation() = 0;
165 virtual DString trMemberDataDocumentation() = 0;
166 virtual DString trMore() = 0;
167 virtual DString trListOfAllMembers() = 0;
168 virtual DString trMemberList() = 0;
169 virtual DString trThisIsTheListOfAllMembers() = 0;
170 virtual DString trIncludingInheritedMembers() = 0;
171 virtual DString trGeneratedAutomatically(const DString &s) = 0;
172 virtual DString trEnumName() = 0;
173 virtual DString trEnumValue() = 0;
174 virtual DString trDefinedIn() = 0;
175
176 // quick reference sections
177
178 virtual DString trModules() = 0;
179 virtual DString trClassHierarchy() = 0;
180 virtual DString trCompoundList() = 0;
181 virtual DString trFileList() = 0;
182 virtual DString trCompoundMembers() = 0;
183 virtual DString trFileMembers() = 0;
184 virtual DString trRelatedPages() = 0;
185 virtual DString trExamples() = 0;
186 virtual DString trSearch() = 0;
187 virtual DString trClassHierarchyDescription() = 0;
188 virtual DString trFileListDescription(bool extractAll) = 0;
189 virtual DString trCompoundListDescription() = 0;
190 virtual DString trCompoundMembersDescription(bool extractAll) = 0;
191 virtual DString trFileMembersDescription(bool extractAll) = 0;
192 virtual DString trExamplesDescription() = 0;
193 virtual DString trRelatedPagesDescription() = 0;
194 virtual DString trModulesDescription() = 0;
195
196 // index titles (the project name is prepended for these)
197
198 virtual DString trDocumentation(const DString &projName) = 0;
199 virtual DString trModuleIndex() = 0;
200 virtual DString trHierarchicalIndex() = 0;
201 virtual DString trCompoundIndex() = 0;
202 virtual DString trFileIndex() = 0;
203 virtual DString trModuleDocumentation() = 0;
204 virtual DString trClassDocumentation() = 0;
205 virtual DString trFileDocumentation() = 0;
206 virtual DString trReferenceManual() = 0;
207 virtual DString trDefines() = 0;
208 virtual DString trTypedefs() = 0;
209 virtual DString trEnumerations() = 0;
210 virtual DString trFunctions() = 0;
211 virtual DString trVariables() = 0;
212 virtual DString trEnumerationValues() = 0;
213 virtual DString trDefineDocumentation() = 0;
214 virtual DString trTypedefDocumentation() = 0;
215 virtual DString trEnumerationTypeDocumentation() = 0;
216 virtual DString trFunctionDocumentation() = 0;
217 virtual DString trVariableDocumentation() = 0;
218 virtual DString trCompounds() = 0;
219 virtual DString trGeneratedAt(const DString &date,const DString &projName) = 0;
220 virtual DString trClassDiagram(const DString &clName) = 0;
221 virtual DString trWarning() = 0;
222 virtual DString trVersion() = 0;
223 virtual DString trDate() = 0;
224 virtual DString trReturns() = 0;
225 virtual DString trSeeAlso() = 0;
226 virtual DString trParameters() = 0;
227 virtual DString trExceptions() = 0;
228 virtual DString trGeneratedBy() = 0;
229
230//////////////////////////////////////////////////////////////////////////
231// new since 0.49-990307
232//////////////////////////////////////////////////////////////////////////
233
234 virtual DString trNamespaceList() = 0;
235 virtual DString trNamespaceListDescription(bool extractAll) = 0;
236 virtual DString trFriends() = 0;
237
238//////////////////////////////////////////////////////////////////////////
239// new since 0.49-990405
240//////////////////////////////////////////////////////////////////////////
241
242 virtual DString trRelatedFunctionDocumentation() = 0;
243
244//////////////////////////////////////////////////////////////////////////
245// new since 0.49-990425
246//////////////////////////////////////////////////////////////////////////
247
248 virtual DString trCompoundReference(const DString &clName,
249 ClassDef::CompoundType compType,
250 bool isTemplate) = 0;
251
252 virtual DString trFileReference(const DString &fileName) = 0;
253 virtual DString trNamespaceReference(const DString &namespaceName) = 0;
254
255 virtual DString trPublicMembers() = 0;
256 virtual DString trPublicSlots() = 0;
257 virtual DString trSignals() = 0;
258 virtual DString trStaticPublicMembers() = 0;
259 virtual DString trProtectedMembers() = 0;
260 virtual DString trProtectedSlots() = 0;
261 virtual DString trStaticProtectedMembers() = 0;
262 virtual DString trPrivateMembers() = 0;
263 virtual DString trPrivateSlots() = 0;
264 virtual DString trStaticPrivateMembers() = 0;
265 virtual DString trWriteList(int numEntries) = 0;
266 virtual DString trInheritsList(int numEntries) = 0;
267 virtual DString trInheritedByList(int numEntries) = 0;
268 virtual DString trReimplementedFromList(int numEntries) = 0;
269 virtual DString trReimplementedInList(int numEntries) = 0;
270 virtual DString trNamespaceMembers() = 0;
271 virtual DString trNamespaceMemberDescription(bool extractAll) = 0;
272 virtual DString trNamespaceIndex() = 0;
273 virtual DString trNamespaceDocumentation() = 0;
274
275//////////////////////////////////////////////////////////////////////////
276// new since 0.49-990522
277//////////////////////////////////////////////////////////////////////////
278
279 virtual DString trNamespaces() = 0;
280
281//////////////////////////////////////////////////////////////////////////
282// new since 0.49-990728
283//////////////////////////////////////////////////////////////////////////
284
285 virtual DString trGeneratedFromFiles(ClassDef::CompoundType compType,
286 bool single) = 0;
287
288//////////////////////////////////////////////////////////////////////////
289// new since 0.49-990901
290//////////////////////////////////////////////////////////////////////////
291
292 virtual DString trReturnValues() = 0;
293 virtual DString trMainPage() = 0;
294 virtual DString trPageAbbreviation() = 0;
295
296//////////////////////////////////////////////////////////////////////////
297// new since 0.49-991003
298//////////////////////////////////////////////////////////////////////////
299
300 virtual DString trDefinedAtLineInSourceFile() = 0;
301 virtual DString trDefinedInSourceFile() = 0;
302
303//////////////////////////////////////////////////////////////////////////
304// new since 0.49-991205
305//////////////////////////////////////////////////////////////////////////
306
307 virtual DString trDeprecated() = 0;
308
309//////////////////////////////////////////////////////////////////////////
310// new since 1.0.0
311//////////////////////////////////////////////////////////////////////////
312
313 virtual DString trCollaborationDiagram(const DString &clName) = 0;
314 virtual DString trInclDepGraph(const DString &fName) = 0;
315 virtual DString trConstructorDocumentation() = 0;
316 virtual DString trGotoSourceCode() = 0;
317 virtual DString trGotoDocumentation() = 0;
318 virtual DString trPrecondition() = 0;
319 virtual DString trPostcondition() = 0;
320 virtual DString trInvariant() = 0;
321 virtual DString trInitialValue() = 0;
322 virtual DString trCode() = 0;
323
324 virtual DString trGraphicalHierarchy() = 0;
325 virtual DString trGotoGraphicalHierarchy() = 0;
326 virtual DString trGotoTextualHierarchy() = 0;
327 virtual DString trPageIndex() = 0;
328
329//////////////////////////////////////////////////////////////////////////
330// new since 1.1.0
331//////////////////////////////////////////////////////////////////////////
332
333 virtual DString trNote() = 0;
334 virtual DString trPublicTypes() = 0;
335 virtual DString trPublicAttribs() = 0;
336 virtual DString trStaticPublicAttribs() = 0;
337 virtual DString trProtectedTypes() = 0;
338 virtual DString trProtectedAttribs() = 0;
339 virtual DString trStaticProtectedAttribs() = 0;
340 virtual DString trPrivateTypes() = 0;
341 virtual DString trPrivateAttribs() = 0;
342 virtual DString trStaticPrivateAttribs() = 0;
343
344//////////////////////////////////////////////////////////////////////////
345// new since 1.1.3
346//////////////////////////////////////////////////////////////////////////
347
348 virtual DString trTodo() = 0;
349 virtual DString trTodoList() = 0;
350
351//////////////////////////////////////////////////////////////////////////
352// new since 1.1.4
353//////////////////////////////////////////////////////////////////////////
354
355 virtual DString trReferencedBy() = 0;
356 virtual DString trRemarks() = 0;
357 virtual DString trAttention() = 0;
358 virtual DString trInclByDepGraph() = 0;
359 virtual DString trSince() = 0;
360
361//////////////////////////////////////////////////////////////////////////
362// new since 1.1.5
363//////////////////////////////////////////////////////////////////////////
364
365 virtual DString trLegendTitle() = 0;
366 virtual DString trLegendDocs() = 0;
367 virtual DString trLegend() = 0;
368
369//////////////////////////////////////////////////////////////////////////
370// new since 1.2.0
371//////////////////////////////////////////////////////////////////////////
372
373 virtual DString trTest() = 0;
374 virtual DString trTestList() = 0;
375
376//////////////////////////////////////////////////////////////////////////
377// new since 1.2.2
378//////////////////////////////////////////////////////////////////////////
379
380 virtual DString trProperties() = 0;
381 virtual DString trPropertyDocumentation() = 0;
382
383//////////////////////////////////////////////////////////////////////////
384// new since 1.2.4
385//////////////////////////////////////////////////////////////////////////
386
387 virtual DString trClasses() = 0;
388 virtual DString trPackage(const DString &name) = 0;
389 virtual DString trPackageListDescription() = 0;
390 virtual DString trPackages() = 0;
391 virtual DString trDefineValue() = 0;
392
393//////////////////////////////////////////////////////////////////////////
394// new since 1.2.5
395//////////////////////////////////////////////////////////////////////////
396
397 virtual DString trBug() = 0;
398 virtual DString trBugList() = 0;
399
400//////////////////////////////////////////////////////////////////////////
401// new since 1.2.6
402//////////////////////////////////////////////////////////////////////////
403
404
405 /*! Used as ansicpg for RTF file
406 *
407 * The following table shows the correlation of Charset name, Charset Value and
408 * <pre>
409 * Codepage number:
410 * Charset Name Charset Value(hex) Codepage number
411 * ------------------------------------------------------
412 * DEFAULT_CHARSET 1 (x01)
413 * SYMBOL_CHARSET 2 (x02)
414 * OEM_CHARSET 255 (xFF)
415 * ANSI_CHARSET 0 (x00) 1252
416 * RUSSIAN_CHARSET 204 (xCC) 1251
417 * EE_CHARSET 238 (xEE) 1250
418 * GREEK_CHARSET 161 (xA1) 1253
419 * TURKISH_CHARSET 162 (xA2) 1254
420 * BALTIC_CHARSET 186 (xBA) 1257
421 * HEBREW_CHARSET 177 (xB1) 1255
422 * ARABIC _CHARSET 178 (xB2) 1256
423 * SHIFTJIS_CHARSET 128 (x80) 932
424 * HANGEUL_CHARSET 129 (x81) 949
425 * GB2313_CHARSET 134 (x86) 936
426 * CHINESEBIG5_CHARSET 136 (x88) 950
427 * </pre>
428 *
429 */
430 virtual DString trRTFansicp() = 0;
431
432 /*! Character sets
433 * <pre>
434 * 0 — ANSI
435 * 1 — Default
436 * 2 — Symbol
437 * 3 — Invalid
438 * 77 — Mac
439 * 128 — Shift Jis
440 * 129 — Hangul
441 * 130 — Johab
442 * 134 — GB2312
443 * 136 — Big5
444 * 161 — Greek
445 * 162 — Turkish
446 * 163 — Vietnamese
447 * 177 — Hebrew
448 * 178 — Arabic
449 * 179 — Arabic Traditional
450 * 180 — Arabic user
451 * 181 — Hebrew user
452 * 186 — Baltic
453 * 204 — Russian
454 * 222 — Thai
455 * 238 — Eastern European
456 * 254 — PC 437
457 * 255 — OEM
458 * </pre>
459 */
460 virtual DString trRTFCharSet() = 0;
461 virtual DString trRTFGeneralIndex() = 0;
462
463 // Translation of the word
464
465 virtual DString trClass(bool first_capital, bool singular) = 0;
466 virtual DString trFile(bool first_capital, bool singular) = 0;
467 virtual DString trNamespace(bool first_capital, bool singular) = 0;
468 virtual DString trGroup(bool first_capital, bool singular) = 0;
469 virtual DString trPage(bool first_capital, bool singular) = 0;
470 virtual DString trMember(bool first_capital, bool singular) = 0;
471 virtual DString trGlobal(bool first_capital, bool singular) = 0;
472
473//////////////////////////////////////////////////////////////////////////
474// new since 1.2.7
475//////////////////////////////////////////////////////////////////////////
476
477 virtual DString trAuthor(bool first_capital, bool singular) = 0;
478
479//////////////////////////////////////////////////////////////////////////
480// new since 1.2.11
481//////////////////////////////////////////////////////////////////////////
482
483 virtual DString trReferences() = 0;
484
485//////////////////////////////////////////////////////////////////////////
486// new since 1.2.13
487//////////////////////////////////////////////////////////////////////////
488
489 virtual DString trImplementedFromList(int numEntries) = 0;
490 virtual DString trImplementedInList(int numEntries) = 0;
491
492//////////////////////////////////////////////////////////////////////////
493// new since 1.2.16
494//////////////////////////////////////////////////////////////////////////
495
496 virtual DString trRTFTableOfContents() = 0;
497
498//////////////////////////////////////////////////////////////////////////
499// new since 1.2.17
500//////////////////////////////////////////////////////////////////////////
501
502 virtual DString trDeprecatedList() = 0;
503
504//////////////////////////////////////////////////////////////////////////
505// new since 1.2.18
506//////////////////////////////////////////////////////////////////////////
507
508 virtual DString trEvents() = 0;
509 virtual DString trEventDocumentation() = 0;
510
511//////////////////////////////////////////////////////////////////////////
512// new since 1.3
513//////////////////////////////////////////////////////////////////////////
514
515 virtual DString trPackageTypes() = 0;
516 virtual DString trPackageFunctions() = 0;
517 virtual DString trPackageMembers() = 0;
518 virtual DString trStaticPackageFunctions() = 0;
519 virtual DString trPackageAttribs() = 0;
520 virtual DString trStaticPackageAttribs() = 0;
521
522//////////////////////////////////////////////////////////////////////////
523// new since 1.3.1
524//////////////////////////////////////////////////////////////////////////
525
526 virtual DString trAll() = 0;
527 virtual DString trCallGraph() = 0;
528
529//////////////////////////////////////////////////////////////////////////
530// new since 1.3.3
531//////////////////////////////////////////////////////////////////////////
532
533 virtual DString trSearchResultsTitle() = 0;
534 virtual DString trSearchResults(int numDocuments) = 0;
535 virtual DString trSearchMatches() = 0;
536
537//////////////////////////////////////////////////////////////////////////
538// new since 1.3.8
539//////////////////////////////////////////////////////////////////////////
540
541 virtual DString trSourceFile(const DString& filename) = 0;
542
543//////////////////////////////////////////////////////////////////////////
544// new since 1.3.9
545//////////////////////////////////////////////////////////////////////////
546
547 virtual DString trDirIndex() = 0;
548 virtual DString trDirDocumentation() = 0;
549 virtual DString trDirectories() = 0;
550 virtual DString trDirReference(const DString &dirName) = 0;
551 virtual DString trDir(bool first_capital, bool singular) = 0;
552
553//////////////////////////////////////////////////////////////////////////
554// new since 1.4.1
555//////////////////////////////////////////////////////////////////////////
556
557 virtual DString trOverloadText() = 0;
558
559//////////////////////////////////////////////////////////////////////////
560// new since 1.4.6
561//////////////////////////////////////////////////////////////////////////
562
563 virtual DString trCallerGraph() = 0;
564 virtual DString trEnumerationValueDocumentation() = 0;
565
566//////////////////////////////////////////////////////////////////////////
567// new since 1.5.4
568//////////////////////////////////////////////////////////////////////////
569
570 virtual DString trMemberFunctionDocumentationFortran() = 0;
571 virtual DString trCompoundListFortran() = 0;
572 virtual DString trCompoundMembersFortran() = 0;
573 virtual DString trCompoundListDescriptionFortran() = 0;
574 virtual DString trCompoundMembersDescriptionFortran(bool extractAll) = 0;
575 virtual DString trCompoundIndexFortran() = 0;
576 virtual DString trTypeDocumentation() = 0;
577 virtual DString trSubprograms() = 0;
578 virtual DString trSubprogramDocumentation() = 0;
579 virtual DString trDataTypes() = 0;
580 virtual DString trModulesList() = 0;
581 virtual DString trModulesListDescription(bool extractAll) = 0;
582 virtual DString trCompoundReferenceFortran(const DString &clName,
583 ClassDef::CompoundType compType,
584 bool isTemplate) = 0;
585 virtual DString trModuleReference(const DString &namespaceName) = 0;
586 virtual DString trModulesMembers() = 0;
587 virtual DString trModulesMemberDescription(bool extractAll) = 0;
588 virtual DString trModulesIndex() = 0;
589 virtual DString trModule(bool first_capital, bool singular) = 0;
590 virtual DString trGeneratedFromFilesFortran(ClassDef::CompoundType compType,
591 bool single) = 0;
592 virtual DString trType(bool first_capital, bool singular) = 0;
593 virtual DString trSubprogram(bool first_capital, bool singular) = 0;
594 virtual DString trTypeConstraints() = 0;
595
596//////////////////////////////////////////////////////////////////////////
597// new since 1.6.0
598//////////////////////////////////////////////////////////////////////////
599
600 virtual DString trDirRelation(const DString &name) = 0;
601 virtual DString trLoading() = 0;
602 virtual DString trGlobalNamespace() = 0;
603 virtual DString trSearching() = 0;
604 virtual DString trNoMatches() = 0;
605
606//////////////////////////////////////////////////////////////////////////
607// new since 1.6.3
608//////////////////////////////////////////////////////////////////////////
609
610 virtual DString trFileIn(const DString &name) = 0;
611 virtual DString trIncludesFileIn(const DString &name) = 0;
612 virtual DString trDateTime(int year,int month,int day,int dayOfWeek,
613 int hour,int minutes,int seconds,
614 DateTimeType includeTime) = 0;
615 virtual DString trDayOfWeek(int dayOfWeek, bool first_capital, bool full) = 0;
616 virtual DString trMonth(int month, bool first_capital, bool full) = 0;
617 virtual DString trDayPeriod(bool period) = 0;
618
619//////////////////////////////////////////////////////////////////////////
620// new since 1.7.5
621//////////////////////////////////////////////////////////////////////////
622
623 virtual DString trCiteReferences() = 0;
624 virtual DString trCopyright() = 0;
625 virtual DString trDirDepGraph(const DString &name) = 0;
626
627//////////////////////////////////////////////////////////////////////////
628// new since 1.8.0
629//////////////////////////////////////////////////////////////////////////
630
631 virtual DString trDetailLevel() = 0;
632 virtual DString trTemplateParameters() = 0;
633 virtual DString trAndMore(const DString &number) = 0;
634 virtual DString trEnumGeneratedFromFiles(bool single) = 0;
635 virtual DString trEnumReference(const DString &name) = 0;
636 virtual DString trInheritedFrom(const DString &members,const DString &what) = 0;
637 virtual DString trAdditionalInheritedMembers() = 0;
638
639//////////////////////////////////////////////////////////////////////////
640// new since 1.8.2
641//////////////////////////////////////////////////////////////////////////
642
643 virtual DString trPanelSynchronisationTooltip(bool enable) = 0;
644 virtual DString trProvidedByCategory() = 0;
645 virtual DString trExtendsClass() = 0;
646 virtual DString trClassMethods() = 0;
647 virtual DString trInstanceMethods() = 0;
648 virtual DString trMethodDocumentation() = 0;
649
650//////////////////////////////////////////////////////////////////////////
651// new since 1.8.4
652//////////////////////////////////////////////////////////////////////////
653
654 virtual DString trInterfaces() = 0;
655 virtual DString trServices() = 0;
656 virtual DString trConstantGroups() = 0;
657 virtual DString trConstantGroupReference(const DString &namespaceName) = 0;
658 virtual DString trServiceReference(const DString &sName) = 0;
659 virtual DString trSingletonReference(const DString &sName) = 0;
660 virtual DString trServiceGeneratedFromFiles(bool single) = 0;
661 virtual DString trSingletonGeneratedFromFiles(bool single) = 0;
662
663//////////////////////////////////////////////////////////////////////////
664// new since 1.8.15
665//////////////////////////////////////////////////////////////////////////
666
667 virtual DString trDesignUnitHierarchy() = 0;
668 virtual DString trDesignUnitList() = 0;
669 virtual DString trDesignUnitMembers() = 0;
670 virtual DString trDesignUnitListDescription() = 0;
671 virtual DString trDesignUnitIndex() = 0;
672 virtual DString trDesignUnits() = 0;
673 virtual DString trFunctionAndProc() = 0;
674 virtual DString trVhdlType(VhdlSpecifier type,bool single) = 0;
675 virtual DString trCustomReference(const DString &name) = 0;
676
677 virtual DString trConstants() = 0;
678 virtual DString trConstantDocumentation() = 0;
679 virtual DString trSequences() = 0;
680 virtual DString trSequenceDocumentation() = 0;
681 virtual DString trDictionaries() = 0;
682 virtual DString trDictionaryDocumentation() = 0;
683 virtual DString trSliceInterfaces() = 0;
684 virtual DString trInterfaceIndex() = 0;
685 virtual DString trInterfaceList() = 0;
686 virtual DString trInterfaceListDescription() = 0;
687 virtual DString trInterfaceHierarchy() = 0;
688 virtual DString trInterfaceHierarchyDescription() = 0;
689 virtual DString trInterfaceDocumentation() = 0;
690 virtual DString trStructs() = 0;
691 virtual DString trStructIndex() = 0;
692 virtual DString trStructList() = 0;
693 virtual DString trStructListDescription() = 0;
694 virtual DString trStructDocumentation() = 0;
695 virtual DString trExceptionIndex() = 0;
696 virtual DString trExceptionList() = 0;
697 virtual DString trExceptionListDescription() = 0;
698 virtual DString trExceptionHierarchy() = 0;
699 virtual DString trExceptionHierarchyDescription() = 0;
700 virtual DString trExceptionDocumentation() = 0;
701 virtual DString trCompoundReferenceSlice(const DString &clName, ClassDef::CompoundType compType, bool isLocal) = 0;
702 virtual DString trOperations() = 0;
703 virtual DString trOperationDocumentation() = 0;
704 virtual DString trDataMembers() = 0;
705 virtual DString trDataMemberDocumentation() = 0;
706
707//////////////////////////////////////////////////////////////////////////
708// new since 1.8.19
709//////////////////////////////////////////////////////////////////////////
710
711 virtual DString trDesignUnitDocumentation() = 0;
712
713//////////////////////////////////////////////////////////////////////////
714// new since 1.9.2
715//////////////////////////////////////////////////////////////////////////
716
717 virtual DString trConcept(bool first_capital, bool singular) = 0;
718 virtual DString trConceptReference(const DString &conceptName) = 0;
719 virtual DString trConceptList() = 0;
720 virtual DString trConceptIndex() = 0;
721 virtual DString trConceptDocumentation() = 0;
722 virtual DString trConceptListDescription(bool extractAll) = 0;
723 virtual DString trConceptDefinition() = 0;
724
725//////////////////////////////////////////////////////////////////////////
726// new since 1.9.4
727//////////////////////////////////////////////////////////////////////////
728 virtual DString trPackageList() = 0;
729
730//////////////////////////////////////////////////////////////////////////
731// new since 1.9.6
732//////////////////////////////////////////////////////////////////////////
733 virtual DString trFlowchart() = 0;
734
735//////////////////////////////////////////////////////////////////////////
736// new since 1.9.7
737//////////////////////////////////////////////////////////////////////////
738 virtual DString trRelatedSymbols() = 0;
739 virtual DString trRelatedSymbolsSubscript() = 0;
740 virtual DString trRelatedSymbolDocumentation() = 0;
741
742 virtual DString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang) = 0;
743
744 virtual DString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl) = 0;
745 virtual DString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl) = 0;
746 virtual DString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl) = 0;
747 virtual DString trDefinition() = 0;
748 virtual DString trDeclaration() = 0;
749//////////////////////////////////////////////////////////////////////////
750// new since 1.9.8
751//////////////////////////////////////////////////////////////////////////
752 virtual DString trTopics() = 0;
753 virtual DString trTopicDocumentation() = 0;
754 virtual DString trTopicList() = 0;
755 virtual DString trTopicIndex() = 0;
756 virtual DString trTopicListDescription() = 0;
757 virtual DString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl) = 0;
758 virtual DString trExportedModules() = 0;
759//////////////////////////////////////////////////////////////////////////
760// new since 1.10.0
761//////////////////////////////////////////////////////////////////////////
762 virtual DString trCopyToClipboard() = 0;
763//////////////////////////////////////////////////////////////////////////
764// new since 1.11.0
765//////////////////////////////////////////////////////////////////////////
766 virtual DString trImportant() = 0;
767
768//////////////////////////////////////////////////////////////////////////
769// new since 1.16.0
770//////////////////////////////////////////////////////////////////////////
771 virtual DString trRequirements() = 0;
772 virtual DString trRequirementID() = 0;
773 virtual DString trSatisfies(bool singular) = 0;
774 virtual DString trSatisfiedBy(const DString &list) = 0;
775 virtual DString trUnsatisfiedRequirements() = 0;
776 virtual DString trUnsatisfiedRequirementsText(bool singular,const DString &list) = 0;
777 virtual DString trVerifies(bool singular) = 0;
778 virtual DString trVerifiedBy(const DString &list) = 0;
779 virtual DString trUnverifiedRequirements() = 0;
780 virtual DString trUnverifiedRequirementsText(bool singular,const DString &list) = 0;
781
782
783
784//////////////////////////////////////////////////////////////////////////
785// helpers
786//////////////////////////////////////////////////////////////////////////
787 protected:
788 DString p_latexCommandName(const DString &latexCmd)
789 {
790 DString latex_command = Config_getString(LATEX_CMD_NAME);
791 if (latex_command.empty()) latex_command = "latex";
792 if (Config_getBool(USE_PDFLATEX))
793 {
794 if (latex_command == "latex") latex_command = latexCmd;
795 }
796 return latex_command;
797 }
798 /*! For easy flexible-noun implementation.
799 * \internal
800 */
801 DString createNoun(bool first_capital, bool singular,
802 const DString &base,
803 const DString &plurSuffix, const DString &singSuffix = "" )
804 {
805 DString result;
806 if (first_capital)
807 {
808 DString lc = getUTF8CharAt(base.str(),0);
809 DString uc = convertUTF8ToUpper(lc.str());
810 result = uc + base.mid(lc.length());
811 }
812 else
813 {
814 result = base;
815 }
816 result += (singular ? singSuffix : plurSuffix);
817 return result;
818 }
819
820};
821
822#endif
ClassDef::CompoundType
CompoundType
The various compound types.
Definition classdef.h:109
DString
A String class for use with Doxygen wrapping std::string and adding some additional functionality off...
Definition dstring.h:89
DString::DString
DString()=default
DString::mid
DString mid(size_t index, size_t len=npos) const
Definition dstring.h:323
DString::empty
bool empty() const
Returns true iff the string is empty (std::string compatible alias for isEmpty()).
Definition dstring.h:153
DString::str
const std::string & str() const
Definition dstring.h:634
DString::length
size_t length() const
Returns the length of the string, not counting the 0-terminator.
Definition dstring.h:156
Translator
Abstract base class for all translatable text fragments.
Definition translator.h:29
Translator::trCompoundMembers
virtual DString trCompoundMembers()=0
Translator::trFileDocumentation
virtual DString trFileDocumentation()=0
Translator::trFunctionAndProc
virtual DString trFunctionAndProc()=0
Translator::latexDocumentPost
virtual DString latexDocumentPost()
Definition translator.h:69
Translator::trConceptReference
virtual DString trConceptReference(const DString &conceptName)=0
Translator::trStaticProtectedAttribs
virtual DString trStaticProtectedAttribs()=0
Translator::trVerifies
virtual DString trVerifies(bool singular)=0
Translator::trTypeConstraints
virtual DString trTypeConstraints()=0
Translator::trProtectedTypes
virtual DString trProtectedTypes()=0
Translator::trTypedefs
virtual DString trTypedefs()=0
Translator::trConceptList
virtual DString trConceptList()=0
Translator::trTestList
virtual DString trTestList()=0
Translator::trGraphicalHierarchy
virtual DString trGraphicalHierarchy()=0
Translator::trBugList
virtual DString trBugList()=0
Translator::trUnsatisfiedRequirements
virtual DString trUnsatisfiedRequirements()=0
Translator::trTopics
virtual DString trTopics()=0
Translator::trModulesMembers
virtual DString trModulesMembers()=0
Translator::trReferences
virtual DString trReferences()=0
Translator::trCompoundMembersFortran
virtual DString trCompoundMembersFortran()=0
Translator::trCompoundReference
virtual DString trCompoundReference(const DString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
Translator::trStaticProtectedMembers
virtual DString trStaticProtectedMembers()=0
Translator::trPublicAttribs
virtual DString trPublicAttribs()=0
Translator::trExceptions
virtual DString trExceptions()=0
Translator::trModulesList
virtual DString trModulesList()=0
Translator::trEnumerations
virtual DString trEnumerations()=0
Translator::trDirDepGraph
virtual DString trDirDepGraph(const DString &name)=0
Translator::trReturns
virtual DString trReturns()=0
Translator::trRelatedSymbolDocumentation
virtual DString trRelatedSymbolDocumentation()=0
Translator::trBug
virtual DString trBug()=0
Translator::trProvidedByCategory
virtual DString trProvidedByCategory()=0
Translator::trIncludingInheritedMembers
virtual DString trIncludingInheritedMembers()=0
Translator::trClasses
virtual DString trClasses()=0
Translator::trDetailedDescription
virtual DString trDetailedDescription()=0
Translator::trParameters
virtual DString trParameters()=0
Translator::trDataMemberDocumentation
virtual DString trDataMemberDocumentation()=0
Translator::trRequirements
virtual DString trRequirements()=0
Translator::trFileMembersDescriptionTotal
virtual DString trFileMembersDescriptionTotal(FileMemberHighlight::Enum hl)=0
Translator::trExceptionDocumentation
virtual DString trExceptionDocumentation()=0
Translator::trInterfaceIndex
virtual DString trInterfaceIndex()=0
Translator::trNamespaceMembers
virtual DString trNamespaceMembers()=0
Translator::trCopyright
virtual DString trCopyright()=0
Translator::trLegend
virtual DString trLegend()=0
Translator::trVariableDocumentation
virtual DString trVariableDocumentation()=0
Translator::trNamespaceMemberDescription
virtual DString trNamespaceMemberDescription(bool extractAll)=0
Translator::trSearching
virtual DString trSearching()=0
Translator::trFileMembersDescription
virtual DString trFileMembersDescription(bool extractAll)=0
Translator::trGroup
virtual DString trGroup(bool first_capital, bool singular)=0
Translator::trPackageMembers
virtual DString trPackageMembers()=0
Translator::trNamespaceList
virtual DString trNamespaceList()=0
Translator::createNoun
DString createNoun(bool first_capital, bool singular, const DString &base, const DString &plurSuffix, const DString &singSuffix="")
Definition translator.h:801
Translator::trRelatedFunctionDocumentation
virtual DString trRelatedFunctionDocumentation()=0
Translator::trRTFCharSet
virtual DString trRTFCharSet()=0
Translator::trWarning
virtual DString trWarning()=0
Translator::idLanguage
virtual DString idLanguage()=0
Translator::trPrivateAttribs
virtual DString trPrivateAttribs()=0
Translator::trExceptionList
virtual DString trExceptionList()=0
Translator::trServiceGeneratedFromFiles
virtual DString trServiceGeneratedFromFiles(bool single)=0
Translator::trGeneratedAt
virtual DString trGeneratedAt(const DString &date, const DString &projName)=0
Translator::trMemberList
virtual DString trMemberList()=0
Translator::trSequenceDocumentation
virtual DString trSequenceDocumentation()=0
Translator::trIncludesFileIn
virtual DString trIncludesFileIn(const DString &name)=0
Translator::latexFontenc
virtual DString latexFontenc()
Definition translator.h:54
Translator::trSince
virtual DString trSince()=0
Translator::trInheritedFrom
virtual DString trInheritedFrom(const DString &members, const DString &what)=0
Translator::trTypedefDocumentation
virtual DString trTypedefDocumentation()=0
Translator::trPackage
virtual DString trPackage(const DString &name)=0
Translator::trPrivateSlots
virtual DString trPrivateSlots()=0
Translator::trAdditionalInheritedMembers
virtual DString trAdditionalInheritedMembers()=0
Translator::trReimplementedFromList
virtual DString trReimplementedFromList(int numEntries)=0
Translator::trNamespace
virtual DString trNamespace(bool first_capital, bool singular)=0
Translator::trNote
virtual DString trNote()=0
Translator::updateNeededMessage
virtual DString updateNeededMessage()
Definition translator.h:37
Translator::trCode
virtual DString trCode()=0
Translator::trDefineValue
virtual DString trDefineValue()=0
Translator::trCompoundReferenceSlice
virtual DString trCompoundReferenceSlice(const DString &clName, ClassDef::CompoundType compType, bool isLocal)=0
Translator::trStructs
virtual DString trStructs()=0
Translator::trType
virtual DString trType(bool first_capital, bool singular)=0
Translator::trAuthor
virtual DString trAuthor(bool first_capital, bool singular)=0
Translator::trPrivateTypes
virtual DString trPrivateTypes()=0
Translator::trClassDocumentation
virtual DString trClassDocumentation()=0
Translator::trHierarchicalIndex
virtual DString trHierarchicalIndex()=0
Translator::trSubprogram
virtual DString trSubprogram(bool first_capital, bool singular)=0
Translator::trExceptionHierarchyDescription
virtual DString trExceptionHierarchyDescription()=0
Translator::trReturnValues
virtual DString trReturnValues()=0
Translator::trRelatedSubscript
virtual DString trRelatedSubscript()=0
Translator::trCiteReferences
virtual DString trCiteReferences()=0
Translator::trOperationDocumentation
virtual DString trOperationDocumentation()=0
Translator::trOverloadText
virtual DString trOverloadText()=0
Translator::trFileReference
virtual DString trFileReference(const DString &fileName)=0
Translator::trDirRelation
virtual DString trDirRelation(const DString &name)=0
Translator::latexLanguageSupportCommand
virtual DString latexLanguageSupportCommand()=0
Translator::trInterfaceList
virtual DString trInterfaceList()=0
Translator::trSequences
virtual DString trSequences()=0
Translator::trClassMethods
virtual DString trClassMethods()=0
Translator::trServiceReference
virtual DString trServiceReference(const DString &sName)=0
Translator::trVersion
virtual DString trVersion()=0
Translator::trFunctions
virtual DString trFunctions()=0
Translator::trReferenceManual
virtual DString trReferenceManual()=0
Translator::trClassDiagram
virtual DString trClassDiagram(const DString &clName)=0
Translator::trImplementedInList
virtual DString trImplementedInList(int numEntries)=0
Translator::trMemberEnumerationDocumentation
virtual DString trMemberEnumerationDocumentation()=0
Translator::trProtectedSlots
virtual DString trProtectedSlots()=0
Translator::trInterfaceListDescription
virtual DString trInterfaceListDescription()=0
Translator::trTemplateParameters
virtual DString trTemplateParameters()=0
Translator::trReferencedBy
virtual DString trReferencedBy()=0
Translator::trFriends
virtual DString trFriends()=0
Translator::trCustomReference
virtual DString trCustomReference(const DString &name)=0
Translator::trConceptIndex
virtual DString trConceptIndex()=0
Translator::trCompoundType
virtual DString trCompoundType(ClassDef::CompoundType compType, SrcLangExt lang)=0
Translator::trPropertyDocumentation
virtual DString trPropertyDocumentation()=0
Translator::trTopicIndex
virtual DString trTopicIndex()=0
Translator::trInstanceMethods
virtual DString trInstanceMethods()=0
Translator::trGotoTextualHierarchy
virtual DString trGotoTextualHierarchy()=0
Translator::trGotoDocumentation
virtual DString trGotoDocumentation()=0
Translator::trExceptionHierarchy
virtual DString trExceptionHierarchy()=0
Translator::trCompoundList
virtual DString trCompoundList()=0
Translator::trModuleIndex
virtual DString trModuleIndex()=0
Translator::trCollaborationDiagram
virtual DString trCollaborationDiagram(const DString &clName)=0
Translator::trPackageAttribs
virtual DString trPackageAttribs()=0
Translator::trDetailLevel
virtual DString trDetailLevel()=0
Translator::trInitialValue
virtual DString trInitialValue()=0
Translator::trEnumerationTypeDocumentation
virtual DString trEnumerationTypeDocumentation()=0
Translator::trImplementedFromList
virtual DString trImplementedFromList(int numEntries)=0
Translator::trInterfaceHierarchy
virtual DString trInterfaceHierarchy()=0
Translator::trDir
virtual DString trDir(bool first_capital, bool singular)=0
Translator::trSearchResults
virtual DString trSearchResults(int numDocuments)=0
Translator::trTypeDocumentation
virtual DString trTypeDocumentation()=0
Translator::trPackageList
virtual DString trPackageList()=0
Translator::trInterfaceDocumentation
virtual DString trInterfaceDocumentation()=0
Translator::trMemberTypedefDocumentation
virtual DString trMemberTypedefDocumentation()=0
Translator::trEnumerationValueDocumentation
virtual DString trEnumerationValueDocumentation()=0
Translator::trModulesDescription
virtual DString trModulesDescription()=0
Translator::trStaticPackageAttribs
virtual DString trStaticPackageAttribs()=0
Translator::trStructListDescription
virtual DString trStructListDescription()=0
Translator::trOperations
virtual DString trOperations()=0
Translator::trGlobalNamespace
virtual DString trGlobalNamespace()=0
Translator::trConceptDefinition
virtual DString trConceptDefinition()=0
Translator::trDefineDocumentation
virtual DString trDefineDocumentation()=0
Translator::p_latexCommandName
DString p_latexCommandName(const DString &latexCmd)
Definition translator.h:788
Translator::trDesignUnitListDescription
virtual DString trDesignUnitListDescription()=0
Translator::trDocumentation
virtual DString trDocumentation(const DString &projName)=0
Translator::trExamplesDescription
virtual DString trExamplesDescription()=0
Translator::trImportant
virtual DString trImportant()=0
Translator::trNamespaceDocumentation
virtual DString trNamespaceDocumentation()=0
Translator::trCompounds
virtual DString trCompounds()=0
Translator::trFileList
virtual DString trFileList()=0
Translator::trDateTime
virtual DString trDateTime(int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime)=0
Translator::trModules
virtual DString trModules()=0
Translator::trRequirementID
virtual DString trRequirementID()=0
Translator::trLegendDocs
virtual DString trLegendDocs()=0
Translator::trTodoList
virtual DString trTodoList()=0
Translator::trInheritedByList
virtual DString trInheritedByList(int numEntries)=0
Translator::trDefines
virtual DString trDefines()=0
Translator::trRelatedPages
virtual DString trRelatedPages()=0
Translator::trInclDepGraph
virtual DString trInclDepGraph(const DString &fName)=0
Translator::trUnverifiedRequirementsText
virtual DString trUnverifiedRequirementsText(bool singular, const DString &list)=0
Translator::trMore
virtual DString trMore()=0
Translator::trLegendTitle
virtual DString trLegendTitle()=0
Translator::trEnumName
virtual DString trEnumName()=0
Translator::trDefinedIn
virtual DString trDefinedIn()=0
Translator::trPublicMembers
virtual DString trPublicMembers()=0
Translator::trSubprogramDocumentation
virtual DString trSubprogramDocumentation()=0
Translator::trCompoundListDescriptionFortran
virtual DString trCompoundListDescriptionFortran()=0
Translator::trVhdlType
virtual DString trVhdlType(VhdlSpecifier type, bool single)=0
Translator::trInterfaces
virtual DString trInterfaces()=0
Translator::trRelatedSymbols
virtual DString trRelatedSymbols()=0
Translator::trFileMembers
virtual DString trFileMembers()=0
Translator::trDesignUnitHierarchy
virtual DString trDesignUnitHierarchy()=0
Translator::trDesignUnits
virtual DString trDesignUnits()=0
Translator::trProtectedMembers
virtual DString trProtectedMembers()=0
Translator::trDirectories
virtual DString trDirectories()=0
Translator::trInterfaceHierarchyDescription
virtual DString trInterfaceHierarchyDescription()=0
Translator::trStaticPrivateAttribs
virtual DString trStaticPrivateAttribs()=0
Translator::trSatisfiedBy
virtual DString trSatisfiedBy(const DString &list)=0
Translator::trStructIndex
virtual DString trStructIndex()=0
Translator::trExceptionIndex
virtual DString trExceptionIndex()=0
Translator::trConstructorDocumentation
virtual DString trConstructorDocumentation()=0
Translator::trThisIsTheListOfAllMembers
virtual DString trThisIsTheListOfAllMembers()=0
Translator::trEnumGeneratedFromFiles
virtual DString trEnumGeneratedFromFiles(bool single)=0
Translator::trPackageTypes
virtual DString trPackageTypes()=0
Translator::trExportedModules
virtual DString trExportedModules()=0
Translator::trModule
virtual DString trModule(bool first_capital, bool singular)=0
Translator::trSingletonReference
virtual DString trSingletonReference(const DString &sName)=0
Translator::trDictionaryDocumentation
virtual DString trDictionaryDocumentation()=0
Translator::trProtectedAttribs
virtual DString trProtectedAttribs()=0
Translator::trPageIndex
virtual DString trPageIndex()=0
Translator::trISOLang
virtual DString trISOLang()=0
Translator::trDeclaration
virtual DString trDeclaration()=0
Translator::trPrecondition
virtual DString trPrecondition()=0
Translator::trModuleDocumentation
virtual DString trModuleDocumentation()=0
Translator::trSearchMatches
virtual DString trSearchMatches()=0
Translator::trDesignUnitMembers
virtual DString trDesignUnitMembers()=0
Translator::latexFont
virtual DString latexFont()
Definition translator.h:55
Translator::latexDocumentPre
virtual DString latexDocumentPre()
Definition translator.h:64
Translator::trModuleReference
virtual DString trModuleReference(const DString &namespaceName)=0
Translator::trFlowchart
virtual DString trFlowchart()=0
Translator::trRTFansicp
virtual DString trRTFansicp()=0
Translator::trConstantGroups
virtual DString trConstantGroups()=0
Translator::trDefinedAtLineInSourceFile
virtual DString trDefinedAtLineInSourceFile()=0
Translator::getLanguageString
virtual DString getLanguageString()=0
language codes for Html help
Translator::trDayOfWeek
virtual DString trDayOfWeek(int dayOfWeek, bool first_capital, bool full)=0
Translator::trAttention
virtual DString trAttention()=0
Translator::trExceptionListDescription
virtual DString trExceptionListDescription()=0
Translator::trProperties
virtual DString trProperties()=0
Translator::trPageAbbreviation
virtual DString trPageAbbreviation()=0
Translator::trRelatedPagesDescription
virtual DString trRelatedPagesDescription()=0
Translator::trInvariant
virtual DString trInvariant()=0
Translator::trDesignUnitList
virtual DString trDesignUnitList()=0
Translator::trModulesMemberDescription
virtual DString trModulesMemberDescription(bool extractAll)=0
Translator::trClass
virtual DString trClass(bool first_capital, bool singular)=0
Translator::trReimplementedInList
virtual DString trReimplementedInList(int numEntries)=0
Translator::trCompoundIndexFortran
virtual DString trCompoundIndexFortran()=0
Translator::trDataTypes
virtual DString trDataTypes()=0
Translator::trCompoundListDescription
virtual DString trCompoundListDescription()=0
Translator::trConcept
virtual DString trConcept(bool first_capital, bool singular)=0
Translator::trTopicListDescription
virtual DString trTopicListDescription()=0
Translator::trModulesIndex
virtual DString trModulesIndex()=0
Translator::trFileIn
virtual DString trFileIn(const DString &name)=0
Translator::trModuleMembersDescriptionTotal
virtual DString trModuleMembersDescriptionTotal(ModuleMemberHighlight::Enum hl)=0
Translator::trUnsatisfiedRequirementsText
virtual DString trUnsatisfiedRequirementsText(bool singular, const DString &list)=0
Translator::trDataMembers
virtual DString trDataMembers()=0
Translator::trFileListDescription
virtual DString trFileListDescription(bool extractAll)=0
Translator::trClassHierarchyDescription
virtual DString trClassHierarchyDescription()=0
Translator::trSliceInterfaces
virtual DString trSliceInterfaces()=0
Translator::trConceptListDescription
virtual DString trConceptListDescription(bool extractAll)=0
Translator::trFunctionDocumentation
virtual DString trFunctionDocumentation()=0
Translator::trInclByDepGraph
virtual DString trInclByDepGraph()=0
Translator::trPanelSynchronisationTooltip
virtual DString trPanelSynchronisationTooltip(bool enable)=0
Translator::trSubprograms
virtual DString trSubprograms()=0
Translator::trVerifiedBy
virtual DString trVerifiedBy(const DString &list)=0
Translator::trDetails
virtual DString trDetails()=0
Translator::trExtendsClass
virtual DString trExtendsClass()=0
Translator::trAll
virtual DString trAll()=0
Translator::trMemberFunctionDocumentationFortran
virtual DString trMemberFunctionDocumentationFortran()=0
Translator::trMemberFunctionDocumentation
virtual DString trMemberFunctionDocumentation()=0
Translator::trCompoundListFortran
virtual DString trCompoundListFortran()=0
Translator::trTopicDocumentation
virtual DString trTopicDocumentation()=0
Translator::trCallerGraph
virtual DString trCallerGraph()=0
Translator::trDeprecatedList
virtual DString trDeprecatedList()=0
Translator::trPackageFunctions
virtual DString trPackageFunctions()=0
Translator::needsPunctuation
virtual bool needsPunctuation()
add punctuation at the end of a brief description when needed and supported by the language
Definition translator.h:154
Translator::trWriteList
virtual DString trWriteList(int numEntries)=0
Translator::trMember
virtual DString trMember(bool first_capital, bool singular)=0
Translator::trPackages
virtual DString trPackages()=0
Translator::trGeneratedFromFiles
virtual DString trGeneratedFromFiles(ClassDef::CompoundType compType, bool single)=0
Translator::trPrivateMembers
virtual DString trPrivateMembers()=0
Translator::trSearch
virtual DString trSearch()=0
Translator::trPackageListDescription
virtual DString trPackageListDescription()=0
Translator::trGeneratedBy
virtual DString trGeneratedBy()=0
Translator::trRTFGeneralIndex
virtual DString trRTFGeneralIndex()=0
Translator::trConstantDocumentation
virtual DString trConstantDocumentation()=0
Translator::trDirReference
virtual DString trDirReference(const DString &dirName)=0
Translator::trPublicTypes
virtual DString trPublicTypes()=0
Translator::trDefinition
virtual DString trDefinition()=0
Translator::trVariables
virtual DString trVariables()=0
Translator::trStaticPublicMembers
virtual DString trStaticPublicMembers()=0
Translator::trMethodDocumentation
virtual DString trMethodDocumentation()=0
Translator::trConceptDocumentation
virtual DString trConceptDocumentation()=0
Translator::trRemarks
virtual DString trRemarks()=0
Translator::trDeprecated
virtual DString trDeprecated()=0
Translator::trDate
virtual DString trDate()=0
Translator::trEnumerationValues
virtual DString trEnumerationValues()=0
Translator::trSourceFile
virtual DString trSourceFile(const DString &filename)=0
Translator::trRTFTableOfContents
virtual DString trRTFTableOfContents()=0
Translator::trAndMore
virtual DString trAndMore(const DString &number)=0
Translator::trListOfAllMembers
virtual DString trListOfAllMembers()=0
Translator::trSeeAlso
virtual DString trSeeAlso()=0
Translator::trTodo
virtual DString trTodo()=0
Translator::trNoMatches
virtual DString trNoMatches()=0
Translator::trRelatedSymbolsSubscript
virtual DString trRelatedSymbolsSubscript()=0
Translator::trDirDocumentation
virtual DString trDirDocumentation()=0
Translator::trStaticPublicAttribs
virtual DString trStaticPublicAttribs()=0
Translator::trSatisfies
virtual DString trSatisfies(bool singular)=0
Translator::trModulesListDescription
virtual DString trModulesListDescription(bool extractAll)=0
Translator::trEnumValue
virtual DString trEnumValue()=0
Translator::trGotoSourceCode
virtual DString trGotoSourceCode()=0
Translator::trServices
virtual DString trServices()=0
Translator::trPage
virtual DString trPage(bool first_capital, bool singular)=0
Translator::trStructList
virtual DString trStructList()=0
Translator::trNamespaceListDescription
virtual DString trNamespaceListDescription(bool extractAll)=0
Translator::trCompoundMembersDescriptionTotal
virtual DString trCompoundMembersDescriptionTotal(ClassMemberHighlight::Enum hl)=0
Translator::trRelatedFunctions
virtual DString trRelatedFunctions()=0
Translator::trTopicList
virtual DString trTopicList()=0
Translator::trInheritsList
virtual DString trInheritsList(int numEntries)=0
Translator::trSignals
virtual DString trSignals()=0
Translator::trGeneratedAutomatically
virtual DString trGeneratedAutomatically(const DString &s)=0
Translator::trClassHierarchy
virtual DString trClassHierarchy()=0
Translator::trDirIndex
virtual DString trDirIndex()=0
Translator::trCopyToClipboard
virtual DString trCopyToClipboard()=0
Translator::trUnverifiedRequirements
virtual DString trUnverifiedRequirements()=0
Translator::trNamespaceReference
virtual DString trNamespaceReference(const DString &namespaceName)=0
Translator::trGeneratedFromFilesFortran
virtual DString trGeneratedFromFilesFortran(ClassDef::CompoundType compType, bool single)=0
Translator::trPublicSlots
virtual DString trPublicSlots()=0
Translator::trCompoundIndex
virtual DString trCompoundIndex()=0
Translator::trFile
virtual DString trFile(bool first_capital, bool singular)=0
Translator::trTest
virtual DString trTest()=0
Translator::trDesignUnitIndex
virtual DString trDesignUnitIndex()=0
Translator::trConstants
virtual DString trConstants()=0
Translator::trDesignUnitDocumentation
virtual DString trDesignUnitDocumentation()=0
Translator::trSearchResultsTitle
virtual DString trSearchResultsTitle()=0
Translator::trConstantGroupReference
virtual DString trConstantGroupReference(const DString &namespaceName)=0
Translator::trDayPeriod
virtual DString trDayPeriod(bool period)=0
Translator::latexCommandName
virtual DString latexCommandName()
Definition translator.h:73
Translator::trCompoundMembersDescription
virtual DString trCompoundMembersDescription(bool extractAll)=0
Translator::trLoading
virtual DString trLoading()=0
Translator::trEventDocumentation
virtual DString trEventDocumentation()=0
Translator::trCompoundReferenceFortran
virtual DString trCompoundReferenceFortran(const DString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
Translator::trMonth
virtual DString trMonth(int month, bool first_capital, bool full)=0
Translator::trStructDocumentation
virtual DString trStructDocumentation()=0
Translator::trMainPage
virtual DString trMainPage()=0
Translator::trEnumReference
virtual DString trEnumReference(const DString &name)=0
Translator::trNamespaces
virtual DString trNamespaces()=0
Translator::trCompoundMembersDescriptionFortran
virtual DString trCompoundMembersDescriptionFortran(bool extractAll)=0
Translator::trCallGraph
virtual DString trCallGraph()=0
Translator::trSingletonGeneratedFromFiles
virtual DString trSingletonGeneratedFromFiles(bool single)=0
Translator::trMemberDataDocumentation
virtual DString trMemberDataDocumentation()=0
Translator::trEvents
virtual DString trEvents()=0
Translator::trDictionaries
virtual DString trDictionaries()=0
Translator::trStaticPackageFunctions
virtual DString trStaticPackageFunctions()=0
Translator::trFileIndex
virtual DString trFileIndex()=0
Translator::trGlobal
virtual DString trGlobal(bool first_capital, bool singular)=0
Translator::trPostcondition
virtual DString trPostcondition()=0
Translator::trExamples
virtual DString trExamples()=0
Translator::trStaticPrivateMembers
virtual DString trStaticPrivateMembers()=0
Translator::trNamespaceMembersDescriptionTotal
virtual DString trNamespaceMembersDescriptionTotal(NamespaceMemberHighlight::Enum hl)=0
Translator::trDefinedInSourceFile
virtual DString trDefinedInSourceFile()=0
Translator::trGotoGraphicalHierarchy
virtual DString trGotoGraphicalHierarchy()=0
Translator::trNamespaceIndex
virtual DString trNamespaceIndex()=0
Config_getBool
#define Config_getBool(name)
Definition config.h:33
Config_getString
#define Config_getString(name)
Definition config.h:32
ABSTRACT_BASE_CLASS
#define ABSTRACT_BASE_CLASS(cls)
Macro to implement rule of 5 for an abstract base class.
Definition construct.h:20
DateTimeType
DateTimeType
Definition datetime.h:38
SrcLangExt
SrcLangExt
Definition types.h:207
VhdlSpecifier
VhdlSpecifier
Definition types.h:770
convertUTF8ToUpper
std::string convertUTF8ToUpper(const std::string &input)
Converts the input string into a upper case version, also taking into account non-ASCII characters th...
Definition utf8.cpp:192
getUTF8CharAt
std::string getUTF8CharAt(const std::string &input, size_t pos)
Returns the UTF8 character found at byte position pos in the input string.
Definition utf8.cpp:127