git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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 obtain 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}}
	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
	50	If you are not sure of the meaning of these params, see the description of the GetXXXX()
	51	functions.
	52
	53	\wxheading{Notes}
	54
	55	It is seldom used by the application programmer but you will need it if
	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
	59	pointer into wxFSFile constructor would lead to memory leaks, you
	60	can write your own class derived from wxFSFile:
	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
	74	\membersection{wxFSFile::GetAnchor}\label{wxfsfilegetanchor}
	75
	76	\constfunc{const wxString\&}{GetAnchor}{\void}
	77
	78	Returns anchor (if present). The term of {\bf anchor} can be easily
	79	explained using few examples:
	80
	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}
	87
	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.
	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
	107	\membersection{wxFSFile::GetMimeType}\label{wxfsfilegetmimetype}
	108
	109	\constfunc{const wxString\&}{GetMimeType}{\void}
	110
	111	Returns the MIME type of the content of this file. It is either
	112	extension-based (see wxMimeTypesManager) or extracted from
	113	HTTP protocol Content-Type header.
	114
	115	\membersection{wxFSFile::GetModificationTime}\label{wxfsfilegetmodificationtime}
	116
	117	\constfunc{wxDateTime}{GetModificationTime}{\void}
	118
	119	Returns time when this file was modified.
	120
	121	\membersection{wxFSFile::GetStream}\label{wxfsfilegetstream}
	122
	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
	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).
	131