My Project
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
RTFGenerator Class Reference

#include <rtfgen.h>

Inheritance diagram for RTFGenerator:
OutputGenerator BaseOutputDocInterface CodeOutputInterface

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 writeDoc (DocNode *, Definition *, 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 ()
 
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 *)
 
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 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 *)
 
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 startSimpleSect (SectionTypes, const char *, const char *, const char *)
 
void endSimpleSect ()
 
void startParamList (ParamListTypes, const char *)
 
void endParamList ()
 
void startDescForItem ()
 
void endDescForItem ()
 
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 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 (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 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 (Definition *, const char *, bool)
 
void addWord (const char *, bool)
 
- Public Member Functions inherited from OutputGenerator
 OutputGenerator ()
 
virtual ~OutputGenerator ()
 
void startPlainFile (const char *name)
 
void endPlainFile ()
 
bool isEnabled () const
 
void pushGeneratorState ()
 
void popGeneratorState ()
 
- Public Member Functions inherited from BaseOutputDocInterface
virtual ~BaseOutputDocInterface ()
 
virtual bool parseText (const QCString &s)
 
- 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)
 

Private Member Functions

 RTFGenerator (const RTFGenerator &)
 
RTFGenerator & operator= (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

int col
 
bool m_prettyCode
 
bool m_bstartedBody
 
int m_listLevel
 
bool m_omitParagraph
 
int m_numCols
 
QCString relPath
 

Additional Inherited Members

- Public Types inherited from OutputGenerator
enum  OutputType {
  Html, Latex, Man, RTF,
  XML, DEF, Perl
}
 
- Protected Attributes inherited from OutputGenerator
FTextStream t
 
QFile * file
 
QCString fileName
 
QCString dir
 
bool active
 
QStack< bool > * genStack
 

Detailed Description

Generator for RTF output.

Definition at line 26 of file rtfgen.h.

Constructor & Destructor Documentation

RTFGenerator::RTFGenerator ( )

Definition at line 60 of file rtfgen.cpp.

References col, Config_getBool, Config_getString, OutputGenerator::dir, m_bstartedBody, m_listLevel, m_numCols, m_omitParagraph, and m_prettyCode.

: OutputGenerator()
{
dir=Config_getString(RTF_OUTPUT);
col=0;
//insideTabbing=FALSE;
m_listLevel = 0;
m_bstartedBody = FALSE;
m_omitParagraph = FALSE;
m_numCols = 0;
m_prettyCode=Config_getBool(RTF_SOURCE_CODE);
}
RTFGenerator::~RTFGenerator ( )

Definition at line 72 of file rtfgen.cpp.

{
}
RTFGenerator::RTFGenerator ( const RTFGenerator &  )
private

Member Function Documentation

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

Implements BaseOutputDocInterface.

Definition at line 1550 of file rtfgen.cpp.

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

Referenced by endTitleHead(), and startMemberDoc().

{
if (s1)
{
t << "{\\xe \\v ";
docify(s1);
if (s2)
{
t << "\\:";
docify(s2);
}
t << "}" << endl;
}
}
void RTFGenerator::addWord ( const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 265 of file rtfgen.h.

{}
void RTFGenerator::beginRTFChapter ( )
private

Definition at line 292 of file rtfgen.cpp.

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

Referenced by endIndexSection(), startIndexSection(), and startTitle().

{
t <<"\n";
DBG_RTF(t << "{\\comment BeginRTFChapter}\n")
t << rtf_Style_Reset;
// if we are compact, no extra page breaks...
if (Config_getBool(COMPACT_RTF))
{
// t <<"\\sect\\sectd\\sbknone\n";
t <<"\\sect\\sbknone\n";
rtfwriteRuler_thick();
}
else
t <<"\\sect\\sbkpage\n";
//t <<"\\sect\\sectd\\sbkpage\n";
t << rtf_Style["Heading1"]->reference << "\n";
}
void RTFGenerator::beginRTFDocument ( )
private

Definition at line 212 of file rtfgen.cpp.

References DBG_RTF, StyleData::definition, endl(), StyleData::index, msg(), StyleData::reference, rtf_Style, OutputGenerator::t, theTranslator, Translator::trRTFansicp(), and Translator::trRTFCharSet().

Referenced by startFile().

{
/* all the included RTF files should begin with the
* same header
*/
t <<"{\\rtf1\\ansi\\ansicpg" << theTranslator->trRTFansicp();
t <<"\\uc1 \\deff0\\deflang1033\\deflangfe1033\n";
DBG_RTF(t <<"{\\comment Beginning font list}\n")
t <<"{\\fonttbl ";
t <<"{\\f0\\froman\\fcharset" << theTranslator->trRTFCharSet();
t <<"\\fprq2{\\*\\panose 02020603050405020304}Times New Roman;}\n";
t <<"{\\f1\\fswiss\\fcharset" << theTranslator->trRTFCharSet();
t <<"\\fprq2{\\*\\panose 020b0604020202020204}Arial;}\n";
t <<"{\\f2\\fmodern\\fcharset" << theTranslator->trRTFCharSet();
t <<"\\fprq1{\\*\\panose 02070309020205020404}Courier New;}\n";
t <<"{\\f3\\froman\\fcharset2\\fprq2{\\*\\panose 05050102010706020507}Symbol;}\n";
t <<"}\n";
DBG_RTF(t <<"{\\comment begin colors}\n")
t <<"{\\colortbl;";
t <<"\\red0\\green0\\blue0;";
t <<"\\red0\\green0\\blue255;";
t <<"\\red0\\green255\\blue255;";
t <<"\\red0\\green255\\blue0;";
t <<"\\red255\\green0\\blue255;";
t <<"\\red255\\green0\\blue0;";
t <<"\\red255\\green255\\blue0;";
t <<"\\red255\\green255\\blue255;";
t <<"\\red0\\green0\\blue128;";
t <<"\\red0\\green128\\blue128;";
t <<"\\red0\\green128\\blue0;";
t <<"\\red128\\green0\\blue128;";
t <<"\\red128\\green0\\blue0;";
t <<"\\red128\\green128\\blue0;";
t <<"\\red128\\green128\\blue128;";
t <<"\\red192\\green192\\blue192;}" << endl;
DBG_RTF(t <<"{\\comment Beginning style list}\n")
t <<"{\\stylesheet\n";
t <<"{\\widctlpar\\adjustright \\fs20\\cgrid \\snext0 Normal;}\n";
// sort styles ascending by \s-number via an intermediate QArray
QArray<const StyleData*> array(128);
array.fill(0);
QDictIterator<StyleData> iter(rtf_Style);
const StyleData* style;
for(; (style = iter.current()); ++iter)
{
unsigned index = style->index;
unsigned size = array.size();
if (index >= size)
{
// +1 to add at least one element, then align up to multiple of 8
array.resize((index + 1 + 7) & ~7);
array.fill(0, size);
ASSERT(index < array.size());
}
if (array.at(index) != 0)
{
QCString key(iter.currentKey());
msg("Style '%s' redefines \\s%d.\n", key.data(), index);
}
array.at(index) = style;
}
// write array elements
unsigned size = array.size();
for(unsigned i = 0; i < size; i++)
{
const StyleData* style = array.at(i);
if (style != 0)
t <<"{" << style->reference << style->definition << ";}\n";
}
t <<"}" << endl;
// this comment is needed for postprocessing!
t <<"{\\comment begin body}" << endl;
}
void RTFGenerator::beginRTFSection ( )
private

Definition at line 312 of file rtfgen.cpp.

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

Referenced by endIndexSection(), and startTitle().

{
t <<"\n";
DBG_RTF(t << "{\\comment BeginRTFSection}\n")
t << rtf_Style_Reset;
// if we are compact, no extra page breaks...
if (Config_getBool(COMPACT_RTF))
{
// t <<"\\sect\\sectd\\sbknone\n";
t <<"\\sect\\sbknone\n";
rtfwriteRuler_emboss();
}
else
t <<"\\sect\\sbkpage\n";
//t <<"\\sect\\sectd\\sbkpage\n";
t << rtf_Style["Heading2"]->reference << "\n";
}
void RTFGenerator::clearBuffer ( )
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 1789 of file rtfgen.cpp.

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

Referenced by writeCodeLink().

{
// note that RTF does not have a "verbatim", so "\n" means
// nothing... add a "newParagraph()";
//static char spaces[]=" ";
if (str)
{
const unsigned char *p=(const unsigned char *)str;
unsigned char c;
int spacesToNextTabStop;
while (*p)
{
//static bool MultiByte = FALSE;
c=*p++;
switch(c)
{
case '\t': spacesToNextTabStop = Config_getInt(TAB_SIZE) - (col%Config_getInt(TAB_SIZE));
t << Doxygen::spaces.left(spacesToNextTabStop);
col+=spacesToNextTabStop;
break;
case '\n': newParagraph();
t << '\n'; col=0;
break;
case '{': t << "\\{"; col++; break;
case '}': t << "\\}"; col++; break;
case '\\': t << "\\\\"; col++; break;
default: p=(const unsigned char *)writeUtf8Char(t,(const char *)p-1); col++; break;
}
}
}
}
void RTFGenerator::decrementIndentLevel ( )
private

Definition at line 2064 of file rtfgen.cpp.

References err(), and m_listLevel.

Referenced by endConstraintList(), endIndent(), endIndexList(), endItemList(), endMemberDescription(), endMemberGroup(), endParamList(), and endSimpleSect().

{
m_listLevel--;
if (m_listLevel<0)
{
err("Negative indent level while generating RTF output!\n");
m_listLevel=0;
}
}
void RTFGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 37 of file rtfgen.h.

References OutputGenerator::active.

Referenced by disableIf(), and disableIfNot().

{ active=FALSE; }
void RTFGenerator::disableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 39 of file rtfgen.h.

References disable(), and OutputGenerator::RTF.

{ if (o==RTF) disable(); }
void RTFGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 40 of file rtfgen.h.

References disable(), and OutputGenerator::RTF.

{ if (o!=RTF) disable(); }
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 1744 of file rtfgen.cpp.

References m_omitParagraph, and OutputGenerator::t.

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

{
if (str)
{
const unsigned char *p=(const unsigned char *)str;
unsigned char c;
//unsigned char pc='\0';
while (*p)
{
//static bool MultiByte = FALSE;
c=*p++;
#if 0
if ( MultiByte )
{
t << getMultiByte( c );
MultiByte = FALSE;
continue;
}
if ( c >= 0x80 )
{
MultiByte = TRUE;
t << getMultiByte( c );
continue;
}
#endif
switch (c)
{
case '{': t << "\\{"; break;
case '}': t << "\\}"; break;
case '\\': t << "\\\\"; break;
default:
{
// see if we can insert an hyphenation hint
//if (isupper(c) && islower(pc) && !insideTabbing) t << "\\-";
t << (char)c;
}
}
//pc = c;
m_omitParagraph = FALSE;
}
}
}
void RTFGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 35 of file rtfgen.h.

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

Referenced by enableIf().

{ if (genStack->top()) active=*genStack->top(); else active=TRUE; }
void RTFGenerator::enableIf ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 38 of file rtfgen.h.

References enable(), and OutputGenerator::RTF.

{ if (o==RTF) enable(); }
void RTFGenerator::endAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 117 of file rtfgen.h.

{}
void RTFGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 135 of file rtfgen.h.

References OutputGenerator::t.

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

{ t << "}"; }
void RTFGenerator::endCallGraph ( const DotCallGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 2517 of file rtfgen.cpp.

References Config_getString, DBG_RTF, endl(), EOF_Rtf, OutputGenerator::fileName, getDotImageExtension(), GOF_BITMAP, newParagraph(), relPath, rtf_Style_Reset, OutputGenerator::t, and DotCallGraph::writeGraph().

{
newParagraph();
QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_Rtf,Config_getString(RTF_OUTPUT),
fileName,relPath,FALSE);
// display the file
t << "{" << endl;
t << rtf_Style_Reset << endl;
t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
QCString imgExt = getDotImageExtension();
t << fn << "." << imgExt;
t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
t << "}" << endl;
DBG_RTF(t << "{\\comment (endCallGraph)}" << endl)
}
void RTFGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 155 of file rtfgen.h.

References OutputGenerator::t.

{ t << "}"; }
void RTFGenerator::endClassDiagram ( const ClassDiagram &  d,
const char *  filename,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1837 of file rtfgen.cpp.

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

{
newParagraph();
// create a png file
d.writeImage(t,dir,relPath,fileName,FALSE);
// display the file
t << "{" << endl;
t << rtf_Style_Reset << endl;
t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
t << fileName << ".png\"";
t << " \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
t << "}" << endl;
}
void RTFGenerator::endCodeFragment ( )
virtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 1908 of file rtfgen.cpp.

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

{
//newParagraph();
//styleStack.pop();
//printf("RTFGenerator::endCodeFrament() top=%s\n",styleStack.top());
//t << rtf_Style_Reset << styleStack.top() << endl;
DBG_RTF(t << "{\\comment (endCodeFragment) }" << endl)
t << "}" << endl;
m_omitParagraph = TRUE;
}
void RTFGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 131 of file rtfgen.h.

References lineBreak().

{ lineBreak(); }
void RTFGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2884 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endConstraintDocs)}" << endl)
newParagraph();
}
void RTFGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2890 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endConstraintList)}" << endl)
newParagraph();
decrementIndentLevel();
m_omitParagraph = TRUE;
t << "}";
}
void RTFGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2859 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endConstraintParam)}" << endl)
endEmphasis();
t << " : ";
}
void RTFGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2872 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endConstraintType)}" << endl)
endEmphasis();
t << " ";
}
void RTFGenerator::endContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 191 of file rtfgen.h.

