TranslatorEnglish Class Reference

#include <translator_en.h>

Inheritance diagram for TranslatorEnglish:

List of all members.

Public Member Functions
virtual QCString	idLanguage ()
virtual QCString	latexLanguageSupportCommand ()
virtual QCString	idLanguageCharset ()
virtual QCString	trRelatedFunctions ()
virtual QCString	trRelatedSubscript ()
virtual QCString	trDetailedDescription ()
virtual QCString	trMemberTypedefDocumentation ()
virtual QCString	trMemberEnumerationDocumentation ()
virtual QCString	trMemberFunctionDocumentation ()
virtual QCString	trMemberDataDocumentation ()
virtual QCString	trMore ()
virtual QCString	trListOfAllMembers ()
virtual QCString	trMemberList ()
virtual QCString	trThisIsTheListOfAllMembers ()
virtual QCString	trIncludingInheritedMembers ()
virtual QCString	trGeneratedAutomatically (const char *s)
virtual QCString	trEnumName ()
virtual QCString	trEnumValue ()
virtual QCString	trDefinedIn ()
virtual QCString	trModules ()
virtual QCString	trClassHierarchy ()
virtual QCString	trCompoundList ()
virtual QCString	trFileList ()
virtual QCString	trCompoundMembers ()
virtual QCString	trFileMembers ()
virtual QCString	trRelatedPages ()
virtual QCString	trExamples ()
virtual QCString	trSearch ()
virtual QCString	trClassHierarchyDescription ()
virtual QCString	trFileListDescription (bool extractAll)
virtual QCString	trCompoundListDescription ()
virtual QCString	trCompoundMembersDescription (bool extractAll)
virtual QCString	trFileMembersDescription (bool extractAll)
virtual QCString	trExamplesDescription ()
virtual QCString	trRelatedPagesDescription ()
virtual QCString	trModulesDescription ()
virtual QCString	trDocumentation ()
virtual QCString	trModuleIndex ()
virtual QCString	trHierarchicalIndex ()
virtual QCString	trCompoundIndex ()
virtual QCString	trFileIndex ()
virtual QCString	trModuleDocumentation ()
virtual QCString	trClassDocumentation ()
virtual QCString	trFileDocumentation ()
virtual QCString	trExampleDocumentation ()
virtual QCString	trPageDocumentation ()
virtual QCString	trReferenceManual ()
virtual QCString	trDefines ()
virtual QCString	trFuncProtos ()
virtual QCString	trTypedefs ()
virtual QCString	trEnumerations ()
virtual QCString	trFunctions ()
virtual QCString	trVariables ()
virtual QCString	trEnumerationValues ()
virtual QCString	trDefineDocumentation ()
virtual QCString	trFunctionPrototypeDocumentation ()
virtual QCString	trTypedefDocumentation ()
virtual QCString	trEnumerationTypeDocumentation ()
virtual QCString	trFunctionDocumentation ()
virtual QCString	trVariableDocumentation ()
virtual QCString	trCompounds ()
virtual QCString	trGeneratedAt (const char *date, const char *projName)
virtual QCString	trWrittenBy ()
virtual QCString	trClassDiagram (const char *clName)
virtual QCString	trForInternalUseOnly ()
virtual QCString	trWarning ()
virtual QCString	trVersion ()
virtual QCString	trDate ()
virtual QCString	trReturns ()
virtual QCString	trSeeAlso ()
virtual QCString	trParameters ()
virtual QCString	trExceptions ()
virtual QCString	trGeneratedBy ()
virtual QCString	trNamespaceList ()
virtual QCString	trNamespaceListDescription (bool extractAll)
virtual QCString	trFriends ()
virtual QCString	trRelatedFunctionDocumentation ()
virtual QCString	trCompoundReference (const char *clName, ClassDef::CompoundType compType, bool isTemplate)
virtual QCString	trFileReference (const char *fileName)
virtual QCString	trNamespaceReference (const char *namespaceName)
virtual QCString	trPublicMembers ()
virtual QCString	trPublicSlots ()
virtual QCString	trSignals ()
virtual QCString	trStaticPublicMembers ()
virtual QCString	trProtectedMembers ()
virtual QCString	trProtectedSlots ()
virtual QCString	trStaticProtectedMembers ()
virtual QCString	trPrivateMembers ()
virtual QCString	trPrivateSlots ()
virtual QCString	trStaticPrivateMembers ()
virtual QCString	trWriteList (int numEntries)
virtual QCString	trInheritsList (int numEntries)
virtual QCString	trInheritedByList (int numEntries)
virtual QCString	trReimplementedFromList (int numEntries)
virtual QCString	trReimplementedInList (int numEntries)
virtual QCString	trNamespaceMembers ()
virtual QCString	trNamespaceMemberDescription (bool extractAll)
virtual QCString	trNamespaceIndex ()
virtual QCString	trNamespaceDocumentation ()
virtual QCString	trNamespaces ()
virtual QCString	trGeneratedFromFiles (ClassDef::CompoundType compType, bool single)
virtual QCString	trAlphabeticalList ()
virtual QCString	trReturnValues ()
virtual QCString	trMainPage ()
virtual QCString	trPageAbbreviation ()
virtual QCString	trDefinedAtLineInSourceFile ()
virtual QCString	trDefinedInSourceFile ()
virtual QCString	trDeprecated ()
virtual QCString	trCollaborationDiagram (const char *clName)
virtual QCString	trInclDepGraph (const char *fName)
virtual QCString	trConstructorDocumentation ()
virtual QCString	trGotoSourceCode ()
virtual QCString	trGotoDocumentation ()
virtual QCString	trPrecondition ()
virtual QCString	trPostcondition ()
virtual QCString	trInvariant ()
virtual QCString	trInitialValue ()
virtual QCString	trCode ()
virtual QCString	trGraphicalHierarchy ()
virtual QCString	trGotoGraphicalHierarchy ()
virtual QCString	trGotoTextualHierarchy ()
virtual QCString	trPageIndex ()
virtual QCString	trNote ()
virtual QCString	trPublicTypes ()
virtual QCString	trPublicAttribs ()
virtual QCString	trStaticPublicAttribs ()
virtual QCString	trProtectedTypes ()
virtual QCString	trProtectedAttribs ()
virtual QCString	trStaticProtectedAttribs ()
virtual QCString	trPrivateTypes ()
virtual QCString	trPrivateAttribs ()
virtual QCString	trStaticPrivateAttribs ()
virtual QCString	trTodo ()
virtual QCString	trTodoList ()
virtual QCString	trReferencedBy ()
virtual QCString	trRemarks ()
virtual QCString	trAttention ()
virtual QCString	trInclByDepGraph ()
virtual QCString	trSince ()
virtual QCString	trLegendTitle ()
virtual QCString	trLegendDocs ()
virtual QCString	trLegend ()
virtual QCString	trTest ()
virtual QCString	trTestList ()
virtual QCString	trDCOPMethods ()
virtual QCString	trProperties ()
virtual QCString	trPropertyDocumentation ()
virtual QCString	trClasses ()
virtual QCString	trPackage (const char *name)
virtual QCString	trPackageList ()
virtual QCString	trPackageListDescription ()
virtual QCString	trPackages ()
virtual QCString	trDefineValue ()
virtual QCString	trBug ()
virtual QCString	trBugList ()
virtual QCString	trRTFansicp ()
virtual QCString	trRTFCharSet ()
virtual QCString	trRTFGeneralIndex ()
virtual QCString	trClass (bool first_capital, bool singular)
virtual QCString	trFile (bool first_capital, bool singular)
virtual QCString	trNamespace (bool first_capital, bool singular)
virtual QCString	trGroup (bool first_capital, bool singular)
virtual QCString	trPage (bool first_capital, bool singular)
virtual QCString	trMember (bool first_capital, bool singular)
virtual QCString	trGlobal (bool first_capital, bool singular)
virtual QCString	trAuthor (bool first_capital, bool singular)
virtual QCString	trReferences ()
virtual QCString	trImplementedFromList (int numEntries)
virtual QCString	trImplementedInList (int numEntries)
virtual QCString	trRTFTableOfContents ()
virtual QCString	trDeprecatedList ()
virtual QCString	trEvents ()
virtual QCString	trEventDocumentation ()
virtual QCString	trPackageTypes ()
virtual QCString	trPackageMembers ()
virtual QCString	trStaticPackageMembers ()
virtual QCString	trPackageAttribs ()
virtual QCString	trStaticPackageAttribs ()
virtual QCString	trAll ()
virtual QCString	trCallGraph ()
virtual QCString	trSearchForIndex ()
virtual QCString	trSearchResultsTitle ()
virtual QCString	trSearchResults (int numDocuments)
virtual QCString	trSearchMatches ()
virtual QCString	trSourceFile (QCString &filename)
virtual QCString	trDirIndex ()
virtual QCString	trDirDocumentation ()
virtual QCString	trDirectories ()
virtual QCString	trDirDescription ()
virtual QCString	trDirReference (const char *dirName)
virtual QCString	trDir (bool first_capital, bool singular)
virtual QCString	trOverloadText ()
virtual QCString	trCallerGraph ()
virtual QCString	trEnumerationValueDocumentation ()
virtual QCString	trMemberFunctionDocumentationFortran ()
virtual QCString	trCompoundListFortran ()
virtual QCString	trCompoundMembersFortran ()
virtual QCString	trCompoundListDescriptionFortran ()
virtual QCString	trCompoundMembersDescriptionFortran (bool extractAll)
virtual QCString	trCompoundIndexFortran ()
virtual QCString	trTypeDocumentation ()
virtual QCString	trSubprograms ()
virtual QCString	trSubprogramDocumentation ()
virtual QCString	trDataTypes ()
virtual QCString	trModulesList ()
virtual QCString	trModulesListDescription (bool extractAll)
virtual QCString	trCompoundReferenceFortran (const char *clName, ClassDef::CompoundType compType, bool isTemplate)
virtual QCString	trModuleReference (const char *namespaceName)
virtual QCString	trModulesMembers ()
virtual QCString	trModulesMemberDescription (bool extractAll)
virtual QCString	trModulesIndex ()
virtual QCString	trModule (bool first_capital, bool singular)
virtual QCString	trGeneratedFromFilesFortran (ClassDef::CompoundType compType, bool single)
virtual QCString	trType (bool first_capital, bool singular)
virtual QCString	trSubprogram (bool first_capital, bool singular)
virtual QCString	trTypeConstraints ()

