Public Member Functions | List of all members
Translator Class Referenceabstract

Abstract base class for all translatable text fragments. More...

#include <translator.h>

Inheritance diagram for Translator:
Inheritance graph

Public Member Functions

virtual QCString updateNeededMessage ()
virtual QCString idLanguage ()=0
virtual QCString latexLanguageSupportCommand ()=0
virtual QCString latexFontenc ()
virtual QCString latexFont ()
virtual QCString latexDocumentPre ()
virtual QCString latexDocumentPost ()
virtual QCString latexCommandName ()
virtual QCString trISOLang ()=0
virtual QCString getLanguageString ()=0
 language codes for Html help More...
virtual bool needsPunctuation ()
 add punctuation at the end of a brief description when needed and supported by the language
virtual QCString trRelatedFunctions ()=0
virtual QCString trRelatedSubscript ()=0
virtual QCString trDetailedDescription ()=0
virtual QCString trDetails ()=0
virtual QCString trMemberTypedefDocumentation ()=0
virtual QCString trMemberEnumerationDocumentation ()=0
virtual QCString trMemberFunctionDocumentation ()=0
virtual QCString trMemberDataDocumentation ()=0
virtual QCString trMore ()=0
virtual QCString trListOfAllMembers ()=0
virtual QCString trMemberList ()=0
virtual QCString trThisIsTheListOfAllMembers ()=0
virtual QCString trIncludingInheritedMembers ()=0
virtual QCString trGeneratedAutomatically (const QCString &s)=0
virtual QCString trEnumName ()=0
virtual QCString trEnumValue ()=0
virtual QCString trDefinedIn ()=0
virtual QCString trModules ()=0
virtual QCString trClassHierarchy ()=0
virtual QCString trCompoundList ()=0
virtual QCString trFileList ()=0
virtual QCString trCompoundMembers ()=0
virtual QCString trFileMembers ()=0
virtual QCString trRelatedPages ()=0
virtual QCString trExamples ()=0
virtual QCString trSearch ()=0
virtual QCString trClassHierarchyDescription ()=0
virtual QCString trFileListDescription (bool extractAll)=0
virtual QCString trCompoundListDescription ()=0
virtual QCString trCompoundMembersDescription (bool extractAll)=0
virtual QCString trFileMembersDescription (bool extractAll)=0
virtual QCString trExamplesDescription ()=0
virtual QCString trRelatedPagesDescription ()=0
virtual QCString trModulesDescription ()=0
virtual QCString trDocumentation ()=0
virtual QCString trModuleIndex ()=0
virtual QCString trHierarchicalIndex ()=0
virtual QCString trCompoundIndex ()=0
virtual QCString trFileIndex ()=0
virtual QCString trModuleDocumentation ()=0
virtual QCString trClassDocumentation ()=0
virtual QCString trFileDocumentation ()=0
virtual QCString trReferenceManual ()=0
virtual QCString trDefines ()=0
virtual QCString trTypedefs ()=0
virtual QCString trEnumerations ()=0
virtual QCString trFunctions ()=0
virtual QCString trVariables ()=0
virtual QCString trEnumerationValues ()=0
virtual QCString trDefineDocumentation ()=0
virtual QCString trTypedefDocumentation ()=0
virtual QCString trEnumerationTypeDocumentation ()=0
virtual QCString trFunctionDocumentation ()=0
virtual QCString trVariableDocumentation ()=0
virtual QCString trCompounds ()=0
virtual QCString trGeneratedAt (const QCString &date, const QCString &projName)=0
virtual QCString trClassDiagram (const QCString &clName)=0
virtual QCString trWarning ()=0
virtual QCString trVersion ()=0
virtual QCString trDate ()=0
virtual QCString trReturns ()=0
virtual QCString trSeeAlso ()=0
virtual QCString trParameters ()=0
virtual QCString trExceptions ()=0
virtual QCString trGeneratedBy ()=0
virtual QCString trNamespaceList ()=0
virtual QCString trNamespaceListDescription (bool extractAll)=0
virtual QCString trFriends ()=0
virtual QCString trRelatedFunctionDocumentation ()=0
virtual QCString trCompoundReference (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
virtual QCString trFileReference (const QCString &fileName)=0
virtual QCString trNamespaceReference (const QCString &namespaceName)=0
virtual QCString trPublicMembers ()=0
virtual QCString trPublicSlots ()=0
virtual QCString trSignals ()=0
virtual QCString trStaticPublicMembers ()=0
virtual QCString trProtectedMembers ()=0
virtual QCString trProtectedSlots ()=0
virtual QCString trStaticProtectedMembers ()=0
virtual QCString trPrivateMembers ()=0
virtual QCString trPrivateSlots ()=0
virtual QCString trStaticPrivateMembers ()=0
virtual QCString trWriteList (int numEntries)=0
virtual QCString trInheritsList (int numEntries)=0
virtual QCString trInheritedByList (int numEntries)=0
virtual QCString trReimplementedFromList (int numEntries)=0
virtual QCString trReimplementedInList (int numEntries)=0
virtual QCString trNamespaceMembers ()=0
virtual QCString trNamespaceMemberDescription (bool extractAll)=0
virtual QCString trNamespaceIndex ()=0
virtual QCString trNamespaceDocumentation ()=0
virtual QCString trNamespaces ()=0
virtual QCString trGeneratedFromFiles (ClassDef::CompoundType compType, bool single)=0
virtual QCString trReturnValues ()=0
virtual QCString trMainPage ()=0
virtual QCString trPageAbbreviation ()=0
virtual QCString trDefinedAtLineInSourceFile ()=0
virtual QCString trDefinedInSourceFile ()=0
virtual QCString trDeprecated ()=0
virtual QCString trCollaborationDiagram (const QCString &clName)=0
virtual QCString trInclDepGraph (const QCString &fName)=0
virtual QCString trConstructorDocumentation ()=0
virtual QCString trGotoSourceCode ()=0
virtual QCString trGotoDocumentation ()=0
virtual QCString trPrecondition ()=0
virtual QCString trPostcondition ()=0
virtual QCString trInvariant ()=0
virtual QCString trInitialValue ()=0
virtual QCString trCode ()=0
virtual QCString trGraphicalHierarchy ()=0
virtual QCString trGotoGraphicalHierarchy ()=0
virtual QCString trGotoTextualHierarchy ()=0
virtual QCString trPageIndex ()=0
virtual QCString trNote ()=0
virtual QCString trPublicTypes ()=0
virtual QCString trPublicAttribs ()=0
virtual QCString trStaticPublicAttribs ()=0
virtual QCString trProtectedTypes ()=0
virtual QCString trProtectedAttribs ()=0
virtual QCString trStaticProtectedAttribs ()=0
virtual QCString trPrivateTypes ()=0
virtual QCString trPrivateAttribs ()=0
virtual QCString trStaticPrivateAttribs ()=0
virtual QCString trTodo ()=0
virtual QCString trTodoList ()=0
virtual QCString trReferencedBy ()=0
virtual QCString trRemarks ()=0
virtual QCString trAttention ()=0
virtual QCString trInclByDepGraph ()=0
virtual QCString trSince ()=0
virtual QCString trLegendTitle ()=0
virtual QCString trLegendDocs ()=0
virtual QCString trLegend ()=0
virtual QCString trTest ()=0
virtual QCString trTestList ()=0
virtual QCString trProperties ()=0
virtual QCString trPropertyDocumentation ()=0
virtual QCString trClasses ()=0
virtual QCString trPackage (const QCString &name)=0
virtual QCString trPackageListDescription ()=0
virtual QCString trPackages ()=0
virtual QCString trDefineValue ()=0
virtual QCString trBug ()=0
virtual QCString trBugList ()=0
virtual QCString trRTFansicp ()=0
virtual QCString trRTFCharSet ()=0
virtual QCString trRTFGeneralIndex ()=0
virtual QCString trClass (bool first_capital, bool singular)=0
virtual QCString trFile (bool first_capital, bool singular)=0
virtual QCString trNamespace (bool first_capital, bool singular)=0
virtual QCString trGroup (bool first_capital, bool singular)=0
virtual QCString trPage (bool first_capital, bool singular)=0
virtual QCString trMember (bool first_capital, bool singular)=0
virtual QCString trGlobal (bool first_capital, bool singular)=0
virtual QCString trAuthor (bool first_capital, bool singular)=0
virtual QCString trReferences ()=0
virtual QCString trImplementedFromList (int numEntries)=0
virtual QCString trImplementedInList (int numEntries)=0
virtual QCString trRTFTableOfContents ()=0
virtual QCString trDeprecatedList ()=0
virtual QCString trEvents ()=0
virtual QCString trEventDocumentation ()=0
virtual QCString trPackageTypes ()=0
virtual QCString trPackageFunctions ()=0
virtual QCString trPackageMembers ()=0
virtual QCString trStaticPackageFunctions ()=0
virtual QCString trPackageAttribs ()=0
virtual QCString trStaticPackageAttribs ()=0
virtual QCString trAll ()=0
virtual QCString trCallGraph ()=0
virtual QCString trSearchResultsTitle ()=0
virtual QCString trSearchResults (int numDocuments)=0
virtual QCString trSearchMatches ()=0
virtual QCString trSourceFile (QCString &filename)=0
virtual QCString trDirIndex ()=0
virtual QCString trDirDocumentation ()=0
virtual QCString trDirectories ()=0
virtual QCString trDirReference (const QCString &dirName)=0
virtual QCString trDir (bool first_capital, bool singular)=0
virtual QCString trOverloadText ()=0
virtual QCString trCallerGraph ()=0
virtual QCString trEnumerationValueDocumentation ()=0
virtual QCString trMemberFunctionDocumentationFortran ()=0
virtual QCString trCompoundListFortran ()=0
virtual QCString trCompoundMembersFortran ()=0
virtual QCString trCompoundListDescriptionFortran ()=0
virtual QCString trCompoundMembersDescriptionFortran (bool extractAll)=0
virtual QCString trCompoundIndexFortran ()=0
virtual QCString trTypeDocumentation ()=0
virtual QCString trSubprograms ()=0
virtual QCString trSubprogramDocumentation ()=0
virtual QCString trDataTypes ()=0
virtual QCString trModulesList ()=0
virtual QCString trModulesListDescription (bool extractAll)=0
virtual QCString trCompoundReferenceFortran (const QCString &clName, ClassDef::CompoundType compType, bool isTemplate)=0
virtual QCString trModuleReference (const QCString &namespaceName)=0
virtual QCString trModulesMembers ()=0
virtual QCString trModulesMemberDescription (bool extractAll)=0
virtual QCString trModulesIndex ()=0
virtual QCString trModule (bool first_capital, bool singular)=0
virtual QCString trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single)=0
virtual QCString trType (bool first_capital, bool singular)=0
virtual QCString trSubprogram (bool first_capital, bool singular)=0
virtual QCString trTypeConstraints ()=0
virtual QCString trDirRelation (const QCString &name)=0
virtual QCString trLoading ()=0
virtual QCString trGlobalNamespace ()=0
virtual QCString trSearching ()=0
virtual QCString trNoMatches ()=0
virtual QCString trFileIn (const QCString &name)=0
virtual QCString trIncludesFileIn (const QCString &name)=0
virtual QCString trDateTime (int year, int month, int day, int dayOfWeek, int hour, int minutes, int seconds, DateTimeType includeTime)=0
virtual QCString trDayOfWeek (int dayOfWeek, bool first_capital, bool full)=0
virtual QCString trMonth (int month, bool first_capital, bool full)=0
virtual QCString trDayPeriod (int period)=0
virtual QCString trCiteReferences ()=0
virtual QCString trCopyright ()=0
virtual QCString trDirDepGraph (const QCString &name)=0
virtual QCString trDetailLevel ()=0
virtual QCString trTemplateParameters ()=0
virtual QCString trAndMore (const QCString &number)=0
virtual QCString trEnumGeneratedFromFiles (bool single)=0
virtual QCString trEnumReference (const QCString &name)=0
virtual QCString trInheritedFrom (const QCString &members, const QCString &what)=0
virtual QCString trAdditionalInheritedMembers ()=0
virtual QCString trPanelSynchronisationTooltip (bool enable)=0
virtual QCString trProvidedByCategory ()=0
virtual QCString trExtendsClass ()=0
virtual QCString trClassMethods ()=0
virtual QCString trInstanceMethods ()=0
virtual QCString trMethodDocumentation ()=0
virtual QCString trInterfaces ()=0
virtual QCString trServices ()=0
virtual QCString trConstantGroups ()=0
virtual QCString trConstantGroupReference (const QCString &namespaceName)=0
virtual QCString trServiceReference (const QCString &sName)=0
virtual QCString trSingletonReference (const QCString &sName)=0
virtual QCString trServiceGeneratedFromFiles (bool single)=0
virtual QCString trSingletonGeneratedFromFiles (bool single)=0
virtual QCString trDesignUnitHierarchy ()=0
virtual QCString trDesignUnitList ()=0
virtual QCString trDesignUnitMembers ()=0
virtual QCString trDesignUnitListDescription ()=0
virtual QCString trDesignUnitIndex ()=0
virtual QCString trDesignUnits ()=0
virtual QCString trFunctionAndProc ()=0
virtual QCString trVhdlType (uint64_t type, bool single)=0
virtual QCString trCustomReference (const QCString &name)=0
virtual QCString trConstants ()=0
virtual QCString trConstantDocumentation ()=0
virtual QCString trSequences ()=0
virtual QCString trSequenceDocumentation ()=0
virtual QCString trDictionaries ()=0
virtual QCString trDictionaryDocumentation ()=0
virtual QCString trSliceInterfaces ()=0
virtual QCString trInterfaceIndex ()=0
virtual QCString trInterfaceList ()=0
virtual QCString trInterfaceListDescription ()=0
virtual QCString trInterfaceHierarchy ()=0
virtual QCString trInterfaceHierarchyDescription ()=0
virtual QCString trInterfaceDocumentation ()=0
virtual QCString trStructs ()=0
virtual QCString trStructIndex ()=0
virtual QCString trStructList ()=0
virtual QCString trStructListDescription ()=0
virtual QCString trStructDocumentation ()=0
virtual QCString trExceptionIndex ()=0
virtual QCString trExceptionList ()=0
virtual QCString trExceptionListDescription ()=0
virtual QCString trExceptionHierarchy ()=0
virtual QCString trExceptionHierarchyDescription ()=0
virtual QCString trExceptionDocumentation ()=0
virtual QCString trCompoundReferenceSlice (const QCString &clName, ClassDef::CompoundType compType, bool isLocal)=0
virtual QCString trOperations ()=0
virtual QCString trOperationDocumentation ()=0
virtual QCString trDataMembers ()=0
virtual QCString trDataMemberDocumentation ()=0
virtual QCString trDesignUnitDocumentation ()=0
virtual QCString trConcept (bool first_capital, bool singular)=0
virtual QCString trConceptReference (const QCString &conceptName)=0
virtual QCString trConceptList ()=0
virtual QCString trConceptIndex ()=0
virtual QCString trConceptDocumentation ()=0
virtual QCString trConceptListDescription (bool extractAll)=0
virtual QCString trConceptDefinition ()=0
virtual QCString trPackageList ()=0
virtual QCString trFlowchart ()=0
virtual QCString trRelatedSymbols ()=0
virtual QCString trRelatedSymbolsSubscript ()=0
virtual QCString trRelatedSymbolDocumentation ()=0
virtual QCString trCompoundType (ClassDef::CompoundType compType, SrcLangExt lang)=0
virtual QCString trFileMembersDescriptionTotal (FileMemberHighlight::Enum hl)=0
virtual QCString trCompoundMembersDescriptionTotal (ClassMemberHighlight::Enum hl)=0
virtual QCString trNamespaceMembersDescriptionTotal (NamespaceMemberHighlight::Enum hl)=0

