Struct pushrod_widgets::properties::WidgetProperties

pub struct WidgetProperties { /* fields omitted */ }

This is a structure that stores properties for Widgets, which can be used to define the object's behavior.

Implementations

impl WidgetProperties

This is the implementation of the WidgetProperties store. This is used by each and every Widget, which stores information about the property. Once each property is set, the Widget can respond to the set action, and repaint itself, or anything similar.

pub fn set(&mut self, property_key: u32, property_value: String) -> &mut Self

Sets a value for a property based on its numerical key. Returns a mutable reference to self so that commands can be chained together.

pub fn delete(&mut self, property_key: u32)

Deletes a property value for the given numerical key.

pub fn get(&mut self, property_key: u32) -> String

Retrieves the value for a property.

pub fn key_set(&mut self, property_key: u32) -> bool

Returns a flag indicating whether or not a property for a numerical key has been set.

pub fn invalidate(&mut self)

Sets the invalidated state for the Widget.

pub fn set_color(&mut self, property_key: u32, color: Color) -> &mut Self

Stores the color for the specified key. Format is "r g b a", as numerical values, base 10. Sets the invalidate flag afterward. Returns a mutable reference to self so that commands can be chained together.

pub fn set_bounds(&mut self, w: u32, h: u32) -> &mut Self

Sets the size of the Widget. Returns a mutable reference to self so that commands can be chained together.

pub fn set_origin(&mut self, x: u32, y: u32) -> &mut Self

Sets the origin for the Widget. Does not set the invalidate flag, as the repositioning of the Widget does not require a repaint. Returns a mutable reference to self so that commands can be chained together.

pub fn set_bool(&mut self, property_key: u32) -> &mut Self

Sets a boolean for a given property key. Returns a mutable reference to self so that commands can be chained together.

pub fn set_value(&mut self, property_key: u32, value: i32) -> &mut Self

Sets a numeric value to a given property key. Returns a mutable reference to self so that commands can be chained together.

pub fn get_color(&self, property_key: u32, default_color: Color) -> Color

Retrieves a color based on the given property key. If the color cannot be found, the default_color specified will be returned.

pub fn get_bounds(&self) -> (u32, u32)

Retrieves the stored bounds as a tuple. If the bounds cannot be found, invisible bounds are returned (0x0).

pub fn get_origin(&self) -> (u32, u32)

Retrieves the origin of the Widget. If the origin cannot be found, an origin of 0x0 is returned.

pub fn get_bool(&self, property_key: u32) -> bool

Retrieves the boolean value for a specified property. If the property has not been set with set_bool, the return will be false. Otherwise, if the specified key exists, and the value is set to 1, the return value will be true.

pub fn get_value(&self, property_key: u32) -> i32

Retrieves a numeric value assigned to a property as an i32 value.

Trait Implementations

impl Clone for WidgetProperties

fn clone(&self) -> WidgetProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WidgetProperties

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

Formats the value using the given formatter.

impl Default for WidgetProperties

fn default() -> WidgetProperties

Returns the "default value" for a type.