---

Detailed Description

When defining a translator class for the new language, follow the description in the documentation. One of the steps says that you should copy the translator_en.h (this) file to your translator_xx.h new file. Your new language should use the Translator class as the base class. This means that you need to implement exactly the same (pure virtual) methods as the TranslatorEnglish does. Because of this, it is a good idea to start with the copy of TranslatorEnglish and replace the strings one by one.

It is not necessary to include "translator.h" or "translator_adapter.h" here. The files are included in the language.cpp correctly. Not including any of the mentioned files frees the maintainer from thinking about whether the first, the second, or both files should be included or not, and why. This holds namely for localized translators because their base class is changed occasionaly to adapter classes when the Translator class changes the interface, or back to the Translator class (by the local maintainer) when the localized translator is made up-to-date again.

Definition at line 43 of file translator_en.h.

---

Member Function Documentation

virtual QCString TranslatorEnglish::idLanguage

(

)

[inline, virtual]

Used for identification of the language. The identification should not be translated. It should be replaced by the name of the language in English using lower-case characters only (e.g. "czech", "japanese", "russian", etc.). It should be equal to the identification used in language.cpp.

Implements Translator.

Reimplemented in TranslatorFinnish, TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 55 of file translator_en.h.

virtual QCString TranslatorEnglish::latexLanguageSupportCommand

(

)

[inline, virtual]

Used to get the LaTeX command(s) for the language support. This method should return string with commands that switch LaTeX to the desired language. For example

"\\usepackage[german]{babel}\n"
  

or

"\\usepackage{polski}\n"
  "\\usepackage[latin2]{inputenc}\n"
  "\\usepackage[T1]{fontenc}\n"
  

The English LaTeX does not use such commands. Because of this the empty string is returned in this implementation.

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 72 of file translator_en.h.

