doxygen  1.8.18
About: Doxygen is a source code documentation generator tool for C++, C, Objective-C, C#, PHP, Java, Python, IDL (diverse flavors), Fortran, VHDL, Tcl, and to some extent D. Different output formats are supported.
  Fossies Dox: doxygen-1.8.18.src.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

RTFGenerator Class Reference

Generator for RTF output. More...

#include <rtfgen.h>

+ Inheritance diagram for RTFGenerator:
+ Collaboration diagram for RTFGenerator:

Public Member Functions

 RTFGenerator ()
 
 ~RTFGenerator ()
 
void setRelativePath (const QCString &path)
 
void setSourceFileName (const QCString &sourceFileName)
 
void enable ()
 
void disable ()
 
void enableIf (OutputType o)
 
void disableIf (OutputType o)
 
void disableIfNot (OutputType o)
 
bool isEnabled (OutputType o)
 
OutputGeneratorget (OutputType o)
 
void writeDoc (DocNode *, const Definition *, const MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeSearchInfo ()
 
void writeFooter (const char *)
 
void endFile ()
 
void clearBuffer ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const char *)
 
void startTitle ()
 
void endTitleHead (const char *, const char *name)
 
void endTitle ()
 
void newParagraph ()
 
void startParagraph (const char *classDef)
 
void endParagraph ()
 
void writeString (const char *text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const char *, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const char *ref, const char *file)
 
void endIndexItem (const char *ref, const char *file)
 
void docify (const char *text)
 
void codify (const char *text)
 
void writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
 
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
 
void writeTooltip (const char *, const DocLinkInfo &, const char *, const char *, const SourceLinkInfo &, const SourceLinkInfo &)
 
void startTextLink (const char *f, const char *anchor)
 
void endTextLink ()
 
void startHtmlLink (const char *url)
 
void endHtmlLink ()
 
void startTypewriter ()
 
void endTypewriter ()
 
void startGroupHeader (int)
 
void endGroupHeader (int)
 
void startItemListItem ()
 
void endItemListItem ()
 
void startMemberSections ()
 
void endMemberSections ()
 
void startHeaderSection ()
 
void endHeaderSection ()
 
void startMemberHeader (const char *, int)
 
void endMemberHeader ()
 
void startMemberSubtitle ()
 
void endMemberSubtitle ()
 
void startMemberDocList ()
 
void endMemberDocList ()
 
void startMemberList ()
 
void endMemberList ()
 
void startInlineHeader ()
 
void endInlineHeader ()
 
void startAnonTypeScope (int)
 
void endAnonTypeScope (int)
 
void startMemberItem (const char *, int, const char *)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *, const char *)
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (int, bool)
 
void writeRuler ()
 
void writeAnchor (const char *fileName, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void writeLineNumber (const char *, const char *, const char *, int l)
 
void startCodeLine (bool)
 
void endCodeLine ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void lineBreak (const char *style=0)
 
void startMemberDoc (const char *, const char *, const char *, const char *, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
 
void endDoxyAnchor (const char *, const char *)
 
void writeChar (char c)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *name)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const char *, const char *, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *, const char *)
 
void writeInheritedSectionTitle (const char *, const char *, const char *, const char *, const char *, const char *)
 
void startDescList (SectionTypes)
 
void startExamples ()
 
void endExamples ()
 
void startParamList (ParamListTypes, const char *)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const char *, const char *, SectionType)
 
void endSection (const char *, SectionType)
 
void addIndexItem (const char *, const char *)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const char *filename, const char *name)
 
void startPageRef ()
 
void endPageRef (const char *, const char *)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const char *)
 
void writeNavigationPath (const char *)
 
void writeLogo ()
 
void writeQuickLinks (bool, HighlightedItem, const char *)
 
void writeSummaryLink (const char *, const char *, const char *, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const char *title)
 
void endDescTable ()
 
void startDescTableRow ()
 
void endDescTableRow ()
 
void startDescTableTitle ()
 
void endDescTableTitle ()
 
void startDescTableData ()
 
void endDescTableData ()
 
void startDotGraph ()
 
void endDotGraph (DotClassGraph &)
 
void startInclDepGraph ()
 
void endInclDepGraph (DotInclDepGraph &)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (DotGroupCollaboration &g)
 
void startCallGraph ()
 
void endCallGraph (DotCallGraph &)
 
void startDirDepGraph ()
 
void endDirDepGraph (DotDirDeps &g)
 
void writeGraphicalHierarchy (DotGfxHierarchyTable &)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void startTextBlock (bool dense)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool, const char *)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool, bool, bool)
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const char *, bool)
 
void startConstraintList (const char *)
 
void startConstraintParam ()
 
void endConstraintParam ()
 
void startConstraintType ()
 
void endConstraintType ()
 
void startConstraintDocs ()
 
void endConstraintDocs ()
 
void endConstraintList ()
 
void startMemberDocSimple (bool)
 
void endMemberDocSimple (bool)
 
void startInlineMemberType ()
 
void endInlineMemberType ()
 
void startInlineMemberName ()
 
void endInlineMemberName ()
 
void startInlineMemberDoc ()
 
void endInlineMemberDoc ()
 
void startLabels ()
 
void writeLabel (const char *l, bool isLast)
 
void endLabels ()
 
void startFontClass (const char *)
 
void endFontClass ()
 
void writeCodeAnchor (const char *)
 
void setCurrentDoc (const Definition *, const char *, bool)
 
