Struct kas_core::layout::FrameRules

pub struct FrameRules { /* private fields */ }

Frame size rules

This is a special variant of SizeRules for frames. It is assumed that frames are not stretchy (i.e. that min-size equals ideal-size); additionally frame rules have a content offset and a minimum internal margin size.

Implementations

impl FrameRules

pub const ZERO: Self = _

pub const fn new(size: i32, inner: (u16, u16), outer: (u16, u16)) -> Self

Construct new FrameRules

All parameters use pairs (first, second) where first is the top/left component. Parameters inner and outer are inner and outer margin sizes respectively while size is the frame size.

If size > 0 then internal margins are the maximum of inner and content margin; generated rules have size content_size + size + inner_margin and outer margin outer.

If size ≤ 0 then the generated rules are simply content rules but with margins the maximum of inner and content margins; outer and size are ignored (other than to enable this mode).

pub const fn new_sym(size: i32, inner: u16, outer: u16) -> Self

Construct (symmetric on axis)

pub fn surround(self, content: SizeRules) -> (SizeRules, i32, i32)

Generate rules for content surrounded by this frame

Returns the tuple (rules, offset, size):

• the generated rules
• the content offset within the allocated rect
• the size consumed by the frame and inner margins (thus the content’s size will be that allocated for this object minus this size value)

Trait Implementations

impl Clone for FrameRules

fn clone(&self) -> FrameRules

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameRules

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

Formats the value using the given formatter.

impl Copy for FrameRules