The DocStyleChange Class Reference

Node representing a style change. More...

Declaration

class DocStyleChange { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocNode
	Abstract node interface with type information. More...

Enumerations Index

enum	Style { ... }

Public Constructors Index

	DocStyleChange (DocParser *parser, DocNodeVariant *parent, size_t position, Style s, const QCString &tagName, bool enable, const HtmlAttribList *attribs=nullptr)
	DocStyleChange (DocParser *parser, DocNodeVariant *parent, size_t position, Style s, const QCString &tagName, bool enable, const QCString &fileName, int lineNr, const HtmlAttribList *attribs=nullptr)

Public Member Functions Index

Style	style () const
const char *	styleString () const
bool	enable () const
size_t	position () const
const HtmlAttribList &	attribs () const
QCString	tagName () const
QCString	fileName () const
int	lineNr () const

Private Member Attributes Index

size_t	m_position = 0
Style	m_style = Bold
bool	m_enable = false
HtmlAttribList	m_attribs
QCString	m_tagName
QCString	m_fileName
int	m_lineNr = -1

Description

Node representing a style change.

Definition at line 267 of file docnode.h.

Enumerations

Style

enum DocStyleChange::Style

Enumeration values

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))
Cite	(= (1<<15))
Kbd	(= (1<<16))
Typewriter	(= (1<<17))

Definition at line 270 of file docnode.h.

270 enum Style { Bold = (1<<0),

271 Italic = (1<<1),

272 Code = (1<<2),

273 Center = (1<<3),

274 Small = (1<<4),

275 Subscript = (1<<5),

276 Superscript = (1<<6),

277 Preformatted = (1<<7),

278 Span = (1<<8),

279 Div = (1<<9),

280 Strike = (1<<10),

281 Underline = (1<<11),

282 Del = (1<<12),

283 Ins = (1<<13),

284 S = (1<<14),

285 Cite = (1<<15),

286 Kbd = (1<<16),

287 Typewriter = (1<<17)

288 };

Public Constructors

DocStyleChange()

DocStyleChange::DocStyleChange (DocParser * parser, DocNodeVariant * parent, size_t position, Style s, const QCString & tagName, bool enable, const HtmlAttribList * attribs=nullptr)

inline

Definition at line 290 of file docnode.h.

290 DocStyleChange(DocParser *parser,DocNodeVariant *parent,size_t position,Style s,

291 const QCString &tagName,bool enable, const HtmlAttribList *attribs=nullptr)

292 : DocNode(parser,parent), m_position(position), m_style(s), m_enable(enable)

293 {

294 if (attribs) m_attribs=*attribs;

295 m_tagName = tagName.lower();

296 }

References attribs, DocNode::DocNode, enable, m_attribs, m_enable, m_position, m_style, m_tagName, DocNode::parent, DocNode::parser, position and tagName.

DocStyleChange()

DocStyleChange::DocStyleChange (DocParser * parser, DocNodeVariant * parent, size_t position, Style s, const QCString & tagName, bool enable, const QCString & fileName, int lineNr, const HtmlAttribList * attribs=nullptr)

inline

Definition at line 297 of file docnode.h.

297 DocStyleChange(DocParser *parser,DocNodeVariant *parent,size_t position,Style s,

298 const QCString &tagName,bool enable,

299 const QCString &fileName,int lineNr,

300 const HtmlAttribList *attribs=nullptr)

301 : DocNode(parser,parent), m_position(position), m_style(s), m_enable(enable),

302 m_fileName(fileName), m_lineNr(lineNr)

303 {

304 if (attribs) m_attribs=*attribs;

305 m_tagName = tagName.lower();

306 }

References attribs, DocNode::DocNode, enable, fileName, lineNr, m_attribs, m_enable, m_fileName, m_lineNr, m_position, m_style, m_tagName, DocNode::parent, DocNode::parser, position and tagName.

Public Member Functions

attribs()

const HtmlAttribList & DocStyleChange::attribs ()

inline

Definition at line 311 of file docnode.h.

311 const HtmlAttribList &attribs() const { return m_attribs; }

Reference m_attribs.

Referenced by DocStyleChange, DocStyleChange, DocParser::handleInitialStyleCommands and HtmlDocVisitor::operator().

enable()

bool DocStyleChange::enable ()

inline

Definition at line 309 of file docnode.h.

309 bool enable() const { return m_enable; }

Reference m_enable.

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

fileName()

