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

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

/**
    Zoom levels availiable in wxWebView
*/
enum wxWebViewZoom
{
    wxWEB_VIEW_ZOOM_TINY,
    wxWEB_VIEW_ZOOM_SMALL,
    wxWEB_VIEW_ZOOM_MEDIUM, //!< default size
    wxWEB_VIEW_ZOOM_LARGE,
    wxWEB_VIEW_ZOOM_LARGEST
};

/**
    The type of zooming that the web view control can perform
*/
enum wxWebViewZoomType
{
    /** 
        The entire layout scales when zooming, including images 
    */
    wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
    /** 
        Only the text changes in size when zooming, images and other layout
        elements retain their initial size 
    */
    wxWEB_VIEW_ZOOM_TYPE_TEXT
};

/** 
    Types of errors that can cause navigation to fail
*/
enum wxWebNavigationError
{
    /** Connection error (timeout, etc.) */
    wxWEB_NAV_ERR_CONNECTION,
    /** Invalid certificate */
    wxWEB_NAV_ERR_CERTIFICATE,
    /** Authentication required */
    wxWEB_NAV_ERR_AUTH,
    /** Other security error */
    wxWEB_NAV_ERR_SECURITY,
    /** Requested resource not found */
    wxWEB_NAV_ERR_NOT_FOUND,
    /** Invalid request/parameters (e.g. bad URL, bad protocol,
        unsupported resource type) */
    wxWEB_NAV_ERR_REQUEST,
    /** The user cancelled (e.g. in a dialog) */
    wxWEB_NAV_ERR_USER_CANCELLED,
    /** Another (exotic) type of error that didn't fit in other categories*/
    wxWEB_NAV_ERR_OTHER
};

/** 
    Type of refresh 
*/
enum wxWebViewReloadFlags
{
    /** Default reload, will access cache */
    wxWEB_VIEW_RELOAD_DEFAULT,
    /** Reload the current view without accessing the cache */
    wxWEB_VIEW_RELOAD_NO_CACHE 
};


/**
 * List of available backends for wxWebView
 */
enum wxWebViewBackend
{
    /** Value that may be passed to wxWebView to let it pick an appropriate
     * engine for the current platform*/
    wxWEB_VIEW_BACKEND_DEFAULT,

    /** The WebKit web engine */
    wxWEB_VIEW_BACKEND_WEBKIT,

    /** Use Microsoft Internet Explorer as web engine */
    wxWEB_VIEW_BACKEND_IE
};

/**
    @class wxWebHistoryItem
  
    A simple class that contains the URL and title of an element of the history
    of a wxWebView. 
   
    @library{wxweb}
    @category{web}
    
    @see wxWebView
 */
class wxWebHistoryItem
{
public:
    /**
        Construtor.
    */
    wxWebHistoryItem(const wxString& url, const wxString& title);
    
    /**
        @return The url of the page.
    */
    wxString GetUrl();
    
    /**
        @return The title of the page.
    */
    wxString GetTitle();
};

/**
    @class wxWebView
  
    This control may be used to render web (HTML / CSS / javascript) documents.
    Capabilities of the HTML renderer will depend upon the backed.

    @c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which 
    is also used by Internet Explorer. It is important to note that by default 
    it emulates Internet Explorer 7, this can be chaged with a registry 
    setting, see 
    <a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
    this</a> article for more information.
  
    Note that errors are generally reported asynchronously though the
    @c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
  
    @beginEventEmissionTable{wxWebNavigationEvent}
    @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
       to get a resource. This event may be vetoed to prevent navigating to this
       resource. Note that if the displayed HTML document has several frames, one
       such event will be generated per frame.
    @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
       confirmed that a resource would be requested. This event may not be vetoed.
       Note that if the displayed HTML document has several frames, one such event
       will be generated per frame.
    @event{EVT_WEB_VIEW_LOADED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
       is fully loaded and displayed. Note that if the displayed HTML document has 
       several frames, one such event will be generated per frame.
    @event{EVT_WEB_VIEW_ERRROR(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
       error occurs.
       The integer associated with this event will be a wxWebNavigationError item.
       The string associated with this event may contain a backend-specific more
       precise error message/code.
    @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
       window is created. You must handle this event if you want anything to 
       happen, for example to load the page in a new window or tab.
    @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when 
       the page title changes. Use GetString to get the title.
    @endEventTable
   
    @library{wxweb}
    @category{ctrl,web}
 */
