Struct re_ui::list_item::property_content::PropertyContent

pub struct PropertyContent<'a> {
    label: WidgetText,
    min_desired_width: f32,
    icon_fn: Option<Box<dyn FnOnce(&mut Ui, Rect, WidgetVisuals) + 'a>>,
    show_only_when_collapsed: bool,
    value_fn: Option<Box<dyn FnOnce(&mut Ui, WidgetVisuals) + 'a>>,
    button: Option<Box<dyn ItemButton + 'a>>,
}

ListItemContent to display property-like, two-column content, with the left column containing a label (along with an optional icon) and the right column containing some custom value (which may be editable).

Fields

label: WidgetText

min_desired_width: f32

icon_fn: Option<Box<dyn FnOnce(&mut Ui, Rect, WidgetVisuals) + 'a>>

show_only_when_collapsed: bool

value_fn: Option<Box<dyn FnOnce(&mut Ui, WidgetVisuals) + 'a>>

button: Option<Box<dyn ItemButton + 'a>>

Implementations

impl<'a> PropertyContent<'a>

const COLUMN_SPACING: f32 = 12f32

Spacing used between the two main columns

pub fn new(label: impl Into<WidgetText>) -> Self

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

Set the minimum desired width for the entire content.

Since there is no possibly way to meaningfully collapse two to three columns worth of content, this is set to 200.0 by default.

pub fn with_icon(self, icon: &'a Icon) -> Self

Provide an Icon to be displayed on the left of the label.

pub fn with_icon_fn<F>(self, icon_fn: F) -> Self

where F: FnOnce(&mut Ui, Rect, WidgetVisuals) + 'a,

Provide a custom closure to draw an icon on the left of the item.

pub fn button(self, button: impl ItemButton + 'a) -> Self

Add a right-aligned super::ItemButton.

Note: for aesthetics, space is always reserved for the action button.

pub fn action_button( self, icon: &'static Icon, on_click: impl FnOnce() + 'a ) -> Self

Helper to add an super::ItemActionButton to the right of the item.

See Self::button for more information.

pub fn action_button_with_enabled( self, icon: &'static Icon, enabled: bool, on_click: impl FnOnce() + 'a ) -> Self

Helper to add an enabled/disabled super::ItemActionButton to the right of the item.

See Self::button for more information.

pub fn menu_button( self, icon: &'static Icon, add_contents: impl FnOnce(&mut Ui) + 'a ) -> Self

Helper to add a super::ItemMenuButton to the right of the item.

See Self::button for more information.

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

Display value only for leaf or collapsed items.

When enabled, the value for this item is not displayed for uncollapsed hierarchical items. This is convenient when the value serves are a summary of the child content, which doesn’t need to be displayed when said content is visible.

Enabled by default.

pub fn value_fn<F>(self, value_fn: F) -> Self

where F: FnOnce(&mut Ui, WidgetVisuals) + 'a,

Provide a closure to draw the content of the right column.

pub fn value_bool(self, b: bool) -> Self

Show a read-only boolean in the value column.

pub fn value_bool_mut(self, b: &'a mut bool) -> Self

Show an editable boolean in the value column.

pub fn value_text(self, text: impl Into<WidgetText> + 'a) -> Self

Show a static text in the value column.

pub fn value_text_mut(self, text: &'a mut String) -> Self

Show an editable text in the value column.

pub fn value_color(self, rgba: &'a [u8; 4]) -> Self

Show a read-only color in the value column.

pub fn value_color_mut(self, rgba: &'a mut [u8; 4]) -> Self

Show an editable color in the value column.

Trait Implementations

impl ListItemContent for PropertyContent<'_>

fn ui(self: Box<Self>, ui: &mut Ui, context: &ContentContext<'_>)

UI for everything that is after the indent and the collapsing triangle (if any).

fn desired_width(&self, ui: &Ui) -> DesiredWidth

The desired width of the content.