{}
void RTFGenerator::endDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1652 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescForItem) }" << endl)
}
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 1601 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescItem)}" << endl)
t << "}" << endl;
newParagraph();
}
void RTFGenerator::endDescription ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1587 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescription)}" << endl)
newParagraph();
t << "}";
}
void RTFGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2014 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescTable)}" << endl)
t << "}" << endl;
}
void RTFGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2046 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescTableData) }" << endl)
t << "\\cell }{\\row }" << endl;
}
void RTFGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2024 of file rtfgen.cpp.

{
}
void RTFGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2034 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endDescTableTitle) }" << endl)
t << "\\cell }";
}
void RTFGenerator::endDirDepGraph ( const DotDirDeps &  g)
virtual

Implements OutputGenerator.

Definition at line 2540 of file rtfgen.cpp.

References Config_getString, DBG_RTF, endl(), EOF_Rtf, OutputGenerator::fileName, getDotImageExtension(), GOF_BITMAP, newParagraph(), relPath, rtf_Style_Reset, OutputGenerator::t, and DotDirDeps::writeGraph().

{
newParagraph();
QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_Rtf,Config_getString(RTF_OUTPUT),
fileName,relPath,FALSE);
// display the file
t << "{" << endl;
t << rtf_Style_Reset << endl;
t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
QCString imgExt = getDotImageExtension();
t << fn << "." << imgExt;
t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
t << "}" << endl;
DBG_RTF(t << "{\\comment (endDirDepGraph)}" << endl)
}
void RTFGenerator::endDotGraph ( const DotClassGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 2462 of file rtfgen.cpp.

References Config_getString, DBG_RTF, endl(), EOF_Rtf, OutputGenerator::fileName, getDotImageExtension(), GOF_BITMAP, newParagraph(), relPath, rtf_Style_Reset, OutputGenerator::t, and DotClassGraph::writeGraph().

{
newParagraph();
QCString fn =
g.writeGraph(t,GOF_BITMAP,EOF_Rtf,Config_getString(RTF_OUTPUT),fileName,relPath,TRUE,FALSE);
// display the file
t << "{" << endl;
t << rtf_Style_Reset << endl;
t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
QCString imgExt = getDotImageExtension();
t << fn << "." << imgExt;
t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
t << "}" << endl;
newParagraph();
DBG_RTF(t << "{\\comment (endDotGraph)}" << endl)
}
void RTFGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1522 of file rtfgen.cpp.

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

{
QCString ref;
if (fName)
{
ref+=fName;
}
if (anchor)
{
ref+='_';
ref+=anchor;
}
DBG_RTF(t << "{\\comment endDoxyAnchor}" << endl)
t << "{\\bkmkstart ";
t << rtfFormatBmkStr(ref);
t << "}" << endl;
t << "{\\bkmkend ";
t << rtfFormatBmkStr(ref);
t << "}" << endl;
}
void RTFGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 133 of file rtfgen.h.

References OutputGenerator::t.

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

{ t << "}"; }
void RTFGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 343 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endFile}\n")
t << "}";
endPlainFile();
}
void RTFGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 261 of file rtfgen.h.

{}
void RTFGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g)
virtual

Implements OutputGenerator.

Definition at line 2508 of file rtfgen.cpp.

{
}
void RTFGenerator::endGroupHeader ( int  )
virtual

Implements OutputGenerator.

Definition at line 1474 of file rtfgen.cpp.

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

Referenced by endMemberHeader().

{
DBG_RTF(t <<"{\\comment endGroupHeader}" << endl)
t << "\\par" << endl;
t << rtf_Style_Reset << endl;
}
void RTFGenerator::endHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 105 of file rtfgen.h.

{}
void RTFGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1091 of file rtfgen.cpp.

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

{
if (Config_getBool(RTF_HYPERLINKS))
{
t << "}}}" << endl;
}
else
{
endTypewriter();
}
}
void RTFGenerator::endInclDepGraph ( const DotInclDepGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 2486 of file rtfgen.cpp.

References Config_getString, DBG_RTF, endl(), EOF_Rtf, OutputGenerator::fileName, getDotImageExtension(), GOF_BITMAP, newParagraph(), relPath, rtf_Style_Reset, OutputGenerator::t, and DotInclDepGraph::writeGraph().

{
newParagraph();
QCString fn = g.writeGraph(t,GOF_BITMAP,EOF_Rtf,Config_getString(RTF_OUTPUT),
fileName,relPath,FALSE);
// display the file
t << "{" << endl;
t << rtf_Style_Reset << endl;
t << "\\par\\pard \\qc {\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"";
QCString imgExt = getDotImageExtension();
t << fn << "." << imgExt;
t << "\" \\\\d \\\\*MERGEFORMAT}{\\fldrslt IMAGE}}\\par" << endl;
t << "}" << endl;
DBG_RTF(t << "{\\comment (endInclDepGraph)}" << endl)
}
void RTFGenerator::endIndent ( )
virtual

Implements OutputGenerator.

Definition at line 1573 of file rtfgen.cpp.

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

{
t << "}" << endl;
decrementIndentLevel();
}
void RTFGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1052 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endIndexItem)}" << endl)
if (!ref && fn)
{
t << "\\tab ";
writeRTFReference(fn);
t << endl;
}
else
{
t << endl;
}
m_omitParagraph = TRUE;
}
void RTFGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1156 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endIndexKey)}" << endl)
}
void RTFGenerator::endIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 965 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endIndexList)}" << endl)
if (!m_omitParagraph)
{
t << "\\par";
m_omitParagraph = TRUE;
}
t << "}";
decrementIndentLevel();
}
void RTFGenerator::endIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 2904 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endIndexListItem)}" << endl)
t << "\\par" << endl;
}
void RTFGenerator::endIndexSection ( IndexSections  is)
virtual

Implements OutputGenerator.

Definition at line 539 of file rtfgen.cpp.