virtual QCString TranslatorEnglish::idLanguageCharset

(

)

[inline, virtual]

return the language charset. This will be used for the HTML output

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 78 of file translator_en.h.

virtual QCString TranslatorEnglish::trRelatedFunctions

(

)

[inline, virtual]

used in the compound documentation before a list of related functions.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 86 of file translator_en.h.

virtual QCString TranslatorEnglish::trRelatedSubscript

(

)

[inline, virtual]

subscript for the related functions.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 90 of file translator_en.h.

virtual QCString TranslatorEnglish::trDetailedDescription

(

)

[inline, virtual]

header that is put before the detailed description of files, classes and namespaces.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 94 of file translator_en.h.

virtual QCString TranslatorEnglish::trMemberTypedefDocumentation

(

)

[inline, virtual]

header that is put before the list of typedefs.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 98 of file translator_en.h.

virtual QCString TranslatorEnglish::trMemberEnumerationDocumentation

(

)

[inline, virtual]

header that is put before the list of enumerations.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 102 of file translator_en.h.

virtual QCString TranslatorEnglish::trMemberFunctionDocumentation

(

)

[inline, virtual]

header that is put before the list of member functions.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 106 of file translator_en.h.

virtual QCString TranslatorEnglish::trMemberDataDocumentation

(

)

[inline, virtual]

header that is put before the list of member attributes.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 110 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trMore

(

)

[inline, virtual]

this is the text of a link put after brief descriptions.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 123 of file translator_en.h.

virtual QCString TranslatorEnglish::trListOfAllMembers

(

)

[inline, virtual]

put in the class documentation

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 127 of file translator_en.h.

virtual QCString TranslatorEnglish::trMemberList

(

)

[inline, virtual]

used as the title of the "list of all members" page of a class

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 131 of file translator_en.h.

virtual QCString TranslatorEnglish::trThisIsTheListOfAllMembers

(

)

[inline, virtual]

this is the first part of a sentence that is followed by a class name

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 135 of file translator_en.h.

virtual QCString TranslatorEnglish::trIncludingInheritedMembers

(

)

[inline, virtual]

this is the remainder of the sentence after the class name

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 139 of file translator_en.h.

virtual QCString TranslatorEnglish::trGeneratedAutomatically

(

const char *

s

)

[inline, virtual]

this is put at the author sections at the bottom of man pages. parameter s is name of the project name.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 145 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trEnumName

(

)

[inline, virtual]

put after an enum name in the list of all members

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 153 of file translator_en.h.

virtual QCString TranslatorEnglish::trEnumValue

(

)

[inline, virtual]

put after an enum value in the list of all members

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 157 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefinedIn

(

)

[inline, virtual]

put after an undocumented member in the list of all members

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 161 of file translator_en.h.

virtual QCString TranslatorEnglish::trModules

(

)

[inline, virtual]

This is put above each page as a link to the list of all groups of compounds or files (see the \group command).

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 169 of file translator_en.h.

virtual QCString TranslatorEnglish::trClassHierarchy

(

)

[inline, virtual]

This is put above each page as a link to the class hierarchy

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 173 of file translator_en.h.

virtual QCString TranslatorEnglish::trCompoundList

(

)

[inline, virtual]

This is put above each page as a link to the list of annotated classes

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 177 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trFileList

(

)

[inline, virtual]

This is put above each page as a link to the list of documented files

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 190 of file translator_en.h.

virtual QCString TranslatorEnglish::trCompoundMembers

(

)

[inline, virtual]

This is put above each page as a link to all members of compounds.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 194 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trFileMembers

(

)

[inline, virtual]

This is put above each page as a link to all members of files.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 207 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trRelatedPages

(

)

[inline, virtual]

This is put above each page as a link to all related pages.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 220 of file translator_en.h.

virtual QCString TranslatorEnglish::trExamples

(

)

[inline, virtual]

This is put above each page as a link to all examples.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 224 of file translator_en.h.

virtual QCString TranslatorEnglish::trSearch

(

)

[inline, virtual]

This is put above each page as a link to the search engine.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 228 of file translator_en.h.

virtual QCString TranslatorEnglish::trClassHierarchyDescription

(

)

[inline, virtual]

This is an introduction to the class hierarchy.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 232 of file translator_en.h.

virtual QCString TranslatorEnglish::trFileListDescription

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the list with all files.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 238 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trCompoundListDescription

(

)

[inline, virtual]

This is an introduction to the annotated compound list.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 247 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trCompoundMembersDescription

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the page with all class members.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 262 of file translator_en.h.

References Config_getBool, and QCString.

virtual QCString TranslatorEnglish::trFileMembersDescription

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the page with all file members.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 304 of file translator_en.h.

References Config_getBool, and QCString.

virtual QCString TranslatorEnglish::trExamplesDescription

(

)

[inline, virtual]

This is an introduction to the page with the list of all examples

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 326 of file translator_en.h.

virtual QCString TranslatorEnglish::trRelatedPagesDescription

(

)

[inline, virtual]

This is an introduction to the page with the list of related pages

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 330 of file translator_en.h.

virtual QCString TranslatorEnglish::trModulesDescription

(

)

[inline, virtual]

This is an introduction to the page with the list of class/file groups

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 334 of file translator_en.h.

virtual QCString TranslatorEnglish::trDocumentation

(

)

[inline, virtual]

This is used in HTML as the title of index.html.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 340 of file translator_en.h.

virtual QCString TranslatorEnglish::trModuleIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the index of all groups.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 346 of file translator_en.h.

virtual QCString TranslatorEnglish::trHierarchicalIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the class hierarchy.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 352 of file translator_en.h.

virtual QCString TranslatorEnglish::trCompoundIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the annotated compound index.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 358 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trFileIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the list of all files.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 373 of file translator_en.h.

virtual QCString TranslatorEnglish::trModuleDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all groups.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 379 of file translator_en.h.

virtual QCString TranslatorEnglish::trClassDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all classes, structs and unions.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 385 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trFileDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all files.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 400 of file translator_en.h.

virtual QCString TranslatorEnglish::trExampleDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all examples.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 406 of file translator_en.h.

virtual QCString TranslatorEnglish::trPageDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all related pages.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 412 of file translator_en.h.

