The DocImage Class Reference

Node representing an image. More...

Declaration

class DocImage { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocCompoundNode
	Base class for nodes with children. More...

Enumerations Index

enum	Type { ... }

Public Constructors Index

	DocImage (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, const QCString &name, Type t, const QCString &url=QCString(), bool inlineImage=TRUE)

Public Member Functions Index

Type	type () const
QCString	name () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	relPath () const
QCString	url () const
bool	isInlineImage () const
bool	isSVG () const
const HtmlAttribList &	attribs () const
void	parse ()

Private Member Attributes Index

std::unique_ptr< Private >	p

Description

Node representing an image.

Definition at line 641 of file docnode.h.

Enumerations

Type

enum DocImage::Type

Enumeration values

Html
Latex
Rtf
DocBook
Xml

Definition at line 644 of file docnode.h.

644 enum Type { Html, Latex, Rtf, DocBook, Xml };

Public Constructors

DocImage()

DocImage::DocImage (DocParser * parser, DocNodeVariant * parent, const HtmlAttribList & attribs, const QCString & name, Type t, const QCString & url=QCString(), bool inlineImage=TRUE)

Declaration at line 645 of file docnode.h, definition at line 1281 of file docnode.cpp.

1281DocImage::DocImage(DocParser *parser,DocNodeVariant *parent,const HtmlAttribList &attribs,const QCString &name,

1282 Type t,const QCString &url, bool inlineImage) :

1283 DocCompoundNode(parser,parent), p(std::make_unique<Private>(attribs, name, t, parser->context.relPath, url, inlineImage))

1284{

1285}

References attribs, DocCompoundNode::DocCompoundNode, name, p, DocNode::parent, DocNode::parser, relPath and url.

Public Member Functions

attribs()

const HtmlAttribList & DocImage::attribs ()

inline

Definition at line 656 of file docnode.h.

656 const HtmlAttribList &attribs() const { return p->attribs; }

Reference p.

Referenced by DocImage, HtmlDocVisitor::operator() and XmlDocVisitor::operator().

hasCaption()

bool DocImage::hasCaption ()

inline

Definition at line 649 of file docnode.h.

649 bool hasCaption() const { return !children().empty(); }

References DocCompoundNode::children and GrowVector< T >::empty.

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

height()

QCString DocImage::height ()

inline

Definition at line 651 of file docnode.h.

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

Reference p.

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

isInlineImage()

bool DocImage::isInlineImage ()

inline

Definition at line 654 of file docnode.h.

654 bool isInlineImage() const { return p->inlineImage; }

Reference p.

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

isSVG()

bool DocImage::isSVG ()

Declaration at line 655 of file docnode.h, definition at line 1287 of file docnode.cpp.

1287bool DocImage::isSVG() const

1288{

1289 QCString locName = p->url.isEmpty() ? p->name : p->url;

1290 int len = static_cast<int>(locName.length());

1291 int fnd = locName.find('?'); // ignore part from ? until end

1292 if (fnd==-1) fnd=len;

1293 return fnd>=4 && locName.mid(fnd-4,4)==".svg";

1294}

References QCString::find, QCString::length, QCString::mid and p.

Referenced by HtmlDocVisitor::operator().

name()

QCString DocImage::name ()

inline

Definition at line 648 of file docnode.h.

648 QCString name() const { return p->name; }

Reference p.

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

parse()

void DocImage::parse ()

Declaration at line 657 of file docnode.h, definition at line 1296 of file docnode.cpp.

1296void DocImage::parse()

1297{

1298 parser()->defaultHandleTitleAndSize(CommandType::CMD_IMAGE,thisVariant(),children(),p->width,p->height);

1299}

References DocCompoundNode::children, CMD_IMAGE, DocParser::defaultHandleTitleAndSize, p, DocNode::parser and DocNode::thisVariant.

relPath()

QCString DocImage::relPath ()

inline

Definition at line 652 of file docnode.h.

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

Reference p.

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

type()

Type DocImage::type ()

inline

Definition at line 647 of file docnode.h.

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

Reference p.

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

url()

QCString DocImage::url ()

inline

Definition at line 653 of file docnode.h.

653 QCString url() const { return p->url; }

Reference p.

Referenced by DocImage, HtmlDocVisitor::operator() and XmlDocVisitor::operator().

width()

QCString DocImage::width ()

inline

Definition at line 650 of file docnode.h.

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

Reference p.

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

Private Member Attributes

p

std::unique_ptr<Private> DocImage::p

Definition at line 675 of file docnode.h.

675 std::unique_ptr<Private> p;

Referenced by attribs, DocImage, height, isInlineImage, isSVG, name, parse, relPath, type, url 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.