void addWord (const char *, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 Copyright (C) 1997-2015 by Dimitri van Heesch. More...
 
virtual ~OutputGenerator ()
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
virtual void startPageDoc (const char *)
 
virtual void endPageDoc ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual void parseText (const QCString &)
 
- Public Member Functions inherited from CodeOutputInterface
virtual ~CodeOutputInterface ()
 

Static Public Member Functions

static void init ()
 
static void writeStyleSheetFile (QFile &f)
 
static void writeExtensionsFile (QFile &file)
 
static bool preProcessFileInplace (const char *path, const char *name)
 This is an API to a VERY brittle RTF preprocessor that combines nested RTF files. More...
 

Private Member Functions

 RTFGenerator (const RTFGenerator &)
 
RTFGeneratoroperator= (const RTFGenerator &)
 
const char * rtf_BList_DepthStyle ()
 
const char * rtf_CList_DepthStyle ()
 
const char * rtf_EList_DepthStyle ()
 
const char * rtf_LCList_DepthStyle ()
 
const char * rtf_DList_DepthStyle ()
 
const char * rtf_Code_DepthStyle ()
 
void incrementIndentLevel ()
 
void decrementIndentLevel ()
 
void beginRTFDocument ()
 
void beginRTFChapter ()
 
void beginRTFSection ()
 
void rtfwriteRuler_doubleline ()
 
void rtfwriteRuler_emboss ()
 
void rtfwriteRuler_thick ()
 
void rtfwriteRuler_thin ()
 
void writeRTFReference (const char *label)
 

Private Attributes

QCString m_sourceFileName
 
int m_col
 
bool m_prettyCode
 
bool m_bstartedBody
 
int m_listLevel
 
bool m_omitParagraph
 
int m_numCols
 
QCString m_relPath
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl, Docbook
}
 
- Public Types inherited from BaseOutputDocInterface
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  SectionTypes { EnumValues, Examples }
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFilem_file
 
QCString m_fileName
 
QCString m_dir
 
bool m_active
 
QStack< bool > * m_genStack
 

Detailed Description

Generator for RTF output.

Definition at line 26 of file rtfgen.h.

Constructor & Destructor Documentation

◆ RTFGenerator() [1/2]

RTFGenerator::RTFGenerator ( )

◆ ~RTFGenerator()

RTFGenerator::~RTFGenerator ( )

Definition at line 78 of file rtfgen.cpp.

◆ RTFGenerator() [2/2]

RTFGenerator::RTFGenerator ( const RTFGenerator )
private

Member Function Documentation

◆ addIndexItem()

