This class represents the file chooser dialog.
FD_DEFAULT_STYLE |
Equivalent to FD_OPEN. |
FD_OPEN |
This is an open dialog; usually this means that the default button’s label of the dialog is “Open”. Cannot be combined with FD_SAVE. |
FD_SAVE |
This is a save dialog; usually this means that the default button’s label of the dialog is “Save”. Cannot be combined with FD_OPEN. |
FD_OVERWRITE_PROMPT |
For save dialog only: prompt for a confirmation if a file will be overwritten. |
FD_FILE_MUST_EXIST |
For open dialog only: the user may only select files that actually exist. |
FD_MULTIPLE |
For open dialog only: allows selecting multiple files. |
FD_CHANGE_DIR |
Change the current working directory to the directory where the file(s) chosen by the user are. |
FD_PREVIEW |
Show the preview of the selected files (currently only supported by GTK using GTK+ 2.4 or later). |
NB: Previous versions of wxRuby used FD_CHANGE_DIR by default
under MS Windows which allowed the program to simply remember the last
directory where user selected the files to open/save. This (desired)
functionality must be implemented in the program itself now (manually remember
the last path used and pass it to the dialog the next time it is called) or
by using this flag.
Pops up a file selector box. In Windows and GTK2.4+, this is the common file selector dialog. In X, this is a file selector box with somewhat less functionality. The path and filename are distinct elements of a full file pathname. If path is ``”, the current directory will be used. If filename is ``”, no default filename will be supplied. The wildcard determines what files are displayed in the file selector, and file extension supplies a type extension for the required filename.
Both the X and Windows versions implement a wildcard filter. Typing a filename containing wildcards (*, ?) in the filename text item, and clicking on Ok, will result in only those files matching the pattern being displayed. The wildcard may be a specification for multiple types of file with a description for each, such as:
BMP and GIF files (*.bmp;*.gif)|*.bmp;*.gif|PNG files (*.png)|*.png
It must be noted that wildcard support in the native Motif file dialog is quite limited: only one alternative is supported, and it is displayed without the descriptive test; BMP files (*.bmp)|*.bmp is displayed as *.bmp, and both BMP files(*.bmp)|*.bmp|GIF files (*.gif)|*.gif and Image files|*.bmp;*.gif are errors.
FileDialog.new(Window parent, String message = "Choose a file",
String defaultDir = "",
String defaultFile = "",
String wildcard = ".*",
Integer style = FD_DEFAULT_STYLE,
Point pos = DEFAULT_POSITION,
Size sz = DEFAULT_SIZE,
String name = "filedlg")Constructor. Use FileDialog#show_modal to show the dialog.
FD_* styles, above, for more info.String get_directory()Returns the default directory.
String get_filename()Returns the default filename.
Array get_filenames()Returns an array of strings of the names of the files chosen. This
function should only be used with the dialogs which have MULTIPLE
style, use get_filename for the others.
Note that under Windows, if the user selects shortcuts, the filenames include paths, since the application cannot determine the full path of each referenced file by appending the directory containing the shortcuts to the filename.
Integer get_filter_index()Returns the index into the list of filters supplied, optionally, in the wildcard parameter. Before the dialog is shown, this is the index which will be used when the dialog is first displayed. After the dialog is shown, this is the index selected by the user.
String get_message()Returns the message that will be displayed on the dialog.
String get_path()Returns the full path (directory and filename) of the selected file.
Array get_paths()Returns an array with the full paths of the files chosen. This function
should only be used with the dialogs which have MULTIPLE style, use
get_path for the others.
String get_wildcard()Returns the file dialog wildcard.
set_directory(String directory)Sets the default directory.
set_filename(String setfilename)Sets the default filename.
set_filter_index(Integer filterIndex)Sets the default filter index, starting from zero.
set_message(String message)Sets the message that will be displayed on the dialog.
set_path(String path)Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).
set_wildcard(String wildCard)Sets the wildcard, which can contain multiple file types, for example:
BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif
Note that the native Motif dialog has some limitations with respect to wildcards; see the Remarks section above.
Integer show_modal()Shows the dialog, returning Wx::ID_OK if the user pressed OK, and
Wx::ID_CANCEL otherwise.
[This page automatically generated from the Textile source at Thu May 01 00:50:36 +0100 2008]