class wxWebView : public wxControl
{
public:

    /**
        Creation function for two-step creation.
    */
    virtual bool Create(wxWindow* parent,
                        wxWindowID id,
                        const wxString& url,
                        const wxPoint& pos,
                        const wxSize& size,
                        long style,
                        const wxString& name) = 0;

    /**
        Factory function to create a new wxWebView for two-step creation
        (you need to call wxWebView::Create on the returned object)
        @param backend which web engine to use as backend for wxWebView
        @return the created wxWebView, or NULL if the requested backend is
                not available
     */
    static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);

    /**
        Factory function to create a new wxWebView
        @param parent parent window to create this view in
        @param id ID of this control
        @param url URL to load by default in the web view
        @param pos position to create this control at
               (you may use wxDefaultPosition if you use sizers)
        @param size size to create this control with
               (you may use wxDefaultSize if you use sizers)
        @param backend which web engine to use as backend for wxWebView
        @return the created wxWebView, or NULL if the requested backend
                is not available
    */
    static wxWebView* New(wxWindow* parent,
           wxWindowID id,
           const wxString& url = wxWebViewDefaultURLStr,
           const wxPoint& pos = wxDefaultPosition,
           const wxSize& size = wxDefaultSize,
           wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
           long style = 0,
           const wxString& name = wxWebViewNameStr);

    /**
        Get the title of the current web page, or its URL/path if title is not
        available.
    */
    virtual wxString GetCurrentTitle() = 0;

   /**
        Get the URL of the currently displayed document.
    */
    virtual wxString GetCurrentURL() = 0;

    /**
        Get the HTML source code of the currently displayed document.
        @return The HTML source code, or an empty string if no page is currently
                shown.
    */
    virtual wxString GetPageSource() = 0;
    
    /**
        Get the text of the current page.
    */
    virtual wxString GetPageText() = 0;
    
    /**
        Returns whether the web control is currently busy (e.g. loading a page).
    */
    virtual bool IsBusy() = 0;

    /**
        Returns whether the web control is currently editable
    */
    virtual bool IsEditable() = 0;

    /**
        Load a web page from a URL
        @param url The URL of the page to be loaded.
        @note Web engines generally report errors asynchronously, so if you wish
            to know whether loading the URL was successful, register to receive
            navigation error events.
    */
    virtual void LoadUrl(const wxString& url) = 0;

    /**
        Opens a print dialog so that the user may print the currently
        displayed page.
    */
    virtual void Print() = 0;

    /**
        Reload the currently displayed URL.
        @param flags A bit array that may optionally contain reload options.
    */
    virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
    
    /**
        Runs the given javascript code. 
    */
    virtual void RunScript(const wxString& javascript) = 0;
    
    /**
        Set the editable property of the web control. Enabling allows the user
        to edit the page even if the @c contenteditable attribute is not set.
        The exact capabilities vary with the backend being used.
    */
    virtual void SetEditable(bool enable = true) = 0;

    /**
        Set the displayed page source to the contents of the given string.
        @param html    The string that contains the HTML data to display.
        @param baseUrl URL assigned to the HTML data, to be used to resolve
                    relative paths, for instance.
    */
    virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;

    /**
        Set the displayed page source to the contents of the given stream.
        @param html    The stream to read HTML data from.
        @param baseUrl URL assigned to the HTML data, to be used to resolve
                    relative paths, for instance.
    */
    virtual void SetPage(wxInputStream& html, wxString baseUrl);

    /**
        Stop the current page loading process, if any.
        May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
        TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
    */
    virtual void Stop() = 0;

    /**
        @name Clipboard
    */

    /**
        Returns @true if the current selection can be copied.
    */
    virtual bool CanCopy() = 0;

    /**
        Returns @true if the current selection can be cut.
    */
    virtual bool CanCut() = 0;

    /**
        Returns @true if data can be pasted.
    */
    virtual bool CanPaste() = 0;

    /**
        Copies the current selection. 
    */
    virtual void Copy() = 0;

    /**
        Cuts the current selection.
    */
    virtual void Cut() = 0;

    /**
        Pastes the current data.
    */
    virtual void Paste() = 0;

    /**
        @name History
    */

    /** 
        Returns @true if it is possible to navigate backward in the history of
        visited pages.
    */
    virtual bool CanGoBack() = 0;

    /** 
        Returns @true if it is possible to navigate forward in the history of
        visited pages.
    */
    virtual bool CanGoForward() = 0;

    /**
        Clear the history, this will also remove the visible page.
    */
    virtual void ClearHistory() = 0;

    /**
        Enable or disable the history. This will also clear the history.
    */
    virtual void EnableHistory(bool enable = true) = 0;

    /**
        Returns a list of items in the back history. The first item in the
        vector is the first page that was loaded by the control.
    */
    virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;

    /**
        Returns a list of items in the forward history. The first item in the 
        vector is the next item in the history with respect to the curently 
        loaded page.
    */
    virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;

    /** 
        Navigate back in the history of visited pages.
        Only valid if CanGoBack() returns true.
    */
    virtual void GoBack() = 0;

    /**
        Navigate forward in the history of visited pages.
        Only valid if CanGoForward() returns true.
    */
    virtual void GoForward() = 0;

    /**
        Loads a history item. 
    */
    virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
    
    /**
        @name Selection
    */
    
    /**
        Clears the current selection. 
    */
    virtual void ClearSelection() = 0;
    
    /**
        Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
        the selection must be editable, either through SetEditable or the 
        correct HTML attribute.
    */
    virtual void DeleteSelection() = 0;
    
    /**
        Returns the currently selected source, if any.
    */
    virtual wxString GetSelectedSource() = 0;
    
    /**
        Returns the currently selected text, if any.
    */
    virtual wxString GetSelectedText() = 0;

    /**
        Returns @true if there is a current selection.
    */
    virtual bool HasSelection() = 0;

    /**
        Selects the entire page.
    */
    virtual void SelectAll() = 0;

    /**
        @name Undo / Redo
    */

    /**
        Returns @true if there is an action to redo.
    */
    virtual bool CanRedo() = 0;

    /**
        Returns @true if there is an action to undo.
    */
    virtual bool CanUndo() = 0;

    /**
        Redos the last action.
    */
    virtual void Redo() = 0;

    /**
        Undos the last action.
    */
    virtual void Undo() = 0;

    /**
        @name Zoom
    */

    /**
        Retrieve whether the current HTML engine supports a zoom type.
        @param type The zoom type to test.
        @return Whether this type of zoom is supported by this HTML engine
                (and thus can be set through SetZoomType()).
    */
    virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;

    /**
        Get the zoom factor of the page.
        @return The current level of zoom.
    */
    virtual wxWebViewZoom GetZoom() = 0;

    /**
        Get how the zoom factor is currently interpreted.
        @return How the zoom factor is currently interpreted by the HTML engine.
    */
    virtual wxWebViewZoomType GetZoomType() const = 0;

    /**
        Set the zoom factor of the page.
        @param zoom How much to zoom (scale) the HTML document.
    */
    virtual void SetZoom(wxWebViewZoom zoom) = 0;

    /**
        Set how to interpret the zoom factor.
        @param zoomType How the zoom factor should be interpreted by the
                        HTML engine.
        @note invoke    CanSetZoomType() first, some HTML renderers may not
                        support all zoom types.
    */
    virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
};


/**
    @class wxWebNavigationEvent

    A navigation  event holds information about events associated with 
    wxWebView objects.

    @beginEventEmissionTable{wxWebNavigationEvent}
    @event{EVT_WEB_VIEW_NAVIGATING(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
       to get a resource. This event may be vetoed to prevent navigating to this
       resource. Note that if the displayed HTML document has several frames, one
       such event will be generated per frame.
    @event{EVT_WEB_VIEW_NAVIGATED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
       confirmed that a resource would be requested. This event may not be vetoed.
       Note that if the displayed HTML document has several frames, one such event
       will be generated per frame.
    @event{EVT_WEB_VIEW_LOADED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
       is fully loaded and displayed. Note that if the displayed HTML document has 
       several frames, one such event will be generated per frame.
    @event{EVT_WEB_VIEW_ERRROR(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
       error occurs.
       The integer associated with this event will be a wxWebNavigationError item.
       The string associated with this event may contain a backend-specific more
       precise error message/code.
    @event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
       window is created. You must handle this event if you want anything to 
       happen, for example to load the page in a new window or tab.
    @event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
       Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when 
       the page title changes. Use GetString to get the title.
    @endEventTable

    @library{wxweb}
    @category{events,web}

    @see wxWebView
*/
class wxWebNavigationEvent : public wxCommandEvent
{
public:
    wxWebNavigationEvent();
    wxWebNavigationEvent(wxEventType type, int id, const wxString href,
                         const wxString target, bool canVeto);