References beginRTFChapter(), beginRTFSection(), Doxygen::classSDict, Config_getBool, Config_getString, dateToRTFDateString(), dateToString(), DBG_RTF, Doxygen::directories, endl(), Doxygen::exampleSDict, FileDef::generateSourceFile(), NamespaceDef::getOutputFileBase(), PageDef::getOutputFileBase(), GroupDef::getOutputFileBase(), DirDef::getOutputFileBase(), FileDef::getOutputFileBase(), ClassDef::getOutputFileBase(), FileDef::getSourceFileBase(), Doxygen::groupSDict, Doxygen::inputNameList, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, ClassDef::isEmbeddedInOuterScope(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), FileDef::isLinkableInProject(), ClassDef::isLinkableInProject(), isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< PageDef >::Iterator, SDict< GroupDef >::Iterator, SDict< NamespaceDef >::Iterator, SDict< ClassDef >::Iterator, m_prettyCode, Doxygen::mainPage, 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(), VhdlDocGen::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(), Translator::trVersion(), validatingParseText(), and writeDoc().

{
bool fortranOpt = Config_getBool(OPTIMIZE_FOR_FORTRAN);
bool vhdlOpt = Config_getBool(OPTIMIZE_OUTPUT_VHDL);
static bool sourceBrowser = Config_getBool(SOURCE_BROWSER);
static QCString projectName = Config_getString(PROJECT_NAME);
switch (is)
{
case isTitlePageStart:
if (rtf_title)
// User has overridden document title in extensions file
t << "}" << rtf_title;
else
t << "}" << projectName;
break;
case isTitlePageAuthor:
{
t << "Doxgyen. }\n";
t << "{\\creatim " << dateToRTFDateString() << "}\n}";
DBG_RTF(t << "{\\comment end of infoblock}\n");
// setup for this section
t << rtf_Style_Reset <<"\n";
t <<"\\sectd\\pgnlcrm\n";
t <<"{\\footer "<<rtf_Style["Footer"]->reference << "{\\chpgn}}\n";
// the title entry
DBG_RTF(t << "{\\comment begin title page}\n")
t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to title style
t << "\\vertalc\\qc\\par\\par\\par\\par\\par\\par\\par\n";
if (rtf_logoFilename)
{
t << "{\\field\\flddirty {\\*\\fldinst INCLUDEPICTURE \"" << rtf_logoFilename;
t << "\" \\\\d \\\\*MERGEFORMAT} {\\fldrslt IMAGE }}\\par\\par\n";
}
if (rtf_company)
{
t << rtf_company << "\\par\\par\n";
}
t << rtf_Style_Reset << rtf_Style["Title"]->reference << endl; // set to title style
if (rtf_title)
// User has overridden document title in extensions file
t << "{\\field\\fldedit {\\*\\fldinst " << rtf_title << " \\\\*MERGEFORMAT}{\\fldrslt " << rtf_title << "}}\\par" << endl;
else
{
DocText *root = validatingParseText(projectName);
t << "{\\field\\fldedit {\\*\\fldinst TITLE \\\\*MERGEFORMAT}{\\fldrslt ";
writeDoc(root,0,0);
t << "}}\\par" << endl;
}
t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to title style
t << "\\par\n";
if (rtf_documentType)
{
t << rtf_documentType << "\\par\n";
}
if (rtf_documentId)
{
t << rtf_documentId << "\\par\n";
}
t << "\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\\par\n";
t << rtf_Style_Reset << rtf_Style["SubTitle"]->reference << endl; // set to subtitle style
if (rtf_author)
t << "{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt "<< rtf_author << " }}\\par" << endl;
else
t << "{\\field\\fldedit {\\*\\fldinst AUTHOR \\\\*MERGEFORMAT}{\\fldrslt AUTHOR}}\\par" << endl;
t << theTranslator->trVersion() << " " << Config_getString(PROJECT_NUMBER) << "\\par";
t << "{\\field\\fldedit {\\*\\fldinst CREATEDATE \\\\*MERGEFORMAT}"
"{\\fldrslt "<< dateToString(FALSE) << " }}\\par"<<endl;
t << "\\page\\page";
DBG_RTF(t << "{\\comment End title page}" << endl)
// table of contents section
DBG_RTF(t << "{\\comment Table of contents}\n")
t << "\\vertalt\n";
t << rtf_Style_Reset << endl;
t << rtf_Style["Heading1"]->reference;
t << theTranslator->trRTFTableOfContents() << "\\par"<< endl;
t << rtf_Style_Reset << "\\par" << endl;
t << "{\\field\\fldedit {\\*\\fldinst TOC \\\\f \\\\*MERGEFORMAT}{\\fldrslt Table of contents}}\\par\n";
t << rtf_Style_Reset << endl;
}
break;
case isMainPage:
t << "\\par " << rtf_Style_Reset << endl;
if (!Doxygen::mainPage || Doxygen::mainPage->title().isEmpty())
{
t << "{\\tc \\v " << theTranslator->trMainPage() << "}"<< endl;
}
else
{
t << "{\\tc \\v " << substitute(Doxygen::mainPage->title(),"%","") << "}"<< endl;
}
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
//if (Config_getBool(GENERATE_TREEVIEW)) t << "main"; else t << "index";
t << "index";
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
//case isPackageIndex:
// t << "\\par " << rtf_Style_Reset << endl;
// t << "{\\tc \\v " << theTranslator->trPackageList() << "}"<< endl;
// t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"packages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
// break;
case isModuleIndex:
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trModuleIndex() << "}"<< endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"modules.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isDirIndex:
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trDirIndex() << "}"<< endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"dirs.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isNamespaceIndex:
t << "\\par " << rtf_Style_Reset << endl;
if (fortranOpt)
{
t << "{\\tc \\v " << theTranslator->trModulesIndex() << "}" << endl;
}
else
{
t << "{\\tc \\v " << theTranslator->trNamespaceIndex() << "}" << endl;
}
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"namespaces.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isClassHierarchyIndex:
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trHierarchicalIndex() << "}"<< endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"hierarchy.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isCompoundIndex:
t << "\\par " << rtf_Style_Reset << endl;
if (fortranOpt)
{
t << "{\\tc \\v " << theTranslator->trCompoundIndexFortran() << "}"<< endl;
}
else if (vhdlOpt)
{
t << "{\\tc \\v " << VhdlDocGen::trDesignUnitIndex() << "}"<< endl;
}
else
{
t << "{\\tc \\v " << theTranslator->trCompoundIndex() << "}"<< endl;
}
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"annotated.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isFileIndex:
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trFileIndex() << "}"<< endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"files.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isPageIndex:
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trPageIndex() << "}"<< endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"pages.rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
break;
case isModuleDocumentation:
{
GroupSDict::Iterator gli(*Doxygen::groupSDict);
GroupDef *gd;
t << "{\\tc \\v " << theTranslator->trModuleDocumentation() << "}"<< endl;
for (gli.toFirst();(gd=gli.current());++gli)
{
if (!gd->isReference())
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << gd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
}
}
break;
case isDirDocumentation:
{
SDict<DirDef>::Iterator dli(*Doxygen::directories);
DirDef *dd;
t << "{\\tc \\v " << theTranslator->trDirDocumentation() << "}"<< endl;
for (dli.toFirst();(dd=dli.current());++dli)
{
if (dd->isLinkableInProject())
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << dd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
}
}
break;
case isNamespaceDocumentation:
{
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
NamespaceDef *nd;
bool found=FALSE;
for (nli.toFirst();(nd=nli.current()) && !found;++nli)
{
if (nd->isLinkableInProject())
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << nd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
found=TRUE;
}
}
while ((nd=nli.current()))
{
if (nd->isLinkableInProject())
{
t << "\\par " << rtf_Style_Reset << endl;
beginRTFSection();
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << nd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
++nli;
}
}
break;
case isClassDocumentation:
{
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd=0;
bool found=FALSE;
if (fortranOpt)
{
t << "{\\tc \\v " << theTranslator->trTypeDocumentation() << "}"<< endl;
}
else
{
t << "{\\tc \\v " << theTranslator->trClassDocumentation() << "}"<< endl;
}
for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << cd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
found=TRUE;
}
}
for (;(cd=cli.current());++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
t << "\\par " << rtf_Style_Reset << endl;
beginRTFSection();
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << cd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
}
}
break;
case isFileDocumentation:
{
bool isFirst=TRUE;
t << "{\\tc \\v " << theTranslator->trFileDocumentation() << "}"<< endl;
FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (fnli.toFirst();(fn=fnli.current());++fnli)
{
FileNameIterator fni(*fn);
FileDef *fd;
for (;(fd=fni.current());++fni)
{
if (fd->isLinkableInProject())
{
if (isFirst)
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << fd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"" << fd->getSourceFileBase() << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
isFirst=FALSE;
}
else
{
t << "\\par " << rtf_Style_Reset << endl;
beginRTFSection();
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << fd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
if (sourceBrowser && m_prettyCode && fd->generateSourceFile())
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"" << fd->getSourceFileBase() << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
}
}
}
}
}
break;
case isExampleDocumentation:
{
//t << "}\n";
t << "{\\tc \\v " << theTranslator->trExampleDocumentation() << "}"<< endl;
PageSDict::Iterator pdi(*Doxygen::exampleSDict);
PageDef *pd=pdi.toFirst();
if (pd)
{
t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << pd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
for (++pdi;(pd=pdi.current());++pdi)
{
t << "\\par " << rtf_Style_Reset << endl;
beginRTFSection();
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << pd->getOutputFileBase();
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
}
break;
case isPageDocumentation:
{
//#error "fix me in the same way as the latex index..."
//t << "{\\tc \\v " << theTranslator->trPageDocumentation() << "}"<< endl;
//t << "}"<< endl;
//PageSDict::Iterator pdi(*Doxygen::pageSDict);
//PageDef *pd=pdi.toFirst();
//bool first=TRUE;
//for (pdi.toFirst();(pd=pdi.current());++pdi)
//{
// if (!pd->getGroupDef() && !pd->isReference())
// {
// if (first) t << "\\par " << rtf_Style_Reset << endl;
// t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
// t << pd->getOutputFileBase();
// t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
// first=FALSE;
// }
//}
}
break;
case isPageDocumentation2:
{
t << "}";
t << "\\par " << rtf_Style_Reset << endl;
}
break;
case isEndIndex:
beginRTFChapter();
t << rtf_Style["Heading1"]->reference;
t << theTranslator->trRTFGeneralIndex() << "\\par "<< endl;
t << rtf_Style_Reset << endl;
t << "{\\tc \\v " << theTranslator->trRTFGeneralIndex() << "}" << endl;
t << "{\\field\\fldedit {\\*\\fldinst INDEX \\\\c2 \\\\*MERGEFORMAT}{\\fldrslt INDEX}}\n";
break;
}
}
void RTFGenerator::endIndexValue ( const char *  name,
bool  hasBrief 
)
virtual

