.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxFileSystem 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxFileSystem \- 
  Main interface for the virtual file system
 
.SH DESCRIPTION

  


   This class provides an interface for opening files on different file systems.
   It can handle absolute and/or local filenames. It uses a system of
   handlers
   to provide access to user-defined virtual file systems.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/filesys.h
.SH MEMBERS

  
.SS  wxFileSystem ()

     


      Constructor.
     
    
   
  
.SS static void AddHandler (wxFileSystemHandler *handler)

     


      This static function adds new handler into the list of handlers. The
      handlers
      provide access to virtual FS.
     
    
   
  
.SS void ChangePathTo (const wxString& locationbool is_dir = false)

     


      Sets the current location.
      
       location
      
      parameter passed to
      OpenFile
      is relative to this path.
     
     


      
       Caution!
      
      Unless
      
       is_dir
      
      is true the
      
       location
      
      parameter is not the directory name but the name of the file in this
      directory. All these commands change the path to "dir/subdir/":
     
     
  ChangePathTo("dir/subdir/xh.htm");
  ChangePathTo("dir/subdir", true);
  ChangePathTo("dir/subdir/", true);

    
   
  
.SS wxString GetPath ()

     


      Returns actual path (set by
      ChangePathTo
      ).
     
    
   
  
.SS static wxString FileNameToURL (wxFileName filename)

     


      Converts filename into URL.
     
    
   
  
.SS wxString FindFirst (const wxString& wildcardint flags = 0)

     


      Works like
      wxFindFirstFile
      . Returns name of the first filename (within filesystem's current path)
      that matches
      
       wildcard
      
      .
      
       flags
      
      may be one of wxFILE (only files), wxDIR (only directories) or 0 (both).
     
    
   
  
.SS wxString FindNext ()

     


      Returns the next filename that matches parameters passed to
      FindFirst
      .
     
    
   
  
.SS wxFSFile* OpenFile (const wxString& location)

     


      Opens the file and returns a pointer to a
      wxFSFile
      object or NULL if failed. It first tries to open the file in relative
      scope (based on value passed to ChangePathTo() method) and then as an
      absolute path. Note that the user is responsible for deleting the returned
      wxFSFile.
     
    
   
  
.SS static wxFileName URLToFileName (const wxString& url)

 
.SH "SEE ALSO"

  wxObject
 
  wxFileSystemHandler
   
  wxFSFile
   
  Overview
 
.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.