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::MutableDomItem Class Reference

#include <qqmldomitem_p.h>

Collaboration diagram for QQmlJS::Dom::MutableDomItem:

Public Types

using CopyOption = DomItem::CopyOption

Public Member Functions

 operator bool () const
DomType internalKind ()
QString internalKindStr ()
DomKind domKind ()
Path canonicalPath () const
MutableDomItem containingObject ()
MutableDomItem container ()
MutableDomItem qmlObject (GoTo option=GoTo::Strict, FilterUpOptions fOptions=FilterUpOptions::ReturnOuter)
MutableDomItem fileObject (GoTo option=GoTo::Strict)
MutableDomItem rootQmlObject (GoTo option=GoTo::Strict)
MutableDomItem scope ()
MutableDomItem component (GoTo option=GoTo::Strict)
MutableDomItem owner ()
MutableDomItem top ()
MutableDomItem environment ()
MutableDomItem universe ()
Path pathFromOwner ()
MutableDomItem operator[] (const Path &path)
MutableDomItem operator[] (QStringView component)
MutableDomItem operator[] (const QString &component)
MutableDomItem operator[] (const char16_t *component)
MutableDomItem operator[] (index_type i)
MutableDomItem path (const Path &p)
MutableDomItem path (const QString &p)
MutableDomItem path (QStringView p)
QList< QString > const fields ()
MutableDomItem field (QStringView name)
index_type indexes ()
MutableDomItem index (index_type i)
QSet< QString > const keys ()
MutableDomItem key (const QString &name)
MutableDomItem key (QStringView name)
void dump (const Sink &s, int indent=0, function_ref< bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)> filter=noFilter)
FileWriter::Status dump (const QString &path, function_ref< bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)> filter=noFilter, int indent=0, FileWriter *fw=nullptr)
void writeOut (OutWriter &lw)
bool writeOut (const QString &path, const LineWriterOptions &opt=LineWriterOptions(), FileWriter *fw=nullptr)
MutableDomItem makeCopy (CopyOption option=CopyOption::EnvConnected)
bool commitToBase (const std::shared_ptr< DomEnvironment > &validEnvPtr=nullptr)
QString canonicalFilePath () const
MutableDomItem refreshed ()
QCborValue value ()
QString toString ()
QString name ()
MutableDomItem pragmas ()
MutableDomItem ids ()
QString idStr ()
MutableDomItem propertyDefs ()
MutableDomItem bindings ()
MutableDomItem methods ()
MutableDomItem children ()
MutableDomItem child (index_type i)
MutableDomItem annotations ()
int derivedFrom ()
int revision ()
QDateTime createdAt ()
QDateTime frozenAt ()
QDateTime lastDataUpdateAt ()
void addError (ErrorMessage &&msg)
ErrorHandler errorHandler ()
MutableDomItem addPropertyDef (const PropertyDefinition &propertyDef, AddOption option=AddOption::Overwrite)
MutableDomItem addBinding (Binding binding, AddOption option=AddOption::Overwrite)
MutableDomItem addMethod (const MethodInfo &functionDef, AddOption option=AddOption::Overwrite)
MutableDomItem addChild (QmlObject child)
 MutableDomItem ()=default
 MutableDomItem (const DomItem &owner, const Path &pathFromOwner)
 MutableDomItem (const DomItem &item)
std::shared_ptr< DomTop > topPtr ()
std::shared_ptr< OwningItem > owningItemPtr ()
template<typename T>
T const * as ()
template<typename T>
T * mutableAs ()
template<typename T>
std::shared_ptr< T > ownerAs () const
DomItem item () const

Friends

bool operator== (const MutableDomItem &o1, const MutableDomItem &o2)
bool operator!= (const MutableDomItem &o1, const MutableDomItem &o2)

Detailed Description

Definition at line 1515 of file qqmldomitem_p.h.

Member Typedef Documentation

◆ CopyOption

using QQmlJS::Dom::MutableDomItem::CopyOption = DomItem::CopyOption

Definition at line 1517 of file qqmldomitem_p.h.

Constructor & Destructor Documentation

◆ MutableDomItem() [1/3]

QQmlJS::Dom::MutableDomItem::MutableDomItem ( )
default