virtual QCString TranslatorEnglish::trReferenceManual

(

)

[inline, virtual]

This is used in LaTeX as the title of the document

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 416 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefines

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of defines

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 422 of file translator_en.h.

virtual QCString TranslatorEnglish::trFuncProtos

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of function prototypes

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 428 of file translator_en.h.

virtual QCString TranslatorEnglish::trTypedefs

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of typedefs

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 434 of file translator_en.h.

virtual QCString TranslatorEnglish::trEnumerations

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of enumerations

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 440 of file translator_en.h.

virtual QCString TranslatorEnglish::trFunctions

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of (global) functions

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 446 of file translator_en.h.

virtual QCString TranslatorEnglish::trVariables

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of (global) variables

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 452 of file translator_en.h.

virtual QCString TranslatorEnglish::trEnumerationValues

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of (global) variables

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 458 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefineDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file before the list of documentation blocks for defines

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 464 of file translator_en.h.

virtual QCString TranslatorEnglish::trFunctionPrototypeDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for function prototypes

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 470 of file translator_en.h.

virtual QCString TranslatorEnglish::trTypedefDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for typedefs

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 476 of file translator_en.h.

virtual QCString TranslatorEnglish::trEnumerationTypeDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration types

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 482 of file translator_en.h.

virtual QCString TranslatorEnglish::trFunctionDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for functions

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 488 of file translator_en.h.

virtual QCString TranslatorEnglish::trVariableDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for variables

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 494 of file translator_en.h.

virtual QCString TranslatorEnglish::trCompounds

(

)

[inline, virtual]

This is used in the documentation of a file/namespace/group before the list of links to documented compounds

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 500 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trGeneratedAt	(	const char *	date,
		const char *	projName
	)			[inline, virtual]

This is used in the standard footer of each page and indicates when the page was generated

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 515 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trWrittenBy

(

)

[inline, virtual]

This is part of the sentence used in the standard footer of each page.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 524 of file translator_en.h.

virtual QCString TranslatorEnglish::trClassDiagram

(

const char *

clName

)

[inline, virtual]

this text is put before a class diagram

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 530 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trForInternalUseOnly

(

)

[inline, virtual]

this text is generated when the \internal command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 536 of file translator_en.h.

virtual QCString TranslatorEnglish::trWarning

(

)

[inline, virtual]

this text is generated when the \warning command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 540 of file translator_en.h.

virtual QCString TranslatorEnglish::trVersion

(

)

[inline, virtual]

this text is generated when the \version command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 544 of file translator_en.h.

virtual QCString TranslatorEnglish::trDate

(

)

[inline, virtual]

this text is generated when the \date command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 548 of file translator_en.h.

virtual QCString TranslatorEnglish::trReturns

(

)

[inline, virtual]

this text is generated when the \return command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 552 of file translator_en.h.

virtual QCString TranslatorEnglish::trSeeAlso

(

)

[inline, virtual]

this text is generated when the \sa command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 556 of file translator_en.h.

virtual QCString TranslatorEnglish::trParameters

(

)

[inline, virtual]

this text is generated when the \param command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 560 of file translator_en.h.

virtual QCString TranslatorEnglish::trExceptions

(

)

[inline, virtual]

this text is generated when the \exception command is used.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 564 of file translator_en.h.

virtual QCString TranslatorEnglish::trGeneratedBy

(

)

[inline, virtual]

this text is used in the title page of a LaTeX document.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 568 of file translator_en.h.

virtual QCString TranslatorEnglish::trNamespaceList

(

)

[inline, virtual]

used as the title of page containing all the index of all namespaces.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 576 of file translator_en.h.

virtual QCString TranslatorEnglish::trNamespaceListDescription

(

bool

extractAll

)

[inline, virtual]

used as an introduction to the namespace list

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 580 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trFriends

(

)

[inline, virtual]

used in the class documentation as a header before the list of all friends of a class

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 591 of file translator_en.h.

virtual QCString TranslatorEnglish::trRelatedFunctionDocumentation

(

)

[inline, virtual]

used in the class documentation as a header before the list of all related classes

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 601 of file translator_en.h.

virtual QCString TranslatorEnglish::trCompoundReference	(	const char *	clName,
		ClassDef::CompoundType	compType,
		bool	isTemplate
	)			[inline, virtual]

used as the title of the HTML page of a class/struct/union

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 609 of file translator_en.h.

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, QCString, ClassDef::Struct, and ClassDef::Union.

virtual QCString TranslatorEnglish::trFileReference

(

const char *

fileName

)

[inline, virtual]

used as the title of the HTML page of a file

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 630 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trNamespaceReference

(

const char *

namespaceName

)

[inline, virtual]

used as the title of the HTML page of a namespace

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 638 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trPublicMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 645 of file translator_en.h.

virtual QCString TranslatorEnglish::trPublicSlots

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 647 of file translator_en.h.

virtual QCString TranslatorEnglish::trSignals

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 649 of file translator_en.h.

virtual QCString TranslatorEnglish::trStaticPublicMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 651 of file translator_en.h.

virtual QCString TranslatorEnglish::trProtectedMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 653 of file translator_en.h.

virtual QCString TranslatorEnglish::trProtectedSlots

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 655 of file translator_en.h.

virtual QCString TranslatorEnglish::trStaticProtectedMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 657 of file translator_en.h.

virtual QCString TranslatorEnglish::trPrivateMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 659 of file translator_en.h.

virtual QCString TranslatorEnglish::trPrivateSlots

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 661 of file translator_en.h.

virtual QCString TranslatorEnglish::trStaticPrivateMembers

(

)

[inline, virtual]

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 663 of file translator_en.h.

virtual QCString TranslatorEnglish::trWriteList

(

int

numEntries

)

[inline, virtual]

this function is used to produce a comma-separated list of items. use generateMarker(i) to indicate where item i should be put.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 669 of file translator_en.h.

References generateMarker(), and QCString.

Referenced by trImplementedFromList(), trImplementedInList(), trInheritedByList(), trInheritsList(), trReimplementedFromList(), and trReimplementedInList().

virtual QCString TranslatorEnglish::trInheritsList

(

int

numEntries

)

