|
|
KLayout Manual: Main Index » Class Index » API reference - Class InputDialog API reference - Class InputDialogNotation used in Ruby API documentation Description: Various methods to open a dialog requesting data entry
This class provides some basic dialogs to enter a single value. Values can be strings floating-point values, integer values or an item from a list.
This functionality is provided through the static (class) methods ask_... Here are some examples:
# get a double value between -10 and 10 (initial value is 0):
v = RBA::InputDialog::ask_double_ex("Dialog Title", "Enter the value here:", 0, -10, 10, 1)
# get an item from a list:
v = RBA::InputDialog::ask_item("Dialog Title", "Select one:", [ "item 1", "item 2", "item 3" ], 1)
All these examples return the "nil" value if "Cancel" is pressed. If you have enabled the Qt binding, you can use QInputDialog directly.
Public constructors| InputDialog | new | | Creates a new object of this class |
Public methods| [const] | void | assign | (const InputDialog other) | Assign the contents of another object to self | | void | create | | Ensures the C++ object is created | | void | destroy | | Explicitly destroy the object | | [const] | bool | destroyed? | | Returns a value indicating whether the object was already destroyed | | [const] | InputDialog | dup | | Creates a copy of self | | [const] | bool | is_const_object? | | Returns a value indicating whether the reference is a const reference |
Public static methods and constants | variant | ask_double | (string title,
string label,
double value,
int digits) | Open an input dialog requesting a floating-point value | | variant | ask_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 | | variant | ask_int | (string title,
string label,
int value) | Open an input dialog requesting an integer value | | variant | ask_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 | | variant | ask_item | (string title,
string label,
string[] items,
int value) | Open an input dialog requesting an item from a list | | variant | ask_string | (string title,
string label,
string value) | Open an input dialog requesting a string | | variant | ask_string_password | (string title,
string label,
string value) | Open an input dialog requesting a string without showing the actual characters entered |
Deprecated methods (protected, public, static, non-static and constructors)| [static] | DoubleValue | get_double | (string title,
string label,
double value,
int digits) | Use of this method is deprecated | | [static] | DoubleValue | get_double_ex | (string title,
string label,
double value,
double min,
double max,
int digits) | Use of this method is deprecated | | [static] | IntValue | get_int | (string title,
string label,
int value) | Use of this method is deprecated | | [static] | IntValue | get_int_ex | (string title,
string label,
int value,
int min,
int max,
int step) | Use of this method is deprecated | | [static] | StringValue | get_item | (string title,
string label,
string[] items,
int value) | Use of this method is deprecated | | [static] | StringValue | get_string | (string title,
string label,
string value) | Use of this method is deprecated | | [static] | StringValue | get_string_password | (string title,
string label,
string value) | Use of this method is deprecated |
Detailed description[static] variant ask_double(string title,string label,double value,int digits)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: | The value entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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: | The value entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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: | The value entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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: | The value entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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 initially) | | Returns: | The string of the item selected if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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: | The string entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [static] variant ask_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: | The string entered if "Ok" was pressed or nil if "Cancel" was pressed |
This method has been introduced in 0.22 and is somewhat easier to use than the get_.. equivalent. [const] void assign(const InputDialog 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.
void createDescription: 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 destroyDescription: 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. Description: Creates a copy of self [static] DoubleValue get_double(string title,string label,double value,int digits)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 |
This method is deprecated. [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 |
This method is deprecated. [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 |
This method is deprecated. [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 |
This method is deprecated. [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 |
This method is deprecated. [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 |
This method is deprecated. [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 |
This method is deprecated. [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. Description: Creates a new object of this class
|