X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/fs.tex diff --git a/docs/latex/wx/fs.tex b/docs/latex/wx/fs.tex index 21821955f6..5182260814 100644 --- a/docs/latex/wx/fs.tex +++ b/docs/latex/wx/fs.tex @@ -18,7 +18,7 @@ Its main methods are ChangePathTo() and OpenFile(). This class is most often used by the end user. \item The \helpref{wxFileSystemHandler}{wxfilesystemhandler} is the core of virtual file systems mechanism. You can derive your own handler and pass it to -of the VFS mechanism. You can derive your own handler and pass it to +the VFS mechanism. You can derive your own handler and pass it to wxFileSystem's AddHandler() method. In the new handler you only need to override the OpenFile() and CanOpen() methods. \end{itemize} @@ -31,7 +31,7 @@ Locations (aka filenames aka addresses) are constructed from four parts: \item {\bf protocol} - handler can recognize if it is able to open a file by checking its protocol. Examples are "http", "file" or "ftp". \item {\bf right location} - is the name of file within the protocol. -In "http://www.wxwindows.org/index.html" the right location is "//www.wxwindows.org/index.html". +In "http://www.wxwidgets.org/index.html" the right location is "//www.wxwidgets.org/index.html". \item {\bf anchor} - an anchor is optional and is usually not present. In "index.htm\#chapter2" the anchor is "chapter2". \item {\bf left location} - this is usually an empty string. @@ -43,40 +43,33 @@ See Combined Protocols paragraph for details. The left location precedes the protocol in the URL string. It is not used by global protocols like HTTP but it becomes handy when nesting -protocols - for example you may want to access files in ZIP archive that is -located on some FTP server: - -ftp:ftp.archives.org/pub/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax - -In fact, you have to use 'left location' even when accessing local ZIPs: +protocols - for example you may want to access files in a ZIP archive: file:archives/cpp\_doc.zip\#zip:reference/fopen.htm\#syntax -In this example, the protocol is "zip", the left location is -"reference/fopen.htm", the anchor is "syntax" and the right location +In this example, the protocol is "zip", right location is +"reference/fopen.htm", anchor is "syntax" and left location is "file:archives/cpp\_doc.zip". There are {\bf two} protocols used in this example: "zip" and "file". -You can construct even more complicated addresses like this one: - -http://www.archives.org/myarchive.zip\#zip:local/docs/cpp/stdio.zip\#zip:index.htm - -In this example you access zip virtual file system stdio.zip stored in another zip (myarchive.zip) -which can be found at WWW. \wxheading{File Systems Included in wxHTML} -The following virtual file system handlers are part of wxWindows so far: +The following virtual file system handlers are part of wxWidgets so far: \begin{twocollist} +\twocolitem{{\bf wxArchiveFSHandler}}{A handler for archives such as zip +and tar. Include file is . URLs examples: +"archive.zip\#zip:filename", "archive.tar.gz\#gzip:\#tar:filename".} +\twocolitem{{\bf wxFilterFSHandler}}{A handler for compression schemes such +as gzip. Header is . URLs are in the form, e.g.: +"document.ps.gz\#gzip:".} \twocolitem{{\bf wxInternetFSHandler}}{A handler for accessing documents -via HTTP or FTP protocols. Include file is .} -\twocolitem{{\bf wxZipFSHandler}}{A handler for ZIP archives. -Include file is . URL is in form "archive.zip\#zip:filename".} +via HTTP or FTP protocols. Include file is .} \twocolitem{{\bf wxMemoryFSHandler}}{This handler allows you to access data stored in memory (such as bitmaps) as if they were regular files. See \helpref{wxMemoryFSHandler documentation}{wxmemoryfshandler} for details. -Include file is . UURL is prefixed with memory:, e.g. +Include file is . URL is prefixed with memory:, e.g. "memory:myfile.htm"} \end{twocollist}