    /**
        Get the name of the target frame which the url of this event
        has been or will be loaded into. This may return an emptry string
        if the frame is not avaliable.
    */
    const wxString& GetTarget() const;

    /**
        Get the URL being visited
    */
    const wxString& GetURL() const;

    virtual wxEvent* Clone() const;

    /** 
        Get whether this event may be vetoed (stopped/prevented). Only
        meaningful for events fired before navigation takes place.
     */
    bool CanVeto() const;

    /** 
        Whether this event was vetoed (stopped/prevented). Only meaningful for
        events fired before navigation takes place or new window events.
     */
    bool IsVetoed() const;

    /** 
        Veto (prevent/stop) this event. Only meaningful for events fired
        before navigation takes place. Only valid if CanVeto() returned true.
     */
    void Veto();
};
Commit	Line	Data
968a7de2 SL	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: webview.h
	3	// Purpose: interface of wxWebView
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	Zoom levels availiable in wxWebView
	11	*/
	12	enum wxWebViewZoom
	13	{
	14	wxWEB_VIEW_ZOOM_TINY,
	15	wxWEB_VIEW_ZOOM_SMALL,
	16	wxWEB_VIEW_ZOOM_MEDIUM, //!< default size
	17	wxWEB_VIEW_ZOOM_LARGE,
	18	wxWEB_VIEW_ZOOM_LARGEST
	19	};
	20
	21	/**
	22	The type of zooming that the web view control can perform
	23	*/
	24	enum wxWebViewZoomType
	25	{
	26	/**
	27	The entire layout scales when zooming, including images
	28	*/
	29	wxWEB_VIEW_ZOOM_TYPE_LAYOUT,
	30	/**
	31	Only the text changes in size when zooming, images and other layout
	32	elements retain their initial size
	33	*/
	34	wxWEB_VIEW_ZOOM_TYPE_TEXT
	35	};
	36
	37	/**
	38	Types of errors that can cause navigation to fail
	39	*/
	40	enum wxWebNavigationError
	41	{
	42	/** Connection error (timeout, etc.) */
	43	wxWEB_NAV_ERR_CONNECTION,
	44	/** Invalid certificate */
	45	wxWEB_NAV_ERR_CERTIFICATE,
	46	/** Authentication required */
	47	wxWEB_NAV_ERR_AUTH,
	48	/** Other security error */
	49	wxWEB_NAV_ERR_SECURITY,
	50	/** Requested resource not found */
	51	wxWEB_NAV_ERR_NOT_FOUND,
	52	/** Invalid request/parameters (e.g. bad URL, bad protocol,
	53	unsupported resource type) */
	54	wxWEB_NAV_ERR_REQUEST,
	55	/** The user cancelled (e.g. in a dialog) */
	56	wxWEB_NAV_ERR_USER_CANCELLED,
	57	/** Another (exotic) type of error that didn't fit in other categories*/
	58	wxWEB_NAV_ERR_OTHER
	59	};
	60
	61	/**
	62	Type of refresh
	63	*/
	64	enum wxWebViewReloadFlags
