Update docs to mention new filesystem handlers.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42805 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Michael Wetherell
2006-10-31 07:40:30 +00:00
parent dd21c82639
commit aa0ff209bc
4 changed files with 13 additions and 9 deletions

View File

@@ -58,10 +58,14 @@ There are {\bf two} protocols used in this example: "zip" and "file".
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 <wx/fs\_arc.h>. 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 <wx/fs\_filter.h>. 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 <wx/fs\_inet.h>.}
\twocolitem{{\bf wxZipFSHandler}}{A handler for ZIP archives.
Include file is <wx/fs\_zip.h>. URL is in form "archive.zip\#zip:filename".}
\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.

View File

@@ -47,7 +47,7 @@ a similar style to the Microsoft HTML Help viewer and using some of the same fil
Although it has an API compatible with other help controllers, it has more advanced features, so it is
recommended that you use the specific API for this class instead. Note that if you
use .zip or .htb formats for your books, you
must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
must add this line to your application initialization: {\tt wxFileSystem::AddHandler(new wxArchiveFSHandler);}
or nothing will be shown in your help window.
\end{itemize}

View File

@@ -115,8 +115,8 @@ different on most platforms)}
\wxheading{Note}
Don't forget to install wxFileSystem ZIP handler with
{\tt wxFileSystem::AddHandler(new wxZipFSHandler);} before calling this method
Don't forget to install the archive wxFileSystem handler with
{\tt wxFileSystem::AddHandler(new wxArchiveFSHandler);} before calling this method
on a .zip or .htb file!
\membersection{wxHtmlHelpController::CreateHelpDialog}\label{wxhtmlhelpcontrollercreatehelpdialog}

View File

@@ -36,7 +36,7 @@ These are the typical steps for using XRC files in your application.
\begin{itemize}\itemsep=0pt
\item Include the appropriate headers: normally "wx/xrc/xmlres.h" will suffice;
\item If you are going to use \helpref{XRS files}{binaryresourcefiles}, install
wxFileSystem ZIP handler first with {\tt wxFileSystem::AddHandler(new wxZipFSHandler);}
wxFileSystem archive handler first with {\tt wxFileSystem::AddHandler(new wxArchiveFSHandler);}
\item call {\tt wxXmlResource::Get()->InitAllHandlers()} from your wxApp::OnInit function,
and then call {\tt wxXmlResource::Get()->Load("myfile.xrc")} to load the resource file;
\item to create a dialog from a resource, create it using the default constructor, and then
@@ -97,14 +97,14 @@ For example:
XRS file is essentially a renamed ZIP archive which means that you can manipulate
it with standard ZIP tools. Note that if you are using XRS files, you have
to initialize the \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple
to initialize the \helpref{wxFileSystem}{wxfilesystem} archive handler first! It is a simple
thing to do:
\begin{verbatim}
#include <wx/filesys.h>
#include <wx/fs_zip.h>
#include <wx/fs_arc.h>
...
wxFileSystem::AddHandler(new wxZipFSHandler);
wxFileSystem::AddHandler(new wxArchiveFSHandler);
\end{verbatim}
\subsection{Using embedded resources}\label{embeddedresource}