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

API reference - Class FileDialog

Notation used in Ruby API documentation

Description: Various methods to request a file name

Public constructors

FileDialognewCreates a new object of this class

Public methods

[const]voidassign(const FileDialog other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]FileDialogdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference

Public static methods and constants

StringValueget_existing_dir(string title,
string dir)
Open a dialog to select a directory
StringValueget_open_file_name(string title,
string dir,
string filter)
Select one file for opening
StringListValueget_open_file_names(string title,
string dir,
string filter)
Select one or multiple files for opening
StringValueget_save_file_name(string title,
string dir,
string filter)
Select one file for writing

Detailed description

[const] void assign(const FileDialog 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 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 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] FileDialog dup

Description: Creates a copy of self

[static] StringValue get_existing_dir(string title,string dir)

Description: Open a dialog to select a directory

title:The title of the dialog
dir:The directory selected initially
Returns:A StringValue object that contains the directory path selected or with has_value? = false if "Cancel" was pressed

[static] StringValue get_open_file_name(string title,string dir,string filter)

Description: Select one file for opening

title:The title of the dialog
dir:The directory selected initially
filter:The filters available, for example "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
Returns:A StringValue object that contains the files selected or with has_value? = false if "Cancel" was pressed

[static] StringListValue get_open_file_names(string title,string dir,string filter)

Description: Select one or multiple files for opening

title:The title of the dialog
dir:The directory selected initially
filter:The filters available, for example "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
Returns:A StringListValue object that contains the files selected or with has_value? = false if "Cancel" was pressed

[static] StringValue get_save_file_name(string title,string dir,string filter)

Description: Select one file for writing

title:The title of the dialog
dir:The directory selected initially
filter:The filters available, for example "Images (*.png *.xpm *.jpg);;Text files (*.txt);;XML files (*.xml)"
Returns:A StringValue object that contains the files selected or with has_value? = false if "Cancel" was pressed

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

Description: Creates a new object of this class