Struct egui::widgets::separator::Separator

pub struct Separator {
    spacing: f32,
    grow: f32,
    is_horizontal_line: Option<bool>,
}

A visual separator. A horizontal or vertical line (depending on crate::Layout).

Usually you’d use the shorter version Ui::separator.

// These are equivalent:
ui.separator();
ui.add(egui::Separator::default());

Fields

spacing: f32

grow: f32

is_horizontal_line: Option<bool>

Implementations

impl Separator

pub fn spacing(self, spacing: f32) -> Self

How much space we take up. The line is painted in the middle of this.

In a vertical layout, with a horizontal Separator, this is the height of the separator widget.

In a horizontal layout, with a vertical Separator, this is the width of the separator widget.

pub fn horizontal(self) -> Self

Explicitly ask for a horizontal line.

By default you will get a horizontal line in vertical layouts, and a vertical line in horizontal layouts.

pub fn vertical(self) -> Self

Explicitly ask for a vertical line.

By default you will get a horizontal line in vertical layouts, and a vertical line in horizontal layouts.

pub fn grow(self, extra: f32) -> Self

Extend each end of the separator line by this much.

The default is to take up the available width/height of the parent.

This will make the line extend outside the parent ui.

pub fn shrink(self, shrink: f32) -> Self

Contract each end of the separator line by this much.

The default is to take up the available width/height of the parent.

This effectively adds margins to the line.

Trait Implementations

impl Default for Separator

fn default() -> Self

Returns the “default value” for a type.

impl Widget for Separator

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response.