mirror of
https://github.com/OrcaSlicer/OrcaSlicer.git
synced 2026-09-24 01:12:35 +00:00
HanifKoh
2876374b45
orca.host.ui.create_dock_panel(html, title, width, height, on_message, on_close, dock) hosts plugin HTML in a pane of the Plater's dock manager, next to the sidebar, and returns a UiDockPanel handle (post/show/hide/close/is_open). The arguments follow create_window(). The panel uses the window.orca bridge of plugin windows, restores its position and size from the saved window layout, hides with the Plater off the Prepare and Preview tabs when floating, and is closed with its plugin; plugin panes are removed in MainFrame::shutdown(). The web view hosting moves out of PluginPage into a shared WebPanel base: bootstrap page and swap to the plugin HTML, theme, element-default and bridge scripts, window.orca message parsing, delivery to the page, and live re-theming, also re-applied on every load after the swap. Pages tabs and docked panels both derive from it. Pages tabs now re-theme in place on a theme change instead of being reloaded, and a window.orca call a host does not support is logged. What the hosts share no longer lives in one of them: the bootstrap page, the base URL and the plugin-window bridge move to Widgets/WebHosting, used by WebDialog and WebPanel alike. The Plater restores plugin panes with a new saved-layout parser, GUI/AuiPaneLayout, kept in its own small header so slic3rutils can test it without pulling in the Plater. The web hosting classes carry no plugin name, so other hosts can reuse them: PluginWebDialog becomes WebDialog (its bootstrap page moves to resources/web/dialog/WebDialog), and destroy_for_plugin(), load_plugin_content() and plugin_defaults_user_script() become destroy_silently(), load_page_html() and element_defaults_user_script(). Includes a sample plugin (sandboxes/orca_dock_panel_plugin_any.py) and binding and layout-helper tests in slic3rutils.
49 lines
1.7 KiB
C++
49 lines
1.7 KiB
C++
#pragma once
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
#include <wx/panel.h>
|
|
#include <wx/webview.h>
|
|
|
|
#include <optional>
|
|
#include <string>
|
|
|
|
namespace Slic3r { namespace GUI {
|
|
|
|
// Host-supplied HTML in a web view panel, for any window that embeds or derives from it (today plugin
|
|
// Pages tabs and docked panels): bootstrap page and swap, theme and bridge scripts, live re-theming, and
|
|
// window.orca messages routed to on_page_message().
|
|
class WebPanel : public wxPanel
|
|
{
|
|
public:
|
|
WebPanel(wxWindow* parent, const char* bridge_script);
|
|
|
|
protected:
|
|
wxWebView* browser() const { return m_browser; }
|
|
|
|
// Delivers an already serialised JSON value to the page's window.orca.onMessage handlers,
|
|
// waiting briefly for the bridge while the page is still loading. Main thread only.
|
|
void post_to_page(const std::string& json);
|
|
|
|
// The plugin HTML to show once the bootstrap page has loaded, and again when WebKit reloads it;
|
|
// std::nullopt leaves it blank.
|
|
virtual std::optional<std::string> page_html() = 0;
|
|
// A window.orca message from the page; false for a kind this host does not handle (logged).
|
|
virtual bool on_page_message(const std::string& kind, const nlohmann::json& data) = 0;
|
|
|
|
private:
|
|
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();
|
|
|
|
wxWebView* m_browser{nullptr};
|
|
bool m_content_loaded{false};
|
|
bool m_own_page_load{false}; // a SetPage of the plugin HTML is in flight
|
|
bool m_content_navigated{false}; // a navigation to the base URL has committed
|
|
};
|
|
|
|
}} // namespace Slic3r::GUI
|