Notation used in Ruby API documentation
Module: lay
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.
| [const] | MessageBox ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const MessageBox other) | Assigns another object to self | |
| [const] | new MessageBox ptr | dup | Creates a copy of self |
| int | Abort | A constant describing the 'Abort' button | ||
| int | Cancel | A constant describing the 'Cancel' button | ||
| int | Ignore | A constant describing the 'Ignore' button | ||
| int | No | A constant describing the 'No' button | ||
| int | Ok | A constant describing the 'Ok' button | ||
| int | Retry | A constant describing the 'Retry' button | ||
| int | Yes | A constant describing the 'Yes' button | ||
| int | critical | (string title, string text, int buttons) | Open a critical (error) message box | |
| int | info | (string title, string text, int buttons) | Open a information message box | |
| int | question | (string title, string text, int buttons) | Open a question message box | |
| int | warning | (string title, string text, int buttons) | Open a warning message box |
| [static] | int | b_abort | Use of this method is deprecated. Use Abort instead | |
| [static] | int | b_cancel | Use of this method is deprecated. Use Cancel instead | |
| [static] | int | b_ignore | Use of this method is deprecated. Use Ignore instead | |
| [static] | int | b_no | Use of this method is deprecated. Use No instead | |
| [static] | int | b_ok | Use of this method is deprecated. Use Ok instead | |
| [static] | int | b_retry | Use of this method is deprecated. Use Retry instead | |
| [static] | int | b_yes | Use of this method is deprecated. Use Yes instead |
Abort | Signature: [static] int Abort Description: A constant describing the 'Abort' button Python specific notes: | ||||||||
Cancel | Signature: [static] int Cancel Description: A constant describing the 'Cancel' button Python specific notes: | ||||||||
Ignore | Signature: [static] int Ignore Description: A constant describing the 'Ignore' button Python specific notes: | ||||||||
No | Signature: [static] int No Description: A constant describing the 'No' button Python specific notes: | ||||||||
Ok | Signature: [static] int Ok Description: A constant describing the 'Ok' button Python specific notes: | ||||||||
Retry | Signature: [static] int Retry Description: A constant describing the 'Retry' button Python specific notes: | ||||||||
Yes | Signature: [static] int Yes Description: A constant describing the 'Yes' button Python specific notes: | ||||||||
_const_cast | Signature: [const] MessageBox 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 MessageBox other) Description: Assigns another object to self | ||||||||
b_abort | Signature: [static] int b_abort Description: A constant describing the 'Abort' button Use of this method is deprecated. Use Abort instead Python specific notes: | ||||||||
b_cancel | Signature: [static] int b_cancel Description: A constant describing the 'Cancel' button Use of this method is deprecated. Use Cancel instead Python specific notes: | ||||||||
b_ignore | Signature: [static] int b_ignore Description: A constant describing the 'Ignore' button Use of this method is deprecated. Use Ignore instead Python specific notes: | ||||||||
b_no | Signature: [static] int b_no Description: A constant describing the 'No' button Use of this method is deprecated. Use No instead Python specific notes: | ||||||||
b_ok | Signature: [static] int b_ok Description: A constant describing the 'Ok' button Use of this method is deprecated. Use Ok instead Python specific notes: | ||||||||
b_retry | Signature: [static] int b_retry Description: A constant describing the 'Retry' button Use of this method is deprecated. Use Retry instead Python specific notes: | ||||||||
b_yes | Signature: [static] int b_yes Description: A constant describing the 'Yes' button Use of this method is deprecated. Use Yes instead Python specific notes: | ||||||||
critical | Signature: [static] int critical (string title, string text, int buttons) Description: Open a critical (error) message box
| ||||||||
dup | Signature: [const] new MessageBox ptr dup Description: Creates a copy of self Python specific notes: | ||||||||
info | Signature: [static] int info (string title, string text, int buttons) Description: Open a information message box
| ||||||||
question | Signature: [static] int question (string title, string text, int buttons) Description: Open a question message box
| ||||||||
warning | Signature: [static] int warning (string title, string text, int buttons) Description: Open a warning message box
|