Referenced by addBinding(), addChild(), addMethod(), addPropertyDef(), and QQmlJS::Dom::DomItem::makeCopy().

Here is the caller graph for this function:

◆ MutableDomItem() [2/3]

QQmlJS::Dom::MutableDomItem::MutableDomItem ( const DomItem & owner,
const Path & pathFromOwner )
inline

Definition at line 1665 of file qqmldomitem_p.h.

References MutableDomItem().

Referenced by MutableDomItem(), QQmlJS::Dom::QmlObject::addChild(), and containingObject().

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

◆ MutableDomItem() [3/3]

QQmlJS::Dom::MutableDomItem::MutableDomItem ( const DomItem & item)
inline

Definition at line 1668 of file qqmldomitem_p.h.

References MutableDomItem().

Referenced by MutableDomItem(), annotations(), bindings(), children(), container(), environment(), methods(), operator[](), propertyDefs(), refreshed(), scope(), top(), and universe().

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

Member Function Documentation

◆ addBinding()

MutableDomItem QQmlJS::Dom::MutableDomItem::addBinding ( Binding binding,
AddOption option = AddOption::Overwrite )

Definition at line 3070 of file qqmldomitem.cpp.

References MutableDomItem(), and QQmlJS::Dom::QmlObject::addBinding().

Here is the call graph for this function:

◆ addChild()

MutableDomItem QQmlJS::Dom::MutableDomItem::addChild ( QmlObject child)

Definition at line 3088 of file qqmldomitem.cpp.

References MutableDomItem(), QQmlJS::Dom::QmlObject::addChild(), QQmlJS::Dom::Component::addObject(), owner(), and path().

Here is the call graph for this function:

◆ addError()

void QQmlJS::Dom::MutableDomItem::addError ( ErrorMessage && msg)
inline

Definition at line 1653 of file qqmldomitem_p.h.

References QQmlJS::Dom::DomItem::addError(), and item().

Referenced by errorHandler().

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

◆ addMethod()

MutableDomItem QQmlJS::Dom::MutableDomItem::addMethod ( const MethodInfo & functionDef,
AddOption option = AddOption::Overwrite )

Definition at line 3079 of file qqmldomitem.cpp.

References MutableDomItem(), and QQmlJS::Dom::QmlObject::addMethod().

Here is the call graph for this function:

◆ addPropertyDef()

MutableDomItem QQmlJS::Dom::MutableDomItem::addPropertyDef ( const PropertyDefinition & propertyDef,
AddOption option = AddOption::Overwrite )

Definition at line 3060 of file qqmldomitem.cpp.

References MutableDomItem(), and QQmlJS::Dom::QmlObject::addPropertyDef().

Here is the call graph for this function:

◆ annotations()

MutableDomItem QQmlJS::Dom::MutableDomItem::annotations ( )
inline

Definition at line 1644 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::DomItem::annotations(), and item().

Here is the call graph for this function:

◆ as()

template<typename T>
T const * QQmlJS::Dom::MutableDomItem::as ( )
inline

Definition at line 1676 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ bindings()

MutableDomItem QQmlJS::Dom::MutableDomItem::bindings ( )
inline

Definition at line 1640 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::DomItem::bindings(), and item().

Here is the call graph for this function:

◆ canonicalFilePath()

QString QQmlJS::Dom::MutableDomItem::canonicalFilePath ( ) const
inline

Definition at line 1626 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ canonicalPath()

Path QQmlJS::Dom::MutableDomItem::canonicalPath ( ) const
inline

Definition at line 1527 of file qqmldomitem_p.h.

◆ child()

MutableDomItem QQmlJS::Dom::MutableDomItem::child ( index_type i)
inline

Definition at line 1643 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ children()

MutableDomItem QQmlJS::Dom::MutableDomItem::children ( )
inline

Definition at line 1642 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::DomItem::children(), and item().

Here is the call graph for this function:

◆ commitToBase()

bool QQmlJS::Dom::MutableDomItem::commitToBase ( const std::shared_ptr< DomEnvironment > & validEnvPtr = nullptr)
inline

Definition at line 1622 of file qqmldomitem_p.h.

References QQmlJS::Dom::DomItem::commitToBase(), and item().

Here is the call graph for this function:

◆ component()

