Realm

oa::Workspace

Editor-style dock host: a serializable node tree over registered items. Implements ViewerLiveSource so a Viewer opened with ViewerMode::Workspace renders and routes through it unchanged; the dock layout round-trips through Workspace::to_json / Workspace::from_json as application-owned state.

StRust public API

Declaration

pub struct Workspace { /* private fields */ }
Public Rust declaration.

Public Methods

pub fn set_layout(&mut self, json: &str) -> Result<()>
pub fn open_tab(&mut self, item: Box<dyn WorkspaceItem>) -> Result<()>
pub fn root(&self) -> &WorkspaceNode
pub fn root_mut(&mut self) -> &mut WorkspaceNode
pub fn add_item(&mut self, item: Box<dyn WorkspaceItem>)
pub fn item(&self, id: &str) -> Option<&dyn WorkspaceItem>
pub fn item_mut(&mut self, id: &str) -> Option<&mut (dyn WorkspaceItem + '_)>
pub fn item_ids(&self) -> impl Iterator<Item = &str>
pub fn to_json(&self) -> Result<String>
pub fn render(&mut self, ui: &mut Ui<'_>, rect: PixelRect) -> Result<()>
pub fn route_event(&mut self, event: &InputEvent) -> Result<()>
fn capabilities(&self) -> ViewerLiveCapabilities
fn open(&mut self, _engine: &Engine) -> Result<()>
fn update(&mut self, delta_ms: f32) -> Result<()>
fn render(&mut self, ui: &mut Ui<'_>, width: u32, height: u32) -> Result<()>
fn on_event(&mut self, event: &InputEvent) -> Result<()>
fn close(&mut self) -> Result<()>

Associated Functions

pub fn new(root: WorkspaceNode) -> Self
pub fn from_json(json: &str) -> Result<Self>
fn default() -> Self

Public Method Documentation

pub fn set_layout(&mut self, json: &str) -> Result<()>
No public source comment is attached to this declaration.
pub fn open_tab(&mut self, item: Box<dyn WorkspaceItem>) -> Result<()>
No public source comment is attached to this declaration.
pub fn root( &self ) -> &WorkspaceNode
No public source comment is attached to this declaration.
pub fn root_mut( &mut self ) -> &mut WorkspaceNode
No public source comment is attached to this declaration.
pub fn add_item( &mut self, item: Box<dyn WorkspaceItem> )
No public source comment is attached to this declaration.
pub fn item( &self, id: &str ) -> Option<&dyn WorkspaceItem>
No public source comment is attached to this declaration.
pub fn item_mut(&mut self, id: &str) -> Option<&mut ( dyn WorkspaceItem + '_ )>
No public source comment is attached to this declaration.
pub fn item_ids( &self ) -> impl Iterator<Item = &str>
No public source comment is attached to this declaration.
pub fn to_json( &self ) -> Result<String>
No public source comment is attached to this declaration.
pub fn render(&mut self, ui: &mut Ui<'_>, rect: PixelRect) -> Result<()>
No public source comment is attached to this declaration.
pub fn route_event(&mut self, event: &InputEvent) -> Result<()>
No public source comment is attached to this declaration.
fn capabilities( &self ) -> ViewerLiveCapabilities
Called once when the Viewer obtains an Engine.
fn open(&mut self, _engine: &Engine) -> Result<()>
No public source comment is attached to this declaration.
fn update(&mut self, delta_ms: f32) -> Result<()>
No public source comment is attached to this declaration.
fn render(&mut self, ui: &mut Ui<'_>, width: u32, height: u32) -> Result<()>
No public source comment is attached to this declaration.
fn on_event(&mut self, event: &InputEvent) -> Result<()>
No public source comment is attached to this declaration.
fn close(&mut self) -> Result<()>
No public source comment is attached to this declaration.
pub fn new( root: WorkspaceNode ) -> Self
No public source comment is attached to this declaration.
pub fn from_json( json: &str ) -> Result<Self>
No public source comment is attached to this declaration.
fn default() -> Self
No public source comment is attached to this declaration.