Struct pushrod::widget::text_widget::TextWidget

pub struct TextWidget { /* fields omitted */ }

This is the TextWidget, which draws a line of text on the screen. This structure contains no accessable objects, they are all internal to TextWidget's implementation.

Example usage: IN PROGRESS

Methods

impl TextWidget

Implementation of the constructor for the TextWidget. Creates a new text object to be displayed on the screen, given a font name, font size, and text message.

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

Creates a new TextWidget object, requiring the current PistonWindow's factory object (which can be cloned), the name of the font (filename in the assets directory), the text to display, the font size in which to use, and the desired text justification strategy.

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

Function to draw the text. Generates a context transformation to display the text based on the point of origin's X and Y coordinates. Since the text is drawn upwards from the point of origin, the starting point is the lower left-hand corner of the widget. (This may change based on text justification, and other optional padding, once padding is introduced.)

Trait Implementations

impl Widget for TextWidget

Implementation of the TextWidget object with the Widget traits implemented.

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 draw(&mut self, c: Context, g: &mut G2d, clip: &DrawState)

Draws the contents of the widget.

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 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 inject_event(&mut self, _widget_id: i32) -> Option<CallbackEvent>

Injects an event into the run loop, but only if injects_events returns true.

fn injects_events(&mut self) -> bool

When set to true, this will check only the Widget that is set to inject events at the time the run loop starts. This cannot be toggled on/off by the Widget, as the run loop checks for Widget objects that inject events before the loop starts. This is to use less overhead during the run loop.

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.