Struct pushrod::widget::box_widget::BoxWidget

pub struct BoxWidget { /* fields omitted */ }

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

Methods

impl BoxWidget

Implementation of the constructor for the BaseWidget. Creates a new base widget that can be positioned anywhere on the screen.

pub fn new() -> Self

pub fn set_border_color(&mut self, color: Color)

Sets the border color for this widget.

pub fn get_border_color(&mut self) -> Color

Retrieves the border color of this widget. Defaults to black color [0.0, 0.0, 0.0, 1.0] if not set.

pub fn set_border_thickness(&mut self, thickness: u8)

Sets the thickness of the border for this widget.

pub fn get_border_thickness(&mut self) -> u8

Retrieves the border thickness of this widget. Defaults to 1 if not set.

Trait Implementations

impl Widget for BoxWidget

Implementation of the BoxWidget object with the Widget traits implemented. This implementation is similar to the BaseWidget, but incorporates a drawable box inside the widget. Base widget is the BaseWidget.

This is basically just a box with a fill color. Use this to draw other things like buttons, text widgets, and so on, if you need anything with a drawable border.

Example usage:

   let mut box_widget = BoxWidget::new();

   box_widget.set_origin(Point { x: 100, y: 100 });
   box_widget.set_size(pushrod::core::point::Size { w: 200, h: 200 });
   box_widget.set_color([0.5, 0.5, 0.5, 1.0]);
   box_widget.set_border_color([0.0, 0.0, 0.0, 1.0]);
   box_widget.set_border_thickness(3);

fn get_config(&mut self) -> &RefCell<HashMap<ConfigKey, WidgetConfig>>

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

fn set_origin(&mut self, point: Point)

Sets the Point of origin for this widget and the base widget. Invalidates the widget afterward.

fn set_size(&mut self, size: Size)

Sets the Size for this widget and the base widget. Invalidates the widget afterward.

fn set_color(&mut self, color: Color)

Sets the color for this widget. Invalidates the widget afterward.

fn get_color(&mut self) -> Color

Retrieves the color of this widget. Defaults to white color [1.0; 4] if not set.

fn mouse_entered(&mut self, widget_id: i32)

Called when a mouse enters the bounds of the widget. Includes the widget ID.

fn mouse_exited(&mut self, widget_id: i32)

Called when a mouse exits the bounds of the widget. Includes the widget ID.

fn mouse_scrolled(&mut self, widget_id: i32, point: Point)

Called when a scroll event is called within the bounds of the widget. Includes the widget ID.

fn draw(&mut self, context: Context, graphics: &mut GlGraphics)

Draws the contents of the widget in this order:

• Base widget first
• Box graphic for the specified width

fn set_config(&mut self, key: u8, value: WidgetConfig)

Sets a configuration object by its key.

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_origin(&mut self) -> Point

Retrieves the Point of origin for this object. Defaults to origin (0, 0) if not set.

fn get_size(&mut self) -> Size

Retrieves the Size bounds for this widget. Defaults to size (0, 0) if not set.