X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9704b2509ac4fd7b9fccd5299e0b377accb2b59e..9c72cf7619064969b5c7f59cece74013789db4cf:/docs/latex/wx/filesysh.tex diff --git a/docs/latex/wx/filesysh.tex b/docs/latex/wx/filesysh.tex index 95ba252f4a..34ca77ed22 100644 --- a/docs/latex/wx/filesysh.tex +++ b/docs/latex/wx/filesysh.tex @@ -18,6 +18,9 @@ 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 @@ -54,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: @@ -116,10 +119,10 @@ Example : GetRightLocation("file:myzipfile.zip\#zip:index.htm") == "index.htm" \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{wxfilesystemhandlerfindnext} @@ -127,7 +130,7 @@ This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} retu Returns next filename that matches parameters passed to \helpref{FindFirst}{wxfilesystemfindfirst}. -This method is only called if \helpref{CanOpen}{wxfilesystemhandlercanopen} 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}