HtmlDocVisitor Class Reference

Concrete visitor implementation for HTML output. More...

#include <htmldocvisitor.h>

Inheritance diagram for HtmlDocVisitor:

List of all members.

Public Member Functions
	HtmlDocVisitor (QTextStream &t, CodeOutputInterface &ci, const char *langExt)
void	visit (DocWord *)
void	visit (DocLinkedWord *)
void	visit (DocWhiteSpace *)
void	visit (DocSymbol *)
void	visit (DocURL *)
void	visit (DocLineBreak *)
void	visit (DocHorRuler *)
void	visit (DocStyleChange *)
void	visit (DocVerbatim *)
void	visit (DocAnchor *)
void	visit (DocInclude *)
void	visit (DocIncOperator *)
void	visit (DocFormula *)
void	visit (DocIndexEntry *)
void	visitPre (DocAutoList *)
void	visitPost (DocAutoList *)
void	visitPre (DocAutoListItem *)
void	visitPost (DocAutoListItem *)
void	visitPre (DocPara *)
void	visitPost (DocPara *)
void	visitPre (DocRoot *)
void	visitPost (DocRoot *)
void	visitPre (DocSimpleSect *)
void	visitPost (DocSimpleSect *)
void	visitPre (DocTitle *)
void	visitPost (DocTitle *)
void	visitPre (DocSimpleList *)
void	visitPost (DocSimpleList *)
void	visitPre (DocSimpleListItem *)
void	visitPost (DocSimpleListItem *)
void	visitPre (DocSection *)
void	visitPost (DocSection *)
void	visitPre (DocHtmlList *)
void	visitPost (DocHtmlList *)
void	visitPre (DocHtmlListItem *)
void	visitPost (DocHtmlListItem *)
void	visitPre (DocHtmlDescList *)
void	visitPost (DocHtmlDescList *)
void	visitPre (DocHtmlDescTitle *)
void	visitPost (DocHtmlDescTitle *)
void	visitPre (DocHtmlDescData *)
void	visitPost (DocHtmlDescData *)
void	visitPre (DocHtmlTable *)
void	visitPost (DocHtmlTable *)
void	visitPre (DocHtmlRow *)
void	visitPost (DocHtmlRow *)
void	visitPre (DocHtmlCell *)
void	visitPost (DocHtmlCell *)
void	visitPre (DocHtmlCaption *)
void	visitPost (DocHtmlCaption *)
void	visitPre (DocInternal *)
void	visitPost (DocInternal *)
void	visitPre (DocHRef *)
void	visitPost (DocHRef *)
void	visitPre (DocHtmlHeader *)
void	visitPost (DocHtmlHeader *)
void	visitPre (DocImage *)
void	visitPost (DocImage *)
void	visitPre (DocDotFile *)
void	visitPost (DocDotFile *)
void	visitPre (DocLink *)
void	visitPost (DocLink *)
void	visitPre (DocRef *)
void	visitPost (DocRef *)
void	visitPre (DocSecRefItem *)
void	visitPost (DocSecRefItem *)
void	visitPre (DocSecRefList *)
void	visitPost (DocSecRefList *)
void	visitPre (DocParamSect *)
void	visitPost (DocParamSect *)
void	visitPre (DocParamList *)
void	visitPost (DocParamList *)
void	visitPre (DocXRefItem *)
void	visitPost (DocXRefItem *)
void	visitPre (DocInternalRef *)
void	visitPost (DocInternalRef *)
void	visitPre (DocCopy *)
void	visitPost (DocCopy *)
void	visitPre (DocText *)
void	visitPost (DocText *)

---

Detailed Description

Concrete visitor implementation for HTML output.

Definition at line 31 of file htmldocvisitor.h.

---

Constructor & Destructor Documentation

HtmlDocVisitor::HtmlDocVisitor	(	QTextStream &	t,
		CodeOutputInterface &	ci,
		const char *	langExt
	)

Definition at line 54 of file htmldocvisitor.cpp.

---

Member Function Documentation

void HtmlDocVisitor::visit

(

DocWord *

)

[virtual]

Implements DocVisitor.

Definition at line 65 of file htmldocvisitor.cpp.

References DocWord::word().

Referenced by visitPre().

void HtmlDocVisitor::visit

(

DocLinkedWord *

)

[virtual]

Implements DocVisitor.

Definition at line 71 of file htmldocvisitor.cpp.

