Struct ApplicationSelectionState

pub struct ApplicationSelectionState {
    pub history: Mutex<SelectionHistory>,
    /* private fields */
}

Selection and hover state.

Both hover and selection are double buffered: Changes from one frame are only visible in the next frame.

Fields

history: Mutex<SelectionHistory>

History of selections (what was selected previously).

Implementations

impl ApplicationSelectionState

pub fn on_frame_start( &mut self, item_retain_condition: impl Fn(&Item) -> bool, fallback_selection: Option<Item>, )

Called at the start of each frame

pub fn select_previous(&self)

Selects the previous element in the history if any.

pub fn select_next(&self)

Selections the next element in the history if any.

pub fn clear_selection(&self)

Clears the current selection out.

pub fn set_selection(&self, items: impl Into<ItemCollection>)

Sets several objects to be selected, updating history as needed.

Clears the selected space context if none was specified.

pub fn selected_items(&self) -> &ItemCollection

Returns the current selection.

pub fn hovered_items(&self) -> &ItemCollection

Returns the currently hovered objects.

pub fn set_hovered(&self, hovered: impl Into<ItemCollection>)

Set the hovered objects. Will be in Self::hovered_items on the next frame.

pub fn toggle_selection(&self, toggle_items: ItemCollection)

Select passed objects unless already selected in which case they get unselected. If however an object is already selected but now gets passed a different selected space context, it stays selected after all but with an updated selected space context!

pub fn selection_space_contexts( &self, ) -> impl Iterator<Item = &ItemSpaceContext>

pub fn hovered_space_context(&self) -> Option<&ItemSpaceContext>

pub fn highlight_for_ui_element(&self, test: &Item) -> HoverHighlight

Trait Implementations

impl Default for ApplicationSelectionState

fn default() -> ApplicationSelectionState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ApplicationSelectionState

where ApplicationSelectionState: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApplicationSelectionState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.