Struct Property 

pub struct Property<Id> {
    pub id: Id,
    pub name: String,
    pub category: Option<String>,
    pub description: Option<String>,
    pub kind: Kind,
    pub value: Value,
    pub default: Option<Value>,
    pub disabled: bool,
}

Available on crate feature property-grid only.

One named property.

Fields

id: Id

name: String

category: Option<String>

The group it is listed under while categorised.

description: Option<String>

Shown under the rows while the property is highlighted.

kind: Kind

value: Value

default: Option<Value>

The value a reset goes back to. A property without one has no reset.

disabled: bool

Implementations

impl<Id> Property<Id>

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

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

pub fn default(self, value: impl Into<Value>) -> Self

The value a reset goes back to. The name shows as modified while the value differs from it.

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

A disabled property shows its value but cannot be edited or reset.

pub fn min(self, min: f64) -> Self

The smallest value of a number property.

pub fn max(self, max: f64) -> Self

The largest value of a number property.

pub fn range(self, min: f64, max: f64) -> Self

pub fn step(self, step: f64) -> Self

How far Up and Down move a number while it is edited. A whole step also makes values between steps invalid.

pub fn decimals(self, decimals: usize) -> Self

Decimal places a number is shown with.

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

Shown after a number, such as px, and accepted when typed.

pub fn switch(self) -> Self

Shows a true or false property as a switch.

pub fn validate(self, validate: Validate) -> Self

Checks what is typed into a text property.

pub fn is_modified(&self) -> bool

Whether the value differs from the default.

pub fn is_typed(&self) -> bool

Whether the value is edited by typing: text, numbers and colours.

pub fn is_editable(&self) -> bool

Whether the user can change the value from the grid.

pub fn display(&self) -> String

The value as shown in its row.

pub fn edit_text(&self) -> String

The value as text to start an edit with.

pub fn parse(&self, input: &str) -> Result<Value, String>

Reads typed text into a value of this property’s kind.

pub fn accepts(&self, value: &Value) -> bool

Whether value suits this property, such as an option of a choice.

Trait Implementations

impl<Id: Clone> Clone for Property<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 Property<Id>

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

Formats the value using the given formatter.