MutableDomItem QQmlJS::Dom::MutableDomItem::component ( GoTo option = GoTo::Strict)
inline

Definition at line 1562 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ container()

MutableDomItem QQmlJS::Dom::MutableDomItem::container ( )
inline

Definition at line 1538 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::DomItem::container(), and item().

Here is the call graph for this function:

◆ containingObject()

MutableDomItem QQmlJS::Dom::MutableDomItem::containingObject ( )
inline

Definition at line 1528 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::Path::Path(), QQmlJS::Dom::domTypeIsOwningItem(), QQmlJS::Dom::DomItem::internalKind(), QQmlJS::Dom::DomItem::owner(), and QQmlJS::Dom::DomItem::pathFromOwner().

Here is the call graph for this function:

◆ createdAt()

QDateTime QQmlJS::Dom::MutableDomItem::createdAt ( )
inline

Definition at line 1649 of file qqmldomitem_p.h.

◆ derivedFrom()

int QQmlJS::Dom::MutableDomItem::derivedFrom ( )
inline

Definition at line 1647 of file qqmldomitem_p.h.

◆ domKind()

DomKind QQmlJS::Dom::MutableDomItem::domKind ( )
inline

Definition at line 1525 of file qqmldomitem_p.h.

◆ dump() [1/2]

FileWriter::Status QQmlJS::Dom::MutableDomItem::dump ( const QString & path,
function_ref< bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)> filter = noFilter,
int indent = 0,
FileWriter * fw = nullptr )
inline

Definition at line 1604 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ dump() [2/2]

void QQmlJS::Dom::MutableDomItem::dump ( const Sink & s,
int indent = 0,
function_ref< bool(const DomItem &, const PathEls::PathComponent &, const DomItem &)> filter = noFilter )
inline

Definition at line 1598 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ environment()

MutableDomItem QQmlJS::Dom::MutableDomItem::environment ( )
inline

Definition at line 1568 of file qqmldomitem_p.h.

References MutableDomItem(), QQmlJS::Dom::DomItem::environment(), and item().

Here is the call graph for this function:

◆ errorHandler()

ErrorHandler QQmlJS::Dom::MutableDomItem::errorHandler ( )

Definition at line 3054 of file qqmldomitem.cpp.

References addError().

Here is the call graph for this function:

◆ field()

MutableDomItem QQmlJS::Dom::MutableDomItem::field ( QStringView name)
inline

Definition at line 1589 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ fields()

QList< QString > const QQmlJS::Dom::MutableDomItem::fields ( )
inline

Definition at line 1588 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ fileObject()

MutableDomItem QQmlJS::Dom::MutableDomItem::fileObject ( GoTo option = GoTo::Strict)
inline

Definition at line 1552 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ frozenAt()

QDateTime QQmlJS::Dom::MutableDomItem::frozenAt ( )
inline

Definition at line 1650 of file qqmldomitem_p.h.

◆ ids()

MutableDomItem QQmlJS::Dom::MutableDomItem::ids ( )
inline

Definition at line 1637 of file qqmldomitem_p.h.

References QQmlJS::Dom::DomItem::ids(), and item().

Here is the call graph for this function:

◆ idStr()

QString QQmlJS::Dom::MutableDomItem::idStr ( )
inline

Definition at line 1638 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ index()

MutableDomItem QQmlJS::Dom::MutableDomItem::index ( index_type i)
inline

Definition at line 1591 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ indexes()

index_type QQmlJS::Dom::MutableDomItem::indexes ( )
inline

Definition at line 1590 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ internalKind()

DomType QQmlJS::Dom::MutableDomItem::internalKind ( )
inline

Definition at line 1523 of file qqmldomitem_p.h.

References QQmlJS::Dom::DomItem::internalKind(), and item().

Here is the call graph for this function:

◆ internalKindStr()

QString QQmlJS::Dom::MutableDomItem::internalKindStr ( )
inline

Definition at line 1524 of file qqmldomitem_p.h.

◆ item()

DomItem QQmlJS::Dom::MutableDomItem::item ( ) const
inline

Definition at line 1707 of file qqmldomitem_p.h.

