API reference - Class QWizard_WizardButton

Notation used in Ruby API documentation

Description: This class represents the QWizard::WizardButton enum

Class hierarchy: QWizard_WizardButton » QWizard_QFlags_WizardButton

Public constructors

new QWizard_WizardButtonnew(unsigned int value)Creates the enum object from an integer

Public methods

[const]bool==(QWizard_WizardButton other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const QWizard_WizardButton other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QWizard_WizardButtondupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

new QWizard_WizardButtonBackButtonEnum constant QWizard::BackButton
new QWizard_WizardButtonCancelButtonEnum constant QWizard::CancelButton
new QWizard_WizardButtonCommitButtonEnum constant QWizard::CommitButton
new QWizard_WizardButtonCustomButton1Enum constant QWizard::CustomButton1
new QWizard_WizardButtonCustomButton2Enum constant QWizard::CustomButton2
new QWizard_WizardButtonCustomButton3Enum constant QWizard::CustomButton3
new QWizard_WizardButtonFinishButtonEnum constant QWizard::FinishButton
new QWizard_WizardButtonHelpButtonEnum constant QWizard::HelpButton
new QWizard_WizardButtonNButtonsEnum constant QWizard::NButtons
new QWizard_WizardButtonNStandardButtonsEnum constant QWizard::NStandardButtons
new QWizard_WizardButtonNextButtonEnum constant QWizard::NextButton
new QWizard_WizardButtonNoButtonEnum constant QWizard::NoButton
new QWizard_WizardButtonStretchEnum constant QWizard::Stretch

Detailed description

[const] bool ==(QWizard_WizardButton other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new QWizard_WizardButton BackButton

Description: Enum constant QWizard::BackButton

[static] new QWizard_WizardButton CancelButton

Description: Enum constant QWizard::CancelButton

[static] new QWizard_WizardButton CommitButton

Description: Enum constant QWizard::CommitButton

[static] new QWizard_WizardButton CustomButton1

Description: Enum constant QWizard::CustomButton1

[static] new QWizard_WizardButton CustomButton2

Description: Enum constant QWizard::CustomButton2

[static] new QWizard_WizardButton CustomButton3

Description: Enum constant QWizard::CustomButton3

[static] new QWizard_WizardButton FinishButton

Description: Enum constant QWizard::FinishButton

[static] new QWizard_WizardButton HelpButton

Description: Enum constant QWizard::HelpButton

[static] new QWizard_WizardButton NButtons

Description: Enum constant QWizard::NButtons

[static] new QWizard_WizardButton NStandardButtons

Description: Enum constant QWizard::NStandardButtons

[static] new QWizard_WizardButton NextButton

Description: Enum constant QWizard::NextButton

[static] new QWizard_WizardButton NoButton

Description: Enum constant QWizard::NoButton

[static] new QWizard_WizardButton Stretch

Description: Enum constant QWizard::Stretch

[const] void assign(const QWizard_WizardButton other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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] QWizard_WizardButton dup

Description: Creates a copy of self

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

[static] new QWizard_WizardButton new(unsigned int value)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string