Notation used in Ruby API documentation
Module: lay
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.
| new FileDialog ptr | new | Creates a new object of this class |
| [const] | FileDialog ptr | _const_cast | Returns a non-const reference to self. | |
| 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 FileDialog other) | Assigns another object to self | |
| [const] | new FileDialog ptr | dup | Creates a copy of self |
| variant | ask_existing_dir | (string title, string dir) | Open a dialog to select a directory | |
| variant | ask_open_file_name | (string title, string dir, string filter) | Select one file for opening | |
| variant | ask_open_file_names | (string title, string dir, string filter) | Select one or multiple files for opening | |
| variant | ask_save_file_name | (string title, string dir, string filter) | Select one file for writing | |
| variant | ask_save_file_name_with_filter | (string title, string dir, string filter) | Select one file for writing |
| 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] | StringValue | get_existing_dir | (string title, string dir) | Use of this method is deprecated |
| [static] | StringValue | get_open_file_name | (string title, string dir, string filter) | Use of this method is deprecated |
| [static] | StringListValue | get_open_file_names | (string title, string dir, string filter) | Use of this method is deprecated |
| [static] | StringValue | get_save_file_name | (string title, string dir, string filter) | Use of this method is deprecated |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] FileDialog ptr _const_cast Description: Returns a non-const reference to self. Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects. This method has been introduced in version 0.29.6. | ||||||||
_create | Signature: 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. | ||||||||
_destroy | Signature: 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. | ||||||||
_destroyed? | Signature: [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. | ||||||||
_is_const_object? | Signature: [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. | ||||||||
_manage | Signature: 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. | ||||||||
_unmanage | Signature: 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. | ||||||||
ask_existing_dir | Signature: [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. | ||||||||
ask_open_file_name | Signature: [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. | ||||||||
ask_open_file_names | Signature: [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. | ||||||||
ask_save_file_name | Signature: [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. | ||||||||
ask_save_file_name_with_filter | Signature: [static] variant ask_save_file_name_with_filter (string title, string dir, string filter) Description: Select one file for writing
This method has been introduced in version 0.28.11. | ||||||||
assign | Signature: void assign (const FileDialog other) Description: Assigns another object to self | ||||||||
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead 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. | ||||||||
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead 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. | ||||||||
destroyed? | Signature: [const] bool destroyed? Description: Returns a value indicating whether the object was already destroyed Use of this method is deprecated. Use _destroyed? instead 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. | ||||||||
dup | Signature: [const] new FileDialog ptr dup Description: Creates a copy of self Python specific notes: | ||||||||
get_existing_dir | Signature: [static] StringValue get_existing_dir (string title, string dir) Description: Open a dialog to select a directory
Use of this method is deprecated Starting with version 0.23 this method is deprecated. Use ask_existing_dir instead. | ||||||||
get_open_file_name | Signature: [static] StringValue get_open_file_name (string title, string dir, string filter) Description: Select one file for opening
Use of this method is deprecated Starting with version 0.23 this method is deprecated. Use ask_open_file_name instead. | ||||||||
get_open_file_names | Signature: [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 Starting with version 0.23 this method is deprecated. Use ask_open_file_names instead. | ||||||||
get_save_file_name | Signature: [static] StringValue get_save_file_name (string title, string dir, string filter) Description: Select one file for writing
Use of this method is deprecated Starting with version 0.23 this method is deprecated. Use ask_save_file_name instead. | ||||||||
is_const_object? | Signature: [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 This method returns true, if self is a const reference. In that case, only const methods may be called on self. | ||||||||
new | Signature: [static] new FileDialog ptr new Description: Creates a new object of this class Python specific notes: |