QCString DocStyleChange::fileName ()

inline

Definition at line 313 of file docnode.h.

313 QCString fileName() const { return m_fileName; }

Reference m_fileName.

Referenced by DocStyleChange.

lineNr()

int DocStyleChange::lineNr ()

inline

Definition at line 314 of file docnode.h.

314 int lineNr() const { return m_lineNr; }

Reference m_lineNr.

Referenced by DocStyleChange.

position()

size_t DocStyleChange::position ()

inline

Definition at line 310 of file docnode.h.

310 size_t position() const { return m_position; }

Reference m_position.

Referenced by DocStyleChange, DocStyleChange and DocParser::handlePendingStyleCommands.

style()

Style DocStyleChange::style ()

inline

Definition at line 307 of file docnode.h.

307 Style style() const { return m_style; }

Reference m_style.

Referenced by DocParser::handleInitialStyleCommands, DocParser::handlePendingStyleCommands, insideStyleChangeThatIsOutsideParagraph, mustBeOutsideParagraph, DocbookDocVisitor::operator(), HtmlDocVisitor::operator(), LatexDocVisitor::operator(), ManDocVisitor::operator(), PerlModDocVisitor::operator(), PrintDocVisitor::operator(), RTFDocVisitor::operator() and XmlDocVisitor::operator().

styleString()

const char * DocStyleChange::styleString ()

Declaration at line 308 of file docnode.h, definition at line 125 of file docnode.cpp.

125const char *DocStyleChange::styleString() const

126{

127 switch (m_style)

128 {

129 case DocStyleChange::Bold: return "b";

130 case DocStyleChange::Italic: return "em";

131 case DocStyleChange::Code: return "code";

132 case DocStyleChange::Center: return "center";

133 case DocStyleChange::Small: return "small";

134 case DocStyleChange::Cite: return "cite";

135 case DocStyleChange::Subscript: return "subscript";

136 case DocStyleChange::Superscript: return "superscript";

137 case DocStyleChange::Preformatted: return "pre";

138 case DocStyleChange::Div: return "div";

139 case DocStyleChange::Span: return "span";

140 case DocStyleChange::Strike: return "strike";

141 case DocStyleChange::S: return "s";

142 case DocStyleChange::Del: return "del";

143 case DocStyleChange::Underline: return "u";

144 case DocStyleChange::Ins: return "ins";

145 case DocStyleChange::Kbd: return "kbd";

146 case DocStyleChange::Typewriter: return "tt";

147 }

148 return "<invalid>";

149}

References Bold, Center, Cite, Code, Del, Div, Ins, Italic, Kbd, m_style, Preformatted, S, Small, Span, Strike, Subscript, Superscript, Typewriter and Underline.

tagName()

QCString DocStyleChange::tagName ()

inline

Definition at line 312 of file docnode.h.

312 QCString tagName() const { return m_tagName; }

Reference m_tagName.

Referenced by DocStyleChange, DocStyleChange, DocParser::handleInitialStyleCommands, DocParser::handlePendingStyleCommands and HtmlDocVisitor::operator().

Private Member Attributes

m_attribs

HtmlAttribList DocStyleChange::m_attribs

Definition at line 320 of file docnode.h.

320 HtmlAttribList m_attribs;

Referenced by attribs, DocStyleChange and DocStyleChange.

m_enable

bool DocStyleChange::m_enable = false

Definition at line 319 of file docnode.h.

319 bool m_enable = false;

Referenced by DocStyleChange, DocStyleChange and enable.

m_fileName

QCString DocStyleChange::m_fileName

Definition at line 322 of file docnode.h.

322 QCString m_fileName;

Referenced by DocStyleChange and fileName.

m_lineNr

int DocStyleChange::m_lineNr = -1

Definition at line 323 of file docnode.h.

323 int m_lineNr = -1;

Referenced by DocStyleChange and lineNr.

m_position

size_t DocStyleChange::m_position = 0

Definition at line 317 of file docnode.h.

317 size_t m_position = 0;

Referenced by DocStyleChange, DocStyleChange and position.

m_style

Style DocStyleChange::m_style = Bold

Definition at line 318 of file docnode.h.

318 Style m_style = Bold;

Referenced by DocStyleChange, DocStyleChange, style and styleString.

m_tagName

QCString DocStyleChange::m_tagName

Definition at line 321 of file docnode.h.

321 QCString m_tagName;

Referenced by DocStyleChange, DocStyleChange and tagName.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.