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 | Static Private Member Functions | Private Attributes | List of all members
HtmlGenerator Class Reference

#include <htmlgen.h>

Inheritance diagram for HtmlGenerator:
OutputGenerator BaseOutputDocInterface CodeOutputInterface

Public Member Functions

 HtmlGenerator ()
 
virtual ~HtmlGenerator ()
 
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 codify (const char *text)
 
void writeCodeLink (const char *ref, const char *file, const char *anchor, const char *name, const char *tooltip)
 
void writeLineNumber (const char *ref, const char *file, const char *anchor, int lineNumber)
 
void writeTooltip (const char *id, const DocLinkInfo &docInfo, const char *decl, const char *desc, const SourceLinkInfo &defInfo, const SourceLinkInfo &declInfo)
 
void startCodeLine (bool hasLineNumbers)
 
void endCodeLine ()
 
void startFontClass (const char *s)
 
void endFontClass ()
 
void writeCodeAnchor (const char *anchor)
 
void setCurrentDoc (Definition *context, const char *anchor, bool isSourceFile)
 
void addWord (const char *word, bool hiPriority)
 
void writeDoc (DocNode *, Definition *, MemberDef *)
 
void startFile (const char *name, const char *manName, const char *title)
 
void writeFooter (const char *navPath)
 
void endFile ()
 
void clearBuffer ()
 
void writeSearchInfo ()
 
void startIndexSection (IndexSections)
 
void endIndexSection (IndexSections)
 
void writePageLink (const char *, bool)
 
void startProjectNumber ()
 
void endProjectNumber ()
 
void writeStyleInfo (int part)
 
void startTitleHead (const char *)
 
void endTitleHead (const char *, const char *)
 
void startTitle ()
 
void endTitle ()
 
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 writeObjectLink (const char *ref, const char *file, const char *anchor, const char *name)
 
void startTextLink (const char *file, 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 *anchor, int, const char *inheritId)
 
void endMemberItem ()
 
void startMemberTemplateParams ()
 
void endMemberTemplateParams (const char *anchor, const char *inheritId)
 
void startMemberGroupHeader (bool)
 
void endMemberGroupHeader ()
 
void startMemberGroupDocs ()
 
void endMemberGroupDocs ()
 
void startMemberGroup ()
 
void endMemberGroup (bool)
 
void insertMemberAlign (bool)
 
void startMemberDescription (const char *anchor, const char *inheritId)
 
void endMemberDescription ()
 
void startMemberDeclaration ()
 
void endMemberDeclaration (const char *anchor, const char *inheritId)
 
void writeInheritedSectionTitle (const char *id, const char *ref, const char *file, const char *anchor, const char *title, const char *name)
 
void writeRuler ()
 
void writeAnchor (const char *, const char *name)
 
void startCodeFragment ()
 
void endCodeFragment ()
 
void startEmphasis ()
 
void endEmphasis ()
 
void startBold ()
 
void endBold ()
 
void startDescription ()
 
void endDescription ()
 
void startDescItem ()
 
void endDescItem ()
 
void startDescForItem ()
 
void endDescForItem ()
 
void lineBreak (const char *style)
 
void writeChar (char c)
 
void startMemberDoc (const char *clName, const char *memName, const char *anchor, const char *title, int memCount, int memTotal, bool showInline)
 
void endMemberDoc (bool)
 
void startDoxyAnchor (const char *fName, const char *manName, const char *anchor, const char *name, const char *args)
 
void endDoxyAnchor (const char *fName, const char *anchor)
 
void writeLatexSpacing ()
 
void writeStartAnnoItem (const char *type, const char *file, const char *path, const char *name)
 
void writeEndAnnoItem (const char *)
 
void startSubsection ()
 
void endSubsection ()
 
void startSubsubsection ()
 
void endSubsubsection ()
 
void startCenter ()
 
void endCenter ()
 
void startSmall ()
 
void endSmall ()
 
void startSimpleSect (SectionTypes, const char *, const char *, const char *)
 
void endSimpleSect ()
 
void startParamList (ParamListTypes, const char *)
 
void endParamList ()
 
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 *, const char *)
 
void startPageRef ()
 
void endPageRef (const char *, const char *)
 
void startQuickIndices ()
 
void endQuickIndices ()
 
void writeSplitBar (const char *name)
 
void writeNavigationPath (const char *s)
 
void writeLogo ()
 
void writeQuickLinks (bool compact, HighlightedItem hli, const char *file)
 
void writeSummaryLink (const char *file, const char *anchor, const char *title, bool first)
 
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 &g)
 
void startInclDepGraph ()
 
void endInclDepGraph (const DotInclDepGraph &g)
 
void startGroupCollaboration ()
 
void endGroupCollaboration (const DotGroupCollaboration &g)
 
void startCallGraph ()
 
void endCallGraph (const DotCallGraph &g)
 
void startDirDepGraph ()
 
void endDirDepGraph (const DotDirDeps &g)
 
void writeGraphicalHierarchy (const DotGfxHierarchyTable &g)
 
void startTextBlock (bool)
 
void endTextBlock (bool)
 
void lastIndexPage ()
 
void startMemberDocPrefixItem ()
 
void endMemberDocPrefixItem ()
 
void startMemberDocName (bool)
 
void endMemberDocName ()
 
void startParameterType (bool first, const char *key)
 
void endParameterType ()
 
void startParameterName (bool)
 
void endParameterName (bool last, bool emptyList, bool closeBracket)
 
void startParameterList (bool)
 
void endParameterList ()
 
virtual 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 ()
 
- 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 writeHeaderFile (QFile &f, const char *cssname)
 
static void writeFooterFile (QFile &f)
 
static void writeTabData ()
 Additional initialization after indices have been created.
 
static void writeSearchInfo (FTextStream &t, const QCString &relPath)
 
static void writeSearchData (const char *dir)
 
static void writeSearchPage ()
 
static void writeExternalSearchPage ()
 
static QCString writeLogoAsString (const char *path)
 
static QCString writeSplitBarAsString (const char *name, const char *relpath)
 

Private Member Functions

void docify (const char *text, bool inHtmlComment)
 
HtmlGenerator & operator= (const HtmlGenerator &g)
 
 HtmlGenerator (const HtmlGenerator &g)
 

Static Private Member Functions

static void writePageFooter (FTextStream &t, const QCString &, const QCString &, const QCString &)
 

Private Attributes

QCString lastTitle
 
QCString lastFile
 
QCString relPath
 
int m_sectionCount
 
bool m_emptySection
 
HtmlCodeGenerator m_codeGen
 

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 HTML output

Definition at line 71 of file htmlgen.h.

Constructor & Destructor Documentation

HtmlGenerator::HtmlGenerator ( )

Definition at line 681 of file htmlgen.cpp.

References Config_getString, OutputGenerator::dir, and m_emptySection.

: OutputGenerator()
{
dir=Config_getString(HTML_OUTPUT);
m_emptySection=FALSE;
}
HtmlGenerator::~HtmlGenerator ( )
virtual

Definition at line 687 of file htmlgen.cpp.

{
//printf("HtmlGenerator::~HtmlGenerator()\n");
}
HtmlGenerator::HtmlGenerator ( const HtmlGenerator &  g)
private

Member Function Documentation

void HtmlGenerator::addIndexItem ( const char *  ,
const char *   
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1853 of file htmlgen.cpp.

{
}
void HtmlGenerator::addWord ( const char *  word,
bool  hiPriority 
)
virtual

Implements CodeOutputInterface.

Definition at line 2672 of file htmlgen.cpp.

References SearchIndexIntf::addWord(), and Doxygen::searchIndex.

{
if (Doxygen::searchIndex)
{
Doxygen::searchIndex->addWord(word,hiPriority);
}
}
void HtmlGenerator::clearBuffer ( )
void HtmlGenerator::codify ( const char *  s)
inlinevirtual

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 98 of file htmlgen.h.

References HtmlCodeGenerator::codify(), and m_codeGen.

{ m_codeGen.codify(text); }
void HtmlGenerator::disable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 90 of file htmlgen.h.

References OutputGenerator::active.

Referenced by disableIf(), and disableIfNot().

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

Implements OutputGenerator.

Definition at line 92 of file htmlgen.h.

References disable(), and OutputGenerator::Html.

{ if (o==Html) disable(); }
void HtmlGenerator::disableIfNot ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 93 of file htmlgen.h.

References disable(), and OutputGenerator::Html.

{ if (o!=Html) disable(); }
void HtmlGenerator::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 1228 of file htmlgen.cpp.

Referenced by endClassDiagram(), startParamList(), startSimpleSect(), writeChar(), writeObjectLink(), and writeStartAnnoItem().

{
docify(str,FALSE);
}
void HtmlGenerator::docify ( const char *  text,
bool  inHtmlComment 
)
private

Definition at line 1233 of file htmlgen.cpp.

References OutputGenerator::t.

{
if (str)
{
const char *p=str;
char c;
while (*p)
{
c=*p++;
switch(c)
{
case '<': t << "&lt;"; break;
case '>': t << "&gt;"; break;
case '&': t << "&amp;"; break;
case '"': t << "&quot;"; break;
case '-': if (inHtmlComment) t << "&#45;"; else t << "-"; break;
case '\\':
if (*p=='<')
{ t << "&lt;"; p++; }
else if (*p=='>')
{ t << "&gt;"; p++; }
else
t << "\\";
break;
default: t << c;
}
}
}
}
void HtmlGenerator::enable ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 88 of file htmlgen.h.

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

Referenced by enableIf().

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

Implements OutputGenerator.

Definition at line 91 of file htmlgen.h.

References enable(), and OutputGenerator::Html.

{ if (o==Html) enable(); }
void HtmlGenerator::endAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 189 of file htmlgen.h.

{}
void HtmlGenerator::endBold ( )
inlinevirtual

End a section of text displayed in bold face.

Implements BaseOutputDocInterface.

Definition at line 219 of file htmlgen.h.

{ t << "</b>"; }
void HtmlGenerator::endCallGraph ( const DotCallGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1776 of file htmlgen.cpp.

References OutputGenerator::dir, endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName, GOF_BITMAP, m_sectionCount, startSectionContent(), startSectionSummary(), OutputGenerator::t, and DotCallGraph::writeGraph().

{
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
g.writeGraph(t,GOF_BITMAP,EOF_Html,dir,fileName,relPath,TRUE,m_sectionCount);
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 245 of file htmlgen.h.

References endl().

{ t << "</center>" << endl; }
void HtmlGenerator::endClassDiagram ( const ClassDiagram &  d,
const char *  fileName,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1350 of file htmlgen.cpp.

References convertToId(), OutputGenerator::dir, docify(), endl(), endSectionContent(), endSectionHeader(), endSectionSummary(), m_sectionCount, startSectionContent(), startSectionSummary(), OutputGenerator::t, and ClassDiagram::writeImage().

{
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
t << " <div class=\"center\">" << endl;
t << " <img src=\"";
t << relPath << fileName << ".png\" usemap=\"#" << convertToId(name);
t << "_map\" alt=\"\"/>" << endl;
t << " <map id=\"" << convertToId(name);
t << "_map\" name=\"";
docify(name);
t << "_map\">" << endl;
d.writeImage(t,dir,relPath,fileName);
t << " </div>";
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endCodeFragment ( )
inlinevirtual

Ends a source code fragment

Implements BaseOutputDocInterface.

Definition at line 215 of file htmlgen.h.

References PREFRAG_END.

{ t << PREFRAG_END; }
void HtmlGenerator::endCodeLine ( )
inlinevirtual

Ends a line of code started with startCodeLine()

Implements CodeOutputInterface.

Definition at line 112 of file htmlgen.h.

References HtmlCodeGenerator::endCodeLine(), and m_codeGen.

{ m_codeGen.endCodeLine(); }
void HtmlGenerator::endConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2469 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</td></tr>" << endl;
}
void HtmlGenerator::endConstraintList ( )
virtual

Implements OutputGenerator.

Definition at line 2474 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</table>" << endl;
t << "</dd>" << endl;
t << "</dl>" << endl;
t << "</div>" << endl;
}
void HtmlGenerator::endConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2449 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</em></td>";
}
void HtmlGenerator::endConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2459 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</em></td>";
}
void HtmlGenerator::endContents ( )
virtual

Implements OutputGenerator.

Definition at line 2236 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</div><!-- contents -->" << endl;
}
void HtmlGenerator::endDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 225 of file htmlgen.h.

