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 descriptionvoid _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 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 _manageDescription: 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 _unmanageDescription: 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. [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. void assign(const FileDialog other)Description: Assigns another object to self void createDescription: Ensures the C++ object is created Use of this method is deprecated. Use _create instead void destroyDescription: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead [const] bool destroyed?Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead [const] new FileDialog ptr dupDescription: Creates a copy of self [static] StringValue get_existing_dir(string title,string dir)Description: Open a dialog to select a directory
Use of this method is deprecated [static] StringValue get_open_file_name(string title,string dir,string filter)Description: Select one file for opening
Use of this method is deprecated [static] StringListValue get_open_file_names(string title,string dir,string filter)Description: Select one or multiple files for opening
Use of this method is deprecated [static] StringValue get_save_file_name(string title,string dir,string filter)Description: Select one file for writing
Use of this method is deprecated [const] bool is_const_object?Description: Returns a value indicating whether the reference is a const reference Use of this method is deprecated. Use _is_const_object? instead [static] new FileDialog ptr newDescription: Creates a new object of this class Python specific notes:This method is the default initializer of the object |