Struct pushrod_widgets::system_widgets::image_button_widget::ImageButtonWidget

pub struct ImageButtonWidget { /* fields omitted */ }

Base Widget.

Trait Implementations

impl Default for ImageButtonWidget

fn default() -> ImageButtonWidget

Returns the "default value" for a type.

impl Widget for ImageButtonWidget

Implementation for drawing a ImageButtonWidget, with the Widget trait objects applied.

fn properties(&mut self) -> &mut WidgetProperties

This provides access to the WidgetProperties set for a Widget. These must be defined in the structure of the Widget, as they allow for direct manipulation of the properties.

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

This is an ImageButtonWidget that is used as a standard blank Widget.

• PROPERTY_MAIN_COLOR: the Color of the body of the Widget
• PROPERTY_BORDER_WIDTH: the width of the border to draw
• PROPERTY_BORDER_COLOR: the Color of the border
• PROPERTY_FONT_COLOR: the color of the font
• PROPERTY_FONT_NAME: full or relative path to the font file to use to render the text
• PROPERTY_FONT_SIZE: the size in points of the font
• PROPERTY_FONT_STYLE: the FontStyle to apply to the font
• PROPERTY_TEXT_JUSTIFICATION: The TEXT_JUSTIFY_* constant to use to position the text inside the Widget
• PROPERTY_TEXT: String containing the text to display
• PROPERTY_IMAGE_FILENAME: the image to show in the button (should be an image equal in width and height dimensions)
• PROPERTY_IMAGE_POSITION: the position of the image inside the button - left or right side

While the button is selected, the color of the background will be Color::BLACK, and the text will turn Color::WHITE. If the button is not selected, it will revert back to the colors that you set for the text color and background colors of the button.

fn handle_event(&mut self, event: PushrodEvent) -> Option<PushrodEvent>

Overrides the handle_event function, which handles the mouse button, widget entering and exiting events.

fn invalidate(&mut self)

Set the invalidation key for this Widget, indicating that the TextureCache needs to be redrawn.

fn invalidated(&mut self) -> bool

Flag indicating whether or not the draw method needs to be called for this Widget so that its TextureCache is refreshed.