Slic3r::GUI::WebPanel Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/WebPanel.hpp>

Inheritance diagram for Slic3r::GUI::WebPanel:

Collaboration diagram for Slic3r::GUI::WebPanel:

Public Member Functions
	WebPanel (wxWindow *parent, const char *bridge_script)

Protected Member Functions
wxWebView *	browser () const
void	post_to_page (const std::string &json)
virtual std::optional< std::string >	page_html ()=0
virtual bool	on_page_message (const std::string &kind, const nlohmann::json &data)=0

Private Member Functions
void	on_load_event (wxWebViewEvent &event)
void	on_navigated (wxWebViewEvent &event)
void	on_script_message (wxWebViewEvent &event)
void	on_webview_recreated (wxCommandEvent &event)
void	apply_theme ()
void	load_page_html ()

Private Attributes
wxWebView *	m_browser {nullptr}
bool	m_content_loaded {false}
bool	m_own_page_load {false}
bool	m_content_navigated {false}

Detailed Description

Constructor & Destructor Documentation

WebPanel()

Slic3r::GUI::WebPanel::WebPanel	(	wxWindow *	parent,
		const char *	bridge_script )

    : wxPanel(parent, wxID_ANY)
{
    SetBackgroundColour(wxGetApp().get_window_default_clr());
    auto* sizer = new wxBoxSizer(wxVERTICAL);
    SetSizer(sizer);
 
    // Never null: WebView::CreateWebView substitutes a placeholder view when no backend is available.
    m_browser = WebView::CreateWebView(this, web_hosting::bootstrap_url());
    m_browser->SetBackgroundColour(GetBackgroundColour());
    m_browser->AddUserScript(wxString::FromUTF8(WebViewHostDialog::theme_user_script()));
    m_browser->AddUserScript(wxString::FromUTF8(WebViewHostDialog::element_defaults_user_script()));
    m_browser->AddUserScript(wxString::FromUTF8(bridge_script));
    m_browser->Bind(wxEVT_WEBVIEW_LOADED, &WebPanel::on_load_event, this);
    m_browser->Bind(wxEVT_WEBVIEW_ERROR, &WebPanel::on_load_event, this);
    m_browser->Bind(wxEVT_WEBVIEW_NAVIGATED, &WebPanel::on_navigated, this);
    m_browser->Bind(wxEVT_WEBVIEW_SCRIPT_MESSAGE_RECEIVED, &WebPanel::on_script_message, this);
    m_browser->Bind(EVT_WEBVIEW_RECREATED, &WebPanel::on_webview_recreated, this);
    sizer->Add(m_browser, 1, wxEXPAND);
}

References Slic3r::GUI::web_hosting::bootstrap_url(), WebView::CreateWebView(), Slic3r::GUI::WebViewHostDialog::element_defaults_user_script(), m_browser, on_load_event(), on_navigated(), on_script_message(), on_webview_recreated(), and Slic3r::GUI::WebViewHostDialog::theme_user_script().

Referenced by Slic3r::GUI::DockPanel::DockPanel(), and Slic3r::PluginPage::PluginPage().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

apply_theme()

void Slic3r::GUI::WebPanel::apply_theme ( )

private

{
    WebView::RunScript(m_browser, wxString::FromUTF8(WebViewHostDialog::theme_apply_script()));
}

References m_browser, WebView::RunScript(), and Slic3r::GUI::WebViewHostDialog::theme_apply_script().

Referenced by on_load_event(), and on_webview_recreated().

Here is the call graph for this function:

Here is the caller graph for this function:

browser()

wxWebView * Slic3r::GUI::WebPanel::browser ( ) const

inlineprotected

{ return m_browser; }

References m_browser.

Referenced by Slic3r::GUI::DockPanel::DockPanel(), Slic3r::PluginPage::PluginPage(), and Slic3r::PluginPage::on_new_window().

Here is the caller graph for this function:

load_page_html()

void Slic3r::GUI::WebPanel::load_page_html ( )

private

{
    if (const std::optional<std::string> html = page_html()) {
        m_own_page_load = true;
        m_browser->SetPage(wxString::FromUTF8(*html), web_hosting::content_base_url());
    }
}

References Slic3r::GUI::web_hosting::content_base_url(), m_browser, m_own_page_load, and page_html().

Referenced by on_load_event().

Here is the call graph for this function:

Here is the caller graph for this function:

on_load_event()

void Slic3r::GUI::WebPanel::on_load_event ( wxWebViewEvent & event )

private