Detailed Description

Abstract base class for all translatable text fragments.

Member Function Documentation

◆ getLanguageString()

virtual QCString Translator::getLanguageString ( )
pure virtual

language codes for Html help

 0x402 Bulgarian
 0x405 Czech
 0x406 Danish
 0x413 Dutch
 0xC09 English (Australia)
 0x809 English (Britain)
 0x1009 English (Canada)
 0x1809 English (Ireland)
 0x1409 English (New Zealand)
 0x1C09 English (South Africa)
 0x409 English (United States)
 0x40B Finnish
 0x40C French
 0x407 German
 0x408 Greece
 0x439 Hindi
 0x40E Hungarian
 0x410 Italian
 0x814 Norwegian
 0x415 Polish
 0x816 Portuguese(Portugal)
 0x416 Portuguese(Brazil)
 0x419 Russian
 0x80A Spanish(Mexico)
 0xC0A Spanish(Modern Sort)
 0x40A Spanish(Traditional Sort)
 0x41D Swedish
 0x41F Turkey
 0x411 Japanese
 0x412 Korean
 0x804 Chinese (PRC)
 0x404 Chinese (Taiwan)

New LCIDs:

 0x421 Indonesian
 0x41A Croatian
 0x418 Romanian
 0x424 Slovenian
 0x41B Slovak
 0x422 Ukrainian
 0x81A Serbian (Serbia, Latin)
 0x403 Catalan
 0x426 Latvian
 0x427 Lithuanian
 0x436 Afrikaans
 0x42A Vietnamese
 0x429 Persian (Iran)
 0xC01 Arabic (Egypt) - I don't know which version of arabic is used inside translator_ar.h ,
       so I have chosen Egypt at random

