% fsfile.tex at 21/Mar/99 23:00:52
%
-
\section{\class{wxFSFile}}\label{wxfsfile}
-This class represents single file opened by \helpref{wxFileSystem}{wxfilesystem}.
-It provides more information than wx's input stream
+This class represents a single file opened by \helpref{wxFileSystem}{wxfilesystem}.
+It provides more information than wxWindow's input stream
(stream, filename, mime type, anchor).
{\bf Note:} Any pointer returned by wxFSFile's member is valid
\wxheading{Derived from}
-wxObject
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/filesys.h>
\wxheading{See Also}
};
\end{verbatim}
-\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}
-
-\constfunc{wxInputStream*}{GetStream}{\void}
+\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
-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 case of HTTP protocol which doesn't provide
-this by default. wxHtml is using local cache to workaround
-this and to speed up connection)
+\constfunc{const wxString\&}{GetAnchor}{\void}
-\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}
+Returns anchor (if present). The term of {\bf anchor} can be easily
+explained using few examples:
-\constfunc{const wxString\&}{GetMimeType}{\void}
+\begin{verbatim}
+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! */
+\end{verbatim}
-Returns MIME type of the content of this file. It is either
-extension-based (see wxMimeTypesManager) or extracted from
-HTTP protocol Content-Type header.
+Usually anchor is presented only if 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 predefined view in VRML)
\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}
relative-file.htm
\end{verbatim}
+\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}
-\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
+\constfunc{const wxString\&}{GetMimeType}{\void}
-\constfunc{const wxString\&}{GetAnchor}{\void}
+Returns MIME type of the content of this file. It is either
+extension-based (see wxMimeTypesManager) or extracted from
+HTTP protocol Content-Type header.
-Returns anchor (if present). The term of {\bf anchor} can be easily
-explained using few examples:
+\membersection{wxFSFile::GetModificationTime}\label{wxfsfilegetmodificationtime}
-\begin{verbatim}
-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! */
-\end{verbatim}
+\constfunc{wxDateTime}{GetModificationTime}{\void}
+
+Returns time when this file was modified.
+
+\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}
+
+\constfunc{wxInputStream*}{GetStream}{\void}
+
+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 case of HTTP protocol which doesn't provide
+this by default. wxHtml is using local cache to workaround
+this and to speed up connection)
-Usually anchor is presented only if 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 predefined view in VRML)