Struct PropertyGrid 

pub struct PropertyGrid<'a, Id, Message> { /* private fields */ }

Available on crate feature property-grid only.

A property grid builder. Convert it into an Element to render.

Implementations

impl<'a, Id, Message> PropertyGrid<'a, Id, Message>

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

Shows the filter box and the sort buttons above the rows. On by default.

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

Shows the highlighted property’s name and description under the rows. On by default. Errors show there even when it is off.

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

The filter box placeholder.

pub fn width(self, width: impl Into<Length>) -> Self

pub fn height(self, height: impl Into<Length>) -> Self

A fixed or filling height scrolls the rows. Defaults to shrinking to fit them.

pub fn keymap(self, keymap: Keymap<Action>) -> Self

Replaces the default_keymap the focused grid resolves keys with.

pub fn on_event(self, on_event: impl Fn(Event<Id>) -> Message + 'a) -> Self

pub fn custom( self, id: Id, render: impl Fn(&'a Property<Id>) -> Element<'a, Message> + 'a, ) -> Self

where Id: PartialEq,

Draws the value of property id with render, such as a slider. Keep it within a row’s height. The app handles its messages and stores the result with State::set.

pub fn context_menu<MenuId>( self, menu: &'a State<MenuId, Id>, on_event: impl Fn(Event<MenuId, Id>) -> Message + 'a, ) -> Self

where MenuId: Copy + PartialEq + 'a, Id: Clone + PartialEq + 'a, Message: Clone + 'a,

Gives every property row the context menu of menu, keyed by property, such as the one from menu(). It opens on a right-click or a long press, and on the highlighted property with its opening chord while the grid has focus.

pub fn context_menu_keymap(self, keymap: Keymap<Action>) -> Self

Replaces the context menu’s default keymap.

pub fn is_enabled(&self) -> bool

Trait Implementations

impl<Id: Debug, Message> Debug for PropertyGrid<'_, Id, Message>

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

Formats the value using the given formatter.

impl<'a, Id, Message> From<PropertyGrid<'a, Id, Message>> for Element<'a, Message>

where Id: Copy + Eq + Hash + 'a, Message: Clone + 'a,

fn from(grid: PropertyGrid<'a, Id, Message>) -> Self

Converts to this type from the input type.