Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QQmlJS::Dom::CommentedElement Class Reference

Keeps the comment associated with an element. More...

#include <qqmldomcomments_p.h>

Collaboration diagram for QQmlJS::Dom::CommentedElement:

Public Member Functions

DomType kind () const
bool iterateDirectSubpaths (const DomItem &self, DirectVisitor visitor) const
void writePre (OutWriter &lw) const
void writePost (OutWriter &lw) const
void addComment (const Comment &comment)
QList< Comment > preComments () const
QList< Comment > postComments () const

Static Public Attributes

static constexpr DomType kindValue = DomType::CommentedElement

Friends

bool operator== (const CommentedElement &c1, const CommentedElement &c2)
bool operator!= (const CommentedElement &c1, const CommentedElement &c2)

Detailed Description

Keeps the comment associated with an element.

A comment can be attached to an element (that is always a range of the file with a start and end) only in two ways: it can precede the region (preComments), or follow it (postComments).

Definition at line 141 of file qqmldomcomments_p.h.

Member Function Documentation

◆ addComment()

void QQmlJS::Dom::CommentedElement::addComment ( const Comment & comment)
inline

Definition at line 160 of file qqmldomcomments_p.h.

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::CommentedElement::iterateDirectSubpaths ( const DomItem & self,
DirectVisitor visitor ) const

Definition at line 243 of file qqmldomcomments.cpp.

◆ kind()

DomType QQmlJS::Dom::CommentedElement::kind ( ) const
inline

Definition at line 145 of file qqmldomcomments_p.h.

References kindValue.

◆ postComments()

QList< Comment > QQmlJS::Dom::CommentedElement::postComments ( ) const
inline

Definition at line 169 of file qqmldomcomments_p.h.

◆ preComments()

QList< Comment > QQmlJS::Dom::CommentedElement::preComments ( ) const
inline

Definition at line 168 of file qqmldomcomments_p.h.

◆ writePost()

void QQmlJS::Dom::CommentedElement::writePost ( OutWriter & lw) const

Definition at line 263 of file qqmldomcomments.cpp.

◆ writePre()

void QQmlJS::Dom::CommentedElement::writePre ( OutWriter & lw) const

Definition at line 258 of file qqmldomcomments.cpp.

◆ operator!=

bool operator!= ( const CommentedElement & c1,
const CommentedElement & c2 )
friend

Definition at line 155 of file qqmldomcomments_p.h.

References operator==.

◆ operator==

bool operator== ( const CommentedElement & c1,
const CommentedElement & c2 )
friend

Definition at line 151 of file qqmldomcomments_p.h.

Referenced by operator!=.

Member Data Documentation

◆ kindValue

DomType QQmlJS::Dom::CommentedElement::kindValue = DomType::CommentedElement
staticconstexpr

Definition at line 144 of file qqmldomcomments_p.h.

Referenced by kind().

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