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