.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxGenericDirCtrl 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxGenericDirCtrl \- 
  A control for displaying a directory tree
 
.SH DESCRIPTION

  


   This control can be used to place a directory listing (with optional files)
   on an arbitrary window.
  
  


   The control contains a
   wxTreeCtrl
   window representing the directory hierarchy, and optionally, a
   wxChoice
   window containing a list of filters.
  
 
.SH "PARENTS"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/dirctrl.h
.SH MEMBERS

  
.SS  wxGenericDirCtrl ()

     


      Default constructor.
     
    
.SS  wxGenericDirCtrl (wxWindow* parentconst wxWindowID id = -1const wxString& dir = wxDirDialogDefaultFolderStrconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDERconst wxString& filter = wxEmptyStringint defaultFilter = 0const wxString& name = wxTreeCtrlNameStr)

     


      Main constructor.
     
    
   
  
.SS  ~wxGenericDirCtrl ()

     


      Destructor.
     
    
   
  
.SS bool Create (wxWindow* parentconst wxWindowID id = -1const wxString& dir = wxDirDialogDefaultFolderStrconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDERconst wxString& filter = wxEmptyStringint defaultFilter = 0const wxString& name = wxTreeCtrlNameStr)

     


      Create function for two-step construction. See
      wxGenericDirCtrl::wxGenericDirCtrl
      for details.
     
    
   
  
.SS void Init ()

     


      Initializes variables.
     
    
   
  
.SS void CollapseTree ()

     


      Collapses the entire tree.
     
    
   
  
.SS bool ExpandPath (const wxString& path)

     


      Tries to expand as much of the given path as possible, so that the
      filename or directory is visible in the tree control.
     
    
   
  
.SS wxString GetDefaultPath ()

     


      Gets the default path.
     
    
   
  
.SS wxString GetPath ()

     


      Gets the currently-selected directory or filename.
     
    
   
  
.SS wxString GetFilePath ()

     


      Gets selected filename path only (else empty string).
     
     


      This function doesn't count a directory as a selection.
     
    
   
  
.SS wxString GetFilter ()

     


      Returns the filter string.
     
    
   
  
.SS int GetFilterIndex ()

     


      Returns the current filter index (zero-based).
     
    
   
  
.SS wxDirFilterListCtrl* GetFilterListCtrl ()

     


      Returns a pointer to the filter list control (if present).
     
    
   
  
.SS wxTreeItemId GetRootId ()

     


      Returns the root id for the tree control.
     
    
   
  
.SS wxTreeCtrl* GetTreeCtrl ()

     


      Returns a pointer to the tree control.
     
    
   
  
.SS void ReCreateTree ()

     


      Collapse and expand the tree, thus re-creating it from scratch. May be
      used to update the displayed directory content.
     
    
   
  
.SS void SetDefaultPath (const wxString& path)

     


      Sets the default path.
     
    
   
  
.SS void SetFilter (const wxString& filter)

     


      Sets the filter string.
     
    
   
  
.SS void SetFilterIndex (int n)

     


      Sets the current filter index (zero-based).
     
    
   
  
.SS void SetPath (const wxString& path)

     


      Sets the current path.
     
    
 
.SH "WINDOW STYLES"

.SH "SEE ALSO"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.