Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Friends | List of all members
QQmlJS::Dom::QmlObject Class Referencefinal

#include <qqmldomelements_p.h>

+ Inheritance diagram for QQmlJS::Dom::QmlObject:
+ Collaboration diagram for QQmlJS::Dom::QmlObject:

Public Member Functions

DomType kind () const override
 
 QmlObject (const Path &pathFromOwner=Path())
 
bool iterateDirectSubpaths (const DomItem &self, DirectVisitor) const override
 
bool iterateBaseDirectSubpaths (const DomItem &self, DirectVisitor) const
 
QList< QString > fields () const
 
QList< QString > fields (const DomItem &) const override
 
DomItem field (const DomItem &self, QStringView name) const override
 
void updatePathFromOwner (const Path &newPath) override
 
QString localDefaultPropertyName () const
 
QString defaultPropertyName (const DomItem &self) const
 
virtual bool iterateSubOwners (const DomItem &self, function_ref< bool(const DomItem &owner)> visitor) const
 
QString idStr () const
 
QString name () const
 
const QList< Path > & prototypePaths () const &
 
Path nextScopePath () const
 
const QMultiMap< QString, PropertyDefinition > & propertyDefs () const &
 
const QMultiMap< QString, Binding > & bindings () const &
 
const QMultiMap< QString, MethodInfo > & methods () const &
 
QList< QmlObject > children () const
 
QList< QmlObject > annotations () const
 
void setIdStr (const QString &id)
 
void setName (const QString &name)
 
void setDefaultPropertyName (const QString &name)
 
void setPrototypePaths (QList< Path > prototypePaths)
 
Path addPrototypePath (const Path &prototypePath)
 
void setNextScopePath (const Path &nextScopePath)
 
void setPropertyDefs (QMultiMap< QString, PropertyDefinition > propertyDefs)
 
void setBindings (QMultiMap< QString, Binding > bindings)
 
void setMethods (QMultiMap< QString, MethodInfo > functionDefs)
 
void setChildren (const QList< QmlObject > &children)
 
void setAnnotations (const QList< QmlObject > &annotations)
 
Path addPropertyDef (const PropertyDefinition &propertyDef, AddOption option, PropertyDefinition **pDef=nullptr)
 
MutableDomItem addPropertyDef (MutableDomItem &self, const PropertyDefinition &propertyDef, AddOption option)
 
Path addBinding (Binding binding, AddOption option, Binding **bPtr=nullptr)
 
MutableDomItem addBinding (MutableDomItem &self, Binding binding, AddOption option)
 
Path addMethod (const MethodInfo &functionDef, AddOption option, MethodInfo **mPtr=nullptr)
 
MutableDomItem addMethod (MutableDomItem &self, const MethodInfo &functionDef, AddOption option)
 
Path addChild (QmlObject child, QmlObject **cPtr=nullptr)
 
MutableDomItem addChild (MutableDomItem &self, QmlObject child)
 
Path addAnnotation (const QmlObject &annotation, QmlObject **aPtr=nullptr)
 
void writeOut (const DomItem &self, OutWriter &ow, const QString &onTarget) const
 
void writeOut (const DomItem &self, OutWriter &lw) const override
 
LocallyResolvedAlias resolveAlias (const DomItem &self, std::shared_ptr< ScriptExpression > accessSequence) const
 
LocallyResolvedAlias resolveAlias (const DomItem &self, const QStringList &accessSequence) const
 
QQmlJSScope::ConstPtr semanticScope () const
 
void setSemanticScope (const QQmlJSScope::ConstPtr &scope)
 
ScriptElementVariant nameIdentifiers () const
 
void setNameIdentifiers (const ScriptElementVariant &name)
 
- Public Member Functions inherited from QQmlJS::Dom::CommentableDomElement
 CommentableDomElement (const Path &pathFromOwner=Path())
 
 CommentableDomElement (const CommentableDomElement &o)
 
CommentableDomElement & operator= (const CommentableDomElement &o)=default
 
RegionComments & comments ()
 
const RegionComments & comments () const
 
- Public Member Functions inherited from QQmlJS::Dom::DomElement
 DomElement (const Path &pathFromOwner=Path())
 
 DomElement (const DomElement &o)=default
 
