doxygen
Classes | Public Member Functions | Static Public Member Functions | List of all members
RTFGenerator Class Reference

Generator for RTF output. More...

#include <rtfgen.h>

Inheritance diagram for RTFGenerator:
Inheritance graph
[legend]
Collaboration diagram for RTFGenerator:
Collaboration graph
[legend]

Public Member Functions

 RTFGenerator (const RTFGenerator &)
 
RTFGenerator & operator= (const RTFGenerator &)
 
 RTFGenerator (RTFGenerator &&)
 
RTFGenerator & operator= (RTFGenerator &&)=delete
 
void cleanup ()
 
OutputType type () const
 
void setRelativePath (const QCString &path)
 
void setSourceFileName (const QCString &sourceFileName)
 
void writeDoc (const IDocNodeAST *ast, const Definition *, const MemberDef *, int)
 
void startFile (const QCString &name, const QCString &manName, const QCString &title, int id, int hierarchyLevel)
 
void writeSearchInfo ()
 
void writeFooter (const QCString &)
 
void endFile ()
 
void clearBuffer ()
 
void startPageDoc (const QCString &)
 
void endPageDoc ()
 
void startIndexSection (IndexSection)
 
void endIndexSection (IndexSection)
 
void writePageLink (const QCString &, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const QCString &)
 
void endTitleHead (const QCString &, const QCString &name)
 
void startParagraph (const QCString &classDef)
 
void endParagraph ()
 
void writeString (const QCString &text)
 
void startIndexListItem ()
 
void endIndexListItem ()
 
void startIndexList ()
 
void endIndexList ()
 
void startIndexKey ()
 
void endIndexKey ()
 
void startIndexValue (bool)
 
void endIndexValue (const QCString &, bool)
 
void startItemList ()
 
void endItemList ()
 
void startIndexItem (const QCString &ref, const QCString &file)
 
void endIndexItem (const QCString &ref, const QCString &file)
 
void docify (const QCString &text)
 
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
 
void startTextLink (const QCString &f, const QCString &anchor)
 
void endTextLink ()
 
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 QCString &, 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 QCString &, MemberItemType, const QCString &)
 
void endMemberItem (MemberItemType)
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const QCString &, const QCString &)
 
void startCompoundTemplateParams ()
 
void endCompoundTemplateParams ()
 
void insertMemberAlign (bool)
 
void insertMemberAlignLeft (MemberItemType, bool)
 
void writeRuler ()
 
void writeAnchor (const QCString &fileName, const QCString &name)
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void lineBreak (const QCString &style=QCString())
 
void startMemberDoc (const QCString &, const QCString &, const QCString &, const QCString &, int, int, bool)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)
 
void endDoxyAnchor (const QCString &, const QCString &)
 
void addLabel (const QCString &, const QCString &)
 
void writeChar (char c)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startMemberDescription (const QCString &, const QCString &, bool)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const QCString &, const QCString &)
 
void writeInheritedSectionTitle (const QCString &, const QCString &, const QCString &, const QCString &, const QCString &, const QCString &)
 
void startExamples ()
 
void endExamples ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void startSection (const QCString &, const QCString &, SectionType)
 
void endSection (const QCString &, SectionType)
 
void addIndexItem (const QCString &, const QCString &)
 
void startIndent ()
 
void endIndent ()
 
void writeSynopsis ()
 
void startClassDiagram ()
 
void endClassDiagram (const ClassDiagram &, const QCString &filename, const QCString &name)
 
void startPageRef ()
 
void endPageRef (const QCString &, const QCString &)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const QCString &)
 
void writeNavigationPath (const QCString &)
 
void writeLogo ()
 
void writeQuickLinks (HighlightedItem, const QCString &)
 
void writeSummaryLink (const QCString &, const QCString &, const QCString &, bool)
 
void startContents ()
 
void endContents ()
 
void writeNonBreakableSpace (int)
 
void startDescTable (const QCString &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 QCString &)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName ()
 
void startParameterExtra ()
 
void endParameterExtra (bool, bool, bool)
 
void startParameterDefVal (const char *s)
 
void endParameterDefVal ()
 
void startParameterList (bool)
 
void endParameterList ()
 
void exceptionEntry (const QCString &, bool)
 
void startConstraintList (const QCString &)
 
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 QCString &l, bool isLast)
 
void endLabels ()
 
void writeLocalToc (const SectionRefs &, const LocalToc &)
 
void addCodeGen (OutputCodeList &list)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator (const QCString &dir)
 
QCString dir () const
 
QCString fileName () const
 
void startPlainFile (const QCString &name)
 
void endPlainFile ()
 

Static Public Member Functions

static void init ()
 
static void writeStyleSheetFile (TextStream &t)
 
static void writeExtensionsFile (TextStream &t)
 
static bool preProcessFileInplace (const QCString &path, const QCString &name)
 This is an API to a VERY brittle RTF preprocessor that combines nested RTF files. More...
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  ParamListTypes { Param, RetVal, Exception }
 
enum  MemberItemType { Normal, AnonymousStart, AnonymousEnd, Templated }
 
- Protected Attributes inherited from OutputGenerator
TextStream m_t
 
QCString m_dir
 

Detailed Description

Generator for RTF output.

Member Function Documentation

◆ endItemList()

void RTFGenerator::endItemList ( )

end bullet list

◆ preProcessFileInplace()

bool RTFGenerator::preProcessFileInplace ( const QCString &  path,
const QCString &  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

◆ startItemList()

void RTFGenerator::startItemList ( )

start bullet list

◆ startItemListItem()

void RTFGenerator::startItemListItem ( )

write bullet or enum item

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13