Struct Flex

pub struct Flex { /* private fields */ }

A flex container.

Implementations

impl Flex

pub fn new() -> Self

Create a new flex container.

pub fn horizontal() -> Self

Create a new horizontal flex container.

pub fn vertical() -> Self

Create a new vertical flex container.

pub fn direction(self, direction: FlexDirection) -> Self

Set the direction of the flex container.

pub fn justify(self, justify: FlexJustify) -> Self

Set how to justify the content (alignment in the main axis). This will only have an effect if all items have grow set to 0.

pub fn align_items(self, align_items: FlexAlign) -> Self

Set the default configuration for the items in the flex container.

pub fn align_items_content(self, align_item_content: Align2) -> Self

If align_items is stretch, how do we align the item content?

pub fn align_content(self, align_content: FlexAlignContent) -> Self

Set how to align the content in the cross axis across the whole container.

This only has an effect if wrap is set to true.

Default is stretch.

pub fn grow_items(self, grow: impl Into<Option<f32>>) -> Self

Set the default grow factor for the items in the flex container.

pub fn gap(self, gap: Vec2) -> Self

Set the gap between the items in the flex container.

Default is item_spacing of the Ui.

pub fn wrap(self, wrap: bool) -> Self

Should the flex container wrap it’s content. If this is set to false the content may overflow the Ui::max_rect

Default: false

pub fn id_salt(self, id_salt: impl Into<Id>) -> Self

Customize the id of the flex container to prevent conflicts with other flex containers.

pub fn width(self, width: impl Into<Size>) -> Self

Set the width of the flex container in points (pixels).

The default depends on the parents horizontal justify. If ui.layout().horizontal_justify() is:

• true, the width will be set to 100%.
• false, the width will depend on the width of the content.

pub fn height(self, height: impl Into<Size>) -> Self

Set the height of the flex container in points (pixels).

The default depends on the parents vertical justify. If ui.layout().vertical_justify() is:

• true, the height will be set to 100%.
• false, the height will depend on the height of the content.

pub fn width_percent(self, width: f32) -> Self

Set the width of the flex container as a percentage of the available width. 1.0 means 100%.

Check Self::width for more info.

pub fn height_percent(self, height: f32) -> Self

Set the height of the flex container as a percentage of the available height. 1.0 means 100%.

Check Self::height for more info.

pub fn size(self, size: impl Into<Vec2>) -> Self

Set the size of the flex container in points (pixels).

Check Self::width and Self::height for more info.

pub fn w_full(self) -> Self

Set the width of the flex container to 100%.

pub fn h_full(self) -> Self

Set the height of the flex container to 100%.

pub fn w_auto(self) -> Self

The width of the flex container will be set to the width of the content, but not larger than the available width (unless wrap is set to false).

This is the default.

pub fn h_auto(self) -> Self

The height of the flex container will be set to the height of the content, but not larger than the available height (unless wrap is set to false).

This is the default.

pub fn show<R>( self, ui: &mut Ui, f: impl FnOnce(&mut FlexInstance<'_>) -> R, ) -> InnerResponse<R>

Show the flex ui. If Self::wrap is true, it will try to stay within Ui::max_rect.

Note: You will likely get weird results when showing this within a Ui::horizontal layout, since it limits the max_rect to some small value. Use Ui::horizontal_top instead.

pub fn show_in<R>( self, flex: &mut FlexInstance<'_>, item: FlexItem<'_>, f: impl FnOnce(&mut FlexInstance<'_>) -> R, ) -> InnerResponse<R>

Show this flex in another Flex. See also FlexInstance::add_flex.

Trait Implementations

impl Clone for Flex

fn clone(&self) -> Flex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Flex

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

Formats the value using the given formatter.

impl Default for Flex

fn default() -> Flex

Returns the “default value” for a type.

impl PartialEq for Flex

fn eq(&self, other: &Flex) -> 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 StructuralPartialEq for Flex