API reference - Class QFileIconProvider

Computer

Signature: [static,const] QFileIconProvider_IconType Computer

Description: Enum constant QFileIconProvider::Computer

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

Desktop

Signature: [static,const] QFileIconProvider_IconType Desktop

Description: Enum constant QFileIconProvider::Desktop

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

DontUseCustomDirectoryIcons

Signature: [static,const] QFileIconProvider_Option DontUseCustomDirectoryIcons

Description: Enum constant QFileIconProvider::DontUseCustomDirectoryIcons

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

Drive

Signature: [static,const] QFileIconProvider_IconType Drive

Description: Enum constant QFileIconProvider::Drive

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

File

Signature: [static,const] QFileIconProvider_IconType File

Description: Enum constant QFileIconProvider::File

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

Folder

Signature: [static,const] QFileIconProvider_IconType Folder

Description: Enum constant QFileIconProvider::Folder

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

Network

Signature: [static,const] QFileIconProvider_IconType Network

Description: Enum constant QFileIconProvider::Network

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

Trashcan

Signature: [static,const] QFileIconProvider_IconType Trashcan

Description: Enum constant QFileIconProvider::Trashcan

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

_const_cast

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

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.

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.

icon

(1) Signature: [const] QIcon icon (const QFileIconProvider_IconType type)

Description: Virtual method QIcon QFileIconProvider::icon(QFileIconProvider::IconType type)

This method can be reimplemented in a derived class.

(2) Signature: [const] QIcon icon (const QFileInfo info)

Description: Virtual method QIcon QFileIconProvider::icon(const QFileInfo &info)

This method can be reimplemented in a derived class.

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.

new

Signature: [static] new QFileIconProvider new

Description: Constructor QFileIconProvider::QFileIconProvider()

This method creates an object of class QFileIconProvider.

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

options

Signature: [const] QFileIconProvider_QFlags_Option options

Description: Method QFlags<QFileIconProvider::Option> QFileIconProvider::options()

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

options=

Signature: void options= (QFileIconProvider_QFlags_Option options)

Description: Method void QFileIconProvider::setOptions(QFlags<QFileIconProvider::Option> options)

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

setOptions

Signature: void setOptions (QFileIconProvider_QFlags_Option options)

Description: Method void QFileIconProvider::setOptions(QFlags<QFileIconProvider::Option> options)

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

type

Signature: [const] string type (const QFileInfo info)

Description: Virtual method QString QFileIconProvider::type(const QFileInfo &info)

This method can be reimplemented in a derived class.