Implements OutputGenerator.

Definition at line 1168 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endIndexValue)}" << endl)
if (hasBrief) t << ")";
t << "} ";
if (name)
{
t << "\\tab ";
writeRTFReference(name);
t << endl;
}
else
{
t << endl;
}
m_omitParagraph=FALSE;
newParagraph();
}
void RTFGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2918 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endInlineHeader)}" << endl)
endBold();
t << "\\par";
t << "}" << endl;
}
void RTFGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 3003 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endInlineMemberDoc)}" << endl)
t << "\\cell }{\\row }" << endl;
}
void RTFGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2991 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endInlineMemberName)}" << endl)
t << "\\cell }";
}
void RTFGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2979 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endInlineMemberType)}" << endl)
t << "\\cell }";
}
void RTFGenerator::endItemList ( )
virtual

end bullet list

Implements BaseOutputDocInterface.

Definition at line 988 of file rtfgen.cpp.

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

{
newParagraph();
DBG_RTF(t << "{\\comment (endItemList level=" << m_listLevel << ")}" << endl)
t << "}";
decrementIndentLevel();
m_omitParagraph = TRUE;
}
void RTFGenerator::endItemListItem ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1036 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endItemListItem)}" << endl)
}
void RTFGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 3019 of file rtfgen.cpp.

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

Implements OutputGenerator.

Definition at line 162 of file rtfgen.h.

{}
void RTFGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1617 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endMemberDescription)}" << endl)
endEmphasis();
newParagraph();
decrementIndentLevel();
//t << "\\par";
t << "}" << endl;
//m_omitParagraph = TRUE;
}
void RTFGenerator::endMemberDoc ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1503 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endMemberDoc}" << endl)
//const char *style = styleStack.pop();
//printf("RTFGenerator::endMemberDoc() `%s'\n",style);
//ASSERT(style==rtf_Style["Heading4"]->reference);
endBold();
t << "}" << endl;
newParagraph();
}
void RTFGenerator::endMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 111 of file rtfgen.h.

{}
void RTFGenerator::endMemberDocName ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 229 of file rtfgen.h.

{}
void RTFGenerator::endMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 227 of file rtfgen.h.

{}
void RTFGenerator::endMemberDocSimple ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2967 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endMemberDocSimple)}" << endl)
t << "}" << endl;
}
void RTFGenerator::endMemberGroup ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2687 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endMemberGroup}" << endl)
if (hasHeader) decrementIndentLevel();
t << "}";
}
void RTFGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2674 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endMemberGroupDocs}" << endl)
endEmphasis();
newParagraph();
}
void RTFGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2661 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endMemberGroupHeader}" << endl)
newParagraph();
t << rtf_Style_Reset << rtf_CList_DepthStyle();
}
void RTFGenerator::endMemberHeader ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 107 of file rtfgen.h.

References endGroupHeader().

{ endGroupHeader(FALSE); }
void RTFGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1865 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment endMemberItem }" << endl)
newParagraph();
}
void RTFGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1936 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endMemberList) }" << endl)
t << "}" << endl;
#ifdef DELETEDCODE
if (!insideTabbing)
t << "\\end{CompactItemize}" << endl;
#endif
}
void RTFGenerator::endMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 103 of file rtfgen.h.

{}
void RTFGenerator::endMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 2168 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endMemberSubtitle}" << endl)
newParagraph();
t << "}" << endl;
}
void RTFGenerator::endMemberTemplateParams ( const char *  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 121 of file rtfgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1362 of file rtfgen.cpp.

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

{
QCString ref;
if (clname)
{
ref+=clname;
}
if (anchor)
{
ref+='_';
ref+=anchor;
}
writeRTFReference(ref);
endEmphasis();
t << ")";
}
void RTFGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 2154 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment endParagraph}" << endl)
t << "}\\par" << endl;
m_omitParagraph = TRUE;
}
void RTFGenerator::endParameterList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 235 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 233 of file rtfgen.h.

{}
void RTFGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 2759 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endParameterType)}" << endl)
t << " ";
}
void RTFGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2741 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endParamList)}" << endl)
newParagraph();
decrementIndentLevel();
m_omitParagraph = TRUE;
t << "}";
}
void RTFGenerator::endProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 357 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment endProjectNumber }" << endl)
}
void RTFGenerator::endQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 184 of file rtfgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1692 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endSection)}" << endl)
// make bookmark
m_omitParagraph=FALSE;
newParagraph();
writeAnchor(0,lab);
t << "}";
}
void RTFGenerator::endSimpleSect ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2716 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (endSimpleSect)}" << endl)
m_omitParagraph = FALSE;
newParagraph();
decrementIndentLevel();
m_omitParagraph = TRUE;
t << "}";
}
void RTFGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 157 of file rtfgen.h.

References OutputGenerator::t.

{ t << "}"; }
void RTFGenerator::endSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1196 of file rtfgen.cpp.

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

{
newParagraph();
t << rtf_Style_Reset << endl;
}
void RTFGenerator::endSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1211 of file rtfgen.cpp.

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

{
newParagraph();
t << "}" << endl;
}
void RTFGenerator::endTextBlock ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2129 of file rtfgen.cpp.

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

{
newParagraph();
DBG_RTF(t << "{\\comment endTextBlock}" << endl)
t << "}" << endl;
//m_omitParagraph = TRUE;
}
void RTFGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1315 of file rtfgen.cpp.

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

{
if (Config_getBool(RTF_HYPERLINKS))
{
t << "}}}" << endl;
}
}
void RTFGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 62 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 1419 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment endTitleHead}" << endl)
t << "\\par " << rtf_Style_Reset << endl;
if (name)
{
// make table of contents entry
t << "{\\tc\\tcl2 \\v ";
docify(name);
t << "}" << endl;
// make an index entry
addIndexItem(name,0);
//if (name)
//{
// writeAnchor(0,name);
//}
//
//if (Config_getBool(RTF_HYPERLINKS) && fileName)
//{
writeAnchor(fileName,0);
//}
}
}
void RTFGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 95 of file rtfgen.h.

References OutputGenerator::t.

Referenced by endHtmlLink().

{ t << "}"; }
void RTFGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 2765 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (exceptionEntry)}" << endl)
if (prefix)
t << " " << prefix;
else if (closeBracket)
t << ")";
t << " ";
}
OutputGenerator* RTFGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 42 of file rtfgen.h.

References OutputGenerator::RTF.

{ return (o==RTF) ? this : 0; }
void RTFGenerator::incrementIndentLevel ( )
private

Definition at line 2054 of file rtfgen.cpp.

References err(), m_listLevel, and rtf_maxIndentLevels.

Referenced by startConstraintList(), startIndent(), startIndexList(), startItemList(), startMemberDescription(), startMemberGroupHeader(), startParamList(), and startSimpleSect().

{
m_listLevel++;
if (m_listLevel>rtf_maxIndentLevels-1)
{
err("Maximum indent level (%d) exceeded while generating RTF output!\n",rtf_maxIndentLevels);
m_listLevel=rtf_maxIndentLevels-1;
}
}
void RTFGenerator::init ( )
static

Definition at line 166 of file rtfgen.cpp.

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

Referenced by generateOutput().

{
QCString dir=Config_getString(RTF_OUTPUT);
QDir d(dir);
if (!d.exists() && !d.mkdir(dir))
{
err("Could not create output directory %s\n",dir.data());
exit(1);
}
rtf_Style.setAutoDelete(TRUE);
// first duplicate strings of rtf_Style_Default
const struct Rtf_Style_Default* def = rtf_Style_Default;
while(def->reference != 0)
{
if (def->definition == 0)
err("Internal: rtf_Style_Default[%s] has no definition.\n", def->name);
StyleData* styleData = new StyleData(def->reference, def->definition);
rtf_Style.insert(def->name, styleData);
def++;
}
// overwrite some (or all) definitions from file
QCString &rtfStyleSheetFile = Config_getString(RTF_STYLESHEET_FILE);
if (!rtfStyleSheetFile.isEmpty())
{
loadStylesheet(rtfStyleSheetFile, rtf_Style);
}
// If user has defined an extension file, load its contents.
QCString &rtfExtensionsFile = Config_getString(RTF_EXTENSIONS_FILE);
if (!rtfExtensionsFile.isEmpty())
{
loadExtensions(rtfExtensionsFile);
}
createSubDirs(d);
}
void RTFGenerator::insertMemberAlign ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 122 of file rtfgen.h.

{}
bool RTFGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 41 of file rtfgen.h.

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

{ return (o==RTF && active); }
void RTFGenerator::lastIndexPage ( )
virtual

Implements OutputGenerator.

Definition at line 926 of file rtfgen.cpp.

References DBG_RTF, rtf_Style, and OutputGenerator::t.

{
DBG_RTF(t <<"{\\comment Beginning Body of RTF Document}\n")
// end page and setup for rest of document
t <<"\\sect \\sbkpage \\pgndec \\pgnrestart\n";
t <<"\\sect \\sectd \\sbknone\n";
// set new footer with arabic numbers
t <<"{\\footer "<< rtf_Style["Footer"]->reference << "{\\chpgn}}\n";
//t << rtf_Style["Heading1"]->reference << "\n";
}
void RTFGenerator::lineBreak ( const char *  style = 0)
virtual

