API reference - Class QNetworkDiskCache

Notation used in Ruby API documentation

Module: QtNetwork

Description: Binding of QNetworkDiskCache

Class hierarchy: QNetworkDiskCache » QAbstractNetworkCache » QObject

Public constructors

new QNetworkDiskCachenew(QObject ptr parent = nullptr)Constructor QNetworkDiskCache::QNetworkDiskCache(QObject *parent)

Public methods

[const]QNetworkDiskCache ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
[const]stringcacheDirectoryMethod QString QNetworkDiskCache::cacheDirectory()
voidcacheDirectory=(string cacheDir)Method void QNetworkDiskCache::setCacheDirectory(const QString &cacheDir)
[const]long longcacheSizeVirtual method qint64 QNetworkDiskCache::cacheSize()
voidclearVirtual method void QNetworkDiskCache::clear()
QIODevice ptrdata(const QUrl url)Virtual method QIODevice *QNetworkDiskCache::data(const QUrl &url)
[signal]voiddestroyed(QObject ptr arg1)Signal declaration for QNetworkDiskCache::destroyed(QObject *)
voidemit_destroyed(QObject ptr arg1 = nullptr)Emitter for signal void QNetworkDiskCache::destroyed(QObject *)
voidemit_objectNameChanged(string objectName)Emitter for signal void QNetworkDiskCache::objectNameChanged(const QString &objectName)
boolevent(QEvent ptr event)Virtual method bool QNetworkDiskCache::event(QEvent *event)
booleventFilter(QObject ptr watched,
QEvent ptr event)
Virtual method bool QNetworkDiskCache::eventFilter(QObject *watched, QEvent *event)
[const]QNetworkCacheMetaDatafileMetaData(string fileName)Method QNetworkCacheMetaData QNetworkDiskCache::fileMetaData(const QString &fileName)
voidinsert(QIODevice ptr device)Virtual method void QNetworkDiskCache::insert(QIODevice *device)
[const]long longmaximumCacheSizeMethod qint64 QNetworkDiskCache::maximumCacheSize()
voidmaximumCacheSize=(long long size)Method void QNetworkDiskCache::setMaximumCacheSize(qint64 size)
QNetworkCacheMetaDatametaData(const QUrl url)Virtual method QNetworkCacheMetaData QNetworkDiskCache::metaData(const QUrl &url)
[signal]voidobjectNameChanged(string objectName)Signal declaration for QNetworkDiskCache::objectNameChanged(const QString &objectName)
QIODevice ptrprepare(const QNetworkCacheMetaData metaData)Virtual method QIODevice *QNetworkDiskCache::prepare(const QNetworkCacheMetaData &metaData)
boolremove(const QUrl url)Virtual method bool QNetworkDiskCache::remove(const QUrl &url)
voidsetCacheDirectory(string cacheDir)Method void QNetworkDiskCache::setCacheDirectory(const QString &cacheDir)
voidsetMaximumCacheSize(long long size)Method void QNetworkDiskCache::setMaximumCacheSize(qint64 size)
voidupdateMetaData(const QNetworkCacheMetaData metaData)Virtual method void QNetworkDiskCache::updateMetaData(const QNetworkCacheMetaData &metaData)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s,
string c = nullptr,
int n = -1)
Static method QString QNetworkDiskCache::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = nullptr,
int n = -1)
Static method QString QNetworkDiskCache::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

voidchildEvent(QChildEvent ptr event)Virtual method void QNetworkDiskCache::childEvent(QChildEvent *event)
voidcustomEvent(QEvent ptr event)Virtual method void QNetworkDiskCache::customEvent(QEvent *event)
voiddisconnectNotify(const QMetaMethod signal)Virtual method void QNetworkDiskCache::disconnectNotify(const QMetaMethod &signal)
long longexpireVirtual method qint64 QNetworkDiskCache::expire()
[const]boolisSignalConnected(const QMetaMethod signal)Method bool QNetworkDiskCache::isSignalConnected(const QMetaMethod &signal)
[const]intreceivers(string signal)Method int QNetworkDiskCache::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QNetworkDiskCache::sender()
[const]intsenderSignalIndexMethod int QNetworkDiskCache::senderSignalIndex()
voidtimerEvent(QTimerEvent ptr event)Virtual method void QNetworkDiskCache::timerEvent(QTimerEvent *event)

