Add documentation for virtual file system support in wxWebView.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/branches/SOC2011_WEBVIEW@68523 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Steve Lamerton
2011-08-04 18:46:49 +00:00
parent e6db07c3ef
commit 42be0c562b
2 changed files with 77 additions and 0 deletions

View File

@@ -0,0 +1,31 @@
/////////////////////////////////////////////////////////////////////////////
// Name: webfilehandler.h
// Purpose: interface of wxWebFileHandler
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxWebFileHandler
A custom handler for the file scheme which also supports loading from
archives. The syntax for wxWebFileHandler differs from virtual file
systems in the rest of wxWidgets by using a syntax such as
@c file:///C:/exmaple/docs.zip;protocol=zip/main.htm Currently the only
supported protocol is @c zip.
@library{wxweb}
@category{web}
@see wxWebView, wxWebHandler
*/
class wxWebFileHandler : public wxWebHandler
{
public:
/**
@return The string @c "file"
*/
virtual wxString GetName() const;
virtual wxFSFile* GetFile(const wxString &uri);
};