References DocLinkedWord::anchor(), DocLinkedWord::file(), DocLinkedWord::ref(), DocLinkedWord::relPath(), DocLinkedWord::tooltip(), and DocLinkedWord::word().

void HtmlDocVisitor::visit

(

DocWhiteSpace *

)

[virtual]

Implements DocVisitor.

Definition at line 79 of file htmldocvisitor.cpp.

References DocWhiteSpace::chars().

void HtmlDocVisitor::visit

(

DocSymbol *

)

[virtual]

Implements DocVisitor.

Definition at line 92 of file htmldocvisitor.cpp.

References DocSymbol::Acute, DocSymbol::Amp, DocSymbol::Apos, DocSymbol::At, DocSymbol::BSlash, DocSymbol::Cedil, DocSymbol::Circ, DocSymbol::Copy, DocSymbol::Dollar, err(), DocSymbol::Grave, DocSymbol::Greater, DocSymbol::Hash, DocSymbol::Ldquo, DocSymbol::Less, DocSymbol::letter(), DocSymbol::Lsquo, DocSymbol::Mdash, DocSymbol::Nbsp, DocSymbol::Ndash, DocSymbol::Percent, DocSymbol::Quot, DocSymbol::Rdquo, DocSymbol::Reg, DocSymbol::Ring, DocSymbol::Rsquo, DocSymbol::Slash, DocSymbol::symbol(), DocSymbol::Szlig, DocSymbol::Tilde, DocSymbol::Tm, and DocSymbol::Uml.

void HtmlDocVisitor::visit

(

DocURL *

)

[virtual]

Implements DocVisitor.

Definition at line 131 of file htmldocvisitor.cpp.

References DocURL::isEmail(), and DocURL::url().

void HtmlDocVisitor::visit

(

DocLineBreak *

)

[virtual]

Implements DocVisitor.

Definition at line 141 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visit

(

DocHorRuler *

)

[virtual]

Implements DocVisitor.

Definition at line 147 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visit

(

DocStyleChange *

)

[virtual]

Implements DocVisitor.

Definition at line 153 of file htmldocvisitor.cpp.

References DocStyleChange::attribs(), DocStyleChange::Bold, DocStyleChange::Center, DocStyleChange::Code, DocStyleChange::Div, DocStyleChange::enable(), DocStyleChange::Italic, DocStyleChange::Preformatted, DocStyleChange::Small, DocStyleChange::Span, DocStyleChange::style(), DocStyleChange::Subscript, and DocStyleChange::Superscript.

void HtmlDocVisitor::visit

(

DocVerbatim *

)

[virtual]

Implements DocVisitor.

Definition at line 202 of file htmldocvisitor.cpp.

References DocVerbatim::Code, Config_getBool, Config_getString, DocVerbatim::context(), DocVerbatim::Dot, err(), DocVerbatim::exampleFile(), ParserManager::getParser(), DocVerbatim::HtmlOnly, DocVerbatim::isExample(), DocVerbatim::LatexOnly, DocVerbatim::ManOnly, DocVerbatim::Msc, ParserInterface::parseCode(), Doxygen::parserManager, PREFRAG_END, PREFRAG_START, QCString, DocVerbatim::relPath(), DocVerbatim::text(), DocVerbatim::type(), DocVerbatim::Verbatim, and DocVerbatim::XmlOnly.

void HtmlDocVisitor::visit

(

DocAnchor *

)

[virtual]

Implements DocVisitor.

Definition at line 283 of file htmldocvisitor.cpp.

References DocAnchor::anchor().

void HtmlDocVisitor::visit

(

DocInclude *

)

[virtual]

Implements DocVisitor.

Definition at line 289 of file htmldocvisitor.cpp.

References DocInclude::context(), DocInclude::DontInclude, DocInclude::exampleFile(), DocInclude::extension(), DocInclude::file(), ParserManager::getParser(), DocInclude::HtmlInclude, DocInclude::Include, DocInclude::IncWithLines, DocInclude::isExample(), Doxygen::parserManager, PREFRAG_END, PREFRAG_START, DocInclude::text(), DocInclude::type(), and DocInclude::VerbInclude.

void HtmlDocVisitor::visit

(

DocIncOperator *

)

[virtual]

Implements DocVisitor.

Definition at line 336 of file htmldocvisitor.cpp.

