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

... / ...

Commit	Line	Data
	1	%
	2	% automatically generated by HelpGen from
	3	% filesystem.tex at 21/Mar/99 23:00:52
	4	%
	5
	6	\section{\class{wxFileSystem}}\label{wxfilesystem}
	7
	8	This class provides an interface for opening files on different
	9	file systems. It can handle absolute and/or local filenames.
	10	It uses a system of \helpref{handlers}{wxfilesystemhandler} to
	11	provide access to user-defined virtual file systems.
	12
	13	\wxheading{Derived from}
	14
	15	\helpref{wxObject}{wxobject}
	16
	17	\wxheading{Include files}
	18
	19	<wx/filesys.h>
	20
	21	\wxheading{See Also}
	22
	23	\helpref{wxFileSystemHandler}{wxfilesystemhandler},
	24	\helpref{wxFSFile}{wxfsfile},
	25	\helpref{Overview}{fs}
	26
	27	\latexignore{\rtfignore{\wxheading{Members}}}
	28
	29
	30	\membersection{wxFileSystem::wxFileSystem}\label{wxfilesystemwxfilesystem}
	31
	32	\func{}{wxFileSystem}{\void}
	33
	34	Constructor.
	35
	36
	37	\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler}
	38
	39	\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}}
	40
	41	This static function adds new handler into the list of handlers.
	42	The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS.
	43
	44	\wxheading{Note}
	45
	46	You can call:
	47
	48	\begin{verbatim}
	49	wxFileSystem::AddHandler(new My_FS_Handler);
	50	\end{verbatim}
	51
	52	This is because (a) AddHandler is a static method, and (b) the handlers
	53	are deleted in wxFileSystem's destructor so that you don't have to
	54	care about it.
	55
	56
	57	\membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto}
	58
	59	\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = false}}
	60
	61	Sets the current location. {\it location} parameter passed to
	62	\helpref{OpenFile}{wxfilesystemopenfile} is relative to this path.
	63
	64	{\bf Caution! } Unless {\it is\_dir} is true the {\it location} parameter
	65	is not the directory name but the name of the file in this directory. All these
	66	commands change the path to "dir/subdir/":
	67
	68	\begin{verbatim}
	69	ChangePathTo("dir/subdir/xh.htm");
	70	ChangePathTo("dir/subdir", true);
	71	ChangePathTo("dir/subdir/", true);
	72	\end{verbatim}
	73
	74	\wxheading{Parameters}
	75
	76	\docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}}
	77
	78	\docparam{is\_dir}{if true {\it location} is new directory. If false (default)
	79	{\it location} is {\bf file in} the new directory.}
	80
	81	\wxheading{Example}
	82
	83	\begin{verbatim}
	84	f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm'
	85	fs -> ChangePathTo("subdir/folder", true);
	86	f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !!
	87	\end{verbatim}
	88
	89
	90	\membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath}
	91
	92	\func{wxString}{GetPath}{\void}
	93
	94	Returns actual path (set by \helpref{ChangePathTo}{wxfilesystemchangepathto}).
	95
	96
	97	\membersection{wxFileSystem::FileNameToURL}\label{wxfilesystemfilenametourl}
	98
	99	\func{static wxString}{FileNameToURL}{\param{wxFileName }{filename}}
	100
	101	Converts filename into URL.
	102
	103	\wxheading{See also}
	104
	105	\helpref{wxFileSystem::URLToFileName}{wxfilesystemurltofilename},
	106	\helpref{wxFileName}{wxfilename}
	107
	108
	109	\membersection{wxFileSystem::FindFileInPath}\label{wxfilesystemfindfileinpath}
	110
	111	\func{bool}{FindFileInPath}{\param{wxString }{str}, \param{const wxChar }{path}, \param{const wxChar }{*file}}
	112
	113	Looks for the file with the given name \arg{file} in a colon or semi-colon
	114	(depending on the current platform) separated list of directories in
	115	\arg{path}. If the file is found in any directory, returns \true and the full
	116	path of the file in \arg{str}, otherwise returns \false and doesn't modify
	117	\arg{str}.
	118
	119	\wxheading{Parameters}
	120
	121	\docparam{str}{Receives the full path of the file, must not be \NULL}
	122
	123	\docparam{path}{\texttt{wxPATH\_SEP}-separated list of directories}
	124
	125	\docparam{file}{the name of the file to look for}
	126
	127
	128	\membersection{wxFileSystem::FindFirst}\label{wxfilesystemfindfirst}
	129
	130	\func{wxString}{FindFirst}{\param{const wxString\& }{wildcard}, \param{int }{flags = 0}}
	131
	132	Works like \helpref{wxFindFirstFile}{wxfindfirstfile}. Returns name of the first
	133	filename (within filesystem's current path) that matches {\it wildcard}. {\it flags} may be one of
	134	wxFILE (only files), wxDIR (only directories) or 0 (both).
	135
	136
	137	\membersection{wxFileSystem::FindNext}\label{wxfilesystemfindnext}
	138
	139	\func{wxString}{FindNext}{\void}
	140
	141	Returns the next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}.
	142
	143
	144	\membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
	145
	146	\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
	147
	148	Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object
	149	or NULL if failed. It first tries to open the file in relative scope
	150	(based on value passed to ChangePathTo() method) and then as an
	151	absolute path. Note that the user is responsible for deleting the returned
	152	wxFSFile.
	153
	154
	155	\membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}
	156
	157	\func{static wxFileName}{URLToFileName}{\param{const wxString\& }{url}}
	158
	159	Converts URL into a well-formed filename. The URL must use the {\tt file}
	160	protocol.
	161
	162	\wxheading{See also}
	163
	164	\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl},
	165	\helpref{wxFileName}{wxfilename}
	166