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 | Protected Member Functions | Friends | List of all members
QQmlQmldirData Class Reference

#include <qqmldirdata_p.h>

+ Inheritance diagram for QQmlQmldirData:
+ Collaboration diagram for QQmlQmldirData:

Public Member Functions

const QString & content () const
 
QV4::CompiledData::Location importLocation (Blob *blob) const
 
template<typename Callback >
bool processImports (Blob *blob, const Callback &callback) const
 
void setPriority (Blob *, PendingImportPtr, int)
 
- Public Member Functions inherited from QQmlTypeLoader::Blob
 Blob (const QUrl &url, QQmlDataBlob::Type type, QQmlTypeLoader *loader)
 
 ~Blob () override
 
const QQmlImports * imports () const
 
void setCachedUnitStatus (QQmlMetaType::CachedUnitLookupError status)
 
void importQmldirScripts (const PendingImportPtr &import, const QQmlTypeLoaderQmldirContent &qmldir, const QUrl &qmldirUrl)
 
- Public Member Functions inherited from QQmlDataBlob
 QQmlDataBlob (const QUrl &, Type, QQmlTypeLoader *manager)
 Create a new QQmlDataBlob for url and of the provided type.
 
virtual ~QQmlDataBlob ()
 
void startLoading ()
 Must be called before loading can occur.
 
QQmlTypeLoader * typeLoader () const
 
Type type () const
 Returns the type provided to the constructor.
 
Status status () const
 Returns the blob's status.
 
bool isNull () const
 Returns true if the status is Null.
 
bool isLoading () const
 Returns true if the status is Loading.
 
bool isWaiting () const
 Returns true if the status is WaitingForDependencies.
 
bool isComplete () const
 Returns true if the status is Complete.
 
bool isError () const
 Returns true if the status is Error.
 
bool isCompleteOrError () const
 Returns true if the status is Complete or Error.
 
qreal progress () const
 Returns the data download progress from 0 to 1.
 
QUrl url () const
 Returns the physical url of the data.
 
QString urlString () const
 
QUrl finalUrl () const
 Returns the logical URL to be used for resolving further URLs referred to in the code.
 
QString finalUrlString () const
 Returns the finalUrl() as a string.
 
QList< QQmlError > errors () const
 Return the errors on this blob.
 
- Public Member Functions inherited from QQmlRefCounted< QQmlDataBlob >
void release () const
 
- Public Member Functions inherited from QQmlRefCount
 QQmlRefCount ()
 
void addref () const
 
int count () const
 

Protected Member Functions

void dataReceived (const SourceCodeData &) override
 Invoked when data for the blob is received.
 
void initializeFromCachedUnit (const QQmlPrivate::CachedQmlUnit *) override
 
- Protected Member Functions inherited from QQmlTypeLoader::Blob
bool addImport (const QV4::CompiledData::Import *import, QQmlImports::ImportFlags, QList< QQmlError > *errors)
 
bool addImport (PendingImportPtr import, QList< QQmlError > *errors)
 
bool fetchQmldir (const QUrl &url, PendingImportPtr import, int priority, QList< QQmlError > *errors)
 
bool updateQmldir (const QQmlRefPointer< QQmlQmldirData > &data, const PendingImportPtr &import, QList< QQmlError > *errors)
 
bool loadDependentImports (const QList< QQmlDirParser::Import > &imports, const QString &qualifier, QTypeRevision version, quint16 precedence, QQmlImports::ImportFlags flags, QList< QQmlError > *errors)
 
virtual QString stringAt (int) const
 
bool isDebugging () const
 
bool readCacheFile () const
 
bool writeCacheFile () const
 
QQmlMetaType::CacheMode aotCacheMode () const
 
- Protected Member Functions inherited from QQmlDataBlob
void setError (const QQmlError &)
 Mark this blob as having errors.
 
void setError (const QList< QQmlError > &errors)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
void setError (const QQmlJS::DiagnosticMessage &error)
 
void setError (const QString &description)
 
