Struct egui::Layout

pub struct Layout { /* fields omitted */ }

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

Implementations

impl Layout

pub fn left_to_right() -> Self

pub fn right_to_left() -> Self

pub fn top_down(cross_align: Align) -> Self

pub fn top_down_justified(cross_align: Align) -> Self

Top-down layout justifed so that buttons etc fill the full available width.

pub fn bottom_up(cross_align: Align) -> Self

pub fn vertical(cross_align: Align) -> Self

👎 Deprecated:

Use top_down

pub fn horizontal(cross_align: Align) -> Self

👎 Deprecated:

Use left_to_right

pub fn with_main_wrap(self, main_wrap: bool) -> Self

pub fn with_cross_align(self, cross_align: Align) -> Self

pub fn with_cross_justify(self, cross_justify: bool) -> Self

pub fn main_dir(self) -> Direction

pub fn main_wrap(self) -> bool

pub fn cross_align(self) -> Align

pub fn cross_justify(self) -> bool

pub fn is_horizontal(self) -> bool

pub fn is_vertical(self) -> bool

pub fn prefer_right_to_left(self) -> bool

pub fn align_size_within_rect(&self, size: Vec2, outer: Rect) -> Rect

pub fn region_from_max_rect(&self, max_rect: Rect) -> Region

pub fn available_size(&self, r: &Region) -> Vec2

Amount of space available for a widget. Wor wrapping layouts, this is the maximum (after wrap)

pub fn next_space(
    self,
    region: &Region,
    child_size: Vec2,
    item_spacing: Vec2
) -> Rect

Returns where to put the next widget that is of the given size. The returned "outer" Rect will always be justified along the cross axis. This is what you then pass to advance_after_outer_rect. Use justify_or_align to get the inner Rect.

pub fn justify_or_align(self, rect: Rect, child_size: Vec2) -> Rect

Apply justify or alignment after calling next_space.

pub fn advance_cursor(self, region: &mut Region, amount: f32)

Advance the cursor by this many points.

pub fn advance_cursor2(self, region: &mut Region, amount: Vec2)

Advance the cursor by this spacing

pub fn advance_after_outer_rect(
    self,
    region: &mut Region,
    outer_rect: Rect,
    inner_rect: Rect,
    item_spacing: Vec2
)

Advance cursor after a widget was added to a specific rectangle. outer_rect is a hack needed because the Vec2 cursor is not quite sufficient to keep track of what is happening when we are doing wrapping layouts.

impl Layout

Debug stuff

pub fn debug_paint_cursor(&self, region: &Region, painter: &Painter)

Shows where the next widget is going to be placed

Trait Implementations

impl Clone for Layout

pub fn clone(&self) -> Layout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Layout

impl Debug for Layout

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

Formats the value using the given formatter.

impl Default for Layout

pub fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<Layout> for Layout

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

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

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

This method tests for !=.

impl StructuralPartialEq for Layout