References DocIncOperator::context(), DocIncOperator::exampleFile(), ParserManager::getParser(), DocIncOperator::isExample(), DocIncOperator::isFirst(), DocIncOperator::isLast(), ParserInterface::parseCode(), Doxygen::parserManager, PREFRAG_END, PREFRAG_START, DocIncOperator::Skip, DocIncOperator::text(), and DocIncOperator::type().

void HtmlDocVisitor::visit

(

DocFormula *

)

[virtual]

Implements DocVisitor.

Definition at line 370 of file htmldocvisitor.cpp.

References DocFormula::name(), DocFormula::relPath(), and DocFormula::text().

void HtmlDocVisitor::visit

(

DocIndexEntry *

)

[virtual]

Implements DocVisitor.

Definition at line 387 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocAutoList *

)

[virtual]

Implements DocVisitor.

Definition at line 396 of file htmldocvisitor.cpp.

References DocAutoList::depth(), DocAutoList::isEnumList(), and DocNode::isPreformatted().

void HtmlDocVisitor::visitPost

(

DocAutoList *

)

[virtual]

Implements DocVisitor.

Definition at line 418 of file htmldocvisitor.cpp.

References DocAutoList::isEnumList(), and DocNode::isPreformatted().

void HtmlDocVisitor::visitPre

(

DocAutoListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 432 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocAutoListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 438 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocPara *

)

[virtual]

Implements DocVisitor.

Definition at line 444 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocPara *

)

[virtual]

Implements DocVisitor.

Definition at line 462 of file htmldocvisitor.cpp.

References DocPara::isLast(), DocNode::kind(), DocNode::Kind_ParamSect, and DocPara::parent().

void HtmlDocVisitor::visitPre

(

DocRoot *

)

[virtual]

Implements DocVisitor.

Definition at line 475 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocRoot *

)

[virtual]

Implements DocVisitor.

Definition at line 479 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocSimpleSect *

)

[virtual]

Implements DocVisitor.

Definition at line 483 of file htmldocvisitor.cpp.

References DocSimpleSect::Attention, DocSimpleSect::Author, DocSimpleSect::Authors, DocSimpleSect::Date, DocSimpleSect::Invar, DocSimpleSect::Note, DocSimpleSect::Post, DocSimpleSect::Pre, DocSimpleSect::Rcs, DocSimpleSect::Remark, DocSimpleSect::Return, DocSimpleSect::See, DocSimpleSect::Since, theTranslator, Translator::trAttention(), Translator::trAuthor(), Translator::trDate(), Translator::trInvariant(), Translator::trNote(), Translator::trPostcondition(), Translator::trPrecondition(), Translator::trRemarks(), Translator::trReturns(), Translator::trSeeAlso(), Translator::trSince(), Translator::trVersion(), Translator::trWarning(), DocSimpleSect::type(), DocSimpleSect::typeString(), DocSimpleSect::Unknown, DocSimpleSect::User, DocSimpleSect::Version, and DocSimpleSect::Warning.

void HtmlDocVisitor::visitPost

(

DocSimpleSect *

)

[virtual]

Implements DocVisitor.

Definition at line 529 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocTitle *

)

[virtual]

Implements DocVisitor.

Definition at line 535 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocTitle *

)

[virtual]

Implements DocVisitor.

Definition at line 539 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocSimpleList *

)

[virtual]

Implements DocVisitor.

Definition at line 545 of file htmldocvisitor.cpp.

References DocNode::isPreformatted().

void HtmlDocVisitor::visitPost

(

DocSimpleList *

)

[virtual]

Implements DocVisitor.

Definition at line 552 of file htmldocvisitor.cpp.

References DocNode::isPreformatted().

void HtmlDocVisitor::visitPre

(

DocSimpleListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 559 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocSimpleListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 565 of file htmldocvisitor.cpp.

References DocNode::isPreformatted().

void HtmlDocVisitor::visitPre

(

DocSection *

)

[virtual]

Implements DocVisitor.

Definition at line 572 of file htmldocvisitor.cpp.

References DocSection::anchor(), convertCharEntitiesToUTF8(), DocSection::level(), and DocSection::title().

void HtmlDocVisitor::visitPost

(

DocSection *

)

[virtual]

Implements DocVisitor.

Definition at line 582 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlList *

)

[virtual]

Implements DocVisitor.

Definition at line 586 of file htmldocvisitor.cpp.

References DocHtmlList::attribs(), DocHtmlList::Ordered, and DocHtmlList::type().