65	{
66	/** Default reload, will access cache */
67	wxWEB_VIEW_RELOAD_DEFAULT,
68	/** Reload the current view without accessing the cache */
69	wxWEB_VIEW_RELOAD_NO_CACHE
70	};
71
72
73	/**
74	* List of available backends for wxWebView
75	*/
76	enum wxWebViewBackend
77	{
78	/** Value that may be passed to wxWebView to let it pick an appropriate
79	* engine for the current platform*/
80	wxWEB_VIEW_BACKEND_DEFAULT,
81
9df97be2 SL	82	/** The WebKit web engine */
9df97be2 SL	83	wxWEB_VIEW_BACKEND_WEBKIT,
968a7de2 SL	84
	85	/** Use Microsoft Internet Explorer as web engine */
	86	wxWEB_VIEW_BACKEND_IE
	87	};
	88
	89	/**
	90	@class wxWebHistoryItem
	91
	92	A simple class that contains the URL and title of an element of the history
	93	of a wxWebView.
	94
	95	@library{wxweb}
bf39189b SL	96	@category{web}
	97
	98	@see wxWebView
968a7de2 SL	99	*/
	100	class wxWebHistoryItem
	101	{
	102	public:
	103	/**
	104	Construtor.
	105	*/
	106	wxWebHistoryItem(const wxString& url, const wxString& title);
	107
	108	/**
	109	@return The url of the page.
	110	*/
	111	wxString GetUrl();
	112
	113	/**
	114	@return The title of the page.
	115	*/
	116	wxString GetTitle();
	117	};
	118
	119	/**
	120	@class wxWebView
	121
	122	This control may be used to render web (HTML / CSS / javascript) documents.
	123	Capabilities of the HTML renderer will depend upon the backed.
c36818c8 SL	124
	125	@c wxWEB_VIEW_BACKEND_IE uses the the Trident rendering engine, which
	126	is also used by Internet Explorer. It is important to note that by default
	127	it emulates Internet Explorer 7, this can be chaged with a registry
	128	setting, see
	129	<a href="http://msdn.microsoft.com/en-us/library/ee330730%28v=vs.85%29.aspx#browser_emulation">
	130	this</a> article for more information.
968a7de2 SL	131
	132	Note that errors are generally reported asynchronously though the
	133	@c wxEVT_COMMAND_WEB_VIEW_ERROR event described below.
	134
	135	@beginEventEmissionTable{wxWebNavigationEvent}
	136	@event{EVT_WEB_VIEW_NAVIGATING(id, func)}
	137	Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
	138	to get a resource. This event may be vetoed to prevent navigating to this
	139	resource. Note that if the displayed HTML document has several frames, one
	140	such event will be generated per frame.
	141	@event{EVT_WEB_VIEW_NAVIGATED(id, func)}
	142	Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
	143	confirmed that a resource would be requested. This event may not be vetoed.
	144	Note that if the displayed HTML document has several frames, one such event
	145	will be generated per frame.
	146	@event{EVT_WEB_VIEW_LOADED(id, func)}
	147	Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
113e0a92 SL	148	is fully loaded and displayed. Note that if the displayed HTML document has
113e0a92 SL	149	several frames, one such event will be generated per frame.
968a7de2 SL	150	@event{EVT_WEB_VIEW_ERRROR(id, func)}
	151	Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
	152	error occurs.
	153	The integer associated with this event will be a wxWebNavigationError item.
	154	The string associated with this event may contain a backend-specific more
	155	precise error message/code.
	156	@event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
	157	Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
d676fb21 SL	158	window is created. You must handle this event if you want anything to
d676fb21 SL	159	happen, for example to load the page in a new window or tab.
153530af SL	160	@event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
	161	Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
	162	the page title changes. Use GetString to get the title.
968a7de2 SL	163	@endEventTable
	164
	165	@library{wxweb}
bf39189b	166	@category{ctrl,web}
968a7de2 SL	167	*/
	168	class wxWebView : public wxControl
	169	{
	170	public:
	171
	172	/**
	173	Creation function for two-step creation.
	174	*/
	175	virtual bool Create(wxWindow* parent,
	176	wxWindowID id,
	177	const wxString& url,
	178	const wxPoint& pos,
	179	const wxSize& size,
	180	long style,
	181	const wxString& name) = 0;
	182
	183	/**
	184	Factory function to create a new wxWebView for two-step creation
	185	(you need to call wxWebView::Create on the returned object)
	186	@param backend which web engine to use as backend for wxWebView
	187	@return the created wxWebView, or NULL if the requested backend is
	188	not available
	189	*/
	190	static wxWebView* New(wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT);
	191
	192	/**
	193	Factory function to create a new wxWebView
	194	@param parent parent window to create this view in
	195	@param id ID of this control
	196	@param url URL to load by default in the web view
	197	@param pos position to create this control at
	198	(you may use wxDefaultPosition if you use sizers)
	199	@param size size to create this control with
	200	(you may use wxDefaultSize if you use sizers)
	201	@param backend which web engine to use as backend for wxWebView
	202	@return the created wxWebView, or NULL if the requested backend
	203	is not available
	204	*/
	205	static wxWebView* New(wxWindow* parent,
	206	wxWindowID id,
	207	const wxString& url = wxWebViewDefaultURLStr,
	208	const wxPoint& pos = wxDefaultPosition,
	209	const wxSize& size = wxDefaultSize,
	210	wxWebViewBackend backend = wxWEB_VIEW_BACKEND_DEFAULT,
	211	long style = 0,
	212	const wxString& name = wxWebViewNameStr);
	213
	214	/**
	215	Get the title of the current web page, or its URL/path if title is not
	216	available.
	217	*/
	218	virtual wxString GetCurrentTitle() = 0;
	219
	220	/**
	221	Get the URL of the currently displayed document.
	222	*/
	223	virtual wxString GetCurrentURL() = 0;
	224
	225	/**
	226	Get the HTML source code of the currently displayed document.
	227	@return The HTML source code, or an empty string if no page is currently
	228	shown.
	229	*/
	230	virtual wxString GetPageSource() = 0;
231
241b769f SL	232	/**
	233	Get the text of the current page.
	234	*/
	235	virtual wxString GetPageText() = 0;
	236
968a7de2 SL	237	/**
	238	Returns whether the web control is currently busy (e.g. loading a page).
	239	*/
c7cbe308 SL	240	virtual bool IsBusy() = 0;
	241
	242	/**
	243	Returns whether the web control is currently editable
	244	*/
	245	virtual bool IsEditable() = 0;
968a7de2 SL	246
	247	/**
	248	Load a web page from a URL
	249	@param url The URL of the page to be loaded.
	250	@note Web engines generally report errors asynchronously, so if you wish
	251	to know whether loading the URL was successful, register to receive
	252	navigation error events.
	253	*/
	254	virtual void LoadUrl(const wxString& url) = 0;
	255
	256	/**
	257	Opens a print dialog so that the user may print the currently
	258	displayed page.
	259	*/
	260	virtual void Print() = 0;
	261
	262	/**
	263	Reload the currently displayed URL.
	264	@param flags A bit array that may optionally contain reload options.
	265	*/
	266	virtual void Reload(wxWebViewReloadFlags flags = wxWEB_VIEW_RELOAD_DEFAULT) = 0;
c7cbe308	267
c9ccc09c SL	268	/**
	269	Runs the given javascript code.
	270	*/
	271	virtual void RunScript(const wxString& javascript) = 0;
	272
c7cbe308 SL	273	/**
	274	Set the editable property of the web control. Enabling allows the user
	275	to edit the page even if the @c contenteditable attribute is not set.
	276	The exact capabilities vary with the backend being used.
	277	*/
	278	virtual void SetEditable(bool enable = true) = 0;
968a7de2 SL	279
	280	/**
	281	Set the displayed page source to the contents of the given string.
	282	@param html The string that contains the HTML data to display.
	283	@param baseUrl URL assigned to the HTML data, to be used to resolve
	284	relative paths, for instance.
	285	*/
	286	virtual void SetPage(const wxString& html, const wxString& baseUrl) = 0;
	287
	288	/**
	289	Set the displayed page source to the contents of the given stream.
	290	@param html The stream to read HTML data from.
	291	@param baseUrl URL assigned to the HTML data, to be used to resolve
	292	relative paths, for instance.
	293	*/
2339d6df	294	virtual void SetPage(wxInputStream& html, wxString baseUrl);
968a7de2 SL	295
	296	/**
	297	Stop the current page loading process, if any.
	298	May trigger an error event of type @c wxWEB_NAV_ERR_USER_CANCELLED.
	299	TODO: make @c wxWEB_NAV_ERR_USER_CANCELLED errors uniform across ports.
	300	*/
	301	virtual void Stop() = 0;
	302
	303	/**
	304	@name Clipboard
	305	*/
	306
	307	/**
	308	Returns @true if the current selection can be copied.
	309	*/
	310	virtual bool CanCopy() = 0;
	311
	312	/**
	313	Returns @true if the current selection can be cut.
	314	*/
	315	virtual bool CanCut() = 0;
	316
	317	/**
	318	Returns @true if data can be pasted.
	319	*/
	320	virtual bool CanPaste() = 0;
	321
	322	/**
	323	Copies the current selection.
	324	*/
	325	virtual void Copy() = 0;
	326
	327	/**
	328	Cuts the current selection.
	329	*/
	330	virtual void Cut() = 0;
	331
	332	/**
	333	Pastes the current data.
	334	*/
	335	virtual void Paste() = 0;
	336
	337	/**
	338	@name History
	339	*/
	340
	341	/**
	342	Returns @true if it is possible to navigate backward in the history of
	343	visited pages.
	344	*/
	345	virtual bool CanGoBack() = 0;
	346
	347	/**
	348	Returns @true if it is possible to navigate forward in the history of
	349	visited pages.
	350	*/
	351	virtual bool CanGoForward() = 0;
	352
	353	/**
	354	Clear the history, this will also remove the visible page.
	355	*/
	356	virtual void ClearHistory() = 0;
	357
	358	/**
359	Enable or disable the history. This will also clear the history.
360	*/
361	virtual void EnableHistory(bool enable = true) = 0;
362
363	/**
364	Returns a list of items in the back history. The first item in the
365	vector is the first page that was loaded by the control.
366	*/
367	virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetBackwardHistory() = 0;
368
369	/**
370	Returns a list of items in the forward history. The first item in the
371	vector is the next item in the history with respect to the curently
372	loaded page.
373	*/
374	virtual wxVector<wxSharedPtr<wxWebHistoryItem> > GetForwardHistory() = 0;
375
376	/**
377	Navigate back in the history of visited pages.
378	Only valid if CanGoBack() returns true.
379	*/
380	virtual void GoBack() = 0;
381
382	/**
383	Navigate forward in the history of visited pages.
384	Only valid if CanGoForward() returns true.
385	*/
386	virtual void GoForward() = 0;
387
388	/**
389	Loads a history item.
390	*/
391	virtual void LoadHistoryItem(wxSharedPtr<wxWebHistoryItem> item) = 0;
63a65070 SL	392
	393	/**
	394	@name Selection
	395	*/
	396
41933aa5 SL	397	/**
	398	Clears the current selection.
	399	*/
	400	virtual void ClearSelection() = 0;
	401
63a65070 SL	402	/**
	403	Deletes the current selection. Note that for @c wxWEB_VIEW_BACKEND_WEBKIT
	404	the selection must be editable, either through SetEditable or the
	405	correct HTML attribute.
	406	*/
	407	virtual void DeleteSelection() = 0;
c9355a3d	408
0fe8a1b6	409	/**
97ba4d81	410	Returns the currently selected source, if any.
0fe8a1b6	411	*/
97ba4d81	412	virtual wxString GetSelectedSource() = 0;
0fe8a1b6	413
c9355a3d SL	414	/**
	415	Returns the currently selected text, if any.
	416	*/
	417	virtual wxString GetSelectedText() = 0;
63a65070 SL	418
	419	/**
	420	Returns @true if there is a current selection.
	421	*/
c9355a3d	422	virtual bool HasSelection() = 0;
63a65070 SL	423
	424	/**
	425	Selects the entire page.
	426	*/
	427	virtual void SelectAll() = 0;
968a7de2 SL	428
	429	/**
	430	@name Undo / Redo
	431	*/
	432
	433	/**
	434	Returns @true if there is an action to redo.
	435	*/
	436	virtual bool CanRedo() = 0;
	437
	438	/**
	439	Returns @true if there is an action to undo.
	440	*/
	441	virtual bool CanUndo() = 0;
	442
	443	/**
	444	Redos the last action.
	445	*/
	446	virtual void Redo() = 0;
	447
	448	/**
	449	Undos the last action.
	450	*/
	451	virtual void Undo() = 0;
	452
	453	/**
	454	@name Zoom
	455	*/
	456
	457	/**
	458	Retrieve whether the current HTML engine supports a zoom type.
	459	@param type The zoom type to test.
	460	@return Whether this type of zoom is supported by this HTML engine
	461	(and thus can be set through SetZoomType()).
	462	*/
	463	virtual bool CanSetZoomType(wxWebViewZoomType type) const = 0;
	464
	465	/**
	466	Get the zoom factor of the page.
	467	@return The current level of zoom.
	468	*/
	469	virtual wxWebViewZoom GetZoom() = 0;
	470
	471	/**
	472	Get how the zoom factor is currently interpreted.
	473	@return How the zoom factor is currently interpreted by the HTML engine.
	474	*/
	475	virtual wxWebViewZoomType GetZoomType() const = 0;
	476
	477	/**
	478	Set the zoom factor of the page.
	479	@param zoom How much to zoom (scale) the HTML document.
	480	*/
	481	virtual void SetZoom(wxWebViewZoom zoom) = 0;
	482
	483	/**
	484	Set how to interpret the zoom factor.
	485	@param zoomType How the zoom factor should be interpreted by the
	486	HTML engine.
	487	@note invoke CanSetZoomType() first, some HTML renderers may not
	488	support all zoom types.
	489	*/
	490	virtual void SetZoomType(wxWebViewZoomType zoomType) = 0;
	491	};