Referenced by QQmlJS::Dom::QmlObject::addChild(), addError(), annotations(), as(), bindings(), canonicalFilePath(), child(), children(), commitToBase(), component(), container(), QQmlJS::Dom::domCompareStrList(), QQmlJS::Dom::domCompareStrList(), QQmlJS::Dom::domCompareStrList(), dump(), dump(), environment(), field(), fields(), fileObject(), ids(), idStr(), index(), indexes(), internalKind(), key(), keys(), makeCopy(), methods(), mutableAs(), name(), operator[](), operator[](), operator[](), operator[](), operator[](), path(), pragmas(), propertyDefs(), qmlObject(), refreshed(), rootQmlObject(), scope(), top(), toString(), universe(), value(), writeOut(), and writeOut().

Here is the caller graph for this function:

◆ key() [1/2]

MutableDomItem QQmlJS::Dom::MutableDomItem::key ( const QString & name)
inline

Definition at line 1594 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ key() [2/2]

MutableDomItem QQmlJS::Dom::MutableDomItem::key ( QStringView name)
inline

Definition at line 1595 of file qqmldomitem_p.h.

◆ keys()

QSet< QString > const QQmlJS::Dom::MutableDomItem::keys ( )
inline

Definition at line 1593 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ lastDataUpdateAt()

QDateTime QQmlJS::Dom::MutableDomItem::lastDataUpdateAt ( )
inline

Definition at line 1651 of file qqmldomitem_p.h.

◆ makeCopy()

MutableDomItem QQmlJS::Dom::MutableDomItem::makeCopy ( CopyOption option = CopyOption::EnvConnected)
inline

Definition at line 1618 of file qqmldomitem_p.h.

References item(), and QQmlJS::Dom::DomItem::makeCopy().

Here is the call graph for this function:

◆ methods()

MutableDomItem QQmlJS::Dom::MutableDomItem::methods ( )
inline

Definition at line 1641 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::methods().

Here is the call graph for this function:

◆ mutableAs()

template<typename T>
T * QQmlJS::Dom::MutableDomItem::mutableAs ( )
inline

Definition at line 1682 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ name()

QString QQmlJS::Dom::MutableDomItem::name ( )
inline

Definition at line 1635 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ operator bool()

QQmlJS::Dom::MutableDomItem::operator bool ( ) const
inlineexplicit

Definition at line 1519 of file qqmldomitem_p.h.

◆ operator[]() [1/5]

MutableDomItem QQmlJS::Dom::MutableDomItem::operator[] ( const char16_t * component)
inline

Definition at line 1577 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ operator[]() [2/5]

MutableDomItem QQmlJS::Dom::MutableDomItem::operator[] ( const Path & path)
inline

Definition at line 1571 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::operator[]().

Here is the call graph for this function:

◆ operator[]() [3/5]

MutableDomItem QQmlJS::Dom::MutableDomItem::operator[] ( const QString & component)
inline

Definition at line 1573 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ operator[]() [4/5]

MutableDomItem QQmlJS::Dom::MutableDomItem::operator[] ( index_type i)
inline

Definition at line 1582 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ operator[]() [5/5]

MutableDomItem QQmlJS::Dom::MutableDomItem::operator[] ( QStringView component)
inline

Definition at line 1572 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ owner()

MutableDomItem QQmlJS::Dom::MutableDomItem::owner ( )
inline

Definition at line 1566 of file qqmldomitem_p.h.

Referenced by QQmlJS::Dom::QmlObject::addBinding(), addChild(), QQmlJS::Dom::QmlObject::addChild(), QQmlJS::Dom::QmlObject::addMethod(), and QQmlJS::Dom::QmlObject::addPropertyDef().

Here is the caller graph for this function:

◆ ownerAs()

template<typename T>
std::shared_ptr< T > QQmlJS::Dom::MutableDomItem::ownerAs ( ) const
inline

Definition at line 1702 of file qqmldomitem_p.h.

◆ owningItemPtr()

std::shared_ptr< OwningItem > QQmlJS::Dom::MutableDomItem::owningItemPtr ( )
inline

Definition at line 1673 of file qqmldomitem_p.h.

◆ path() [1/3]

MutableDomItem QQmlJS::Dom::MutableDomItem::path ( const Path & p)
inline

Definition at line 1584 of file qqmldomitem_p.h.

References item(), and QQmlJS::Dom::DomItem::path().

