Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature property-grid only.

The properties, their values, and what is open, highlighted, filtered and being edited.

Implementations

impl<Id: Copy + Eq + Hash> State<Id>

pub fn new(properties: impl IntoIterator<Item = Property<Id>>) -> Self

Holds properties, categorised with every category open. Ids must be unique; a later property with the same id replaces the earlier.

pub fn with_sort(self, sort: Sort) -> Self

pub fn with_collapsed( self, categories: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Starts with these categories closed.

pub fn with_name_width(self, width: f32) -> Self

Starts the name column at width pixels rather than NAME_WIDTH, which a narrow grid shrinks.

pub fn properties(&self) -> &[Property<Id>]

Every property, in the order given.

pub fn property(&self, id: Id) -> Option<&Property<Id>>

pub fn value(&self, id: Id) -> Option<&Value>

pub fn set(&mut self, id: Id, value: impl Into<Value>) -> bool

Sets a value from the app, such as after an undo or from a custom editor, dropping any draft or edit of it. Returns whether it changed.

pub fn categories(&self) -> &[String]

Category names, in the order they first appear.

pub fn is_expanded(&self, category: &str) -> bool

pub fn sort(&self) -> Sort

pub fn query(&self) -> &str

The search text, which filters properties by name.

pub fn highlighted(&self) -> Option<&Entry<Id>>

The row the keyboard acts on, which the description area describes.

pub fn highlighted_property(&self) -> Option<&Property<Id>>

The highlighted property, if a property rather than a category is highlighted.

pub fn editing(&self) -> Option<Id>

The property being typed into.

pub fn draft(&self, id: Id) -> Option<&Draft>

Text typed into a property that is being edited, or that was left while invalid.

pub fn error(&self, id: Id) -> Option<&str>

Why a property’s draft is not valid.

pub fn can_reset(&self, id: Id) -> bool

Whether resetting the property would change anything: it has a default, is enabled, and differs from the default or holds a draft.

pub fn is_focused(&self) -> bool

pub fn is_resizing(&self) -> bool

Whether the line between the columns is being dragged.

pub fn name_width(&self) -> Option<f32>

The name column’s width once set or dragged.

pub fn matches(&self, id: Id) -> bool

Whether a property passes the filter.

pub fn count(&self, category: &str) -> usize

How many properties in a category pass the filter.

pub fn entries(&self) -> Vec<Entry<Id>>

The rows on screen, in order: properties that pass the filter, under their categories while categorised.

pub fn update(&mut self, event: Event<Id>) -> Option<Output<Id>>

Applies an event and returns what the app may need to act on.

pub fn key_event( &self, keymap: &Keymap<Action>, key: &Event, ) -> Option<Event<Id>>

Turns a key press into an event through keymap.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.