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 HtmlAttribList & attribs () const
Token parse ()
Token parseXml ()
Public Member Functions inherited from DocCompoundNode
 DocCompoundNode (DocParser *parser, DocNodeVariant *parent)
DocNodeList & children ()
const DocNodeList & children () 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

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 2824 of file docnode.cpp.

2825{
2826 AUTO_TRACE();
2827 Token retval = Token::make_TK_NONE();
2828 auto ns = AutoNodeStack(parser(),thisVariant());
2829
2830 // parse one or more paragraphs
2831 bool isFirst=true;
2832 DocPara *par=nullptr;
2833 do
2834 {
2835 children().append<DocPara>(parser(),thisVariant());
2836 par = children().get_last<DocPara>();
2837 if (isFirst) { par->markFirst(); isFirst=false; }
2838 retval=par->parse();
2839 }
2840 while (retval.is(TokenRetval::TK_NEWPARA));
2841 if (par) par->markLast();
2842
2843 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2844 return retval;
2845}
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:5779
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 2847 of file docnode.cpp.

2848{
2849 AUTO_TRACE();
2850 Token retval = Token::make_TK_NONE();
2851 auto ns = AutoNodeStack(parser(),thisVariant());
2852
2853 // parse one or more paragraphs
2854 bool isFirst=true;
2855 DocPara *par=nullptr;
2856 do
2857 {
2858 children().append<DocPara>(parser(),thisVariant());
2859 par = children().get_last<DocPara>();
2860 if (isFirst) { par->markFirst(); isFirst=false; }
2861 retval=par->parse();
2862 if (retval.is_any_of(TokenRetval::TK_NONE,TokenRetval::TK_EOF)) break;
2863
2864 //printf("new item: retval=%x parser()->context.token->name=%s parser()->context.token->endTag=%d\n",
2865 // retval,qPrint(parser()->context.token->name),parser()->context.token->endTag);
2866 if (retval.is(TokenRetval::RetVal_ListItem))
2867 {
2868 break;
2869 }
2870 }
2871 while (!retval.is(TokenRetval::RetVal_CloseXml));
2872
2873 if (par) par->markLast();
2874
2875 AUTO_TRACE_EXIT("retval={}",retval.to_string());
2876 return retval;
2877}
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: