<?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>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxGenericDirCtrl</title>
</header>
<module>wxGenericDirCtrl</module>
<modulesummary>Functions for wxGenericDirCtrl class</modulesummary>
<description><p>This control can be used to place a directory listing (with optional files) on an arbitrary window.
      </p><p>The control contains a <seeerl marker="wxTreeCtrl"><c>wxTreeCtrl</c></seeerl> window representing the directory hierarchy, and optionally, a <seeerl marker="wxChoice"><c>wxChoice</c></seeerl> window containing a list of filters.
      </p><p>Styles</p><p>This class supports the following styles:
      </p>
  <p>This class is derived (and can use functions) from: 
    <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_generic_dir_ctrl.html">wxGenericDirCtrl</url></p>
  </description><section><title>Events</title><p>Event types emitted from this class: <seeerl marker="wxTreeEvent"><c>dirctrl_selectionchanged</c></seeerl>, <seeerl marker="wxTreeEvent"><c>dirctrl_fileactivated</c></seeerl></p></section>
<datatypes><datatype><name name="wxGenericDirCtrl"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <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>Main constructor. </fsummary>
    <desc><p>Main constructor. 
      </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="create" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>create/3</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>Create function for two-step construction. </fsummary>
    <desc><p>Create function for two-step construction. 
      </p><p>See <seemfa marker="#new/2"><c>new/2</c></seemfa> for details. 
      </p></desc>
  </func>
  
  <func>
    <name name="init" arity="1" clause_i="1" since=""/>
    <fsummary>Initializes variables. </fsummary>
    <desc><p>Initializes variables. 
      </p></desc>
  </func>
  
  <func>
    <name name="collapseTree" arity="1" clause_i="1" since=""/>
    <fsummary>Collapses the entire tree. </fsummary>
    <desc><p>Collapses the entire tree. 
      </p></desc>
  </func>
  
  <func>
    <name name="expandPath" arity="2" clause_i="1" since=""/>
    <fsummary>Tries to expand as much of the given <c>path</c> as possible, so that the filename or directory is visible in the tree control. </fsummary>
    <desc><p>Tries to expand as much of the given <c>path</c> as possible, so that the filename or directory is visible in the tree control. 
      </p></desc>
  </func>
  
  <func>
    <name name="getDefaultPath" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the default path. </fsummary>
    <desc><p>Gets the default path. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPath" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the currently-selected directory or filename. </fsummary>
    <desc><p>Gets the currently-selected directory or filename. 
      </p></desc>
  </func>
  
  <func>
    <name name="getPath" arity="2" clause_i="1" since=""/>
    <fsummary>Gets the path corresponding to the given tree control item. </fsummary>
    <desc><p>Gets the path corresponding to the given tree control item. 
      </p><p>Since: 2.9.5 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilePath" arity="1" clause_i="1" since=""/>
    <fsummary>Gets selected filename path only (else empty string). </fsummary>
    <desc><p>Gets selected filename path only (else empty string). 
      </p><p>This function doesn't count a directory as a selection. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilter" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the filter string. </fsummary>
    <desc><p>Returns the filter string. 
      </p></desc>
  </func>
  
  <func>
    <name name="getFilterIndex" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the current filter index (zero-based). </fsummary>
    <desc><p>Returns the current filter index (zero-based). 
      </p></desc>
  </func>
  
  <func>
    <name name="getRootId" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the root id for the tree control. </fsummary>
    <desc><p>Returns the root id for the tree control. 
      </p></desc>
  </func>
  
  <func>
    <name name="getTreeCtrl" arity="1" clause_i="1" since=""/>
    <fsummary>Returns a pointer to the tree control. </fsummary>
    <desc><p>Returns a pointer to the tree control. 
      </p></desc>
  </func>
  
  <func>
    <name name="reCreateTree" arity="1" clause_i="1" since=""/>
    <fsummary>Collapse and expand the tree, thus re-creating it from scratch. </fsummary>
    <desc><p>Collapse and expand the tree, thus re-creating it from scratch. 
      </p><p>May be used to update the displayed directory content. 
      </p></desc>
  </func>
  
  <func>
    <name name="setDefaultPath" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default path. </fsummary>
    <desc><p>Sets the default path. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFilter" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the filter string. </fsummary>
    <desc><p>Sets the filter string. 
      </p></desc>
  </func>
  
  <func>
    <name name="setFilterIndex" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the current filter index (zero-based). </fsummary>
    <desc><p>Sets the current filter index (zero-based). 
      </p></desc>
  </func>
  
  <func>
    <name name="setPath" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the current path. </fsummary>
    <desc><p>Sets the current path. 
      </p></desc>
  </func>
  </funcs>
</erlref>
