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

/////////////////////////////////////////////////////////////////////////////
// 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);
};
Commit	Line	Data
42be0c56 SL	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: webfilehandler.h
	3	// Purpose: interface of wxWebFileHandler
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxWebFileHandler
	11
	12	A custom handler for the file scheme which also supports loading from
	13	archives. The syntax for wxWebFileHandler differs from virtual file
	14	systems in the rest of wxWidgets by using a syntax such as
	15	@c file:///C:/exmaple/docs.zip;protocol=zip/main.htm Currently the only
	16	supported protocol is @c zip.
	17
	18	@library{wxweb}
	19	@category{web}
	20
	21	@see wxWebView, wxWebHandler
	22	*/
	23	class wxWebFileHandler : public wxWebHandler
	24	{
	25	public:
	26	/**
	27	@return The string @c "file"
	28	*/
	29	virtual wxString GetName() const;
	30	virtual wxFSFile* GetFile(const wxString &uri);
	31	};