DocVerbatim Class Reference

Node representing a verbatim, unparsed text fragment. More...

#include <src/docnode.h>

Inheritance diagram for DocVerbatim:

Collaboration diagram for DocVerbatim:

Classes
struct	Private

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

Public Member Functions
	DocVerbatim (DocParser *parser, DocNodeVariant *parent, const QCString &context, const QCString &text, Type t, bool isExample, const QCString &exampleFile, bool isBlock=FALSE, const QCString &lang=QCString())
Type	type () const
QCString	text () const
QCString	context () const
bool	isExample () const
QCString	exampleFile () const
QCString	relPath () const
QCString	language () const
bool	isBlock () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	engine () const
bool	useBitmap () const
const DocNodeList &	children () const
DocNodeList &	children ()
QCString	srcFile () const
int	srcLine () const
void	setText (const QCString &t)
void	setWidth (const QCString &w)
void	setHeight (const QCString &h)
void	setEngine (const QCString &e)
void	setUseBitmap (const bool &u)
void	setLocation (const QCString &file, int line)
Public Member Functions inherited from DocNode
	DocNode (DocParser *parser, DocNodeVariant *parent)
	~DocNode ()=default
DocNodeVariant *	parent ()
const DocNodeVariant *	parent () const
DocNodeVariant *	thisVariant ()
const DocNodeVariant *	thisVariant () const
void	setThisVariant (DocNodeVariant *thisVariant)
DocParser *	parser ()
const DocParser *	parser () const
void	setParent (DocNodeVariant *parent)
bool	isPreformatted () const

Private Attributes
std::unique_ptr< Private >	p

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType { Unknown , Anchor , Section , Table }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing a verbatim, unparsed text fragment.

Definition at line 371 of file docnode.h.

Member Enumeration Documentation

Type

enum DocVerbatim::Type

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

Definition at line 374 of file docnode.h.

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

Constructor & Destructor Documentation

DocVerbatim()

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

Definition at line 258 of file docnode.cpp.

  : DocNode(parser,parent), p(std::make_unique<Private>(context, text, t, isExample, exampleFile, parser->context.relPath, lang, isBlock))
{
}

References context(), DocNode::DocNode(), exampleFile(), isBlock(), isExample(), p, DocNode::parent(), DocNode::parser(), relPath(), and text().

Member Function Documentation

children() [1/2]

DocNodeList & DocVerbatim::children ( )

inline

Definition at line 392 of file docnode.h.

{ return p->children; }

References p.

children() [2/2]

const DocNodeList & DocVerbatim::children ( ) const

inline

Definition at line 391 of file docnode.h.

{ return p->children; }

References p.

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

context()

QCString DocVerbatim::context ( ) const

inline

Definition at line 380 of file docnode.h.

{ return p->context; }

References p.

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

engine()

QCString DocVerbatim::engine ( ) const

inline

Definition at line 389 of file docnode.h.

{ return p->engine; }

References p.

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

exampleFile()

QCString DocVerbatim::exampleFile ( ) const

inline

Definition at line 382 of file docnode.h.

{ return p->exampleFile; }

References p.

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

hasCaption()

bool DocVerbatim::hasCaption ( ) const

inline

Definition at line 386 of file docnode.h.

{ return !p->children.empty(); }

References p.

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

height()

QCString DocVerbatim::height ( ) const

inline

Definition at line 388 of file docnode.h.

{ return p->height; }

References p.

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

isBlock()

bool DocVerbatim::isBlock ( ) const

inline

Definition at line 385 of file docnode.h.

{ return p->isBlock; }

References p.

Referenced by DocVerbatim(), mustBeOutsideParagraph(), HtmlDocVisitor::operator()(), and XmlDocVisitor::operator()().

isExample()

bool DocVerbatim::isExample ( ) const

inline

Definition at line 381 of file docnode.h.

{ return p->isExample; }

References p.

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

language()

QCString DocVerbatim::language ( ) const

inline

Definition at line 384 of file docnode.h.

{ return p->lang; }

References p.

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

relPath()

QCString DocVerbatim::relPath ( ) const

inline

Definition at line 383 of file docnode.h.

{ return p->relPath; }

References p.

Referenced by DocVerbatim(), HtmlDocVisitor::operator()(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), and DocbookDocVisitor::writePlantUMLFile().

setEngine()

void DocVerbatim::setEngine ( const QCString & e )

inline

Definition at line 398 of file docnode.h.

{ p->engine=e; }

References p.

Referenced by DocPara::handleCommand().

setHeight()

void DocVerbatim::setHeight ( const QCString & h )

inline

Definition at line 397 of file docnode.h.

{ p->height=h; }

References p.

setLocation()

void DocVerbatim::setLocation ( const QCString & file, int line )

inline

Definition at line 400 of file docnode.h.

{ p->srcFile=file; p->srcLine=line; }

References p.

setText()

void DocVerbatim::setText ( const QCString & t )

inline

Definition at line 395 of file docnode.h.

{ p->text=t;   }

References p.

setUseBitmap()

void DocVerbatim::setUseBitmap ( const bool & u )

inline

Definition at line 399 of file docnode.h.

{ p->useBitmap=u; }

References p.

setWidth()

void DocVerbatim::setWidth ( const QCString & w )

inline

Definition at line 396 of file docnode.h.

{ p->width=w;  }

References p.

srcFile()

QCString DocVerbatim::srcFile ( ) const

inline

Definition at line 393 of file docnode.h.

{ return p->srcFile; }

References p.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), and LatexDocVisitor::writeMscFile().

srcLine()

int DocVerbatim::srcLine ( ) const

inline

Definition at line 394 of file docnode.h.

{ return p->srcLine; }

References p.

Referenced by DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), DocbookDocVisitor::writeDiaFile(), LatexDocVisitor::writeDiaFile(), DocbookDocVisitor::writeDotFile(), DocbookDocVisitor::writeMscFile(), and LatexDocVisitor::writeMscFile().

text()

QCString DocVerbatim::text ( ) const

inline

Definition at line 379 of file docnode.h.

{ return p->text; }

References p.

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

type()

Type DocVerbatim::type ( ) const

inline

Definition at line 378 of file docnode.h.

{ return p->type; }

References p.

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

useBitmap()

bool DocVerbatim::useBitmap ( ) const

inline

Definition at line 390 of file docnode.h.

{ return p->useBitmap; }

References p.

Referenced by LatexDocVisitor::operator()(), and LatexDocVisitor::writePlantUMLFile().

width()

QCString DocVerbatim::width ( ) const

inline

Definition at line 387 of file docnode.h.

{ return p->width; }

References p.

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

Member Data Documentation

p

std::unique_ptr<Private> DocVerbatim::p

private

Definition at line 425 of file docnode.h.

Referenced by children(), children(), context(), DocVerbatim(), engine(), exampleFile(), hasCaption(), height(), isBlock(), isExample(), language(), relPath(), setEngine(), setHeight(), setLocation(), setText(), setUseBitmap(), setWidth(), srcFile(), srcLine(), text(), type(), useBitmap(), and width().

---

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

• src/docnode.h
• src/docnode.cpp