Code for Esperanto should be as shown below but the htmlhelp compiler 1.3 does not support this (and no newer version is available).

0x48f Esperanto

So do a fallback to the default language

0x409 English (United States)
0xC1A Serbian (Serbia, Cyrillic)

Implemented in TranslatorGreek, TranslatorSwedish, TranslatorHindi, TranslatorBrazilian, TranslatorCzech, TranslatorGerman, TranslatorFrench, TranslatorDanish, TranslatorFinnish, TranslatorItalian, TranslatorPortuguese, TranslatorHungarian, TranslatorVietnamese, TranslatorKorean, TranslatorPersian, TranslatorCroatian, TranslatorChinesetraditional, TranslatorLatvian, TranslatorBulgarian, TranslatorJapanese, TranslatorEsperanto, TranslatorSerbianCyrillic, TranslatorCatalan, TranslatorEnglish, TranslatorNorwegian, TranslatorRomanian, TranslatorTurkish, TranslatorSpanish, TranslatorLithuanian, TranslatorMacedonian, TranslatorJapaneseEn, TranslatorArabic, TranslatorKoreanEn, TranslatorAfrikaans, TranslatorIndonesian, TranslatorSerbian, TranslatorChinese, TranslatorPolish, TranslatorSlovak, TranslatorRussian, TranslatorDutch, TranslatorArmenian, TranslatorSlovene, and TranslatorUkrainian.