void addDependency (QQmlDataBlob *)
 Wait for blob to become complete or to error.
 
virtual void done ()
 Invoked once data has either been received or a network error occurred, and all dependencies are complete.
 
virtual void dependencyError (QQmlDataBlob *)
 Called if blob, which was previously waited for, has an error.
 
virtual void allDependenciesDone ()
 Called when all blobs waited for have completed.
 
virtual void downloadProgressChanged (qreal)
 Called when the download progress of this blob changes.
 
virtual void completed ()
 Invoked on the main thread sometime after done() was called on the load thread.
 
- Protected Member Functions inherited from QQmlRefCounted< QQmlDataBlob >
 ~QQmlRefCounted ()
 

Friends

class QQmlTypeLoader
 

Additional Inherited Members

- Public Types inherited from QQmlTypeLoader::Blob
using PendingImportPtr = std::shared_ptr<PendingImport>
 
- Public Types inherited from QQmlDataBlob
enum  Status {
  Null , Loading , WaitingForDependencies , ResolvingDependencies ,
  Complete , Error
}
 This enum describes the status of the data blob. More...
 
enum  Type { QmlFile = QQmlAbstractUrlInterceptor::QmlFile , JavaScriptFile = QQmlAbstractUrlInterceptor::JavaScriptFile , QmldirFile = QQmlAbstractUrlInterceptor::QmldirFile }
 This enum describes the type of the data blob. More...
 
using Ptr = QQmlRefPointer<QQmlDataBlob>
 
- Protected Attributes inherited from QQmlTypeLoader::Blob
QQmlRefPointer< QQmlImports > m_importCache
 
QVector< PendingImportPtr > m_unresolvedImports
 
QVector< QQmlRefPointer< QQmlQmldirData > > m_qmldirs
 
QQmlMetaType::CachedUnitLookupError m_cachedUnitStatus = QQmlMetaType::CachedUnitLookupError::NoError
 
- Protected Attributes inherited from QQmlDataBlob
QQmlTypeLoader * m_typeLoader
 
QList< QQmlDataBlob * > m_waitingOnMe
 

Detailed Description

Definition at line 22 of file qqmldirdata_p.h.

Member Function Documentation

◆ content()

const QString & QQmlQmldirData::content ( ) const

Definition at line 13 of file qqmldirdata.cpp.

◆ dataReceived()

void QQmlQmldirData::dataReceived ( const SourceCodeData & )
overrideprotectedvirtual

Invoked when data for the blob is received.

Implementors should use this callback to determine a blob's dependencies. Within this callback you may call setError() or addDependency().

Implements QQmlDataBlob.

Definition at line 32 of file qqmldirdata.cpp.

References error, and QQmlDataBlob::setError().

+ Here is the call graph for this function:

◆ importLocation()

QV4::CompiledData::Location QQmlQmldirData::importLocation ( Blob * blob) const

Definition at line 18 of file qqmldirdata.cpp.

References QMultiHash< Key, T >::constEnd(), QMultiHash< Key, T >::constFind(), and it.

+ Here is the call graph for this function:

◆ initializeFromCachedUnit()

void QQmlQmldirData::initializeFromCachedUnit ( const QQmlPrivate::CachedQmlUnit * )
overrideprotectedvirtual

Implements QQmlDataBlob.

Definition at line 42 of file qqmldirdata.cpp.

References Q_UNIMPLEMENTED.

◆ processImports()

template<typename Callback >
bool QQmlQmldirData::processImports ( Blob * blob,
const Callback & callback ) const
inline

Definition at line 34 of file qqmldirdata_p.h.

References it.

◆ setPriority()

void QQmlQmldirData::setPriority ( Blob * ,
PendingImportPtr ,
int  )

Definition at line 26 of file qqmldirdata.cpp.

References QMultiHash< Key, T >::insert().

+ Here is the call graph for this function:

Friends And Related Symbol Documentation

◆ QQmlTypeLoader

friend class QQmlTypeLoader
friend

Definition at line 25 of file qqmldirdata_p.h.

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