Struct pushrod::widgets::slider_widget::SliderWidget

pub struct SliderWidget { /* fields omitted */ }

This is the storage object for the SliderWidget. It stores the config, properties, callback registry.

Methods

impl SliderWidget

This is the implementation of the SliderWidget, a control that draws a bounds line indicator, and a draggable slider.

pub fn new(
    points: Points,
    size: Size,
    min: u32,
    max: u32,
    current: u32,
    orientation: SliderOrientation
) -> Self

Creates a new SliderWidget given the x, y, w, h coordinates, sets the min and max values, the current value, and the orientation of the slider as drawn.

pub fn on_value_changed<F>(&mut self, callback: F) where
    F: FnMut(&mut SliderWidget, &[WidgetContainer], &[LayoutContainer], u32) + 'static, 

Assigns the callback closure that will be used when the Widget changes value.

Trait Implementations

impl CanvasHelper for SliderWidget

fn draw_point(&mut self, c: &mut Canvas<Window>, x: i32, y: i32)

Draws a point in the Canvas.

fn draw_bounding_box(&mut self, c: &mut Canvas<Window>)

Draws a box around the bounding area of the Widget.

fn get_rect_dest(&mut self) -> Rect

Returns a Rect destination object

impl Widget for SliderWidget

This is the Widget implementation of the SliderWidget.

fn draw(
    &mut self,
    c: &mut Canvas<Window>,
    _t: &mut TextureCache
) -> Option<&Texture>

Draws the SliderWidget contents.

fn mouse_entered(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer]
)

When a mouse enters the bounds of the Widget, this function is triggered.

fn mouse_exited(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer]
)

When a mouse exits the bounds of the Widget, this function is triggered.

fn mouse_moved(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    points: Points
)

When a mouse is moved in the bounds of this Widget, this function is triggered.

fn mouse_scrolled(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    points: Points
)

Handles the scrolling functionality.

fn button_clicked(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    _button: u8,
    _clicks: u8,
    _state: bool
)

Overrides the button_clicked callback to handle toggling.

fn as_any(&mut self) -> &mut dyn Any

This function is a macro-created getter function that returns the Widget as an Any type. This allows the Widget trait to be downcast into a struct that implements the Widget trait.

fn get_config(&mut self) -> &mut WidgetConfig

This function is a macro-created getter function that returns the Widget's configuration object as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn get_system_properties(&mut self) -> &mut HashMap<i32, String>

This function is a macro-created getter function that returns the Widget's system properties as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn get_callbacks(&mut self) -> &mut CallbackRegistry

This function is a macro-created getter function that returns the Widget's CallbackRegistry object as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn tick_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer]
)

This function is a macro-created tick callback override, created by the default_widget_callbacks!() macro.

fn mouse_entered_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer]
)

This function is a macro-created mouse entered callback override, created by the default_widget_callbacks!() macro.

fn mouse_exited_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer]
)

This function is a macro-created mouse exited callback override, created by the default_widget_callbacks!() macro.

fn mouse_moved_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    _points: Points
)

This function is a macro-created mouse moved callback override, created by the default_widget_callbacks!() macro.

fn mouse_scrolled_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    _points: Points
)

This function is a macro-created mouse scrolled callback override, created by the default_widget_callbacks!() macro.

fn button_clicked_callback(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    _button: u8,
    _clicks: u8,
    _state: bool
)

This function is a macro-created mouse scrolled callback override, created by the default_widget_callbacks!() macro.

fn tick(&mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer])

When a timer tick goes by (ie. a frame is displayed on the screen), this function is called. This function implementation is optional.

fn other_event(
    &mut self,
    _widgets: &[WidgetContainer],
    _layouts: &[LayoutContainer],
    _event: Event
)

When an Event is sent to the application that is not handled by the Engine::run loop, this method is called, sending the unhandled Event to the currently active Widget. This behavior is subject to change as the Engine::run loop is modified to handle more Events.

fn on_config_changed(&mut self, _k: u8, _v: Config)

This callback is called when a setter is used to configure a value. It is not called when a call to get_config() using the setter is called, so it is best to use the top-level setters and getters for the configuration values - at least, until the get_config() call can be made private.

fn set_point(&mut self, config: u8, x: i32, y: i32)

Sets a point for a configuration key.

fn set_color(&mut self, config: u8, color: Color)

Sets a color for a configuration key.

fn set_numeric(&mut self, config: u8, value: i32)

Sets a numeric value for a configuration key.

fn set_text(&mut self, config: u8, text: String)

Sets a text value for a configuration key.

fn set_toggle(&mut self, config: u8, flag: bool)

Sets a toggle for a configuration key.

fn set_compass(&mut self, config: u8, value: CompassPosition)

Sets a compass position for a configuration key.

fn get_point(&mut self, k: u8) -> Points

Retrieves a Points for a configuration key. Returns Points::default if not set.

fn get_size(&mut self, k: u8) -> Size

Retrieves a Size for a configuration key. Returns a Size::default if not set.

fn get_color(&mut self, k: u8) -> Color

Retrieves a Color for a configuration key. Returns white if not set.

fn get_numeric(&mut self, k: u8) -> i32

Retrieves a numeric value for a configuration key. Returns 0 if not set.

fn get_text(&mut self, k: u8) -> String

Retrieves text for a configuration key. Returns a blank string if not set.

fn get_toggle(&mut self, k: u8) -> bool

Retrieves a boolean toggle for a configuration key. Returns false if not set.

fn get_compass(&mut self, k: u8) -> CompassPosition

Retrieves a CompassPosition toggle for a configuration key. Returns CompassPosition::W if not set.

fn set_origin(&mut self, _origin: Points)

Sets the origin of the Widget, adjusting the X and Y coordinates. Automatically sets the invalidate flag to true when adjusted, but only if the new origin is not the same as the previous origin.

fn set_size(&mut self, _size: Vec<u32>)

Sets the size of the Widget, adjusting the width and height. Automatically sets the invalidate flag to true when adjusted, but only if the new size is not the same as the previous size.

fn get_drawing_area(&mut self) -> Rect

Returns a Rect object containing the drawing bounds of this Widget.

fn is_invalidated(&mut self) -> bool

Returns whether or not a Widget is invalidated state.

fn set_invalidated(&mut self, flag: bool)

Sets invalidation state for the current Widget.