void HtmlDocVisitor::visitPost

(

DocHtmlList *

)

[virtual]

Implements DocVisitor.

Definition at line 599 of file htmldocvisitor.cpp.

References DocNode::isPreformatted(), DocHtmlList::Ordered, and DocHtmlList::type().

void HtmlDocVisitor::visitPre

(

DocHtmlListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 613 of file htmldocvisitor.cpp.

References DocHtmlListItem::attribs(), and DocNode::isPreformatted().

void HtmlDocVisitor::visitPost

(

DocHtmlListItem *

)

[virtual]

Implements DocVisitor.

Definition at line 620 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlDescList *

)

[virtual]

Implements DocVisitor.

Definition at line 626 of file htmldocvisitor.cpp.

References DocHtmlDescList::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlDescList *

)

[virtual]

Implements DocVisitor.

Definition at line 632 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlDescTitle *

)

[virtual]

Implements DocVisitor.

Definition at line 638 of file htmldocvisitor.cpp.

References DocHtmlDescTitle::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlDescTitle *

)

[virtual]

Implements DocVisitor.

Definition at line 644 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlDescData *

)

[virtual]

Implements DocVisitor.

Definition at line 650 of file htmldocvisitor.cpp.

References DocHtmlDescData::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlDescData *

)

[virtual]

Implements DocVisitor.

Definition at line 656 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlTable *

)

[virtual]

Implements DocVisitor.

Definition at line 662 of file htmldocvisitor.cpp.

References DocHtmlTable::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlTable *

)

[virtual]

Implements DocVisitor.

Definition at line 684 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlRow *

)

[virtual]

Implements DocVisitor.

Definition at line 690 of file htmldocvisitor.cpp.

References DocHtmlRow::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlRow *

)

[virtual]

Implements DocVisitor.

Definition at line 696 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlCell *

)

[virtual]

Implements DocVisitor.

Definition at line 702 of file htmldocvisitor.cpp.

References DocHtmlCell::attribs(), and DocHtmlCell::isHeading().

void HtmlDocVisitor::visitPost

(

DocHtmlCell *

)

[virtual]

Implements DocVisitor.

Definition at line 715 of file htmldocvisitor.cpp.

References DocHtmlCell::isHeading().

void HtmlDocVisitor::visitPre

(

DocHtmlCaption *

)

[virtual]

Implements DocVisitor.

Definition at line 721 of file htmldocvisitor.cpp.

References DocHtmlCaption::attribs().

void HtmlDocVisitor::visitPost

(

DocHtmlCaption *

)

[virtual]

Implements DocVisitor.

Definition at line 736 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocInternal *

)

[virtual]

Implements DocVisitor.

Definition at line 742 of file htmldocvisitor.cpp.

References theTranslator, and Translator::trForInternalUseOnly().

void HtmlDocVisitor::visitPost

(

DocInternal *

)

[virtual]

Implements DocVisitor.

Definition at line 749 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHRef *

)

[virtual]

Implements DocVisitor.

Definition at line 755 of file htmldocvisitor.cpp.

References DocHRef::attribs(), and DocHRef::url().

void HtmlDocVisitor::visitPost

(

DocHRef *

)

[virtual]

Implements DocVisitor.

Definition at line 762 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocHtmlHeader *

)

[virtual]

Implements DocVisitor.

Definition at line 768 of file htmldocvisitor.cpp.

References DocHtmlHeader::attribs(), and DocHtmlHeader::level().

void HtmlDocVisitor::visitPost

(

DocHtmlHeader *

)

[virtual]

Implements DocVisitor.

Definition at line 775 of file htmldocvisitor.cpp.

References DocHtmlHeader::level().

void HtmlDocVisitor::visitPre

(

DocImage *

)

[virtual]

Implements DocVisitor.

Definition at line 781 of file htmldocvisitor.cpp.

References DocImage::hasCaption(), DocImage::Html, DocImage::name(), DocImage::relPath(), and DocImage::type().

void HtmlDocVisitor::visitPost

(

DocImage *

)

[virtual]

Implements DocVisitor.

Definition at line 807 of file htmldocvisitor.cpp.

References DocImage::hasCaption(), DocImage::Html, and DocImage::type().

void HtmlDocVisitor::visitPre

(

DocDotFile *

)

[virtual]

Implements DocVisitor.

Definition at line 824 of file htmldocvisitor.cpp.

