Struct pushrod::widget::radio_button_widget::RadioButtonWidget

pub struct RadioButtonWidget { /* fields omitted */ }

This is the RadioButtonWidget, which contains a top-level widget for display, overriding the draw method to draw the base widget and the border for this box.

Example usage: IN PROGRESS

Methods

impl RadioButtonWidget

Implementation of the constructor for the RadioButtonWidget.

pub fn new(
    factory: &mut GfxFactory,
    font_name: String,
    text: String,
    font_size: u32,
    justify: TextJustify,
    selected: bool
) -> Self

Trait Implementations

impl Widget for RadioButtonWidget

Implementation of the RadioButtonWidget object with the Widget traits implemented. The base widget is a BoxWidget, which overlays a TextWidget over the top. This Widget responds to the button down/up callbacks internally.

fn config(&mut self) -> &mut Configurable

Retrieves the configuration HashMap that stores the configuration list of settings for this widget.

fn set_config(&mut self, config: u8, config_value: Config)

fn handle_event(
    &mut self,
    injected: bool,
    event: CallbackEvent
) -> Option<CallbackEvent>

Handles an event that was sent by the event loop. It is up to the Widget to handle the event, or to ignore it. If this function is not overridden, the event will be ignored, and no event will be returned as a result. This function returns an Option<CallbackEvent>, which can be injected into the run loop. This can be things for Widget interaction that may generate an event that the application needs to respond to, like a button click, or a drag start/end event.

fn injects_events(&mut self) -> bool

This function injects events, as other radio buttons need to become invalidated that may be part of the same group ID.

fn inject_event(&mut self, widget_id: i32) -> Option<CallbackEvent>

Returns an injected event where appropriate.

fn draw(&mut self, c: Context, g: &mut G2d, clip: &DrawState)

Draws the contents of the widget in this order:

• Base widget first
• Box graphic for the specified width

fn invalidate(&mut self)

Indicates that a widget needs to be redrawn/refreshed.

fn clear_invalidate(&mut self)

Clears the invalidation flag.

fn is_invalidated(&mut self) -> bool

Checks to see whether or not the widget needs to be redrawn/refreshed.

fn get_config(&mut self, config: u8) -> Option<&Config>

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

fn set_size(&mut self, config: u8, w: i32, h: i32)

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

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

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

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

fn draw_with_offset(
    &mut self,
    c: Context,
    g: &mut G2d,
    clip: &DrawState,
    point_offset: Point
)

Sets an alternate context with a drawing offset and size scale, then calls the underlying draw routine. If this is not the desired effect, this routine can be overridden, but this will handle the offset drawing for 90% of the Widget draw routines.