void RTFGenerator::addIndexItem ( const char *  s1,
const char *  s2 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1582 of file rtfgen.cpp.

References docify(), endl(), and OutputGenerator::t.

Referenced by endTitleHead(), and startMemberDoc().

◆ addWord()

void RTFGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 268 of file rtfgen.h.

◆ beginRTFChapter()

void RTFGenerator::beginRTFChapter ( )
private

◆ beginRTFDocument()

◆ beginRTFSection()

void RTFGenerator::beginRTFSection ( )
private

◆ clearBuffer()

void RTFGenerator::clearBuffer ( )

◆ codify()

void RTFGenerator::codify ( const char *  s)
virtual

Writes an code fragment to the output. This function should keep spaces visible, should break lines at a newline and should convert tabs to the right number of spaces.

Implements CodeOutputInterface.

Definition at line 1821 of file rtfgen.cpp.

References Config_getInt, QCString::left(), m_col, newParagraph(), Doxygen::spaces, OutputGenerator::t, and writeUtf8Char().

Referenced by writeCodeLink().

◆ decrementIndentLevel()

void RTFGenerator::decrementIndentLevel ( )
private

◆ disable()

void RTFGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 39 of file rtfgen.h.

References FALSE, and OutputGenerator::m_active.

Referenced by disableIf(), and disableIfNot().

◆ disableIf()

void RTFGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 41 of file rtfgen.h.

References disable(), and OutputGenerator::RTF.

◆ disableIfNot()

void RTFGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 42 of file rtfgen.h.

References disable(), and OutputGenerator::RTF.

◆ docify()

void RTFGenerator::docify ( const char *  s)
virtual

Writes an ASCII string to the output. Converts characters that have A special meaning, like & in html.

Implements BaseOutputDocInterface.

Definition at line 1776 of file rtfgen.cpp.

References FALSE, m_omitParagraph, OutputGenerator::t, and TRUE.

Referenced by addIndexItem(), endTitleHead(), startConstraintList(), startDescTable(), startExamples(), startParamList(), startSection(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

◆ enable()

void RTFGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 37 of file rtfgen.h.

References OutputGenerator::m_active, OutputGenerator::m_genStack, QStack< type >::top(), and TRUE.

Referenced by enableIf().

◆ enableIf()

void RTFGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 40 of file rtfgen.h.

References enable(), and OutputGenerator::RTF.

◆ endAnonTypeScope()

void RTFGenerator::endAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 119 of file rtfgen.h.

◆ endBold()

void RTFGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 138 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endInlineHeader(), endMemberDoc(), startConstraintList(), startExamples(), startParamList(), and writeObjectLink().

◆ endCallGraph()

◆ endCenter()

void RTFGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 158 of file rtfgen.h.

References OutputGenerator::t.

◆ endClassDiagram()

void RTFGenerator::endClassDiagram ( const ClassDiagram d,
const char *  filename,
const char *  name 
)
virtual

◆ endCodeFragment()

void RTFGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 1940 of file rtfgen.cpp.

References DBG_RTF, endCodeLine(), endl(), m_omitParagraph, OutputGenerator::t, and TRUE.

◆ endCodeLine()

void RTFGenerator::endCodeLine ( )
virtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 3072 of file rtfgen.cpp.

References DoxyCodeLineOpen, FALSE, and lineBreak().

Referenced by endCodeFragment().

◆ endConstraintDocs()

void RTFGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2913 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endConstraintList()

void RTFGenerator::endConstraintList ( )
virtual

◆ endConstraintParam()

void RTFGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2888 of file rtfgen.cpp.

References DBG_RTF, endEmphasis(), endl(), and OutputGenerator::t.

◆ endConstraintType()

void RTFGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2901 of file rtfgen.cpp.

References DBG_RTF, endEmphasis(), endl(), and OutputGenerator::t.

◆ endContents()

void RTFGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 194 of file rtfgen.h.

◆ endDescForItem()

void RTFGenerator::endDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1684 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endDescItem()

void RTFGenerator::endDescItem ( )
virtual

Ends an item of a description list and starts the description itself: e.g. </dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 1633 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endDescription()

void RTFGenerator::endDescription ( )
virtual

Ends a description list: e.g. </dl> in HTML

Implements BaseOutputDocInterface.

Definition at line 1619 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endDescTable()

void RTFGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2049 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endDescTableData()

void RTFGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2081 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endDescTableRow()

void RTFGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2059 of file rtfgen.cpp.

◆ endDescTableTitle()

void RTFGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2069 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endDirDepGraph()

◆ endDotGraph()

◆ endDoxyAnchor()

void RTFGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1554 of file rtfgen.cpp.

References DBG_RTF, endl(), rtfFormatBmkStr(), and OutputGenerator::t.

◆ endEmphasis()

void RTFGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 136 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endConstraintParam(), endConstraintType(), endMemberDescription(), endMemberGroupDocs(), and endPageRef().

◆ endExamples()

void RTFGenerator::endExamples ( )
virtual

◆ endFile()

void RTFGenerator::endFile ( )
virtual

◆ endFontClass()

void RTFGenerator::endFontClass ( )
virtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 3110 of file rtfgen.cpp.

References OutputGenerator::t.

◆ endGroupCollaboration()

void RTFGenerator::endGroupCollaboration ( DotGroupCollaboration g)
virtual

Implements OutputGenerator.

Definition at line 2544 of file rtfgen.cpp.

◆ endGroupHeader()

void RTFGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 1506 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style_Reset, and OutputGenerator::t.

Referenced by endMemberHeader().

◆ endHeaderSection()

void RTFGenerator::endHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 107 of file rtfgen.h.

◆ endHtmlLink()

void RTFGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1123 of file rtfgen.cpp.

References Config_getBool, endl(), endTypewriter(), and OutputGenerator::t.

◆ endInclDepGraph()

◆ endIndent()

void RTFGenerator::endIndent ( )
virtual

Implements OutputGenerator.

Definition at line 1605 of file rtfgen.cpp.

References decrementIndentLevel(), endl(), and OutputGenerator::t.

◆ endIndexItem()

void RTFGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1084 of file rtfgen.cpp.

References DBG_RTF, endl(), m_omitParagraph, OutputGenerator::t, TRUE, and writeRTFReference().

◆ endIndexKey()

void RTFGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1188 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endIndexList()

void RTFGenerator::endIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 997 of file rtfgen.cpp.

References DBG_RTF, decrementIndentLevel(), endl(), m_omitParagraph, OutputGenerator::t, and TRUE.

◆ endIndexListItem()

void RTFGenerator::endIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 2933 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endIndexSection()

void RTFGenerator::endIndexSection ( IndexSections  is)
virtual

Implements OutputGenerator.

Definition at line 576 of file rtfgen.cpp.

References beginRTFChapter(), beginRTFSection(), Doxygen::classSDict, Config_getBool, Config_getString, dateToRTFDateString(), dateToString(), DBG_RTF, Doxygen::directories, endl(), Doxygen::exampleSDict, FALSE, getDoxygenVersion(), NamespaceDef::getOutputFileBase(), PageDef::getOutputFileBase(), DirDef::getOutputFileBase(), GroupDef::getOutputFileBase(), ClassDef::getOutputFileBase(), Doxygen::groupSDict, Doxygen::inputNameLinkedMap, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, ClassDef::isEmbeddedInOuterScope(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), ClassDef::isLinkableInProject(), isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< NamespaceDef >::Iterator, SDict< ClassDef >::Iterator, SDict< PageDef >::Iterator, SDict< GroupDef >::Iterator, m_prettyCode, Doxygen::mainPage, mainPageHasTitle(), Doxygen::namespaceSDict, rtf_author, rtf_company, rtf_documentId, rtf_documentType, rtf_logoFilename, rtf_Style, rtf_Style_Reset, rtf_title, substitute(), OutputGenerator::t, ClassDef::templateMaster(), theTranslator, Translator::trClassDocumentation(), Translator::trCompoundIndex(), Translator::trCompoundIndexFortran(), Translator::trDesignUnitIndex(), Translator::trDirDocumentation(), Translator::trDirIndex(), Translator::trExampleDocumentation(), Translator::trFileDocumentation(), Translator::trFileIndex(), Translator::trHierarchicalIndex(), Translator::trMainPage(), Translator::trModuleDocumentation(), Translator::trModuleIndex(), Translator::trModulesIndex(), Translator::trNamespaceIndex(), Translator::trPageIndex(), Translator::trRTFGeneralIndex(), Translator::trRTFTableOfContents(), Translator::trTypeDocumentation(), TRUE, Translator::trVersion(), validatingParseText(), and writeDoc().

◆ endIndexValue()

void RTFGenerator::endIndexValue ( const char *  name,
bool  hasBrief 
)
virtual

◆ endInlineHeader()

void RTFGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2947 of file rtfgen.cpp.

References DBG_RTF, endBold(), endl(), and OutputGenerator::t.

◆ endInlineMemberDoc()

void RTFGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 3032 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endInlineMemberName()

void RTFGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 3020 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endInlineMemberType()

void RTFGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 3008 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endItemList()

void RTFGenerator::endItemList ( )
virtual

end bullet list

Implements BaseOutputDocInterface.

Definition at line 1020 of file rtfgen.cpp.

References DBG_RTF, decrementIndentLevel(), endl(), m_listLevel, m_omitParagraph, newParagraph(), OutputGenerator::t, and TRUE.

◆ endItemListItem()

void RTFGenerator::endItemListItem ( )
virtual

Writes a list item for a bullet or enumerated list: e.g. </li> in html

Implements BaseOutputDocInterface.

Definition at line 1068 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endLabels()

void RTFGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 3088 of file rtfgen.cpp.

◆ endMemberDeclaration()

void RTFGenerator::endMemberDeclaration ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 165 of file rtfgen.h.

◆ endMemberDescription()

void RTFGenerator::endMemberDescription ( )
virtual

◆ endMemberDoc()

void RTFGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1535 of file rtfgen.cpp.

References DBG_RTF, endBold(), endl(), newParagraph(), and OutputGenerator::t.

◆ endMemberDocList()

void RTFGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 113 of file rtfgen.h.

◆ endMemberDocName()

void RTFGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file rtfgen.h.

◆ endMemberDocPrefixItem()

void RTFGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 230 of file rtfgen.h.

◆ endMemberDocSimple()

void RTFGenerator::endMemberDocSimple ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2996 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endMemberGroup()

void RTFGenerator::endMemberGroup ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2723 of file rtfgen.cpp.

References DBG_RTF, decrementIndentLevel(), endl(), and OutputGenerator::t.

◆ endMemberGroupDocs()

void RTFGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2710 of file rtfgen.cpp.

References DBG_RTF, endEmphasis(), endl(), newParagraph(), and OutputGenerator::t.

◆ endMemberGroupHeader()

void RTFGenerator::endMemberGroupHeader ( )
virtual

◆ endMemberHeader()

void RTFGenerator::endMemberHeader ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 109 of file rtfgen.h.

References endGroupHeader(), and FALSE.

◆ endMemberItem()

void RTFGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1897 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endMemberList()

void RTFGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1971 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endMemberSections()

void RTFGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 105 of file rtfgen.h.

◆ endMemberSubtitle()

void RTFGenerator::endMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 2204 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endMemberTemplateParams()

void RTFGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 123 of file rtfgen.h.

◆ endPageRef()

void RTFGenerator::endPageRef ( const char *  clname,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1394 of file rtfgen.cpp.

References endEmphasis(), OutputGenerator::t, and writeRTFReference().

◆ endParagraph()

void RTFGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 2190 of file rtfgen.cpp.

References DBG_RTF, endl(), m_omitParagraph, OutputGenerator::t, and TRUE.

◆ endParameterList()

void RTFGenerator::endParameterList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 238 of file rtfgen.h.

◆ endParameterName()

void RTFGenerator::endParameterName ( bool  ,
bool  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 236 of file rtfgen.h.

◆ endParameterType()

void RTFGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 2788 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endParamList()

void RTFGenerator::endParamList ( )
virtual

◆ endProjectNumber()

void RTFGenerator::endProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 398 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ endQuickIndices()

void RTFGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 187 of file rtfgen.h.

◆ endSection()

void RTFGenerator::endSection ( const char *  lab,
SectionType   
)
virtual

◆ endSmall()

void RTFGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 160 of file rtfgen.h.

References OutputGenerator::t.

◆ endSubsection()

void RTFGenerator::endSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1228 of file rtfgen.cpp.

References endl(), newParagraph(), rtf_Style_Reset, and OutputGenerator::t.

◆ endSubsubsection()

void RTFGenerator::endSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1243 of file rtfgen.cpp.

References endl(), newParagraph(), and OutputGenerator::t.

◆ endTextBlock()

void RTFGenerator::endTextBlock ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2164 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ endTextLink()

void RTFGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1347 of file rtfgen.cpp.

References Config_getBool, endl(), and OutputGenerator::t.

◆ endTitle()

void RTFGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 64 of file rtfgen.h.

◆ endTitleHead()

void RTFGenerator::endTitleHead ( const char *  fileName,
const char *  name 
)
virtual

◆ endTypewriter()

void RTFGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 97 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endHtmlLink().

◆ exceptionEntry()

void RTFGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2794 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ get()

OutputGenerator* RTFGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 44 of file rtfgen.h.

References OutputGenerator::RTF.

◆ incrementIndentLevel()

void RTFGenerator::incrementIndentLevel ( )
private

◆ init()

◆ insertMemberAlign()

void RTFGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 124 of file rtfgen.h.

◆ insertMemberAlignLeft()

void RTFGenerator::insertMemberAlignLeft ( int  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 125 of file rtfgen.h.

◆ isEnabled()

bool RTFGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 43 of file rtfgen.h.

References OutputGenerator::m_active, and OutputGenerator::RTF.

◆ lastIndexPage()

void RTFGenerator::lastIndexPage ( )
virtual

Implements OutputGenerator.

Definition at line 959 of file rtfgen.cpp.

References DBG_RTF, rtf_Style, and OutputGenerator::t.

◆ lineBreak()

void RTFGenerator::lineBreak ( const char *  style = 0)
virtual

Implements BaseOutputDocInterface.

Definition at line 975 of file rtfgen.cpp.

References DBG_RTF, endl(), m_omitParagraph, OutputGenerator::t, and TRUE.

Referenced by endCodeLine().

◆ newParagraph()

◆ operator=()

RTFGenerator& RTFGenerator::operator= ( const RTFGenerator )
private

◆ preProcessFileInplace()

bool RTFGenerator::preProcessFileInplace ( const char *  path,
const char *  name 
)
static

This is an API to a VERY brittle RTF preprocessor that combines nested RTF files.

This version replaces the infile with the new file

Definition at line 2642 of file rtfgen.cpp.

References QDir::absPath(), QFile::close(), QDir::currentDirPath(), QCString::data(), err(), QDir::exists(), FALSE, IO_WriteOnly, Rtf_Style_Default::name, QFile::open(), preProcessFile(), QDir::remove(), QDir::rename(), QDir::setCurrent(), testRTFOutput(), TRUE, and QString::utf8().

Referenced by generateOutput().

◆ rtf_BList_DepthStyle()

const char * RTFGenerator::rtf_BList_DepthStyle ( )
private

Definition at line 2124 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startItemListItem(), startMemberGroup(), and startMemberItem().

◆ rtf_CList_DepthStyle()

const char * RTFGenerator::rtf_CList_DepthStyle ( )
private

◆ rtf_Code_DepthStyle()

const char * RTFGenerator::rtf_Code_DepthStyle ( )
private

Definition at line 2143 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startCodeFragment().

◆ rtf_DList_DepthStyle()

const char * RTFGenerator::rtf_DList_DepthStyle ( )
private

◆ rtf_EList_DepthStyle()

const char * RTFGenerator::rtf_EList_DepthStyle ( )
private

Definition at line 2131 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startItemListItem().

◆ rtf_LCList_DepthStyle()

const char * RTFGenerator::rtf_LCList_DepthStyle ( )
private

Definition at line 2117 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startIndexList().

◆ rtfwriteRuler_doubleline()

void RTFGenerator::rtfwriteRuler_doubleline ( )
private

Definition at line 2812 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ rtfwriteRuler_emboss()

void RTFGenerator::rtfwriteRuler_emboss ( )
private

Definition at line 2818 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

Referenced by beginRTFSection().

◆ rtfwriteRuler_thick()

void RTFGenerator::rtfwriteRuler_thick ( )
private

Definition at line 2824 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

Referenced by beginRTFChapter().

◆ rtfwriteRuler_thin()

void RTFGenerator::rtfwriteRuler_thin ( )
private

Definition at line 2830 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

Referenced by writeRuler().

◆ setCurrentDoc()

void RTFGenerator::setCurrentDoc ( const Definition ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 267 of file rtfgen.h.

◆ setRelativePath()

void RTFGenerator::setRelativePath ( const QCString path)

Definition at line 82 of file rtfgen.cpp.

References m_relPath.

Referenced by startFile().

◆ setSourceFileName()

void RTFGenerator::setSourceFileName ( const QCString sourceFileName)

Definition at line 87 of file rtfgen.cpp.

References m_sourceFileName.

Referenced by endFile(), and startFile().

◆ startAnonTypeScope()

void RTFGenerator::startAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 118 of file rtfgen.h.

◆ startBold()

void RTFGenerator::startBold ( )
inlinevirtual

Changes the text font to bold face. The bold section ends with endBold()

Implements BaseOutputDocInterface.

Definition at line 137 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startConstraintList(), startDescList(), startExamples(), startInlineHeader(), startMemberDoc(), startParamList(), and writeObjectLink().

◆ startCallGraph()

void RTFGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2548 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startCenter()

void RTFGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 157 of file rtfgen.h.

References endl(), and OutputGenerator::t.

◆ startClassDiagram()

void RTFGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1864 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startCodeFragment()

void RTFGenerator::startCodeFragment ( )
virtual

Starts a source code fragment. The fragment will be fed to the code parser (see code.h) for syntax highlighting and cross-referencing. The fragment ends by a call to endCodeFragment()

Implements BaseOutputDocInterface.

Definition at line 1931 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Code_DepthStyle(), rtf_Style_Reset, and OutputGenerator::t.

◆ startCodeLine()

void RTFGenerator::startCodeLine ( bool  )
virtual

Implements CodeOutputInterface.

Definition at line 3067 of file rtfgen.cpp.

References DoxyCodeLineOpen, m_col, and TRUE.

◆ startConstraintDocs()

void RTFGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2908 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startConstraintList()

void RTFGenerator::startConstraintList ( const char *  header)
virtual

◆ startConstraintParam()

void RTFGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2882 of file rtfgen.cpp.

References DBG_RTF, endl(), startEmphasis(), and OutputGenerator::t.

◆ startConstraintType()

void RTFGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2895 of file rtfgen.cpp.

References DBG_RTF, endl(), startEmphasis(), and OutputGenerator::t.

◆ startContents()

void RTFGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 193 of file rtfgen.h.

◆ startDescForItem()

void RTFGenerator::startDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1679 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startDescItem()

void RTFGenerator::startDescItem ( )
virtual

Starts an item of a description list: e.g. <dt> in HTML.

Implements BaseOutputDocInterface.

Definition at line 1626 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ startDescList()

void RTFGenerator::startDescList ( SectionTypes  )

Definition at line 1660 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), startBold(), and OutputGenerator::t.

◆ startDescription()

void RTFGenerator::startDescription ( )
virtual

Starts a description list: e.g. <dl> in HTML Items are surrounded by startDescItem() and endDescItem()

Implements BaseOutputDocInterface.

Definition at line 1612 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_DList_DepthStyle(), rtf_Style_Reset, and OutputGenerator::t.

◆ startDescTable()

void RTFGenerator::startDescTable ( const char *  title)
virtual

◆ startDescTableData()

void RTFGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2075 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startDescTableRow()

void RTFGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2055 of file rtfgen.cpp.

◆ startDescTableTitle()

void RTFGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2063 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startDirDepGraph()

void RTFGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2571 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startDotGraph()

void RTFGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2493 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startDoxyAnchor()

void RTFGenerator::startDoxyAnchor ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1546 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startEmphasis()

void RTFGenerator::startEmphasis ( )
inlinevirtual

Changes the text font to italic. The italic section ends with endEmphasis()

Implements BaseOutputDocInterface.

Definition at line 135 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startConstraintParam(), startConstraintType(), startMemberDescription(), startMemberGroupDocs(), and startPageRef().

◆ startExamples()

◆ startFile()

void RTFGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

◆ startFontClass()

void RTFGenerator::startFontClass ( const char *  clsName)
virtual

Starts a block with a certain meaning. Used for syntax highlighting, which elements of the same type are rendered using the same 'font class'.

Parameters
clsNameThe category name.

Implements CodeOutputInterface.

Definition at line 3092 of file rtfgen.cpp.

References Rtf_Style_Default::name, and OutputGenerator::t.

◆ startGroupCollaboration()

void RTFGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 2540 of file rtfgen.cpp.

◆ startGroupHeader()

void RTFGenerator::startGroupHeader ( int  extraIndent)
virtual

Implements OutputGenerator.

Definition at line 1486 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

Referenced by startMemberHeader().

◆ startHeaderSection()

void RTFGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 106 of file rtfgen.h.

◆ startHtmlLink()

void RTFGenerator::startHtmlLink ( const char *  url)
virtual

Starts a (link to an) URL found in the documentation.

Parameters
urlThe URL to link to.

Implements BaseOutputDocInterface.

Definition at line 1107 of file rtfgen.cpp.

References Config_getBool, startTypewriter(), and OutputGenerator::t.

◆ startInclDepGraph()

void RTFGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2517 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startIndent()

void RTFGenerator::startIndent ( )
virtual

◆ startIndexItem()

void RTFGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1073 of file rtfgen.cpp.

References DBG_RTF, endl(), m_omitParagraph, OutputGenerator::t, and TRUE.

◆ startIndexKey()

void RTFGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1182 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startIndexList()

void RTFGenerator::startIndexList ( )
virtual

◆ startIndexListItem()

void RTFGenerator::startIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 2928 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startIndexSection()

◆ startIndexValue()

void RTFGenerator::startIndexValue ( bool  hasBrief)
virtual

Implements OutputGenerator.

Definition at line 1193 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startInlineHeader()

void RTFGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2939 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, startBold(), and OutputGenerator::t.

◆ startInlineMemberDoc()

void RTFGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 3026 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startInlineMemberName()

void RTFGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 3014 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startInlineMemberType()

void RTFGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 3002 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startItemList()

void RTFGenerator::startItemList ( )
virtual

◆ startItemListItem()

void RTFGenerator::startItemListItem ( )
virtual

start enumeration list *‍/ void RTFGenerator::startEnumList() // starts an enumeration list { DBG_RTF(t << "{\\comment (startEnumList)}" << endl) t << "{" << endl; incrementIndentLevel(); rtf_listItemInfo[m_listLevel].isEnum = TRUE; rtf_listItemInfo[m_listLevel].number = 1; }

/*! end enumeration list *‍/ void RTFGenerator::endEnumList() { newParagraph(); DBG_RTF(t << "{\\comment (endEnumList)}" << endl) t << "}"; decrementIndentLevel(); m_omitParagraph = TRUE; }

/*! write bullet or enum item

Implements BaseOutputDocInterface.

Definition at line 1050 of file rtfgen.cpp.

References DBG_RTF, endl(), m_listLevel, m_omitParagraph, newParagraph(), RTFListItemInfo::number, rtf_BList_DepthStyle(), rtf_EList_DepthStyle(), rtf_listItemInfo, rtf_Style_Reset, OutputGenerator::t, and TRUE.

◆ startLabels()

void RTFGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 3078 of file rtfgen.cpp.

◆ startMemberDeclaration()

void RTFGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 164 of file rtfgen.h.

◆ startMemberDescription()

void RTFGenerator::startMemberDescription ( const char *  ,
const char *  ,
bool   
)
virtual

◆ startMemberDoc()

void RTFGenerator::startMemberDoc ( const char *  clname,
const char *  memname,
const char *  ,
const char *  ,
int  ,
int  ,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1513 of file rtfgen.cpp.

References addIndexItem(), DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, startBold(), and OutputGenerator::t.

◆ startMemberDocList()

void RTFGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 112 of file rtfgen.h.

◆ startMemberDocName()

void RTFGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 231 of file rtfgen.h.

◆ startMemberDocPrefixItem()

void RTFGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 229 of file rtfgen.h.

◆ startMemberDocSimple()

void RTFGenerator::startMemberDocSimple ( bool  isEnum)
virtual

◆ startMemberGroup()

void RTFGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 2717 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_BList_DepthStyle(), rtf_Style_Reset, and OutputGenerator::t.

◆ startMemberGroupDocs()

void RTFGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2704 of file rtfgen.cpp.

References DBG_RTF, endl(), startEmphasis(), and OutputGenerator::t.

◆ startMemberGroupHeader()

void RTFGenerator::startMemberGroupHeader ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2689 of file rtfgen.cpp.

References DBG_RTF, endl(), incrementIndentLevel(), rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

◆ startMemberHeader()

void RTFGenerator::startMemberHeader ( const char *  ,
int   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 108 of file rtfgen.h.

References FALSE, and startGroupHeader().

◆ startMemberItem()

void RTFGenerator::startMemberItem ( const char *  ,
int  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1891 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_BList_DepthStyle(), rtf_Style_Reset, and OutputGenerator::t.

◆ startMemberList()

void RTFGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1960 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startMemberSections()

void RTFGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 104 of file rtfgen.h.

◆ startMemberSubtitle()

void RTFGenerator::startMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 2197 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_CList_DepthStyle(), rtf_Style_Reset, and OutputGenerator::t.

◆ startMemberTemplateParams()

void RTFGenerator::startMemberTemplateParams ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file rtfgen.h.

◆ startPageRef()

void RTFGenerator::startPageRef ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1388 of file rtfgen.cpp.

References startEmphasis(), and OutputGenerator::t.

◆ startParagraph()

void RTFGenerator::startParagraph ( const char *  classDef)
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 2182 of file rtfgen.cpp.

References DBG_RTF, endl(), newParagraph(), and OutputGenerator::t.

◆ startParameterList()

void RTFGenerator::startParameterList ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 237 of file rtfgen.h.

◆ startParameterName()

void RTFGenerator::startParameterName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 235 of file rtfgen.h.

◆ startParameterType()

void RTFGenerator::startParameterType ( bool  first,
const char *  key 
)
virtual

Implements OutputGenerator.

Definition at line 2779 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startParamList()

void RTFGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

◆ startProjectNumber()

void RTFGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 392 of file rtfgen.cpp.

References DBG_RTF, endl(), and OutputGenerator::t.

◆ startQuickIndices()

void RTFGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 186 of file rtfgen.h.

◆ startSection()

void RTFGenerator::startSection ( const char *  ,
const char *  title,
SectionType  type 
)
virtual

◆ startSmall()

void RTFGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 159 of file rtfgen.h.

References OutputGenerator::t.

◆ startSubsection()

void RTFGenerator::startSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1219 of file rtfgen.cpp.

References DBG_RTF, rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

◆ startSubsubsection()

void RTFGenerator::startSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1234 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

◆ startTextBlock()

void RTFGenerator::startTextBlock ( bool  dense)
virtual

Implements OutputGenerator.

Definition at line 2149 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

◆ startTextLink()

void RTFGenerator::startTextLink ( const char *  f,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1325 of file rtfgen.cpp.

References Config_getBool, rtfFormatBmkStr(), and OutputGenerator::t.

◆ startTitle()

void RTFGenerator::startTitle ( )
virtual

◆ startTitleHead()

void RTFGenerator::startTitleHead ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 1443 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_Style, rtf_Style_Reset, and OutputGenerator::t.

◆ startTypewriter()

void RTFGenerator::startTypewriter ( )
inlinevirtual

Changes the text font to fixed size. The section ends with endTypewriter()

Implements BaseOutputDocInterface.

Definition at line 96 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startHtmlLink().

◆ writeAnchor()

void RTFGenerator::writeAnchor ( const char *  fileName,
const char *  name 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1903 of file rtfgen.cpp.

References DBG_RTF, endl(), Rtf_Style_Default::name, rtfFormatBmkStr(), and OutputGenerator::t.

Referenced by endSection(), and endTitleHead().

◆ writeChar()

void RTFGenerator::writeChar ( char  c)
virtual

Writes a single ASCII character to the output. Converts characters that have a special meaning.

Implements BaseOutputDocInterface.

Definition at line 1856 of file rtfgen.cpp.

References cs, and docify().

◆ writeCodeAnchor()

void RTFGenerator::writeCodeAnchor ( const char *  name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 266 of file rtfgen.h.

◆ writeCodeLink()

void RTFGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
)
virtual

Writes a link to an object in a code fragment.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.
tooltipThe tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 1411 of file rtfgen.cpp.

References codify(), Config_getBool, endl(), Rtf_Style_Default::name, rtfFormatBmkStr(), and OutputGenerator::t.

◆ writeDoc()

void RTFGenerator::writeDoc ( DocNode n,
const Definition ctx,
const MemberDef  
)
virtual

◆ writeEndAnnoItem()

void RTFGenerator::writeEndAnnoItem ( const char *  name)
virtual

◆ writeExtensionsFile()

void RTFGenerator::writeExtensionsFile ( QFile file)
static

Definition at line 109 of file rtfgen.cpp.

References getDoxygenVersion(), and OutputGenerator::t.

Referenced by readConfiguration().

◆ writeFooter()

void RTFGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 50 of file rtfgen.h.

◆ writeGraphicalHierarchy()

void RTFGenerator::writeGraphicalHierarchy ( DotGfxHierarchyTable )
inlinevirtual

Implements OutputGenerator.

Definition at line 216 of file rtfgen.h.

◆ writeInheritedSectionTitle()

void RTFGenerator::writeInheritedSectionTitle ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 166 of file rtfgen.h.

◆ writeLabel()

void RTFGenerator::writeLabel ( const char *  l,
bool  isLast 
)
virtual

Implements OutputGenerator.

Definition at line 3082 of file rtfgen.cpp.

References languages::l, and OutputGenerator::t.

◆ writeLatexSpacing()

void RTFGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 149 of file rtfgen.h.

◆ writeLineNumber()

void RTFGenerator::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
)
virtual

Writes the line number of a source listing

Parameters
refExternal reference (when imported from a tag file)
fileThe file part of the URL pointing to the docs.
anchorThe anchor part of the URL pointing to the docs.
lineNumberThe line number to write

Implements CodeOutputInterface.

Definition at line 3038 of file rtfgen.cpp.

References Config_getBool, DoxyCodeLineOpen, endl(), QCString::isEmpty(), languages::l, m_col, m_prettyCode, m_sourceFileName, QCString::prepend(), rtfFormatBmkStr(), QCString::sprintf(), stripExtensionGeneral(), OutputGenerator::t, and TRUE.

◆ writeLogo()

void RTFGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 190 of file rtfgen.h.

◆ writeNavigationPath()

void RTFGenerator::writeNavigationPath ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file rtfgen.h.

◆ writeNonBreakableSpace()

void RTFGenerator::writeNonBreakableSpace ( int  )
virtual

Implements BaseOutputDocInterface.

Definition at line 1954 of file rtfgen.cpp.

References OutputGenerator::t.

◆ writeObjectLink()

void RTFGenerator::writeObjectLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name 
)
virtual

Writes a link to an object in the documentation.

Parameters
refIf this is non-zero, the object is to be found in an external documentation file.
fileThe file in which the object is located.
anchorThe anchor uniquely identifying the object within the file.
nameThe text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 1355 of file rtfgen.cpp.

References Config_getBool, docify(), endBold(), endl(), rtfFormatBmkStr(), startBold(), and OutputGenerator::t.

◆ writePageLink()

void RTFGenerator::writePageLink ( const char *  name,
bool  first 
)
virtual

Implements OutputGenerator.

Definition at line 951 of file rtfgen.cpp.

References endl(), Rtf_Style_Default::name, rtf_Style_Reset, and OutputGenerator::t.

◆ writeQuickLinks()

void RTFGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 191 of file rtfgen.h.

◆ writeRTFReference()

void RTFGenerator::writeRTFReference ( const char *  label)
private

Definition at line 1924 of file rtfgen.cpp.

References rtfFormatBmkStr(), and OutputGenerator::t.

Referenced by endIndexItem(), endIndexValue(), endPageRef(), and writeEndAnnoItem().

◆ writeRuler()

void RTFGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 127 of file rtfgen.h.

References rtfwriteRuler_thin().

◆ writeSearchInfo()

void RTFGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 49 of file rtfgen.h.

◆ writeSplitBar()

void RTFGenerator::writeSplitBar ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 188 of file rtfgen.h.

◆ writeStartAnnoItem()

void RTFGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
virtual

◆ writeString()

void RTFGenerator::writeString ( const char *  text)
virtual

Writes an ASCII string to the output, without converting special characters.

Implements BaseOutputDocInterface.

Definition at line 982 of file rtfgen.cpp.

References OutputGenerator::t.

◆ writeStyleInfo()

void RTFGenerator::writeStyleInfo ( int  part)
virtual

Implements OutputGenerator.

Definition at line 971 of file rtfgen.cpp.

◆ writeStyleSheetFile()

void RTFGenerator::writeStyleSheetFile ( QFile f)
static

◆ writeSummaryLink()

void RTFGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 192 of file rtfgen.h.

◆ writeSynopsis()

void RTFGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 181 of file rtfgen.h.

◆ writeTooltip()

void RTFGenerator::writeTooltip ( const char *  id,
const DocLinkInfo docInfo,
const char *  decl,
const char *  desc,
const SourceLinkInfo defInfo,
const SourceLinkInfo declInfo 
)
inlinevirtual

Writes a tool tip definition

Parameters
idunique identifier for the tooltip
docInfoInfo about the symbol's documentation.
declfull declaration of the symbol (for functions)
descbrief description for the symbol
defInfoInfo about the symbol's definition in the source code
declInfoInfo about the symbol's declaration in the source code

Implements CodeOutputInterface.

Definition at line 89 of file rtfgen.h.

Member Data Documentation

◆ m_bstartedBody

bool RTFGenerator::m_bstartedBody
private

Definition at line 288 of file rtfgen.h.

Referenced by RTFGenerator().

◆ m_col

int RTFGenerator::m_col
private

Definition at line 285 of file rtfgen.h.

Referenced by codify(), RTFGenerator(), startCodeLine(), and writeLineNumber().

◆ m_listLevel

◆ m_numCols

int RTFGenerator::m_numCols
private

Definition at line 291 of file rtfgen.h.

Referenced by RTFGenerator().

◆ m_omitParagraph

◆ m_prettyCode

bool RTFGenerator::m_prettyCode
private

Definition at line 286 of file rtfgen.h.

Referenced by endIndexSection(), RTFGenerator(), and writeLineNumber().

◆ m_relPath

QCString RTFGenerator::m_relPath
private

◆ m_sourceFileName

QCString RTFGenerator::m_sourceFileName
private

Definition at line 284 of file rtfgen.h.

Referenced by setSourceFileName(), and writeLineNumber().


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