#include <docparser.h>

Inheritance diagram for DocVerbatim:

Public Types
enum	Type { Code, HtmlOnly, ManOnly, LatexOnly, RtfOnly, XmlOnly, Verbatim, Dot, Msc, DocbookOnly, PlantUML }

Public Types inherited from DocNode
enum	Kind { Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3, Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7, Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11, Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15, Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19, Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23, Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27, Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31, Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35, Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39, Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43, Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47, Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51, Kind_DiaFile = 52 }

Public Member Functions
	DocVerbatim (DocNode *parent, const QCString &context, const QCString &text, Type t, bool isExample, const QCString &exampleFile, bool isBlock=FALSE, const QCString &lang=QCString())

Kind	kind () const

Type	type () const

QCString	text () const

QCString	context () const

void	accept (DocVisitor *v)

bool	isExample () const

QCString	exampleFile () const

QCString	relPath () const

QCString	language () const

bool	isBlock () const

bool	hasCaption () const

QCString	width () const

QCString	height () const

const QList< DocNode > &	children () const

QList< DocNode > &	children ()

void	setText (const QCString &t)

void	setWidth (const QCString &w)

void	setHeight (const QCString &h)

Public Member Functions inherited from DocNode
	DocNode ()

virtual	~DocNode ()

DocNode *	parent () const

void	setParent (DocNode *parent)

bool	isPreformatted () const

Private Attributes
QCString	m_context

QCString	m_text

Type	m_type

bool	m_isExample

QCString	m_exampleFile

QCString	m_relPath

QCString	m_lang

bool	m_isBlock

QCString	m_width

QCString	m_height

QList< DocNode >	m_children

Additional Inherited Members
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a verbatim, unparsed text fragment

Definition at line 441 of file docparser.h.

Member Enumeration Documentation

enum DocVerbatim::Type

Enumerator
Code
HtmlOnly
ManOnly
LatexOnly
RtfOnly
XmlOnly
Verbatim
Dot
Msc
DocbookOnly
PlantUML

Definition at line 444 of file docparser.h.

{ Code, HtmlOnly, ManOnly, LatexOnly, RtfOnly, XmlOnly, Verbatim, Dot, Msc, DocbookOnly, PlantUML };

Constructor & Destructor Documentation

DocVerbatim::DocVerbatim	(	DocNode *	parent,
		const QCString &	context,
		const QCString &	text,
		Type	t,
		bool	isExample,
		const QCString &	exampleFile,
		bool	isBlock = `FALSE`,
		const QCString &	lang = `QCString()`
	)

Definition at line 1896 of file docparser.cpp.

References DocNode::m_parent, and DocNode::parent().

  : m_context(context), m_text(text), m_type(t),
    m_isExample(isExample), m_exampleFile(exampleFile),
    m_relPath(g_relPath), m_lang(lang), m_isBlock(isBlock)
{
  m_parent = parent;
}

Member Function Documentation

void DocVerbatim::accept ( DocVisitor * v )

inlinevirtual

Acceptor function for node visitors. Part of the visitor pattern.

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 452 of file docparser.h.

References DocVisitor::visit().

{ v->visit(this); }

const QList<DocNode>& DocVerbatim::children ( ) const

inline

Definition at line 461 of file docparser.h.

References m_children.

Referenced by DocPara::handleCommand(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), PerlModDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile(), and LatexDocVisitor::writePlantUMLFile().

{ return m_children; }

QList<DocNode>& DocVerbatim::children ( )

inline

Definition at line 462 of file docparser.h.

References m_children.

{ return m_children; }

QCString DocVerbatim::context ( ) const

inline

Definition at line 451 of file docparser.h.

References m_context.

Referenced by DocbookDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), and PerlModDocVisitor::visit().

{ return m_context; }

QCString DocVerbatim::exampleFile ( ) const

inline

Definition at line 454 of file docparser.h.

References m_exampleFile.

Referenced by DocbookDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), and LatexDocVisitor::visit().

{ return m_exampleFile; }

bool DocVerbatim::hasCaption ( ) const

inline

Definition at line 458 of file docparser.h.

References m_children.

