KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
WEBVIEW_PANEL Class Reference

#include <webview_panel.h>

Inheritance diagram for WEBVIEW_PANEL:

Public Types

using MESSAGE_HANDLER = std::function< void(const wxString &)>
 

Public Member Functions

 WEBVIEW_PANEL (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const int style=0)
 
 ~WEBVIEW_PANEL () override
 
wxWebView * GetWebView () const
 
void LoadURL (const wxString &url)
 
void SetPage (const wxString &htmlContent)
 
bool AddMessageHandler (const wxString &name, MESSAGE_HANDLER handler)
 
void ClearMessageHandlers ()
 

Protected Member Functions

void OnNavigationRequest (wxWebViewEvent &evt)
 
void OnWebViewLoaded (wxWebViewEvent &evt)
 
void OnNewWindow (wxWebViewEvent &evt)
 
void OnScriptMessage (wxWebViewEvent &evt)
 
void OnScriptResult (wxWebViewEvent &evt)
 
void OnError (wxWebViewEvent &evt)
 

Private Attributes

bool m_initialized
 
wxWebView * m_browser
 
std::map< wxString, MESSAGE_HANDLER > m_msgHandlers
 

Detailed Description

Definition at line 9 of file webview_panel.h.

Member Typedef Documentation

◆ MESSAGE_HANDLER

using WEBVIEW_PANEL::MESSAGE_HANDLER = std::function<void( const wxString& )>

Definition at line 12 of file webview_panel.h.

Constructor & Destructor Documentation

◆ WEBVIEW_PANEL()

WEBVIEW_PANEL::WEBVIEW_PANEL ( wxWindow *  parent,
wxWindowID  id = wxID_ANY,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
const int  style = 0 
)
explicit

Definition at line 9 of file webview_panel.cpp.

References GetMajorMinorPatchVersion(), m_browser, OnError(), OnNavigationRequest(), OnNewWindow(), OnScriptMessage(), OnScriptResult(), and OnWebViewLoaded().

◆ ~WEBVIEW_PANEL()

WEBVIEW_PANEL::~WEBVIEW_PANEL ( )
override

Definition at line 44 of file webview_panel.cpp.

Member Function Documentation

◆ AddMessageHandler()

bool WEBVIEW_PANEL::AddMessageHandler ( const wxString &  name,
MESSAGE_HANDLER  handler 
)

Definition at line 71 of file webview_panel.cpp.

References m_msgHandlers.

◆ ClearMessageHandlers()

void WEBVIEW_PANEL::ClearMessageHandlers ( )

Definition at line 77 of file webview_panel.cpp.

References m_msgHandlers.

◆ GetWebView()

wxWebView * WEBVIEW_PANEL::GetWebView ( ) const
inline

Definition at line 18 of file webview_panel.h.

References m_browser.

◆ LoadURL()

void WEBVIEW_PANEL::LoadURL ( const wxString &  url)

Definition at line 48 of file webview_panel.cpp.

References m_browser.

Referenced by DIALOG_TEMPLATE_SELECTOR::SetHtml(), and DIALOG_TEMPLATE_SELECTOR::SetWidget().

◆ OnError()

void WEBVIEW_PANEL::OnError ( wxWebViewEvent &  evt)
protected

Definition at line 182 of file webview_panel.cpp.

Referenced by WEBVIEW_PANEL().

◆ OnNavigationRequest()

void WEBVIEW_PANEL::OnNavigationRequest ( wxWebViewEvent &  evt)
protected

Definition at line 82 of file webview_panel.cpp.

Referenced by WEBVIEW_PANEL().

◆ OnNewWindow()

void WEBVIEW_PANEL::OnNewWindow ( wxWebViewEvent &  evt)
protected

Definition at line 144 of file webview_panel.cpp.

References m_browser.

Referenced by WEBVIEW_PANEL().

◆ OnScriptMessage()

void WEBVIEW_PANEL::OnScriptMessage ( wxWebViewEvent &  evt)
protected

Definition at line 154 of file webview_panel.cpp.

References m_msgHandlers.

Referenced by WEBVIEW_PANEL().

◆ OnScriptResult()

void WEBVIEW_PANEL::OnScriptResult ( wxWebViewEvent &  evt)
protected

Definition at line 176 of file webview_panel.cpp.

Referenced by WEBVIEW_PANEL().

◆ OnWebViewLoaded()

void WEBVIEW_PANEL::OnWebViewLoaded ( wxWebViewEvent &  evt)
protected

Definition at line 93 of file webview_panel.cpp.

References m_browser, m_initialized, and m_msgHandlers.

Referenced by WEBVIEW_PANEL().

◆ SetPage()

void WEBVIEW_PANEL::SetPage ( const wxString &  htmlContent)

Definition at line 66 of file webview_panel.cpp.

References m_browser.

Referenced by DIALOG_TEMPLATE_SELECTOR::DIALOG_TEMPLATE_SELECTOR(), DIALOG_TEMPLATE_SELECTOR::OnPageChange(), DIALOG_TEMPLATE_SELECTOR::replaceCurrentPage(), and DIALOG_TEMPLATE_SELECTOR::SetWidget().

Member Data Documentation

◆ m_browser

wxWebView* WEBVIEW_PANEL::m_browser
private

Definition at line 36 of file webview_panel.h.

Referenced by GetWebView(), LoadURL(), OnNewWindow(), OnWebViewLoaded(), SetPage(), and WEBVIEW_PANEL().

◆ m_initialized

bool WEBVIEW_PANEL::m_initialized
private

Definition at line 35 of file webview_panel.h.

Referenced by OnWebViewLoaded().

◆ m_msgHandlers

std::map<wxString, MESSAGE_HANDLER> WEBVIEW_PANEL::m_msgHandlers
private

Definition at line 37 of file webview_panel.h.

Referenced by AddMessageHandler(), ClearMessageHandlers(), OnScriptMessage(), and OnWebViewLoaded().

The documentation for this class was generated from the following files: