KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QMessageBox_StandardButton

Notation used in Ruby API documentation

Module: QtWidgets

Description: This class represents the QMessageBox::StandardButton enum

This class is equivalent to the class QMessageBox::StandardButton

Public constructors

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

Public methods

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

Public static methods and constants

[static,const]QMessageBox_StandardButtonAbortEnum constant QMessageBox::Abort
[static,const]QMessageBox_StandardButtonApplyEnum constant QMessageBox::Apply
[static,const]QMessageBox_StandardButtonButtonMaskEnum constant QMessageBox::ButtonMask
[static,const]QMessageBox_StandardButtonCancelEnum constant QMessageBox::Cancel
[static,const]QMessageBox_StandardButtonCloseEnum constant QMessageBox::Close
[static,const]QMessageBox_StandardButtonDefaultEnum constant QMessageBox::Default
[static,const]QMessageBox_StandardButtonDiscardEnum constant QMessageBox::Discard
[static,const]QMessageBox_StandardButtonEscapeEnum constant QMessageBox::Escape
[static,const]QMessageBox_StandardButtonFirstButtonEnum constant QMessageBox::FirstButton
[static,const]QMessageBox_StandardButtonFlagMaskEnum constant QMessageBox::FlagMask
[static,const]QMessageBox_StandardButtonHelpEnum constant QMessageBox::Help
[static,const]QMessageBox_StandardButtonIgnoreEnum constant QMessageBox::Ignore
[static,const]QMessageBox_StandardButtonLastButtonEnum constant QMessageBox::LastButton
[static,const]QMessageBox_StandardButtonNoEnum constant QMessageBox::No
[static,const]QMessageBox_StandardButtonNoAllEnum constant QMessageBox::NoAll
[static,const]QMessageBox_StandardButtonNoButtonEnum constant QMessageBox::NoButton
[static,const]QMessageBox_StandardButtonNoToAllEnum constant QMessageBox::NoToAll
[static,const]QMessageBox_StandardButtonOkEnum constant QMessageBox::Ok
[static,const]QMessageBox_StandardButtonOpenEnum constant QMessageBox::Open
[static,const]QMessageBox_StandardButtonResetEnum constant QMessageBox::Reset
[static,const]QMessageBox_StandardButtonRestoreDefaultsEnum constant QMessageBox::RestoreDefaults
[static,const]QMessageBox_StandardButtonRetryEnum constant QMessageBox::Retry
[static,const]QMessageBox_StandardButtonSaveEnum constant QMessageBox::Save
[static,const]QMessageBox_StandardButtonSaveAllEnum constant QMessageBox::SaveAll
[static,const]QMessageBox_StandardButtonYesEnum constant QMessageBox::Yes
[static,const]QMessageBox_StandardButtonYesAllEnum constant QMessageBox::YesAll
[static,const]QMessageBox_StandardButtonYesToAllEnum constant QMessageBox::YesToAll

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

Abort

Signature: [static,const] QMessageBox_StandardButton Abort

Description: Enum constant QMessageBox::Abort

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

Apply

Signature: [static,const] QMessageBox_StandardButton Apply

Description: Enum constant QMessageBox::Apply

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

ButtonMask

Signature: [static,const] QMessageBox_StandardButton ButtonMask

Description: Enum constant QMessageBox::ButtonMask

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

Cancel

Signature: [static,const] QMessageBox_StandardButton Cancel

Description: Enum constant QMessageBox::Cancel

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

Close

Signature: [static,const] QMessageBox_StandardButton Close

Description: Enum constant QMessageBox::Close

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

Default

Signature: [static,const] QMessageBox_StandardButton Default

Description: Enum constant QMessageBox::Default

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

Discard

Signature: [static,const] QMessageBox_StandardButton Discard

Description: Enum constant QMessageBox::Discard

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

Escape

Signature: [static,const] QMessageBox_StandardButton Escape

Description: Enum constant QMessageBox::Escape

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

FirstButton

Signature: [static,const] QMessageBox_StandardButton FirstButton

Description: Enum constant QMessageBox::FirstButton

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

FlagMask

Signature: [static,const] QMessageBox_StandardButton FlagMask

Description: Enum constant QMessageBox::FlagMask

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

Help

Signature: [static,const] QMessageBox_StandardButton Help

Description: Enum constant QMessageBox::Help

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

Ignore

Signature: [static,const] QMessageBox_StandardButton Ignore

Description: Enum constant QMessageBox::Ignore

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

LastButton

Signature: [static,const] QMessageBox_StandardButton LastButton

Description: Enum constant QMessageBox::LastButton

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

No

Signature: [static,const] QMessageBox_StandardButton No

Description: Enum constant QMessageBox::No

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

NoAll

Signature: [static,const] QMessageBox_StandardButton NoAll

Description: Enum constant QMessageBox::NoAll

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

NoButton

Signature: [static,const] QMessageBox_StandardButton NoButton

Description: Enum constant QMessageBox::NoButton

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

NoToAll

Signature: [static,const] QMessageBox_StandardButton NoToAll

Description: Enum constant QMessageBox::NoToAll

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

Ok

Signature: [static,const] QMessageBox_StandardButton Ok

Description: Enum constant QMessageBox::Ok

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

Open

Signature: [static,const] QMessageBox_StandardButton Open

Description: Enum constant QMessageBox::Open

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

Reset

Signature: [static,const] QMessageBox_StandardButton Reset

Description: Enum constant QMessageBox::Reset

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

RestoreDefaults

Signature: [static,const] QMessageBox_StandardButton RestoreDefaults

Description: Enum constant QMessageBox::RestoreDefaults

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

Retry

Signature: [static,const] QMessageBox_StandardButton Retry

Description: Enum constant QMessageBox::Retry

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

Save

Signature: [static,const] QMessageBox_StandardButton Save

Description: Enum constant QMessageBox::Save

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

SaveAll

Signature: [static,const] QMessageBox_StandardButton SaveAll

Description: Enum constant QMessageBox::SaveAll

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

Yes

Signature: [static,const] QMessageBox_StandardButton Yes

Description: Enum constant QMessageBox::Yes

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

YesAll

Signature: [static,const] QMessageBox_StandardButton YesAll

Description: Enum constant QMessageBox::YesAll

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

YesToAll

Signature: [static,const] QMessageBox_StandardButton YesToAll

Description: Enum constant QMessageBox::YesToAll

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

_const_cast

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set