Referenced by RTFDocVisitor::visit(), XmlDocVisitor::visit(), LatexDocVisitor::visit(), PerlModDocVisitor::visit(), visitPostCaption(), visitPreCaption(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile(), and LatexDocVisitor::writePlantUMLFile().

{ return !m_children.isEmpty(); }

QCString DocVerbatim::height ( ) const

inline

Definition at line 460 of file docparser.h.

References m_height.

Referenced by XmlDocVisitor::visit(), LatexDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile(), and LatexDocVisitor::writePlantUMLFile().

{ return m_height; }

bool DocVerbatim::isBlock ( ) const

inline

Definition at line 457 of file docparser.h.

References m_isBlock.

Referenced by mustBeOutsideParagraph(), and HtmlDocVisitor::visit().

{ return m_isBlock; }

bool DocVerbatim::isExample ( ) const

inline

Definition at line 453 of file docparser.h.

References m_isExample.

Referenced by DocbookDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), and LatexDocVisitor::visit().

{ return m_isExample; }

Kind DocVerbatim::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 448 of file docparser.h.

References DocNode::Kind_Verbatim.

{ return Kind_Verbatim; }

QCString DocVerbatim::language ( ) const

inline

Definition at line 456 of file docparser.h.

References m_lang.

Referenced by ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), and LatexDocVisitor::visit().

{ return m_lang; }

QCString DocVerbatim::relPath ( ) const

inline

Definition at line 455 of file docparser.h.

References m_relPath.

Referenced by HtmlDocVisitor::visit().

{ return m_relPath; }

void DocVerbatim::setHeight ( const QCString & h )

inline

Definition at line 465 of file docparser.h.

References m_height.

Referenced by DocPara::handleCommand().

{ m_height=h; }

void DocVerbatim::setText ( const QCString & t )

inline

Definition at line 463 of file docparser.h.

References m_text.

Referenced by DocPara::handleCommand().

{ m_text=t; }

void DocVerbatim::setWidth ( const QCString & w )

inline

Definition at line 464 of file docparser.h.

References m_width.

Referenced by DocPara::handleCommand().

{ m_width=w; }

QCString DocVerbatim::text ( ) const

inline

Definition at line 450 of file docparser.h.

References m_text.

Referenced by DocbookDocVisitor::visit(), ManDocVisitor::visit(), TextDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit(), HtmlDocVisitor::visit(), LatexDocVisitor::visit(), PrintDocVisitor::visit(), and PerlModDocVisitor::visit().

{ return m_text; }

Type DocVerbatim::type ( ) const

inline

Definition at line 449 of file docparser.h.

References m_type.

Referenced by mustBeOutsideParagraph(), DocbookDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), XmlDocVisitor::visit(), LatexDocVisitor::visit(), HtmlDocVisitor::visit(), PrintDocVisitor::visit(), and PerlModDocVisitor::visit().

{ return m_type; }

QCString DocVerbatim::width ( ) const

inline

Definition at line 459 of file docparser.h.

References m_width.

Referenced by XmlDocVisitor::visit(), LatexDocVisitor::visit(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), LatexDocVisitor::writeMscFile(), DocbookDocVisitor::writePlantUMLFile(), and LatexDocVisitor::writePlantUMLFile().

{ return m_width; }

Member Data Documentation

QList<DocNode> DocVerbatim::m_children

private

Definition at line 478 of file docparser.h.

Referenced by children(), and hasCaption().

QCString DocVerbatim::m_context

private

Definition at line 468 of file docparser.h.

Referenced by context().

QCString DocVerbatim::m_exampleFile

private

Definition at line 472 of file docparser.h.

Referenced by exampleFile().

QCString DocVerbatim::m_height

private

Definition at line 477 of file docparser.h.

Referenced by height(), and setHeight().

bool DocVerbatim::m_isBlock

private

Definition at line 475 of file docparser.h.

Referenced by isBlock().

bool DocVerbatim::m_isExample

private

Definition at line 471 of file docparser.h.

Referenced by isExample().

QCString DocVerbatim::m_lang

private

Definition at line 474 of file docparser.h.

Referenced by language().

QCString DocVerbatim::m_relPath

private

Definition at line 473 of file docparser.h.

Referenced by relPath().

QCString DocVerbatim::m_text

private

Definition at line 469 of file docparser.h.

Referenced by setText(), and text().

Type DocVerbatim::m_type

private

Definition at line 470 of file docparser.h.

Referenced by type().

QCString DocVerbatim::m_width

private

Definition at line 476 of file docparser.h.

Referenced by setWidth(), and width().

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

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation