API reference - Class Qt::ItemDataRole

!=

(1) Signature: [const] bool != (const Qt_ItemDataRole other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const Qt_ItemDataRole other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const Qt_ItemDataRole other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

AccessibleDescriptionRole

Signature: [static,const] Qt_ItemDataRole AccessibleDescriptionRole

Description: Enum constant Qt::AccessibleDescriptionRole

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

AccessibleTextRole

Signature: [static,const] Qt_ItemDataRole AccessibleTextRole

Description: Enum constant Qt::AccessibleTextRole

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

BackgroundColorRole

Signature: [static,const] Qt_ItemDataRole BackgroundColorRole

Description: Enum constant Qt::BackgroundColorRole

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

BackgroundRole

Signature: [static,const] Qt_ItemDataRole BackgroundRole

Description: Enum constant Qt::BackgroundRole

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

CheckStateRole

Signature: [static,const] Qt_ItemDataRole CheckStateRole

Description: Enum constant Qt::CheckStateRole

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

DecorationPropertyRole

Signature: [static,const] Qt_ItemDataRole DecorationPropertyRole

Description: Enum constant Qt::DecorationPropertyRole

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

DecorationRole

Signature: [static,const] Qt_ItemDataRole DecorationRole

Description: Enum constant Qt::DecorationRole

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

DisplayPropertyRole

Signature: [static,const] Qt_ItemDataRole DisplayPropertyRole

Description: Enum constant Qt::DisplayPropertyRole

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

DisplayRole

Signature: [static,const] Qt_ItemDataRole DisplayRole

Description: Enum constant Qt::DisplayRole

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

EditRole

Signature: [static,const] Qt_ItemDataRole EditRole

Description: Enum constant Qt::EditRole

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

FontRole

Signature: [static,const] Qt_ItemDataRole FontRole

Description: Enum constant Qt::FontRole

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

ForegroundRole

Signature: [static,const] Qt_ItemDataRole ForegroundRole

Description: Enum constant Qt::ForegroundRole

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

InitialSortOrderRole

Signature: [static,const] Qt_ItemDataRole InitialSortOrderRole

Description: Enum constant Qt::InitialSortOrderRole

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

SizeHintRole

Signature: [static,const] Qt_ItemDataRole SizeHintRole

Description: Enum constant Qt::SizeHintRole

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

StatusTipPropertyRole

Signature: [static,const] Qt_ItemDataRole StatusTipPropertyRole

Description: Enum constant Qt::StatusTipPropertyRole

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

StatusTipRole

Signature: [static,const] Qt_ItemDataRole StatusTipRole

Description: Enum constant Qt::StatusTipRole

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

TextAlignmentRole

Signature: [static,const] Qt_ItemDataRole TextAlignmentRole

Description: Enum constant Qt::TextAlignmentRole

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

TextColorRole

Signature: [static,const] Qt_ItemDataRole TextColorRole

Description: Enum constant Qt::TextColorRole

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

ToolTipPropertyRole

Signature: [static,const] Qt_ItemDataRole ToolTipPropertyRole

Description: Enum constant Qt::ToolTipPropertyRole

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

ToolTipRole

Signature: [static,const] Qt_ItemDataRole ToolTipRole

Description: Enum constant Qt::ToolTipRole

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

UserRole

Signature: [static,const] Qt_ItemDataRole UserRole

Description: Enum constant Qt::UserRole

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

WhatsThisPropertyRole

Signature: [static,const] Qt_ItemDataRole WhatsThisPropertyRole

Description: Enum constant Qt::WhatsThisPropertyRole

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

WhatsThisRole

Signature: [static,const] Qt_ItemDataRole WhatsThisRole

Description: Enum constant Qt::WhatsThisRole

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

_const_cast

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

assign

Signature: void assign (const Qt_ItemDataRole other)

Description: Assigns another object to self

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.

dup

Signature: [const] new Qt_ItemDataRole ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

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

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

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

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

(1) Signature: [static] new Qt_ItemDataRole ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new Qt_ItemDataRole ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

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

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

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

|

(1) Signature: [const] Qt_QFlags_ItemDataRole | (const Qt_ItemDataRole other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] Qt_QFlags_ItemDataRole | (const Qt_QFlags_ItemDataRole other)

Description: Combines the flag and the flag set