The DocTitle Class Reference

Node representing a simple section title. More...

Declaration

class DocTitle { ... }

Included Headers

#include <src/docnode.h>

Base class

class	DocCompoundNode
	Base class for nodes with children. More...

Public Constructors Index

	DocTitle (DocParser *parser, DocNodeVariant *parent)

Public Member Functions Index

void	parse ()
void	parseFromString (DocNodeVariant *, const QCString &title)
bool	hasTitle () const
bool	isEmpty () const

Description

Node representing a simple section title.

Definition at line 607 of file docnode.h.

Public Constructors

DocTitle()

DocTitle::DocTitle (DocParser * parser, DocNodeVariant * parent)

inline

Definition at line 610 of file docnode.h.

610 DocTitle(DocParser *parser,DocNodeVariant *parent) : DocCompoundNode(parser,parent) {}

References DocCompoundNode::DocCompoundNode, DocNode::parent and DocNode::parser.

Public Member Functions

hasTitle()

bool DocTitle::hasTitle ()

inline

Definition at line 613 of file docnode.h.

613 bool hasTitle() const { return !children().empty(); }

References DocCompoundNode::children and GrowVector< T >::empty.

Referenced by isEmpty and DocbookDocVisitor::operator().

isEmpty()

bool DocTitle::isEmpty ()

inline

Definition at line 614 of file docnode.h.

614 bool isEmpty() const { return !hasTitle(); }

Reference hasTitle.

parse()

void DocTitle::parse ()

Declaration at line 611 of file docnode.h, definition at line 2968 of file docnode.cpp.

2968void DocTitle::parse()

2969{

2970 AUTO_TRACE();

2971 auto ns = AutoNodeStack(parser(),thisVariant());

2972 parser()->tokenizer.setStateTitle();

2973 Token tok = parser()->tokenizer.lex();

2974 while (!tok.is_any_of(TokenRetval::TK_NONE, TokenRetval::TK_EOF))

2975 {

2976 if (!parser()->defaultHandleToken(thisVariant(),tok,children()))

2977 {

2978 parser()->errorHandleDefaultToken(thisVariant(),tok,children(),"title section");

2979 }

2980 tok = parser()->tokenizer.lex();

2981 }

2982 parser()->tokenizer.setStatePara();

2983 parser()->handlePendingStyleCommands(thisVariant(),children());

2984}

References AUTO_TRACE, DocCompoundNode::children, DocParser::errorHandleDefaultToken, DocParser::handlePendingStyleCommands, Token::is_any_of, DocTokenizer::lex, DocNode::parser, DocTokenizer::setStatePara, DocTokenizer::setStateTitle, DocNode::thisVariant and DocParser::tokenizer.

parseFromString()

void DocTitle::parseFromString (DocNodeVariant * parent, const QCString & title)

Declaration at line 612 of file docnode.h, definition at line 2986 of file docnode.cpp.

2986void DocTitle::parseFromString(DocNodeVariant *parent,const QCString &text)

2987{

2988 parser()->context.insideHtmlLink=TRUE;

2989 parser()->pushContext(); // this will create a new parser->context.token

2990 parser()->internalValidatingParseDoc(thisVariant(),children(),text);

2991 parser()->popContext(); // this will restore the old parser->context.token

2992 parser()->context.insideHtmlLink=FALSE;

2993 parser()->tokenizer.setStatePara();

2994 flattenParagraphs(thisVariant(),children());

2995}

References DocCompoundNode::children, DocParser::context, FALSE, flattenParagraphs, DocParserContext::insideHtmlLink, DocParser::internalValidatingParseDoc, DocNode::parent, DocNode::parser, DocParser::popContext, DocParser::pushContext, DocTokenizer::setStatePara, DocNode::thisVariant, DocParser::tokenizer and TRUE.

---

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

• docnode.cpp
• docnode.h

---

Generated via doxygen2docusaurus by Doxygen 1.14.0.