Referenced by QQmlJS::Dom::QmlObject::addBinding(), addChild(), QQmlJS::Dom::QmlObject::addMethod(), QQmlJS::Dom::QmlObject::addPropertyDef(), path(), and path().

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

◆ path() [2/3]

MutableDomItem QQmlJS::Dom::MutableDomItem::path ( const QString & p)
inline

Definition at line 1585 of file qqmldomitem_p.h.

References path().

Here is the call graph for this function:

◆ path() [3/3]

MutableDomItem QQmlJS::Dom::MutableDomItem::path ( QStringView p)
inline

Definition at line 1586 of file qqmldomitem_p.h.

References path().

Here is the call graph for this function:

◆ pathFromOwner()

Path QQmlJS::Dom::MutableDomItem::pathFromOwner ( )
inline

Definition at line 1570 of file qqmldomitem_p.h.

◆ pragmas()

MutableDomItem QQmlJS::Dom::MutableDomItem::pragmas ( )
inline

Definition at line 1636 of file qqmldomitem_p.h.

References item(), and QQmlJS::Dom::DomItem::pragmas().

Here is the call graph for this function:

◆ propertyDefs()

MutableDomItem QQmlJS::Dom::MutableDomItem::propertyDefs ( )
inline

Definition at line 1639 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::propertyDefs().

Here is the call graph for this function:

◆ qmlObject()

MutableDomItem QQmlJS::Dom::MutableDomItem::qmlObject ( GoTo option = GoTo::Strict,
FilterUpOptions fOptions = FilterUpOptions::ReturnOuter )
inline

Definition at line 1547 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ refreshed()

MutableDomItem QQmlJS::Dom::MutableDomItem::refreshed ( )
inline

Definition at line 1628 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::refreshed().

Here is the call graph for this function:

◆ revision()

int QQmlJS::Dom::MutableDomItem::revision ( )
inline

Definition at line 1648 of file qqmldomitem_p.h.

◆ rootQmlObject()

MutableDomItem QQmlJS::Dom::MutableDomItem::rootQmlObject ( GoTo option = GoTo::Strict)
inline

Definition at line 1556 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ scope()

MutableDomItem QQmlJS::Dom::MutableDomItem::scope ( )
inline

Definition at line 1560 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::scope().

Here is the call graph for this function:

◆ top()

MutableDomItem QQmlJS::Dom::MutableDomItem::top ( )
inline

Definition at line 1567 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::top().

Here is the call graph for this function:

◆ topPtr()

std::shared_ptr< DomTop > QQmlJS::Dom::MutableDomItem::topPtr ( )
inline

Definition at line 1672 of file qqmldomitem_p.h.

◆ toString()

QString QQmlJS::Dom::MutableDomItem::toString ( )
inline

Definition at line 1632 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ universe()

MutableDomItem QQmlJS::Dom::MutableDomItem::universe ( )
inline

Definition at line 1569 of file qqmldomitem_p.h.

References MutableDomItem(), item(), and QQmlJS::Dom::DomItem::universe().

Here is the call graph for this function:

◆ value()

QCborValue QQmlJS::Dom::MutableDomItem::value ( )
inline

Definition at line 1630 of file qqmldomitem_p.h.

References item().

Here is the call graph for this function:

◆ writeOut() [1/2]

bool QQmlJS::Dom::MutableDomItem::writeOut ( const QString & path,
const LineWriterOptions & opt = LineWriterOptions(),
FileWriter * fw = nullptr )
inline

Definition at line 1612 of file qqmldomitem_p.h.

References item(), and QQmlJS::Dom::DomItem::writeOut().

Here is the call graph for this function:

◆ writeOut() [2/2]

void QQmlJS::Dom::MutableDomItem::writeOut ( OutWriter & lw)
inline

Definition at line 1611 of file qqmldomitem_p.h.

References item(), and QQmlJS::Dom::DomItem::writeOut().

Here is the call graph for this function:

◆ operator!=

bool operator!= ( const MutableDomItem & o1,
const MutableDomItem & o2 )
friend

Definition at line 1713 of file qqmldomitem_p.h.

References operator==.

◆ operator==

bool operator== ( const MutableDomItem & o1,
const MutableDomItem & o2 )
friend

Definition at line 1709 of file qqmldomitem_p.h.

Referenced by operator!=.

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