Struct re_viewer::external::re_ui::list_item::ListItem

pub struct ListItem {
    pub interactive: bool,
    pub selected: bool,
    pub draggable: bool,
    pub drag_target: bool,
    pub force_hovered: bool,
    force_background: Option<Color32>,
    pub collapse_openness: Option<f32>,
    height: f32,
}

Content-generic list item.

The following features are supported:

• Flat or collapsible hierarchical lists.
• Full-span background highlighting.
• Interactive or not.
• Support for drag and drop with crate::drag_and_drop.

Besides these core features, ListItem delegates all content to the ListItemContent implementations, such as super::LabelContent and super::PropertyContent.

Usage example can be found in re_ui_example.

Fields

interactive: bool

selected: bool

draggable: bool

drag_target: bool

force_hovered: bool

force_background: Option<Color32>

collapse_openness: Option<f32>

height: f32

Implementations

impl ListItem

pub fn new() -> ListItem

Create a new ListItem with the given label.

pub fn interactive(self, interactive: bool) -> ListItem

Can the user click and interact with it?

Set to false for items that only show info, but shouldn’t be interactive. Note: making the list item non-interactive does not necessarily make its content non-interactive. For example, a non-interactive list item may be used in conjunction with super::PropertyContent to build property-like editors.

pub fn selected(self, selected: bool) -> ListItem

Set the selected state of the item.

pub fn draggable(self, draggable: bool) -> ListItem

Make the item draggable.

pub fn drop_target_style(self, drag_target: bool) -> ListItem

Highlight the item as the current drop target.

Use this while dragging, to highlight which container will receive the drop at any given time. Note: this flag has otherwise no behavioral effect. It’s up to the caller to set it when the item is being hovered (or otherwise selected as drop target) while a drag is in progress.

pub fn force_hovered(self, force_hovered: bool) -> ListItem

Override the hovered state even if the item is not actually hovered.

Used to highlight items representing things that are hovered elsewhere in the UI. Note that the [egui::Response] returned by Self::show_flat, Self::show_hierarchical, and Self::show_hierarchical_with_children will still reflect the actual hover state.

pub fn force_background(self, force_background: Color32) -> ListItem

Override the background color for the item.

If set, this takes precedence over Self::force_hovered and any kind of selection/ interaction-driven background handling.

pub fn with_height(self, height: f32) -> ListItem

Set the item height.

The default is provided by DesignTokens::list_item_height and is suitable for hierarchical lists.

pub fn show_flat<'a>( self, ui: &mut Ui, content: impl ListItemContent + 'a ) -> Response

Draw the item as part of a flat list.

Important: must be called while nested in a super::list_item_scope.

pub fn show_hierarchical( self, ui: &mut Ui, content: impl ListItemContent ) -> Response

Draw the item as a leaf node from a hierarchical list.

Important: must be called while nested in a super::list_item_scope.

pub fn show_hierarchical_with_children<R>( self, ui: &mut Ui, id: Id, default_open: bool, content: impl ListItemContent, add_children: impl FnOnce(&mut Ui) -> R ) -> ShowCollapsingResponse<R>

Draw the item as a non-leaf node from a hierarchical list.

The id should be globally unique! You can use ui.make_persistent_id(…) for that. The children content is indented.

Important: must be called while nested in a super::list_item_scope.

pub fn show_hierarchical_with_children_unindented<R>( self, ui: &mut Ui, id: Id, default_open: bool, content: impl ListItemContent, add_children: impl FnOnce(&mut Ui) -> R ) -> ShowCollapsingResponse<R>

Draw the item with unindented child content.

This is similar to Self::show_hierarchical_with_children but without indent. This is only for special cases such as crate::SectionCollapsingHeader.

Trait Implementations

impl Clone for ListItem

fn clone(&self) -> ListItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ListItem

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

Formats the value using the given formatter.

impl Default for ListItem

fn default() -> ListItem

Returns the “default value” for a type.