API reference - Class QFileIconProvider

Notation used in Ruby API documentation

Description: Binding of QFileIconProvider

Class hierarchy: QFileIconProvider

Sub-classes: IconType

Public constructors

new QFileIconProvidernewConstructor QFileIconProvider::QFileIconProvider()

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.
[virtual,const]QIconicon(const QFileIconProvider_IconType type)Virtual method QIcon QFileIconProvider::icon(QFileIconProvider::IconType type)
[virtual,const]QIconicon(const QFileInfo info)Virtual method QIcon QFileIconProvider::icon(const QFileInfo &info)
[virtual,const]stringtype(const QFileInfo info)Virtual method QString QFileIconProvider::type(const QFileInfo &info)

Public static methods and constants

[static,const]new QFileIconProvider_IconType ptrComputerEnum constant QFileIconProvider::Computer
[static,const]new QFileIconProvider_IconType ptrDesktopEnum constant QFileIconProvider::Desktop
[static,const]new QFileIconProvider_IconType ptrDriveEnum constant QFileIconProvider::Drive
[static,const]new QFileIconProvider_IconType ptrFileEnum constant QFileIconProvider::File
[static,const]new QFileIconProvider_IconType ptrFolderEnum constant QFileIconProvider::Folder
[static,const]new QFileIconProvider_IconType ptrNetworkEnum constant QFileIconProvider::Network
[static,const]new QFileIconProvider_IconType ptrTrashcanEnum constant QFileIconProvider::Trashcan

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

[static,const] new QFileIconProvider_IconType ptr Computer

Description: Enum constant QFileIconProvider::Computer

[static,const] new QFileIconProvider_IconType ptr Desktop

Description: Enum constant QFileIconProvider::Desktop

[static,const] new QFileIconProvider_IconType ptr Drive

Description: Enum constant QFileIconProvider::Drive

[static,const] new QFileIconProvider_IconType ptr File

Description: Enum constant QFileIconProvider::File

[static,const] new QFileIconProvider_IconType ptr Folder

Description: Enum constant QFileIconProvider::Folder

[static,const] new QFileIconProvider_IconType ptr Network

Description: Enum constant QFileIconProvider::Network

[static,const] new QFileIconProvider_IconType ptr Trashcan

Description: Enum constant QFileIconProvider::Trashcan

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.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

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

[virtual,const] QIcon icon(const QFileInfo info)

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

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

[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

[virtual,const] string type(const QFileInfo info)

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

This method can be reimplemented in a derived class.