Detailed description

_const_cast

Signature: [const] QNetworkDiskCache ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

cacheDirectory

Signature: [const] string cacheDirectory

Description: Method QString QNetworkDiskCache::cacheDirectory()

Python specific notes:
The object exposes a readable attribute 'cacheDirectory'. This is the getter.

cacheDirectory=

Signature: void cacheDirectory= (string cacheDir)

Description: Method void QNetworkDiskCache::setCacheDirectory(const QString &cacheDir)

Python specific notes:
The object exposes a writable attribute 'cacheDirectory'. This is the setter.

cacheSize

Signature: [const] long long cacheSize

Description: Virtual method qint64 QNetworkDiskCache::cacheSize()

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QNetworkDiskCache::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

clear

Signature: void clear

Description: Virtual method void QNetworkDiskCache::clear()

This method can be reimplemented in a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QNetworkDiskCache::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

data

Signature: QIODevice ptr data (const QUrl url)

Description: Virtual method QIODevice *QNetworkDiskCache::data(const QUrl &url)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QNetworkDiskCache::destroyed(QObject *)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QNetworkDiskCache::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QNetworkDiskCache::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QNetworkDiskCache::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QNetworkDiskCache::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QNetworkDiskCache::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

expire

Signature: long long expire

Description: Virtual method qint64 QNetworkDiskCache::expire()

This method can be reimplemented in a derived class.

fileMetaData

Signature: [const] QNetworkCacheMetaData fileMetaData (string fileName)

Description: Method QNetworkCacheMetaData QNetworkDiskCache::fileMetaData(const QString &fileName)

insert

Signature: void insert (QIODevice ptr device)

Description: Virtual method void QNetworkDiskCache::insert(QIODevice *device)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QNetworkDiskCache::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

maximumCacheSize

Signature: [const] long long maximumCacheSize

Description: Method qint64 QNetworkDiskCache::maximumCacheSize()

Python specific notes:
The object exposes a readable attribute 'maximumCacheSize'. This is the getter.

maximumCacheSize=

Signature: void maximumCacheSize= (long long size)

Description: Method void QNetworkDiskCache::setMaximumCacheSize(qint64 size)

Python specific notes:
The object exposes a writable attribute 'maximumCacheSize'. This is the setter.

metaData

Signature: QNetworkCacheMetaData metaData (const QUrl url)

Description: Virtual method QNetworkCacheMetaData QNetworkDiskCache::metaData(const QUrl &url)

This method can be reimplemented in a derived class.

new

Signature: [static] new QNetworkDiskCache new (QObject ptr parent = nullptr)

Description: Constructor QNetworkDiskCache::QNetworkDiskCache(QObject *parent)

This method creates an object of class QNetworkDiskCache.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QNetworkDiskCache::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

prepare

Signature: QIODevice ptr prepare (const QNetworkCacheMetaData metaData)

Description: Virtual method QIODevice *QNetworkDiskCache::prepare(const QNetworkCacheMetaData &metaData)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QNetworkDiskCache::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

remove

Signature: bool remove (const QUrl url)

Description: Virtual method bool QNetworkDiskCache::remove(const QUrl &url)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QNetworkDiskCache::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QNetworkDiskCache::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setCacheDirectory

Signature: void setCacheDirectory (string cacheDir)

Description: Method void QNetworkDiskCache::setCacheDirectory(const QString &cacheDir)

Python specific notes:
The object exposes a writable attribute 'cacheDirectory'. This is the setter.

setMaximumCacheSize

Signature: void setMaximumCacheSize (long long size)

Description: Method void QNetworkDiskCache::setMaximumCacheSize(qint64 size)

Python specific notes:
The object exposes a writable attribute 'maximumCacheSize'. This is the setter.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QNetworkDiskCache::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

Description: Static method QString QNetworkDiskCache::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

Description: Static method QString QNetworkDiskCache::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

updateMetaData

Signature: void updateMetaData (const QNetworkCacheMetaData metaData)

Description: Virtual method void QNetworkDiskCache::updateMetaData(const QNetworkCacheMetaData &metaData)

This method can be reimplemented in a derived class.