Path pathFromOwner (const DomItem &self) const override
 
Path pathFromOwner () const
 
Path canonicalPath (const DomItem &self) const override
 
DomItem containingObject (const DomItem &self) const override
 
- Public Member Functions inherited from QQmlJS::Dom::DomBase
virtual ~DomBase ()=default
 
DomBase * domBase ()
 
const DomBase * domBase () const
 
virtual DomKind domKind () const
 
bool iterateDirectSubpathsConst (const DomItem &self, DirectVisitor) const
 
virtual void dump (const DomItem &, const Sink &sink, int indent, FilterT filter) const
 
virtual quintptr id () const
 
QString typeName () const
 
virtual index_type indexes (const DomItem &self) const
 
virtual DomItem index (const DomItem &self, index_type index) const
 
virtual QSet< QString > const keys (const DomItem &self) const
 
virtual DomItem key (const DomItem &self, const QString &name) const
 
virtual QString canonicalFilePath (const DomItem &self) const
 
virtual QCborValue value () const
 

Static Public Attributes

static constexpr DomType kindValue = DomType::QmlObject
 

Friends

class QQmlDomAstCreator
 

Additional Inherited Members

- Public Types inherited from QQmlJS::Dom::DomBase
using FilterT = function_ref<bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)>
 
- Protected Member Functions inherited from QQmlJS::Dom::DomElement
DomElement & operator= (const DomElement &)=default
 

Detailed Description

Definition at line 842 of file qqmldomelements_p.h.

Constructor & Destructor Documentation

◆ QmlObject()

QQmlJS::Dom::QmlObject::QmlObject ( const Path & pathFromOwner = Path())

Member Function Documentation

◆ addAnnotation()

Path QQmlJS::Dom::QmlObject::addAnnotation ( const QmlObject & annotation,
QmlObject ** aPtr = nullptr )
inline

Definition at line 934 of file qqmldomelements_p.h.

References QQmlJS::Dom::appendUpdatableElementInQList().

+ Here is the call graph for this function:

◆ addBinding() [1/2]

Path QQmlJS::Dom::QmlObject::addBinding ( Binding binding,
AddOption option,
Binding ** bPtr = nullptr )
inline

Definition at line 912 of file qqmldomelements_p.h.

References QQmlJS::Dom::insertUpdatableElementInMultiMap(), and QQmlJS::Dom::Binding::name().

+ Here is the call graph for this function:

◆ addBinding() [2/2]

MutableDomItem QQmlJS::Dom::QmlObject::addBinding ( MutableDomItem & self,
Binding binding,
AddOption option )

◆ addChild() [1/2]

MutableDomItem QQmlJS::Dom::QmlObject::addChild ( MutableDomItem & self,
QmlObject child )
inline

Definition at line 929 of file qqmldomelements_p.h.

References child.

◆ addChild() [2/2]

Path QQmlJS::Dom::QmlObject::addChild ( QmlObject child,
QmlObject ** cPtr = nullptr )
inline

Definition at line 924 of file qqmldomelements_p.h.

References QQmlJS::Dom::appendUpdatableElementInQList(), and child.

+ Here is the call graph for this function:

◆ addMethod() [1/2]

Path QQmlJS::Dom::QmlObject::addMethod ( const MethodInfo & functionDef,
AddOption option,
MethodInfo ** mPtr = nullptr )
inline

Definition at line 918 of file qqmldomelements_p.h.

References QQmlJS::Dom::insertUpdatableElementInMultiMap().

+ Here is the call graph for this function:

◆ addMethod() [2/2]

MutableDomItem QQmlJS::Dom::QmlObject::addMethod ( MutableDomItem & self,
const MethodInfo & functionDef,
AddOption option )

◆ addPropertyDef() [1/2]

Path QQmlJS::Dom::QmlObject::addPropertyDef ( const PropertyDefinition & propertyDef,
AddOption option,
PropertyDefinition ** pDef = nullptr )
inline

Definition at line 902 of file qqmldomelements_p.h.

References QQmlJS::Dom::insertUpdatableElementInMultiMap().

+ Here is the call graph for this function:

◆ addPropertyDef() [2/2]

