pulp::view::ScriptedEditorSession Class Reference

The part of a scripted editor session that editor hosts drive: the frame pump, the content-first open, GPU-surface handoff, and teardown. More...

#include <scripted_editor_session.hpp>

Public Member Functions
virtual	~ScriptedEditorSession ()=default
virtual bool	document_load_pending () const noexcept=0
	See ScriptedUiSession::document_load_pending().
virtual bool	borrows_root (const View &view) const noexcept=0
	See ScriptedUiSession::borrows_root().
virtual bool	poll (std::string *error=nullptr)=0
	See ScriptedUiSession::poll().
virtual bool	settling () const noexcept=0
	See ScriptedUiSession::settling().
virtual bool	complete_pending_load (std::string *error=nullptr)=0
	See ScriptedUiSession::complete_pending_load().
virtual void	release_root () noexcept=0
	See ScriptedUiSession::release_root().
virtual void	set_host_kind (std::string kind)=0
	See ScriptedUiSession::set_host_kind().
virtual void	attach_gpu_surface (render::GpuSurface *gpu_surface)=0
	See ScriptedUiSession::attach_gpu_surface().

Protected Member Functions
	ScriptedEditorSession ()=default
	ScriptedEditorSession (const ScriptedEditorSession &)=default
ScriptedEditorSession &	operator= (const ScriptedEditorSession &)=default

Detailed Description

The part of a scripted editor session that editor hosts drive: the frame pump, the content-first open, GPU-surface handoff, and teardown.

Hosts reach a session only through these virtual calls, so a binary that never constructs a ScriptedUiSession references none of the script runtime and a static link drops it. Calling a non-virtual ScriptedUiSession method from always-linked host code would pull the whole runtime into every plug-in, including ones whose editor is AutoUi.

Constructor & Destructor Documentation

~ScriptedEditorSession()

virtual pulp::view::ScriptedEditorSession::~ScriptedEditorSession ( )

virtualdefault

ScriptedEditorSession() [1/2]

pulp::view::ScriptedEditorSession::ScriptedEditorSession ( )

protecteddefault

ScriptedEditorSession() [2/2]

pulp::view::ScriptedEditorSession::ScriptedEditorSession ( const ScriptedEditorSession & )

protecteddefault

Member Function Documentation

attach_gpu_surface()

virtual void pulp::view::ScriptedEditorSession::attach_gpu_surface ( render::GpuSurface * gpu_surface )

pure virtual

See ScriptedUiSession::attach_gpu_surface().

Implemented in pulp::view::ScriptedUiSession.

borrows_root()

virtual bool pulp::view::ScriptedEditorSession::borrows_root ( const View & view ) const

pure virtualnoexcept

See ScriptedUiSession::borrows_root().

Implemented in pulp::view::ScriptedUiSession.

complete_pending_load()

virtual bool pulp::view::ScriptedEditorSession::complete_pending_load ( std::string * error = nullptr )

pure virtual

See ScriptedUiSession::complete_pending_load().

Implemented in pulp::view::ScriptedUiSession.

document_load_pending()

virtual bool pulp::view::ScriptedEditorSession::document_load_pending ( ) const

pure virtualnoexcept

See ScriptedUiSession::document_load_pending().

Implemented in pulp::view::ScriptedUiSession.

operator=()

ScriptedEditorSession & pulp::view::ScriptedEditorSession::operator= ( const ScriptedEditorSession & )

protecteddefault

poll()

virtual bool pulp::view::ScriptedEditorSession::poll ( std::string * error = nullptr )

pure virtual

See ScriptedUiSession::poll().

Implemented in pulp::view::ScriptedUiSession.

release_root()

virtual void pulp::view::ScriptedEditorSession::release_root ( )

pure virtualnoexcept

See ScriptedUiSession::release_root().

Implemented in pulp::view::ScriptedUiSession.

set_host_kind()

virtual void pulp::view::ScriptedEditorSession::set_host_kind ( std::string kind )

pure virtual

See ScriptedUiSession::set_host_kind().

Implemented in pulp::view::ScriptedUiSession.

settling()

virtual bool pulp::view::ScriptedEditorSession::settling ( ) const

pure virtualnoexcept

See ScriptedUiSession::settling().

Implemented in pulp::view::ScriptedUiSession.

---

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

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