doxygen
Public Types | Public Member Functions | List of all members
DocInclude Class Reference

Node representing an included text block from file. More...

#include <docparser.h>

Inheritance diagram for DocInclude:
Inheritance graph
[legend]
Collaboration diagram for DocInclude:
Collaboration graph
[legend]

Public Types

enum  Type {
  Include, DontInclude, VerbInclude, HtmlInclude,
  LatexInclude, IncWithLines, Snippet, IncludeDoc,
  SnippetDoc, SnipWithLines, DontIncWithLines, RtfInclude,
  ManInclude, DocbookInclude, XmlInclude
}
 
- 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, Kind_Emoji = 53, Kind_Sep = 54
}
 

Public Member Functions

 DocInclude (DocNode *parent, const QCString &file, const QCString context, Type t, bool isExample, const QCString exampleFile, const QCString blockId, bool isBlock)
 
Kind kind () const
 
QCString file () const
 
QCString extension () const
 
Type type () const
 
QCString text () const
 
QCString context () const
 
QCString blockId () const
 
bool isExample () const
 
QCString exampleFile () const
 
bool isBlock () const
 
void accept (DocVisitor *v)
 
void parse ()
 
- Public Member Functions inherited from DocNode
 DocNode ()
 
virtual ~DocNode ()
 
DocNodeparent () const
 
void setParent (DocNode *parent)
 
bool isPreformatted () const
 
virtual QString::Direction getTextDir () const
 
virtual QString::Direction getTextBasicDir () const
 

Additional Inherited Members

- Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)
 
- Protected Attributes inherited from DocNode
DocNodem_parent = 0
 

Detailed Description

Node representing an included text block from file.

Member Function Documentation

◆ accept()

void DocInclude::accept ( DocVisitor v)
inlinevirtual

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

Parameters
vAbstract visitor.

Implements DocNode.

◆ kind()

Kind DocInclude::kind ( ) const
inlinevirtual

Returns the kind of node. Provides runtime type information

Implements DocNode.


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