Struct re_ui::list_item::LabelContent

pub struct LabelContent<'a> {
    text: WidgetText,
    subdued: bool,
    weak: bool,
    italics: bool,
    label_style: LabelStyle,
    icon_fn: Option<Box<dyn FnOnce(&mut Ui, Rect, WidgetVisuals) + 'a>>,
    buttons_fn: Option<Box<dyn FnOnce(&mut Ui) -> Response + 'a>>,
    always_show_buttons: bool,
    text_wrap_mode: Option<TextWrapMode>,
    min_desired_width: Option<f32>,
}

ListItemContent that displays a simple label with optional icon and buttons.

Fields

text: WidgetText

subdued: bool

weak: bool

italics: bool

label_style: LabelStyle

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

buttons_fn: Option<Box<dyn FnOnce(&mut Ui) -> Response + 'a>>

always_show_buttons: bool

text_wrap_mode: Option<TextWrapMode>

min_desired_width: Option<f32>

Implementations

impl<'a> LabelContent<'a>

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

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

Set the subdued state of the item.

Note: takes precedence over Self::weak if set.

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

Set the weak state of the item.

Note: Self::subdued takes precedence if set.

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

Render text in italic.

pub fn label_style(self, style: LabelStyle) -> Self

Style the label for an unnamed items.

The styling is applied on top of to Self::weak and Self::subdued. It also implies Self::italics.

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

Should we truncate text if it is too long?

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

Set the minimum desired for the content.

This defaults to zero.

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

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

pub fn with_icon_fn( self, icon_fn: impl FnOnce(&mut Ui, Rect, WidgetVisuals) + 'a ) -> Self

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

pub fn with_buttons( self, buttons: impl FnOnce(&mut Ui) -> Response + 'a ) -> Self

Provide a closure to display on-hover buttons on the right of the item.

Buttons also show when the item is selected, in order to support clicking them on touch screens. The buttons can be set to be always shown with Self::always_show_buttons.

Notes:

• If buttons are used, the item will allocate the full available width of the parent. If the enclosing UI adapts to the childrens width, it will unnecessarily grow. If buttons aren’t used, the item will only allocate the width needed for the text and icons if any.
• A right to left layout is used, so the right-most button must be added first.

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

Always show the buttons.

By default, buttons are only shown when the item is hovered or selected. By setting this to true, the buttons are always shown.

fn get_text_wrap_mode(&self, ui: &Ui) -> TextWrapMode

Trait Implementations

impl ListItemContent for LabelContent<'_>

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.