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:
31
interface/wx/webfilehandler.h
Normal file
31
interface/wx/webfilehandler.h
Normal 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);
|
||||
};
|
Reference in New Issue
Block a user