Doxygen
Loading...
Searching...
No Matches
DocHtmlListItem Class Referencefinal

Node representing a HTML list item. More...

#include <src/docnode.h>

Inheritance diagram for DocHtmlListItem:
Collaboration diagram for DocHtmlListItem:

Public Member Functions

 DocHtmlListItem (DocParser *parser, DocNodeVariant *parent, const HtmlAttribList &attribs, int num)
int itemNumber () const
const HtmlAttribListattribs () const
Token parse ()
Token parseXml ()
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeListchildren ()
const DocNodeListchildren () const
Public Member Functions inherited from DocNode
 DocNode (DocParser *parser, DocNodeVariant *parent)
 ~DocNode ()=default
DocNodeVariantparent ()
const DocNodeVariantparent () const
DocNodeVariantthisVariant ()
const DocNodeVariantthisVariant () const
void setThisVariant (DocNodeVariant *thisVariant)
DocParserparser ()
const DocParserparser () const
void setParent (DocNodeVariant *parent)
bool isPreformatted () const

Private Attributes

HtmlAttribList m_attribs
int m_itemNum = 0

Additional Inherited Members

Protected Types inherited from DocNode
enum  RefType {
  Unknown , Anchor , Section , Table ,
  Requirement
}
Protected Member Functions inherited from DocNode
void setInsidePreformatted (bool p)

Detailed Description

Node representing a HTML list item.

Definition at line 1169 of file docnode.h.

Constructor & Destructor Documentation

◆ DocHtmlListItem()

DocHtmlListItem::DocHtmlListItem ( DocParser * parser,
DocNodeVariant * parent,
const HtmlAttribList & attribs,
int num )
inline

Definition at line 1172 of file docnode.h.

DocCompoundNode(DocParser *parser, DocNodeVariant *parent)
Definition docnode.h:141
const HtmlAttribList & attribs() const
Definition docnode.h:1175
HtmlAttribList m_attribs
Definition docnode.h:1180
DocParser * parser()
Definition docnode.h:97
DocNodeVariant * parent()
Definition docnode.h:89

References attribs(), DocCompoundNode::DocCompoundNode(), m_attribs, m_itemNum, DocNode::parent(), and DocNode::parser().

Member Function Documentation

◆ attribs()

◆ itemNumber()

int DocHtmlListItem::itemNumber ( ) const
inline

Definition at line 1174 of file docnode.h.

1174{ return m_itemNum; }

References m_itemNum.

◆ parse()

Token DocHtmlListItem::parse ( )

Definition at line 2735 of file docnode.cpp.

2736{
2737 AUTO_TRACE();
2738 Token retval = Token::make_TK_NONE();
2739 auto ns = AutoNodeStack(parser(),thisVariant());
2740
2741 // parse one or more paragraphs
2742 bool isFirst=true;
2743 DocPara *par=nullptr;
2744 do
2745 {
2746 children().append<DocPara>(parser(),thisVariant());
2747 par = children().get_last<DocPara>();
2748 if (isFirst) { par->markFirst(); isFirst=false; }
2749 retval=par->parse();
2750 }
2751 while (retval.is(TokenRetval::TK_NEWPARA));
2752 if (par) par->markLast();
2753
2754 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2755 return retval;
2756}
DocNodeList & children()
Definition docnode.h:143
DocNodeVariant * thisVariant()
Definition docnode.h:92
void append(Args &&... args)
Append a new DocNodeVariant to the list by constructing it with type T and parameters Args.
Definition docnode.h:1404
T * get_last()
Returns a pointer to the last element in the list if that element exists and holds a T,...
Definition docnode.h:1415
void markFirst(bool v=true)
Definition docnode.h:1094
Token parse()
Definition docnode.cpp:5690
void markLast(bool v=true)
Definition docnode.h:1095
bool is(TokenRetval rv) const
TOKEN_SPECIFICATIONS RETVAL_SPECIFICATIONS const char * to_string() const
#define AUTO_TRACE(...)
Definition docnode.cpp:53
#define AUTO_TRACE_EXIT(...)
Definition docnode.cpp:55

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), DocNodeList::get_last(), Token::is(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

◆ parseXml()

Token DocHtmlListItem::parseXml ( )

Definition at line 2758 of file docnode.cpp.

2759{
2760 AUTO_TRACE();
2761 Token retval = Token::make_TK_NONE();
2762 auto ns = AutoNodeStack(parser(),thisVariant());
2763
2764 // parse one or more paragraphs
2765 bool isFirst=true;
2766 DocPara *par=nullptr;
2767 do
2768 {
2769 children().append<DocPara>(parser(),thisVariant());
2770 par = children().get_last<DocPara>();
2771 if (isFirst) { par->markFirst(); isFirst=false; }
2772 retval=par->parse();
2773 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2774
2775 //printf("new item: retval=%x parser()->context.token->name=%s parser()->context.token->endTag=%d\n",
2776 // retval,qPrint(parser()->context.token->name),parser()->context.token->endTag);
2777 if (retval.is(TokenRetval::RetVal_ListItem))
2778 {
2779 break;
2780 }
2781 }
2782 while (!retval.is(TokenRetval::RetVal_CloseXml));
2783
2784 if (par) par->markLast();
2785
2786 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2787 return retval;
2788}
bool is_any_of(ARGS... args) const

References DocNodeList::append(), AUTO_TRACE, AUTO_TRACE_EXIT, DocCompoundNode::children(), DocNodeList::get_last(), Token::is(), Token::is_any_of(), DocPara::markFirst(), DocPara::markLast(), DocPara::parse(), DocNode::parser(), DocNode::thisVariant(), and Token::to_string().

Member Data Documentation

◆ m_attribs

HtmlAttribList DocHtmlListItem::m_attribs
private

Definition at line 1180 of file docnode.h.

Referenced by attribs(), and DocHtmlListItem().

◆ m_itemNum

int DocHtmlListItem::m_itemNum = 0
private

Definition at line 1181 of file docnode.h.

Referenced by DocHtmlListItem(), and itemNumber().


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