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
Assets::Downloader::AssetDownloader Class Reference

#include <assetdownloader.h>

+ Inheritance diagram for Assets::Downloader::AssetDownloader:
+ Collaboration diagram for Assets::Downloader::AssetDownloader:

Public Slots

void start ()
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void started ()
 
void finished (bool success)
 
void progressChanged (int progressValue, int progressMaximum, const QString &progressText)
 
void localDownloadDirChanged (const QUrl &url)
 
void downloadBaseChanged (const QUrl &)
 
void preferredLocalDownloadDirChanged (const QUrl &url)
 
void offlineAssetsFilePathChanged (const QUrl &)
 
void jsonFileNameChanged (const QString &)
 
void zipFileNameChanged (const QString &)
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 AssetDownloader (QObject *parent=nullptr)
 
 ~AssetDownloader ()
 
QUrl downloadBase () const
 
void setDownloadBase (const QUrl &downloadBase)
 
QUrl preferredLocalDownloadDir () const
 
void setPreferredLocalDownloadDir (const QUrl &localDir)
 
QUrl offlineAssetsFilePath () const
 
void setOfflineAssetsFilePath (const QUrl &offlineAssetsFilePath)
 
QString jsonFileName () const
 
void setJsonFileName (const QString &jsonFileName)
 
QString zipFileName () const
 
void setZipFileName (const QString &zipFileName)
 
QUrl localDownloadDir () const
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Properties

QUrl downloadBase
 
QUrl preferredLocalDownloadDir
 
QUrl offlineAssetsFilePath
 
QString jsonFileName
 
QString zipFileName
 
QUrl localDownloadDir
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 

Detailed Description

Definition at line 29 of file assetdownloader.h.

Constructor & Destructor Documentation

◆ AssetDownloader()

Assets::Downloader::AssetDownloader::AssetDownloader ( QObject * parent = nullptr)

Definition at line 176 of file assetdownloader.cpp.

◆ ~AssetDownloader()

Assets::Downloader::AssetDownloader::~AssetDownloader ( )
default

Member Function Documentation

◆ downloadBase()

QUrl Assets::Downloader::AssetDownloader::downloadBase ( ) const

Definition at line 183 of file assetdownloader.cpp.

◆ downloadBaseChanged

void Assets::Downloader::AssetDownloader::downloadBaseChanged ( const QUrl & )
signal

Referenced by setDownloadBase().

+ Here is the caller graph for this function:

◆ finished

void Assets::Downloader::AssetDownloader::finished ( bool success)
signal

Referenced by start().

+ Here is the caller graph for this function:

◆ jsonFileName()

QString Assets::Downloader::AssetDownloader::jsonFileName ( ) const

Definition at line 226 of file assetdownloader.cpp.

◆ jsonFileNameChanged

void Assets::Downloader::AssetDownloader::jsonFileNameChanged ( const QString & )
signal

Referenced by setJsonFileName().

+ Here is the caller graph for this function:

◆ localDownloadDir()

QUrl Assets::Downloader::AssetDownloader::localDownloadDir ( ) const

Definition at line 252 of file assetdownloader.cpp.

References QUrl::fromLocalFile().

+ Here is the call graph for this function:

◆ localDownloadDirChanged

void Assets::Downloader::AssetDownloader::localDownloadDirChanged ( const QUrl & url)
signal

Referenced by Assets::Downloader::AssetDownloaderPrivate::setLocalDownloadDir().

+ Here is the caller graph for this function:

◆ offlineAssetsFilePath()

QUrl Assets::Downloader::AssetDownloader::offlineAssetsFilePath ( ) const

Definition at line 213 of file assetdownloader.cpp.

◆ offlineAssetsFilePathChanged

void Assets::Downloader::AssetDownloader::offlineAssetsFilePathChanged ( const QUrl & )
signal

Referenced by setOfflineAssetsFilePath().

+ Here is the caller graph for this function:

◆ preferredLocalDownloadDir()

QUrl Assets::Downloader::AssetDownloader::preferredLocalDownloadDir ( ) const

