RTFGenerator Class Reference

#include <rtfgen.h>

Inheritance diagram for RTFGenerator:

OutputGenerator BaseOutputDocInterface CodeOutputInterface List of all members.

Public Member Functions

 RTFGenerator ()
 ~RTFGenerator ()
void enable ()
void disable ()
void enableIf (OutputType o)
void disableIf (OutputType o)
void disableIfNot (OutputType o)
bool isEnabled (OutputType o)
OutputGenerator * get (OutputType o)
void printDoc (DocNode *, const char *)
void startFile (const char *name, const char *manName, const char *title)
void writeFooter ()
void endFile ()
void clearBuffer ()
void postProcess (QByteArray &)
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 ()
void endParagraph ()
void writeString (const char *text)
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 startTextLink (const char *f, const char *anchor)
void endTextLink ()
void startHtmlLink (const char *url)
void endHtmlLink ()
void startTypewriter ()
void endTypewriter ()
void startGroupHeader ()
void endGroupHeader ()
void writeListItem ()
void startMemberSections ()
void endMemberSections ()
void startMemberHeader ()
void endMemberHeader ()
void startMemberSubtitle ()
void endMemberSubtitle ()
void startMemberDocList ()
void endMemberDocList ()
void startMemberList ()
void endMemberList ()
void startAnonTypeScope (int)
void endAnonTypeScope (int)
void startMemberItem (int)
void endMemberItem ()
void startMemberTemplateParams ()
void endMemberTemplateParams ()
void insertMemberAlign (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 ()
void endCodeLine ()
void startEmphasis ()
void endEmphasis ()
void startBold ()
void endBold ()
void startDescription ()
void endDescription ()
void startDescItem ()
void endDescItem ()
void lineBreak ()
void startMemberDoc (const char *, const char *, const char *, const char *)
void endMemberDoc (bool)
void startDoxyAnchor (const char *, const char *, const char *, const char *, const char *)
void endDoxyAnchor (const char *, const char *)
void startCodeAnchor (const char *)
void endCodeAnchor ()
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 ()
void endMemberDescription ()
void startDescList (SectionTypes)
void startSimpleSect (SectionTypes, const char *, const char *, const char *)
void endSimpleSect ()
void startParamList (ParamListTypes, const char *)
void endParamList ()
void writeDescItem ()
void startSection (const char *, const char *, SectionInfo::SectionType)
void endSection (const char *, SectionInfo::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 writeQuickLinks (bool, HighlightedItem)
void startContents ()
void endContents ()
void writeNonBreakableSpace (int)
void startDescTable ()
void endDescTable ()
void startDescTableTitle ()
void endDescTableTitle ()
void startDescTableData ()
void endDescTableData ()
void startDotGraph ()
void endDotGraph (const DotClassGraph &)
void startInclDepGraph ()
void endInclDepGraph (const DotInclDepGraph &)
void startGroupCollaboration ()
void endGroupCollaboration (const DotGroupCollaboration &g)
void startCallGraph ()
void endCallGraph (const DotCallGraph &)
void startDirDepGraph ()
void endDirDepGraph (const DotDirDeps &g)
void writeGraphicalHierarchy (const 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 startConstraintList (const char *)
void startConstraintParam ()
void endConstraintParam ()
void startConstraintType ()
void endConstraintType ()
void startConstraintDocs ()
void endConstraintDocs ()
void endConstraintList ()
void startFontClass (const char *)
void endFontClass ()
void writeCodeAnchor (const char *)
void linkableSymbol (int, const char *, Definition *, Definition *)

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)

Detailed Description

Definition at line 25 of file rtfgen.h.

Constructor & Destructor Documentation

RTFGenerator::RTFGenerator (  ) 

Definition at line 55 of file rtfgen.cpp.

References Config_getString, and OutputGenerator::dir.

RTFGenerator::~RTFGenerator (  ) 

Definition at line 66 of file rtfgen.cpp.

Member Function Documentation

void RTFGenerator::init (  )  [static]

Definition at line 160 of file rtfgen.cpp.

References Config_getString, createSubDirs(), Rtf_Style_Default::definition, OutputGenerator::dir, err(), loadExtensions(), loadStylesheet(), Rtf_Style_Default::name, QCString, Rtf_Style_Default::reference, rtf_Style, and rtf_Style_Default.

Referenced by generateOutput().

void RTFGenerator::writeStyleSheetFile ( QFile &  f  )  [static]

Definition at line 90 of file rtfgen.cpp.

References Rtf_Style_Default::reference, rtf_Style_Default, OutputGenerator::t, and versionString.

Referenced by readConfiguration().

void RTFGenerator::writeExtensionsFile ( QFile &  file  )  [static]

Definition at line 107 of file rtfgen.cpp.

References OutputGenerator::t, and versionString.

Referenced by readConfiguration().

void RTFGenerator::enable (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 34 of file rtfgen.h.

References OutputGenerator::active, and OutputGenerator::genStack.

void RTFGenerator::disable (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 36 of file rtfgen.h.

References OutputGenerator::active.

void RTFGenerator::enableIf ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 37 of file rtfgen.h.

References OutputGenerator::active, and OutputGenerator::RTF.

void RTFGenerator::disableIf ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 38 of file rtfgen.h.

References OutputGenerator::active, and OutputGenerator::RTF.

void RTFGenerator::disableIfNot ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 39 of file rtfgen.h.

References OutputGenerator::active, and OutputGenerator::RTF.

bool RTFGenerator::isEnabled ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 40 of file rtfgen.h.

References OutputGenerator::active, and OutputGenerator::RTF.

OutputGenerator* RTFGenerator::get ( OutputType  o  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 41 of file rtfgen.h.

References OutputGenerator::RTF.

void RTFGenerator::printDoc ( DocNode *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 2562 of file rtfgen.cpp.

References DocNode::accept().

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

Implements OutputGenerator.

Definition at line 326 of file rtfgen.cpp.

void RTFGenerator::writeFooter (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 46 of file rtfgen.h.

void RTFGenerator::endFile (  )  [virtual]

Implements OutputGenerator.

Definition at line 337 of file rtfgen.cpp.

void RTFGenerator::clearBuffer (  ) 

void RTFGenerator::postProcess ( QByteArray &   )  [virtual]

Reimplemented from OutputGenerator.

Definition at line 2594 of file rtfgen.cpp.

void RTFGenerator::startIndexSection ( IndexSections   )  [virtual]

Implements OutputGenerator.

Definition at line 356 of file rtfgen.cpp.

void RTFGenerator::endIndexSection ( IndexSections   )  [virtual]

Implements OutputGenerator.

Definition at line 526 of file rtfgen.cpp.

void RTFGenerator::writePageLink ( const char *  ,
bool   
) [virtual]

Implements OutputGenerator.

Definition at line 865 of file rtfgen.cpp.

References rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::startProjectNumber (  )  [virtual]

Implements OutputGenerator.

Definition at line 345 of file rtfgen.cpp.

void RTFGenerator::endProjectNumber (  )  [virtual]

Implements OutputGenerator.

Definition at line 351 of file rtfgen.cpp.

void RTFGenerator::writeStyleInfo ( int  part  )  [virtual]

Implements OutputGenerator.

Definition at line 886 of file rtfgen.cpp.

void RTFGenerator::startTitleHead ( const char *   )  [virtual]

Implements OutputGenerator.

Definition at line 1345 of file rtfgen.cpp.

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

void RTFGenerator::startTitle (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1379 of file rtfgen.cpp.

References Config_getBool, DBG_RTF, and OutputGenerator::t.

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

Implements OutputGenerator.

Definition at line 1353 of file rtfgen.cpp.

References addIndexItem(), DBG_RTF, docify(), rtf_Style_Reset, OutputGenerator::t, and writeAnchor().

void RTFGenerator::endTitle (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 60 of file rtfgen.h.

void RTFGenerator::newParagraph (  )  [virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 2045 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

Referenced by codify(), endCallGraph(), endClassDiagram(), endDescItem(), endDescription(), endDescTableData(), endDirDepGraph(), endInclDepGraph(), endIndexItem(), endIndexValue(), endItemList(), endMemberDescription(), endMemberDoc(), endMemberGroupDocs(), endMemberGroupHeader(), endMemberItem(), endMemberSubtitle(), endParamList(), endSection(), endSimpleSect(), endSubsection(), endSubsubsection(), endTextBlock(), startDescItem(), startDescList(), startItemList(), startParagraph(), startParamList(), startSimpleSect(), writeEndAnnoItem(), and writeListItem().

void RTFGenerator::startParagraph (  )  [virtual]

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 2055 of file rtfgen.cpp.

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

void RTFGenerator::endParagraph (  )  [virtual]

End a paragraph

Implements BaseOutputDocInterface.

Definition at line 2062 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

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

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

Implements BaseOutputDocInterface.

Definition at line 897 of file rtfgen.cpp.

References OutputGenerator::t.

void RTFGenerator::startIndexList (  )  [virtual]

Implements OutputGenerator.

Definition at line 902 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endIndexList (  )  [virtual]

Implements OutputGenerator.

Definition at line 912 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::startIndexKey (  )  [virtual]

Implements OutputGenerator.

Definition at line 1084 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endIndexKey (  )  [virtual]

Implements OutputGenerator.

Definition at line 1090 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::startIndexValue ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1095 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endIndexValue ( const char *  ,
bool   
) [virtual]

Implements OutputGenerator.

Definition at line 1102 of file rtfgen.cpp.

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

void RTFGenerator::startItemList (  )  [virtual]

start bullet list

Implements BaseOutputDocInterface.

Definition at line 922 of file rtfgen.cpp.

References DBG_RTF, RTFListItemInfo::isEnum, newParagraph(), rtf_listItemInfo, and OutputGenerator::t.

void RTFGenerator::endItemList (  )  [virtual]

end bullet list

Implements BaseOutputDocInterface.

Definition at line 932 of file rtfgen.cpp.

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

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

Implements OutputGenerator.

Definition at line 980 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

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

Implements OutputGenerator.

Definition at line 985 of file rtfgen.cpp.

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

void RTFGenerator::docify ( const char *  text  )  [virtual]

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

Implements BaseOutputDocInterface.

Definition at line 1658 of file rtfgen.cpp.

References OutputGenerator::t.

Referenced by addIndexItem(), endTitleHead(), startParamList(), startSection(), startSimpleSect(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

void RTFGenerator::codify ( const char *  text  )  [virtual]

Writes an ASCII string 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 1703 of file rtfgen.cpp.

References Config_getInt, newParagraph(), spaces, and OutputGenerator::t.

Referenced by writeCodeLink().

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:
ref If this is non-zero, the object is to be found in an external documentation file.
file The file in which the object is located.
anchor The anchor uniquely identifying the object within the file.
name The text to display as a placeholder for the link.

Implements BaseOutputDocInterface.

Definition at line 1257 of file rtfgen.cpp.

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

Referenced by startSimpleSect().

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:
ref If this is non-zero, the object is to be found in an external documentation file.
file The file in which the object is located.
anchor The anchor uniquely identifying the object within the file.
name The text to display as a placeholder for the link.
tooltip The tooltip to display when the mouse is on the link.

Implements CodeOutputInterface.

Definition at line 1313 of file rtfgen.cpp.

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

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

Implements BaseOutputDocInterface.

Definition at line 1227 of file rtfgen.cpp.

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

void RTFGenerator::endTextLink (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1249 of file rtfgen.cpp.

References Config_getBool, and OutputGenerator::t.

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

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

Parameters:
url The URL to link to.

Implements BaseOutputDocInterface.

Definition at line 1009 of file rtfgen.cpp.

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

void RTFGenerator::endHtmlLink (  )  [virtual]

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1025 of file rtfgen.cpp.

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

void RTFGenerator::startTypewriter (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 87 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startHtmlLink().

void RTFGenerator::endTypewriter (  )  [inline, virtual]

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 88 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endHtmlLink().

void RTFGenerator::startGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 1388 of file rtfgen.cpp.

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

Referenced by startMemberHeader().

void RTFGenerator::endGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 1397 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

Referenced by endMemberHeader().

void RTFGenerator::writeListItem (  )  [virtual]

write bullet or enum item

Implements BaseOutputDocInterface.

Definition at line 962 of file rtfgen.cpp.

References DBG_RTF, newParagraph(), RTFListItemInfo::number, rtf_listItemInfo, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::startMemberSections (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 93 of file rtfgen.h.

void RTFGenerator::endMemberSections (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 94 of file rtfgen.h.

void RTFGenerator::startMemberHeader (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 95 of file rtfgen.h.

References startGroupHeader().

void RTFGenerator::endMemberHeader (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 96 of file rtfgen.h.

References endGroupHeader().

void RTFGenerator::startMemberSubtitle (  )  [virtual]

Implements OutputGenerator.

Definition at line 2069 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endMemberSubtitle (  )  [virtual]

Implements OutputGenerator.

Definition at line 2076 of file rtfgen.cpp.

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

void RTFGenerator::startMemberDocList (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 99 of file rtfgen.h.

void RTFGenerator::endMemberDocList (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 100 of file rtfgen.h.

void RTFGenerator::startMemberList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1854 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endMemberList (  )  [virtual]

Implements OutputGenerator.

Definition at line 1865 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::startAnonTypeScope ( int   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 103 of file rtfgen.h.

void RTFGenerator::endAnonTypeScope ( int   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 104 of file rtfgen.h.

void RTFGenerator::startMemberItem ( int   )  [virtual]

Implements OutputGenerator.

Definition at line 1788 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endMemberItem (  )  [virtual]

Implements OutputGenerator.

Definition at line 1794 of file rtfgen.cpp.

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

void RTFGenerator::startMemberTemplateParams (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 107 of file rtfgen.h.

void RTFGenerator::endMemberTemplateParams (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 108 of file rtfgen.h.

void RTFGenerator::insertMemberAlign ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 109 of file rtfgen.h.

void RTFGenerator::writeRuler (  )  [inline, virtual]

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 111 of file rtfgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1800 of file rtfgen.cpp.

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

Referenced by endSection(), and endTitleHead().

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 1828 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endCodeFragment (  )  [virtual]

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 1837 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::writeLineNumber ( const char *  ,
const char *  ,
const char *  ,
int  l 
) [inline, virtual]

Implements CodeOutputInterface.

Definition at line 116 of file rtfgen.h.

References OutputGenerator::t.

void RTFGenerator::startCodeLine (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 117 of file rtfgen.h.

void RTFGenerator::endCodeLine (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 118 of file rtfgen.h.

References lineBreak().

void RTFGenerator::startEmphasis (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 119 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startDescTableTitle(), startMemberDescription(), startMemberGroupDocs(), and startPageRef().

void RTFGenerator::endEmphasis (  )  [inline, virtual]

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 120 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endDescTableTitle(), endMemberDescription(), endMemberGroupDocs(), and endPageRef().

void RTFGenerator::startBold (  )  [inline, virtual]

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

Implements BaseOutputDocInterface.

Definition at line 121 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startDescList(), startDescTableTitle(), startMemberDoc(), startParamList(), startSimpleSect(), and writeObjectLink().

void RTFGenerator::endBold (  )  [inline, virtual]

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 122 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endDescTableTitle(), endMemberDoc(), startParamList(), startSimpleSect(), and writeObjectLink().

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 1500 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endDescription (  )  [virtual]

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

Implements BaseOutputDocInterface.

Definition at line 1507 of file rtfgen.cpp.

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

void RTFGenerator::startDescItem (  )  [virtual]

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

Implements BaseOutputDocInterface.

Definition at line 1514 of file rtfgen.cpp.

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

void RTFGenerator::endDescItem (  )  [virtual]

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

Implements BaseOutputDocInterface.

Definition at line 1521 of file rtfgen.cpp.

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

void RTFGenerator::lineBreak (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 890 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

Referenced by endCodeLine().

void RTFGenerator::startMemberDoc ( const char *  ,
const char *  ,
const char *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 1404 of file rtfgen.cpp.

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

void RTFGenerator::endMemberDoc ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 1423 of file rtfgen.cpp.

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

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

Implements OutputGenerator.

Definition at line 1434 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endDoxyAnchor ( const char *  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 1442 of file rtfgen.cpp.

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

void RTFGenerator::startCodeAnchor ( const char *   )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 132 of file rtfgen.h.

void RTFGenerator::endCodeAnchor (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 133 of file rtfgen.h.

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 1753 of file rtfgen.cpp.

References docify().

void RTFGenerator::writeLatexSpacing (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 135 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 1044 of file rtfgen.cpp.

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

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

Implements OutputGenerator.

Definition at line 1068 of file rtfgen.cpp.

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

void RTFGenerator::startSubsection (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1121 of file rtfgen.cpp.

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

void RTFGenerator::endSubsection (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1130 of file rtfgen.cpp.

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

void RTFGenerator::startSubsubsection (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1136 of file rtfgen.cpp.

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

void RTFGenerator::endSubsubsection (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1145 of file rtfgen.cpp.

References newParagraph(), and OutputGenerator::t.

void RTFGenerator::startCenter (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 143 of file rtfgen.h.

References OutputGenerator::t.

void RTFGenerator::endCenter (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 144 of file rtfgen.h.

References OutputGenerator::t.

void RTFGenerator::startSmall (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 145 of file rtfgen.h.

References OutputGenerator::t.

void RTFGenerator::endSmall (  )  [inline, virtual]

Implements BaseOutputDocInterface.

Definition at line 146 of file rtfgen.h.

References OutputGenerator::t.

void RTFGenerator::startMemberDescription (  )  [virtual]

Implements OutputGenerator.

Definition at line 1528 of file rtfgen.cpp.

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

void RTFGenerator::endMemberDescription (  )  [virtual]

Implements OutputGenerator.

Definition at line 1537 of file rtfgen.cpp.

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

void RTFGenerator::startDescList ( SectionTypes   ) 

Definition at line 1548 of file rtfgen.cpp.

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

void RTFGenerator::startSimpleSect ( SectionTypes  ,
const char *  ,
const char *  ,
const char *   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 2498 of file rtfgen.cpp.

References DBG_RTF, docify(), endBold(), newParagraph(), rtf_Style_Reset, startBold(), and writeObjectLink().

void RTFGenerator::endSimpleSect (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 2520 of file rtfgen.cpp.

References DBG_RTF, and newParagraph().

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

Implements BaseOutputDocInterface.

Definition at line 2529 of file rtfgen.cpp.

References DBG_RTF, docify(), endBold(), newParagraph(), rtf_Style_Reset, and startBold().

void RTFGenerator::endParamList (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 2544 of file rtfgen.cpp.

References DBG_RTF, and newParagraph().

void RTFGenerator::writeDescItem (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1567 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::startSection ( const char *  ,
const char *  ,
SectionInfo::SectionType   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1582 of file rtfgen.cpp.

References DBG_RTF, docify(), SectionInfo::Page, SectionInfo::Paragraph, QCString, rtf_Style, rtf_Style_Reset, SectionInfo::Section, SectionInfo::Subsection, SectionInfo::Subsubsection, and OutputGenerator::t.

void RTFGenerator::endSection ( const char *  ,
SectionInfo::SectionType   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1607 of file rtfgen.cpp.

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

void RTFGenerator::addIndexItem ( const char *  ,
const char *   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1470 of file rtfgen.cpp.

References docify(), and OutputGenerator::t.

Referenced by endTitleHead(), and startMemberDoc().

void RTFGenerator::startIndent (  )  [virtual]

Implements OutputGenerator.

Definition at line 1485 of file rtfgen.cpp.

References DBG_RTF, rtf_Style_Reset, and OutputGenerator::t.

void RTFGenerator::endIndent (  )  [virtual]

Implements OutputGenerator.

Definition at line 1493 of file rtfgen.cpp.

References OutputGenerator::t.

void RTFGenerator::writeSynopsis (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 161 of file rtfgen.h.

void RTFGenerator::startClassDiagram (  )  [virtual]

Implements OutputGenerator.

Definition at line 1761 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endClassDiagram ( const ClassDiagram &  ,
const char *  filename,
const char *  name 
) [virtual]

Implements OutputGenerator.

Definition at line 1766 of file rtfgen.cpp.

References OutputGenerator::dir, newParagraph(), rtf_Style_Reset, OutputGenerator::t, and ClassDiagram::writeImage().

void RTFGenerator::startPageRef (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1290 of file rtfgen.cpp.

References startEmphasis(), and OutputGenerator::t.

void RTFGenerator::endPageRef ( const char *  ,
const char *   
) [virtual]

Implements BaseOutputDocInterface.

Definition at line 1296 of file rtfgen.cpp.

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

void RTFGenerator::startQuickIndices (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 166 of file rtfgen.h.

void RTFGenerator::endQuickIndices (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 167 of file rtfgen.h.

void RTFGenerator::writeQuickLinks ( bool  ,
HighlightedItem   
) [inline, virtual]

Implements OutputGenerator.

Definition at line 168 of file rtfgen.h.

void RTFGenerator::startContents (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 169 of file rtfgen.h.

void RTFGenerator::endContents (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 170 of file rtfgen.h.

void RTFGenerator::writeNonBreakableSpace ( int   )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1848 of file rtfgen.cpp.

References OutputGenerator::t.

void RTFGenerator::startDescTable (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1915 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endDescTable (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1923 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::startDescTableTitle (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1931 of file rtfgen.cpp.

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

void RTFGenerator::endDescTableTitle (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1939 of file rtfgen.cpp.

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

void RTFGenerator::startDescTableData (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1947 of file rtfgen.cpp.

References DBG_RTF, and OutputGenerator::t.

void RTFGenerator::endDescTableData (  )  [virtual]

Implements BaseOutputDocInterface.

Definition at line 1953 of file rtfgen.cpp.

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

void RTFGenerator::startDotGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 2265 of file rtfgen.cpp.

void RTFGenerator::endDotGraph ( const DotClassGraph &   )  [virtual]

Implements OutputGenerator.

Definition at line 2270 of file rtfgen.cpp.

References Config_getEnum, and DBG_RTF.

void RTFGenerator::startInclDepGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 2288 of file rtfgen.cpp.

References DBG_RTF.

void RTFGenerator::endInclDepGraph ( const DotInclDepGraph &   )  [virtual]

Implements OutputGenerator.

Definition at line 2293 of file rtfgen.cpp.

References BITMAP, Config_getEnum, Config_getString, DBG_RTF, newParagraph(), QCString, rtf_Style_Reset, and DotInclDepGraph::writeGraph().

void RTFGenerator::startGroupCollaboration (  )  [virtual]

Implements OutputGenerator.

Definition at line 2310 of file rtfgen.cpp.

void RTFGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 2314 of file rtfgen.cpp.

void RTFGenerator::startCallGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 2318 of file rtfgen.cpp.

References DBG_RTF.

void RTFGenerator::endCallGraph ( const DotCallGraph &   )  [virtual]

Implements OutputGenerator.

Definition at line 2323 of file rtfgen.cpp.

References BITMAP, Config_getEnum, Config_getString, DBG_RTF, newParagraph(), QCString, rtf_Style_Reset, and DotCallGraph::writeGraph().

void RTFGenerator::startDirDepGraph (  )  [virtual]

Implements OutputGenerator.

Definition at line 2340 of file rtfgen.cpp.

References DBG_RTF.

void RTFGenerator::endDirDepGraph ( const DotDirDeps &  g  )  [virtual]

Implements OutputGenerator.

Definition at line 2345 of file rtfgen.cpp.

References BITMAP, Config_getEnum, Config_getString, DBG_RTF, newParagraph(), QCString, rtf_Style_Reset, and DotDirDeps::writeGraph().

void RTFGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 190 of file rtfgen.h.

void RTFGenerator::startMemberGroupHeader ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 2457 of file rtfgen.cpp.

References DBG_RTF, rtf_Style, and rtf_Style_Reset.

void RTFGenerator::endMemberGroupHeader (  )  [virtual]

Implements OutputGenerator.

Definition at line 2465 of file rtfgen.cpp.

References DBG_RTF, newParagraph(), and rtf_Style_Reset.

void RTFGenerator::startMemberGroupDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2472 of file rtfgen.cpp.

References DBG_RTF, and startEmphasis().

void RTFGenerator::endMemberGroupDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2478 of file rtfgen.cpp.

References DBG_RTF, endEmphasis(), and newParagraph().

void RTFGenerator::startMemberGroup (  )  [virtual]

Implements OutputGenerator.

Definition at line 2485 of file rtfgen.cpp.

References DBG_RTF, and rtf_Style_Reset.

void RTFGenerator::endMemberGroup ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 2491 of file rtfgen.cpp.

References DBG_RTF.

void RTFGenerator::startTextBlock ( bool  dense  )  [virtual]

Implements OutputGenerator.

Definition at line 2022 of file rtfgen.cpp.

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

void RTFGenerator::endTextBlock ( bool   )  [virtual]

Implements OutputGenerator.

Definition at line 2037 of file rtfgen.cpp.

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

void RTFGenerator::lastIndexPage (  )  [virtual]

Implements OutputGenerator.

Definition at line 873 of file rtfgen.cpp.

References DBG_RTF, rtf_Style, and OutputGenerator::t.

void RTFGenerator::startMemberDocPrefixItem (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 203 of file rtfgen.h.

void RTFGenerator::endMemberDocPrefixItem (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 204 of file rtfgen.h.

void RTFGenerator::startMemberDocName ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 205 of file rtfgen.h.

void RTFGenerator::endMemberDocName (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 206 of file rtfgen.h.

void RTFGenerator::startParameterType ( bool  ,
const char *   
) [virtual]

Implements OutputGenerator.

Definition at line 2553 of file rtfgen.cpp.

References DBG_RTF.

void RTFGenerator::endParameterType (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 208 of file rtfgen.h.

void RTFGenerator::startParameterName ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 209 of file rtfgen.h.

void RTFGenerator::endParameterName ( bool  ,
bool  ,
bool   
) [inline, virtual]

Implements OutputGenerator.

Definition at line 210 of file rtfgen.h.

void RTFGenerator::startParameterList ( bool   )  [inline, virtual]

Implements OutputGenerator.

Definition at line 211 of file rtfgen.h.

void RTFGenerator::endParameterList (  )  [inline, virtual]

Implements OutputGenerator.

Definition at line 212 of file rtfgen.h.

void RTFGenerator::startConstraintList ( const char *   )  [virtual]

Implements OutputGenerator.

Definition at line 2618 of file rtfgen.cpp.

void RTFGenerator::startConstraintParam (  )  [virtual]

Implements OutputGenerator.

Definition at line 2633 of file rtfgen.cpp.

void RTFGenerator::endConstraintParam (  )  [virtual]

Implements OutputGenerator.

Definition at line 2639 of file rtfgen.cpp.

void RTFGenerator::startConstraintType (  )  [virtual]

Implements OutputGenerator.

Definition at line 2646 of file rtfgen.cpp.

void RTFGenerator::endConstraintType (  )  [virtual]

Implements OutputGenerator.

Definition at line 2652 of file rtfgen.cpp.

void RTFGenerator::startConstraintDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2659 of file rtfgen.cpp.

void RTFGenerator::endConstraintDocs (  )  [virtual]

Implements OutputGenerator.

Definition at line 2664 of file rtfgen.cpp.

void RTFGenerator::endConstraintList (  )  [virtual]

Implements OutputGenerator.

Definition at line 2670 of file rtfgen.cpp.

void RTFGenerator::startFontClass ( const char *   )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 224 of file rtfgen.h.

void RTFGenerator::endFontClass (  )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 225 of file rtfgen.h.

void RTFGenerator::writeCodeAnchor ( const char *   )  [inline, virtual]

Implements CodeOutputInterface.

Definition at line 227 of file rtfgen.h.

void RTFGenerator::linkableSymbol ( int  ,
const char *  ,
Definition *  ,
Definition *   
) [inline, virtual]

Implements CodeOutputInterface.

Definition at line 228 of file rtfgen.h.

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 2410 of file rtfgen.cpp.

References convertToQCString(), err(), QCString, and testRTFOutput().

Referenced by generateOutput().

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


Generated on Mon Mar 31 10:59:03 2008 by  doxygen 1.5.1