X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/11b63f34f8c2a08e9b5246f7239792fb22048d97..3ce369e6876c49ad7a101ad222048bd5446b7125:/docs/latex/wx/fsfile.tex diff --git a/docs/latex/wx/fsfile.tex b/docs/latex/wx/fsfile.tex index 0fcebe2c44..14b54ccd7d 100644 --- a/docs/latex/wx/fsfile.tex +++ b/docs/latex/wx/fsfile.tex @@ -3,7 +3,6 @@ % fsfile.tex at 21/Mar/99 23:00:52 % - \section{\class{wxFSFile}}\label{wxfsfile} This class represents single file opened by \helpref{wxFileSystem}{wxfilesystem}. @@ -68,24 +67,24 @@ class wxMyFSFile : public wxFSFile }; \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} @@ -101,22 +100,22 @@ file:/home/vasek/index.htm 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::GetStream}\label{wxfsfilegetstream} -\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{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)