docs/latex/wx/fsfile.tex

   1 %
   2 % automatically generated by HelpGen from
   3 % fsfile.tex at 21/Mar/99 23:00:52
   4 %
   5
   6 \section{\class{wxFSFile}}\label{wxfsfile}
   7
   8 This class represents a single file opened by \helpref{wxFileSystem}{wxfilesystem}.
   9 It provides more information than wxWindow's input stream
  10 (stream, filename, mime type, anchor).
  11
  12 {\bf Note:} Any pointer returned by a method of wxFSFile is valid
  13 only as long as the wxFSFile object exists. For example a call to GetStream()
  14 doesn't {\it create} the stream but only returns the pointer to it. In
  15 other words after 10 calls to GetStream() you will have obtained ten identical
  16 pointers.
  17
  18 \wxheading{Derived from}
  19
  20 \helpref{wxObject}{wxobject}
  21
  22 \wxheading{Include files}
  23
  24 <wx/filesys.h>
  25
  26 \wxheading{See Also}
  27
  28 \helpref{wxFileSystemHandler}{wxfilesystemhandler},
  29 \helpref{wxFileSystem}{wxfilesystem},
  30 \helpref{Overview}{fs}
  31
  32 \latexignore{\rtfignore{\wxheading{Members}}}
  33
  34 \membersection{wxFSFile::wxFSFile}\label{wxfsfilewxfsfile}
  35
  36 \func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}, \param{wxDateTime }{modif}}
  37
  38 Constructor. You probably won't use it. See Notes for details.
  39
  40 \wxheading{Parameters}
  41
  42 \docparam{stream}{The input stream that will be used to access data}
  43
  44 \docparam{location}{The full location (aka filename) of the file}
  45
  46 \docparam{mimetype}{MIME type of this file. It may be left empty, in which
  47 case the type will be determined from file's extension (\arg{location} must
  48 not be empty in this case).}
  49
  50 \docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.}
  51
  52 If you are not sure of the meaning of these params, see the description of the GetXXXX()
  53 functions.
  54
  55 \wxheading{Notes}
  56
  57 It is seldom used by the application programmer but you will need it if
  58 you are writing your own virtual FS. For example you may need something
  59 similar to wxMemoryInputStream, but because wxMemoryInputStream
  60 doesn't free the memory when destroyed and thus passing a memory stream
  61 pointer into wxFSFile constructor would lead to memory leaks, you
  62 can write your own class derived from wxFSFile:
  63
  64 \begin{verbatim}
  65 class wxMyFSFile : public wxFSFile
  66 {
  67     private:
  68         void *m_Mem;
  69     public:
  70         wxMyFSFile(.....)
  71         ~wxMyFSFile() {free(m_Mem);}
  72             // of course dtor is virtual ;-)
  73 };
  74 \end{verbatim}
  75
  76 \membersection{wxFSFile::DetachStream}\label{wxfsfiledetachstream}
  77
  78 \func{void}{DetachStream}{\void}
  79
  80 Detaches the stream from the wxFSFile object. That is, the
  81 stream obtained with {\tt GetStream()} will continue its existance
  82 after the wxFSFile object is deleted. You will have to delete
  83 the stream yourself.
  84
  85 \membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
  86
  87 \constfunc{const wxString\&}{GetAnchor}{\void}
  88
  89 Returns anchor (if present). The term of {\bf anchor} can be easily
  90 explained using few examples:
  91
  92 \begin{verbatim}
  93 index.htm#anchor                      /* 'anchor' is anchor */
  94 index/wx001.htm                       /* NO anchor here!    */
  95 archive/main.zip#zip:index.htm#global /* 'global'           */
  96 archive/main.zip#zip:index.htm        /* NO anchor here!    */
  97 \end{verbatim}
  98
  99 Usually an anchor is presented only if the MIME type is 'text/html'.
 100 But it may have some meaning with other files;
 101 for example myanim.avi\#200 may refer to position in animation
 102 or reality.wrl\#MyView may refer to a predefined view in VRML.
 103
 104 \membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
 105
 106 \constfunc{const wxString\&}{GetLocation}{\void}
 107
 108 Returns full location of the file, including path and protocol.
 109 Examples :
 110
 111 \begin{verbatim}
 112 http://www.wxwidgets.org
 113 http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt
 114 file:/home/vasek/index.htm
 115 relative-file.htm
 116 \end{verbatim}
 117
 118 \membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}
 119
 120 \constfunc{const wxString\&}{GetMimeType}{\void}
 121
 122 Returns the MIME type of the content of this file. It is either
 123 extension-based (see wxMimeTypesManager) or extracted from
 124 HTTP protocol Content-Type header.
 125
 126 \membersection{wxFSFile::GetModificationTime}\label{wxfsfilegetmodificationtime}
 127
 128 \constfunc{wxDateTime}{GetModificationTime}{\void}
 129
 130 Returns time when this file was modified.
 131
 132 \membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}
 133
 134 \constfunc{wxInputStream*}{GetStream}{\void}
 135
 136 Returns pointer to the stream. You can use the returned
 137 stream to directly access data. You may suppose
 138 that the stream provide Seek and GetSize functionality
 139 (even in the case of the HTTP protocol which doesn't provide
 140 this by default. wxHtml uses local cache to work around
 141 this and to speed up the connection).
 142