API reference - Class QNetworkDiskCache

Notation used in Ruby API documentation

Description: Binding of QNetworkDiskCache

Class hierarchy: QNetworkDiskCache » QAbstractNetworkCache » QObject

Public constructors

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

Public methods

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)
[virtual,const]long longcacheSizeVirtual method qint64 QNetworkDiskCache::cacheSize()
[virtual]voidclearVirtual method void QNetworkDiskCache::clear()
[virtual]QIODevice ptrdata(const QUrl url)Virtual method QIODevice *QNetworkDiskCache::data(const QUrl &url)
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QNetworkDiskCache::destroyed(QObject *)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QNetworkDiskCache::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QNetworkDiskCache::eventFilter(QObject *, QEvent *)
[const]QNetworkCacheMetaDatafileMetaData(string fileName)Method QNetworkCacheMetaData QNetworkDiskCache::fileMetaData(const QString &fileName)
[virtual]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)
[virtual]QNetworkCacheMetaDatametaData(const QUrl url)Virtual method QNetworkCacheMetaData QNetworkDiskCache::metaData(const QUrl &url)
[virtual]QIODevice ptrprepare(const QNetworkCacheMetaData metaData)Virtual method QIODevice *QNetworkDiskCache::prepare(const QNetworkCacheMetaData &metaData)
[virtual]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)
[virtual]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 = 0)
Static method QString QNetworkDiskCache::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QNetworkDiskCache::tr(const char *s, const char *c, int n)
stringtrUtf8(string s,
string c = 0)
Static method QString QNetworkDiskCache::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QNetworkDiskCache::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QNetworkDiskCache::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QNetworkDiskCache::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QNetworkDiskCache::disconnectNotify(const char *signal)
[virtual]long longexpireVirtual method qint64 QNetworkDiskCache::expire()
[const]intreceivers(string signal)Method int QNetworkDiskCache::receivers(const char *signal)
[const]QObject ptrsenderMethod QObject *QNetworkDiskCache::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QNetworkDiskCache::timerEvent(QTimerEvent *)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

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.

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.

[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.

[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.

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.

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.

[const] string cacheDirectory

Description: Method QString QNetworkDiskCache::cacheDirectory()

Python specific notes:

The object exposes a readable attribute 'cacheDirectory'. This is the getter.

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.

[virtual,const] long long cacheSize

Description: Virtual method qint64 QNetworkDiskCache::cacheSize()

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] void clear

Description: Virtual method void QNetworkDiskCache::clear()

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] QIODevice ptr data(const QUrl url)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QNetworkDiskCache::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

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

This method can be reimplemented in a derived class.

[virtual] long long expire

Description: Virtual method qint64 QNetworkDiskCache::expire()

This method can be reimplemented in a derived class.

[const] QNetworkCacheMetaData fileMetaData(string fileName)

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

[virtual] void insert(QIODevice ptr device)

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

This method can be reimplemented in a derived class.

[const] bool is_const_object?

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

Use of this method is deprecated. Use _is_const_object? instead

[const] long long maximumCacheSize

Description: Method qint64 QNetworkDiskCache::maximumCacheSize()

Python specific notes:

The object exposes a readable attribute 'maximumCacheSize'. This is the getter.

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.

[virtual] QNetworkCacheMetaData metaData(const QUrl url)

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

This method can be reimplemented in a derived class.

[static] new QNetworkDiskCache new(QObject ptr parent = 0)

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

[virtual] QIODevice ptr prepare(const QNetworkCacheMetaData metaData)

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

This method can be reimplemented in a derived class.

[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.

[virtual] bool remove(const QUrl url)

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

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject *QNetworkDiskCache::sender()

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

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.

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.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

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

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

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

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

[static] string trUtf8(string s,string c,int n)

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.

[virtual] void updateMetaData(const QNetworkCacheMetaData metaData)

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

This method can be reimplemented in a derived class.