Class FileDialog (version 0.18)

Description: Various methods to request a file name

Class overview

Index

Method Overview

[static] StringValue get_existing_dir( string title, string dir )Open a dialog to select a directory
[static] StringListValue get_open_file_names( string title, string dir, string filter )Select one or multiple files for opening
[static] StringValue get_open_file_name( string title, string dir, string filter )Select one file for opening
[static] StringValue get_save_file_name( string title, string dir, string filter )Select one file for writing
assign( FileDialog other )Assign the contents of another object to self
[const] FileDialog dupCreates a copy of self.
destroyExplicitly destroy the object
[const] bool destroyedTell, if the object was destroyed

assign( 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.

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: 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.

[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