<?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>wxDirPickerCtrl</title>
</header>
<module>wxDirPickerCtrl</module>
<modulesummary>Functions for wxDirPickerCtrl class</modulesummary>
<description><p>This control allows the user to select a directory. The generic implementation is a button which brings up a <seeerl marker="wxDirDialog"><c>wxDirDialog</c></seeerl> when clicked. Native implementation may differ but this is usually a (small) widget which give access to the dir-chooser dialog. It is only available if <c>wxUSE_DIRPICKERCTRL</c> is set to 1 (the default).
      </p><p>Styles</p><p>This class supports the following styles:
      </p><p>See: <seeerl marker="wxDirDialog"><c>wxDirDialog</c></seeerl>, <seeerl marker="wxFileDirPickerEvent"><c>wxFileDirPickerEvent</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxPickerBase"><c>wxPickerBase</c></seeerl> <seeerl marker="wxControl"><c>wxControl</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_dir_picker_ctrl.html">wxDirPickerCtrl</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxFileDirPickerEvent"><c>command_dirpicker_changed</c></seeerl></p></section>
<datatypes><datatype><name name="wxDirPickerCtrl"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>new/3</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>Initializes the object and calls <c>create/4</c> with all the parameters. </fsummary>
    <desc><p>Initializes the object and calls <seemfa marker="#create/4"><c>create/4</c></seemfa> with all the parameters. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>See: <c>create/4</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="4" clause_i="1" since=""/>
    <fsummary>Creates the widgets with the given parameters. </fsummary>
    <desc><p>Creates the widgets with the given parameters. 
      </p><p>Return: true if the control was successfully created or false if creation failed. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPath" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the absolute path of the currently selected directory. </fsummary>
    <desc><p>Returns the absolute path of the currently selected directory. 
      </p></desc>
  </func>
  
  <func>
    <name name="setPath" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the absolute path of the currently selected directory. </fsummary>
    <desc><p>Sets the absolute path of the currently selected directory. 
      </p><p>If the control uses <c>wxDIRP_DIR_MUST_EXIST</c> and does not use <c>wxDIRP_USE_TEXTCTRL</c> style, the <c>dirname</c> must be a name of an existing directory and will be simply ignored by the native wxGTK implementation if this is not the case. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor</fsummary>
    <desc><p>Destroys the object.</p></desc>
  </func>
  </funcs>
</erlref>