[inline, virtual]

used in class documentation to produce a list of base classes, if class diagrams are disabled.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 694 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trInheritedByList

(

int

numEntries

)

[inline, virtual]

used in class documentation to produce a list of super classes, if class diagrams are disabled.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 702 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trReimplementedFromList

(

int

numEntries

)

[inline, virtual]

used in member documentation blocks to produce a list of members that are hidden by this one.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 710 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trReimplementedInList

(

int

numEntries

)

[inline, virtual]

used in member documentation blocks to produce a list of all member that overwrite the implementation of this member.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 718 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trNamespaceMembers

(

)

[inline, virtual]

This is put above each page as a link to all members of namespaces.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 724 of file translator_en.h.

virtual QCString TranslatorEnglish::trNamespaceMemberDescription

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the page with all namespace members

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 728 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trNamespaceIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the index of all namespaces.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 742 of file translator_en.h.

virtual QCString TranslatorEnglish::trNamespaceDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all namespaces.

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 748 of file translator_en.h.

virtual QCString TranslatorEnglish::trNamespaces

(

)

[inline, virtual]

This is used in the documentation before the list of all namespaces in a file.

Implements Translator.

Definition at line 758 of file translator_en.h.

virtual QCString TranslatorEnglish::trGeneratedFromFiles	(	ClassDef::CompoundType	compType,
		bool	single
	)			[inline, virtual]

This is put at the bottom of a class documentation page and is followed by a list of files that were used to generate the page.

Implements Translator.

Definition at line 768 of file translator_en.h.

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, QCString, ClassDef::Struct, and ClassDef::Union.

virtual QCString TranslatorEnglish::trAlphabeticalList

(

)

[inline, virtual]

This is in the (quick) index as a link to the alphabetical compound list.

Implements Translator.

Definition at line 791 of file translator_en.h.

virtual QCString TranslatorEnglish::trReturnValues

(

)

[inline, virtual]

This is used as the heading text for the retval command.

Implements Translator.

Definition at line 799 of file translator_en.h.

virtual QCString TranslatorEnglish::trMainPage

(

)

[inline, virtual]

This is in the (quick) index as a link to the main page (index.html)

Implements Translator.

Definition at line 804 of file translator_en.h.

virtual QCString TranslatorEnglish::trPageAbbreviation

(

)

[inline, virtual]

This is used in references to page that are put in the LaTeX documentation. It should be an abbreviation of the word page.

Implements Translator.

Definition at line 810 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefinedAtLineInSourceFile

(

)

[inline, virtual]

Implements Translator.

Definition at line 817 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefinedInSourceFile

(

)

[inline, virtual]

Implements Translator.

Definition at line 821 of file translator_en.h.

virtual QCString TranslatorEnglish::trDeprecated

(

)

[inline, virtual]

Implements Translator.

Definition at line 830 of file translator_en.h.

virtual QCString TranslatorEnglish::trCollaborationDiagram

(

const char *

clName

)

[inline, virtual]

this text is put before a collaboration diagram

Implements Translator.

Definition at line 840 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trInclDepGraph

(

const char *

fName

)

[inline, virtual]

this text is put before an include dependency graph

Implements Translator.

Definition at line 845 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trConstructorDocumentation

(

)

[inline, virtual]

header that is put before the list of constructor/destructors.

Implements Translator.

Definition at line 850 of file translator_en.h.

virtual QCString TranslatorEnglish::trGotoSourceCode

(

)

[inline, virtual]

Used in the file documentation to point to the corresponding sources.

Implements Translator.

Definition at line 855 of file translator_en.h.

virtual QCString TranslatorEnglish::trGotoDocumentation

(

)

[inline, virtual]

Used in the file sources to point to the corresponding documentation.

Implements Translator.

Definition at line 860 of file translator_en.h.

virtual QCString TranslatorEnglish::trPrecondition

(

)

[inline, virtual]

Text for the \pre command

Implements Translator.

Definition at line 865 of file translator_en.h.

virtual QCString TranslatorEnglish::trPostcondition

(

)

[inline, virtual]

Text for the \post command

Implements Translator.

Definition at line 870 of file translator_en.h.

virtual QCString TranslatorEnglish::trInvariant

(

)

[inline, virtual]

Text for the \invariant command

Implements Translator.

Definition at line 875 of file translator_en.h.

virtual QCString TranslatorEnglish::trInitialValue

(

)

[inline, virtual]

Text shown before a multi-line variable/enum initialization

Implements Translator.

Definition at line 880 of file translator_en.h.

virtual QCString TranslatorEnglish::trCode

(

)

[inline, virtual]

Text used the source code in the file index

Implements Translator.

Definition at line 885 of file translator_en.h.

virtual QCString TranslatorEnglish::trGraphicalHierarchy

(

)

[inline, virtual]

Implements Translator.

Definition at line 889 of file translator_en.h.

virtual QCString TranslatorEnglish::trGotoGraphicalHierarchy

(

)

[inline, virtual]

Implements Translator.

Definition at line 893 of file translator_en.h.

virtual QCString TranslatorEnglish::trGotoTextualHierarchy

(

)

[inline, virtual]

Implements Translator.

Definition at line 897 of file translator_en.h.

virtual QCString TranslatorEnglish::trPageIndex

(

)

[inline, virtual]

Implements Translator.

Definition at line 901 of file translator_en.h.

virtual QCString TranslatorEnglish::trNote

(

)

[inline, virtual]

Implements Translator.

Definition at line 910 of file translator_en.h.

virtual QCString TranslatorEnglish::trPublicTypes

(

)

[inline, virtual]

Implements Translator.

Definition at line 914 of file translator_en.h.

virtual QCString TranslatorEnglish::trPublicAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 918 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trStaticPublicAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 929 of file translator_en.h.

virtual QCString TranslatorEnglish::trProtectedTypes

(

)

[inline, virtual]

Implements Translator.

Definition at line 933 of file translator_en.h.

virtual QCString TranslatorEnglish::trProtectedAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 937 of file translator_en.h.

virtual QCString TranslatorEnglish::trStaticProtectedAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 941 of file translator_en.h.

virtual QCString TranslatorEnglish::trPrivateTypes

(

)

