Struct imgui::TableSortSpecsMut

pub struct TableSortSpecsMut<'ui>(_, _);

A wrapper around table sort specs.

To use this simply, use conditional_sort and provide a closure – if you should sort your data, then the closure will be ran and imgui will be informed that your data is sorted.

For manual control (such as if sorting can fail), use should_sort to check if you should sort your data, sort your data using specs for information on how to sort it, and then set_sorted to indicate that the data is sorted.

Implementations

impl TableSortSpecsMut<'_>

pub fn specs(&self) -> Specs<'_>

Gets the specs for a given sort. In most scenarios, this will be a slice of 1 entry.

pub fn should_sort(&self) -> bool

Returns true if the data should be sorted.

pub fn set_sorted(&mut self)

Sets the internal flag that the data has been sorted.

pub fn conditional_sort(self, f: impl FnMut(Specs<'_>))

Provide a closure, which will receive the Specs for a sort.

If you should sort the data, the closure will run, and ImGui will be told that the data has been sorted.

If you need manual control over sorting, consider using should_sort, specs, and set_sorted youself.