Public Member Functions | Static Public Member Functions | List of all members
HtmlGenerator Class Reference

Generator for HTML output. More...

#include <htmlgen.h>

Inheritance diagram for HtmlGenerator:
Inheritance graph
Collaboration diagram for HtmlGenerator:
Collaboration graph

Public Member Functions

 HtmlGenerator (const HtmlGenerator &)
HtmlGeneratoroperator= (const HtmlGenerator &)
 HtmlGenerator (HtmlGenerator &&)
HtmlGeneratoroperator= (HtmlGenerator &&)=delete
OutputType type () const
void cleanup ()
void writeDoc (const IDocNodeAST *node, const Definition *, const MemberDef *, int id)
void startFile (const QCString &name, const QCString &manName, const QCString &title, int id)
void writeFooter (const QCString &navPath)
void endFile ()
void clearBuffer ()
void writeSearchInfo ()
void startIndexSection (IndexSection)
void endIndexSection (IndexSection)
void writePageLink (const QCString &, bool)
void startProjectNumber ()
void endProjectNumber ()
void writeStyleInfo (int part)
void startTitleHead (const QCString &)
void endTitleHead (const QCString &, const QCString &)
void startTitle ()
void endTitle ()
void startParagraph (const QCString &classDef)
void endParagraph ()
void writeString (const QCString &text)
void startIndexListItem ()
void endIndexListItem ()
void startIndexList ()
void endIndexList ()
void startIndexKey ()
void endIndexKey ()
void startIndexValue (bool)
void endIndexValue (const QCString &, bool)
void startItemList ()
void endItemList ()
void startIndexItem (const QCString &ref, const QCString &file)
void endIndexItem (const QCString &ref, const QCString &file)
void docify (const QCString &text)
void writeObjectLink (const QCString &ref, const QCString &file, const QCString &anchor, const QCString &name)
void startTextLink (const QCString &file, const QCString &anchor)
void endTextLink ()
void startHtmlLink (const QCString &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 QCString &, int)
void endMemberHeader ()
void startMemberSubtitle ()
void endMemberSubtitle ()
void startMemberDocList ()
void endMemberDocList ()
void startMemberList ()
void endMemberList ()
void startInlineHeader ()
void endInlineHeader ()
void startAnonTypeScope (int)
void endAnonTypeScope (int)
void startMemberItem (const QCString &anchor, MemberItemType, const QCString &inheritId)
void endMemberItem (MemberItemType)
void startMemberTemplateParams ()
void endMemberTemplateParams (const QCString &anchor, const QCString &inheritId)
void startCompoundTemplateParams ()
void endCompoundTemplateParams ()
void startMemberGroupHeader (bool)
void endMemberGroupHeader ()
void startMemberGroupDocs ()
void endMemberGroupDocs ()
void startMemberGroup ()
void endMemberGroup (bool)
void insertMemberAlign (bool)
void insertMemberAlignLeft (MemberItemType, bool)
void startMemberDescription (const QCString &anchor, const QCString &inheritId, bool typ)
void endMemberDescription ()
void startMemberDeclaration ()
void endMemberDeclaration (const QCString &anchor, const QCString &inheritId)
void writeInheritedSectionTitle (const QCString &id, const QCString &ref, const QCString &file, const QCString &anchor, const QCString &title, const QCString &name)
void writeRuler ()
void writeAnchor (const QCString &, const QCString &name)
void startEmphasis ()
void endEmphasis ()
void startBold ()
void endBold ()
void startDescription ()
void endDescription ()
void startDescItem ()
void endDescItem ()
void startDescForItem ()
void endDescForItem ()
void lineBreak (const QCString &style)
void writeChar (char c)
void startMemberDoc (const QCString &clName, const QCString &memName, const QCString &anchor, const QCString &title, int memCount, int memTotal, bool showInline)
void endMemberDoc (bool)
void startDoxyAnchor (const QCString &fName, const QCString &manName, const QCString &anchor, const QCString &name, const QCString &args)
void endDoxyAnchor (const QCString &fName, const QCString &anchor)
void writeLatexSpacing ()
void writeStartAnnoItem (const QCString &type, const QCString &file, const QCString &path, const QCString &name)
void writeEndAnnoItem (const QCString &)
void startSubsection ()
void endSubsection ()
void startSubsubsection ()
void endSubsubsection ()
void startCenter ()
void endCenter ()
void startSmall ()
void endSmall ()
void startExamples ()
void endExamples ()
void startParamList (ParamListTypes, const QCString &)
void endParamList ()
void startSection (const QCString &, const QCString &, SectionType)
void endSection (const QCString &, SectionType)
void addIndexItem (const QCString &, const QCString &)
void startIndent ()
void endIndent ()
void writeSynopsis ()
void startClassDiagram ()
void endClassDiagram (const ClassDiagram &, const QCString &, const QCString &)
void startPageRef ()
void endPageRef (const QCString &, const QCString &)
void startQuickIndices ()
void endQuickIndices ()
void writeSplitBar (const QCString &name)
void writeNavigationPath (const QCString &s)
void writeLogo ()
void writeQuickLinks (bool compact, HighlightedItem hli, const QCString &file)
void writeSummaryLink (const QCString &file, const QCString &anchor, const QCString &title, bool first)
void startContents ()
void endContents ()
void startPageDoc (const QCString &pageTitle)
void endPageDoc ()
void writeNonBreakableSpace (int)
void startDescTable (const QCString &title)
void endDescTable ()
void startDescTableRow ()
void endDescTableRow ()
void startDescTableTitle ()
void endDescTableTitle ()
void startDescTableData ()
void endDescTableData ()
void startDotGraph ()
void endDotGraph (DotClassGraph &g)
void startInclDepGraph ()
void endInclDepGraph (DotInclDepGraph &g)
void startGroupCollaboration ()
void endGroupCollaboration (DotGroupCollaboration &g)
void startCallGraph ()
void endCallGraph (DotCallGraph &g)
void startDirDepGraph ()
void endDirDepGraph (DotDirDeps &g)
void writeGraphicalHierarchy (DotGfxHierarchyTable &g)
void startTextBlock (bool)
void endTextBlock (bool)
void lastIndexPage ()
void startMemberDocPrefixItem ()
void endMemberDocPrefixItem ()
void startMemberDocName (bool)
void endMemberDocName ()
void startParameterType (bool first, const QCString &key)
void endParameterType ()
void startParameterName (bool)
void endParameterName (bool last, bool emptyList, bool closeBracket)
void startParameterList (bool)
void endParameterList ()
void exceptionEntry (const QCString &, bool)
void startConstraintList (const QCString &)
void startConstraintParam ()
void endConstraintParam ()
void startConstraintType ()
void endConstraintType ()
void startConstraintDocs ()
void endConstraintDocs ()
void endConstraintList ()
void startMemberDocSimple (bool)
void endMemberDocSimple (bool)
void startInlineMemberType ()
void endInlineMemberType ()
void startInlineMemberName ()
void endInlineMemberName ()
void startInlineMemberDoc ()
void endInlineMemberDoc ()
void startLabels ()
void writeLabel (const QCString &l, bool isLast)
void endLabels ()
void writeLocalToc (const SectionRefs &sr, const LocalToc &lt)
void addCodeGen (OutputCodeList &list)
- Public Member Functions inherited from OutputGenerator
 OutputGenerator (const QCString &dir)
 OutputGenerator (const OutputGenerator &)=delete
OutputGeneratoroperator= (const OutputGenerator &)=delete
 OutputGenerator (OutputGenerator &&)=default
OutputGeneratoroperator= (OutputGenerator &&)=delete
QCString dir () const
QCString fileName () const
void startPlainFile (const QCString &name)
void endPlainFile ()

Static Public Member Functions

static void init ()
static void writeStyleSheetFile (TextStream &t)
static void writeHeaderFile (TextStream &t, const QCString &cssname)
static void writeFooterFile (TextStream &t)
static void writeTabData ()
 Additional initialization after indices have been created.
static void writeSearchInfoStatic (TextStream &t, const QCString &relPath)
static void writeSearchData (const QCString &dir)
static void writeSearchPage ()
static void writeExternalSearchPage ()
static QCString writeLogoAsString (const QCString &path)
static QCString writeSplitBarAsString (const QCString &name, const QCString &relpath)
static QCString getMathJaxMacros ()
static QCString getNavTreeCss ()

Additional Inherited Members

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

Detailed Description

Generator for HTML output.

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