{ t << "</dd>\n"; }
void HtmlGenerator::endDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 223 of file htmlgen.h.

{ t << "</dt>"; }
void HtmlGenerator::endDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 221 of file htmlgen.h.

References endl().

{ t << endl << "</dl>\n" << endl; }
void HtmlGenerator::endDescTable ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1871 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</table>" << endl;
}
void HtmlGenerator::endDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1901 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</td>";
}
void HtmlGenerator::endDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1881 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</tr>" << endl;
}
void HtmlGenerator::endDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1891 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "&#160;</td>";
}
void HtmlGenerator::endDirDepGraph ( const DotDirDeps &  g)
virtual

Implements OutputGenerator.

Definition at line 1794 of file htmlgen.cpp.

References OutputGenerator::dir, endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName, GOF_BITMAP, m_sectionCount, startSectionContent(), startSectionSummary(), OutputGenerator::t, and DotDirDeps::writeGraph().

{
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
g.writeGraph(t,GOF_BITMAP,EOF_Html,dir,fileName,relPath,TRUE,m_sectionCount);
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endDotGraph ( const DotClassGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1712 of file htmlgen.cpp.

References Config_getBool, OutputGenerator::dir, endHtmlLink(), endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName, GOF_BITMAP, Doxygen::htmlFileExtension, m_sectionCount, startHtmlLink(), startSectionContent(), startSectionSummary(), OutputGenerator::t, theTranslator, Translator::trLegend(), and DotClassGraph::writeGraph().

{
bool generateLegend = Config_getBool(GENERATE_LEGEND);
bool umlLook = Config_getBool(UML_LOOK);
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
g.writeGraph(t,GOF_BITMAP,EOF_Html,dir,fileName,relPath,TRUE,TRUE,m_sectionCount);
if (generateLegend && !umlLook)
{
t << "<center><span class=\"legend\">[";
startHtmlLink(relPath+"graph_legend"+Doxygen::htmlFileExtension);
t << theTranslator->trLegend();
endHtmlLink();
t << "]</span></center>";
}
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endDoxyAnchor ( const char *  fName,
const char *  anchor 
)
virtual

Implements OutputGenerator.

Definition at line 1039 of file htmlgen.cpp.

{
}
void HtmlGenerator::endEmphasis ( )
inlinevirtual

Ends a section of text displayed in italic.

Implements BaseOutputDocInterface.

Definition at line 217 of file htmlgen.h.

{ t << "</em>"; }
void HtmlGenerator::endFile ( )
virtual

Implements OutputGenerator.

Definition at line 964 of file htmlgen.cpp.

References OutputGenerator::endPlainFile().

{
endPlainFile();
}
void HtmlGenerator::endFontClass ( )
inlinevirtual

Ends a block started with startFontClass()

Implements CodeOutputInterface.

Definition at line 116 of file htmlgen.h.

References HtmlCodeGenerator::endFontClass(), and m_codeGen.

{ m_codeGen.endFontClass(); }
void HtmlGenerator::endGroupCollaboration ( const DotGroupCollaboration &  g)
virtual

Implements OutputGenerator.

Definition at line 1758 of file htmlgen.cpp.

References OutputGenerator::dir, endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName, GOF_BITMAP, m_sectionCount, startSectionContent(), startSectionSummary(), OutputGenerator::t, and DotGroupCollaboration::writeGraph().

{
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
g.writeGraph(t,GOF_BITMAP,EOF_Html,dir,fileName,relPath,TRUE,m_sectionCount);
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1185 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
if (extraIndentLevel==2)
{
t << "</h4>" << endl;
}
else if (extraIndentLevel==1)
{
t << "</h3>" << endl;
}
else
{
t << "</h2>" << endl;
}
}
void HtmlGenerator::endHeaderSection ( )
virtual

Implements OutputGenerator.

Definition at line 2511 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</div><!--header-->" << endl;
}
void HtmlGenerator::endHtmlLink ( )
virtual

Ends a link started by startHtmlLink().

Implements BaseOutputDocInterface.

Definition at line 1164 of file htmlgen.cpp.

References OutputGenerator::t.

Referenced by endDotGraph().

{
t << "</a>";
}
void HtmlGenerator::endInclDepGraph ( const DotInclDepGraph &  g)
virtual

Implements OutputGenerator.

Definition at line 1740 of file htmlgen.cpp.

References OutputGenerator::dir, endSectionContent(), endSectionHeader(), endSectionSummary(), EOF_Html, OutputGenerator::fileName, GOF_BITMAP, m_sectionCount, startSectionContent(), startSectionSummary(), OutputGenerator::t, and DotInclDepGraph::writeGraph().

{
endSectionHeader(t);
startSectionSummary(t,m_sectionCount);
endSectionSummary(t);
startSectionContent(t,m_sectionCount);
g.writeGraph(t,GOF_BITMAP,EOF_Html,dir,fileName,relPath,TRUE,m_sectionCount);
endSectionContent(t);
m_sectionCount++;
}
void HtmlGenerator::endIndent ( )
virtual

Implements OutputGenerator.

Definition at line 1847 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endIndent -->" << endl;)
t << endl << "</div>" << endl << "</div>" << endl;
}
void HtmlGenerator::endIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1097 of file htmlgen.cpp.

References OutputGenerator::t.

{
//printf("HtmlGenerator::endIndexItem(%s,%s,%s)\n",ref,f,name);
if (ref || f)
{
t << "</a>";
}
else
{
t << "</b>";
}
}
void HtmlGenerator::endIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1532 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</td>";
}
void HtmlGenerator::endIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 1521 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</table>" << endl;
}
void HtmlGenerator::endIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 1068 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</li>" << endl;
}
void HtmlGenerator::endIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 133 of file htmlgen.h.

{}
void HtmlGenerator::endIndexValue ( const char *  ,
bool   
)
virtual

Implements OutputGenerator.

Definition at line 1543 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</td></tr>" << endl;
}
void HtmlGenerator::endInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2526 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</h3></td></tr>" << endl;
}
void HtmlGenerator::endInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2576 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endInlineMemberDoc -->" << endl;)
t << "</td></tr>" << endl;
}
void HtmlGenerator::endInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2564 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endInlineMemberName -->" << endl;)
t << "</td>" << endl;
}
void HtmlGenerator::endInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2552 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endInlineMemberType -->" << endl;)
t << "</td>" << endl;
}
void HtmlGenerator::endItemList ( )
inlinevirtual

Ends a bullet list: e.g. </ul> in html

Implements BaseOutputDocInterface.

Definition at line 155 of file htmlgen.h.

References endl().

{ t << "</ul>" << endl; }
void HtmlGenerator::endItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 172 of file htmlgen.h.

{ t << "</li>\n"; }
void HtmlGenerator::endLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2596 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endLabels -->" << endl;)
t << "</span>";
}
void HtmlGenerator::endMemberDeclaration ( const char *  anchor,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 2654 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<tr class=\"separator:" << anchor;
if (inheritId)
{
t << " inherit " << inheritId;
}
t << "\"><td class=\"memSeparator\" colspan=\"2\">&#160;</td></tr>\n";
}
void HtmlGenerator::endMemberDescription ( )
virtual

Implements OutputGenerator.

Definition at line 1455 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDescription -->" << endl)
t << "<br /></td></tr>" << endl;
}
void HtmlGenerator::endMemberDoc ( bool  hasArgs)
virtual

Implements OutputGenerator.

Definition at line 1696 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDoc -->" << endl;)
if (!hasArgs)
{
t << " </tr>" << endl;
}
t << " </table>" << endl;
// t << "</div>" << endl;
}
void HtmlGenerator::endMemberDocList ( )
virtual