Definition at line 196 of file assetdownloader.cpp.

References QUrl::fromLocalFile().

+ Here is the call graph for this function:

◆ preferredLocalDownloadDirChanged

void Assets::Downloader::AssetDownloader::preferredLocalDownloadDirChanged ( const QUrl & url)
signal

Referenced by setPreferredLocalDownloadDir().

+ Here is the caller graph for this function:

◆ progressChanged

void Assets::Downloader::AssetDownloader::progressChanged ( int progressValue,
int progressMaximum,
const QString & progressText )
signal

Referenced by Assets::Downloader::AssetDownloaderPrivate::setProgress().

+ Here is the caller graph for this function:

◆ setDownloadBase()

void Assets::Downloader::AssetDownloader::setDownloadBase ( const QUrl & downloadBase)

Definition at line 188 of file assetdownloader.cpp.

References downloadBase, downloadBaseChanged(), and emit.

+ Here is the call graph for this function:

◆ setJsonFileName()

void Assets::Downloader::AssetDownloader::setJsonFileName ( const QString & jsonFileName)

Definition at line 231 of file assetdownloader.cpp.

References emit, jsonFileName, and jsonFileNameChanged().

+ Here is the call graph for this function:

◆ setOfflineAssetsFilePath()

void Assets::Downloader::AssetDownloader::setOfflineAssetsFilePath ( const QUrl & offlineAssetsFilePath)

Definition at line 218 of file assetdownloader.cpp.

References emit, offlineAssetsFilePath, and offlineAssetsFilePathChanged().

+ Here is the call graph for this function:

◆ setPreferredLocalDownloadDir()

void Assets::Downloader::AssetDownloader::setPreferredLocalDownloadDir ( const QUrl & localDir)

Definition at line 201 of file assetdownloader.cpp.

References emit, Assets::Downloader::pathFromUrl(), preferredLocalDownloadDir, preferredLocalDownloadDirChanged(), and qWarning.

+ Here is the call graph for this function:

◆ setZipFileName()

void Assets::Downloader::AssetDownloader::setZipFileName ( const QString & zipFileName)

Definition at line 244 of file assetdownloader.cpp.

References emit, zipFileName, and zipFileNameChanged().

+ Here is the call graph for this function:

◆ start

◆ started

void Assets::Downloader::AssetDownloader::started ( )
signal

Referenced by start().

+ Here is the caller graph for this function:

◆ zipFileName()

QString Assets::Downloader::AssetDownloader::zipFileName ( ) const

Definition at line 239 of file assetdownloader.cpp.

◆ zipFileNameChanged

void Assets::Downloader::AssetDownloader::zipFileNameChanged ( const QString & )
signal

Referenced by setZipFileName().

+ Here is the caller graph for this function:

Property Documentation

◆ downloadBase

QUrl Assets::Downloader::AssetDownloader::downloadBase
readwrite

Definition at line 33 of file assetdownloader.h.

Referenced by setDownloadBase().

◆ jsonFileName

QString Assets::Downloader::AssetDownloader::jsonFileName
readwrite

Definition at line 51 of file assetdownloader.h.

Referenced by setJsonFileName().

◆ localDownloadDir

QUrl Assets::Downloader::AssetDownloader::localDownloadDir
read

Definition at line 63 of file assetdownloader.h.

◆ offlineAssetsFilePath

QUrl Assets::Downloader::AssetDownloader::offlineAssetsFilePath
readwrite

Definition at line 45 of file assetdownloader.h.

Referenced by setOfflineAssetsFilePath().

◆ preferredLocalDownloadDir

QUrl Assets::Downloader::AssetDownloader::preferredLocalDownloadDir
readwrite

Definition at line 39 of file assetdownloader.h.

Referenced by setPreferredLocalDownloadDir().

◆ zipFileName

QString Assets::Downloader::AssetDownloader::zipFileName
readwrite

Definition at line 57 of file assetdownloader.h.

Referenced by setZipFileName().


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