X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/36edded90cf3d4d11dc55362b332733b79e8f54d..e31f4da5f0e888e3bae947061be02a427c570372:/docs/latex/wx/filesysh.tex?ds=inline diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index 03d37300be..34ca77ed22 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -16,6 +16,11 @@ GetAnchor, GetMimeTypeFromExt. Please have a look at \helpref{overview}{fs} if you don't know how locations are constructed. +Also consult \helpref{list of available handlers}{fs}. + +\perlnote{In wxPerl, you need to derive your file system handler class +from Wx::PlFileSystemHandler.} + \wxheading{Notes} \begin{itemize}\itemsep=0pt @@ -27,7 +32,11 @@ is always an {\bf absolute} path. You don't need to check the FS's current path. \wxheading{Derived from} -wxObject +\helpref{wxObject}{wxobject} + +\wxheading{Include files} + + \wxheading{See also} @@ -35,6 +44,9 @@ wxObject \helpref{wxFSFile}{wxfsfile}, \helpref{Overview}{fs} +\latexignore{\rtfignore{\wxheading{Members}}} + + \membersection{wxFileSystemHandler::wxFileSystemHandler}\label{wxfilesystemhandlerwxfilesystemhandler} \func{}{wxFileSystemHandler}{\void} @@ -45,7 +57,7 @@ Constructor. \func{virtual bool}{CanOpen}{\param{const wxString\& }{location}} -Returns TRUE if the handler is able to open this file. This function doesn't +Returns true if the handler is able to open this file. This function doesn't check whether the file exists or not, it only checks if it knows the protocol. Example: @@ -102,23 +114,23 @@ Returns the right location string extracted from {\it location}. Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm" -\membersection{wxFileSystemHandler::FindFirst}\label{wxfilesystemfindfirst} +\membersection{wxFileSystemHandler::FindFirst}\label{wxfilesystemhandlerfindfirst} \func{virtual 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). -This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns TRUE. +This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns true. -\membersection{wxFileSystemHandler::FindNext}\label{wxfilesystemfindnext} +\membersection{wxFileSystemHandler::FindNext}\label{wxfilesystemhandlerfindnext} \func{virtual wxString}{FindNext}{\void} Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}. -This method is only called if \helpref{CanRead}{wxfilesystemhandlercanread} returns TRUE and FindFirst +This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} returns true and FindFirst returned a non-empty string. \membersection{wxFileSystemHandler::OpenFile}\label{wxfilesystemhandleropenfile}