WEBVIEW_BACKEND_IE (MSW)WEBVIEW_BACKEND_EDGE (MSW)WEBVIEW_WEBKIT (GTK)WEBVIEW_WEBKIT2 (GTK3)WEBVIEW_WEBKIT (macOS)
wx.html2.WebView¶This control may be used to render web (HTML / CSS / javascript) documents.
It is designed to allow the creation of multiple backends for each port, although currently just one is available. It differs from wx.html.HtmlWindow in that each backend is actually a full rendering engine, Internet Explorer or Edge on MSW and WebKit on macOS and GTK. This allows the correct viewing of complex pages with JavaScript and CSS.
Backend Descriptions¶This class supports using multiple backends, corresponding to different implementations of the same functionality. Under macOS and Unix platforms only a single, WebKit-based, backend is currently provided, but under MSW both the legacy IE backend and the new Edge backend exist. Backends are identified by their names, documented in the backend descriptions below.
WEBVIEW_BACKEND_IE (MSW)¶The IE backend uses Microsoft’s WebBrowser control, which depends the locally installed version of Internet Explorer. By default this backend emulates Internet Explorer 7. This can be changed with a registry setting by WebViewIE.MSWSetEmulationLevel see this article for more information. This backend has full support for custom schemes and virtual file systems. The predefined WebViewBackendIE constant contains the name of this backend and can be used to explicitly select it when using wx.html2.WebView.New .
WEBVIEW_BACKEND_EDGE (MSW)¶The Edge backend uses Microsoft’s Edge WebView2. It is available for Windows 7 and newer. This backend does not support custom schemes and virtual file systems. This backend is not enabled by default, to build it follow these steps:
Visual Studio 2015 or newer, or GCC/Clang with c++11 is required
With CMake just enable USE_WEBVIEW_EDGE
When not using CMake:
Download the WebView2 SDK nuget package (Version 1.0.705.50 or newer)
Extract the package (it’s a zip archive) to Widgets/3rdparty/webview2 (you should have 3rdparty/webview2/build/native/include/WebView2.h file after unpacking it)
Enable USE_WEBVIEW_EDGE in setup.h
Build wxWidgets webview library
Copy WebView2Loader.dll from the subdirectory corresponding to the architecture used (x86 or x64) of Widgets/3rdparty/webview2/build/ to your applications executable
At runtime you can use wx.html2.WebView.IsBackendAvailable to check if the backend can be used (it will be available if WebView2Loader.dll can be loaded and Edge (Chromium) is installed)
Make sure to add a note about using the WebView2 SDK to your application documentation, as required by its licence
With Visual Studio 2019 or newer USE_WEBVIEW_EDGE_STATIC can be used to static link the loader and remove the dependency on WebView2Loader.dll at runtime.
If enabled and available at runtime Edge will be selected as the default backend. If you require the IE backend use WebViewBackendIE when using wx.html2.WebView.New . If your application should use a fixed version of the WebView2 runtime you must use WebViewEdge.MSWSetBrowserExecutableDir to specify its usage before using the Edge backend. The predefined WebViewBackendEdge constant contains the name of this backend.
WEBVIEW_WEBKIT (GTK)¶Under GTK the WebKit backend uses WebKitGTK+. The current minimum version required is 1.3.1 which ships by default with Ubuntu Natty and Debian Wheezy and has the package name libwebkitgtk-dev. Custom schemes and virtual files systems are supported under this backend, however embedded resources such as images and stylesheets are currently loaded using the data:// scheme. The predefined WebViewBackendWebKit constant contains the name of this backend.
WEBVIEW_WEBKIT2 (GTK3)¶Under GTK3 the WebKit2 version of WebKitGTK+ is used. In Ubuntu the required package name is libwebkit2gtk-4.0-dev and under Fedora it is webkitgtk4-devel. All features are supported except for clearing and enabling / disabling the history. The predefined WebViewBackendWebKit constant contains the name of this backend.
WEBVIEW_WEBKIT (macOS)¶The macOS WebKit backend uses Apple’s WKWebView class. This backend has full support for custom schemes and virtual file systems on macOS 10.13+. In order to use handlers two-step creation has to be used and RegisterHandler has to be called before Create. Starting with macOS 10.11 and iOS 9 an application cannot create unsecure connections (this includes HTTP and unverified HTTPS). You have to include additional fields in your Info.plist to enable such connections. For further details see the documentation on NSAppTransportSecurity here The predefined WebViewBackendWebKit constant contains the name of this backend.
Asynchronous Notifications¶Many of the methods in wx.html2.WebView are asynchronous, i.e. they return immediately and perform their work in the background. This includes functions such as LoadURL and Reload. To receive notification of the progress and completion of these functions you need to handle the events that are provided. Specifically wxEVT_WEBVIEW_LOADED notifies when the page or a sub-frame has finished loading and wxEVT_WEBVIEW_ERROR notifies that an error has occurred.
Virtual File Systems and Custom Schemes¶ wx.html2.WebView supports the registering of custom scheme handlers, for example file or http . To do this create a new class which inherits from wx.html2.WebViewHandler, where WebHandler.GetFile() returns a pointer to a wx.FSFile which represents the given url. You can then register your handler with RegisterHandler it will be called for all pages and resources. wx.html2.WebViewFSHandler is provided to access the virtual file system encapsulated by wx.FileSystem. The wx.MemoryFSHandler documentation gives an example of how this may be used. wx.html2.WebViewArchiveHandler is provided to allow the navigation of pages inside a zip archive. It supports paths of the form: scheme:///C :/example/docs.zip;protocol=zip/main.htm ^^
Events Emitted by this Class¶Handlers bound for the following event types will receive one of the wx.html2.WebViewEvent parameters.
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 WebNavigationError 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 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 RunScriptAsync. ^^
wx.html2.WebView ^^<>< =’’>:</>&;&;< =’’>\ , \ </></>
New in version 2.9.3.
Note
If you plan to display any modern web content you should consider using ``WEBVIEW_BACKEND_EDGE `` , as Internet Explorer is not supported anymore by Microsoft.
See also
Methods Summary¶Add a script message handler with the given name. |
|
Injects the specified script into the webpage’s content. |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Returns |
|
Retrieve whether the current HTML engine supports a zoom type. |
|
Returns |
|
Clear the history, this will also remove the visible page. |
|
Clears the current selection. |
|
Copies the current selection. |
|
Creation function for two-step creation. |
|
Cuts the current selection. |
|
Deletes the current selection. |
|
Enable or disable access to dev tools for the user. |
|
Enable or disable the right click context menu. |
|
Enable or disable the history. |
|
Finds a phrase on the current page and if found, the control will scroll the phrase into view and select it. |
|
Retrieve the version information about the backend implementation. |
|
Returns a list of items in the back history. |
|
Get the title of the current web page, or its URL/path if title is not available. |
|
Get the URL of the currently displayed document. |
|
Returns a list of items in the forward history. |
|
Return the pointer to the native backend used by this control. |
|
Get the HTML source code of the currently displayed document. |
|
Get the text of the current page. |
|
Returns the currently selected source, if any. |
|
Returns the currently selected text, if any. |
|
Returns the current user agent string for the web view. |
|
Get the zoom level of the page. |
|
Get the zoom factor of the page. |
|
Get how the zoom factor is currently interpreted. |
|
Navigate back in the history of visited pages. |
|
Navigate forward in the history of visited pages. |
|
Returns |
|
Returns |
|
Allows to check if a specific backend is currently available. |
|
Returns whether the web control is currently busy (e.g. loading a page). |
|
Returns |
|
Returns whether the web control is currently editable. |
|
Load a web page from a URL. |
|
Sets emulation level. |
|
Factory function to create a new wx.html2.WebView with two-step creation, |
|
Pastes the current data. |
|
Opens a print dialog so that the user may print the currently displayed page. |
|
Redos the last action. |
|
Allows the registering of new backend for wx.html2.WebView. |
|
Registers a custom scheme handler. |
|
Reload the currently displayed URL. |
|
Removes all user scripts from the web view. |
|
Remove a script message handler with the given name that was previously added via |
|
Runs the given JavaScript code. |
|
Runs the given JavaScript code asynchronously and returns the result via a |
|
Selects the entire page. |
|
Set the editable property of the web control. |
|
Set the displayed page source to the contents of the given string. |
|
Specify a custom user agent string for the web view. |
|
Set the zoom level of the page. |
|
Set the zoom factor of the page. |
|
Set how to interpret the zoom factor. |
|
Stop the current page loading process, if any. |
|
Undos the last action. |
Properties Summary¶See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
|
See |
Class API¶
Inheritance diagram for class WebView:
wx.html2.WebView(Control)¶This control may be used to render web (HTML / CSS / javascript) documents.
AddScriptMessageHandler(self, name)¶Add a script message handler with the given name.
To use the script message handler from javascript use window .<name>.postMessage(<messageBody>) where <name> corresponds the value of the name parameter. The <messageBody> will be available to the application via a wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED event.
Sample C++ code receiving a script message:
# Install message handler with the name wx_msg
self.webView.AddScriptMessageHandler('wx_msg')
# Bind an event handler to receive those messages
self.webView.Bind(wx.EVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED, self.handleMessage)
Sample javascript sending a script message:
# Send sample message body
window.wx_msg.postMessage('This is a message body')
name (string) – Name of the message handler that can be used from javascript
bool
True if the handler could be added, False if it could not be added.
New in version 4.1/wxWidgets-3.1.5.
Note
The Edge backend only supports a single message handler and the IE backend does not support script message handlers.
See also
AddUserScript(self, javascript, injectionTime=WEBVIEW_INJECT_AT_DOCUMENT_START)¶Injects the specified script into the webpage’s content.
javascript (string) – The javascript code to add.
injectionTime (WebViewUserScriptInjectionTime) – Specifies when the script will be executed.
bool
Returns True if the script was added successfully.
New in version 4.1/wxWidgets-3.1.5.
Note
Please note that this is unsupported by the IE backend and the Edge backend does only support wx.html2.WEBVIEW_INJECT_AT_DOCUMENT_START.
See also
CanCopy(self)¶Returns True if the current selection can be copied.
bool
CanCut(self)¶Returns True if the current selection can be cut.
bool
CanGoBack(self)¶Returns True if it is possible to navigate backward in the history of visited pages.
bool
CanGoForward(self)¶Returns True if it is possible to navigate forward in the history of visited pages.
bool
CanPaste(self)¶Returns True if data can be pasted.
bool
CanRedo(self)¶Returns True if there is an action to redo.
bool
CanSetZoomType(self, type)¶Retrieve whether the current HTML engine supports a zoom type.
type (WebViewZoomType) – The zoom type to test.
bool
Whether this type of zoom is supported by this HTML engine (and thus can be set through SetZoomType ).
CanUndo(self)¶Returns True if there is an action to undo.
bool
ClearHistory(self)¶Clear the history, this will also remove the visible page.
Note
This is not implemented on the WebKit2GTK+ backend and macOS.
ClearSelection(self)¶Clears the current selection.
Copy(self)¶Copies the current selection.
Create(self, parent, id=ID_ANY, url=WebViewDefaultURLStr, pos=DefaultPosition, size=DefaultSize, style=0, name=WebViewNameStr)¶Creation function for two-step creation.
Cut(self)¶Cuts the current selection.
DeleteSelection(self)¶Deletes the current selection.
Note that for WEBVIEW_BACKEND_WEBKIT the selection must be editable, either through SetEditable or the correct HTML attribute.
EnableAccessToDevTools(self, enable=True)¶Enable or disable access to dev tools for the user.
Dev tools are disabled by default.
enable (bool) –
New in version 4.1/wxWidgets-3.1.4.
Note
This is not implemented for the IE backend.
EnableContextMenu(self, enable=True)¶Enable or disable the right click context menu.
By default the standard context menu is enabled, this method can be used to disable it or re-enable it later.
enable (bool) –
New in version 2.9.5.
EnableHistory(self, enable=True)¶Enable or disable the history.
This will also clear the history.
enable (bool) –
Note
This is not implemented on the WebKit2GTK+ backend and macOS.
Find(self, text, flags=WEBVIEW_FIND_DEFAULT)¶Finds a phrase on the current page and if found, the control will scroll the phrase into view and select it.
text (string) – The phrase to search for.
flags (WebViewFindFlags) – The flags for the search.
long
If search phrase was not found in combination with the flags then NOT_FOUND is returned. If called for the first time with search phrase then the total number of results will be returned. Then for every time its called with the same search phrase it will return the number of the current match.
New in version 2.9.5.
Note
This function will restart the search if the flags WEBVIEW_FIND_ENTIRE_WORD or WEBVIEW_FIND_MATCH_CASE are changed, since this will require a new search. To reset the search, for example resetting the highlights call the function with an empty search phrase.
GetBackendVersionInfo(backend=WebViewBackendDefault)¶Retrieve the version information about the backend implementation.
backend (string) –
VersionInfo
New in version 4.1/wxWidgets-3.1.5.
GetBackwardHistory(self)¶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.
PyObject
GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶variant (WindowVariant) –
VisualAttributes
GetCurrentTitle(self)¶Get the title of the current web page, or its URL/path if title is not available.
string
GetCurrentURL(self)¶Get the URL of the currently displayed document.
string
GetForwardHistory(self)¶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 currently loaded page.
PyObject
GetNativeBackend(self)¶Return the pointer to the native backend used by this control.
This method can be used to retrieve the pointer to the native rendering engine used by this control. The return value needs to be down-casted to the appropriate type depending on the platform: under Windows, it’s a pointer to IWebBrowser2 interface, under macOS it’s a WebView pointer and under GTK it’s a WebKitWebView.
For example, you could set the WebKit options using this method:
# In Python the value returned will be a sip wrapper around a void* type,
# and it can be converted to the address being pointed to with int().
webview_ptr = self.webview.GetNativeBackend()
# Assuming you are able to get a ctypes, cffi or similar access to the
# webview library, you can use that pointer value to give it access to the
# WebView backend to operate upon.
theWebViewLib.doSomething(int(webview_ptr))
New in version 2.9.5.
GetPageSource(self)¶Get the HTML source code of the currently displayed document.
string
The HTML source code, or an empty string if no page is currently shown.
GetPageText(self)¶Get the text of the current page.
string
GetSelectedSource(self)¶Returns the currently selected source, if any.
string
GetSelectedText(self)¶Returns the currently selected text, if any.
string
GetUserAgent(self)¶Returns the current user agent string for the web view.
string
New in version 4.1/wxWidgets-3.1.5.
GetZoom(self)¶Get the zoom level of the page.
See GetZoomFactor to get more precise zoom scale value other than as provided by WebViewZoom .
The current level of zoom.
GetZoomFactor(self)¶Get the zoom factor of the page.
float
The current factor of zoom.
New in version 4.1/wxWidgets-3.1.4.
GetZoomType(self)¶Get how the zoom factor is currently interpreted.
How the zoom factor is currently interpreted by the HTML engine.
GoForward(self)¶Navigate forward in the history of visited pages.
Only valid if CanGoForward returns True.
HasSelection(self)¶Returns True if there is a current selection.
bool
IsAccessToDevToolsEnabled(self)¶Returns True if dev tools are available to the user.
bool
New in version 4.1/wxWidgets-3.1.4.
IsBackendAvailable(backend)¶Allows to check if a specific backend is currently available.
For example, to check for Edge backend availability:
if wx.html2.WebView.IsBackendAvailable(wx.html2.WebViewBackendEdge):
# Do whatever you need to do when the Edge backend is available
backend (string) –
bool
New in version 4.1/wxWidgets-3.1.4.
IsBusy(self)¶Returns whether the web control is currently busy (e.g. loading a page).
bool
IsContextMenuEnabled(self)¶Returns True if a context menu will be shown on right click.
bool
New in version 2.9.5.
IsEditable(self)¶Returns whether the web control is currently editable.
bool
LoadURL(self, url)¶Load a web page from a URL.
url (string) – 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.
MSWSetEmulationLevel(level=WEBVIEWIE_EMU_IE11)¶Sets emulation level.
This function is useful to change the emulation level of the system browser control used for wx.html2.WebView implementation under MSW, rather than using the currently default, IE7-compatible, level.
Please notice that this function works by modifying the per-user part of MSW registry, which has several implications: first, it is sufficient to call it only once (per user) as the changes done by it are persistent and, second, if you do not want them to be persistent, you need to call it with WEBVIEWIE_EMU_DEFAULT argument explicitly.
In particular, this function should be called to allow RunScript to work for JavaScript code returning arbitrary objects, which is not supported at the default emulation level.
If set to a level higher than installed version, the highest available level will be used instead. WEBVIEWIE_EMU_IE11 is recommended for best performance and experience.
This function is MSW-specific and doesn’t exist under other platforms.
See https://msdn.microsoft.com/en-us/library/ee330730#browser_emulation for more information about browser control emulation levels.
level (WebViewIE_EmulationLevel) – the target emulation level
bool
True on success, False on failure (a warning message is also logged in the latter case).
New in version 4.1/wxWidgets-3.1.3.
MSWSetModernEmulationLevel(modernLevel=True)¶Please explicitly specify emulation level with MSWSetEmulationLevel .
modernLevel (bool) – True to set level to IE8, synonym for WEBVIEWIE_EMU_IE8 . False to reset the emulation level to its default, synonym for WEBVIEWIE_EMU_DEFAULT .
bool
True on success, False on failure (a warning message is also logged in the latter case).
New in version 4.1/wxWidgets-3.1.1.
Deprecated
This function is kept mostly for backwards compatibility.
New(*args, **kw)¶
Overloaded Implementations:
New (backend=WebViewBackendDefault)
Factory function to create a new wx.html2.WebView with two-step creation, wx.html2.WebView.Create should be called on the returned object.
backend (string) – The backend web rendering engine to use. WebViewBackendDefault , WebViewBackendIE and WebViewBackendWebKit are predefined where appropriate.
The created wx.html2.WebView
New in version 2.9.5.
New (parent, id=ID_ANY, url=WebViewDefaultURLStr, pos=DefaultPosition, size=DefaultSize, backend=WebViewBackendDefault, style=0, name=WebViewNameStr)
Factory function to create a new wx.html2.WebView using a wx.html2.WebViewFactory.
parent (wx.Window) – Parent window for the control
id (wx.WindowID) – ID of this control
url (string) – Initial URL to load
pos (wx.Point) – Position of the control
size (wx.Size) – Size of the control
backend (string) – The backend web rendering engine to use. WebViewBackendDefault , WebViewBackendIE and WebViewBackendWebKit are predefined where appropriate.
style (long) – Window style. For generic window styles, please see wx.Window.
name (string) – Window name.
The created wx.html2.WebView, or NULL if the requested backend is not available
New in version 2.9.5.
Paste(self)¶Pastes the current data.
Print(self)¶Opens a print dialog so that the user may print the currently displayed page.
Redo(self)¶Redos the last action.
RegisterFactory(backend, factory)¶Allows the registering of new backend for wx.html2.WebView.
backend can be used as an argument to New .
backend (string) – The name for the new backend to be registered under
factory (wx.html2.WebViewFactory) – A shared pointer to the factory which creates the appropriate backend.
New in version 2.9.5.
RegisterHandler(self, handler)¶Registers a custom scheme handler.
handler (wx.html2.WebViewHandler) – A shared pointer to a WebHandler.
Note
On macOS in order to use handlers two-step creation has to be used and RegisterHandler has to be called before Create . With the other backends it has to be called after Create .
Reload(self, flags=WEBVIEW_RELOAD_DEFAULT)¶Reload the currently displayed URL.
flags (WebViewReloadFlags) – A bit array that may optionally contain reload options.
Note
The flags are ignored by the Edge backend.
RemoveAllUserScripts(self)¶Removes all user scripts from the web view.
New in version 4.1/wxWidgets-3.1.5.
See also
RemoveScriptMessageHandler(self, name)¶Remove a script message handler with the given name that was previously added via AddScriptMessageHandler .
name (string) –
bool
True if the handler could be removed, False if it could not be removed.
New in version 4.1/wxWidgets-3.1.5.
See also
RunScript(self, javascript)¶Runs the given JavaScript code.
JavaScript code is executed inside the browser control and has full access to DOM and other browser-provided functionality. For example, this code
webview.RunScript("document.write('Hello from wx.Widgets!')")
will replace the current page contents with the provided string.
If output is non-null, it is filled with the result of executing this code on success, e.g. a JavaScript value such as a string, a number (integer or floating point), a boolean or JSON representation for non-primitive types such as arrays and objects. For example:
success, result = webview.RunScript(
"document.getElementById('some_id').innderHTML")
if success:
... result contains the contents of the given element ...
else:
... the element with self ID probably doesn't exist ...
This function has a few platform-specific limitations:
When using WebKit v1 in wxGTK2, retrieving the result of JavaScript execution is unsupported and this function will always return False if output is non-null to indicate this. This functionality is fully supported when using WebKit v2 or later in GTK3.
When using WebKit under macOS, code execution is limited to at most 10MiB of memory and 10 seconds of execution time.
When using IE backend under MSW, scripts can only be executed when the current page is fully loaded (i.e. wxEVT_WEBVIEW_LOADED event was received). A script tag inside the page HTML is required in order to run JavaScript.
Also notice that under MSW converting JavaScript objects to JSON is not supported in the default emulation mode. wx.html2.WebView implements its own object-to-JSON conversion as a fallback for this case, however it is not as full-featured, well-tested or performing as the implementation of this functionality in the browser control itself, so it is recommended to use MSWSetEmulationLevel() to change emulation level to a more modern one in which JSON conversion is done by the control itself.
javascript (string) – JavaScript code to execute.
tuple
( bool, output )
Note
Because of various potential issues it’s recommended to use RunScriptAsync instead of this method. This is especially True if you plan to run code from a webview event and will also prevent unintended side effects on the UI outside of the webview.
See also
RunScriptAsync(self, javascript, clientData=None)¶Runs the given JavaScript code asynchronously and returns the result via a wxEVT_WEBVIEW_SCRIPT_RESULT .
The script result value can be retrieved via wx.html2.WebViewEvent.GetString . If the execution fails wx.html2.WebViewEvent.IsError will return True. In this case additional script execution error information maybe available via wx.html2.WebViewEvent.GetString .
javascript (string) – JavaScript code to execute.
clientData – Arbirary pointer to data that can be retrieved from the result event.
New in version 4.1/wxWidgets-3.1.6.
Note
The IE backend does not support async script execution.
See also
SelectAll(self)¶Selects the entire page.
SetEditable(self, enable=True)¶Set the editable property of the web control.
Enabling allows the user to edit the page even if the contenteditable attribute is not set. The exact capabilities vary with the backend being used.
enable (bool) –
Note
This is not implemented for macOS and the Edge backend.
SetPage(self, *args, **kw)¶ Overloaded Implementations:
SetPage (self, html, baseUrl)
Set the displayed page source to the contents of the given string.
html (string) – The string that contains the HTML data to display.
baseUrl (string) – URL assigned to the HTML data, to be used to resolve relative paths, for instance.
Note
When using WEBVIEW_BACKEND_IE you must wait for the current page to finish loading before calling SetPage . The baseURL parameter is not used in this backend and the Edge backend.
SetPage (self, html, baseUrl)
Set the displayed page source to the contents of the given stream.
html (wx.InputStream) – The stream to read HTML data from.
baseUrl (string) – URL assigned to the HTML data, to be used to resolve relative paths, for instance.
SetUserAgent(self, userAgent)¶Specify a custom user agent string for the web view.
Returns True the user agent could be set.
If your first request should already use the custom user agent please use two step creation and call SetUserAgent before Create .
userAgent (string) –
bool
New in version 4.1/wxWidgets-3.1.5.
Note
This is not implemented for IE. For Edge SetUserAgent MUST be called before Create .
SetZoom(self, zoom)¶Set the zoom level of the page.
See SetZoomFactor for more precise scaling other than the measured steps provided by WebViewZoom .
zoom (WebViewZoom) – How much to zoom (scale) the HTML document.
SetZoomFactor(self, zoom)¶Set the zoom factor of the page.
zoom (float) – How much to zoom (scale) the HTML document in arbitrary number.
New in version 4.1/wxWidgets-3.1.4.
Note
zoom scale in IE will be converted into WebViewZoom levels for WebViewZoomType of WEBVIEW_ZOOM_TYPE_TEXT .
SetZoomType(self, zoomType)¶Set how to interpret the zoom factor.
zoomType (WebViewZoomType) – How the zoom factor should be interpreted by the HTML engine.
Note
invoke CanSetZoomType first, some HTML renderers may not support all zoom types.
Stop(self)¶Stop the current page loading process, if any.
May trigger an error event of type WEBVIEW_NAV_ERR_USER_CANCELLED . TODO: make WEBVIEW_NAV_ERR_USER_CANCELLED errors uniform across ports.
Undo(self)¶Undos the last action.
BackwardHistory¶CurrentTitle¶See GetCurrentTitle
CurrentURL¶See GetCurrentURL
ForwardHistory¶NativeBackend¶See GetNativeBackend
PageSource¶See GetPageSource
PageText¶See GetPageText
SelectedSource¶SelectedText¶See GetSelectedText
UserAgent¶See GetUserAgent and SetUserAgent
ZoomFactor¶See GetZoomFactor and SetZoomFactor
ZoomType¶See GetZoomType and SetZoomType