pulp::view::WebViewPanel Class Reference

#include <web_view.hpp>

Public Types
using	JsCallback = std::function<std::string(const std::string& args_json)>
using	EvalCallback
using	MessageHandler = std::function<std::string(const WebViewMessage& message)>
using	ReadyHandler = std::function<void()>

Public Member Functions
virtual	~WebViewPanel ()=default
virtual bool	is_ready () const =0
virtual void	set_ready_handler (ReadyHandler handler)=0
virtual NativeViewHandle	native_handle ()=0
virtual std::vector< uint8_t >	snapshot_png ()
virtual void	navigate (const std::string &url)=0
virtual void	set_html (const std::string &html)=0
virtual void	evaluate_js (const std::string &js)=0
virtual void	evaluate_js (const std::string &js, EvalCallback callback)=0
virtual void	bind (const std::string &name, JsCallback callback)=0
virtual void	set_message_handler (MessageHandler handler)=0
virtual void	post_message (const WebViewMessage &message)=0
virtual void	set_size (uint32_t width, uint32_t height)=0

Static Public Member Functions
static std::unique_ptr< WebViewPanel >	create (const WebViewOptions &options={})

Member Typedef Documentation

EvalCallback

using pulp::view::WebViewPanel::EvalCallback

Initial value:

 std::function<void(const std::string& result_json,
                                            const std::string& error)>

JsCallback

using pulp::view::WebViewPanel::JsCallback = std::function<std::string(const std::string& args_json)>

MessageHandler

using pulp::view::WebViewPanel::MessageHandler = std::function<std::string(const WebViewMessage& message)>

ReadyHandler

using pulp::view::WebViewPanel::ReadyHandler = std::function<void()>

Constructor & Destructor Documentation

~WebViewPanel()

virtual pulp::view::WebViewPanel::~WebViewPanel ( )

virtualdefault

Member Function Documentation

bind()

virtual void pulp::view::WebViewPanel::bind ( const std::string & name, JsCallback callback )

pure virtual

create()

std::unique_ptr< WebViewPanel > pulp::view::WebViewPanel::create ( const WebViewOptions & options = {} )

static

evaluate_js() [1/2]

virtual void pulp::view::WebViewPanel::evaluate_js ( const std::string & js )

pure virtual

evaluate_js() [2/2]

virtual void pulp::view::WebViewPanel::evaluate_js ( const std::string & js, EvalCallback callback )

pure virtual

is_ready()

virtual bool pulp::view::WebViewPanel::is_ready ( ) const

pure virtual

native_handle()

virtual NativeViewHandle pulp::view::WebViewPanel::native_handle ( )

pure virtual

navigate()

virtual void pulp::view::WebViewPanel::navigate ( const std::string & url )

pure virtual

post_message()

virtual void pulp::view::WebViewPanel::post_message ( const WebViewMessage & message )

pure virtual

set_html()

virtual void pulp::view::WebViewPanel::set_html ( const std::string & html )

pure virtual

set_message_handler()

virtual void pulp::view::WebViewPanel::set_message_handler ( MessageHandler handler )

pure virtual

set_ready_handler()

virtual void pulp::view::WebViewPanel::set_ready_handler ( ReadyHandler handler )

pure virtual

set_size()

virtual void pulp::view::WebViewPanel::set_size ( uint32_t width, uint32_t height )

pure virtual

snapshot_png()

virtual std::vector< uint8_t > pulp::view::WebViewPanel::snapshot_png ( )

inlinevirtual

---

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

• /home/runner/work/pulp/pulp/core/view/include/pulp/view/web_view.hpp