Implements BaseOutputDocInterface.

Definition at line 943 of file rtfgen.cpp.

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

Referenced by endCodeLine().

{
DBG_RTF(t << "{\\comment (lineBreak)}" << endl)
t << "\\par" << endl;
m_omitParagraph = TRUE;
}
void RTFGenerator::newParagraph ( )

Definition at line 2137 of file rtfgen.cpp.

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

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

{
if (!m_omitParagraph)
{
DBG_RTF(t << "{\\comment (newParagraph)}" << endl)
t << "\\par" << endl;
}
m_omitParagraph = FALSE;
}
RTFGenerator& RTFGenerator::operator= ( const RTFGenerator &  )
private
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 2606 of file rtfgen.cpp.

References err(), preProcessFile(), and testRTFOutput().

Referenced by generateOutput().

{
QDir d(path);
// store the original directory
if (!d.exists())
{
err("Output dir %s does not exist!\n",path);
return FALSE;
}
QCString oldDir = QDir::currentDirPath().utf8();
// go to the html output directory (i.e. path)
QDir::setCurrent(d.absPath());
QDir thisDir;
QCString combinedName = (QCString)path+"/combined.rtf";
QCString mainRTFName = (QCString)path+"/"+name;
QFile outf(combinedName);
if (!outf.open(IO_WriteOnly))
{
err("Failed to open %s for writing!\n",combinedName.data());
QDir::setCurrent(oldDir);
return FALSE;
}
FTextStream outt(&outf);
if (!preProcessFile(thisDir,mainRTFName,outt))
{
// it failed, remove the temp file
outf.close();
thisDir.remove(combinedName);
QDir::setCurrent(oldDir);
return FALSE;
}
// everything worked, move the files
outf.close();
thisDir.remove(mainRTFName);
thisDir.rename(combinedName,mainRTFName);
testRTFOutput(mainRTFName);
QDir::setCurrent(oldDir);
return TRUE;
}
const char * RTFGenerator::rtf_BList_DepthStyle ( )
private

Definition at line 2089 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

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

{
QCString n=makeIndexName("ListBullet",m_listLevel);
return rtf_Style[n]->reference;
}
const char * RTFGenerator::rtf_CList_DepthStyle ( )
private

Definition at line 2075 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by endMemberGroupHeader(), startIndent(), startMemberDescription(), and startMemberSubtitle().

{
QCString n=makeIndexName("ListContinue",m_listLevel);
return rtf_Style[n]->reference;
}
const char * RTFGenerator::rtf_Code_DepthStyle ( )
private

Definition at line 2108 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startCodeFragment().

{
QCString n=makeIndexName("CodeExample",m_listLevel);
return rtf_Style[n]->reference;
}
const char * RTFGenerator::rtf_DList_DepthStyle ( )
private

Definition at line 2102 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startConstraintList(), startDescription(), startDescTable(), startMemberDocSimple(), startParamList(), and startSimpleSect().

{
QCString n=makeIndexName("DescContinue",m_listLevel);
return rtf_Style[n]->reference;
}
const char * RTFGenerator::rtf_EList_DepthStyle ( )
private

Definition at line 2096 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startItemListItem().

{
QCString n=makeIndexName("ListEnum",m_listLevel);
return rtf_Style[n]->reference;
}
const char * RTFGenerator::rtf_LCList_DepthStyle ( )
private

Definition at line 2082 of file rtfgen.cpp.

References m_listLevel, makeIndexName(), and rtf_Style.

Referenced by startIndexList().

{
QCString n=makeIndexName("LatexTOC",m_listLevel);
return rtf_Style[n]->reference;
}
void RTFGenerator::rtfwriteRuler_doubleline ( )
private

Definition at line 2783 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (rtfwriteRuler_doubleline)}" << endl)
t << "{\\pard\\widctlpar\\brdrb\\brdrdb\\brdrw15\\brsp20 \\adjustright \\par}" << endl;
}
void RTFGenerator::rtfwriteRuler_emboss ( )
private

Definition at line 2789 of file rtfgen.cpp.

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

Referenced by beginRTFSection().

{
DBG_RTF(t << "{\\comment (rtfwriteRuler_emboss)}" << endl)
t << "{\\pard\\widctlpar\\brdrb\\brdremboss\\brdrw15\\brsp20 \\adjustright \\par}" << endl;
}
void RTFGenerator::rtfwriteRuler_thick ( )
private

Definition at line 2795 of file rtfgen.cpp.

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

Referenced by beginRTFChapter().

{
DBG_RTF(t << "{\\comment (rtfwriteRuler_thick)}" << endl)
t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw75\\brsp20 \\adjustright \\par}" << endl;
}
void RTFGenerator::rtfwriteRuler_thin ( )
private

Definition at line 2801 of file rtfgen.cpp.

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

Referenced by writeRuler().

{
DBG_RTF(t << "{\\comment (rtfwriteRuler_thin)}" << endl)
t << "{\\pard\\widctlpar\\brdrb\\brdrs\\brdrw5\\brsp20 \\adjustright \\par}" << endl;
}
void RTFGenerator::setCurrentDoc ( Definition *  ,
const char *  ,
bool   
)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 264 of file rtfgen.h.

{}
void RTFGenerator::startAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 116 of file rtfgen.h.

{}
void RTFGenerator::startBold ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 134 of file rtfgen.h.

References OutputGenerator::t.

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

{ t << "{\\b "; }
void RTFGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2512 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startCallGraph)}" << endl)
}
void RTFGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 154 of file rtfgen.h.

References endl(), and OutputGenerator::t.

{ t << "{\\qc" << endl; }
void RTFGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1832 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment startClassDiagram }" << endl)
}
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 1899 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startCodeFragment) }" << endl)
t << "{" << endl;
//newParagraph();
t << rtf_Style_Reset << rtf_Code_DepthStyle();
//styleStack.push(rtf_Style_CodeExample);
}
void RTFGenerator::startCodeLine ( bool  )
inlinevirtual

Implements CodeOutputInterface.

Definition at line 130 of file rtfgen.h.

References col.

{ col=0; }
void RTFGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2879 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startConstraintDocs)}" << endl)
}
void RTFGenerator::startConstraintList ( const char *  header)
virtual

Implements OutputGenerator.

Definition at line 2838 of file rtfgen.cpp.

References DBG_RTF, docify(), endBold(), endl(), incrementIndentLevel(), newParagraph(), rtf_DList_DepthStyle(), rtf_Style_Reset, startBold(), and OutputGenerator::t.

{
DBG_RTF(t << "{\\comment (startConstraintList)}" << endl)
t << "{"; // ends at endConstraintList
t << "{";
startBold();
newParagraph();
docify(header);
endBold();
t << "}";
newParagraph();
incrementIndentLevel();
t << rtf_Style_Reset << rtf_DList_DepthStyle();
}
void RTFGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2853 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startConstraintParam)}" << endl)
startEmphasis();
}
void RTFGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2866 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startConstraintType)}" << endl)
startEmphasis();
}
void RTFGenerator::startContents ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 190 of file rtfgen.h.

{}
void RTFGenerator::startDescForItem ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1647 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescForItem) }" << endl)
}
void RTFGenerator::startDescItem ( )
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1594 of file rtfgen.cpp.

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

{
newParagraph();
DBG_RTF(t << "{\\comment (startDescItem)}" << endl)
t << "{\\b ";
}
void RTFGenerator::startDescList ( SectionTypes  )

Definition at line 1628 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescList)}" << endl)
t << "{"; // ends at endDescList
t << "{"; // ends at endDescTitle
startBold();
newParagraph();
}
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 1580 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescription)}" << endl)
t << "{" << endl;
t << rtf_Style_Reset << rtf_DList_DepthStyle();
}
void RTFGenerator::startDescTable ( const char *  title)
virtual

Implements BaseOutputDocInterface.

Definition at line 1986 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescTable) }" << endl)
t << "{\\par" << endl;
t << "{" << rtf_Style["Heading5"]->reference << endl;
docify(title);
t << ":\\par}" << endl;
t << rtf_Style_Reset << rtf_DList_DepthStyle();
t << "\\trowd \\trgaph108\\trleft426\\tblind426"
"\\trbrdrt\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrl\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrb\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrr\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrh\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 "<< endl;
int i,columnPos[2] = { 25, 100 };
for (i=0;i<2;i++)
{
t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrl\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrb\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrr \\brdrs\\brdrw10\\brdrcf15 "
"\\cltxlrtb "
"\\cellx" << (rtf_pageWidth*columnPos[i]/100) << endl;
}
t << "\\pard \\widctlpar\\intbl\\adjustright" << endl;
}
void RTFGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2040 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescTableData) }" << endl)
t << "{";
}
void RTFGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2020 of file rtfgen.cpp.

{
}
void RTFGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 2028 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDescTableTitle) }" << endl)
t << "{\\qr ";
}
void RTFGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2535 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDirDepGraph)}" << endl)
}
void RTFGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2457 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startDotGraph)}" << endl)
}
void RTFGenerator::startDoxyAnchor ( const char *  ,
const char *  ,
const char *  ,
const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1514 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startDoxyAnchor}" << endl)
}
void RTFGenerator::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 132 of file rtfgen.h.

References OutputGenerator::t.

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

{ t << "{\\i "; }
void RTFGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

Implements OutputGenerator.

Definition at line 332 of file rtfgen.cpp.

References beginRTFDocument(), OutputGenerator::fileName, Rtf_Style_Default::name, relativePathToRoot(), relPath, and OutputGenerator::startPlainFile().

