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 until it is removed
through DockWorkspaceState::remove_panel. Layout 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
Sourcepub fn panel_builder<F>(self, panel_builder: F) -> DockWorkspace
pub fn panel_builder<F>(self, panel_builder: F) -> DockWorkspace
Creates the widget for a panel added through
DockWorkspaceState::add_panel.
The builder runs once per added panel, on the UI thread. Without a builder an added panel has a tab and empty content.
Sourcepub fn on_close_request<F>(self, on_close_request: F) -> DockWorkspace
pub fn on_close_request<F>(self, on_close_request: F) -> DockWorkspace
Decides what a press on a tab’s close button does.
Without a handler a closed panel is hidden, which keeps its widget and
lets DockWorkspaceState::show bring it back.
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,
Sourcepub fn with_panel<W>(
self,
id: DockPanelId,
options: impl Into<DockPanelOptions>,
child: W,
) -> DockWorkspacewhere
W: Widget + 'static,
pub fn with_panel<W>(
self,
id: DockPanelId,
options: impl Into<DockPanelOptions>,
child: W,
) -> DockWorkspacewhere
W: Widget + 'static,
Registers a panel. options is a title or a full DockPanelOptions.
pub fn push_panel<W>(
&mut self,
id: DockPanelId,
options: impl Into<DockPanelOptions>,
child: W,
) -> Result<(), DockLayoutError>where
W: Widget + 'static,
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)
Source§fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
fn visit_children_mut(&mut self, visitor: &mut dyn WidgetPodMutVisitor)
Source§fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn command(&mut self, _ctx: &mut EventCtx, _command: &Command<'_>)
fn debug_name(&self) -> &'static str
Source§fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
fn diagnostics(&self, _ctx: &mut WidgetDiagnosticsCtx)
Source§fn measure_size(
&mut self,
ctx: &mut MeasureCtx,
constraints: Constraints,
) -> Size
fn measure_size( &mut self, ctx: &mut MeasureCtx, constraints: Constraints, ) -> Size
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
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
Source§fn supports_output_reuse(&self) -> bool
fn supports_output_reuse(&self) -> bool
fn layer_options(&self) -> LayerOptions
fn layer_properties(&self) -> LayerProperties
Source§fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
fn layer_properties_at(&self, frame_time: f64) -> LayerProperties
frame_time. Override this
instead of Widget::layer_properties when they come from Motion
values; the runtime refreshes them without repainting when the motion
invalidates Transform or Effect.fn stack_surface_options(&self) -> Option<StackSurfaceOptions>
Source§fn overlay_options(&self) -> Option<OverlayOptions>
fn overlay_options(&self) -> Option<OverlayOptions>
Source§fn hit_test_self(&self) -> bool
fn hit_test_self(&self) -> bool
false so those points reach what is behind
them.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 Forget for DockWorkspace
impl Freeze for DockWorkspace
impl Move 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
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>
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>
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)
&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)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.