Struct LayoutNode

pub struct LayoutNode { /* private fields */ }

A single node of a layout tree.

LayoutNodes allow you to hierarchically represent layouts in a tree structure. They have the following properties:

• A layout direction, set with set_dir: This determines the direction that children layout nodes are laid out in.
• A size proportion, set with set_size_proportion: This determines the proportion of space a layout node takes up in relation to its siblings.
• Gaps, set with set_gaps: This determines the gaps surrounding a layout node.
• A traversal index, set with set_traversal_index: This determines the order that the layout tree is traversed in when assigning layout node geometries to windows.
• Traversal overrides, set with set_traversal_overrides: This provides a way to provide per-window overrides to tree traversal. This is used to enable otherwise impossible window insertion strategies. For example, the Corner layout generator overrides traversal to allow windows to be inserted into the vertical and horizontal stacks in an alternating fashion.
• An optional label, set with set_label: This gives the compositor a hint when diffing layout trees, allowing it to, for example, decide whether to move a node or delete it and insert a new one.

Implementations

impl LayoutNode

pub fn new() -> Self

Creates a new layout node.

pub fn new_with_label(label: impl ToString) -> Self

Creates a new layout node with the given label.

pub fn new_with_traversal_index(index: u32) -> Self

Creates a new layout node with the given traversal index.

pub fn new_with_label_and_index(label: impl ToString, index: u32) -> Self

Creates a new layout node with the given label and traversal index.

pub fn set_traversal_overrides( &self, overrides: impl IntoIterator<Item = (u32, Vec<u32>)>, )

Sets this node’s traversal overrides, allowing it to change how windows are assigned geometries.

pub fn add_child(&self, child: Self)

Adds a child layout node to this node.

pub fn set_label(&self, label: Option<impl ToString>)

Sets this node’s label.

pub fn set_traversal_index(&self, index: u32)

Sets this node’s traversal index, changing how the compositor traverses the tree when assigning geometries to windows.

pub fn set_children(&self, children: impl IntoIterator<Item = Self>)

Sets this node’s children.

pub fn set_dir(&self, dir: LayoutDir)

Sets this node’s LayoutDir.

pub fn set_size_proportion(&self, proportion: f32)

Sets this node’s size proportion in relation to its siblings.

pub fn set_gaps(&self, gaps: impl Into<Gaps>)

Sets the gaps this node places around its children.

Trait Implementations

impl Clone for LayoutNode

fn clone(&self) -> LayoutNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LayoutNode

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

Formats the value using the given formatter.

impl Default for LayoutNode

fn default() -> Self

Returns the “default value” for a type.

impl From<LayoutNode> for LayoutNode

fn from(value: LayoutNode) -> Self

Converts to this type from the input type.

impl PartialEq for LayoutNode

fn eq(&self, other: &Self) -> 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.