◆ latexCommandName()

virtual QCString Translator::latexCommandName ( )

Set the name to be used as latex command.

Reimplemented in TranslatorGreek, TranslatorVietnamese, TranslatorKorean, and TranslatorKoreanEn.

◆ latexDocumentPost()

virtual QCString Translator::latexDocumentPost ( )

Sets the commands to be inserted directly before the \\end{document} in the LaTeX document.

Reimplemented in TranslatorJapanese, TranslatorChinesetraditional, TranslatorChinese, and TranslatorJapaneseEn.

◆ latexDocumentPre()

virtual QCString Translator::latexDocumentPre ( )

Sets the commands to be inserted directly after the \\begin{document} in the LaTeX document.

Reimplemented in TranslatorJapanese, TranslatorChinesetraditional, TranslatorChinese, and TranslatorJapaneseEn.

◆ latexFontenc()

virtual QCString Translator::latexFontenc ( )

Sets the LaTeX font encoding to be used. The default is set to T1, in case another font encoding has to be used this can be specified with this routine. In case no font encoding is required the empty string can be returned.

Reimplemented in TranslatorJapanese, TranslatorVietnamese, TranslatorGreek, TranslatorSerbianCyrillic, TranslatorChinesetraditional, TranslatorChinese, and TranslatorJapaneseEn.