{
    const bool loaded = event.GetEventType() == wxEVT_WEBVIEW_LOADED;
    if (!m_content_loaded) {
        // The first bootstrap load (or its error) triggers the swap to the plugin HTML.
        m_content_loaded = true;
        load_page_html();
    } else if (!web_hosting::is_content_url(event.GetURL())) {
        // Not our document (a linked page, a substituted error page), or any document on Edge, which ignores
        // the base URL and restores SetPage content on a reload itself; either way it takes the app theme.
        if (loaded)
            apply_theme();
    } else if (m_own_page_load) {
        m_own_page_load = false;
        // The document-start theme script is fixed at creation, so re-apply the app theme.
        if (loaded)
            apply_theme();
    } else if (loaded && m_content_navigated) {
        // WebKit reloads the SetPage base URL, so a committed load of it that we did not start is a
        // reload. A failed navigation is reported against the page that stayed but never commits.
        load_page_html();
    }
    if (loaded)
        m_content_navigated = false;
    event.Skip();
}

References apply_theme(), Slic3r::GUI::web_hosting::is_content_url(), load_page_html(), m_content_loaded, m_content_navigated, and m_own_page_load.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_navigated()

void Slic3r::GUI::WebPanel::on_navigated ( wxWebViewEvent & event )

private

{
    m_content_navigated = web_hosting::is_content_url(event.GetURL());
    event.Skip();
}

References Slic3r::GUI::web_hosting::is_content_url(), and m_content_navigated.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_page_message()

virtual bool Slic3r::GUI::WebPanel::on_page_message ( const std::string & kind, const nlohmann::json & data )

protectedpure virtual

Implemented in Slic3r::GUI::DockPanel, and Slic3r::PluginPage.

Referenced by on_script_message().

Here is the caller graph for this function:

on_script_message()

void Slic3r::GUI::WebPanel::on_script_message ( wxWebViewEvent & event )

private

{
    const nlohmann::json payload = nlohmann::json::parse(event.GetString().utf8_string(), nullptr, false);
    if (!payload.is_object() || payload.value("channel", std::string()) != "orca")
        return;
 
    const std::string kind = payload.value("kind", std::string());
    if (!on_page_message(kind, payload.contains("data") ? payload["data"] : nlohmann::json()))
        BOOST_LOG_TRIVIAL(warning) << "WebPanel ignored a window.orca '" << kind << "' call; this host does not support it";
}

References on_page_message().

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

on_webview_recreated()

void Slic3r::GUI::WebPanel::on_webview_recreated ( wxCommandEvent & event )

private

{
    SetBackgroundColour(wxGetApp().get_window_default_clr());
    m_browser->SetBackgroundColour(GetBackgroundColour());
    Refresh();
    // Handled without Skip(), so WebView::RecreateAll() does not reload the plugin page.
    apply_theme();
}

References apply_theme(), and m_browser.

Referenced by WebPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

page_html()

virtual std::optional< std::string > Slic3r::GUI::WebPanel::page_html ( )

protectedpure virtual

Implemented in Slic3r::GUI::DockPanel, and Slic3r::PluginPage.

Referenced by load_page_html().

Here is the caller graph for this function:

post_to_page()

void Slic3r::GUI::WebPanel::post_to_page ( const std::string & json )

protected

{
    WebView::RunScript(m_browser, wxString::Format(
        "(function dispatch(payload, attempts) {\n"
        "  if (typeof window.__orcaDispatch === 'function') { window.__orcaDispatch(payload); return; }\n"
        "  if (attempts < 100) window.setTimeout(function() { dispatch(payload, attempts + 1); }, 25);\n"
        "})({data: %s}, 0);",
        wxString::FromUTF8(json)));
}

References m_browser, and WebView::RunScript().

Referenced by Slic3r::GUI::DockPanel::push_message(), and Slic3r::PluginPage::push_message().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_browser

wxWebView* Slic3r::GUI::WebPanel::m_browser {nullptr}

private

{nullptr};

Referenced by WebPanel(), apply_theme(), browser(), load_page_html(), on_webview_recreated(), and post_to_page().

m_content_loaded

bool Slic3r::GUI::WebPanel::m_content_loaded {false}

private

{false};

Referenced by on_load_event().

m_content_navigated

bool Slic3r::GUI::WebPanel::m_content_navigated {false}

private

{false}; // a navigation to the base URL has committed

Referenced by on_load_event(), and on_navigated().

m_own_page_load

bool Slic3r::GUI::WebPanel::m_own_page_load {false}

private

{false};   // a SetPage of the plugin HTML is in flight

Referenced by load_page_html(), and on_load_event().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/WebPanel.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/WebPanel.cpp