DocDiagramFileBase Class Reference

#include <src/docnode.h>

Inheritance diagram for DocDiagramFileBase:

Collaboration diagram for DocDiagramFileBase:

Classes
struct	Private

Public Member Functions
	DocDiagramFileBase (DocParser *parser, DocNodeVariant *parent, const DString &name, const DString &context, const DString &srcFile, int srcLine)
DString	name () const
DString	file () const
DString	relPath () const
bool	hasCaption () const
DString	width () const
DString	height () const
DString	context () const
DString	srcFile () const
int	srcLine () const
Public Member Functions inherited from DocCompoundNode
	DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList &	children ()
const DocNodeList &	children () const
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

Protected 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

Definition at line 678 of file docnode.h.

Constructor & Destructor Documentation

DocDiagramFileBase()

DocDiagramFileBase::DocDiagramFileBase ( DocParser * parser, DocNodeVariant * parent, const DString & name, const DString & context, const DString & srcFile, int srcLine )

inline

Definition at line 681 of file docnode.h.

    : DocCompoundNode(parser,parent), p(std::make_unique<Private>(name, context, srcFile, srcLine)) {}

References context(), DocCompoundNode::DocCompoundNode(), name(), p, DocNode::parent(), DocNode::parser(), srcFile(), and srcLine().

Referenced by DocDiaFile::DocDiaFile(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), and DocPlantUmlFile::DocPlantUmlFile().

Member Function Documentation

context()

DString DocDiagramFileBase::context ( ) const

inline

Definition at line 690 of file docnode.h.

{ return p->context; }

References p.

Referenced by DocDiaFile::DocDiaFile(), DocDiagramFileBase(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), DocDiaFile::parse(), DocDotFile::parse(), DocMermaidFile::parse(), DocMscFile::parse(), and DocPlantUmlFile::parse().

file()

DString DocDiagramFileBase::file ( ) const

inline

Definition at line 685 of file docnode.h.

{ return p->file; }

References p.

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

hasCaption()

bool DocDiagramFileBase::hasCaption ( ) const

inline

Definition at line 687 of file docnode.h.

{ return !children().empty(); }

References DocCompoundNode::children(), and GrowVector< T >::empty().

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

height()

DString DocDiagramFileBase::height ( ) const

inline

Definition at line 689 of file docnode.h.

{ return p->height; }

References p.

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

name()

DString DocDiagramFileBase::name ( ) const

inline

Definition at line 684 of file docnode.h.

{ return p->name; }

References p.

Referenced by DocDiaFile::DocDiaFile(), DocDiagramFileBase(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), PrintDocVisitor::operator()(), PrintDocVisitor::operator()(), PrintDocVisitor::operator()(), PrintDocVisitor::operator()(), and PrintDocVisitor::operator()().

relPath()

DString DocDiagramFileBase::relPath ( ) const

inline

Definition at line 686 of file docnode.h.

{ return p->relPath; }

References p.

Referenced by DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), and HtmlDocVisitor::operator()().

srcFile()

DString DocDiagramFileBase::srcFile ( ) const

inline

Definition at line 691 of file docnode.h.

{ return p->srcFile; }

References p.

Referenced by DocDiaFile::DocDiaFile(), DocDiagramFileBase(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), and RTFDocVisitor::operator()().

srcLine()

int DocDiagramFileBase::srcLine ( ) const

inline

Definition at line 692 of file docnode.h.

{ return p->srcLine; }

References p.

Referenced by DocDiaFile::DocDiaFile(), DocDiagramFileBase(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), DocbookDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), HtmlDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), LatexDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), RTFDocVisitor::operator()(), and RTFDocVisitor::operator()().

width()

DString DocDiagramFileBase::width ( ) const

inline

Definition at line 688 of file docnode.h.

{ return p->width; }

References p.

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

Member Data Documentation

p

std::unique_ptr<Private> DocDiagramFileBase::p

protected

Definition at line 708 of file docnode.h.

Referenced by context(), DocDiaFile::DocDiaFile(), DocDiagramFileBase(), DocDotFile::DocDotFile(), DocMermaidFile::DocMermaidFile(), DocMscFile::DocMscFile(), DocPlantUmlFile::DocPlantUmlFile(), file(), height(), name(), DocDiaFile::parse(), DocDotFile::parse(), DocMermaidFile::parse(), DocMscFile::parse(), DocPlantUmlFile::parse(), relPath(), srcFile(), srcLine(), and width().

---

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

• src/docnode.h