API reference - Class MessageBox

Notation used in Ruby API documentation

Description: Various methods to display message boxes

• Public constructors
• Public methods
• Public static methods and constants
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

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

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

[const] void assign(const MessageBox 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.

[static] int b_abort

Description: A constant describing the 'Abort' button

This method is deprecated. Use method 'Abort' instead

[static] int b_cancel

Description: A constant describing the 'Cancel' button

This method is deprecated. Use method 'Cancel' instead

[static] int b_ignore

Description: A constant describing the 'Ignore' button

This method is deprecated. Use method 'Ignore' instead

[static] int b_no

Description: A constant describing the 'No' button

This method is deprecated. Use method 'No' instead

[static] int b_ok

Description: A constant describing the 'Ok' button

This method is deprecated. Use method 'Ok' instead

[static] int b_retry

Description: A constant describing the 'Retry' button

This method is deprecated. Use method 'Retry' instead

[static] int b_yes

Description: A constant describing the 'Yes' button

This method is deprecated. Use method 'Yes' instead

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.

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

Description: Open a critical (error) message box

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] MessageBox dup

Description: Creates a copy of self

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

Description: Open a information message box

[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] MessageBox new

Description: Creates a new object of this class

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

Description: Open a question message box

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

Description: Open a warning message box