Struct Layout

pub struct Layout {
    pub order: u32,
    pub location: Point<f32>,
    pub size: Size<f32>,
    pub content_size: Size<f32>,
    pub scrollbar_size: Size<f32>,
    pub border: Rect<f32>,
    pub padding: Rect<f32>,
    pub margin: Rect<f32>,
}

The final result of a layout algorithm for a single node.

Fields

order: u32

The relative ordering of the node

Nodes with a higher order should be rendered on top of those with a lower order. This is effectively a topological sort of each tree.

location: Point<f32>

The top-left corner of the node

size: Size<f32>

The width and height of the node

content_size: Size<f32>

Available on crate feature content_size only.

The width and height of the content inside the node. This may be larger than the size of the node in the case of overflowing content and is useful for computing a “scroll width/height” for scrollable nodes

scrollbar_size: Size<f32>

The size of the scrollbars in each dimension. If there is no scrollbar then the size will be zero.

border: Rect<f32>

The size of the borders of the node

padding: Rect<f32>

The size of the padding of the node

margin: Rect<f32>

The size of the margin of the node

Implementations

impl Layout

pub const fn new() -> Self

Creates a new zero-Layout.

The Zero-layout has size and location set to ZERO. The order value of this layout is set to the minimum value of 0. This means it should be rendered below all other Layouts.

pub const fn with_order(order: u32) -> Self

Creates a new zero-Layout with the supplied order value.

Nodes with a higher order should be rendered on top of those with a lower order. The Zero-layout has size and location set to ZERO.

Examples found in repository

examples/custom_tree_owned_partial.rs (line 46)

    fn default() -> Self {
        Node {
            kind: NodeKind::Flexbox,
            style: Style::default(),
            text_data: None,
            image_data: None,
            cache: Cache::new(),
            layout: Layout::with_order(0),
            children: Vec::new(),
        }
    }

examples/custom_tree_owned_unsafe.rs (line 42)

    fn default() -> Self {
        Node {
            kind: NodeKind::Flexbox,
            style: Style::default(),
            text_data: None,
            image_data: None,
            cache: Cache::new(),
            unrounded_layout: Layout::with_order(0),
            final_layout: Layout::with_order(0),
            children: Vec::new(),
        }
    }

examples/custom_tree_vec.rs (line 41)

    fn default() -> Self {
        Node {
            kind: NodeKind::Flexbox,
            style: Style::default(),
            text_data: None,
            image_data: None,
            cache: Cache::new(),
            unrounded_layout: Layout::with_order(0),
            final_layout: Layout::with_order(0),
            children: Vec::new(),
        }
    }

pub fn content_box_width(&self) -> f32

Get the width of the node’s content box

pub fn content_box_height(&self) -> f32

Get the height of the node’s content box

pub fn content_box_size(&self) -> Size<f32>

Get the size of the node’s content box

pub fn content_box_x(&self) -> f32

Get x offset of the node’s content box relative to it’s parent’s border box

pub fn content_box_y(&self) -> f32

Get x offset of the node’s content box relative to it’s parent’s border box

impl Layout

pub fn scroll_width(&self) -> f32

Available on crate feature content_size only.

Return the scroll width of the node. The scroll width is the difference between the width and the content width, floored at zero

pub fn scroll_height(&self) -> f32

Available on crate feature content_size only.

Return the scroll height of the node. The scroll height is the difference between the height and the content height, floored at zero

Trait Implementations

impl Clone for Layout

fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Layout

fn eq(&self, other: &Layout) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Layout

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Layout

impl StructuralPartialEq for Layout