DocDiaFile Class Reference

#include <docparser.h>

Inheritance diagram for DocDiaFile:

Public Member Functions
	DocDiaFile (DocNode *parent, const QCString &name, const QCString &context)
void	parse ()
Kind	kind () const
QCString	name () const
QCString	file () const
QCString	relPath () const
bool	hasCaption () const
QCString	width () const
QCString	height () const
QCString	context () const
void	accept (DocVisitor *v)
Public Member Functions inherited from CompAccept< DocDiaFile >
	CompAccept ()
virtual	~CompAccept ()
void	accept (DocDiaFile *obj, DocVisitor *v)
const QList< DocNode > &	children () const
QList< DocNode > &	children ()
Public Member Functions inherited from DocNode
	DocNode ()
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private Attributes
QCString	m_name
QCString	m_file
QCString	m_relPath
QCString	m_width
QCString	m_height
QCString	m_context

Additional Inherited Members
Public Types inherited from DocNode
enum	Kind {   Kind_Root = 0, Kind_Word = 1, Kind_WhiteSpace = 2, Kind_Para = 3,   Kind_AutoList = 4, Kind_AutoListItem = 5, Kind_Symbol = 6, Kind_URL = 7,   Kind_StyleChange = 8, Kind_SimpleSect = 9, Kind_Title = 10, Kind_SimpleList = 11,   Kind_SimpleListItem = 12, Kind_Section = 13, Kind_Verbatim = 14, Kind_XRefItem = 15,   Kind_HtmlList = 16, Kind_HtmlListItem = 17, Kind_HtmlDescList = 18, Kind_HtmlDescData = 19,   Kind_HtmlDescTitle = 20, Kind_HtmlTable = 21, Kind_HtmlRow = 22, Kind_HtmlCell = 23,   Kind_HtmlCaption = 24, Kind_LineBreak = 25, Kind_HorRuler = 26, Kind_Anchor = 27,   Kind_IndexEntry = 28, Kind_Internal = 29, Kind_HRef = 30, Kind_Include = 31,   Kind_IncOperator = 32, Kind_HtmlHeader = 33, Kind_Image = 34, Kind_DotFile = 35,   Kind_Link = 36, Kind_Ref = 37, Kind_Formula = 38, Kind_SecRefItem = 39,   Kind_SecRefList = 40, Kind_SimpleSectSep = 41, Kind_LinkedWord = 42, Kind_ParamSect = 43,   Kind_ParamList = 44, Kind_InternalRef = 45, Kind_Copy = 46, Kind_Text = 47,   Kind_MscFile = 48, Kind_HtmlBlockQuote = 49, Kind_VhdlFlow = 50, Kind_ParBlock = 51,   Kind_DiaFile = 52 }
Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)
Protected Attributes inherited from CompAccept< DocDiaFile >
QList< DocNode >	m_children
Protected Attributes inherited from DocNode
DocNode *	m_parent

Detailed Description

Node representing a dia file

Definition at line 764 of file docparser.h.

Constructor & Destructor Documentation

DocDiaFile::DocDiaFile	(	DocNode *	parent,
		const QCString &	name,
		const QCString &	context
	)

Definition at line 2835 of file docparser.cpp.

                                                                                   :
      m_name(name), m_relPath(g_relPath), m_context(context)
{
  m_parent = parent;
}

Member Function Documentation

void DocDiaFile::accept ( DocVisitor *  v )

inlinevirtual

Acceptor function for node visitors. Part of the visitor pattern.

Parameters

v	Abstract visitor.

Implements DocNode.

Definition at line 777 of file docparser.h.

{ CompAccept<DocDiaFile>::accept(this,v); }

QCString DocDiaFile::context ( ) const

inline

Definition at line 776 of file docparser.h.

{ return m_context; }

QCString DocDiaFile::file ( ) const

inline

Definition at line 771 of file docparser.h.

{ return m_file; }

bool DocDiaFile::hasCaption ( ) const

inline

Definition at line 773 of file docparser.h.

{ return !m_children.isEmpty(); }

QCString DocDiaFile::height ( ) const

inline

Definition at line 775 of file docparser.h.

{ return m_height; }

Kind DocDiaFile::kind ( ) const

inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.

Definition at line 769 of file docparser.h.

{ return Kind_DiaFile; }

QCString DocDiaFile::name ( ) const

inline

Definition at line 770 of file docparser.h.

{ return m_name; }

void DocDiaFile::parse

(

)

Definition at line 2841 of file docparser.cpp.

{
  defaultHandleTitleAndSize(CMD_DIAFILE,this,m_children,m_width,m_height);

  bool ambig;
  FileDef *fd = findFileDef(Doxygen::diaFileNameDict,m_name,ambig);
  if (fd==0 && m_name.right(4)!=".dia") // try with .dia extension as well
  {
    fd = findFileDef(Doxygen::diaFileNameDict,m_name+".dia",ambig);
  }
  if (fd)
  {
    m_file = fd->absFilePath();
  }
  else if (ambig)
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"included dia file name %s is ambiguous.\n"
           "Possible candidates:\n%s",qPrint(m_name),
           qPrint(showFileDefMatches(Doxygen::exampleNameDict,m_name))
          );
  }
  else
  {
    warn_doc_error(g_fileName,doctokenizerYYlineno,"included dia file %s is not found "
           "in any of the paths specified via DIAFILE_DIRS!",qPrint(m_name));
  }
}

QCString DocDiaFile::relPath ( ) const

inline

Definition at line 772 of file docparser.h.

{ return m_relPath; }

QCString DocDiaFile::width ( ) const

inline

Definition at line 774 of file docparser.h.

{ return m_width; }

Member Data Documentation

QCString DocDiaFile::m_context

private

Definition at line 784 of file docparser.h.

QCString DocDiaFile::m_file

private

Definition at line 780 of file docparser.h.

QCString DocDiaFile::m_height

private

Definition at line 783 of file docparser.h.

QCString DocDiaFile::m_name

private

Definition at line 779 of file docparser.h.

QCString DocDiaFile::m_relPath

private

Definition at line 781 of file docparser.h.

QCString DocDiaFile::m_width

private

Definition at line 782 of file docparser.h.

---

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

• doxygen-1.8.11/src/docparser.h
• doxygen-1.8.11/src/docparser.cpp