Slic3r::GUI::DockPanel Class Reference

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

Inheritance diagram for Slic3r::GUI::DockPanel:

Collaboration diagram for Slic3r::GUI::DockPanel:

Public Types
using	MessageHandler = std::function<void(const nlohmann::json& data)>
using	CloseHandler = std::function<void()>

Public Member Functions
	DockPanel (wxWindow *parent, const std::string &html, MessageHandler on_message, CloseHandler on_close, CloseHandler on_destroyed)
	~DockPanel () override
void	push_message (const nlohmann::json &data)
void	request_close ()
void	destroy_silently ()
void	fire_close ()

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

Private Member Functions
void	remove_pane ()
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
std::string	m_html
bool	m_closing {false}
MessageHandler	m_on_message
CloseHandler	m_on_close
CloseHandler	m_on_destroyed
wxWebView *	m_browser {nullptr}
bool	m_content_loaded {false}
bool	m_own_page_load {false}
bool	m_content_navigated {false}

Detailed Description

Member Typedef Documentation

CloseHandler

using Slic3r::GUI::DockPanel::CloseHandler = std::function<void()>

MessageHandler

using Slic3r::GUI::DockPanel::MessageHandler = std::function<void(const nlohmann::json& data)>

Constructor & Destructor Documentation

DockPanel()

Slic3r::GUI::DockPanel::DockPanel	(	wxWindow *	parent,
		const std::string &	html,
		MessageHandler	on_message,
		CloseHandler	on_close,
		CloseHandler	on_destroyed )

    : WebPanel(parent, web_hosting::orca_bridge_script())
    , m_html(html)
    , m_on_message(std::move(on_message))
    , m_on_close(std::move(on_close))
    , m_on_destroyed(std::move(on_destroyed))
{
    // A link asking for a new window has nowhere to open from a docked panel.
    browser()->Bind(wxEVT_WEBVIEW_NEWWINDOW, [](wxWebViewEvent& event) { event.Veto(); });
}

References Slic3r::GUI::WebPanel::WebPanel(), Slic3r::GUI::WebPanel::browser(), m_html, m_on_close, m_on_destroyed, and m_on_message.

Here is the call graph for this function:

~DockPanel()

Slic3r::GUI::DockPanel::~DockPanel ( )

override

{
    if (m_on_destroyed)
        m_on_destroyed();
}

References m_on_destroyed.

Member Function Documentation

apply_theme()

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

privateinherited

{
    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

inlineprotectedinherited

{ 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:

destroy_silently()

void Slic3r::GUI::DockPanel::destroy_silently

(

)

{
    m_closing  = true;
    m_on_close = nullptr;
    remove_pane();
}

References m_closing, m_on_close, and remove_pane().

Here is the call graph for this function:

fire_close()

void Slic3r::GUI::DockPanel::fire_close

(

)

{
    if (m_closing)
        return;
    m_closing = true;
    if (m_on_close) {
        CloseHandler on_close = std::move(m_on_close);
        m_on_close            = nullptr;
        on_close();
    }
}

References m_closing, and m_on_close.

Referenced by request_close().

Here is the caller graph for this function:

load_page_html()

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

privateinherited

{
    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 )

privateinherited

{
    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 )

privateinherited

{
    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()

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

overrideprotectedvirtual

Implements Slic3r::GUI::WebPanel.

{
    if (kind == "message") {
        if (m_on_message)
            m_on_message(data);
        return true;
    }
    if (kind == "close") {
        request_close();
        return true;
    }
    return false;
}

References m_on_message, and request_close().

Here is the call graph for this function:

on_script_message()

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

privateinherited

{
    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 )

privateinherited

{
    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()

std::optional< std::string > Slic3r::GUI::DockPanel::page_html ( )

inlineoverrideprotectedvirtual

Implements Slic3r::GUI::WebPanel.

{ return m_html; }

References m_html.

post_to_page()

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

protectedinherited

{
    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:

push_message()

void Slic3r::GUI::DockPanel::push_message

(

const nlohmann::json &

data

)

{
    if (!m_closing)
        post_to_page(data.dump(-1, ' ', false, nlohmann::json::error_handler_t::replace));
}

References m_closing, and Slic3r::GUI::WebPanel::post_to_page().

Here is the call graph for this function:

remove_pane()

void Slic3r::GUI::DockPanel::remove_pane ( )

private

{
    if (Plater* plater = wxGetApp().plater())
        plater->remove_dock_pane(this);
    else
        Destroy();
}

References Slic3r::GUI::plater().

Referenced by destroy_silently().

Here is the call graph for this function:

Here is the caller graph for this function:

request_close()

void Slic3r::GUI::DockPanel::request_close

(

)

{
    if (m_closing)
        return;
    fire_close();
    // A page-requested close arrives inside the web view's script callback, so destroy later; another
    // close path may have destroyed the panel by then.
    wxWeakRef<DockPanel> self(this);
    CallAfter([self]() {
        if (self)
            self->remove_pane();
    });
}

References fire_close(), and m_closing.

Referenced by on_page_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}

privateinherited

{nullptr};

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

m_closing

bool Slic3r::GUI::DockPanel::m_closing {false}

private

{false};

Referenced by destroy_silently(), fire_close(), push_message(), and request_close().

m_content_loaded

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

privateinherited

{false};

Referenced by on_load_event().

m_content_navigated

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

privateinherited

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

Referenced by on_load_event(), and on_navigated().

m_html

std::string Slic3r::GUI::DockPanel::m_html

private

Referenced by DockPanel(), and page_html().

m_on_close

CloseHandler Slic3r::GUI::DockPanel::m_on_close

private

Referenced by DockPanel(), destroy_silently(), and fire_close().

m_on_destroyed

CloseHandler Slic3r::GUI::DockPanel::m_on_destroyed

private

Referenced by DockPanel(), and ~DockPanel().

m_on_message

MessageHandler Slic3r::GUI::DockPanel::m_on_message

private

Referenced by DockPanel(), and on_page_message().

m_own_page_load

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

privateinherited

{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/DockPanel.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/DockPanel.cpp