DocStyleChange类 参考

Node representing a style change 更多...

#include <docparser.h>

类 DocStyleChange 继承关系图:

DocStyleChange 的协作图:

Public 类型
enum	Style {   Bold = (1<<0), Italic = (1<<1), Code = (1<<2), Center = (1<<3),   Small = (1<<4), Subscript = (1<<5), Superscript = (1<<6), Preformatted = (1<<7),   Span = (1<<8), Div = (1<<9), Strike = (1<<10), Underline = (1<<11),   Del = (1<<12), Ins = (1<<13), S = (1<<14) }
Public 类型 继承自 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 成员函数
	DocStyleChange (DocParser &parser, DocNode *parent, uint position, Style s, const QCString &tagName, bool enable, const HtmlAttribList *attribs=0)
Kind	kind () const override
Style	style () const
const char *	styleString () const
bool	enable () const
uint	position () const
void	accept (DocVisitor *v) override
const HtmlAttribList &	attribs () const
QCString	tagName () const
Public 成员函数 继承自 DocNode
	DocNode (DocParser &parser)
virtual	~DocNode ()
DocNode *	parent () const
void	setParent (DocNode *parent)
bool	isPreformatted () const

Private 属性
uint	m_position = 0
Style	m_style = Bold
bool	m_enable = false
HtmlAttribList	m_attribs
QCString	m_tagName

额外继承的成员函数
Protected 类型 继承自 DocNode
enum	RefType { Unknown, Anchor, Section, Table }
Protected 成员函数 继承自 DocNode
void	setInsidePreformatted (bool p)
Protected 属性 继承自 DocNode
DocNode *	m_parent = 0
DocParser &	m_parser

详细描述

Node representing a style change

在文件 docparser.h 第 343 行定义.

成员枚举类型说明

Style

enum DocStyleChange::Style

枚举值
Bold
Italic
Code
Center
Small
Subscript
Superscript
Preformatted
Span
Div
Strike
Underline
Del
Ins
S

在文件 docparser.h 第 346 行定义.

               { Bold          = (1<<0),
                 Italic        = (1<<1),
                 Code          = (1<<2),
                 Center        = (1<<3),
                 Small         = (1<<4),
                 Subscript     = (1<<5),
                 Superscript   = (1<<6),
                 Preformatted  = (1<<7),
                 Span          = (1<<8),
                 Div           = (1<<9),
                 Strike        = (1<<10),
                 Underline     = (1<<11),
                 Del           = (1<<12),
                 Ins           = (1<<13),
                 S             = (1<<14)
               };

构造及析构函数说明

DocStyleChange()

DocStyleChange::DocStyleChange ( DocParser &  parser, DocNode *  parent, uint  position, Style  s, const QCString &  tagName, bool  enable, const HtmlAttribList *  attribs = 0  )

inline

在文件 docparser.h 第 363 行定义.

                                                    :
      DocNode(parser), m_position(position), m_style(s), m_enable(enable)
      { m_parent = parent; if (attribs) m_attribs=*attribs; m_tagName = tagName.lower();}

引用了 attribs(), QCString::lower(), m_attribs, DocNode::m_parent, m_tagName, DocNode::parent() , 以及 tagName().

成员函数说明

accept()

void DocStyleChange::accept ( DocVisitor *  v )

inlineoverridevirtual

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

参数

v	Abstract visitor.

实现了 DocNode.

在文件 docparser.h 第 372 行定义.

{ v->visit(this); }

引用了 DocVisitor::visit().

attribs()

const HtmlAttribList& DocStyleChange::attribs ( ) const

inline

在文件 docparser.h 第 373 行定义.

{ return m_attribs; }

引用了 m_attribs.

被这些函数引用 DocStyleChange(), DocParser::handleInitialStyleCommands() , 以及 HtmlDocVisitor::visit().

enable()

bool DocStyleChange::enable ( ) const

inline

在文件 docparser.h 第 370 行定义.

{ return m_enable; }

引用了 m_enable.

被这些函数引用 insideStyleChangeThatIsOutsideParagraph(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), ManDocVisitor::visit(), RTFDocVisitor::visit(), XmlDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

kind()

Kind DocStyleChange::kind ( ) const

inlineoverridevirtual

Returns the kind of node. Provides runtime type information

实现了 DocNode.

在文件 docparser.h 第 367 行定义.

{ return Kind_StyleChange; }

引用了 DocNode::Kind_StyleChange.

position()

uint DocStyleChange::position ( ) const

inline

在文件 docparser.h 第 371 行定义.

{ return m_position; }

引用了 m_position.

被这些函数引用 DocParser::handlePendingStyleCommands().

style()

Style DocStyleChange::style ( ) const

inline

在文件 docparser.h 第 368 行定义.

{ return m_style; }

引用了 m_style.

被这些函数引用 DocParser::handleInitialStyleCommands(), DocParser::handlePendingStyleCommands(), insideStyleChangeThatIsOutsideParagraph(), HtmlDocVisitor::visit(), DocbookDocVisitor::visit(), LatexDocVisitor::visit(), RTFDocVisitor::visit(), ManDocVisitor::visit(), XmlDocVisitor::visit(), PrintDocVisitor::visit() , 以及 PerlModDocVisitor::visit().

styleString()

const char * DocStyleChange::styleString

(

)

const

在文件 docparser.cpp 第 979 行定义.

{
  switch (m_style)
  {
    case DocStyleChange::Bold:         return "b";
    case DocStyleChange::Italic:       return "em";
    case DocStyleChange::Code:         return "code";
    case DocStyleChange::Center:       return "center";
    case DocStyleChange::Small:        return "small";
    case DocStyleChange::Subscript:    return "subscript";
    case DocStyleChange::Superscript:  return "superscript";
    case DocStyleChange::Preformatted: return "pre";
    case DocStyleChange::Div:          return "div";
    case DocStyleChange::Span:         return "span";
    case DocStyleChange::Strike:       return "strike";
    case DocStyleChange::S:            return "s";
    case DocStyleChange::Del:          return "del";
    case DocStyleChange::Underline:    return "u";
    case DocStyleChange::Ins:          return "ins";
  }
  return "<invalid>";
}

引用了 Bold, Center, Code, Del, Div, Ins, Italic, m_style, Preformatted, S, Small, Span, Strike, Subscript, Superscript , 以及 Underline.

tagName()

QCString DocStyleChange::tagName ( ) const

inline

在文件 docparser.h 第 374 行定义.

{ return m_tagName; }

引用了 m_tagName.

被这些函数引用 DocStyleChange(), DocParser::handleInitialStyleCommands(), DocParser::handlePendingStyleCommands() , 以及 DocParser::handleUnclosedStyleCommands().

类成员变量说明

m_attribs

HtmlAttribList DocStyleChange::m_attribs

private

在文件 docparser.h 第 380 行定义.

被这些函数引用 attribs() , 以及 DocStyleChange().

m_enable

bool DocStyleChange::m_enable = false

private

在文件 docparser.h 第 379 行定义.

被这些函数引用 enable().

m_position

uint DocStyleChange::m_position = 0

private

在文件 docparser.h 第 377 行定义.

被这些函数引用 position().

m_style

Style DocStyleChange::m_style = Bold

private

在文件 docparser.h 第 378 行定义.

被这些函数引用 style() , 以及 styleString().

m_tagName

QCString DocStyleChange::m_tagName

private

在文件 docparser.h 第 381 行定义.

被这些函数引用 DocStyleChange() , 以及 tagName().

---

该类的文档由以下文件生成:

• src/docparser.h
• src/docparser.cpp