Struct Frame

pub struct Frame { /* private fields */ }

A finished layout with items at fixed positions.

Implementations

impl Frame

Constructor, accessors and setters.

pub fn new(size: Size, kind: FrameKind) -> Self

Create a new, empty frame.

Panics the size is not finite.

pub fn soft(size: Size) -> Self

Create a new, empty soft frame.

Panics if the size is not finite.

pub fn hard(size: Size) -> Self

Create a new, empty hard frame.

Panics if the size is not finite.

pub fn set_kind(&mut self, kind: FrameKind)

Sets the frame’s hardness.

pub fn with_kind(self, kind: FrameKind) -> Self

Sets the frame’s hardness builder-style.

pub fn kind(&self) -> FrameKind

Whether the frame is hard or soft.

pub fn is_empty(&self) -> bool

Whether the frame contains no items.

pub fn size(&self) -> Size

The size of the frame.

pub fn size_mut(&mut self) -> &mut Size

The size of the frame, mutably.

pub fn set_size(&mut self, size: Size)

Set the size of the frame.

pub fn width(&self) -> Abs

The width of the frame.

pub fn height(&self) -> Abs

The height of the frame.

pub fn baseline(&self) -> Abs

The vertical position of the frame’s baseline.

pub fn has_baseline(&self) -> bool

Whether the frame has a non-default baseline.

pub fn set_baseline(&mut self, baseline: Abs)

Set the frame’s baseline from the top.

pub fn ascent(&self) -> Abs

The distance from the baseline to the top of the frame.

This is the same as baseline(), but more in line with the terminology used in math layout.

pub fn descent(&self) -> Abs

The distance from the baseline to the bottom of the frame.

pub fn items(&self) -> Iter<'_, (Point, FrameItem)>

An iterator over the items inside this frame alongside their positions relative to the top-left of the frame.

impl Frame

Insert items and subframes.

pub fn layer(&self) -> usize

The layer the next item will be added on. This corresponds to the number of items in the frame.

pub fn push(&mut self, pos: Point, item: FrameItem)

Add an item at a position in the foreground.

pub fn push_multiple<I>(&mut self, items: I)

where I: IntoIterator<Item = (Point, FrameItem)>,

Add multiple items at a position in the foreground.

The first item in the iterator will be the one that is most in the background.

pub fn push_frame(&mut self, pos: Point, frame: Frame)

Add a frame at a position in the foreground.

Automatically decides whether to inline the frame or to include it as a group based on the number of items in it.

pub fn insert(&mut self, layer: usize, pos: Point, item: FrameItem)

Insert an item at the given layer in the frame.

This panics if the layer is greater than the number of layers present.

pub fn prepend(&mut self, pos: Point, item: FrameItem)

Add an item at a position in the background.

pub fn prepend_multiple<I>(&mut self, items: I)

where I: IntoIterator<Item = (Point, FrameItem)>,

Add multiple items at a position in the background.

The first item in the iterator will be the one that is most in the background.

pub fn prepend_frame(&mut self, pos: Point, frame: Frame)

Add a frame at a position in the background.

impl Frame

Modify the frame.

pub fn clear(&mut self)

Remove all items from the frame.

pub fn resize(&mut self, target: Size, align: Axes<FixedAlignment>) -> Point

Adjust the frame’s size, translate the original content by an offset computed according to the given alignments, and return the amount of offset.

pub fn translate(&mut self, offset: Point)

Move the baseline and contents of the frame by an offset.

pub fn hide(&mut self)

Hide all content in the frame, but keep metadata.

pub fn fill(&mut self, fill: impl Into<Paint>)

Add a background fill.

pub fn transform(&mut self, transform: Transform)

Arbitrarily transform the contents of the frame.

pub fn clip(&mut self, clip_curve: Curve)

Clip the contents of a frame to a clip curve.

The clip curve can be the size of the frame in the case of a rectangular frame. In the case of a frame with rounded corner, this should be a curve that matches the frame’s outline.

pub fn label(&mut self, label: Label)

Add a label to the frame.

pub fn set_parent(&mut self, parent: Location)

Set a parent for the frame. As a result, all elements in the frame become logically ordered immediately after the given location.

impl Frame

Tools for debugging.

pub fn mark_box(self) -> Self

Add a full size aqua background and a red baseline for debugging.

pub fn mark_box_in_place(&mut self)

Debug in place. Add a full size aqua background and a red baseline for debugging.

pub fn mark_point(&mut self, pos: Point)

Add a green marker at a position for debugging.

pub fn mark_line(&mut self, y: Abs)

Add a green marker line at a position for debugging.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Frame

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Frame

fn default() -> Frame

Returns the “default value” for a type.

impl Hash for Frame

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.