492
493
494
495
496	/**
497	@class wxWebNavigationEvent
498
499	A navigation event holds information about events associated with
500	wxWebView objects.
501
502	@beginEventEmissionTable{wxWebNavigationEvent}
503	@event{EVT_WEB_VIEW_NAVIGATING(id, func)}
504	Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATING event, generated before trying
505	to get a resource. This event may be vetoed to prevent navigating to this
506	resource. Note that if the displayed HTML document has several frames, one
507	such event will be generated per frame.
508	@event{EVT_WEB_VIEW_NAVIGATED(id, func)}
509	Process a @c wxEVT_COMMAND_WEB_VIEW_NAVIGATED event generated after it was
510	confirmed that a resource would be requested. This event may not be vetoed.
511	Note that if the displayed HTML document has several frames, one such event
512	will be generated per frame.
513	@event{EVT_WEB_VIEW_LOADED(id, func)}
514	Process a @c wxEVT_COMMAND_WEB_VIEW_LOADED event generated when the document
113e0a92 SL	515	is fully loaded and displayed. Note that if the displayed HTML document has
113e0a92 SL	516	several frames, one such event will be generated per frame.
968a7de2 SL	517	@event{EVT_WEB_VIEW_ERRROR(id, func)}
	518	Process a @c wxEVT_COMMAND_WEB_VIEW_ERROR event generated when a navigation
	519	error occurs.
	520	The integer associated with this event will be a wxWebNavigationError item.
	521	The string associated with this event may contain a backend-specific more
	522	precise error message/code.
	523	@event{EVT_WEB_VIEW_NEWWINDOW(id, func)}
	524	Process a @c wxEVT_COMMAND_WEB_VIEW_NEWWINDOW event, generated when a new
d676fb21 SL	525	window is created. You must handle this event if you want anything to
d676fb21 SL	526	happen, for example to load the page in a new window or tab.
153530af SL	527	@event{EVT_WEB_VIEW_TITLE_CHANGED(id, func)}
	528	Process a @c wxEVT_COMMAND_WEB_VIEW_TITLE_CHANGED event, generated when
	529	the page title changes. Use GetString to get the title.
968a7de2 SL	530	@endEventTable
	531
	532	@library{wxweb}
bf39189b	533	@category{events,web}
968a7de2 SL	534
	535	@see wxWebView
	536	*/
	537	class wxWebNavigationEvent : public wxCommandEvent
	538	{
	539	public:
	540	wxWebNavigationEvent();
	541	wxWebNavigationEvent(wxEventType type, int id, const wxString href,
	542	const wxString target, bool canVeto);
968a7de2 SL	543
968a7de2 SL	544	/**
45aa63c2 SL	545	Get the name of the target frame which the url of this event
	546	has been or will be loaded into. This may return an emptry string
	547	if the frame is not avaliable.
968a7de2 SL	548	*/
	549	const wxString& GetTarget() const;
	550
e40741b9 SL	551	/**
	552	Get the URL being visited
	553	*/
	554	const wxString& GetURL() const;
	555
968a7de2 SL	556	virtual wxEvent* Clone() const;
	557
	558	/**
	559	Get whether this event may be vetoed (stopped/prevented). Only
d676fb21	560	meaningful for events fired before navigation takes place.
968a7de2 SL	561	*/
	562	bool CanVeto() const;
	563
	564	/**
	565	Whether this event was vetoed (stopped/prevented). Only meaningful for
	566	events fired before navigation takes place or new window events.
	567	*/
	568	bool IsVetoed() const;
	569
	570	/**
	571	Veto (prevent/stop) this event. Only meaningful for events fired
d676fb21	572	before navigation takes place. Only valid if CanVeto() returned true.
968a7de2 SL	573	*/
968a7de2 SL	574	void Veto();
dec53e5a	575	};