API reference - Class FileDialogNotation used in Ruby API documentation Description: Various methods to request a file name
This class provides some basic dialogs to select a file or directory. This functionality is provided through the static (class) methods ask_... Here are some examples:
# get an existing directory:
v = RBA::FileDialog::ask_existing_dir("Dialog Title", ".")
# get multiple files:
v = RBA::FileDialog::ask_open_file_names("Title", ".", "All files (*)")
# ask for one file name to save a file:
v = RBA::FileDialog::ask_save_file_name("Title", ".", "All files (*)")
All these examples return the "nil" value if "Cancel" is pressed. If you have enabled the Qt binding, you can use QFileDialog directly. Public constructors
Public methods
Public static methods and constants
Deprecated methods (protected, public, static, non-static and constructors)
Detailed description[static] variant ask_existing_dir(string title,string dir)Description: Open a dialog to select a directory
This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent. [static] variant ask_open_file_name(string title,string dir,string filter)Description: Select one file for opening
This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent. [static] variant ask_open_file_names(string title,string dir,string filter)Description: Select one or multiple files for opening
This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent. [static] variant ask_save_file_name(string title,string dir,string filter)Description: Select one file for writing
This method has been introduced in version 0.23. It is somewhat easier to use than the get_... equivalent. [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 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. [const] FileDialog dupDescription: Creates a copy of self [static] StringValue get_existing_dir(string title,string dir)Description: Open a dialog to select a directory
This method is deprecated. [static] StringValue get_open_file_name(string title,string dir,string filter)Description: Select one file for opening
This method is deprecated. [static] StringListValue get_open_file_names(string title,string dir,string filter)Description: Select one or multiple files for opening
This method is deprecated. [static] StringValue get_save_file_name(string title,string dir,string filter)Description: Select one file for writing
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. [static] FileDialog newDescription: Creates a new object of this class |