API reference - Class QResource

_const_cast

Signature: [const] QResource 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.

absoluteFilePath

Signature: [const] string absoluteFilePath

Description: Method QString QResource::absoluteFilePath()

addSearchPath

Signature: [static] void addSearchPath (string path)

Description: Static method void QResource::addSearchPath(const QString &path)

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

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

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.

data

Signature: [const] string data

Description: Method const unsigned char *QResource::data()

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

Use of this method is deprecated. Use _destroyed? instead

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.

fileName

Signature: [const] string fileName

Description: Method QString QResource::fileName()

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

fileName=

Signature: void fileName= (string file)

Description: Method void QResource::setFileName(const QString &file)

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

isCompressed?

Signature: [const] bool isCompressed?

Description: Method bool QResource::isCompressed()

isValid?

Signature: [const] bool isValid?

Description: Method bool QResource::isValid()

is_const_object?

Signature: [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

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

locale

Signature: [const] QLocale locale

Description: Method QLocale QResource::locale()

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

locale=

Signature: void locale= (const QLocale locale)

Description: Method void QResource::setLocale(const QLocale &locale)

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

new

Signature: [static] new QResource new (string file = QString(), const QLocale locale = QLocale())

Description: Constructor QResource::QResource(const QString &file, const QLocale &locale)

This method creates an object of class QResource.

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

registerResource_data

Signature: [static] bool registerResource_data (string rccData, string resourceRoot = QString())

Description: Static method bool QResource::registerResource(const unsigned char *rccData, const QString &resourceRoot)

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

registerResource_file

Signature: [static] bool registerResource_file (string rccFilename, string resourceRoot = QString())

Description: Static method bool QResource::registerResource(const QString &rccFilename, const QString &resourceRoot)

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

searchPaths

Signature: [static] string[] searchPaths

Description: Static method QStringList QResource::searchPaths()

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

setFileName

Signature: void setFileName (string file)

Description: Method void QResource::setFileName(const QString &file)

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

setLocale

Signature: void setLocale (const QLocale locale)

Description: Method void QResource::setLocale(const QLocale &locale)

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

size

Signature: [const] long long size

Description: Method qint64 QResource::size()

Python specific notes:
This method is also available as 'len(object)'.

unregisterResource_data

Signature: [static] bool unregisterResource_data (string rccData, string resourceRoot = QString())

Description: Static method bool QResource::unregisterResource(const unsigned char *rccData, const QString &resourceRoot)

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

unregisterResource_file

Signature: [static] bool unregisterResource_file (string rccFilename, string resourceRoot = QString())

Description: Static method bool QResource::unregisterResource(const QString &rccFilename, const QString &resourceRoot)

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