X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/36edded90cf3d4d11dc55362b332733b79e8f54d..d3e78bab3ea46183c22a5f0484b931a99b897636:/docs/latex/wx/filesys.tex?ds=sidebyside diff --git a/docs/latex/wx/filesys.tex b/docs/latex/wx/filesys.tex index 6ff0524b18..92ae14e6bd 100644 --- a/docs/latex/wx/filesys.tex +++ b/docs/latex/wx/filesys.tex @@ -12,7 +12,11 @@ provide access to user-defined virtual file systems. \wxheading{Derived from} -wxObject +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + \wxheading{See Also} @@ -49,34 +53,34 @@ 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); +C hangePathTo("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} @@ -85,28 +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 (withing filesystem's current path) that matches {\it wildcard}. {\it flags} may be one of +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 next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}. - +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::URLToFileName}\label{wxfilesystemurltofilename} + +\func{static wxFileName}{URLToFileName}{\param{const wxString\& }{url}} + +Converts URL into a well-formed filename. The URL must use the {\tt file} +protocol. + +\wxheading{See also} + +\helpref{wxFileSystem::FileNameToURL}{wxfilesystemfilenametourl}, +\helpref{wxFileName}{wxfilename}