DocImage Class Reference

Node representing an image. More...

#include <src/docnode.h>

Inheritance diagram for DocImage:

Collaboration diagram for DocImage:

Classes
struct	Private

Public Types
enum	Type {   Html , Latex , Rtf , DocBook ,   Xml }

Public Member Functions
	DocImage (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, const QCString &name, Type t, const QCString &url=QCString(), bool inlineImage=TRUE)
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 ()
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

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 an image.

Definition at line 641 of file docnode.h.

Member Enumeration Documentation

Type

enum DocImage::Type

Enumerator
Html
Latex
Rtf
DocBook
Xml

Definition at line 644 of file docnode.h.

{ Html, Latex, Rtf, DocBook, Xml };

Constructor & Destructor Documentation

DocImage()

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

Definition at line 1314 of file docnode.cpp.

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

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

Member Function Documentation

attribs()

const HtmlAttribList & DocImage::attribs ( ) const

inline

Definition at line 656 of file docnode.h.

{ return p->attribs; }

References p.

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

hasCaption()

bool DocImage::hasCaption ( ) const

inline

Definition at line 649 of file docnode.h.

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

inline

Definition at line 651 of file docnode.h.

{ return p->height; }

References p.

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

isInlineImage()

bool DocImage::isInlineImage ( ) const

inline

Definition at line 654 of file docnode.h.

{ return p->inlineImage; }

References p.

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

isSVG()

bool DocImage::isSVG

(

)

const

Definition at line 1320 of file docnode.cpp.

{
  QCString  locName = p->url.isEmpty() ? p->name : p->url;
  int len = static_cast<int>(locName.length());
  int fnd = locName.find('?'); // ignore part from ? until end
  if (fnd==-1) fnd=len;
  return fnd>=4 && locName.mid(fnd-4,4)==".svg";
}

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

Referenced by HtmlDocVisitor::operator()().

name()

QCString DocImage::name ( ) const

inline

Definition at line 648 of file docnode.h.

{ return p->name; }

References p.

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

parse()

void DocImage::parse

(

)

Definition at line 1329 of file docnode.cpp.

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

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

relPath()

QCString DocImage::relPath ( ) const

inline

Definition at line 652 of file docnode.h.

{ return p->relPath; }

References p.

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

type()

Type DocImage::type ( ) const

inline

Definition at line 647 of file docnode.h.

{ return p->type; }

References p.

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

url()

QCString DocImage::url ( ) const

inline

Definition at line 653 of file docnode.h.

{ return p->url; }

References p.

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

width()

QCString DocImage::width ( ) const

inline

Definition at line 650 of file docnode.h.

{ return p->width; }

References p.

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

Member Data Documentation

p

std::unique_ptr<Private> DocImage::p

private

Definition at line 675 of file docnode.h.

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:

• src/docnode.h
• src/docnode.cpp