Qt 6.x
The Qt SDK
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
QQmlJS::Dom::DomTop Class Referenceabstract

#include <qqmldomtop_p.h>

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

Public Types

using Callback = DomItem::Callback
 
- Public Types inherited from QQmlJS::Dom::DomBase
using FilterT = function_ref< bool(DomItem &, const PathEls::PathComponent &, DomItem &)>
 

Public Member Functions

 DomTop (QMap< QString, OwnerT > extraOwningItems={}, int derivedFrom=0)
 
 DomTop (const DomTop &o)
 
virtual Path canonicalPath () const =0
 
Path canonicalPath (DomItem &) const override
 QQml::Dom::DomTop::loadFile.
 
DomItem containingObject (DomItem &) const override
 
bool iterateDirectSubpaths (DomItem &self, DirectVisitor) override
 
template<typename T >
void setExtraOwningItem (QString fieldName, std::shared_ptr< T > item)
 
void clearExtraOwningItems ()
 
QMap< QString, OwnerTextraOwningItems () const
 
- Public Member Functions inherited from QQmlJS::Dom::OwningItem
 OwningItem (const OwningItem &o)
 
 OwningItem (int derivedFrom=0)
 
 OwningItem (int derivedFrom, QDateTime lastDataUpdateAt)
 
 OwningItem (const OwningItem &&)=delete
 
OwningItemoperator= (const OwningItem &&)=delete
 
Path canonicalPath (DomItem &self) const override=0
 
bool iterateDirectSubpaths (DomItem &self, DirectVisitor) override
 
std::shared_ptr< OwningItemmakeCopy (DomItem &self) const
 
Path pathFromOwner () const
 
Path pathFromOwner (DomItem &) const override final
 
DomItem containingObject (DomItem &self) const override
 
int derivedFrom () const
 
virtual int revision () const
 
QDateTime createdAt () const
 
virtual QDateTime lastDataUpdateAt () const
 
virtual void refreshedDataAt (QDateTime tNew)
 
virtual bool frozen () const
 
virtual bool freeze ()
 
QDateTime frozenAt () const
 
virtual void addError (DomItem &self, ErrorMessage msg)
 
void addErrorLocal (ErrorMessage msg)
 
void clearErrors (ErrorGroups groups=ErrorGroups({}))
 
bool iterateErrors (DomItem &self, function_ref< bool(DomItem source, ErrorMessage msg)> visitor, Path inPath=Path())
 
QMultiMap< Path, ErrorMessagelocalErrors () const
 
virtual bool iterateSubOwners (DomItem &self, function_ref< bool(DomItem &owner)> visitor)
 
QBasicMutexmutex () const
 
- Public Member Functions inherited from QQmlJS::Dom::DomBase
virtual ~DomBase ()=default
 
DomBasedomBase ()
 
virtual DomType kind () const =0
 
virtual DomKind domKind () const
 
virtual Path pathFromOwner (DomItem &self) const =0
 
virtual Path canonicalPath (DomItem &self) const =0
 
virtual bool iterateDirectSubpaths (DomItem &self, DirectVisitor visitor)=0
 
bool iterateDirectSubpathsConst (DomItem &self, DirectVisitor) const
 
virtual DomItem containingObject (DomItem &self) const
 
virtual void dump (DomItem &, Sink sink, int indent, FilterT filter) const
 
virtual quintptr id () const
 
QString typeName () const
 
virtual QList< QStringfields (DomItem &self) const
 
virtual DomItem field (DomItem &self, QStringView name) const
 
virtual index_type indexes (DomItem &self) const
 
virtual DomItem index (DomItem &self, index_type index) const
 
virtual QSet< QString > const keys (DomItem &self) const
 
virtual DomItem key (DomItem &self, QString name) const
 
virtual QString canonicalFilePath (DomItem &self) const
 
virtual void writeOut (DomItem &self, OutWriter &lw) const
 
virtual QCborValue value () const
 

Additional Inherited Members

- Static Public Member Functions inherited from QQmlJS::Dom::OwningItem
static int nextRevision ()
 
- Protected Member Functions inherited from QQmlJS::Dom::OwningItem
virtual std::shared_ptr< OwningItemdoCopy (DomItem &self) const =0
 

Detailed Description

Definition at line 158 of file qqmldomtop_p.h.

Member Typedef Documentation

◆ Callback

Constructor & Destructor Documentation

◆ DomTop() [1/2]

QQmlJS::Dom::DomTop::DomTop ( QMap< QString, OwnerT extraOwningItems = {},
int  derivedFrom = 0 
)
inline

Definition at line 160 of file qqmldomtop_p.h.

◆ DomTop() [2/2]

QQmlJS::Dom::DomTop::DomTop ( const DomTop o)
inline

Definition at line 163 of file qqmldomtop_p.h.

References items, mutex, and o.

Member Function Documentation

◆ canonicalPath() [1/2]

virtual Path QQmlJS::Dom::DomTop::canonicalPath ( ) const
pure virtual

Implemented in QQmlJS::Dom::DomUniverse, QQmlJS::Dom::DomEnvironment, QQmlJS::Dom::DomUniverse, and QQmlJS::Dom::DomEnvironment.

Referenced by canonicalPath().

+ Here is the caller graph for this function:

◆ canonicalPath() [2/2]

Path QQmlJS::Dom::DomTop::canonicalPath ( DomItem ) const
overridevirtual

QQml::Dom::DomTop::loadFile.

Parameters
filePaththe file path to load
logicalPaththe path from the
callbacka callback called with an canonical path, the old value, and the current value.
loadOptionsare if force is true the file is always read

Implements QQmlJS::Dom::OwningItem.

Reimplemented in QQmlJS::Dom::DomUniverse.

Definition at line 58 of file qqmldomtop.cpp.

References canonicalPath().

+ Here is the call graph for this function:

◆ clearExtraOwningItems()

void QQmlJS::Dom::DomTop::clearExtraOwningItems ( )

Definition at line 91 of file qqmldomtop.cpp.

References mutex.

◆ containingObject()

DomItem QQmlJS::Dom::DomTop::containingObject ( DomItem ) const
overridevirtual

Reimplemented from QQmlJS::Dom::DomBase.

Definition at line 63 of file qqmldomtop.cpp.

◆ extraOwningItems()

QMap< QString, OwnerT > QQmlJS::Dom::DomTop::extraOwningItems ( ) const

Definition at line 97 of file qqmldomtop.cpp.

References mutex.

◆ iterateDirectSubpaths()

bool QQmlJS::Dom::DomTop::iterateDirectSubpaths ( DomItem self,
DirectVisitor  visitor 
)
overridevirtual

Implements QQmlJS::Dom::DomBase.

Reimplemented in QQmlJS::Dom::DomUniverse.

Definition at line 68 of file qqmldomtop.cpp.

References QMap< Key, T >::cbegin(), and QHash< Key, T >::contains().

Referenced by QQmlJS::Dom::DomUniverse::iterateDirectSubpaths().

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

◆ setExtraOwningItem()

template<typename T >
void QQmlJS::Dom::DomTop::setExtraOwningItem ( QString  fieldName,
std::shared_ptr< T >  item 
)
inline

Definition at line 180 of file qqmldomtop_p.h.

References item, and mutex.


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