{
//setEncoding(QCString().sprintf("CP%s",theTranslator->trRTFansicp()));
QCString fileName=name;
relPath = relativePathToRoot(fileName);
if (fileName.right(4)!=".rtf" ) fileName+=".rtf";
startPlainFile(fileName);
beginRTFDocument();
}
void RTFGenerator::startFontClass ( const char *  clsName)
inlinevirtual

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 260 of file rtfgen.h.

{}
void RTFGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 2504 of file rtfgen.cpp.

{
}
void RTFGenerator::startGroupHeader ( int  extraIndent)
virtual

Implements OutputGenerator.

Definition at line 1454 of file rtfgen.cpp.

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

Referenced by startMemberHeader().

{
DBG_RTF(t <<"{\\comment startGroupHeader}" << endl)
//newParagraph();
t << rtf_Style_Reset;
if (extraIndent==2)
{
t << rtf_Style["Heading5"]->reference;
}
else if (extraIndent==1)
{
t << rtf_Style["Heading4"]->reference;
}
else // extraIndent==0
{
t << rtf_Style["Heading3"]->reference;
}
t << endl;
}
void RTFGenerator::startHeaderSection ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 104 of file rtfgen.h.

{}
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 1075 of file rtfgen.cpp.

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

{
if (Config_getBool(RTF_HYPERLINKS))
{
t << "{\\field {\\*\\fldinst { HYPERLINK \"";
t << url;
t << "\" }{}";
t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
}
else
{
startTypewriter();
}
}
void RTFGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 2481 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startInclDepGraph)}" << endl)
}
void RTFGenerator::startIndent ( )
virtual

Implements OutputGenerator.

Definition at line 1565 of file rtfgen.cpp.

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

{
incrementIndentLevel();
DBG_RTF(t << "{\\comment (startIndent) }" << endl)
t << "{" << endl;
t << rtf_Style_Reset << rtf_CList_DepthStyle() << endl;
}
void RTFGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1041 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startIndexItem)}" << endl)
if (!m_omitParagraph)
{
t << "\\par" << endl;
m_omitParagraph = TRUE;
}
}
void RTFGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1150 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startIndexKey)}" << endl)
t << "{\\b ";
}
void RTFGenerator::startIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 955 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startIndexList)}" << endl)
t << "{" << endl;
t << "\\par" << endl;
incrementIndentLevel();
t << rtf_Style_Reset << rtf_LCList_DepthStyle() << endl;
m_omitParagraph = TRUE;
}
void RTFGenerator::startIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 2899 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startIndexListItem)}" << endl)
}
void RTFGenerator::startIndexSection ( IndexSections  is)
virtual

Implements OutputGenerator.

Definition at line 362 of file rtfgen.cpp.

References beginRTFChapter(), Doxygen::classSDict, DBG_RTF, Doxygen::directories, Doxygen::groupSDict, Doxygen::inputNameList, isClassDocumentation, isClassHierarchyIndex, isCompoundIndex, isDirDocumentation, isDirIndex, ClassDef::isEmbeddedInOuterScope(), isEndIndex, isExampleDocumentation, isFileDocumentation, isFileIndex, DirDef::isLinkableInProject(), NamespaceDef::isLinkableInProject(), FileDef::isLinkableInProject(), ClassDef::isLinkableInProject(), isMainPage, isModuleDocumentation, isModuleIndex, isNamespaceDocumentation, isNamespaceIndex, isPageDocumentation, isPageDocumentation2, isPageIndex, Definition::isReference(), isTitlePageAuthor, isTitlePageStart, SDict< ClassDef >::Iterator, SDict< GroupDef >::Iterator, SDict< NamespaceDef >::Iterator, m_listLevel, Doxygen::namespaceSDict, rtf_author, rtf_comments, rtf_company, rtf_documentType, rtf_keywords, rtf_manager, rtf_subject, OutputGenerator::t, and ClassDef::templateMaster().

{
//QCString paperName;
m_listLevel = 0;
switch (is)
{
case isTitlePageStart:
// basic RTFstart
// get readyfor author etc
t << "{\\info \n";
t << "{\\title {\\comment ";
break;
case isTitlePageAuthor:
t << "}\n";
if (rtf_subject) t << "{\\subject " << rtf_subject << "}\n";
if (rtf_comments) t << "{\\comment " << rtf_comments << "}\n";
if (rtf_company) t << "{\\company " << rtf_company << "}\n";
if (rtf_author) t << "{\\author " << rtf_author << "}\n";
if (rtf_manager) t << "{\\manager " << rtf_manager << "}\n";
if (rtf_documentType) t << "{\\category " << rtf_documentType << "}\n";
if (rtf_keywords) t << "{\\keywords " << rtf_keywords << "}\n";
t << "{\\comment ";
break;
case isMainPage:
//Introduction
beginRTFChapter();
break;
//case isPackageIndex:
// //Package Index
// beginRTFChapter();
// break;
case isModuleIndex:
//Module Index
beginRTFChapter();
break;
case isDirIndex:
//Directory Index
beginRTFChapter();
break;
case isNamespaceIndex:
//Namespace Index
beginRTFChapter();
break;
case isClassHierarchyIndex:
//Hierarchical Index
DBG_RTF(t << "{\\comment start classhierarchy}\n")
beginRTFChapter();
break;
case isCompoundIndex:
//Annotated Compound Index
beginRTFChapter();
break;
case isFileIndex:
//Annotated File Index
beginRTFChapter();
break;
case isPageIndex:
//Related Page Index
beginRTFChapter();
break;
case isModuleDocumentation:
{
//Module Documentation
GroupSDict::Iterator gli(*Doxygen::groupSDict);
GroupDef *gd;
bool found=FALSE;
for (gli.toFirst();(gd=gli.current()) && !found;++gli)
{
if (!gd->isReference())
{
beginRTFChapter();
found=TRUE;
}
}
}
break;
case isDirDocumentation:
{
//Directory Documentation
SDict<DirDef>::Iterator dli(*Doxygen::directories);
DirDef *dd;
bool found=FALSE;
for (dli.toFirst();(dd=dli.current()) && !found;++dli)
{
if (dd->isLinkableInProject())
{
beginRTFChapter();
found=TRUE;
}
}
}
break;
case isNamespaceDocumentation:
{
// Namespace Documentation
NamespaceSDict::Iterator nli(*Doxygen::namespaceSDict);
NamespaceDef *nd;
bool found=FALSE;
for (nli.toFirst();(nd=nli.current()) && !found;++nli)
{
if (nd->isLinkableInProject())
{
beginRTFChapter();
found=TRUE;
}
}
}
break;
case isClassDocumentation:
{
//Compound Documentation
ClassSDict::Iterator cli(*Doxygen::classSDict);
ClassDef *cd=0;
bool found=FALSE;
for (cli.toFirst();(cd=cli.current()) && !found;++cli)
{
if (cd->isLinkableInProject() &&
cd->templateMaster()==0 &&
!cd->isEmbeddedInOuterScope()
)
{
beginRTFChapter();
found=TRUE;
}
}
}
break;
case isFileDocumentation:
{
//File Documentation
bool isFirst=TRUE;
FileNameListIterator fnli(*Doxygen::inputNameList);
FileName *fn;
for (fnli.toFirst();(fn=fnli.current());++fnli)
{
FileNameIterator fni(*fn);
FileDef *fd;
for (;(fd=fni.current());++fni)
{
if (fd->isLinkableInProject())
{
if (isFirst)
{
beginRTFChapter();
isFirst=FALSE;
break;
}
}
}
}
}
break;
case isExampleDocumentation:
{
//Example Documentation
beginRTFChapter();
}
break;
case isPageDocumentation:
{
//Page Documentation
beginRTFChapter();
}
break;
case isPageDocumentation2:
{
t << "{\\tc \\v ";
}
break;
case isEndIndex:
break;
}
}
void RTFGenerator::startIndexValue ( bool  hasBrief)
virtual

Implements OutputGenerator.

Definition at line 1161 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startIndexValue)}" << endl)
t << " ";
if (hasBrief) t << "(";
}
void RTFGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2910 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startInlineHeader)}" << endl)
t << "{" << endl;
t << rtf_Style_Reset << rtf_Style["Heading5"]->reference;
startBold();
}
void RTFGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2997 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startInlineMemberDoc)}" << endl)
t << "{";
}
void RTFGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2985 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startInlineMemberName)}" << endl)
t << "{";
}
void RTFGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2973 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startInlineMemberType)}" << endl)
t << "{\\qr ";
}
void RTFGenerator::startItemList ( )
virtual

start bullet list

Implements BaseOutputDocInterface.

Definition at line 978 of file rtfgen.cpp.

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

{
newParagraph();
DBG_RTF(t << "{\\comment (startItemList level=" << m_listLevel << ") }" << endl)
t << "{";
incrementIndentLevel();
rtf_listItemInfo[m_listLevel].isEnum = FALSE;
}
void RTFGenerator::startItemListItem ( )
virtual

start enumeration list

end enumeration list

write bullet or enum item

Implements BaseOutputDocInterface.

Definition at line 1018 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, and OutputGenerator::t.

{
DBG_RTF(t << "{\\comment (startItemListItem)}" << endl)
newParagraph();
t << rtf_Style_Reset;
if (rtf_listItemInfo[m_listLevel].isEnum)
{
t << rtf_EList_DepthStyle() << endl;
t << rtf_listItemInfo[m_listLevel].number << ".\\tab ";
rtf_listItemInfo[m_listLevel].number++;
}
else
{
t << rtf_BList_DepthStyle() << endl;
}
m_omitParagraph = TRUE;
}
void RTFGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 3009 of file rtfgen.cpp.

{
}
void RTFGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 161 of file rtfgen.h.