Implements OutputGenerator.

Definition at line 1553 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDocList -->" << endl;)
}
void HtmlGenerator::endMemberDocName ( )
virtual

Implements OutputGenerator.

Definition at line 1598 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDocName -->" << endl;)
t << "</td>" << endl;
}
void HtmlGenerator::endMemberDocPrefixItem ( )
virtual

Implements OutputGenerator.

Definition at line 1582 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDocPrefixItem -->" << endl;)
t << "</div>" << endl;
}
void HtmlGenerator::endMemberDocSimple ( bool  )
virtual

Implements OutputGenerator.

Definition at line 2540 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberDocSimple -->" << endl;)
t << "</table>" << endl;
}
void HtmlGenerator::endMemberGroup ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1836 of file htmlgen.cpp.

{
}
void HtmlGenerator::endMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1827 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</div></td></tr>" << endl;
}
void HtmlGenerator::endMemberGroupHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1817 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</div></td></tr>" << endl;
}
void HtmlGenerator::endMemberHeader ( )
virtual

Implements OutputGenerator.

Definition at line 1498 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberHeader -->" << endl)
t << "</h2></td></tr>" << endl;
}
void HtmlGenerator::endMemberItem ( )
virtual

Implements OutputGenerator.

Definition at line 1410 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</td></tr>";
t << endl;
}
void HtmlGenerator::endMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1378 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberList -->" << endl)
}
void HtmlGenerator::endMemberSections ( )
virtual

Implements OutputGenerator.

Definition at line 1469 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

{
DBG_HTML(t << "<!-- endMemberSections -->" << endl)
if (!m_emptySection)
{
t << "</table>" << endl;
}
}
void HtmlGenerator::endMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 1510 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endMemberSubtitle -->" << endl)
t << "</td></tr>" << endl;
}
void HtmlGenerator::endMemberTemplateParams ( const char *  anchor,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 1420 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</td></tr>" << endl;
t << "<tr class=\"memitem:" << anchor;
if (inheritId)
{
t << " inherit " << inheritId;
}
t << "\"><td class=\"memTemplItemLeft\" align=\"right\" valign=\"top\">";
}
void HtmlGenerator::endPageRef ( const char *  ,
const char *   
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 264 of file htmlgen.h.

{}
void HtmlGenerator::endParagraph ( )
virtual

Ends a paragraph

Implements BaseOutputDocInterface.

Definition at line 1053 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</p>" << endl;
}
void HtmlGenerator::endParameterList ( )
virtual

Implements OutputGenerator.

Definition at line 1673 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endParameterList -->" << endl;)
t << "</td>" << endl;
t << " </tr>" << endl;
}
void HtmlGenerator::endParameterName ( bool  last,
bool  emptyList,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 1643 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endParameterName -->" << endl;)
if (last)
{
if (emptyList)
{
if (closeBracket) t << "</td><td>)";
t << "</td>" << endl;
t << " <td>";
}
else
{
t << "&#160;</td>" << endl;
t << " </tr>" << endl;
t << " <tr>" << endl;
t << " <td></td>" << endl;
t << " <td>";
if (closeBracket) t << ")";
t << "</td>" << endl;
t << " <td></td><td>";
}
}
else
{
t << "</td>" << endl;
t << " </tr>" << endl;
}
}
void HtmlGenerator::endParameterType ( )
virtual

Implements OutputGenerator.

Definition at line 1631 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- endParameterType -->" << endl;)
t << "&#160;</td>" << endl;
}
void HtmlGenerator::endParamList ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1935 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</dl>";
}
void HtmlGenerator::endProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 974 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</h3>";
}
void HtmlGenerator::endQuickIndices ( )
virtual

Implements OutputGenerator.

Definition at line 2187 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "</div><!-- top -->" << endl;
}
void HtmlGenerator::endSection ( const char *  ,
SectionInfo::SectionType  type 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1215 of file htmlgen.cpp.

References SectionInfo::Page, SectionInfo::Paragraph, SectionInfo::Section, SectionInfo::Subsection, SectionInfo::Subsubsection, and OutputGenerator::t.

{
switch(type)
{
case SectionInfo::Page: t << "</h1>"; break;
case SectionInfo::Section: t << "</h2>"; break;
case SectionInfo::Subsection: t << "</h3>"; break;
case SectionInfo::Subsubsection: t << "</h4>"; break;
case SectionInfo::Paragraph: t << "</h5>"; break;
default: ASSERT(0); break;
}
}
void HtmlGenerator::endSimpleSect ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1922 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</dl>";
}
void HtmlGenerator::endSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 247 of file htmlgen.h.

References endl().

{ t << "</small>" << endl; }
void HtmlGenerator::endSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 241 of file htmlgen.h.

References endl().

{ t << "</h2>" << endl; }
void HtmlGenerator::endSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 243 of file htmlgen.h.

References endl().

{ t << "</h3>" << endl; }
void HtmlGenerator::endTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 299 of file htmlgen.h.

{ t << "</div>"; }
void HtmlGenerator::endTextLink ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1149 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "</a>";
}
void HtmlGenerator::endTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 141 of file htmlgen.h.

Referenced by endTitleHead().

{ t << "</div>"; }
void HtmlGenerator::endTitleHead ( const char *  ,
const char *   
)
virtual

Implements OutputGenerator.

Definition at line 2505 of file htmlgen.cpp.

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

{
endTitle();
t << " </div>" << endl;
}
void HtmlGenerator::endTypewriter ( )
inlinevirtual

End a section of text displayed in typewriter style.

Implements BaseOutputDocInterface.

Definition at line 168 of file htmlgen.h.

{ t << "</code>"; }
void HtmlGenerator::exceptionEntry ( const char *  prefix,
bool  closeBracket 
)
virtual

Implements OutputGenerator.

Definition at line 1680 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- exceptionEntry -->" << endl;)
t << "</td>" << endl;
t << " </tr>" << endl;
t << " <tr>" << endl;
t << " <td align=\"right\">";
// colspan 2 so it gets both parameter type and parameter name columns
if (prefix)
t << prefix << "</td><td>(</td><td colspan=\"2\">";
else if (closeBracket)
t << "</td><td>)</td><td></td><td>";
else
t << "</td><td></td><td colspan=\"2\">";
}
OutputGenerator* HtmlGenerator::get ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 95 of file htmlgen.h.

References OutputGenerator::Html.

{ return (o==Html) ? this : 0; }
void HtmlGenerator::init ( )
static

Definition at line 692 of file htmlgen.cpp.

References Config_getBool, Config_getString, ResourceMgr::copyResource(), createSubDirs(), endl(), err(), fileToString(), g_footer, g_header, g_mathjax_code, ResourceMgr::getAsString(), ResourceMgr::instance(), and OutputGenerator::t.

Referenced by generateOutput().

{
QCString dname=Config_getString(HTML_OUTPUT);
QDir d(dname);
if (!d.exists() && !d.mkdir(dname))
{
err("Could not create output directory %s\n",dname.data());
exit(1);
}
//writeLogo(dname);
if (!Config_getString(HTML_HEADER).isEmpty())
{
g_header=fileToString(Config_getString(HTML_HEADER));
//printf("g_header='%s'\n",g_header.data());
}
else
{
g_header = ResourceMgr::instance().getAsString("header.html");
}
if (!Config_getString(HTML_FOOTER).isEmpty())
{
g_footer=fileToString(Config_getString(HTML_FOOTER));
//printf("g_footer='%s'\n",g_footer.data());
}
else
{
g_footer = ResourceMgr::instance().getAsString("footer.html");
}
if (Config_getBool(USE_MATHJAX))
{
if (!Config_getString(MATHJAX_CODEFILE).isEmpty())
{
g_mathjax_code=fileToString(Config_getString(MATHJAX_CODEFILE));
//printf("g_mathjax_code='%s'\n",g_mathjax_code.data());
}
}
createSubDirs(d);
ResourceMgr &mgr = ResourceMgr::instance();
mgr.copyResource("tabs.css",dname);
mgr.copyResource("jquery.js",dname);
if (Config_getBool(INTERACTIVE_SVG))
{
mgr.copyResource("svgpan.js",dname);
}
if (!Config_getBool(DISABLE_INDEX))
{
mgr.copyResource("menu.js",dname);
}
{
QFile f(dname+"/dynsections.js");
if (f.open(IO_WriteOnly))
{
FTextStream t(&f);
t << mgr.getAsString("dynsections.js");
if (Config_getBool(SOURCE_BROWSER) && Config_getBool(SOURCE_TOOLTIPS))
{
t << endl <<
"$(document).ready(function() {\n"
" $('.code,.codeRef').each(function() {\n"
" $(this).data('powertip',$('#'+$(this).attr('href').replace(/.*\\//,'').replace(/[^a-z_A-Z0-9]/g,'_')).html());\n"
" $(this).powerTip({ placement: 's', smartPlacement: true, mouseOnToPopup: true });\n"
" });\n"
"});\n";
}
}
}
}
void HtmlGenerator::insertMemberAlign ( bool  templ)
virtual

Implements OutputGenerator.

Definition at line 1432 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- insertMemberAlign -->" << endl)
QCString className = templ ? "memTemplItemRight" : "memItemRight";
t << "&#160;</td><td class=\"" << className << "\" valign=\"bottom\">";
}
bool HtmlGenerator::isEnabled ( OutputType  o)
inlinevirtual

Implements OutputGenerator.

Definition at line 94 of file htmlgen.h.

References OutputGenerator::active, and OutputGenerator::Html.

{ return (o==Html && active); }
void HtmlGenerator::lastIndexPage ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 301 of file htmlgen.h.

{}
void HtmlGenerator::lineBreak ( const char *  style)
virtual

Implements BaseOutputDocInterface.

Definition at line 2482 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
if (style)
{
t << "<br class=\"" << style << "\" />" << endl;
}
else
{
t << "<br />" << endl;
}
}
HtmlGenerator& HtmlGenerator::operator= ( const HtmlGenerator &  g)
private
void HtmlGenerator::setCurrentDoc ( Definition *  context,
const char *  anchor,
bool  isSourceFile 
)
virtual

