Struct nuki::compr::PropertyAction

pub struct PropertyAction { /* fields omitted */ }

An action typed property.

Implementations

impl PropertyAction

pub fn with_button<F>(
    name: &'static str,
    text: &'static str,
    callback: Arc<RefCell<F>>
) -> Self where
    F: FnMut(&dyn Property, bool) -> bool + 'static, 

Create an Action Property with Push Button.

pub fn with_check_box<F>(
    name: &'static str,
    checked: bool,
    callback: Arc<RefCell<F>>
) -> Self where
    F: FnMut(&dyn Property, bool) -> bool + 'static, 

Create an Action Property with Check Box.

pub fn is_checked(&self) -> bool

Returns current check state.

pub fn trigger(&self, checked: bool) -> bool

Trigger the action callback and returning the final check state.

Trait Implementations

impl Debug for PropertyAction

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

Formats the value using the given formatter.

impl Default for PropertyAction

pub fn default() -> Self

Returns the "default value" for a type.

impl Property for PropertyAction

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_action(&self) -> Option<&PropertyAction>

Casting to PropertyAction.

pub fn is_selectable(&self) -> bool

Returns true if the property can marked with selected.

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

Casting to PropertyBool.

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 PropertyAction

impl Sync for PropertyAction