API reference - Class MessageBox

Notation used in Ruby API documentation

Description: Various methods to display message boxes

Class hierarchy: MessageBox » QMainWindow » QWidget » QObject

This class provides some basic message boxes. This functionality is provided through the static (class) methods warning, question and so on.

Here is some example:

# issue a warning and ask whether to continue:
v = RBA::MessageBox::warning("Dialog Title", "Something happened. Continue?", RBA::MessageBox::Yes + RBA::MessageBox::No)
if v == RBA::MessageBox::Yes
  ... continue ...
end

If you have enabled the Qt binding, you can use QMessageBox directly.

Public constructors

new MessageBox ptrnewCreates a new object of this class

Public methods

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 MessageBox other)Assigns another object to self
[const]new MessageBox ptrdupCreates a copy of self

Public static methods and constants

intAbortA constant describing the 'Abort' button
intCancelA constant describing the 'Cancel' button
intIgnoreA constant describing the 'Ignore' button
intNoA constant describing the 'No' button
intOkA constant describing the 'Ok' button
intRetryA constant describing the 'Retry' button
intYesA constant describing the 'Yes' button
intcritical(string title,
string text,
int buttons)
Open a critical (error) message box
intinfo(string title,
string text,
int buttons)
Open a information message box
intquestion(string title,
string text,
int buttons)
Open a question message box
intwarning(string title,
string text,
int buttons)
Open a warning message box

Deprecated methods (protected, public, static, non-static and constructors)

[static]intb_abortUse of this method is deprecated. Use Abort instead
[static]intb_cancelUse of this method is deprecated. Use Cancel instead
[static]intb_ignoreUse of this method is deprecated. Use Ignore instead
[static]intb_noUse of this method is deprecated. Use No instead
[static]intb_okUse of this method is deprecated. Use Ok instead
[static]intb_retryUse of this method is deprecated. Use Retry instead
[static]intb_yesUse of this method is deprecated. Use Yes instead
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

[static] int Abort

Description: A constant describing the 'Abort' button

[static] int Cancel

Description: A constant describing the 'Cancel' button

[static] int Ignore

Description: A constant describing the 'Ignore' button

[static] int No

Description: A constant describing the 'No' button

[static] int Ok

Description: A constant describing the 'Ok' button

[static] int Retry

Description: A constant describing the 'Retry' button

[static] int Yes

Description: A constant describing the 'Yes' button

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

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

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.

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.

void assign(const MessageBox other)

Description: Assigns another object to self

[static] int b_abort

Description: A constant describing the 'Abort' button

Use of this method is deprecated. Use Abort instead

[static] int b_cancel

Description: A constant describing the 'Cancel' button

Use of this method is deprecated. Use Cancel instead

[static] int b_ignore

Description: A constant describing the 'Ignore' button

Use of this method is deprecated. Use Ignore instead

[static] int b_no

Description: A constant describing the 'No' button

Use of this method is deprecated. Use No instead

[static] int b_ok

Description: A constant describing the 'Ok' button

Use of this method is deprecated. Use Ok instead

[static] int b_retry

Description: A constant describing the 'Retry' button

Use of this method is deprecated. Use Retry instead

[static] int b_yes

Description: A constant describing the 'Yes' button

Use of this method is deprecated. Use Yes instead

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[static] int critical(string title,string text,int buttons)

Description: Open a critical (error) message box

title:The title of the window
text:The text to show
buttons:A combination (+) of button constants (Ok and so on) describing the buttons to show for the message box
Returns:The button constant describing the button that was pressed

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[const] new MessageBox ptr dup

Description: Creates a copy of self

[static] int info(string title,string text,int buttons)

Description: Open a information message box

title:The title of the window
text:The text to show
buttons:A combination (+) of button constants (Ok and so on) describing the buttons to show for the message box
Returns:The button constant describing the button that was pressed

[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

[static] new MessageBox ptr new

Description: Creates a new object of this class

Python specific notes:

This method is the default initializer of the object

[static] int question(string title,string text,int buttons)

Description: Open a question message box

title:The title of the window
text:The text to show
buttons:A combination (+) of button constants (Ok and so on) describing the buttons to show for the message box
Returns:The button constant describing the button that was pressed

[static] int warning(string title,string text,int buttons)

Description: Open a warning message box

title:The title of the window
text:The text to show
buttons:A combination (+) of button constants (Ok and so on) describing the buttons to show for the message box
Returns:The button constant describing the button that was pressed