[wxWidgets.git] / docs / latex / wx / fsfile.tex

%
% automatically generated by HelpGen from
% fsfile.tex at 21/Mar/99 23:00:52
%

\section{\class{wxFSFile}}\label{wxfsfile}

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
only as long as wxFSFile object exists. For example a call to GetStream()
doesn't {\it create} the stream but only returns the pointer to it. In
other words after 10 calls to GetStream() you will obtain ten identical
pointers.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/filesys.h>

\wxheading{See Also}

\helpref{wxFileSystemHandler}{wxfilesystemhandler}, 
\helpref{wxFileSystem}{wxfilesystem}, 
\helpref{Overview}{fs}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxFSFile::wxFSFile}\label{wxfsfilewxfsfile}

\func{}{wxFSFile}{\param{wxInputStream }{*stream}, \param{const wxString\& }{loc}, \param{const wxString\& }{mimetype}, \param{const wxString\& }{anchor}}

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

\wxheading{Parameters}

\docparam{stream}{The input stream that will be used to access data}

\docparam{location}{The full location (aka filename) of the file}

\docparam{mimetype}{MIME type of this file. Mime type is either extension-based or HTTP Content-Type}

\docparam{anchor}{Anchor. See \helpref{GetAnchor()}{wxfsfilegetanchor} for details.}

If you are not sure of the meaning of these params, see the description of the GetXXXX()
functions.

\wxheading{Notes}

It is seldom used by the application programmer but you will need it if
you are writing your own virtual FS. For example you may need something
similar to wxMemoryInputStream, but because wxMemoryInputStream
doesn't free the memory when destroyed and thus passing a memory stream
pointer into wxFSFile constructor would lead to memory leaks, you
can write your own class derived from wxFSFile:

\begin{verbatim}
class wxMyFSFile : public wxFSFile
{
    private:
        void *m_Mem;
    public:
        wxMyFSFile(.....)
	~wxMyFSFile() {free(m_Mem);}
	    // of course dtor is virtual ;-)
};
\end{verbatim}

\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}

\constfunc{const wxString\&}{GetAnchor}{\void}

Returns anchor (if present). The term of {\bf anchor} can be easily
explained using few examples:

\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}

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.

\membersection{wxFSFile::GetLocation}\label{wxfsfilegetlocation}

\constfunc{const wxString\&}{GetLocation}{\void}

Returns full location of the file, including path and protocol. 
Examples : 

\begin{verbatim}
http://www.wxwindows.org
http://www.ms.mff.cuni.cz/~vsla8348/wxhtml/archive.zip#zip:info.txt
file:/home/vasek/index.htm
relative-file.htm
\end{verbatim}

\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}

\constfunc{const wxString\&}{GetMimeType}{\void}

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.

\membersection{wxFSFile::GetModificationTime}\label{wxfsfilegetmodificationtime}

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