API reference - Class QWizard_WizardOption

Notation used in Ruby API documentation

Module: QtWidgets

Description: This class represents the QWizard::WizardOption enum

This class is equivalent to the class QWizard::WizardOption

Public constructors

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

Public methods

[const]bool!=(const QWizard_WizardOption other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QWizard_WizardOption 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 QWizard_WizardOption other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
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 QWizard_WizardOption other)Assigns another object to self
[const]new QWizard_WizardOption ptrdupCreates a copy of self
[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]QWizard_QFlags_WizardOption|(const QWizard_WizardOption other)Creates a flag set by combining the two flags
[const]QWizard_QFlags_WizardOption|(const QWizard_QFlags_WizardOption other)Combines the flag and the flag set

Public static methods and constants

[static,const]QWizard_WizardOptionCancelButtonOnLeftEnum constant QWizard::CancelButtonOnLeft
[static,const]QWizard_WizardOptionDisabledBackButtonOnLastPageEnum constant QWizard::DisabledBackButtonOnLastPage
[static,const]QWizard_WizardOptionExtendedWatermarkPixmapEnum constant QWizard::ExtendedWatermarkPixmap
[static,const]QWizard_WizardOptionHaveCustomButton1Enum constant QWizard::HaveCustomButton1
[static,const]QWizard_WizardOptionHaveCustomButton2Enum constant QWizard::HaveCustomButton2
[static,const]QWizard_WizardOptionHaveCustomButton3Enum constant QWizard::HaveCustomButton3
[static,const]QWizard_WizardOptionHaveFinishButtonOnEarlyPagesEnum constant QWizard::HaveFinishButtonOnEarlyPages
[static,const]QWizard_WizardOptionHaveHelpButtonEnum constant QWizard::HaveHelpButton
[static,const]QWizard_WizardOptionHaveNextButtonOnLastPageEnum constant QWizard::HaveNextButtonOnLastPage
[static,const]QWizard_WizardOptionHelpButtonOnRightEnum constant QWizard::HelpButtonOnRight
[static,const]QWizard_WizardOptionIgnoreSubTitlesEnum constant QWizard::IgnoreSubTitles
[static,const]QWizard_WizardOptionIndependentPagesEnum constant QWizard::IndependentPages
[static,const]QWizard_WizardOptionNoBackButtonOnLastPageEnum constant QWizard::NoBackButtonOnLastPage
[static,const]QWizard_WizardOptionNoBackButtonOnStartPageEnum constant QWizard::NoBackButtonOnStartPage
[static,const]QWizard_WizardOptionNoCancelButtonEnum constant QWizard::NoCancelButton
[static,const]QWizard_WizardOptionNoCancelButtonOnLastPageEnum constant QWizard::NoCancelButtonOnLastPage
[static,const]QWizard_WizardOptionNoDefaultButtonEnum constant QWizard::NoDefaultButton

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 QWizard_WizardOption 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 QWizard_WizardOption 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 QWizard_WizardOption other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

CancelButtonOnLeft

Signature: [static,const] QWizard_WizardOption CancelButtonOnLeft

Description: Enum constant QWizard::CancelButtonOnLeft

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

DisabledBackButtonOnLastPage

Signature: [static,const] QWizard_WizardOption DisabledBackButtonOnLastPage

Description: Enum constant QWizard::DisabledBackButtonOnLastPage

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

ExtendedWatermarkPixmap

Signature: [static,const] QWizard_WizardOption ExtendedWatermarkPixmap

Description: Enum constant QWizard::ExtendedWatermarkPixmap

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

HaveCustomButton1

Signature: [static,const] QWizard_WizardOption HaveCustomButton1

Description: Enum constant QWizard::HaveCustomButton1

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

HaveCustomButton2

Signature: [static,const] QWizard_WizardOption HaveCustomButton2

Description: Enum constant QWizard::HaveCustomButton2

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

HaveCustomButton3

Signature: [static,const] QWizard_WizardOption HaveCustomButton3

Description: Enum constant QWizard::HaveCustomButton3

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

HaveFinishButtonOnEarlyPages

Signature: [static,const] QWizard_WizardOption HaveFinishButtonOnEarlyPages

Description: Enum constant QWizard::HaveFinishButtonOnEarlyPages

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

HaveHelpButton

Signature: [static,const] QWizard_WizardOption HaveHelpButton

Description: Enum constant QWizard::HaveHelpButton

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

HaveNextButtonOnLastPage

Signature: [static,const] QWizard_WizardOption HaveNextButtonOnLastPage

Description: Enum constant QWizard::HaveNextButtonOnLastPage

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

HelpButtonOnRight

Signature: [static,const] QWizard_WizardOption HelpButtonOnRight

Description: Enum constant QWizard::HelpButtonOnRight

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

IgnoreSubTitles

Signature: [static,const] QWizard_WizardOption IgnoreSubTitles

Description: Enum constant QWizard::IgnoreSubTitles

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

IndependentPages

Signature: [static,const] QWizard_WizardOption IndependentPages

Description: Enum constant QWizard::IndependentPages

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

NoBackButtonOnLastPage

Signature: [static,const] QWizard_WizardOption NoBackButtonOnLastPage

Description: Enum constant QWizard::NoBackButtonOnLastPage

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

NoBackButtonOnStartPage

Signature: [static,const] QWizard_WizardOption NoBackButtonOnStartPage

Description: Enum constant QWizard::NoBackButtonOnStartPage

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

NoCancelButton

Signature: [static,const] QWizard_WizardOption NoCancelButton

Description: Enum constant QWizard::NoCancelButton

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

NoCancelButtonOnLastPage

Signature: [static,const] QWizard_WizardOption NoCancelButtonOnLastPage

Description: Enum constant QWizard::NoCancelButtonOnLastPage

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

NoDefaultButton

Signature: [static,const] QWizard_WizardOption NoDefaultButton

Description: Enum constant QWizard::NoDefaultButton

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

_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 QWizard_WizardOption 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 QWizard_WizardOption ptr dup

Description: Creates a copy of self

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

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 QWizard_WizardOption 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 QWizard_WizardOption 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

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] QWizard_QFlags_WizardOption | (const QWizard_WizardOption other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set