Struct druid::widget::FlexParams

pub struct FlexParams { /* private fields */ }

Optional parameters for an item in a Flex container (row or column).

Generally, when you would like to add a flexible child to a container, you can simply call with_flex_child or add_flex_child, passing the child and the desired flex factor as a f64, which has an impl of Into<FlexParams>.

If you need to set additional parameters, such as a custom CrossAxisAlignment, you can construct FlexParams directly. By default, the child has the same CrossAxisAlignment as the container.

For an overview of the flex layout algorithm, see the Flex docs.

Examples

use druid::widget::{FlexParams, Label, CrossAxisAlignment};

let mut row = druid::widget::Flex::<()>::row();
let child_1 = Label::new("I'm hungry");
let child_2 = Label::new("I'm scared");
// normally you just use a float:
row.add_flex_child(child_1, 1.0);
// you can construct FlexParams if needed:
let params = FlexParams::new(2.0, CrossAxisAlignment::End);
row.add_flex_child(child_2, params);

Implementations

impl FlexParams

pub fn new(flex: f64, alignment: impl Into<Option<CrossAxisAlignment>>) -> Self

Create custom FlexParams with a specific flex_factor and an optional CrossAxisAlignment.

You likely only need to create these manually if you need to specify a custom alignment; if you only need to use a custom flex_factor you can pass an f64 to any of the functions that take FlexParams.

By default, the widget uses the alignment of its parent Flex container.

Trait Implementations

impl Clone for FlexParams

fn clone(&self) -> FlexParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlexParams

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

Formats the value using the given formatter.

impl From<f64> for FlexParams

fn from(flex: f64) -> FlexParams

Converts to this type from the input type.

impl PartialEq<FlexParams> for FlexParams

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FlexParams

impl StructuralPartialEq for FlexParams