|
|
Class InputDialog (version 0.18)Description: Various methods to open a dialog requesting data entry
Class overview
Index
Method Overview
| [static] StringValue get_string( string title, string label, string value ) | Open an input dialog requesting a string |
| [static] StringValue get_item( string title, string label, string items[ ], int value ) | Open an input dialog requesting an item from a list |
| [static] StringValue get_string_password( string title, string label, string value ) | Open an input dialog requesting a string without showing the actual characters entered |
| [static] DoubleValue get_double( string title, string label, double value, int ) | Open an input dialog requesting a floating-point value |
| [static] DoubleValue get_double_ex( string title, string label, double value, double min, double max, int digits ) | Open an input dialog requesting a floating-point value with enhanced capabilities |
| [static] IntValue get_int( string title, string label, int value ) | Open an input dialog requesting an integer value |
| [static] IntValue get_int_ex( string title, string label, int value, int min, int max, int step ) | Open an input dialog requesting an integer value with enhanced capabilities |
| assign( InputDialog other ) | Assign the contents of another object to self |
| [const] InputDialog dup | Creates a copy of self. |
| destroy | Explicitly destroy the object |
| [const] bool destroyed | Tell, if the object was destroyed |
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.
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.
Description: Tell, if the object was 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.
Description: Creates a copy of self.
[static] DoubleValue get_double( string title, string label, double value, int )
Description: Open an input dialog requesting a floating-point value | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | digits: | The number of digits allowed | | returns: | A DoubleValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] DoubleValue get_double_ex( string title, string label, double value, double min, double max, int digits )
Description: Open an input dialog requesting a floating-point value with enhanced capabilities | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | min: | The minimum value allowed | | max: | The maximum value allowed | | digits: | The number of digits allowed | | returns: | A DoubleValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] IntValue get_int( string title, string label, int value )
Description: Open an input dialog requesting an integer value | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | returns: | A IntValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] IntValue get_int_ex( string title, string label, int value, int min, int max, int step )
Description: Open an input dialog requesting an integer value with enhanced capabilities | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | min: | The minimum value allowed | | max: | The maximum value allowed | | step: | The step size for the spin buttons | | returns: | A IntValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] StringValue get_item( string title, string label, string items[ ], int value )
Description: Open an input dialog requesting an item from a list | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | items: | The list of items to show in the selection element | | selection: | The initial selection (index of the element selected intially) | | returns: | A StringValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] StringValue get_string( string title, string label, string value )
Description: Open an input dialog requesting a string | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | returns: | A StringValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
[static] StringValue get_string_password( string title, string label, string value )
Description: Open an input dialog requesting a string without showing the actual characters entered | title: | The title to display for the dialog | | label: | The label text to display for the dialog | | value: | The initial value for the input field | | returns: | A StringValue object with has_value? set to true, if "Ok" was pressed and the value given in it's value attribute |
|