wx.html2.WebViewHandler

The base class for handling custom schemes in wx.html2.WebView, for example to allow virtual file system support.

A new handler should either implement GetFile or if a more detailed request handling is required (access to headers, post data) StartRequest has to be implemented.

wx.html2.WebView

Added in version 2.9.3.

See also

wx.html2.WebView

Class Hierarchy

Inheritance diagram for class WebViewHandler:

Known Subclasses

wx.html2.WebViewArchiveHandler, wx.html2.WebViewFSHandler

Methods Summary

__init__	Constructor.
GetFile
GetName
GetSecurityURL
GetVirtualHost
SetSecurityURL	Sets a custom security URL.
SetVirtualHost	When using the edge backend handler urls are https urls with a virtual host.

Properties Summary

Name	See GetName
SecurityURL	See GetSecurityURL and SetSecurityURL
VirtualHost	See GetVirtualHost and SetVirtualHost

Class API

class wx.html2.WebViewHandler(object)

Possible constructors:

WebViewHandler(scheme) -> None

The base class for handling custom schemes in WebView, for example to allow virtual file system support.

Methods

__init__(self, scheme)

Constructor.

Takes the name of the scheme that will be handled by this class for example file or zip .

Parameters:

scheme (string)

Return type:

None

---

GetFile(self, uri)

Parameters:

uri (string)

Return type:

FSFile

Returns:

A pointer to the file represented by uri .

---

GetName(self)

Return type:

str

Returns:

The name of the scheme, as passed to the constructor.

---

GetSecurityURL(self)

Return type:

str

Returns:

The custom security URL. Only used by WebViewIE .

Added in version 4.1/wxWidgets-3.1.5.

---

GetVirtualHost(self)

Return type:

str

Returns:

The virtual host of this handler

Added in version 4.3/wxWidgets-3.3.0.

See also

SetVirtualHost

---

SetSecurityURL(self, url)

Sets a custom security URL.

Only used by WebViewIE .

Parameters:

url (string)

Return type:

None

Added in version 4.1/wxWidgets-3.1.5.

---

SetVirtualHost(self, host)

When using the edge backend handler urls are https urls with a virtual host.

As default name.wxsite is used as the virtual hostname. If you customize this host, use a non existing site (ideally a reserved subdomain of a domain you control). If localassests.domain.example is used the handlers content will be available under https://localassets.domain.example/

This has to be set before registering the handler via wx.html2.WebView.RegisterHandler .

Parameters:

host (string)

Return type:

None

Added in version 4.3/wxWidgets-3.3.0.

Properties

Name

See GetName

---

SecurityURL

See GetSecurityURL and SetSecurityURL

---

VirtualHost

See GetVirtualHost and SetVirtualHost