MutableDomItem QQmlJS::Dom::QmlObject::addPropertyDef ( MutableDomItem & self,
const PropertyDefinition & propertyDef,
AddOption option )

◆ addPrototypePath()

Path QQmlJS::Dom::QmlObject::addPrototypePath ( const Path & prototypePath)
inline

Definition at line 874 of file qqmldomelements_p.h.

Referenced by QQmlJS::Dom::QQmlDomAstCreator::visit().

+ Here is the caller graph for this function:

◆ annotations()

QList< QmlObject > QQmlJS::Dom::QmlObject::annotations ( ) const
inline

Definition at line 868 of file qqmldomelements_p.h.

◆ bindings()

const QMultiMap< QString, Binding > & QQmlJS::Dom::QmlObject::bindings ( ) const &
inline

Definition at line 865 of file qqmldomelements_p.h.

◆ children()

QList< QmlObject > QQmlJS::Dom::QmlObject::children ( ) const
inline

Definition at line 867 of file qqmldomelements_p.h.

◆ defaultPropertyName()

QString QQmlJS::Dom::QmlObject::defaultPropertyName ( const DomItem & self) const

◆ field()

DomItem QQmlJS::Dom::QmlObject::field ( const DomItem & self,
QStringView name ) const
overridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

◆ fields() [1/2]

QList< QString > QQmlJS::Dom::QmlObject::fields ( ) const

◆ fields() [2/2]

QList< QString > QQmlJS::Dom::QmlObject::fields ( const DomItem & ) const
inlineoverridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

Definition at line 853 of file qqmldomelements_p.h.

References fields().

Referenced by fields().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ idStr()

QString QQmlJS::Dom::QmlObject::idStr ( ) const
inline

Definition at line 860 of file qqmldomelements_p.h.

◆ iterateBaseDirectSubpaths()

bool QQmlJS::Dom::QmlObject::iterateBaseDirectSubpaths ( const DomItem & self,
DirectVisitor  ) const

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::QmlObject::iterateDirectSubpaths ( const DomItem & self,
DirectVisitor  ) const
overridevirtual

Reimplemented from QQmlJS::Dom::CommentableDomElement.

◆ iterateSubOwners()

virtual bool QQmlJS::Dom::QmlObject::iterateSubOwners ( const DomItem & self,
function_ref< bool(const DomItem &owner)> visitor ) const
virtual

◆ kind()

DomType QQmlJS::Dom::QmlObject::kind ( ) const
inlineoverridevirtual

Implements QQmlJS::Dom::DomBase.

Definition at line 847 of file qqmldomelements_p.h.

◆ localDefaultPropertyName()

QString QQmlJS::Dom::QmlObject::localDefaultPropertyName ( ) const

◆ methods()

const QMultiMap< QString, MethodInfo > & QQmlJS::Dom::QmlObject::methods ( ) const &
inline

Definition at line 866 of file qqmldomelements_p.h.

◆ name()

QString QQmlJS::Dom::QmlObject::name ( ) const
inline

Definition at line 861 of file qqmldomelements_p.h.

Referenced by QQmlJS::Dom::QQmlDomAstCreator::visit().

+ Here is the caller graph for this function:

◆ nameIdentifiers()

ScriptElementVariant QQmlJS::Dom::QmlObject::nameIdentifiers ( ) const
inline

Definition at line 949 of file qqmldomelements_p.h.

◆ nextScopePath()

Path QQmlJS::Dom::QmlObject::nextScopePath ( ) const
inline

Definition at line 863 of file qqmldomelements_p.h.

◆ propertyDefs()

const QMultiMap< QString, PropertyDefinition > & QQmlJS::Dom::QmlObject::propertyDefs ( ) const &
inline

Definition at line 864 of file qqmldomelements_p.h.

◆ prototypePaths()

const QList< Path > & QQmlJS::Dom::QmlObject::prototypePaths ( ) const &
inline

Definition at line 862 of file qqmldomelements_p.h.

◆ resolveAlias() [1/2]

LocallyResolvedAlias QQmlJS::Dom::QmlObject::resolveAlias ( const DomItem & self,
const QStringList & accessSequence ) const

◆ resolveAlias() [2/2]

