Erlang -- wxFileDialog

# wxFileDialog

###
Module

wxFileDialog

###
Module Summary

Functions for wxFileDialog class

###
Description

This class represents the file chooser dialog.

The path and filename are distinct elements of a full file pathname. If path is ?wxEmptyString, the current directory will be used. If filename is ?wxEmptyString, 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.

The typical usage for the open file dialog is:

The typical usage for the save file dialog is instead somewhat simpler:

Remark: All implementations of the wxFileDialog provide 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: It must be noted that wildcard support in the native Motif file dialog is quite limited: only one file type 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. On Mac macOS in the open file dialog the filter choice box is not shown by default. Instead all given wildcards are appplied at the same time: So in the above example all bmp, gif and png files are displayed. To enforce the display of the filter choice set the corresponding wxSystemOptions before calling the file open dialog: But in contrast to Windows and Unix, where the file type choice filters only the selected files, on Mac macOS even in this case the dialog shows all files matching all file types. The files which does not match the currently selected file type are greyed out and are not selectable.

Styles

This class supports the following styles:

See: Overview cmndlg, ?wxFileSelector()

This class is derived (and can use functions) from: wxDialog wxTopLevelWindow wxWindow wxEvtHandler

wxWidgets docs: wxFileDialog

###
Data Types

####
wxFileDialog() = wx:wx_object()

###
Exports

####
new(Parent) -> wxFileDialog()

### Types

Parent = wxWindow:wxWindow()

####
new(Parent, Options :: [Option]) -> wxFileDialog()

### Types

Parent = wxWindow:wxWindow()
Option =
{message, unicode:chardata()} |
{defaultDir, unicode:chardata()} |
{defaultFile, unicode:chardata()} |
{wildCard, unicode:chardata()} |
{style, integer()} |
{pos, {X :: integer(), Y :: integer()}} |
{sz, {W :: integer(), H :: integer()}}

Constructor.

Use wxDialog:showModal/1 to show the dialog.

####
destroy(This :: wxFileDialog()) -> ok

Destructor.

####
getDirectory(This) -> unicode:charlist()

### Types

This = wxFileDialog()

Returns the default directory.

####
getFilename(This) -> unicode:charlist()

### Types

This = wxFileDialog()

Returns the default filename.

Note: This function can't be used with dialogs which have the wxFD_MULTIPLE style, use getFilenames/1 instead.

####
getFilenames(This) -> [unicode:charlist()]

### Types

This = wxFileDialog()

Fills the array filenames with the names of the files chosen.

This function should only be used with the dialogs which have wxFD_MULTIPLE style, use getFilename/1 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.

####
getFilterIndex(This) -> integer()

### Types

This = wxFileDialog()

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.

####
getMessage(This) -> unicode:charlist()

### Types

This = wxFileDialog()

Returns the message that will be displayed on the dialog.

####
getPath(This) -> unicode:charlist()

### Types

This = wxFileDialog()

Returns the full path (directory and filename) of the selected file.

Note: This function can't be used with dialogs which have the wxFD_MULTIPLE style, use getPaths/1 instead.

####
getPaths(This) -> [unicode:charlist()]

### Types

This = wxFileDialog()

Fills the array paths with the full paths of the files chosen.

This function should only be used with the dialogs which have wxFD_MULTIPLE style, use getPath/1 for the others.

####
getWildcard(This) -> unicode:charlist()

### Types

This = wxFileDialog()

Returns the file dialog wildcard.

####
setDirectory(This, Directory) -> ok

### Types

This = wxFileDialog()
Directory = unicode:chardata()

Sets the default directory.

####
setFilename(This, Setfilename) -> ok

### Types

This = wxFileDialog()
Setfilename = unicode:chardata()

Sets the default filename.

In wxGTK this will have little effect unless a default directory has previously been set.

####
setFilterIndex(This, FilterIndex) -> ok

### Types

This = wxFileDialog()
FilterIndex = integer()

Sets the default filter index, starting from zero.

####
setMessage(This, Message) -> ok

### Types

This = wxFileDialog()
Message = unicode:chardata()

Sets the message that will be displayed on the dialog.

####
setPath(This, Path) -> ok

### Types

This = wxFileDialog()
Path = unicode:chardata()

Sets the path (the combined directory and filename that will be returned when the dialog is dismissed).

####
setWildcard(This, WildCard) -> ok

### Types

This = wxFileDialog()
WildCard = unicode:chardata()

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.