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

/////////////////////////////////////////////////////////////////////////////
// Name:        webviewarchivehandler.h
// Purpose:     interface of wxWebViewArchiveHandler
// Author:      wxWidgets team
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxWebViewArchiveHandler

    A custom handler for the file scheme which also supports loading from
    archives. The syntax for wxWebViewArchiveHandler differs from virtual file
    systems in the rest of wxWidgets by using a syntax such as
    <code> scheme:///C:/example/docs.zip;protocol=zip/main.htm </code>
    Currently the only supported protocol is @c zip.

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

    @see wxWebView, wxWebViewHandler
 */
class wxWebViewArchiveHandler : public wxWebViewHandler
{
public:
    /**
        Constructor.
    */
    wxWebViewArchiveHandler(const wxString& scheme);
    virtual wxFSFile* GetFile(const wxString &uri);
};
Commit	Line	Data
42be0c56	1	/////////////////////////////////////////////////////////////////////////////
43d53ee5	2	// Name: webviewarchivehandler.h
7d8d6163	3	// Purpose: interface of wxWebViewArchiveHandler
42be0c56	4	// Author: wxWidgets team
42be0c56 SL	5	// Licence: wxWindows licence
	6	/////////////////////////////////////////////////////////////////////////////
	7
	8	/**
7d8d6163	9	@class wxWebViewArchiveHandler
34326da7 SL	10
	11	A custom handler for the file scheme which also supports loading from
	12	archives. The syntax for wxWebViewArchiveHandler differs from virtual file
42be0c56	13	systems in the rest of wxWidgets by using a syntax such as
f090e4ef	14	<code> scheme:///C:/example/docs.zip;protocol=zip/main.htm </code>
34326da7 SL	15	Currently the only supported protocol is @c zip.
34326da7 SL	16
b2b31b87	17	@since 2.9.3
43d53ee5 SL	18	@library{wxwebview}
43d53ee5 SL	19	@category{webview}
34326da7	20
7d8d6163	21	@see wxWebView, wxWebViewHandler
42be0c56	22	*/
7d8d6163	23	class wxWebViewArchiveHandler : public wxWebViewHandler
42be0c56 SL	24	{
	25	public:
	26	/**
7d8d6163	27	Constructor.
42be0c56	28	*/
7d8d6163	29	wxWebViewArchiveHandler(const wxString& scheme);
42be0c56	30	virtual wxFSFile* GetFile(const wxString &uri);
f090e4ef	31	};