{}
void RTFGenerator::startMemberDescription ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1608 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startMemberDescription)}" << endl)
t << "{" << endl;
incrementIndentLevel();
t << rtf_Style_Reset << rtf_CList_DepthStyle();
startEmphasis();
}
void RTFGenerator::startMemberDoc ( const char *  clname,
const char *  memname,
const char *  ,
const char *  ,
int  ,
int  ,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1481 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startMemberDoc}" << endl)
if (memname && memname[0]!='@')
{
addIndexItem(memname,clname);
addIndexItem(clname,memname);
}
t << rtf_Style_Reset << rtf_Style[showInline ? "Heading5" : "Heading4"]->reference;
//styleStack.push(rtf_Style_Heading4);
t << "{" << endl;
//printf("RTFGenerator::startMemberDoc() `%s'\n",rtf_Style["Heading4"]->reference);
startBold();
t << endl;
}
void RTFGenerator::startMemberDocList ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 110 of file rtfgen.h.

{}
void RTFGenerator::startMemberDocName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 228 of file rtfgen.h.

{}
void RTFGenerator::startMemberDocPrefixItem ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 226 of file rtfgen.h.

{}
void RTFGenerator::startMemberDocSimple ( bool  isEnum)
virtual

Implements OutputGenerator.

Definition at line 2926 of file rtfgen.cpp.

References DBG_RTF, endl(), rtf_DList_DepthStyle(), rtf_pageWidth, rtf_Style, rtf_Style_Reset, OutputGenerator::t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

{
DBG_RTF(t << "{\\comment (startMemberDocSimple)}" << endl)
t << "{\\par" << endl;
t << "{" << rtf_Style["Heading5"]->reference << endl;
if (isEnum)
{
t << theTranslator->trEnumerationValues();
}
else
{
t << theTranslator->trCompoundMembers();
}
t << ":\\par}" << endl;
t << rtf_Style_Reset << rtf_DList_DepthStyle();
t << "\\trowd \\trgaph108\\trleft426\\tblind426"
"\\trbrdrt\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrl\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrb\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrr\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrh\\brdrs\\brdrw10\\brdrcf15 "
"\\trbrdrv\\brdrs\\brdrw10\\brdrcf15 "<< endl;
int i,n=3,columnPos[3] = { 25, 50, 100 };
if (isEnum)
{
columnPos[0]=30;
columnPos[1]=100;
n=2;
}
for (i=0;i<n;i++)
{
t << "\\clvertalt\\clbrdrt\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrl\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrb\\brdrs\\brdrw10\\brdrcf15 "
"\\clbrdrr \\brdrs\\brdrw10\\brdrcf15 "
"\\cltxlrtb "
"\\cellx" << (rtf_pageWidth*columnPos[i]/100) << endl;
}
t << "\\pard \\widctlpar\\intbl\\adjustright" << endl;
}
void RTFGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 2681 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startMemberGroup}" << endl)
t << rtf_Style_Reset << rtf_BList_DepthStyle() << endl;
}
void RTFGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2668 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startMemberGroupDocs}" << endl)
startEmphasis();
}
void RTFGenerator::startMemberGroupHeader ( bool  hasHeader)
virtual

Implements OutputGenerator.

Definition at line 2653 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startMemberGroupHeader}" << endl)
t << "{" << endl;
if (hasHeader) incrementIndentLevel();
t << rtf_Style_Reset << rtf_Style["GroupHeader"]->reference;
}
void RTFGenerator::startMemberHeader ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 106 of file rtfgen.h.

References startGroupHeader().

{ startGroupHeader(FALSE); }
void RTFGenerator::startMemberItem ( const char *  ,
int  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 1859 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment startMemberItem }" << endl)
t << rtf_Style_Reset << rtf_BList_DepthStyle() << endl; // set style to appropriate depth
}
void RTFGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1925 of file rtfgen.cpp.

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

{
t << endl;
DBG_RTF(t << "{\\comment (startMemberList) }" << endl)
t << "{" << endl;
#ifdef DELETEDCODE
if (!insideTabbing)
t << "\\begin{CompactItemize}" << endl;
#endif
}
void RTFGenerator::startMemberSections ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 102 of file rtfgen.h.

{}
void RTFGenerator::startMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 2161 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startMemberSubtitle}" << endl)
t << "{" << endl;
t << rtf_Style_Reset << rtf_CList_DepthStyle() << endl;
}
void RTFGenerator::startMemberTemplateParams ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 120 of file rtfgen.h.

{}
void RTFGenerator::startPageRef ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1356 of file rtfgen.cpp.

References startEmphasis(), and OutputGenerator::t.

{
t << " (";
startEmphasis();
}
void RTFGenerator::startParagraph ( )
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 2147 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startParagraph}" << endl)
newParagraph();
t << "{" << endl;
}
void RTFGenerator::startParameterList ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 234 of file rtfgen.h.

{}
void RTFGenerator::startParameterName ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 232 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 2750 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startParameterType)}" << endl)
if (!first && key)
{
t << " " << key << " ";
}
}
void RTFGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2726 of file rtfgen.cpp.

References DBG_RTF, docify(), endBold(), endl(), incrementIndentLevel(), newParagraph(), rtf_DList_DepthStyle(), rtf_Style_Reset, startBold(), and OutputGenerator::t.

{
DBG_RTF(t << "{\\comment (startParamList)}" << endl)
t << "{"; // ends at endParamList
t << "{"; // ends at endDescTitle
startBold();
newParagraph();
docify(title);
endBold();
t << "}";
newParagraph();
incrementIndentLevel();
t << rtf_Style_Reset << rtf_DList_DepthStyle();
}
void RTFGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 351 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment startProjectNumber }" << endl)
t << " ";
}
void RTFGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 183 of file rtfgen.h.

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

Implements BaseOutputDocInterface.

Definition at line 1667 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (startSection)}" << endl)
t << "{";
t<< rtf_Style_Reset;
int num=4;
switch(type)
{
case SectionInfo::Page: num=2; break;
case SectionInfo::Section: num=3; break;
case SectionInfo::Subsection: num=4; break;
case SectionInfo::Subsubsection: num=4; break;
case SectionInfo::Paragraph: num=4; break;
default: ASSERT(0); break;
}
QCString heading;
heading.sprintf("Heading%d",num);
// set style
t << rtf_Style[heading]->reference;
// make table of contents entry
t << "{\\tc\\tcl" << num << " \\v ";
docify(title);
t << "}" << endl;
}
void RTFGenerator::startSimpleSect ( SectionTypes  ,
const char *  file,
const char *  anchor,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 2694 of file rtfgen.cpp.

References DBG_RTF, docify(), endBold(), endl(), incrementIndentLevel(), newParagraph(), rtf_DList_DepthStyle(), rtf_Style_Reset, startBold(), OutputGenerator::t, and writeObjectLink().

{
DBG_RTF(t << "{\\comment (startSimpleSect)}" << endl)
t << "{"; // ends at endDescList
t << "{"; // ends at endDescTitle
startBold();
newParagraph();
if (file)
{
writeObjectLink(0,file,anchor,title);
}
else
{
docify(title);
}
endBold();
t << "}";
newParagraph();
incrementIndentLevel();
t << rtf_Style_Reset << rtf_DList_DepthStyle();
}
void RTFGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 156 of file rtfgen.h.

References OutputGenerator::t.

{ t << "{\\sub "; }
void RTFGenerator::startSubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1187 of file rtfgen.cpp.

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

{
//beginRTFSubSection();
t <<"\n";
DBG_RTF(t << "{\\comment Begin SubSection}\n")
t << rtf_Style_Reset;
t << rtf_Style["Heading3"]->reference << "\n";
}
void RTFGenerator::startSubsubsection ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1202 of file rtfgen.cpp.

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

{
//beginRTFSubSubSection();
t << "\n";
DBG_RTF(t << "{\\comment Begin SubSubSection}\n")
t << "{" << endl;
t << rtf_Style_Reset << rtf_Style["Heading4"]->reference << "\n";
}
void RTFGenerator::startTextBlock ( bool  dense)
virtual

Implements OutputGenerator.

Definition at line 2114 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment startTextBlock}" << endl)
t << "{" << endl;
t << rtf_Style_Reset;
if (dense) // no spacing between "paragraphs"
{
t << rtf_Style["DenseText"]->reference;
}
else // some spacing
{
t << rtf_Style["BodyText"]->reference;
}
}
void RTFGenerator::startTextLink ( const char *  f,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1293 of file rtfgen.cpp.

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

{
if (Config_getBool(RTF_HYPERLINKS))
{
QCString ref;
if (f)
{
ref+=f;
}
if (anchor)
{
ref+='_';
ref+=anchor;
}
t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";
t << rtfFormatBmkStr(ref);
t << "\" }{}";
t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
}
}
void RTFGenerator::startTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1445 of file rtfgen.cpp.

References beginRTFChapter(), beginRTFSection(), Config_getBool, DBG_RTF, endl(), and OutputGenerator::t.

{
DBG_RTF(t <<"{\\comment startTitle}" << endl)
if (Config_getBool(COMPACT_RTF))
beginRTFSection();
else
beginRTFChapter();
}
void RTFGenerator::startTitleHead ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 1411 of file rtfgen.cpp.

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

{
DBG_RTF(t <<"{\\comment startTitleHead}" << endl)
// beginRTFSection();
t << rtf_Style_Reset << rtf_Style["Heading2"]->reference << endl;
}
void RTFGenerator::startTypewriter ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 94 of file rtfgen.h.

References OutputGenerator::t.

Referenced by startHtmlLink().

{ t << "{\\f2 "; }
void RTFGenerator::writeAnchor ( const char *  fileName,
const char *  name 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1871 of file rtfgen.cpp.

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

Referenced by endSection(), and endTitleHead().

{
QCString anchor;
if (fileName)
{
anchor+=fileName;
}
if (fileName && name)
{
anchor+='_';
}
if (name)
{
anchor+=name;
}
DBG_RTF(t <<"{\\comment writeAnchor (" << anchor << ")}" << endl)
t << "{\\bkmkstart " << rtfFormatBmkStr(anchor) << "}" << endl;
t << "{\\bkmkend " << rtfFormatBmkStr(anchor) << "}" << endl;
}
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 1824 of file rtfgen.cpp.

References docify().

{
char cs[2];
cs[0]=c;
cs[1]=0;
docify(cs);
}
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 263 of file rtfgen.h.

{}
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 1379 of file rtfgen.cpp.

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

{
if (!ref && Config_getBool(RTF_HYPERLINKS))
{
QCString refName;
if (f)
{
refName+=f;
}
if (anchor)
{
refName+='_';
refName+=anchor;
}
t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";
t << rtfFormatBmkStr(refName);
t << "\" }{}";
t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
codify(name);
t << "}}}" << endl;
}
else
{
codify(name);
}
}
void RTFGenerator::writeDoc ( DocNode *  n,
Definition *  ctx,
MemberDef *   
)
virtual

Implements OutputGenerator.

Definition at line 2775 of file rtfgen.cpp.

References DocNode::accept(), Definition::getDefFileExtension(), m_omitParagraph, and OutputGenerator::t.

Referenced by endIndexSection().

{
RTFDocVisitor *visitor = new RTFDocVisitor(t,*this,ctx?ctx->getDefFileExtension():QCString(""));
n->accept(visitor);
delete visitor;
m_omitParagraph = TRUE;
}
void RTFGenerator::writeEndAnnoItem ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 1134 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (writeEndAnnoItem)}" << endl)
if (name)
{
t << "\\tab ";
writeRTFReference(name);
t << endl;
}
else
{
t << endl;
}
newParagraph();
}
void RTFGenerator::writeExtensionsFile ( QFile &  file)
static