Implements CodeOutputInterface.

Definition at line 2664 of file htmlgen.cpp.

References Doxygen::searchIndex, and SearchIndexIntf::setCurrentDoc().

{
if (Doxygen::searchIndex)
{
Doxygen::searchIndex->setCurrentDoc(context,anchor,isSourceFile);
}
}
void HtmlGenerator::startAnonTypeScope ( int  )
inlinevirtual

Implements OutputGenerator.

Definition at line 188 of file htmlgen.h.

{}
void HtmlGenerator::startBold ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 218 of file htmlgen.h.

{ t << "<b>"; }
void HtmlGenerator::startCallGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1771 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startCenter ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 244 of file htmlgen.h.

References endl().

{ t << "<center>" << endl; }
void HtmlGenerator::startClassDiagram ( )
virtual

Implements OutputGenerator.

Definition at line 1345 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startCodeFragment ( )
inlinevirtual

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 214 of file htmlgen.h.

References PREFRAG_START.

{ t << PREFRAG_START; }
void HtmlGenerator::startCodeLine ( bool  hasLineNumbers)
inlinevirtual

Implements CodeOutputInterface.

Definition at line 110 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::startCodeLine().

{ m_codeGen.startCodeLine(hasLineNumbers); }
void HtmlGenerator::startConstraintDocs ( )
virtual

Implements OutputGenerator.

Definition at line 2464 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<td>&#160;";
}
void HtmlGenerator::startConstraintList ( const char *  header)
virtual

Implements OutputGenerator.

Definition at line 2437 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "<div class=\"typeconstraint\">" << endl;
t << "<dl><dt><b>" << header << "</b></dt><dd>" << endl;
t << "<table border=\"0\" cellspacing=\"2\" cellpadding=\"0\">" << endl;
}
void HtmlGenerator::startConstraintParam ( )
virtual

Implements OutputGenerator.

Definition at line 2444 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<tr><td valign=\"top\"><em>";
}
void HtmlGenerator::startConstraintType ( )
virtual

Implements OutputGenerator.

Definition at line 2454 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<td>&#160;:</td><td valign=\"top\"><em>";
}
void HtmlGenerator::startContents ( )
virtual

Implements OutputGenerator.

Definition at line 2231 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "<div class=\"contents\">" << endl;
}
void HtmlGenerator::startDescForItem ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 224 of file htmlgen.h.

{ t << "<dd>"; }
void HtmlGenerator::startDescItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 222 of file htmlgen.h.

{ t << "<dt>"; }
void HtmlGenerator::startDescription ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 220 of file htmlgen.h.

References endl().

{ t << endl << "<dl>" << endl; }
void HtmlGenerator::startDescTable ( const char *  title)
virtual

Implements BaseOutputDocInterface.

Definition at line 1866 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "<table class=\"fieldtable\">" << endl
<< "<tr><th colspan=\"2\">" << title << "</th></tr>";
}
void HtmlGenerator::startDescTableData ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1896 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<td class=\"fielddoc\">";
}
void HtmlGenerator::startDescTableRow ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1876 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<tr>";
}
void HtmlGenerator::startDescTableTitle ( )
virtual

Implements BaseOutputDocInterface.

Definition at line 1886 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<td class=\"fieldname\">";
}
void HtmlGenerator::startDirDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1789 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startDotGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1707 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startDoxyAnchor ( const char *  fName,
const char *  manName,
const char *  anchor,
const char *  name,
const char *  args 
)
virtual

Implements OutputGenerator.

Definition at line 1032 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<a id=\"" << anchor << "\"></a>";
}
void HtmlGenerator::startEmphasis ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 216 of file htmlgen.h.

{ t << "<em>"; }
void HtmlGenerator::startFile ( const char *  name,
const char *  manName,
const char *  title 
)
virtual

Implements OutputGenerator.

Definition at line 859 of file htmlgen.cpp.

References IndexList::addIndexFile(), Config_getBool, convertToHtml(), endl(), OutputGenerator::fileName, filterTitle(), g_header, Doxygen::htmlFileExtension, Doxygen::indexList, lastFile, lastTitle, m_codeGen, m_sectionCount, relativePathToRoot(), HtmlCodeGenerator::setRelativePath(), HtmlCodeGenerator::setTextStream(), OutputGenerator::startPlainFile(), substituteHtmlKeywords(), OutputGenerator::t, theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), and versionString.

{
//printf("HtmlGenerator::startFile(%s)\n",name);
QCString fileName=name;
lastTitle=title;
relPath = relativePathToRoot(fileName);
if (fileName.right(Doxygen::htmlFileExtension.length())!=Doxygen::htmlFileExtension)
{
fileName+=Doxygen::htmlFileExtension;
}
startPlainFile(fileName);
m_codeGen.setTextStream(t);
m_codeGen.setRelativePath(relPath);
Doxygen::indexList->addIndexFile(fileName);
lastFile = fileName;
t << substituteHtmlKeywords(g_header,convertToHtml(filterTitle(title)),relPath);
t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
<< versionString << " -->" << endl;
//static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
static bool searchEngine = Config_getBool(SEARCHENGINE);
if (searchEngine /*&& !generateTreeView*/)
{
t << "<script type=\"text/javascript\">\n";
t << "var searchBox = new SearchBox(\"searchBox\", \""
<< relPath<< "search\",false,'" << theTranslator->trSearch() << "');\n";
t << "</script>\n";
}
//generateDynamicSections(t,relPath);
m_sectionCount=0;
}
void HtmlGenerator::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 114 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::startFontClass().

{ m_codeGen.startFontClass(s); }
void HtmlGenerator::startGroupCollaboration ( )
virtual

Implements OutputGenerator.

Definition at line 1753 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startGroupHeader ( int  extraIndentLevel)
virtual

Implements OutputGenerator.

Definition at line 1169 of file htmlgen.cpp.

References OutputGenerator::t.

{
if (extraIndentLevel==2)
{
t << "<h4 class=\"groupheader\">";
}
else if (extraIndentLevel==1)
{
t << "<h3 class=\"groupheader\">";
}
else // extraIndentLevel==0
{
t << "<h2 class=\"groupheader\">";
}
}
void HtmlGenerator::startHeaderSection ( )
virtual

Implements OutputGenerator.

Definition at line 2494 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "<div class=\"header\">" << endl;
}
void HtmlGenerator::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 1154 of file htmlgen.cpp.

References Config_getBool, and OutputGenerator::t.

Referenced by endDotGraph().

{
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
t << "<a ";
if (generateTreeView) t << "target=\"top\" ";
t << "href=\"";
if (url) t << url;
t << "\">";
}
void HtmlGenerator::startInclDepGraph ( )
virtual

Implements OutputGenerator.

Definition at line 1735 of file htmlgen.cpp.

References m_sectionCount, startSectionHeader(), and OutputGenerator::t.

{
startSectionHeader(t,relPath,m_sectionCount);
}
void HtmlGenerator::startIndent ( )
virtual

Implements OutputGenerator.

Definition at line 1840 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startIndent -->" << endl;)
t << "<div class=\"memdoc\">\n";
}
void HtmlGenerator::startIndexItem ( const char *  ref,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 1073 of file htmlgen.cpp.

References externalLinkTarget(), externalRef(), Doxygen::htmlFileExtension, and OutputGenerator::t.

{
//printf("HtmlGenerator::startIndexItem(%s,%s)\n",ref,f);
if (ref || f)
{
if (ref)
{
t << "<a class=\"elRef\" ";
t << externalLinkTarget() << externalRef(relPath,ref,FALSE);
}
else
{
t << "<a class=\"el\" ";
}
t << "href=\"";
t << externalRef(relPath,ref,TRUE);
if (f) t << f << Doxygen::htmlFileExtension << "\">";
}
else
{
t << "<b>";
}
}
void HtmlGenerator::startIndexKey ( )
virtual

Implements OutputGenerator.

Definition at line 1526 of file htmlgen.cpp.

References OutputGenerator::t.

{
// inserted 'class = ...', 02 jan 2002, jh
t << " <tr><td class=\"indexkey\">";
}
void HtmlGenerator::startIndexList ( )
virtual

Implements OutputGenerator.

Definition at line 1516 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << "<table>" << endl;
}
void HtmlGenerator::startIndexListItem ( )
virtual

Implements OutputGenerator.

Definition at line 1063 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<li>";
}
void HtmlGenerator::startIndexSection ( IndexSections  )
inlinevirtual

Implements OutputGenerator.

Definition at line 132 of file htmlgen.h.

{}
void HtmlGenerator::startIndexValue ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1537 of file htmlgen.cpp.

References OutputGenerator::t.

{
// inserted 'class = ...', 02 jan 2002, jh
t << "<td class=\"indexvalue\">";
}
void HtmlGenerator::startInlineHeader ( )
virtual

Implements OutputGenerator.

Definition at line 2516 of file htmlgen.cpp.

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

{
if (m_emptySection)
{
t << "<table class=\"memberdecls\">" << endl;
m_emptySection=FALSE;
}
t << "<tr><td colspan=\"2\"><h3>";
}
void HtmlGenerator::startInlineMemberDoc ( )
virtual

Implements OutputGenerator.

Definition at line 2570 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startInlineMemberDoc -->" << endl;)
t << "<td class=\"fielddoc\">" << endl;
}
void HtmlGenerator::startInlineMemberName ( )
virtual

Implements OutputGenerator.

Definition at line 2558 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startInlineMemberName -->" << endl;)
t << "<td class=\"fieldname\">" << endl;
}
void HtmlGenerator::startInlineMemberType ( )
virtual

Implements OutputGenerator.

Definition at line 2546 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startInlineMemberType -->" << endl;)
t << "<tr><td class=\"fieldtype\">" << endl;
}
void HtmlGenerator::startItemList ( )
inlinevirtual

Start of a bullet list: e.g. <ul> in html. startItemListItem() is Used for the bullet items.

