KLayout Manual: Main Index » Class Index » API reference - Class InputDialog

API reference - Class InputDialog

Description: Various methods to open a dialog requesting data entry

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

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

new InputDialog ptr

new

Creates a new object of this class

Public methods

	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 InputDialog other)	Assigns another object to self
[const]	new InputDialog ptr	dup		Creates a copy of self

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)

	void	create		Use of this method is deprecated. Use _create instead
	void	destroy		Use of this method is deprecated. Use _destroy instead
[const]	bool	destroyed?		Use of this method is deprecated. Use _destroyed? instead
[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
[const]	bool	is_const_object?		Use of this method is deprecated. Use _is_const_object? instead

Detailed description

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.