[inline, virtual]

Implements Translator.

Definition at line 945 of file translator_en.h.

virtual QCString TranslatorEnglish::trPrivateAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 949 of file translator_en.h.

virtual QCString TranslatorEnglish::trStaticPrivateAttribs

(

)

[inline, virtual]

Implements Translator.

Definition at line 953 of file translator_en.h.

virtual QCString TranslatorEnglish::trTodo

(

)

[inline, virtual]

Used as a marker that is put before a \todo item

Implements Translator.

Definition at line 963 of file translator_en.h.

virtual QCString TranslatorEnglish::trTodoList

(

)

[inline, virtual]

Used as the header of the todo list

Implements Translator.

Definition at line 968 of file translator_en.h.

virtual QCString TranslatorEnglish::trReferencedBy

(

)

[inline, virtual]

Implements Translator.

Definition at line 977 of file translator_en.h.

virtual QCString TranslatorEnglish::trRemarks

(

)

[inline, virtual]

Implements Translator.

Definition at line 981 of file translator_en.h.

virtual QCString TranslatorEnglish::trAttention

(

)

[inline, virtual]

Implements Translator.

Definition at line 985 of file translator_en.h.

virtual QCString TranslatorEnglish::trInclByDepGraph

(

)

[inline, virtual]

Implements Translator.

Definition at line 989 of file translator_en.h.

virtual QCString TranslatorEnglish::trSince

(

)

[inline, virtual]

Implements Translator.

Definition at line 994 of file translator_en.h.

virtual QCString TranslatorEnglish::trLegendTitle

(

)

[inline, virtual]

title of the graph legend page

Implements Translator.

Definition at line 1004 of file translator_en.h.

virtual QCString TranslatorEnglish::trLegendDocs

(

)

[inline, virtual]

page explaining how the dot graph's should be interpreted The A in the text below are to prevent link to classes called "A".

Implements Translator.

Definition at line 1011 of file translator_en.h.

References Config_getEnum.

virtual QCString TranslatorEnglish::trLegend

(

)

[inline, virtual]

text for the link to the legend page

Implements Translator.

Definition at line 1074 of file translator_en.h.

virtual QCString TranslatorEnglish::trTest

(

)

[inline, virtual]

Used as a marker that is put before a test item

Implements Translator.

Definition at line 1084 of file translator_en.h.

virtual QCString TranslatorEnglish::trTestList

(

)

[inline, virtual]

Used as the header of the test list

Implements Translator.

Definition at line 1089 of file translator_en.h.

virtual QCString TranslatorEnglish::trDCOPMethods

(

)

[inline, virtual]

Used as a section header for KDE-2 IDL methods

Implements Translator.

Definition at line 1099 of file translator_en.h.

virtual QCString TranslatorEnglish::trProperties

(

)

[inline, virtual]

Used as a section header for IDL properties

Implements Translator.

Definition at line 1109 of file translator_en.h.

virtual QCString TranslatorEnglish::trPropertyDocumentation

(

)

[inline, virtual]

Used as a section header for IDL property documentation

Implements Translator.

Definition at line 1114 of file translator_en.h.

virtual QCString TranslatorEnglish::trClasses

(

)

[inline, virtual]

Used for Java classes in the summary section of Java packages

Implements Translator.

Definition at line 1124 of file translator_en.h.

References Config_getBool.

virtual QCString TranslatorEnglish::trPackage

(

const char *

name

)

[inline, virtual]

Used as the title of a Java package

Implements Translator.

Definition at line 1136 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trPackageList

(

)

[inline, virtual]

Title of the package index page

Implements Translator.

Definition at line 1141 of file translator_en.h.

virtual QCString TranslatorEnglish::trPackageListDescription

(

)

[inline, virtual]

The description of the package index page

Implements Translator.

Definition at line 1146 of file translator_en.h.

virtual QCString TranslatorEnglish::trPackages

(

)

[inline, virtual]

The link name in the Quick links header for each page

Implements Translator.

Definition at line 1151 of file translator_en.h.

virtual QCString TranslatorEnglish::trDefineValue

(

)

[inline, virtual]

Text shown before a multi-line define

Implements Translator.

Definition at line 1156 of file translator_en.h.

virtual QCString TranslatorEnglish::trBug

(

)

[inline, virtual]

Used as a marker that is put before a \bug item

Implements Translator.

Definition at line 1166 of file translator_en.h.

virtual QCString TranslatorEnglish::trBugList

(

)

[inline, virtual]

Used as the header of the bug list

Implements Translator.

Definition at line 1171 of file translator_en.h.

virtual QCString TranslatorEnglish::trRTFansicp

(

)

