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 , Mermaid ,   JavaDocCode , JavaDocLiteral }

Public Member Functions
	DocVerbatim (DocParser *parser, DocNodeVariant *parent, const DString &context, const DString &text, Type t, bool isExample, const DString &exampleFile, bool isBlock=false, const DString &lang=DString())
Type	type () const
DString	text () const
DString	context () const
bool	isExample () const
DString	exampleFile () const
DString	relPath () const
DString	language () const
bool	isBlock () const
bool	hasCaption () const
DString	width () const
DString	height () const
DString	engine () const
bool	useBitmap () const
const DocNodeList &	children () const
DocNodeList &	children ()
DString	srcFile () const
int	srcLine () const
void	setText (const DString &t)
void	setWidth (const DString &w)
void	setHeight (const DString &h)
void	setEngine (const DString &e)
void	setUseBitmap (const bool &u)
void	setLocation (const DString &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 ,   Requirement }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing a verbatim, unparsed text fragment.

Definition at line 375 of file docnode.h.

Member Enumeration Documentation

Type

enum DocVerbatim::Type

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

Definition at line 378 of file docnode.h.

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

Constructor & Destructor Documentation

DocVerbatim()

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

Definition at line 260 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 396 of file docnode.h.

{ return p->children; }

References p.

children() [2/2]

const DocNodeList & DocVerbatim::children ( ) const

inline

Definition at line 395 of file docnode.h.

{ return p->children; }

References p.

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

context()

DString DocVerbatim::context ( ) const

inline

Definition at line 384 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()

DString DocVerbatim::engine ( ) const

inline

Definition at line 393 of file docnode.h.

{ return p->engine; }

References p.

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

exampleFile()

DString DocVerbatim::exampleFile ( ) const

inline

Definition at line 386 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 390 of file docnode.h.

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

References p.

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

height()

DString DocVerbatim::height ( ) const

inline

Definition at line 392 of file docnode.h.

{ return p->height; }

References p.

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

isBlock()

bool DocVerbatim::isBlock ( ) const

inline

Definition at line 389 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 385 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()

DString DocVerbatim::language ( ) const

inline

Definition at line 388 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()

DString DocVerbatim::relPath ( ) const

inline

Definition at line 387 of file docnode.h.

{ return p->relPath; }

References p.

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

setEngine()

void DocVerbatim::setEngine ( const DString & e )

inline

Definition at line 402 of file docnode.h.

{ p->engine=e; }

References p.

Referenced by DocPara::handleCommand().

setHeight()

void DocVerbatim::setHeight ( const DString & h )

inline

Definition at line 401 of file docnode.h.

{ p->height=h; }

References p.

setLocation()

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

inline

Definition at line 404 of file docnode.h.

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

References p.

setText()

void DocVerbatim::setText ( const DString & t )

inline

Definition at line 399 of file docnode.h.

{ p->text=t;   }

References p.

setUseBitmap()

void DocVerbatim::setUseBitmap ( const bool & u )

inline

Definition at line 403 of file docnode.h.

{ p->useBitmap=u; }

References p.

setWidth()

void DocVerbatim::setWidth ( const DString & w )

inline

Definition at line 400 of file docnode.h.

{ p->width=w;  }

References p.

srcFile()

DString DocVerbatim::srcFile ( ) const

inline

Definition at line 397 of file docnode.h.

{ return p->srcFile; }

References p.

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

srcLine()

int DocVerbatim::srcLine ( ) const

inline

Definition at line 398 of file docnode.h.

{ return p->srcLine; }

References p.

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

text()

DString DocVerbatim::text ( ) const

inline

Definition at line 383 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 382 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 394 of file docnode.h.

{ return p->useBitmap; }

References p.

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

width()

DString DocVerbatim::width ( ) const

inline

Definition at line 391 of file docnode.h.

{ return p->width; }

References p.

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

Member Data Documentation

p

std::unique_ptr<Private> DocVerbatim::p

private

Definition at line 429 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