Node representing a style change. More...

#include <src/docnode.h>

Inheritance diagram for DocStyleChange:

Collaboration diagram for DocStyleChange:

Public Types
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) , Cite = (1<<15) , Kbd = (1<<16) }

Public Member Functions
	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)

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

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
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

Additional Inherited Members
Protected Types inherited from DocNode
enum	RefType { Unknown , Anchor , Section , Table }

Protected Member Functions inherited from DocNode
void	setInsidePreformatted (bool p)

Detailed Description

Node representing a style change.

Definition at line 263 of file docnode.h.

Member Enumeration Documentation

◆ Style

enum DocStyleChange::Style

Enumerator
Bold
Italic
Code
Center
Small
Subscript
Superscript
Preformatted
Span
Div
Strike
Underline
Del
Ins
S
Cite
Kbd

Definition at line 266 of file docnode.h.

               { 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)
               };

Constructor & Destructor Documentation

◆ DocStyleChange() [1/2]

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

inline

Definition at line 285 of file docnode.h.

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

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

◆ DocStyleChange() [2/2]

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 292 of file docnode.h.

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

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().

Member Function Documentation

◆ attribs()

const HtmlAttribList & DocStyleChange::attribs ( ) const

inline

Definition at line 306 of file docnode.h.

306{ return m_attribs; }

References m_attribs.

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

◆ enable()

bool DocStyleChange::enable ( ) const

inline

Definition at line 304 of file docnode.h.

304{ return m_enable; }

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

inline

Definition at line 308 of file docnode.h.

308{ return m_fileName; }

References m_fileName.

Referenced by DocStyleChange().

◆ lineNr()

int DocStyleChange::lineNr ( ) const

inline

Definition at line 309 of file docnode.h.

309{ return m_lineNr; }

References m_lineNr.

Referenced by DocStyleChange().

◆ position()

size_t DocStyleChange::position ( ) const

inline

Definition at line 305 of file docnode.h.

305{ return m_position; }

References m_position.

Referenced by DocStyleChange(), DocStyleChange(), and DocParser::handlePendingStyleCommands().

◆ style()

Style DocStyleChange::style ( ) const

inline

Definition at line 302 of file docnode.h.

302{ return m_style; }

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

Definition at line 125 of file docnode.cpp.

{
  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::Cite:         return "cite";
    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";
    case DocStyleChange::Kbd:          return "kbd";
  }
  return "<invalid>";
}

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

◆ tagName()

QCString DocStyleChange::tagName ( ) const

inline

Definition at line 307 of file docnode.h.

307{ return m_tagName; }

References m_tagName.

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

Member Data Documentation

◆ m_attribs

HtmlAttribList DocStyleChange::m_attribs

private

Definition at line 315 of file docnode.h.

Referenced by attribs(), DocStyleChange(), and DocStyleChange().

◆ m_enable

bool DocStyleChange::m_enable = false

private

Definition at line 314 of file docnode.h.

Referenced by DocStyleChange(), DocStyleChange(), and enable().

◆ m_fileName

QCString DocStyleChange::m_fileName

private

Definition at line 317 of file docnode.h.

Referenced by DocStyleChange(), and fileName().

◆ m_lineNr

int DocStyleChange::m_lineNr = -1

private

Definition at line 318 of file docnode.h.

Referenced by DocStyleChange(), and lineNr().

◆ m_position

size_t DocStyleChange::m_position = 0

private

Definition at line 312 of file docnode.h.

Referenced by DocStyleChange(), DocStyleChange(), and position().

◆ m_style

Style DocStyleChange::m_style = Bold

private

Definition at line 313 of file docnode.h.

Referenced by DocStyleChange(), DocStyleChange(), style(), and styleString().

◆ m_tagName

QCString DocStyleChange::m_tagName

private

Definition at line 316 of file docnode.h.

Referenced by DocStyleChange(), DocStyleChange(), and tagName().

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

src/docnode.h
src/docnode.cpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Style

Constructor & Destructor Documentation

◆ DocStyleChange() [1/2]

◆ DocStyleChange() [2/2]

Member Function Documentation

◆ attribs()

◆ enable()

◆ fileName()

◆ lineNr()

◆ position()

◆ style()

◆ styleString()

◆ tagName()

Member Data Documentation

◆ m_attribs

◆ m_enable

◆ m_fileName

◆ m_lineNr

◆ m_position

◆ m_style

◆ m_tagName