[inline, 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
 

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 1205 of file translator_en.h.

virtual QCString TranslatorEnglish::trRTFCharSet

(

)

[inline, virtual]

Used as ansicpg for RTF fcharset

See also:

trRTFansicp() for a table of possible values.

Implements Translator.

Reimplemented in TranslatorJapaneseEn, and TranslatorKoreanEn.

Definition at line 1214 of file translator_en.h.

virtual QCString TranslatorEnglish::trRTFGeneralIndex

(

)

[inline, virtual]

Used as header RTF general index

Implements Translator.

Definition at line 1220 of file translator_en.h.

virtual QCString TranslatorEnglish::trClass	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1229 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trFile	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1240 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trNamespace	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1251 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trGroup	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1262 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trPage	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1273 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trMember	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1284 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trGlobal	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1295 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trAuthor	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This text is generated when the \author command is used and for the author section in man pages.

Implements Translator.

Definition at line 1308 of file translator_en.h.

References QCString.

virtual QCString TranslatorEnglish::trReferences

(

)

[inline, virtual]

This text is put before the list of members referenced by a member

Implements Translator.

Definition at line 1321 of file translator_en.h.

virtual QCString TranslatorEnglish::trImplementedFromList

(

int

numEntries

)

[inline, virtual]

used in member documentation blocks to produce a list of members that are implemented by this one.

Implements Translator.

Definition at line 1333 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trImplementedInList

(

int

numEntries

)

[inline, virtual]

used in member documentation blocks to produce a list of all members that implement this abstract member.

Implements Translator.

Definition at line 1341 of file translator_en.h.

References trWriteList().

virtual QCString TranslatorEnglish::trRTFTableOfContents

(

)

[inline, virtual]

used in RTF documentation as a heading for the Table of Contents.

Implements Translator.

Definition at line 1353 of file translator_en.h.

virtual QCString TranslatorEnglish::trDeprecatedList

(

)

[inline, virtual]

Used as the header of the list of item that have been flagged deprecated

Implements Translator.

Definition at line 1365 of file translator_en.h.

virtual QCString TranslatorEnglish::trEvents

(

)

[inline, virtual]

Used as a header for declaration section of the events found in a C# program

Implements Translator.

Definition at line 1377 of file translator_en.h.

Referenced by TranslatorAdapter_1_2_18::trEvents().

virtual QCString TranslatorEnglish::trEventDocumentation

(

)

[inline, virtual]

Header used for the documentation section of a class' events.

Implements Translator.

Definition at line 1382 of file translator_en.h.

Referenced by TranslatorAdapter_1_2_18::trEventDocumentation().

virtual QCString TranslatorEnglish::trPackageTypes

(

)

[inline, virtual]

Used as a heading for a list of Java class types with package scope.

Implements Translator.

Definition at line 1393 of file translator_en.h.

Referenced by TranslatorAdapter_1_3::trPackageTypes().

virtual QCString TranslatorEnglish::trPackageMembers

(

)

[inline, virtual]

Used as a heading for a list of Java class functions with package scope.

Implements Translator.

Definition at line 1400 of file translator_en.h.

Referenced by TranslatorAdapter_1_3::trPackageMembers().

virtual QCString TranslatorEnglish::trStaticPackageMembers

(

)

[inline, virtual]

Used as a heading for a list of static Java class functions with package scope.

Implements Translator.

Definition at line 1407 of file translator_en.h.

Referenced by TranslatorAdapter_1_3::trStaticPackageMembers().

virtual QCString TranslatorEnglish::trPackageAttribs

(

)

[inline, virtual]

Used as a heading for a list of Java class variables with package scope.

Implements Translator.

Definition at line 1414 of file translator_en.h.

Referenced by TranslatorAdapter_1_3::trPackageAttribs().

virtual QCString TranslatorEnglish::trStaticPackageAttribs

(

)

[inline, virtual]

Used as a heading for a list of static Java class variables with package scope.

Implements Translator.

Definition at line 1421 of file translator_en.h.

Referenced by TranslatorAdapter_1_3::trStaticPackageAttribs().

virtual QCString TranslatorEnglish::trAll

(

)

[inline, virtual]

Used in the quick index of a class/file/namespace member list page to link to the unfiltered list of all members.

Implements Translator.

Definition at line 1433 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_1::trAll().

virtual QCString TranslatorEnglish::trCallGraph

(

)

[inline, virtual]

Put in front of the call graph for a function.

Implements Translator.

Definition at line 1438 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_1::trCallGraph().

virtual QCString TranslatorEnglish::trSearchForIndex

(

)

[inline, virtual]

When the search engine is enabled this text is put in the header of each page before the field where one can enter the text to search for.

Implements Translator.

Definition at line 1451 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_3::trSearchForIndex().

virtual QCString TranslatorEnglish::trSearchResultsTitle

(

)

[inline, virtual]

This string is used as the title for the page listing the search results.

Implements Translator.

Definition at line 1458 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_3::trSearchResultsTitle().

virtual QCString TranslatorEnglish::trSearchResults

(

int

numDocuments

)

[inline, virtual]

This string is put just before listing the search results. The text can be different depending on the number of documents found. Inside the text you can put the special marker $num to insert the number representing the actual number of search results. The numDocuments parameter can be either 0, 1 or 2, where the value 2 represents 2 or more matches. HTML markup is allowed inside the returned string.

Implements Translator.

Definition at line 1470 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_3::trSearchResults().

virtual QCString TranslatorEnglish::trSearchMatches

(

)

[inline, virtual]

This string is put before the list of matched words, for each search result. What follows is the list of words that matched the query.

Implements Translator.

Definition at line 1489 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_3::trSearchMatches().

virtual QCString TranslatorEnglish::trSourceFile

(

QCString &

filename

)

[inline, virtual]

This is used in HTML as the title of page with source code for file filename

Implements Translator.

Definition at line 1500 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_8::trSourceFile().

virtual QCString TranslatorEnglish::trDirIndex

(

)

[inline, virtual]

This is used as the name of the chapter containing the directory hierarchy.

Implements Translator.

Definition at line 1512 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_9::trDirIndex().

virtual QCString TranslatorEnglish::trDirDocumentation

(

)

[inline, virtual]

This is used as the name of the chapter containing the documentation of the directories.

Implements Translator.

Definition at line 1518 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_9::trDirDocumentation().

virtual QCString TranslatorEnglish::trDirectories

(

)

[inline, virtual]

This is used as the title of the directory index and also in the Quick links of an HTML page, to link to the directory hierarchy.

Implements Translator.

Definition at line 1524 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_9::trDirectories().

virtual QCString TranslatorEnglish::trDirDescription

(

)

[inline, virtual]

This returns a sentences that introduces the directory hierarchy. and the fact that it is sorted alphabetically per level

Implements Translator.

Definition at line 1530 of file translator_en.h.

Referenced by TranslatorAdapter_1_3_9::trDirDescription().

virtual QCString TranslatorEnglish::trDirReference

(

const char *

dirName

)

[inline, virtual]

This returns the title of a directory page. The name of the directory is passed via dirName.

Implements Translator.

Definition at line 1538 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_3_9::trDirReference().

virtual QCString TranslatorEnglish::trDir	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This returns the word directory with or without starting capital (first_capital) and in sigular or plural form (singular).

Implements Translator.

Definition at line 1544 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_3_9::trDir().

virtual QCString TranslatorEnglish::trOverloadText

(

)

[inline, virtual]

This text is added to the documentation when the \overload command is used for a overloaded function.

Implements Translator.

Definition at line 1558 of file translator_en.h.

Referenced by TranslatorAdapter_1_4_1::trOverloadText().

virtual QCString TranslatorEnglish::trCallerGraph

(

)

[inline, virtual]

This is used to introduce a caller (or called-by) graph

Implements Translator.

Definition at line 1570 of file translator_en.h.

Referenced by TranslatorAdapter_1_4_6::trCallerGraph().

virtual QCString TranslatorEnglish::trEnumerationValueDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for enumeration values

Implements Translator.

Reimplemented in TranslatorFinnish.

Definition at line 1578 of file translator_en.h.

Referenced by TranslatorAdapter_1_4_6::trEnumerationValueDocumentation().

virtual QCString TranslatorEnglish::trMemberFunctionDocumentationFortran

(

)

[inline, virtual]

header that is put before the list of member subprograms (Fortran).

Implements Translator.

Definition at line 1586 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trMemberFunctionDocumentationFortran().

virtual QCString TranslatorEnglish::trCompoundListFortran

(

)

[inline, virtual]

This is put above each page as a link to the list of annotated data types (Fortran).

Implements Translator.

Definition at line 1590 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trCompoundListFortran().

virtual QCString TranslatorEnglish::trCompoundMembersFortran

(

)

[inline, virtual]

This is put above each page as a link to all members of compounds (Fortran).

Implements Translator.

Definition at line 1594 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trCompoundMembersFortran().

virtual QCString TranslatorEnglish::trCompoundListDescriptionFortran

(

)

[inline, virtual]

This is an introduction to the annotated compound list (Fortran).

Implements Translator.

Definition at line 1598 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trCompoundListDescriptionFortran().

virtual QCString TranslatorEnglish::trCompoundMembersDescriptionFortran

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the page with all data types (Fortran).

Implements Translator.

Definition at line 1602 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trCompoundMembersDescriptionFortran().

virtual QCString TranslatorEnglish::trCompoundIndexFortran

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the annotated compound index (Fortran).

Implements Translator.

Definition at line 1625 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trCompoundIndexFortran().

virtual QCString TranslatorEnglish::trTypeDocumentation

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter containing the documentation of all data types (Fortran).

Implements Translator.

Definition at line 1631 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trTypeDocumentation().

virtual QCString TranslatorEnglish::trSubprograms

(

)

[inline, virtual]

This is used in the documentation of a file as a header before the list of (global) subprograms (Fortran).

Implements Translator.

Definition at line 1637 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trSubprograms().

virtual QCString TranslatorEnglish::trSubprogramDocumentation

(

)

[inline, virtual]

This is used in the documentation of a file/namespace before the list of documentation blocks for subprograms (Fortran)

Implements Translator.

Definition at line 1643 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trSubprogramDocumentation().

virtual QCString TranslatorEnglish::trDataTypes

(

)

[inline, virtual]

This is used in the documentation of a file/namespace/group before the list of links to documented compounds (Fortran)

Implements Translator.

Definition at line 1649 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trDataTypes().

virtual QCString TranslatorEnglish::trModulesList

(

)

[inline, virtual]

used as the title of page containing all the index of all modules (Fortran).

Implements Translator.

Definition at line 1653 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trModulesList().

virtual QCString TranslatorEnglish::trModulesListDescription

(

bool

extractAll

)

[inline, virtual]

used as an introduction to the modules list (Fortran)

Implements Translator.

Definition at line 1657 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trModulesListDescription().

virtual QCString TranslatorEnglish::trCompoundReferenceFortran	(	const char *	clName,
		ClassDef::CompoundType	compType,
		bool	isTemplate
	)			[inline, virtual]

used as the title of the HTML page of a module/type (Fortran)

Implements Translator.

Definition at line 1666 of file translator_en.h.

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, QCString, ClassDef::Struct, and ClassDef::Union.

Referenced by TranslatorAdapter_1_5_4::trCompoundReferenceFortran().

virtual QCString TranslatorEnglish::trModuleReference

(

const char *

namespaceName

)

[inline, virtual]

used as the title of the HTML page of a module (Fortran)

Implements Translator.

Definition at line 1686 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trModuleReference().

virtual QCString TranslatorEnglish::trModulesMembers

(

)

[inline, virtual]

This is put above each page as a link to all members of modules. (Fortran)

Implements Translator.

Definition at line 1694 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trModulesMembers().

virtual QCString TranslatorEnglish::trModulesMemberDescription

(

bool

extractAll

)

[inline, virtual]

This is an introduction to the page with all modules members (Fortran)

Implements Translator.

Definition at line 1698 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trModulesMemberDescription().

virtual QCString TranslatorEnglish::trModulesIndex

(

)

[inline, virtual]

This is used in LaTeX as the title of the chapter with the index of all modules (Fortran).

Implements Translator.

Definition at line 1717 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trModulesIndex().

virtual QCString TranslatorEnglish::trModule	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1724 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trModule().

virtual QCString TranslatorEnglish::trGeneratedFromFilesFortran	(	ClassDef::CompoundType	compType,
		bool	single
	)			[inline, virtual]

This is put at the bottom of a module documentation page and is followed by a list of files that were used to generate the page.

Implements Translator.

Definition at line 1733 of file translator_en.h.

References ClassDef::Category, ClassDef::Class, ClassDef::Exception, ClassDef::Interface, ClassDef::Protocol, QCString, ClassDef::Struct, and ClassDef::Union.

Referenced by TranslatorAdapter_1_5_4::trGeneratedFromFilesFortran().

virtual QCString TranslatorEnglish::trType	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1756 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trType().

virtual QCString TranslatorEnglish::trSubprogram	(	bool	first_capital,
		bool	singular
	)			[inline, virtual]

This is used for translation of the word that will possibly be followed by a single name or by a list of names of the category.

Implements Translator.

Definition at line 1766 of file translator_en.h.

References QCString.

Referenced by TranslatorAdapter_1_5_4::trSubprogram().

virtual QCString TranslatorEnglish::trTypeConstraints

(

)

[inline, virtual]

C# Type Constraint list

Implements Translator.

Definition at line 1774 of file translator_en.h.

Referenced by TranslatorAdapter_1_5_4::trTypeConstraints().

---

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

• translator_en.h

---

• ソフトウェア開発
• ホームページ制作
• Tcl版
• STLport版
• Dradnats C++ Library
• 要約文庫