wxWebViewWindowFeatures Class Reference

#include <wx/webview.h>

Detailed Description

A class describing the window information for a new child window.

An object of this class can be obtained using wxWebViewEvent::GetTargetWindowFeatures() while handling wxEVT_WEBVIEW_NEWWINDOW_FEATURES.

If a wxEVT_WEBVIEW_NEWWINDOW is not vetoed, a wxEVT_WEBVIEW_NEWWINDOW_FEATURES event will be sent to the application. The application can then create a new window and call wxWebViewEvent::GetTargetWindowInfo() to get this class providing information about the new window. A new child web view will be available via GetChildWebView(). The application can then place the child web view into the new window by calling wxWebView::Create() on the child web view.

Sample JavaScript opening a new window:

window.open("https://www.wxwidgets.org", "newWindow", "width=400,height=400");

Sample C++ code handling a new window request:

// Bind new window handler
m_webView->Bind(wxEVT_WEBVIEW_NEWWINDOW, [](wxWebViewEvent& evt) {
    if (evt.GetURL() == "http://badwebsite.com")
        evt.Veto(); // Disallow new window for badwebsite.com
    else
        evt.Skip(); // Allow new window for all other websites
});
 
// Bind new window features handler
m_webView->Bind(wxEVT_WEBVIEW_NEWWINDOW_FEATURES, [](wxWebViewEvent& evt) {
    // Get target window features
    wxWebViewWindowFeatures* features = evt.GetTargetWindowFeatures();
    // Create a top level window for the child web view
    wxWindow* win = new wxWindow(this, wxID_ANY, features->GetPosition(), features->GetSize());
    wxSizer* sizer = new wxBoxSizer(wxVERTICAL);
    win->SetSizer(sizer);
    // Get the child web view
    wxWebView* childWebView = features->GetChildWebView();
    // Place the child web view into the window
    childWebView->Create(win, wxID_ANY);
    sizer->Add(childWebView, wxSizerFlags().Proportion(1).Expand());
}

Since

3.3.0

Public Member Functions
wxWebView *	GetChildWebView ()
	Get the child web view for the target window. More...
virtual wxPoint	GetPosition () const =0
	Returns the position of the new window if specified by a window.open() call. More...
virtual wxSize	GetSize () const =0
	Returns the size of the new window if specified by a window.open() call. More...
virtual bool	ShouldDisplayMenuBar () const =0
	Returns true if the target window is expected to display a menu bar as specified by a window.open() call. More...
virtual bool	ShouldDisplayStatusBar () const =0
	Returns true if the target window is expected to display a status bar as specified by a window.open() call. More...
virtual bool	ShouldDisplayToolBar () const =0
	Returns true if the target window is expected to display a tool bar as specified by a window.open() call. More...
virtual bool	ShouldDisplayScrollBars () const =0
	Returns true if the target window is expected to display scroll bars as specified by a window.open() call. More...

Member Function Documentation

GetChildWebView()

wxWebView* wxWebViewWindowFeatures::GetChildWebView

(

)

Get the child web view for the target window.

This is available in the event handler for wxEVT_WEBVIEW_NEWWINDOW_FEATURES and wxWebView::Create() must be called on the child web view directly.

The requested URL will be loaded automatically in the child web view.

GetPosition()

virtual wxPoint wxWebViewWindowFeatures::GetPosition ( ) const

pure virtual

Returns the position of the new window if specified by a window.open() call.

GetSize()

virtual wxSize wxWebViewWindowFeatures::GetSize ( ) const

pure virtual

Returns the size of the new window if specified by a window.open() call.

ShouldDisplayMenuBar()

virtual bool wxWebViewWindowFeatures::ShouldDisplayMenuBar ( ) const

pure virtual

Returns true if the target window is expected to display a menu bar as specified by a window.open() call.

ShouldDisplayScrollBars()

virtual bool wxWebViewWindowFeatures::ShouldDisplayScrollBars ( ) const

pure virtual

Returns true if the target window is expected to display scroll bars as specified by a window.open() call.

ShouldDisplayStatusBar()

virtual bool wxWebViewWindowFeatures::ShouldDisplayStatusBar ( ) const

pure virtual

Returns true if the target window is expected to display a status bar as specified by a window.open() call.

ShouldDisplayToolBar()

virtual bool wxWebViewWindowFeatures::ShouldDisplayToolBar ( ) const

pure virtual

Returns true if the target window is expected to display a tool bar as specified by a window.open() call.