Definition at line 113 of file rtfgen.cpp.

References OutputGenerator::t, and versionString.

Referenced by readConfiguration().

{
FTextStream t(&file);
t << "# Generated by doxygen " << versionString << "\n\n";
t << "# This file describes extensions used for generating RTF output.\n";
t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
t << "# Remove a hash to activate a line.\n\n";
t << "# Overrides the project title.\n";
t << "#Title = \n\n";
t << "# Name of the company that produced this document.\n";
t << "#Company = \n\n";
t << "# Filename of a company or project logo.\n";
t << "#LogoFilename = \n\n";
t << "# Author of the document.\n";
t << "#Author = \n\n";
t << "# Type of document (e.g. Design Specification, User Manual, etc.).\n";
t << "#DocumentType = \n\n";
t << "# Document tracking number.\n";
t << "#DocumentId = \n\n";
t << "# Name of the author's manager.\n";
t << "# This field is not displayed in the document itself, but it is \n";
t << "# available in the information block of the rtf file. In Microsoft \n";
t << "# Word, it is available under File:Properties.\n";
t << "#Manager = \n\n";
t << "# Subject of the document.\n";
t << "# This field is not displayed in the document itself, but it is \n";
t << "# available in the information block of the rtf file. In Microsoft \n";
t << "# Word, it is available under File:Properties.\n";
t << "#Subject = \n\n";
t << "# Comments regarding the document.\n";
t << "# This field is not displayed in the document itself, but it is \n";
t << "# available in the information block of the rtf file. In Microsoft \n";
t << "# Word, it is available under File:Properties.\n";
t << "#Comments = \n\n";
t << "# Keywords associated with the document.\n";
t << "# This field is not displayed in the document itself, but it is \n";
t << "# available in the information block of the rtf file. In Microsoft \n";
t << "# Word, it is available under File:Properties.\n";
t << "#Keywords = \n\n";
}
void RTFGenerator::writeFooter ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 48 of file rtfgen.h.

{}
void RTFGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  )
inlinevirtual

Implements OutputGenerator.

Definition at line 213 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 163 of file rtfgen.h.

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

Implements OutputGenerator.

Definition at line 3013 of file rtfgen.cpp.

References OutputGenerator::t.

{
t << "{\\f2 [" << l << "]}";
if (!isLast) t << ", ";
}
void RTFGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 146 of file rtfgen.h.

{};//{ t << "\\hspace{0.3cm}"; }
void RTFGenerator::writeLineNumber ( const char *  ref,
const char *  file,
const char *  anchor,
int  lineNumber 
)
inlinevirtual

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 129 of file rtfgen.h.

References OutputGenerator::t.

{ t << QString("%1").arg(l,5) << " "; }
void RTFGenerator::writeLogo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 187 of file rtfgen.h.

{}
void RTFGenerator::writeNavigationPath ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 186 of file rtfgen.h.

{}
void RTFGenerator::writeNonBreakableSpace ( int  )
virtual

Implements BaseOutputDocInterface.

Definition at line 1919 of file rtfgen.cpp.

References OutputGenerator::t.

{
t << "\\~ ";
}
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 1323 of file rtfgen.cpp.

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

Referenced by startSimpleSect().

{
if (!ref && Config_getBool(RTF_HYPERLINKS))
{
QCString refName;
if (f)
{
refName+=f;
}
if (anchor)
{
refName+='_';
refName+=anchor;
}
t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";
t << rtfFormatBmkStr(refName);
t << "\" }{}";
t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
docify(text);
t << "}}}" << endl;
}
else
{
startBold();
docify(text);
endBold();
}
}
void RTFGenerator::writePageLink ( const char *  name,
bool  first 
)
virtual

Implements OutputGenerator.

Definition at line 918 of file rtfgen.cpp.

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

{
if (first) t << "\\par " << rtf_Style_Reset << endl;
t << "{\\field\\fldedit{\\*\\fldinst INCLUDETEXT \"";
t << name;
t << ".rtf\" \\\\*MERGEFORMAT}{\\fldrslt includedstuff}}\n";
}
void RTFGenerator::writeQuickLinks ( bool  ,
HighlightedItem  ,
const char *   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 188 of file rtfgen.h.

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

Definition at line 1892 of file rtfgen.cpp.

References rtfFormatBmkStr(), and OutputGenerator::t.

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

{
t << "{\\field\\fldedit {\\*\\fldinst PAGEREF ";
t << rtfFormatBmkStr(label);
t << " \\\\*MERGEFORMAT}{\\fldrslt pagenum}}";
}
void RTFGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 124 of file rtfgen.h.

References rtfwriteRuler_thin().

{ rtfwriteRuler_thin(); }
void RTFGenerator::writeSearchInfo ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 47 of file rtfgen.h.

{}
void RTFGenerator::writeSplitBar ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 185 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 1110 of file rtfgen.cpp.

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

{
DBG_RTF(t << "{\\comment (writeStartAnnoItem)}" << endl)
t << "{\\b ";
if (path) docify(path);
if (f && Config_getBool(RTF_HYPERLINKS))
{
t << "{\\field {\\*\\fldinst { HYPERLINK \\\\l \"";
t << rtfFormatBmkStr(f);
t << "\" }{}";
t << "}{\\fldrslt {\\cs37\\ul\\cf2 ";
docify(name);
t << "}}}" << endl;
}
else
{
docify(name);
}
t << "} ";
}
void RTFGenerator::writeString ( const char *  text)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 950 of file rtfgen.cpp.

References OutputGenerator::t.

{
t << text;
}
void RTFGenerator::writeStyleInfo ( int  part)
virtual

Implements OutputGenerator.

Definition at line 939 of file rtfgen.cpp.

{
}
void RTFGenerator::writeStyleSheetFile ( QFile &  f)
static

Definition at line 96 of file rtfgen.cpp.

References Rtf_Style_Default::definition, endl(), Rtf_Style_Default::name, Rtf_Style_Default::reference, rtf_Style_Default, OutputGenerator::t, and versionString.

Referenced by readConfiguration().

{
FTextStream t(&file);
t << "# Generated by doxygen " << versionString << "\n\n";
t << "# This file describes styles used for generating RTF output.\n";
t << "# All text after a hash (#) is considered a comment and will be ignored.\n";
t << "# Remove a hash to activate a line.\n\n";
int i;
for ( i=0 ; rtf_Style_Default[i].reference!=0 ; i++ )
{
t << "# " << rtf_Style_Default[i].name << " = "
<< rtf_Style_Default[i].reference
<< rtf_Style_Default[i].definition << endl;
}
}
void RTFGenerator::writeSummaryLink ( const char *  ,
const char *  ,
const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file rtfgen.h.

{}
void RTFGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 178 of file rtfgen.h.

{}
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 87 of file rtfgen.h.

{}

Member Data Documentation

int RTFGenerator::col
private

Definition at line 281 of file rtfgen.h.

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

bool RTFGenerator::m_bstartedBody
private

Definition at line 284 of file rtfgen.h.

Referenced by RTFGenerator().

int RTFGenerator::m_listLevel
private

Definition at line 285 of file rtfgen.h.

Referenced by decrementIndentLevel(), endItemList(), incrementIndentLevel(), rtf_BList_DepthStyle(), rtf_CList_DepthStyle(), rtf_Code_DepthStyle(), rtf_DList_DepthStyle(), rtf_EList_DepthStyle(), rtf_LCList_DepthStyle(), RTFGenerator(), startIndexSection(), startItemList(), and startItemListItem().

int RTFGenerator::m_numCols
private

Definition at line 287 of file rtfgen.h.

Referenced by RTFGenerator().

bool RTFGenerator::m_omitParagraph
private

Definition at line 286 of file rtfgen.h.

Referenced by docify(), endCodeFragment(), endConstraintList(), endIndexItem(), endIndexList(), endIndexValue(), endItemList(), endParagraph(), endParamList(), endSection(), endSimpleSect(), lineBreak(), newParagraph(), RTFGenerator(), startIndexItem(), startIndexList(), startItemListItem(), and writeDoc().

bool RTFGenerator::m_prettyCode
private

Definition at line 282 of file rtfgen.h.

Referenced by endIndexSection(), and RTFGenerator().

QCString RTFGenerator::relPath
private

Definition at line 288 of file rtfgen.h.

Referenced by endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endInclDepGraph(), and startFile().

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