Struct masonry::widget::Portal

pub struct Portal<W: Widget> { /* private fields */ }

Implementations

impl<W: Widget> Portal<W>

pub fn new(child: W) -> Self

pub fn get_viewport_pos(&self) -> Point

pub fn child(&self) -> WidgetRef<'_, W>

pub fn constrain_vertical(self, constrain: bool) -> Self

Builder-style method for deciding whether to constrain the child vertically.

The default is false.

This setting affects how a ClipBox lays out its child.

• When it is false (the default), the child does not receive any upper bound on its height: the idea is that the child can be as tall as it wants, and the viewport will somehow get moved around to see all of it.
• When it is true, the viewport’s maximum height will be passed down as an upper bound on the height of the child, and the viewport will set its own height to be the same as its child’s height.

pub fn constrain_horizontal(self, constrain: bool) -> Self

Builder-style method for deciding whether to constrain the child horizontally.

The default is false. See constrain_vertical for more details.

pub fn content_must_fill(self, must_fill: bool) -> Self

Builder-style method to set whether the child must fill the view.

If false (the default) there is no minimum constraint on the child’s size. If true, the child is passed the same minimum constraints as the ClipBox.

Trait Implementations

impl<W: Widget> Widget for Portal<W>

fn on_pointer_event(&mut self, ctx: &mut EventCtx<'_>, event: &PointerEvent)

Handle an event - usually user interaction.

fn on_text_event(&mut self, ctx: &mut EventCtx<'_>, event: &TextEvent)

fn on_access_event(&mut self, ctx: &mut EventCtx<'_>, event: &AccessEvent)

Handle an event from the platform’s accessibility API.

fn on_status_change( &mut self, _ctx: &mut LifeCycleCtx<'_>, _event: &StatusChange )

fn lifecycle(&mut self, ctx: &mut LifeCycleCtx<'_>, event: &LifeCycle)

Handle a lifecycle notification.

fn layout(&mut self, ctx: &mut LayoutCtx<'_>, bc: &BoxConstraints) -> Size

Compute layout.

fn paint(&mut self, ctx: &mut PaintCtx<'_>, scene: &mut Scene)

Paint the widget appearance.

fn accessibility_role(&self) -> Role

fn accessibility(&mut self, ctx: &mut AccessCtx<'_>)

fn children(&self) -> SmallVec<[WidgetRef<'_, dyn Widget>; 16]>

Return references to this widget’s children.

fn make_trace_span(&self) -> Span

Return a span for tracing.

fn get_debug_text(&self) -> Option<String>

Return a small string representing important info about this widget instance.

fn get_child_at_pos(&self, pos: Point) -> Option<WidgetRef<'_, dyn Widget>>

Return which child, if any, has the given pos in its layout rect.