<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxFileDialog</title>
</header>
<module>wxFileDialog</module>
<modulesummary>Functions for wxFileDialog class</modulesummary>
<description><p>This class represents the file chooser dialog.
      </p><p>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.
      </p><p>The typical usage for the open file dialog is: 
      </p><p>The typical usage for the save file dialog is instead somewhat simpler: 
      </p><p>Remark: All implementations of the <seeerl marker="wxFileDialog"><c>wxFileDialog</c></seeerl> 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 <seeerl marker="wxSystemOptions"><c>wxSystemOptions</c></seeerl> 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.
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_file">Overview cmndlg</url>, ?wxFileSelector()
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxDialog"><c>wxDialog</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_file_dialog.html">wxFileDialog</url></p>
  </description>
<datatypes><datatype><name name="wxFileDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Use <seemfa marker="wxDialog#showModal/1"><c>wxDialog:showModal/1</c></seemfa> to show the dialog.
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDirectory" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the default directory. </fsummary>
    <desc><p>Returns the default directory. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilename" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the default filename. </fsummary>
    <desc><p>Returns the default filename. 
      </p><p>Note: This function can't be used with dialogs which have the <c>wxFD_MULTIPLE</c> style, use <seemfa marker="#getFilenames/1"><c>getFilenames/1</c></seemfa> instead. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilenames" arity="1" clause_i="1" since=""/>
    <fsummary>Fills the array <c>filenames</c> with the names of the files chosen. </fsummary>
    <desc><p>Fills the array <c>filenames</c> with the names of the files chosen. 
      </p><p>This function should only be used with the dialogs which have <c>wxFD_MULTIPLE</c> style, use <seemfa marker="#getFilename/1"><c>getFilename/1</c></seemfa> for the others.
      </p><p>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. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilterIndex" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the index into the list of filters supplied, optionally, in the wildcard parameter. </fsummary>
    <desc><p>Returns the index into the list of filters supplied, optionally, in the wildcard parameter. 
      </p><p>Before the dialog is shown, this is the index which will be used when the dialog is first displayed.
      </p><p>After the dialog is shown, this is the index selected by the user. 
      </p></desc>
  </func>
  
  <func>
    <name name="getMessage" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the message that will be displayed on the dialog. </fsummary>
    <desc><p>Returns the message that will be displayed on the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPath" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the full path (directory and filename) of the selected file. </fsummary>
    <desc><p>Returns the full path (directory and filename) of the selected file. 
      </p><p>Note: This function can't be used with dialogs which have the <c>wxFD_MULTIPLE</c> style, use <seemfa marker="#getPaths/1"><c>getPaths/1</c></seemfa> instead. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPaths" arity="1" clause_i="1" since=""/>
    <fsummary>Fills the array <c>paths</c> with the full paths of the files chosen. </fsummary>
    <desc><p>Fills the array <c>paths</c> with the full paths of the files chosen. 
      </p><p>This function should only be used with the dialogs which have <c>wxFD_MULTIPLE</c> style, use <seemfa marker="#getPath/1"><c>getPath/1</c></seemfa> for the others. 
      </p></desc>
  </func>
  
  <func>
    <name name="getWildcard" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the file dialog wildcard. </fsummary>
    <desc><p>Returns the file dialog wildcard. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDirectory" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default directory. </fsummary>
    <desc><p>Sets the default directory. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFilename" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default filename. </fsummary>
    <desc><p>Sets the default filename. 
      </p><p>In wxGTK this will have little effect unless a default directory has previously been set. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFilterIndex" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default filter index, starting from zero. </fsummary>
    <desc><p>Sets the default filter index, starting from zero. 
      </p></desc>
  </func>
  
  <func>
    <name name="setMessage" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the message that will be displayed on the dialog. </fsummary>
    <desc><p>Sets the message that will be displayed on the dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPath" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the path (the combined directory and filename that will be returned when the dialog is dismissed). </fsummary>
    <desc><p>Sets the path (the combined directory and filename that will be returned when the dialog is dismissed). 
      </p></desc>
  </func>
  
  <func>
    <name name="setWildcard" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif". </fsummary>
    <desc><p>Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif". 
      </p><p>Note that the native Motif dialog has some limitations with respect to wildcards; see the Remarks section above. 
      </p></desc>
  </func>
  </funcs>
</erlref>
