The DocVerbatim Class Reference

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

Declaration

class DocVerbatim { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocNode
	Abstract node interface with type information. More...

Enumerations Index

enum	Type { ... }

Public Constructors Index

	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())

Public Member Functions Index

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)

Private Member Attributes Index

std::unique_ptr< Private >	p

Description

Node representing a verbatim, unparsed text fragment.

Definition at line 375 of file docnode.h.

Enumerations

Type

enum DocVerbatim::Type

Enumeration values

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

Definition at line 378 of file docnode.h.

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

Public Constructors

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())

Declaration at line 379 of file docnode.h, definition at line 258 of file docnode.cpp.

258DocVerbatim::DocVerbatim(DocParser *parser,DocNodeVariant *parent,const QCString &context,

259 const QCString &text, Type t,bool isExample,

260 const QCString &exampleFile,bool isBlock,const QCString &lang)

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

262{

263}

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

Public Member Functions

children()

const DocNodeList & DocVerbatim::children ()

inline

Definition at line 395 of file docnode.h.

395 const DocNodeList &children() const { return p->children; }

Reference p.

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

children()

DocNodeList & DocVerbatim::children ()

inline

Definition at line 396 of file docnode.h.

396 DocNodeList &children() { return p->children; }

Reference p.

context()

QCString DocVerbatim::context ()

inline

Definition at line 384 of file docnode.h.

384 QCString context() const { return p->context; }

Reference p.

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

engine()

QCString DocVerbatim::engine ()

inline

Definition at line 393 of file docnode.h.

393 QCString engine() const { return p->engine; }

Reference p.

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

exampleFile()

QCString DocVerbatim::exampleFile ()

inline

Definition at line 386 of file docnode.h.

386 QCString exampleFile() const { return p->exampleFile; }

Reference p.

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

hasCaption()

bool DocVerbatim::hasCaption ()

inline

Definition at line 390 of file docnode.h.

390 bool hasCaption() const { return !p->children.empty(); }

Reference 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 ()

inline

Definition at line 392 of file docnode.h.

392 QCString height() const { return p->height; }

Reference 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 ()

inline

Definition at line 389 of file docnode.h.

389 bool isBlock() const { return p->isBlock; }

Reference p.

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

isExample()

bool DocVerbatim::isExample ()

inline

Definition at line 385 of file docnode.h.

385 bool isExample() const { return p->isExample; }

Reference p.

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

language()

QCString DocVerbatim::language ()

inline

Definition at line 388 of file docnode.h.

388 QCString language() const { return p->lang; }

Reference p.

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

relPath()

QCString DocVerbatim::relPath ()

inline

Definition at line 387 of file docnode.h.

387 QCString relPath() const { return p->relPath; }

Reference p.

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

setEngine()

void DocVerbatim::setEngine (const QCString & e)

inline

Definition at line 402 of file docnode.h.

402 void setEngine(const QCString &e) { p->engine=e; }

Reference p.

Referenced by DocPara::handleCommand.

setHeight()

void DocVerbatim::setHeight (const QCString & h)

inline

Definition at line 401 of file docnode.h.

401 void setHeight(const QCString &h) { p->height=h; }

Reference p.

setLocation()

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

inline

Definition at line 404 of file docnode.h.

404 void setLocation(const QCString &file,int line) { p->srcFile=file; p->srcLine=line; }

Reference p.

setText()

void DocVerbatim::setText (const QCString & t)

inline

Definition at line 399 of file docnode.h.

399 void setText(const QCString &t) { p->text=t; }

Reference p.

setUseBitmap()

void DocVerbatim::setUseBitmap (const bool & u)

inline

Definition at line 403 of file docnode.h.

403 void setUseBitmap(const bool &u) { p->useBitmap=u; }

Reference p.

setWidth()

void DocVerbatim::setWidth (const QCString & w)

inline

Definition at line 400 of file docnode.h.

400 void setWidth(const QCString &w) { p->width=w; }

Reference p.

srcFile()

QCString DocVerbatim::srcFile ()

inline

Definition at line 397 of file docnode.h.

397 QCString srcFile() const { return p->srcFile; }

Reference 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 ()

inline

Definition at line 398 of file docnode.h.

398 int srcLine() const { return p->srcLine; }

Reference 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 ()

inline

Definition at line 383 of file docnode.h.

383 QCString text() const { return p->text; }

Reference 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 ()

inline

Definition at line 382 of file docnode.h.

382 Type type() const { return p->type; }

Reference 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 ()

inline

Definition at line 394 of file docnode.h.

394 bool useBitmap() const { return p->useBitmap; }

Reference p.

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

width()

QCString DocVerbatim::width ()

inline

Definition at line 391 of file docnode.h.

391 QCString width() const { return p->width; }

Reference p.

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

Private Member Attributes

p

std::unique_ptr<Private> DocVerbatim::p

Definition at line 429 of file docnode.h.

429 std::unique_ptr<Private> p;

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:

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.