pub struct DockWorkspace { /* private fields */ }Expand description
Retained editor workspace with a split/tab dock graph and same-window floating panels.
Every panel widget remains owned by this workspace for its full lifetime. State changes only alter which registered panel is measured, arranged, and visited at each logical location.
Implementations§
Source§impl DockWorkspace
impl DockWorkspace
pub fn new(state: DockWorkspaceState) -> DockWorkspace
pub fn name(self, name: impl Into<String>) -> DockWorkspace
pub fn theme(self, theme: DefaultTheme) -> DockWorkspace
pub fn theme_when<F>(self, theme: F) -> DockWorkspacewhere
F: Fn() -> DefaultTheme + 'static,
pub fn with_panel<W>(
self,
id: DockPanelId,
title: impl Into<String>,
child: W,
) -> DockWorkspacewhere
W: Widget + 'static,
pub fn push_panel<W>(
&mut self,
id: DockPanelId,
title: impl Into<String>,
child: W,
) -> Result<(), DockLayoutError>where
W: Widget + 'static,
pub fn state(&self) -> DockWorkspaceState
pub fn panel_widget_id(&self, panel: DockPanelId) -> Option<WidgetId>
pub fn validate_registered_panels(&self) -> Result<(), DockLayoutError>
Sourcepub fn validate_snapshot_panels(
&self,
snapshot: &DockWorkspaceSnapshot,
) -> Result<(), DockLayoutError>
pub fn validate_snapshot_panels( &self, snapshot: &DockWorkspaceSnapshot, ) -> Result<(), DockLayoutError>
Validates that every panel referenced by snapshot has a widget in
this workspace’s stable registry.
This complements the structural graph validation performed by
DockWorkspaceState::apply_snapshot.
Sourcepub fn apply_snapshot(
&self,
snapshot: DockWorkspaceSnapshot,
) -> Result<bool, DockLayoutError>
pub fn apply_snapshot( &self, snapshot: DockWorkspaceSnapshot, ) -> Result<bool, DockLayoutError>
Applies a restored snapshot only after validating both its graph and all panel IDs against this workspace’s registry.
Trait Implementations§
Source§impl Widget for DockWorkspace
impl Widget for DockWorkspace
fn event(&mut self, ctx: &mut EventCtx, event: &Event)
fn measure(&mut self, ctx: &mut MeasureCtx, constraints: Constraints) -> Size
fn arrange(&mut self, ctx: &mut ArrangeCtx, bounds: Rect)
fn paint(&self, ctx: &mut PaintCtx)
fn semantics(&self, ctx: &mut SemanticsCtx)
fn accepts_focus(&self) -> bool
fn stack_host_options(&self) -> Option<StackHostOptions>
Source§fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
fn visit_children(&self, visitor: &mut dyn WidgetPodVisitor)
Visit this widget’s logical children. Read more
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Mutably visit this widget’s logical children. Read more
Source§fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
Receive a typed command addressed directly to this widget. Commands are
target-only and do not capture or bubble through the widget tree.
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Publish widget-specific state for an inspector snapshot. Read more
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
Compute a provisional size. Containers can override this to query child
sizes without committing their final layouts. The default preserves
existing custom widgets by delegating to
measure; it may mutate state.
Child measure calls still commit state. Use child size probes explicitly
when only their scalar results are needed.
Results must match measure for the same content and constraints.
A final measure is still required before arrangement after a probe miss.Source§fn measure_axis(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
axis: Axis,
) -> f32
fn measure_axis( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, axis: Axis, ) -> f32
Query one component of
measure_size under exactly the same constraints.
Overrides may avoid computing the other component, but must return the
same extent. Like size probes, this does not replace final measurement.Source§fn intrinsic_size(
&mut self,
ctx: &mut MeasureCtx,
axis: Axis,
available_cross: f32,
) -> IntrinsicSize
fn intrinsic_size( &mut self, ctx: &mut MeasureCtx, axis: Axis, available_cross: f32, ) -> IntrinsicSize
Report the smallest and preferred extent along one axis. Read more
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
Opt into retaining paint and semantics between targeted invalidations.
Output must depend only on widget state, context, and observed sources;
changes must invalidate the widget. Untracked readers and callbacks with
side effects should keep the default. An opaque descendant also prevents
caching its ancestors. Explicit subtree/window requests always rerun them.
A source observed only in paint or semantics invalidates that callback,
not its descendants. Mutating child state requires a child/subtree request.
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Describe this widget as the logical owner of a presented overlay. Read more
fn focus_changed(&mut self, _ctx: &mut EventCtx, _focused: bool)
Auto Trait Implementations§
impl !RefUnwindSafe for DockWorkspace
impl !Send for DockWorkspace
impl !Sync for DockWorkspace
impl !UnwindSafe for DockWorkspace
impl Freeze for DockWorkspace
impl Unpin for DockWorkspace
impl UnsafeUnpin for DockWorkspace
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.