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

  


   This class represents a single file opened by
   wxFileSystem
   . It provides more information than wxWindow's input stream (stream,
   filename, mime type, anchor).
  
  


   
    Note:
   
   Any pointer returned by a method of wxFSFile is valid only as long as the
   wxFSFile object exists. For example a call to GetStream() doesn't
   
    create
   
   the stream but only returns the pointer to it. In other words after 10 calls
   to GetStream() you will obtain ten identical pointers.
  
 
.SH "PARENTS"

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

  
.SS  wxFSFile (wxInputStream *streamconst wxString& locconst wxString& mimetypeconst wxString& anchorwxDateTime modif)

     


      Constructor. You probably won't use it. See Notes for details.
     
     


      If you are not sure of the meaning of these params, see the description of
      the GetXXXX() functions.
     
    
   
  
.SS const wxString& GetAnchor ()

     


      Returns anchor (if present). The term of
      
       anchor
      
      can be easily explained using few examples:
     
     
index.htm#anchor                      /* 'anchor' is anchor */
index/wx001.htm                       /* NO anchor here!    */
archive/main.zip#zip:index.htm#global /* 'global'           */
archive/main.zip#zip:index.htm        /* NO anchor here!    */

     


      Usually an anchor is presented only if the MIME type is 'text/html'. But
      it may have some meaning with other files; for example myanim.avi#200 may
      refer to position in animation or reality.wrl#MyView may refer to a
      predefined view in VRML.
     
    
   
  
.SS const wxString& GetLocation ()

     


      Returns full location of the file, including path and protocol. Examples :
     
     
http://www.wxwidgets.org
http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt
file:/home/vasek/index.htm
relative-file.htm

    
   
  
.SS const wxString& GetMimeType ()

     


      Returns the MIME type of the content of this file. It is either
      extension-based (see wxMimeTypesManager) or extracted from HTTP protocol
      Content-Type header.
     
    
   
  
.SS wxDateTime GetModificationTime ()

     


      Returns time when this file was modified.
     
    
   
  
.SS wxInputStream* GetStream ()

     


      Returns pointer to the stream. You can use the returned stream to directly
      access data. You may suppose that the stream provide Seek and GetSize
      functionality (even in the case of the HTTP protocol which doesn't provide
      this by default. wxHtml uses local cache to work around this and to speed
      up the connection).
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxFileSystemHandler
   
  wxFileSystem
   
  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.