Struct pushrod_widgets::system_widgets::image_widget::ImageWidget

pub struct ImageWidget { /* fields omitted */ }

This is the storage object for the ImageWidget. It stores the config, properties, callback registry, the image name, and a scale flag.

Trait Implementations

impl Default for ImageWidget

fn default() -> ImageWidget

Returns the "default value" for a type.

impl Widget for ImageWidget

Creates a new ImageWidget, which draws an image in a supported image format for SDL2 at a specific location on the screen. Requires the name of the image (the full path to the file), the position within the widget (defined as ImagePosition), the xywh bounds, and whether or not the image is scaled within the bounds of the Widget.

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 widget_name(&self) -> String

Returns the name of the type of Widget. Must be implemented by Widgets, as this helps with (de)serialization.

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

This is the drawing implementation of the ImageWidget. The following are the properties that can be applied:

• 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_IMAGE_POSITION: position of the image within the ImageWidget
• PROPERTY_IMAGE_FILENAME: the filename of the image to display
• PROPERTY_IMAGE_SCALED: boolean flag indicating whether or not to scale the image to the bounds of the ImageWidget

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

Handles a PushrodEvent sent to the Widget that would also be sent to the application. If any PushrodEvents trigger a custom Widget-based event, this function can intercept the incoming event, and issue one of its own. If the function returns no events, a None can be returned, otherwise a Some(PushrodEvent) should be returned. If this function returns an event, that event will be sent on to the application as soon as it has been generated.

fn build_layout(&mut self) -> Vec<Box<dyn Widget>>

This is called when PROPERTY_NEEDS_LAYOUT is enabled in properties. When a layout is required to be built, this function is called, returning the list of Widgets that are to be added. If no Widgets are to be added, an empty list is valid to return here. Otherwise, the list of Widgets that this parent Widget controls are returned as a list here.

fn constructed_layout_ids(&mut self, _ids: Vec<u32>)

After a build_layout call has been completed, the list of IDs that were added to the display list are returned in the same order in from build_layout. The Widget that created these IDs should then store them here in an array, so that they can be referenced when interacted with.

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.

fn hide(&mut self)

Sets the Widget to hidden state. If not overridden, this function will only hide the current Widget, not its children. To do that, you will need to use the set_hidden function in WidgetCache, which walks the tree.

fn show(&mut self)

Sets the Widget to visible state. If not overridden, this function will only show the current Widget, not its children. To do that, you'll need to use the set_hidden function in WidgetCache, which walks the tree.