X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/22d6efa851642c6a69174278fc50f712f41e2271..8b2858410444b111cb192d1539ef6c76209091fd:/docs/latex/wx/filesys.tex diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 25eb6181c1..8c8b0f6215 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -5,19 +5,23 @@ \section{\class{wxFileSystem}}\label{wxfilesystem} -This class provides interface for opening files on different +This class provides an interface for opening files on different file systems. It can handle absolute and/or local filenames. -It uses system of \helpref{handlers}{wxfilesystemhandler} to +It uses a system of \helpref{handlers}{wxfilesystemhandler} to provide access to user-defined virtual file systems. \wxheading{Derived from} -wxObject +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + \wxheading{See Also} -\helpref{wxFileSystemHandler}{wxfilesystemhandler}, -\helpref{wxFSFile}{wxfsfile}, +\helpref{wxFileSystemHandler}{wxfilesystemhandler}, +\helpref{wxFSFile}{wxfsfile}, \helpref{Overview}{fs} \latexignore{\rtfignore{\wxheading{Members}}} @@ -28,36 +32,55 @@ wxObject Constructor. +\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler} + +\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}} + +This static function adds new handler into the list of handlers. +The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS. + +\wxheading{Note} + +You can call: + +\begin{verbatim} +wxFileSystem::AddHandler(new My_FS_Handler); +\end{verbatim} + +This is because (a) AddHandler is a static method, and (b) the handlers +are deleted in wxFileSystem's destructor so that you don't have to +care about it. + \membersection{wxFileSystem::ChangePathTo}\label{wxfilesystemchangepathto} -\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = FALSE}} +\func{void}{ChangePathTo}{\param{const wxString\& }{location}, \param{bool }{is\_dir = false}} Sets the current location. {\it location} parameter passed to \helpref{OpenFile}{wxfilesystemopenfile} is relative to this path. -{\bf Caution! } Unless {\it is\_dir} is TRUE the {\it location} parameter -is not directory name but the name of the file in this directory!! All these -commands change path to "dir/subdir/" : +{\bf Caution! } Unless {\it is\_dir} is true the {\it location} parameter +is not the directory name but the name of the file in this directory. All these +commands change the path to "dir/subdir/": \begin{verbatim} -ChangePathTo("dir/subdir/xh.htm"); -ChangePathTo("dir/subdir", TRUE); -ChangePathTo("dir/subdir/", TRUE); + ChangePathTo("dir/subdir/xh.htm"); + ChangePathTo("dir/subdir", true); + ChangePathTo("dir/subdir/", true); \end{verbatim} \wxheading{Parameters} -\docparam{location}{the new location. Its meaning depends on value of {\it is\_dir}} +\docparam{location}{the new location. Its meaning depends on the value of {\it is\_dir}} -\docparam{is\_dir}{if TRUE {\it location} is new directory. If FALSE (default) +\docparam{is\_dir}{if true {\it location} is new directory. If false (default) {\it location} is {\bf file in} the new directory.} \wxheading{Example} \begin{verbatim} -f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm' -fs -> ChangePathTo("subdir/folder", TRUE); -f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !! + f = fs -> OpenFile("hello.htm"); // opens file 'hello.htm' + fs -> ChangePathTo("subdir/folder", true); + f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !! \end{verbatim} \membersection{wxFileSystem::GetPath}\label{wxfilesystemgetpath} @@ -66,31 +89,50 @@ f = fs -> OpenFile("hello.htm"); // opens file 'subdir/folder/hello.htm' !! Returns actual path (set by \helpref{ChangePathTo}{wxfilesystemchangepathto}). +\membersection{wxFileSystem::FileNameToURL}\label{wxfilesystemfilenametourl} + +\func{static wxString}{FileNameToURL}{\param{wxFileName }{filename}} + +Converts filename into URL. + +\wxheading{See also} + +\helpref{wxFileSystem::URLToFileName}{wxfilesystemurltofilename}, +\helpref{wxFileName}{wxfilename} + +\membersection{wxFileSystem::FindFirst}\label{wxfilesystemfindfirst} + +\func{wxString}{FindFirst}{\param{const wxString\& }{wildcard}, \param{int }{flags = 0}} + +Works like \helpref{wxFindFirstFile}{wxfindfirstfile}. Returns name of the first +filename (within filesystem's current path) that matches {\it wildcard}. {\it flags} may be one of +wxFILE (only files), wxDIR (only directories) or 0 (both). + +\membersection{wxFileSystem::FindNext}\label{wxfilesystemfindnext} + +\func{wxString}{FindNext}{\void} + +Returns the next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}. + \membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile} \func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}} -Opens file and returns pointer to \helpref{wxFSFile}{wxfsfile} object +Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object or NULL if failed. It first tries to open the file in relative scope (based on value passed to ChangePathTo() method) and then as an -absolute path. +absolute path. Note that the user is responsible for deleting the returned +wxFSFile. -\membersection{wxFileSystem::AddHandler}\label{wxfilesystemaddhandler} +\membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename} -\func{static void}{AddHandler}{\param{wxFileSystemHandler }{*handler}} +\func{static wxFileName}{URLToFileName}{\param{const wxString\& }{url}} -This static function adds new handler into the list of handlers. -The \helpref{handlers}{wxfilesystemhandler} provide access to virtual FS. - -\wxheading{Note} +Converts URL into a well-formed filename. The URL must use the {\tt file} +protocol. -You can call: +\wxheading{See also} -\begin{verbatim} -wxFileSystem::AddHandler(new My_FS_Handler); -\end{verbatim} - -This is because (a) AddHandler is a static method, and (b) the handlers -are deleted in wxFileSystem's destructor so that you don't have to -care about it. +\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl}, +\helpref{wxFileName}{wxfilename}