LocallyResolvedAlias QQmlJS::Dom::QmlObject::resolveAlias ( const DomItem & self,
std::shared_ptr< ScriptExpression > accessSequence ) const

◆ semanticScope()

QQmlJSScope::ConstPtr QQmlJS::Dom::QmlObject::semanticScope ( ) const
inline

Definition at line 946 of file qqmldomelements_p.h.

◆ setAnnotations()

void QQmlJS::Dom::QmlObject::setAnnotations ( const QList< QmlObject > & annotations)
inline

Definition at line 896 of file qqmldomelements_p.h.

◆ setBindings()

void QQmlJS::Dom::QmlObject::setBindings ( QMultiMap< QString, Binding > bindings)
inline

Definition at line 888 of file qqmldomelements_p.h.

◆ setChildren()

void QQmlJS::Dom::QmlObject::setChildren ( const QList< QmlObject > & children)
inline

Definition at line 890 of file qqmldomelements_p.h.

◆ setDefaultPropertyName()

void QQmlJS::Dom::QmlObject::setDefaultPropertyName ( const QString & name)
inline

Definition at line 872 of file qqmldomelements_p.h.

◆ setIdStr()

void QQmlJS::Dom::QmlObject::setIdStr ( const QString & id)
inline

Definition at line 870 of file qqmldomelements_p.h.

Referenced by QQmlJS::Dom::QQmlDomAstCreator::visit().

+ Here is the caller graph for this function:

◆ setMethods()

void QQmlJS::Dom::QmlObject::setMethods ( QMultiMap< QString, MethodInfo > functionDefs)
inline

Definition at line 889 of file qqmldomelements_p.h.

◆ setName()

void QQmlJS::Dom::QmlObject::setName ( const QString & name)
inline

Definition at line 871 of file qqmldomelements_p.h.

Referenced by QQmlJS::Dom::QQmlDomAstCreator::endVisit(), QQmlJS::Dom::QQmlDomAstCreator::visit(), and QQmlJS::Dom::QQmlDomAstCreator::visit().

+ Here is the caller graph for this function:

◆ setNameIdentifiers()

void QQmlJS::Dom::QmlObject::setNameIdentifiers ( const ScriptElementVariant & name)
inline

Definition at line 950 of file qqmldomelements_p.h.

◆ setNextScopePath()

void QQmlJS::Dom::QmlObject::setNextScopePath ( const Path & nextScopePath)
inline

Definition at line 883 of file qqmldomelements_p.h.

◆ setPropertyDefs()

void QQmlJS::Dom::QmlObject::setPropertyDefs ( QMultiMap< QString, PropertyDefinition > propertyDefs)
inline

Definition at line 884 of file qqmldomelements_p.h.

◆ setPrototypePaths()

void QQmlJS::Dom::QmlObject::setPrototypePaths ( QList< Path > prototypePaths)
inline

Definition at line 873 of file qqmldomelements_p.h.

◆ setSemanticScope()

void QQmlJS::Dom::QmlObject::setSemanticScope ( const QQmlJSScope::ConstPtr & scope)
inline

Definition at line 947 of file qqmldomelements_p.h.

◆ updatePathFromOwner()

void QQmlJS::Dom::QmlObject::updatePathFromOwner ( const Path & newPath)
overridevirtual

Reimplemented from QQmlJS::Dom::DomElement.

◆ writeOut() [1/2]

void QQmlJS::Dom::QmlObject::writeOut ( const DomItem & self,
OutWriter & lw ) const
inlineoverridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

Definition at line 940 of file qqmldomelements_p.h.

References writeOut().

Referenced by writeOut().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ writeOut() [2/2]

void QQmlJS::Dom::QmlObject::writeOut ( const DomItem & self,
OutWriter & ow,
const QString & onTarget ) const

Friends And Related Symbol Documentation

◆ QQmlDomAstCreator

friend class QQmlDomAstCreator
friend

Definition at line 953 of file qqmldomelements_p.h.

Member Data Documentation

◆ kindValue

constexpr DomType QQmlJS::Dom::QmlObject::kindValue = DomType::QmlObject
staticconstexpr

Definition at line 846 of file qqmldomelements_p.h.

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