API reference - Class QTreeWidgetItemIterator_IteratorFlag

Notation used in Ruby API documentation

Module: QtWidgets

Description: This class represents the QTreeWidgetItemIterator::IteratorFlag enum

This class is equivalent to the class QTreeWidgetItemIterator::IteratorFlag

Public constructors

new QTreeWidgetItemIterator_IteratorFlag ptrnew(int i)Creates an enum from an integer value
new QTreeWidgetItemIterator_IteratorFlag ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QTreeWidgetItemIterator_IteratorFlag other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QTreeWidgetItemIterator_IteratorFlag other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QTreeWidgetItemIterator_IteratorFlag other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QTreeWidgetItemIterator_IteratorFlag ptr_const_castReturns a non-const reference to self.
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.
voidassign(const QTreeWidgetItemIterator_IteratorFlag other)Assigns another object to self
[const]new QTreeWidgetItemIterator_IteratorFlag ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QTreeWidgetItemIterator_QFlags_IteratorFlag|(const QTreeWidgetItemIterator_IteratorFlag other)Creates a flag set by combining the two flags
[const]QTreeWidgetItemIterator_QFlags_IteratorFlag|(const QTreeWidgetItemIterator_QFlags_IteratorFlag other)Combines the flag and the flag set

Public static methods and constants

[static,const]QTreeWidgetItemIterator_IteratorFlagAllEnum constant QTreeWidgetItemIterator::All
[static,const]QTreeWidgetItemIterator_IteratorFlagCheckedEnum constant QTreeWidgetItemIterator::Checked
[static,const]QTreeWidgetItemIterator_IteratorFlagDisabledEnum constant QTreeWidgetItemIterator::Disabled
[static,const]QTreeWidgetItemIterator_IteratorFlagDragDisabledEnum constant QTreeWidgetItemIterator::DragDisabled
[static,const]QTreeWidgetItemIterator_IteratorFlagDragEnabledEnum constant QTreeWidgetItemIterator::DragEnabled
[static,const]QTreeWidgetItemIterator_IteratorFlagDropDisabledEnum constant QTreeWidgetItemIterator::DropDisabled
[static,const]QTreeWidgetItemIterator_IteratorFlagDropEnabledEnum constant QTreeWidgetItemIterator::DropEnabled
[static,const]QTreeWidgetItemIterator_IteratorFlagEditableEnum constant QTreeWidgetItemIterator::Editable
[static,const]QTreeWidgetItemIterator_IteratorFlagEnabledEnum constant QTreeWidgetItemIterator::Enabled
[static,const]QTreeWidgetItemIterator_IteratorFlagHasChildrenEnum constant QTreeWidgetItemIterator::HasChildren
[static,const]QTreeWidgetItemIterator_IteratorFlagHiddenEnum constant QTreeWidgetItemIterator::Hidden
[static,const]QTreeWidgetItemIterator_IteratorFlagNoChildrenEnum constant QTreeWidgetItemIterator::NoChildren
[static,const]QTreeWidgetItemIterator_IteratorFlagNotCheckedEnum constant QTreeWidgetItemIterator::NotChecked
[static,const]QTreeWidgetItemIterator_IteratorFlagNotEditableEnum constant QTreeWidgetItemIterator::NotEditable
[static,const]QTreeWidgetItemIterator_IteratorFlagNotHiddenEnum constant QTreeWidgetItemIterator::NotHidden
[static,const]QTreeWidgetItemIterator_IteratorFlagNotSelectableEnum constant QTreeWidgetItemIterator::NotSelectable
[static,const]QTreeWidgetItemIterator_IteratorFlagSelectableEnum constant QTreeWidgetItemIterator::Selectable
[static,const]QTreeWidgetItemIterator_IteratorFlagSelectedEnum constant QTreeWidgetItemIterator::Selected
[static,const]QTreeWidgetItemIterator_IteratorFlagUnselectedEnum constant QTreeWidgetItemIterator::Unselected
[static,const]QTreeWidgetItemIterator_IteratorFlagUserFlagEnum constant QTreeWidgetItemIterator::UserFlag

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

!=

(1) Signature: [const] bool != (const QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

All

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag All

Description: Enum constant QTreeWidgetItemIterator::All

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

Checked

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Checked

Description: Enum constant QTreeWidgetItemIterator::Checked

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

Disabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Disabled

Description: Enum constant QTreeWidgetItemIterator::Disabled

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

DragDisabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag DragDisabled

Description: Enum constant QTreeWidgetItemIterator::DragDisabled

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

DragEnabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag DragEnabled

Description: Enum constant QTreeWidgetItemIterator::DragEnabled

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

DropDisabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag DropDisabled

Description: Enum constant QTreeWidgetItemIterator::DropDisabled

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

DropEnabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag DropEnabled

Description: Enum constant QTreeWidgetItemIterator::DropEnabled

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

Editable

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Editable

Description: Enum constant QTreeWidgetItemIterator::Editable

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

Enabled

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Enabled

Description: Enum constant QTreeWidgetItemIterator::Enabled

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

HasChildren

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag HasChildren

Description: Enum constant QTreeWidgetItemIterator::HasChildren

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

Hidden

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Hidden

Description: Enum constant QTreeWidgetItemIterator::Hidden

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

NoChildren

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag NoChildren

Description: Enum constant QTreeWidgetItemIterator::NoChildren

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

NotChecked

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag NotChecked

Description: Enum constant QTreeWidgetItemIterator::NotChecked

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

NotEditable

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag NotEditable

Description: Enum constant QTreeWidgetItemIterator::NotEditable

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

NotHidden

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag NotHidden

Description: Enum constant QTreeWidgetItemIterator::NotHidden

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

NotSelectable

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag NotSelectable

Description: Enum constant QTreeWidgetItemIterator::NotSelectable

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

Selectable

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Selectable

Description: Enum constant QTreeWidgetItemIterator::Selectable

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

Selected

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Selected

Description: Enum constant QTreeWidgetItemIterator::Selected

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

Unselected

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag Unselected

Description: Enum constant QTreeWidgetItemIterator::Unselected

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

UserFlag

Signature: [static,const] QTreeWidgetItemIterator_IteratorFlag UserFlag

Description: Enum constant QTreeWidgetItemIterator::UserFlag

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

_const_cast

Signature: [const] QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag 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 QTreeWidgetItemIterator_IteratorFlag 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] QTreeWidgetItemIterator_QFlags_IteratorFlag | (const QTreeWidgetItemIterator_IteratorFlag other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set