Struct egui::Layout

pub struct Layout { /* fields omitted */ }

The layout of a Ui, e.g. horizontal left-aligned.

Implementations

impl Layout

pub fn from_dir_align(dir: Direction, align: Option<Align>) -> Self

None align means justified, e.g. fill full width/height.

pub fn vertical(align: Align) -> Self

pub fn horizontal(align: Align) -> Self

pub fn justified(dir: Direction) -> Self

Full-width layout. Nice for menues etc where each button is full width.

#[must_use]pub fn reverse(self) -> Self

#[must_use]pub fn with_reversed(self, reversed: bool) -> Self

pub fn dir(self) -> Direction

pub fn align(self) -> Option<Align>

pub fn is_reversed(self) -> bool

pub fn initial_cursor(self, max_rect: Rect) -> Pos2

pub fn available(self, cursor: Pos2, max_rect: Rect) -> Rect

Given the cursor in the region, how much space is available for the next widget?

pub fn advance_cursor(self, cursor: &mut Pos2, amount: f32)

Advance the cursor by this many points.

pub fn rect_from_cursor_size(self, cursor: Pos2, size: Vec2) -> Rect

pub fn allocate_space(
    self,
    cursor: &mut Pos2,
    style: &Style,
    available_size: Vec2,
    child_size: Vec2
) -> Rect

Reserve this much space and move the cursor. Returns where to put the widget.

How sizes are negotiated

Each widget should have a minimum desired size and a desired size. When asking for space, ask AT LEAST for you minimum, and don't ask for more than you need. If you want to fill the space, ask about available().size() and use that.

You may get MORE space than you asked for, for instance for Justified aligned layouts, like in menus.

You may get LESS space than you asked for if the current layout won't fit what you asked for.

impl Layout

Debug stuff

pub fn debug_paint_cursor(&self, cursor: Pos2, painter: &Painter)

Shows where the next widget is going to be placed

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 Copy for Layout

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<Layout> for Layout

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Layout