wx.html2.WebViewEvent¶

A navigation event holds information about events associated with wx.html2.WebView objects.

Events Emitted by this Class¶

Handlers bound for the following event types will receive a wx.html2.WebViewEvent parameter.

EVT_WEBVIEW_NAVIGATING: Process a wxEVT_WEBVIEW_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.
EVT_WEBVIEW_NAVIGATED: Process a wxEVT_WEBVIEW_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.
EVT_WEBVIEW_LOADED: Process a wxEVT_WEBVIEW_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.
EVT_WEBVIEW_ERROR: Process a wxEVT_WEBVIEW_ERROR event generated when a navigation error occurs. The integer associated with this event will be a wx.html2.WebViewNavigationError item. The string associated with this event may contain a backend-specific more precise error message/code.
EVT_WEBVIEW_NEWWINDOW: Process a wxEVT_WEBVIEW_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.
EVT_WEBVIEW_TITLE_CHANGED: Process a wxEVT_WEBVIEW_TITLE_CHANGED event, generated when the page title changes. Use GetString to get the title.
EVT_WEBVIEW_FULLSCREEN_CHANGED: Process a wxEVT_WEBVIEW_FULLSCREEN_CHANGED event, generated when the page wants to enter or leave fullscreen. Use GetInt to get the status. Not implemented for the IE backend and is only available in wxWidgets 3.1.5 or later.
EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED: Process a wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED event only available in wxWidgets 3.1.5 or later. For usage details see wx.html2.WebView.AddScriptMessageHandler .
wxEVT_WEBVIEW_SCRIPT_RESULT: Process a wxEVT_WEBVIEW_SCRIPT_RESULT event only available in wxWidgets 3.1.6 or later. For usage details see wx.html2.WebView.RunScriptAsync .

wx.html2.WebView

Added in version 2.9.3.

Class Hierarchy¶

Inheritance diagram for class WebViewEvent:

Methods Summary¶

`__init__`
`GetMessageHandler`	Get the name of the script handler.
`GetNavigationAction`	Get the type of navigation action.
`GetTarget`	Get the name of the target frame which the url of this event has been or will be loaded into.
`GetURL`	Get the URL being visited.
`IsError`	Returns `True` the script execution failed.

Properties Summary¶

`MessageHandler`	See `GetMessageHandler`
`NavigationAction`	See `GetNavigationAction`
`Target`	See `GetTarget`
`URL`	See `GetURL`

Class API¶

class wx.html2.WebViewEvent(NotifyEvent)¶

Possible constructors:

WebViewEvent() -> None

WebViewEvent(type, id, href, target, flags=WEBVIEW_NAV_ACTION_NONE,
             messageHandler="") -> None

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

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Return type:: None

__init__ (self, type, id, href, target, flags=WEBVIEW_NAV_ACTION_NONE, messageHandler=””)

Parameters:

type (wx.EventType)
id (int)
href (string)
target (string)
flags (WebViewNavigationActionFlags)
messageHandler (string)

Return type:

None

GetMessageHandler(self)¶

Get the name of the script handler.

Only valid for events of type wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED

Return type:: str

Added in version 4.1/wxWidgets-3.1.5.

GetNavigationAction(self)¶

Get the type of navigation action.

Only valid for events of type wxEVT_WEBVIEW_NEWWINDOW

Return type:: wx.html2.WebViewNavigationActionFlags

Added in version 4.1/wxWidgets-3.1.2.

GetTarget(self)¶

Get the name of the target frame which the url of this event has been or will be loaded into.

This may return an empty string if the frame is not available.

Return type:: str

GetURL(self)¶

Get the URL being visited.

Return type:: str

IsError(self)¶

Returns True the script execution failed.

Only valid for events of type wxEVT_WEBVIEW_SCRIPT_RESULT

Return type:: bool

Added in version 4.1/wxWidgets-3.1.6.

Properties¶

MessageHandler¶: See GetMessageHandler

NavigationAction¶: See GetNavigationAction

Target¶: See GetTarget

URL¶: See GetURL