Struct nuki::compr::PropertyBool

pub struct PropertyBool { /* fields omitted */ }

A boolean typed property.

Implementations

impl PropertyBool

pub fn with_switch(name: &'static str, def_val: bool) -> Self

pub fn def_val(&self) -> bool

pub fn value(&self) -> bool

pub fn value_mut(&self) -> &mut bool

pub unsafe fn value_mut_ptr(&self) -> *mut bool

Safety

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

pub fn toggle(&self) -> bool

Toggle the value between true and false.

Trait Implementations

impl Debug for PropertyBool

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

Formats the value using the given formatter.

impl Default for PropertyBool

pub fn default() -> Self

Returns the "default value" for a type.

impl Property for PropertyBool

pub fn id(&self) -> usize

Returns the id of the property.

pub fn set_id(&self, id: usize)

Change the id of the property.

pub fn name(&self) -> &'static str

Returns the name of the Property.

pub fn options(&self) -> &[&'static str]

Returns the Options of the Property.

pub fn value_type(&self) -> ValueType

Returns the Type of the Property Value.

pub fn widget_type(&self) -> WidgetType

Returns which Type of Widget to render the Property.

pub fn is_selected(&self) -> bool

Returns true if the property marked with selected.

pub fn set_selected(&self, selected: bool)

Change the selected marker of the property.

pub fn is_visible(&self) -> bool

Returns true if the property visibile.

pub fn set_visible(&self, visible: bool)

Change the visibility of the property.

pub fn show(&self)

Change the visibility of the property to true.

pub fn hide(&self)

Change the visibility of the property to false.

pub fn as_property_bool(&self) -> Option<&PropertyBool>

Casting to PropertyBool.

pub fn is_selectable(&self) -> bool

Returns true if the property can marked with selected.

pub fn as_property_action(&self) -> Option<&PropertyAction>

Casting to PropertyAction.

pub fn as_property_dummy(&self) -> Option<&PropertyDummy>

Casting to PropertyDummy.

pub fn as_property_f32<'l>(&self) -> Option<&(dyn PropertyNumber<f32> + 'l)>

Casting to dyn PropertyNumber.

pub fn as_property_f64<'l>(&self) -> Option<&(dyn PropertyNumber<f64> + 'l)>

Casting to dyn PropertyNumber.

pub fn as_property_i32<'l>(&self) -> Option<&(dyn PropertyNumber<i32> + 'l)>

Casting to dyn PropertyNumber.

pub fn as_property_i64<'l>(&self) -> Option<&(dyn PropertyNumber<i64> + 'l)>

Casting to dyn PropertyNumber.

pub fn as_property_string(&self) -> Option<&PropertyString>

Casting to PropertyString.

pub fn is_action_checked(&self) -> Option<bool>

Returns the checked state if the property is type of ValueType::Action.

pub fn trigger_action(&self, checked: bool) -> Option<bool>

Trigger the action if the property is type of ValueType::Action.

pub fn get_value_bool(&self) -> Option<bool>

Returns the bool value if the property is type of ValueType::Bool.

pub fn set_value_bool(&self, value: bool) -> Option<bool>

Change the bool value if the property is type of ValueType::Bool.

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

Returns the f32 value if the property is type of ValueType::F32.

pub fn set_value_f32(&self, value: f32) -> Option<f32>

Change the f32 value if the property is type of ValueType::F32.

pub fn get_value_f64(&self) -> Option<f64>

Returns the f64 value if the property is type of ValueType::F64.

pub fn set_value_f64(&self, value: f64) -> Option<f64>

Change the f64 value if the property is type of ValueType::F64.

pub fn get_value_i32(&self) -> Option<i32>

Returns the i32 value if the property is type of ValueType::I32.

pub fn set_value_i32(&self, value: i32) -> Option<i32>

Change the i32 value if the property is type of ValueType::I32.

pub fn get_value_i64(&self) -> Option<i64>

Returns the i64 value if the property is type of ValueType::I64.

pub fn set_value_i64(&self, value: i64) -> Option<i64>

Change the i64 value if the property is type of ValueType::I64.

pub fn get_value_string(&self) -> Option<Ref<'_, str>>

Returns the &str value if the property is type of ValueType::String.

pub fn set_value_string<'l>(&self, value: &'l str) -> Option<Ref<'_, str>>

impl Send for PropertyBool

impl Sync for PropertyBool