References DocDotFile::context(), DocDotFile::file(), DocDotFile::hasCaption(), and DocDotFile::relPath().

void HtmlDocVisitor::visitPost

(

DocDotFile *

)

[virtual]

Implements DocVisitor.

Definition at line 835 of file htmldocvisitor.cpp.

References DocDotFile::hasCaption().

void HtmlDocVisitor::visitPre

(

DocLink *

)

[virtual]

Implements DocVisitor.

Definition at line 845 of file htmldocvisitor.cpp.

References DocLink::anchor(), DocLink::file(), DocLink::ref(), and DocLink::relPath().

void HtmlDocVisitor::visitPost

(

DocLink *

)

[virtual]

Implements DocVisitor.

Definition at line 851 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocRef *

)

[virtual]

Implements DocVisitor.

Definition at line 857 of file htmldocvisitor.cpp.

References DocRef::anchor(), DocRef::file(), DocRef::hasLinkText(), DocRef::ref(), DocRef::relPath(), and DocRef::targetTitle().

void HtmlDocVisitor::visitPost

(

DocRef *

)

[virtual]

Implements DocVisitor.

Definition at line 867 of file htmldocvisitor.cpp.

References DocRef::file().

void HtmlDocVisitor::visitPre

(

DocSecRefItem *

)

[virtual]

Implements DocVisitor.

Definition at line 874 of file htmldocvisitor.cpp.

References DocSecRefItem::anchor(), DocSecRefItem::file(), and Doxygen::htmlFileExtension.

void HtmlDocVisitor::visitPost

(

DocSecRefItem *

)

[virtual]

Implements DocVisitor.

Definition at line 887 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocSecRefList *

)

[virtual]

Implements DocVisitor.

Definition at line 893 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocSecRefList *

)

[virtual]

Implements DocVisitor.

Definition at line 900 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocParamSect *

)

[virtual]

Implements DocVisitor.

Definition at line 926 of file htmldocvisitor.cpp.

References DocParamSect::Exception, DocParamSect::Param, DocParamSect::RetVal, DocParamSect::TemplateParam, theTranslator, Translator::trExceptions(), Translator::trParameters(), Translator::trReturnValues(), and DocParamSect::type().

void HtmlDocVisitor::visitPost

(

DocParamSect *

)

[virtual]

Implements DocVisitor.

Definition at line 951 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocParamList *

)

[virtual]

Implements DocVisitor.

Definition at line 958 of file htmldocvisitor.cpp.

References DocParamList::direction(), DocParamSect::In, DocParamSect::InOut, DocNode::Kind_LinkedWord, DocNode::Kind_Word, DocParamSect::Out, DocParamList::parameters(), DocParamSect::Unspecified, and visit().

void HtmlDocVisitor::visitPost

(

DocParamList *

)

[virtual]

Implements DocVisitor.

Definition at line 1000 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocXRefItem *

)

[virtual]

Implements DocVisitor.

Definition at line 1006 of file htmldocvisitor.cpp.

References DocXRefItem::anchor(), DocXRefItem::file(), Doxygen::htmlFileExtension, DocXRefItem::relPath(), and DocXRefItem::title().

void HtmlDocVisitor::visitPost

(

DocXRefItem *

)

[virtual]

Implements DocVisitor.

Definition at line 1026 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocInternalRef *

)

[virtual]

Implements DocVisitor.

Definition at line 1032 of file htmldocvisitor.cpp.

References DocInternalRef::anchor(), DocInternalRef::file(), and DocInternalRef::relPath().

void HtmlDocVisitor::visitPost

(

DocInternalRef *

)

[virtual]

Implements DocVisitor.

Definition at line 1038 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocCopy *

)

[virtual]

Implements DocVisitor.

Definition at line 1045 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocCopy *

)

[virtual]

Implements DocVisitor.

Definition at line 1049 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPre

(

DocText *

)

[virtual]

Implements DocVisitor.

Definition at line 1053 of file htmldocvisitor.cpp.

void HtmlDocVisitor::visitPost

(

DocText *

)

[virtual]

Implements DocVisitor.

Definition at line 1057 of file htmldocvisitor.cpp.

---

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

• htmldocvisitor.h
• htmldocvisitor.cpp

---

• ソフトウェア開発
• ホームページ制作
• Tcl版
• STLport版
• Dradnats C++ Library
• 要約文庫