Implements BaseOutputDocInterface.

Definition at line 154 of file htmlgen.h.

References endl().

{ t << "<ul>" << endl; }
void HtmlGenerator::startItemListItem ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 171 of file htmlgen.h.

{ t << "<li>"; }
void HtmlGenerator::startLabels ( )
virtual

Implements OutputGenerator.

Definition at line 2582 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startLabels -->" << endl;)
t << "<span class=\"mlabels\">";
}
void HtmlGenerator::startMemberDeclaration ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 205 of file htmlgen.h.

{}
void HtmlGenerator::startMemberDescription ( const char *  anchor,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 1439 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

{
DBG_HTML(t << "<!-- startMemberDescription -->" << endl)
if (m_emptySection)
{
t << "<table class=\"memberdecls\">" << endl;
m_emptySection=FALSE;
}
t << "<tr class=\"memdesc:" << anchor;
if (inheritId)
{
t << " inherit " << inheritId;
}
t << "\"><td class=\"mdescLeft\">&#160;</td><td class=\"mdescRight\">";
}
void HtmlGenerator::startMemberDoc ( const char *  clName,
const char *  memName,
const char *  anchor,
const char *  title,
int  memCount,
int  memTotal,
bool  showInline 
)
virtual

Implements OutputGenerator.

Definition at line 1558 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberDoc -->" << endl;)
t << "\n<h2 class=\"memtitle\">"
<< "<span class=\"permalink\"><a href=\"#" << anchor << "\">&sect;&nbsp;</a></span>"
<< title;
if (memTotal>1)
{
t << " <span class=\"overload\">[" << memCount << "/" << memTotal <<"]</span>";
}
t << "</h2>"
<< endl;
t << "\n<div class=\"memitem\">" << endl;
t << "<div class=\"memproto\">" << endl;
}
void HtmlGenerator::startMemberDocList ( )
virtual

Implements OutputGenerator.

Definition at line 1548 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberDocList -->" << endl;)
}
void HtmlGenerator::startMemberDocName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1588 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberDocName -->" << endl;)
t << " <table class=\"memname\">" << endl;
t << " <tr>" << endl;
t << " <td class=\"memname\">";
}
void HtmlGenerator::startMemberDocPrefixItem ( )
virtual

Implements OutputGenerator.

Definition at line 1576 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberDocPrefixItem -->" << endl;)
t << "<div class=\"memtemplate\">" << endl;
}
void HtmlGenerator::startMemberDocSimple ( bool  isEnum)
virtual

Implements OutputGenerator.

Definition at line 2531 of file htmlgen.cpp.

References DBG_HTML, endl(), OutputGenerator::t, theTranslator, Translator::trCompoundMembers(), and Translator::trEnumerationValues().

{
DBG_HTML(t << "<!-- startMemberDocSimple -->" << endl;)
t << "<table class=\"fieldtable\">" << endl;
t << "<tr><th colspan=\"" << (isEnum?"2":"3") << "\">";
t << (isEnum? theTranslator->trEnumerationValues() :
theTranslator->trCompoundMembers()) << "</th></tr>" << endl;
}
void HtmlGenerator::startMemberGroup ( )
virtual

Implements OutputGenerator.

Definition at line 1832 of file htmlgen.cpp.

{
}
void HtmlGenerator::startMemberGroupDocs ( )
virtual

Implements OutputGenerator.

Definition at line 1822 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<tr><td colspan=\"2\"><div class=\"groupText\">";
}
void HtmlGenerator::startMemberGroupHeader ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1812 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<tr><td colspan=\"2\"><div class=\"groupHeader\">";
}
void HtmlGenerator::startMemberHeader ( const char *  anchor)
virtual

Implements OutputGenerator.

Definition at line 1478 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

{
DBG_HTML(t << "<!-- startMemberHeader -->" << endl)
if (!m_emptySection)
{
t << "</table>";
m_emptySection=TRUE;
}
if (m_emptySection)
{
t << "<table class=\"memberdecls\">" << endl;
m_emptySection=FALSE;
}
t << "<tr class=\"heading\"><td colspan=\"2\"><h2 class=\"groupheader\">";
if (anchor)
{
t << "<a name=\"" << anchor << "\"></a>" << endl;
}
}
void HtmlGenerator::startMemberItem ( const char *  anchor,
int  annoType,
const char *  inheritId 
)
virtual

Implements OutputGenerator.

Definition at line 1387 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

{
DBG_HTML(t << "<!-- startMemberItem() -->" << endl)
if (m_emptySection)
{
t << "<table class=\"memberdecls\">" << endl;
m_emptySection=FALSE;
}
t << "<tr class=\"memitem:" << anchor;
if (inheritId)
{
t << " inherit " << inheritId;
}
t << "\">";
switch(annoType)
{
case 0: t << "<td class=\"memItemLeft\" align=\"right\" valign=\"top\">"; break;
case 1: t << "<td class=\"memItemLeft\" >"; break;
case 2: t << "<td class=\"memItemLeft\" valign=\"top\">"; break;
default: t << "<td class=\"memTemplParams\" colspan=\"2\">"; break;
}
}
void HtmlGenerator::startMemberList ( )
virtual

Implements OutputGenerator.

Definition at line 1373 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberList -->" << endl)
}
void HtmlGenerator::startMemberSections ( )
virtual

Implements OutputGenerator.

Definition at line 1461 of file htmlgen.cpp.

References DBG_HTML, endl(), m_emptySection, and OutputGenerator::t.

{
DBG_HTML(t << "<!-- startMemberSections -->" << endl)
m_emptySection=TRUE; // we postpone writing <table> until we actually
// write a row to prevent empty tables, which
// are not valid XHTML!
}
void HtmlGenerator::startMemberSubtitle ( )
virtual

Implements OutputGenerator.

Definition at line 1504 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startMemberSubtitle -->" << endl)
t << "<tr><td class=\"ititle\" colspan=\"2\">";
}
void HtmlGenerator::startMemberTemplateParams ( )
virtual

Implements OutputGenerator.

Definition at line 1416 of file htmlgen.cpp.

{
}
void HtmlGenerator::startPageRef ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 263 of file htmlgen.h.

{}
void HtmlGenerator::startParagraph ( )
virtual

Starts a new paragraph

Starts a new paragraph

Implements BaseOutputDocInterface.

Definition at line 1048 of file htmlgen.cpp.

References endl(), and OutputGenerator::t.

{
t << endl << "<p>";
}
void HtmlGenerator::startParameterList ( bool  openBracket)
virtual

Implements OutputGenerator.

Definition at line 1604 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startParameterList -->" << endl;)
t << " <td>";
if (openBracket) t << "(";
t << "</td>" << endl;
}
void HtmlGenerator::startParameterName ( bool  )
virtual

Implements OutputGenerator.

Definition at line 1637 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- startParameterName -->" << endl;)
t << " <td class=\"paramname\">";
}
void HtmlGenerator::startParameterType ( bool  first,
const char *  key 
)
virtual

Implements OutputGenerator.

Definition at line 1612 of file htmlgen.cpp.

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