◆ trRTFansicp()

virtual QCString Translator::trRTFansicp ( )
pure virtual

Used as ansicpg for RTF file

The following table shows the correlation of Charset name, Charset Value and

Codepage number:

Charset Name Charset Value(hex) Codepage number

DEFAULT_CHARSET           1 (x01)
SYMBOL_CHARSET            2 (x02)
OEM_CHARSET             255 (xFF)
ANSI_CHARSET              0 (x00)            1252
RUSSIAN_CHARSET         204 (xCC)            1251
EE_CHARSET              238 (xEE)            1250
GREEK_CHARSET           161 (xA1)            1253
TURKISH_CHARSET         162 (xA2)            1254
BALTIC_CHARSET          186 (xBA)            1257
HEBREW_CHARSET          177 (xB1)            1255
ARABIC _CHARSET         178 (xB2)            1256
SHIFTJIS_CHARSET        128 (x80)             932
HANGEUL_CHARSET         129 (x81)             949
GB2313_CHARSET          134 (x86)             936
CHINESEBIG5_CHARSET     136 (x88)             950

Implemented in TranslatorBrazilian, TranslatorCzech, TranslatorGerman, TranslatorSwedish, TranslatorFinnish, TranslatorFrench, TranslatorSpanish, TranslatorPortuguese, TranslatorJapanese, TranslatorHungarian, TranslatorSerbianCyrillic, TranslatorEnglish, TranslatorKorean, TranslatorVietnamese, TranslatorBulgarian, TranslatorChinesetraditional, TranslatorRomanian, TranslatorLatvian, TranslatorNorwegian, TranslatorHindi, TranslatorEsperanto, TranslatorGreek, TranslatorCatalan, TranslatorArabic, TranslatorPersian, TranslatorTurkish, TranslatorLithuanian, TranslatorItalian, TranslatorMacedonian, TranslatorSerbian, TranslatorAfrikaans, TranslatorIndonesian, TranslatorDanish, TranslatorRussian, TranslatorSlovak, TranslatorPolish, TranslatorUkrainian, TranslatorArmenian, TranslatorChinese, TranslatorDutch, TranslatorCroatian, TranslatorSlovene, TranslatorJapaneseEn, and TranslatorKoreanEn.

◆ trRTFCharSet()

virtual QCString Translator::trRTFCharSet ( )
pure virtual

◆ updateNeededMessage()

virtual QCString Translator::updateNeededMessage ( )

This method is used to provide warning message that is displayed if the user chooses a language whose translation is not up to date. It is implemented by the adapter classes.

Reimplemented in TranslatorAdapter_1_4_6, TranslatorAdapter_1_6_0, TranslatorAdapter_1_7_5, TranslatorAdapter_1_8_0, TranslatorAdapter_1_8_2, TranslatorAdapter_1_8_4, TranslatorAdapter_1_8_15, TranslatorAdapter_1_8_19, TranslatorAdapter_1_9_2, TranslatorAdapter_1_9_4, TranslatorAdapter_1_9_5, TranslatorAdapter_1_9_6, and TranslatorAdapterBase.

The documentation for this class was generated from the following file: