[wxWidgets.git] / interface / wx / webviewfshandler.h

/////////////////////////////////////////////////////////////////////////////
// Name:        webviewfshandler.h
// Purpose:     interface of wxWebViewFSHandler
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxWebViewFSHandler

    A wxWebView file system handler to support standard wxFileSystem protocols
    of the form <code> example:page.htm </code> The handler allows wxWebView to
    use wxFileSystem in a similar fashion to its use with wxHtml.

    The wxMemoryFSHandler documentation gives an example of how it may be used.

    @since 2.9.5
    @library{wxwebview}
    @category{webview}

    @see wxWebView, wxWebViewHandler, wxWebViewArchiveHandler
 */
class wxWebViewFSHandler : public wxWebViewHandler
{
public:
    /**
        Constructor.
    */
    wxWebViewFSHandler(const wxString& scheme);
    virtual wxFSFile* GetFile(const wxString &uri);
};
Commit	Line	Data
81a887a8 DS	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: webviewfshandler.h
	3	// Purpose: interface of wxWebViewFSHandler
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxWebViewFSHandler
	11
	12	A wxWebView file system handler to support standard wxFileSystem protocols
	13	of the form <code> example:page.htm </code> The handler allows wxWebView to
	14	use wxFileSystem in a similar fashion to its use with wxHtml.
	15
	16	The wxMemoryFSHandler documentation gives an example of how it may be used.
	17
	18	@since 2.9.5
	19	@library{wxwebview}
	20	@category{webview}
	21
	22	@see wxWebView, wxWebViewHandler, wxWebViewArchiveHandler
	23	*/
	24	class wxWebViewFSHandler : public wxWebViewHandler
	25	{
	26	public:
	27	/**
	28	Constructor.
	29	*/
	30	wxWebViewFSHandler(const wxString& scheme);
	31	virtual wxFSFile* GetFile(const wxString &uri);
	32	};