{
if (first)
{
DBG_HTML(t << "<!-- startFirstParameterType -->" << endl;)
t << " <td class=\"paramtype\">";
}
else
{
DBG_HTML(t << "<!-- startParameterType -->" << endl;)
t << " <tr>" << endl;
t << " <td class=\"paramkey\">";
if (key) t << key;
t << "</td>" << endl;
t << " <td></td>" << endl;
t << " <td class=\"paramtype\">";
}
}
void HtmlGenerator::startParamList ( ParamListTypes  ,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1927 of file htmlgen.cpp.

References docify(), and OutputGenerator::t.

{
t << "<dl><dt><b>";
docify(title);
t << "</b></dt>";
}
void HtmlGenerator::startProjectNumber ( )
virtual

Implements OutputGenerator.

Definition at line 969 of file htmlgen.cpp.

References OutputGenerator::t.

{
t << "<h3 class=\"version\">";
}
void HtmlGenerator::startQuickIndices ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 265 of file htmlgen.h.

{}
void HtmlGenerator::startSection ( const char *  lab,
const char *  ,
SectionInfo::SectionType  type 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1201 of file htmlgen.cpp.

References SectionInfo::Page, SectionInfo::Paragraph, SectionInfo::Section, SectionInfo::Subsection, SectionInfo::Subsubsection, and OutputGenerator::t.

{
switch(type)
{
case SectionInfo::Page: t << "\n\n<h1>"; break;
case SectionInfo::Section: t << "\n\n<h2>"; break;
case SectionInfo::Subsection: t << "\n\n<h3>"; break;
case SectionInfo::Subsubsection: t << "\n\n<h4>"; break;
case SectionInfo::Paragraph: t << "\n\n<h5>"; break;
default: ASSERT(0); break;
}
t << "<a id=\"" << lab << "\"></a>";
}
void HtmlGenerator::startSimpleSect ( SectionTypes  ,
const char *  filename,
const char *  anchor,
const char *  title 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1906 of file htmlgen.cpp.

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

{
t << "<dl><dt><b>";
if (filename)
{
writeObjectLink(0,filename,anchor,title);
}
else
{
docify(title);
}
t << "</b></dt>";
}
void HtmlGenerator::startSmall ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 246 of file htmlgen.h.

References endl().

{ t << "<small>" << endl; }
void HtmlGenerator::startSubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 240 of file htmlgen.h.

{ t << "<h2>"; }
void HtmlGenerator::startSubsubsection ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 242 of file htmlgen.h.

{ t << "<h3>"; }
void HtmlGenerator::startTextBlock ( bool  )
inlinevirtual

Implements OutputGenerator.

Definition at line 297 of file htmlgen.h.

{ t << "<div class=\"textblock\">"; }
void HtmlGenerator::startTextLink ( const char *  file,
const char *  anchor 
)
virtual

Implements BaseOutputDocInterface.

Definition at line 1141 of file htmlgen.cpp.

References Doxygen::htmlFileExtension, and OutputGenerator::t.

{
t << "<a href=\"";
if (f) t << relPath << f << Doxygen::htmlFileExtension;
if (anchor) t << "#" << anchor;
t << "\">";
}
void HtmlGenerator::startTitle ( )
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 140 of file htmlgen.h.

Referenced by startTitleHead().

{ t << "<div class=\"title\">"; }
void HtmlGenerator::startTitleHead ( const char *  )
virtual

Implements OutputGenerator.

Definition at line 2499 of file htmlgen.cpp.

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

{
t << " <div class=\"headertitle\">" << endl;
startTitle();
}
void HtmlGenerator::startTypewriter ( )
inlinevirtual

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

Implements BaseOutputDocInterface.

Definition at line 167 of file htmlgen.h.

{ t << "<code>"; }
void HtmlGenerator::writeAnchor ( const char *  ,
const char *  name 
)
inlinevirtual

Implements BaseOutputDocInterface.

Definition at line 212 of file htmlgen.h.

{ t << "<a name=\"" << name <<"\" id=\"" << name << "\"></a>"; }
void HtmlGenerator::writeChar ( char  c)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1263 of file htmlgen.cpp.

References docify().

{
char cs[2];
cs[0]=c;
cs[1]=0;
docify(cs);
}
void HtmlGenerator::writeCodeAnchor ( const char *  name)
inlinevirtual

Write an anchor to a source listing.

Parameters
nameThe name of the anchor.

Implements CodeOutputInterface.

Definition at line 118 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeCodeAnchor().

{ m_codeGen.writeCodeAnchor(anchor); }
void HtmlGenerator::writeCodeLink ( const char *  ref,
const char *  file,
const char *  anchor,
const char *  name,
const char *  tooltip 
)
inlinevirtual

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 100 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeCodeLink().

{ m_codeGen.writeCodeLink(ref,file,anchor,name,tooltip); }
void HtmlGenerator::writeDoc ( DocNode *  n,
Definition *  ctx,
MemberDef *   
)
virtual

Implements OutputGenerator.

Definition at line 1940 of file htmlgen.cpp.

References DocNode::accept(), m_codeGen, and OutputGenerator::t.

{
HtmlDocVisitor *visitor = new HtmlDocVisitor(t,m_codeGen,ctx);
n->accept(visitor);
delete visitor;
}
void HtmlGenerator::writeEndAnnoItem ( const char *  )
inlinevirtual

Implements OutputGenerator.

Definition at line 239 of file htmlgen.h.

References endl().

{ t << endl; }
void HtmlGenerator::writeExternalSearchPage ( )
static

Definition at line 2333 of file htmlgen.cpp.

References Config_getBool, Config_getList, Config_getString, endl(), err(), OutputGenerator::fileName, g_header, ResourceMgr::getAsString(), HLI_Search, Doxygen::htmlFileExtension, ResourceMgr::instance(), substituteHtmlKeywords(), OutputGenerator::t, theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), versionString, writeDefaultQuickLinks(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

{
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
static bool disableIndex = Config_getBool(DISABLE_INDEX);
QCString fileName = Config_getString(HTML_OUTPUT)+"/search"+Doxygen::htmlFileExtension;
QFile f(fileName);
if (f.open(IO_WriteOnly))
{
FTextStream t(&f);
t << substituteHtmlKeywords(g_header,"Search","");
t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
<< versionString << " -->" << endl;
t << "<script type=\"text/javascript\">\n";
t << "var searchBox = new SearchBox(\"searchBox\", \""
<< "search\",false,'" << theTranslator->trSearch() << "');\n";
t << "</script>\n";
if (!Config_getBool(DISABLE_INDEX))
{
writeDefaultQuickLinks(t,TRUE,HLI_Search,0,"");
t << " <input type=\"text\" id=\"MSearchField\" name=\"query\" value=\"\" size=\"20\" accesskey=\"S\" onfocus=\"searchBox.OnSearchFieldFocus(true)\" onblur=\"searchBox.OnSearchFieldFocus(false)\"/>\n";
t << " </form>\n";
t << " </div><div class=\"right\"></div>\n";
t << " </div>\n";
t << " </li>\n";
t << " </ul>\n";
t << " </div>\n";
t << "</div>\n";
}
else
{
t << "</div>" << endl;
}
t << writeSplitBarAsString("search","");
t << "<div class=\"header\">" << endl;
t << " <div class=\"headertitle\">" << endl;
t << " <div class=\"title\">" << theTranslator->trSearchResultsTitle() << "</div>" << endl;
t << " </div>" << endl;
t << "</div>" << endl;
t << "<div class=\"contents\">" << endl;
t << "<div id=\"searchresults\"></div>" << endl;
t << "</div>" << endl;
if (generateTreeView)
{
t << "</div><!-- doc-content -->" << endl;
}
writePageFooter(t,"Search","","");
}
QCString scriptName = Config_getString(HTML_OUTPUT)+"/search/search.js";
QFile sf(scriptName);
if (sf.open(IO_WriteOnly))
{
FTextStream t(&sf);
t << "var searchResultsText=["
<< "\"" << theTranslator->trSearchResults(0) << "\","
<< "\"" << theTranslator->trSearchResults(1) << "\","
<< "\"" << theTranslator->trSearchResults(2) << "\"];" << endl;
t << "var serverUrl=\"" << Config_getString(SEARCHENGINE_URL) << "\";" << endl;
t << "var tagMap = {" << endl;
bool first=TRUE;
// add search mappings
QStrList &extraSearchMappings = Config_getList(EXTRA_SEARCH_MAPPINGS);
char *ml=extraSearchMappings.first();
while (ml)
{
QCString mapLine = ml;
int eqPos = mapLine.find('=');
if (eqPos!=-1) // tag command contains a destination
{
QCString tagName = mapLine.left(eqPos).stripWhiteSpace();
QCString destName = mapLine.right(mapLine.length()-eqPos-1).stripWhiteSpace();
if (!tagName.isEmpty())
{
if (!first) t << "," << endl;
t << " \"" << tagName << "\": \"" << destName << "\"";
first=FALSE;
}
}
ml=extraSearchMappings.next();
}
if (!first) t << endl;
t << "};" << endl << endl;
t << ResourceMgr::instance().getAsString("extsearch.js");
t << endl;
t << "$(document).ready(function() {" << endl;
t << " var query = trim(getURLParameter('query'));" << endl;
t << " if (query) {" << endl;
t << " searchFor(query,0,20);" << endl;
t << " } else {" << endl;
t << " var results = $('#results');" << endl;
t << " results.html('<p>" << theTranslator->trSearchResults(0) << "</p>');" << endl;
t << " }" << endl;
t << "});" << endl;
}
else
{
err("Failed to open file '%s' for writing...\n",scriptName.data());
}
}
void HtmlGenerator::writeFooter ( const char *  navPath)
virtual

Implements OutputGenerator.

Definition at line 959 of file htmlgen.cpp.

References lastTitle, OutputGenerator::t, and writePageFooter().

{
writePageFooter(t,lastTitle,relPath,navPath);
}
void HtmlGenerator::writeFooterFile ( QFile &  f)
static

Definition at line 852 of file htmlgen.cpp.

References endl(), ResourceMgr::getAsString(), ResourceMgr::instance(), OutputGenerator::t, and versionString.

Referenced by readConfiguration().

{
FTextStream t(&file);
t << "<!-- HTML footer for doxygen " << versionString << "-->" << endl;
t << ResourceMgr::instance().getAsString("footer.html");
}
void HtmlGenerator::writeGraphicalHierarchy ( const DotGfxHierarchyTable &  g)
virtual

Implements OutputGenerator.

Definition at line 1807 of file htmlgen.cpp.

References OutputGenerator::dir, OutputGenerator::fileName, OutputGenerator::t, and DotGfxHierarchyTable::writeGraph().

{
g.writeGraph(t,dir,fileName);
}
void HtmlGenerator::writeHeaderFile ( QFile &  f,
const char *  cssname 
)
static

Definition at line 845 of file htmlgen.cpp.

References endl(), ResourceMgr::getAsString(), ResourceMgr::instance(), OutputGenerator::t, and versionString.

Referenced by readConfiguration().

{
FTextStream t(&file);
t << "<!-- HTML header for doxygen " << versionString << "-->" << endl;
t << ResourceMgr::instance().getAsString("header.html");
}
void HtmlGenerator::writeInheritedSectionTitle ( const char *  id,
const char *  ref,
const char *  file,
const char *  anchor,
const char *  title,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 2602 of file htmlgen.cpp.

References convertToHtml(), DBG_HTML, endl(), externalLinkTarget(), externalRef(), Doxygen::htmlFileExtension, relPath, OutputGenerator::t, theTranslator, and Translator::trInheritedFrom().

{
DBG_HTML(t << "<!-- writeInheritedSectionTitle -->" << endl;)
QCString a = anchor;
if (!a.isEmpty()) a.prepend("#");
QCString classLink = QCString("<a class=\"el\" href=\"");
if (ref)
{
classLink+= externalLinkTarget() + externalRef(relPath,ref,TRUE);
}
else
{
classLink+=relPath;
}
classLink+=file+Doxygen::htmlFileExtension+a;
classLink+=QCString("\">")+convertToHtml(name,FALSE)+"</a>";
t << "<tr class=\"inherit_header " << id << "\">"
<< "<td colspan=\"2\" onclick=\"javascript:toggleInherit('" << id << "')\">"
<< "<img src=\"" << relPath << "closed.png\" alt=\"-\"/>&#160;"
<< theTranslator->trInheritedFrom(convertToHtml(title,FALSE),classLink)
<< "</td></tr>" << endl;
}
void HtmlGenerator::writeLabel ( const char *  l,
bool  isLast 
)
virtual

Implements OutputGenerator.

Definition at line 2588 of file htmlgen.cpp.

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

{
DBG_HTML(t << "<!-- writeLabel(" << l << ") -->" << endl;)
//t << "<tt>[" << l << "]</tt>";
//if (!isLast) t << ", ";
t << "<span class=\"mlabel\">" << l << "</span>";
}
void HtmlGenerator::writeLatexSpacing ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 236 of file htmlgen.h.

{}
void HtmlGenerator::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 104 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeLineNumber().

{ m_codeGen.writeLineNumber(ref,file,anchor,lineNumber); }
void HtmlGenerator::writeLogo ( )
virtual

Implements OutputGenerator.

Definition at line 948 of file htmlgen.cpp.

References OutputGenerator::t, and writeLogoAsString().

{
t << writeLogoAsString(relPath);
}
QCString HtmlGenerator::writeLogoAsString ( const char *  path)
static

Definition at line 924 of file htmlgen.cpp.

References Config_getBool, Config_getString, dateToString(), theTranslator, Translator::trGeneratedAt(), Translator::trGeneratedBy(), and versionString.

Referenced by writeLogo(), and writeSearchPage().

{
static bool timeStamp = Config_getBool(HTML_TIMESTAMP);
QCString result;
if (timeStamp)
{
result += theTranslator->trGeneratedAt(
dateToString(TRUE),
Config_getString(PROJECT_NAME)
);
}
else
{
result += theTranslator->trGeneratedBy();
}
result += "&#160;\n<a href=\"http://www.doxygen.org/index.html\">\n"
"<img class=\"footer\" src=\"";
result += path;
result += "doxygen.png\" alt=\"doxygen\"/></a> ";
result += versionString;
result += " ";
return result;
}
void HtmlGenerator::writeNavigationPath ( const char *  s)
virtual

Implements OutputGenerator.

Definition at line 2226 of file htmlgen.cpp.

References substitute(), and OutputGenerator::t.

{
t << substitute(s,"$relpath^",relPath);
}
void HtmlGenerator::writeNonBreakableSpace ( int  n)
virtual

Implements BaseOutputDocInterface.

Definition at line 1857 of file htmlgen.cpp.

References OutputGenerator::t.

{
int i;
for (i=0;i<n;i++)
{
t << "&#160;";
}
}
void HtmlGenerator::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 1120 of file htmlgen.cpp.

References docify(), externalLinkTarget(), externalRef(), Doxygen::htmlFileExtension, and OutputGenerator::t.

Referenced by startSimpleSect().

{
if (ref)
{
t << "<a class=\"elRef\" ";
t << externalLinkTarget() << externalRef(relPath,ref,FALSE);
}
else
{
t << "<a class=\"el\" ";
}
t << "href=\"";
t << externalRef(relPath,ref,TRUE);
if (f) t << f << Doxygen::htmlFileExtension;
if (anchor) t << "#" << anchor;
t << "\">";
docify(name);
t << "</a>";
}
void HtmlGenerator::writePageFooter ( FTextStream &  t,
const QCString &  lastTitle,
const QCString &  relPath,
const QCString &  navPath 
)
staticprivate

Definition at line 953 of file htmlgen.cpp.

References convertToHtml(), g_footer, and substituteHtmlKeywords().

Referenced by writeExternalSearchPage(), writeFooter(), and writeSearchPage().

{
t << substituteHtmlKeywords(g_footer,convertToHtml(lastTitle),relPath,navPath);
}
void HtmlGenerator::writePageLink ( const char *  ,
bool   
)
inlinevirtual

Implements OutputGenerator.

Definition at line 134 of file htmlgen.h.

{}
void HtmlGenerator::writeQuickLinks ( bool  compact,
HighlightedItem  hli,
const char *  file 
)
virtual

Implements OutputGenerator.

Definition at line 2241 of file htmlgen.cpp.

References OutputGenerator::t, and writeDefaultQuickLinks().

{
writeDefaultQuickLinks(t,compact,hli,file,relPath);
}
void HtmlGenerator::writeRuler ( )
inlinevirtual

Writes a horizontal ruler to the output

Implements BaseOutputDocInterface.

Definition at line 211 of file htmlgen.h.

{ t << "<hr/>"; }
void HtmlGenerator::writeSearchData ( const char *  dir)
static

Definition at line 794 of file htmlgen.cpp.

References IndexList::addImageFile(), IndexList::addStyleSheetFile(), Config_getBool, Config_getString, ResourceMgr::copyResource(), ResourceMgr::getAsString(), Doxygen::indexList, ResourceMgr::instance(), replaceColorMarkers(), substitute(), OutputGenerator::t, and versionString.

Referenced by generateOutput().

{
static bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
//writeImgData(dir,serverBasedSearch ? search_server_data : search_client_data);
ResourceMgr &mgr = ResourceMgr::instance();
mgr.copyResource("search_l.png",dir);
Doxygen::indexList->addImageFile("search/search_l.png");
mgr.copyResource("search_m.png",dir);
Doxygen::indexList->addImageFile("search/search_m.png");
mgr.copyResource("search_r.png",dir);
Doxygen::indexList->addImageFile("search/search_r.png");
if (serverBasedSearch)
{
mgr.copyResource("mag.png",dir);
Doxygen::indexList->addImageFile("search/mag.png");
}
else
{
mgr.copyResource("close.png",dir);
Doxygen::indexList->addImageFile("search/close.png");
mgr.copyResource("mag_sel.png",dir);
Doxygen::indexList->addImageFile("search/mag_sel.png");
}
QCString searchDirName = Config_getString(HTML_OUTPUT)+"/search";
QFile f(searchDirName+"/search.css");
if (f.open(IO_WriteOnly))
{
FTextStream t(&f);
QCString searchCss;
if (Config_getBool(DISABLE_INDEX))
{
searchCss = mgr.getAsString("search_nomenu.css");
}
else
{
searchCss = mgr.getAsString("search.css");
}
searchCss = substitute(replaceColorMarkers(searchCss),"$doxygenversion",versionString);
t << searchCss;
Doxygen::indexList->addStyleSheetFile("search/search.css");
}
}
void HtmlGenerator::writeSearchInfo ( FTextStream &  t,
const QCString &  relPath 
)
static

Definition at line 894 of file htmlgen.cpp.

References Config_getBool.

{
static bool searchEngine = Config_getBool(SEARCHENGINE);
static bool serverBasedSearch = Config_getBool(SERVER_BASED_SEARCH);
if (searchEngine && !serverBasedSearch)
{
(void)relPath;
t << "<!-- window showing the filter options -->\n";
t << "<div id=\"MSearchSelectWindow\"\n";
t << " onmouseover=\"return searchBox.OnSearchSelectShow()\"\n";
t << " onmouseout=\"return searchBox.OnSearchSelectHide()\"\n";
t << " onkeydown=\"return searchBox.OnSearchSelectKey(event)\">\n";
t << "</div>\n";
t << "\n";
t << "<!-- iframe showing the search results (closed by default) -->\n";
t << "<div id=\"MSearchResultsWindow\">\n";
t << "<iframe src=\"javascript:void(0)\" frameborder=\"0\" \n";
t << " name=\"MSearchResults\" id=\"MSearchResults\">\n";
t << "</iframe>\n";
t << "</div>\n";
t << "\n";
}
}
void HtmlGenerator::writeSearchInfo ( )
virtual

Implements OutputGenerator.

Definition at line 918 of file htmlgen.cpp.

References OutputGenerator::t.

{
writeSearchInfo(t,relPath);
}
void HtmlGenerator::writeSearchPage ( )
static

Definition at line 2247 of file htmlgen.cpp.

References Config_getBool, Config_getString, convertToHtml(), ResourceMgr::copyResource(), endl(), err(), OutputGenerator::fileName, g_header, ResourceMgr::getAsString(), HLI_Search, ResourceMgr::instance(), substitute(), substituteHtmlKeywords(), OutputGenerator::t, theTranslator, Translator::trGeneratedBy(), Translator::trSearch(), Translator::trSearchMatches(), Translator::trSearchResults(), Translator::trSearchResultsTitle(), versionString, writeDefaultQuickLinks(), writeLogoAsString(), writePageFooter(), and writeSplitBarAsString().

Referenced by generateOutput().

{
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
static bool disableIndex = Config_getBool(DISABLE_INDEX);
static QCString projectName = Config_getString(PROJECT_NAME);
static QCString htmlOutput = Config_getString(HTML_OUTPUT);
// OPENSEARCH_PROVIDER {
QCString configFileName = htmlOutput+"/search_config.php";
QFile cf(configFileName);
if (cf.open(IO_WriteOnly))
{
FTextStream t(&cf);
t << "<script language=\"php\">\n\n";
t << "$config = array(\n";
t << " 'PROJECT_NAME' => \"" << convertToHtml(projectName) << "\",\n";
t << " 'GENERATE_TREEVIEW' => " << (generateTreeView?"true":"false") << ",\n";
t << " 'DISABLE_INDEX' => " << (disableIndex?"true":"false") << ",\n";
t << ");\n\n";
t << "$translator = array(\n";
t << " 'search_results_title' => \"" << theTranslator->trSearchResultsTitle() << "\",\n";
t << " 'search_results' => array(\n";
t << " 0 => \"" << theTranslator->trSearchResults(0) << "\",\n";
t << " 1 => \"" << theTranslator->trSearchResults(1) << "\",\n";
t << " 2 => \"" << substitute(theTranslator->trSearchResults(2), "$", "\\$") << "\",\n";
t << " ),\n";
t << " 'search_matches' => \"" << theTranslator->trSearchMatches() << "\",\n";
t << " 'search' => \"" << theTranslator->trSearch() << "\",\n";
t << " 'split_bar' => \"" << substitute(substitute(writeSplitBarAsString("search",""), "\"","\\\""), "\n","\\n") << "\",\n";
t << " 'logo' => \"" << substitute(substitute(writeLogoAsString(""), "\"","\\\""), "\n","\\n") << "\",\n";
t << ");\n\n";
t << "</script>\n";
}
ResourceMgr::instance().copyResource("search_functions.php",htmlOutput);
ResourceMgr::instance().copyResource("search_opensearch.php",htmlOutput);
// OPENSEARCH_PROVIDER }
QCString fileName = htmlOutput+"/search.php";
QFile f(fileName);
if (f.open(IO_WriteOnly))
{
FTextStream t(&f);
t << substituteHtmlKeywords(g_header,"Search","");
t << "<!-- " << theTranslator->trGeneratedBy() << " Doxygen "
<< versionString << " -->" << endl;
t << "<script type=\"text/javascript\">\n";
t << "var searchBox = new SearchBox(\"searchBox\", \""
<< "search\",false,'" << theTranslator->trSearch() << "');\n";
t << "</script>\n";
if (!Config_getBool(DISABLE_INDEX))
{
writeDefaultQuickLinks(t,TRUE,HLI_Search,0,"");
}
else
{
t << "</div>" << endl;
}
t << "<script language=\"php\">\n";
t << "require_once \"search_functions.php\";\n";
t << "main();\n";
t << "</script>\n";
// Write empty navigation path, to make footer connect properly
if (generateTreeView)
{
t << "</div><!-- doc-content -->\n";
}
writePageFooter(t,"Search","","");
}
QCString scriptName = htmlOutput+"/search/search.js";
QFile sf(scriptName);
if (sf.open(IO_WriteOnly))
{
FTextStream t(&sf);
t << ResourceMgr::instance().getAsString("extsearch.js");
}
else
{
err("Failed to open file '%s' for writing...\n",scriptName.data());
}
}
void HtmlGenerator::writeSplitBar ( const char *  name)
virtual

Implements OutputGenerator.

Definition at line 2221 of file htmlgen.cpp.

References OutputGenerator::t, and writeSplitBarAsString().

{
t << writeSplitBarAsString(name,relPath);
}
QCString HtmlGenerator::writeSplitBarAsString ( const char *  name,
const char *  relpath 
)
static

Definition at line 2192 of file htmlgen.cpp.

References Config_getBool, and Doxygen::htmlFileExtension.

Referenced by writeExternalSearchPage(), writeSearchPage(), and writeSplitBar().

{
static bool generateTreeView = Config_getBool(GENERATE_TREEVIEW);
QCString result;
// write split bar
if (generateTreeView)
{
result = QCString(
"<div id=\"side-nav\" class=\"ui-resizable side-nav-resizable\">\n"
" <div id=\"nav-tree\">\n"
" <div id=\"nav-tree-contents\">\n"
" <div id=\"nav-sync\" class=\"sync\"></div>\n"
" </div>\n"
" </div>\n"
" <div id=\"splitbar\" style=\"-moz-user-select:none;\" \n"
" class=\"ui-resizable-handle\">\n"
" </div>\n"
"</div>\n"
"<script type=\"text/javascript\">\n"
"$(document).ready(function(){initNavTree('") +
QCString(name) + Doxygen::htmlFileExtension +
QCString("','") + relpath +
QCString("');});\n"
"</script>\n"
"<div id=\"doc-content\">\n");
}
return result;
}
void HtmlGenerator::writeStartAnnoItem ( const char *  type,
const char *  file,
const char *  path,
const char *  name 
)
virtual

Implements OutputGenerator.

Definition at line 1110 of file htmlgen.cpp.

References docify(), Doxygen::htmlFileExtension, and OutputGenerator::t.

{
t << "<li>";
if (path) docify(path);
t << "<a class=\"el\" href=\"" << f << Doxygen::htmlFileExtension << "\">";
docify(name);
t << "</a> ";
}
void HtmlGenerator::writeString ( const char *  text)
virtual

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

Implements BaseOutputDocInterface.

Definition at line 1058 of file htmlgen.cpp.

References OutputGenerator::t.

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

Implements OutputGenerator.

Definition at line 979 of file htmlgen.cpp.

References IndexList::addStyleSheetFile(), Config_getList, Config_getString, OutputGenerator::endPlainFile(), err(), OutputGenerator::fileName, fileToString(), Doxygen::indexList, ResourceMgr::instance(), replaceColorMarkers(), OutputGenerator::startPlainFile(), substitute(), OutputGenerator::t, and versionString.

{
//printf("writeStyleInfo(%d)\n",part);
if (part==0)
{
if (Config_getString(HTML_STYLESHEET).isEmpty()) // write default style sheet
{
//printf("write doxygen.css\n");
startPlainFile("doxygen.css");
// alternative, cooler looking titles
//t << "H1 { text-align: center; border-width: thin none thin none;" << endl;
//t << " border-style : double; border-color : blue; padding-left : 1em; padding-right : 1em }" << endl;
t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",versionString));
endPlainFile();
Doxygen::indexList->addStyleSheetFile("doxygen.css");
}
else // write user defined style sheet
{
QCString cssname=Config_getString(HTML_STYLESHEET);
QFileInfo cssfi(cssname);
if (!cssfi.exists() || !cssfi.isFile() || !cssfi.isReadable())
{
err("style sheet %s does not exist or is not readable!", Config_getString(HTML_STYLESHEET).data());
}
else
{
// convert style sheet to string
QCString fileStr = fileToString(cssname);
// write the string into the output dir
startPlainFile(cssfi.fileName().utf8());
t << fileStr;
endPlainFile();
}
Doxygen::indexList->addStyleSheetFile(cssfi.fileName().utf8());
}
static QStrList extraCssFile = Config_getList(HTML_EXTRA_STYLESHEET);
for (uint i=0; i<extraCssFile.count(); ++i)
{
QCString fileName(extraCssFile.at(i));
if (!fileName.isEmpty())
{
QFileInfo fi(fileName);
if (fi.exists())
{
Doxygen::indexList->addStyleSheetFile(fi.fileName().utf8());
}
}
}
}
}
void HtmlGenerator::writeStyleSheetFile ( QFile &  f)
static

Definition at line 839 of file htmlgen.cpp.

References ResourceMgr::instance(), replaceColorMarkers(), substitute(), OutputGenerator::t, and versionString.

Referenced by readConfiguration().

{
FTextStream t(&file);
t << replaceColorMarkers(substitute(ResourceMgr::instance().getAsString("doxygen.css"),"$doxygenversion",versionString));
}
void HtmlGenerator::writeSummaryLink ( const char *  file,
const char *  anchor,
const char *  title,
bool  first 
)
virtual

Implements OutputGenerator.

Definition at line 2628 of file htmlgen.cpp.

References OutputGenerator::file, Doxygen::htmlFileExtension, and OutputGenerator::t.

{
if (first)
{
t << " <div class=\"summary\">\n";
}
else
{
t << " &#124;\n";
}
t << "<a href=\"";
if (file)
{
t << relPath << file;
t << Doxygen::htmlFileExtension;
}
else
{
t << "#";
t << anchor;
}
t << "\">";
t << title;
t << "</a>";
}
void HtmlGenerator::writeSynopsis ( )
inlinevirtual

Implements OutputGenerator.

Definition at line 260 of file htmlgen.h.

{}
void HtmlGenerator::writeTabData ( )
static

Additional initialization after indices have been created.

Definition at line 765 of file htmlgen.cpp.

References IndexList::addStyleSheetFile(), Config_getString, ResourceMgr::copyResource(), Doxygen::indexList, and ResourceMgr::instance().

Referenced by generateOutput().

{
Doxygen::indexList->addStyleSheetFile("tabs.css");
QCString dname=Config_getString(HTML_OUTPUT);
ResourceMgr &mgr = ResourceMgr::instance();
//writeColoredImgData(dname,colored_tab_data);
mgr.copyResource("tab_a.lum",dname);
mgr.copyResource("tab_b.lum",dname);
mgr.copyResource("tab_h.lum",dname);
mgr.copyResource("tab_s.lum",dname);
mgr.copyResource("nav_h.lum",dname);
mgr.copyResource("nav_f.lum",dname);
mgr.copyResource("bc_s.luma",dname);
mgr.copyResource("doxygen.luma",dname);
mgr.copyResource("closed.luma",dname);
mgr.copyResource("open.luma",dname);
mgr.copyResource("bdwn.luma",dname);
mgr.copyResource("sync_on.luma",dname);
mgr.copyResource("sync_off.luma",dname);
//{
// unsigned char shadow[6] = { 5, 5, 5, 5, 5, 5 };
// unsigned char shadow_alpha[6] = { 80, 60, 40, 20, 10, 0 };
// ColoredImage img(1,6,shadow,shadow_alpha,0,0,100);
// img.save(dname+"/nav_g.png");
//}
mgr.copyResource("nav_g.png",dname);
}
void HtmlGenerator::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 106 of file htmlgen.h.

References m_codeGen, and HtmlCodeGenerator::writeTooltip().

{ m_codeGen.writeTooltip(id,docInfo,decl,desc,defInfo,declInfo); }

Member Data Documentation

QCString HtmlGenerator::lastFile
private

Definition at line 343 of file htmlgen.h.

Referenced by startFile().

QCString HtmlGenerator::lastTitle
private

Definition at line 342 of file htmlgen.h.

Referenced by startFile(), and writeFooter().

HtmlCodeGenerator HtmlGenerator::m_codeGen
private

Definition at line 352 of file htmlgen.h.

Referenced by codify(), endCodeLine(), endFontClass(), startCodeLine(), startFile(), startFontClass(), writeCodeAnchor(), writeCodeLink(), writeDoc(), writeLineNumber(), and writeTooltip().

bool HtmlGenerator::m_emptySection
private

Definition at line 351 of file htmlgen.h.

Referenced by endMemberSections(), HtmlGenerator(), startInlineHeader(), startMemberDescription(), startMemberHeader(), startMemberItem(), and startMemberSections().

int HtmlGenerator::m_sectionCount
private

Definition at line 350 of file htmlgen.h.

Referenced by endCallGraph(), endClassDiagram(), endDirDepGraph(), endDotGraph(), endGroupCollaboration(), endInclDepGraph(), startCallGraph(), startClassDiagram(), startDirDepGraph(), startDotGraph(), startFile(), startGroupCollaboration(), and startInclDepGraph().

QCString HtmlGenerator::relPath
private

Definition at line 344 of file htmlgen.h.

Referenced by renderQuickLinksAsTabs(), and writeInheritedSectionTitle().

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