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.

Example usage:

   let mut box_widget = BoxWidget::new();

   box_widget.set_origin(100, 100);
   box_widget.set_size(200, 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);

   // (OR)

   box_widget.set_border([0.0, 0.0, 0.0, 1.0], 3);

Methods

impl BoxWidget

Implementation of the constructor for the CanvasWidget. 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.

pub fn set_border(&mut self, color: Color, thickness: u8)

Helper function that sets both the color of the border and the thickness at the same time.

Trait Implementations

impl Widget for BoxWidget

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

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.

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

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

fn callbacks(&mut self) -> &mut CallbackStore

Returns the CallbackStore for this Widget. This contains a set of callbacks that only apply to this Widget.

fn set_origin(&mut self, x: i32, y: i32)

Sets the Point of origin for this widget and the base widget, given the X and Y coordinates. Invalidates the widget afterward.

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

Sets the Size for this widget and the base widget, given width and height. 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 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_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.

fn perform_single_callback(&mut self, callback_id: u32, widget_id: i32)

Performs a callback stored in the CallbackStore for this Widget, but only for the CallbackTypes::SingleCallback enum type. If the callback does not exist, or is not defined properly, it will be silently dropped and ignored.

fn perform_bool_callback(
    &mut self,
    callback_id: u32,
    widget_id: i32,
    flag: bool
)

Performs a callback stored in the CallbackStore for this Widget, but only for the CallbackTypes::BoolCallback enum type. If the callback does not exist, or is not defined properly, it will be silently dropped and ignored.

fn perform_point_callback(
    &mut self,
    callback_id: u32,
    widget_id: i32,
    point: Point
)

Performs a callback stored in the CallbackStore for this Widget, but only for the CallbackTypes::PointCallback enum type. If the callback does not exist, or is not defined properly, it will be silently dropped and ignored.

fn perform_size_callback(
    &mut self,
    callback_id: u32,
    widget_id: i32,
    size: Size
)

Performs a callback stored in the CallbackStore for this Widget, but only for the CallbackTypes::SizeCallback enum type. If the callback does not exist, or is not defined properly, it will be silently dropped and ignored.

fn perform_button_callback(
    &mut self,
    callback_id: u32,
    widget_id: i32,
    button: Button
)

fn perform_key_callback(
    &mut self,
    callback_id: u32,
    widget_id: i32,
    key: Key,
    state: ButtonState
)

Performs a callback stored in the CallbackStore for this Widget, but only for the CallbackTypes::KeyCallback enum type. If the callback does not exist, or is not defined properly, it will be silently dropped and ignored.

fn key_pressed(&mut self, widget_id: i32, key: &Key, state: &ButtonState)

Called when a keyboard event takes place within the bounds of a widget. Includes the widget ID, the key code that was affected, and its state - pressed or released.

fn mouse_entered(&mut self, widget_id: i32)

Called when a mouse enters the bounds of the widget. Includes the widget ID. Only override if you want to signal a mouse enter event.

fn mouse_exited(&mut self, widget_id: i32)

Called when a mouse exits the bounds of the widget. Includes the widget ID. Only override if you want to signal a mouse exit event.

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. Only override if you want to signal a mouse scroll event.

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

Called when the mouse pointer is moved inside a widget. Includes the widget ID and point. Only override if you want to track mouse movement.

fn window_resized(&mut self, widget_id: i32, size: Size)

Called when the main window is resized. Includes the widget ID and the new window size. Only override if you want to respond to a window resize (and if the window is resizable.)

fn window_focused(&mut self, widget_id: i32, focused: bool)

Called when a window focus state changes. Includes the widget ID and a focus flag: true when window gains focus, false otherwise. Only override if you want to signal a window focus event.

fn button_down(&mut self, widget_id: i32, button: Button)

Called when a mouse button is clicked down. Includes the widget ID and the button code. Only override if you want to respond to a mouse click.

fn button_up_inside(&mut self, widget_id: i32, button: Button)

Called when a mouse button is released inside the same Widget that it was clicked inside. Includes the widget ID and the button code. Only override if you want to respond to a mouse button release.

fn button_up_outside(&mut self, widget_id: i32, button: Button)

Called when a mouse button is released outside the same Widget that it was clicked inside. Includes the widget ID and the button code. Only override if you want to respond to a mouse button release.

fn on_key_pressed(&mut self, callback: KeyCallback)

fn on_mouse_entered(&mut self, callback: SingleCallback)

Sets the closure action to be performed when a mouse enters a Widget.

fn on_mouse_exited(&mut self, callback: SingleCallback)

Sets the closure action to be performed when a mouse exits a Widget.

fn on_mouse_scrolled(&mut self, callback: PointCallback)

Sets the closure action to be performed when a mouse scrolls inside a Widget.

fn on_mouse_moved(&mut self, callback: PointCallback)

Sets the closure action to be performed when a mouse moves within a Widget. The mouse point is based on the position within the Widget, not its Point relative to the window.

fn on_window_resized(&mut self, callback: SizeCallback)

Sets the window resize action to be performed when the window is resized.

fn on_focused(&mut self, callback: BoolCallback)

Sets the window focused action to be performed when the window is (un)focused.

fn on_button_down(&mut self, callback: ButtonCallback)

Sets the button click action to be performed when a mouse button is clicked.

fn on_button_up_inside(&mut self, callback: ButtonCallback)

Sets the callback to be performed when a mouse button is released within the same Widget that it was pressed down inside.

fn on_button_up_outside(&mut self, callback: ButtonCallback)

Sets the callback to be performed when a mouse button is released outside of the same Widget that it was pressed down inside.