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 QCString &name, const QCString &context, const QCString &srcFile, int srcLine)
QCString	name () const
QCString	file () const
QCString	relPath () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	context () const
QCString	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 }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Definition at line 672 of file docnode.h.

Constructor & Destructor Documentation

DocDiagramFileBase()

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

inline

Definition at line 675 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(), DocMscFile::DocMscFile(), and DocPlantUmlFile::DocPlantUmlFile().

Member Function Documentation

context()

QCString DocDiagramFileBase::context ( ) const

inline

Definition at line 684 of file docnode.h.

{ return p->context; }

References p.

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

file()

QCString DocDiagramFileBase::file ( ) const

inline

Definition at line 679 of file docnode.h.

{ return p->file; }

References p.

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

hasCaption()

bool DocDiagramFileBase::hasCaption ( ) const

inline

Definition at line 681 of file docnode.h.

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

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

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

height()

QCString DocDiagramFileBase::height ( ) const

inline

Definition at line 683 of file docnode.h.

{ return p->height; }

References p.

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

name()

QCString DocDiagramFileBase::name ( ) const

inline

Definition at line 678 of file docnode.h.

{ return p->name; }

References p.

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

relPath()

QCString DocDiagramFileBase::relPath ( ) const

inline

Definition at line 680 of file docnode.h.

{ return p->relPath; }

References p.

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

srcFile()

QCString DocDiagramFileBase::srcFile ( ) const

inline

Definition at line 685 of file docnode.h.

{ return p->srcFile; }

References p.

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

srcLine()

int DocDiagramFileBase::srcLine ( ) const

inline

Definition at line 686 of file docnode.h.

{ return p->srcLine; }

References p.

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

width()

QCString DocDiagramFileBase::width ( ) const

inline

Definition at line 682 of file docnode.h.

{ return p->width; }

References p.

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

Member Data Documentation

p

std::unique_ptr<Private> DocDiagramFileBase::p

protected

Definition at line 702 of file docnode.h.

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

---

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

• src/docnode.h