Struct TabBarWidget 

pub struct TabBarWidget { /* private fields */ }

This is the storage object for the TabBarWidget. It stores the config, properties, callback registry, tab items, and other storage values for internal rendering.

Implementations

impl TabBarWidget

This is the implementation of the TabBarWidget, which displays a series of tabs specified by the tab items in the constructor. Tab bar items are automatically sized and rendered depending on the number of items specified.

pub fn new(points: Points, size: Size, tab_items: Vec<String>) -> Self

Creates a new TabBarWidget, given the x, y, w, h coordinates, and the tab items to be shown in the tab bar area.

Examples found in repository

examples/tab_bar.rs (lines 25-33)

pub fn main() {
    let sdl_context = sdl2::init().unwrap();
    let video_subsystem = sdl_context.video().unwrap();
    let window = video_subsystem
        .window("pushrod-render tab bar demo", 400, 300)
        .position_centered()
        .opengl()
        .build()
        .unwrap();
    let mut engine = Engine::new(400, 300, 60);
    let mut widget1 = TabBarWidget::new(
        make_points(20, 20),
        make_size(360, 30),
        vec![
            String::from("First"),
            String::from("Second"),
            String::from("Third"),
        ],
    );

    widget1.set_color(CONFIG_COLOR_BASE, Color::RGB(255, 255, 255));
    widget1.set_color(CONFIG_COLOR_HOVER, Color::RGB(192, 192, 255));
    widget1.on_tab_selected(|_, _, _, selected_tab| {
        eprintln!("Selected tab: {}", selected_tab);
    });

    engine.add_widget(Box::new(widget1), String::from("widget1"));

    engine.run(sdl_context, window);
}

pub fn on_tab_selected<F>(&mut self, callback: F)

where F: FnMut(&mut TabBarWidget, &[WidgetContainer], &[LayoutContainer], u16) + 'static,

Assigns the callback closure that will be used when a tab is selected.

Examples found in repository

examples/tab_bar.rs (lines 37-39)

pub fn main() {
    let sdl_context = sdl2::init().unwrap();
    let video_subsystem = sdl_context.video().unwrap();
    let window = video_subsystem
        .window("pushrod-render tab bar demo", 400, 300)
        .position_centered()
        .opengl()
        .build()
        .unwrap();
    let mut engine = Engine::new(400, 300, 60);
    let mut widget1 = TabBarWidget::new(
        make_points(20, 20),
        make_size(360, 30),
        vec![
            String::from("First"),
            String::from("Second"),
            String::from("Third"),
        ],
    );

    widget1.set_color(CONFIG_COLOR_BASE, Color::RGB(255, 255, 255));
    widget1.set_color(CONFIG_COLOR_HOVER, Color::RGB(192, 192, 255));
    widget1.on_tab_selected(|_, _, _, selected_tab| {
        eprintln!("Selected tab: {}", selected_tab);
    });

    engine.add_widget(Box::new(widget1), String::from("widget1"));

    engine.run(sdl_context, window);
}

Trait Implementations

impl Widget for TabBarWidget

This is the Widget implementation of the TabBarWidget.

fn mouse_entered( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], )

When a mouse enters the bounds of the Widget, this function is triggered. Overridden by this Widget.

fn mouse_exited( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], )

When a mouse exits the bounds of the Widget, this function is triggered. Overidden by this Widget.

fn mouse_moved( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], points: Points, )

Overrides the mouse_moved function, used to determine the position of the tab bar that is currently under the mouse coordinates.

fn button_clicked( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], button: u8, _clicks: u8, state: bool, )

Overrides the button_clicked function, used to determine when a mouse clicks inside the bounds of a tab, triggering the on_tab_selected callback where appropriate.

fn as_any(&mut self) -> &mut dyn Any

This function is a macro-created getter function that returns the Widget as an Any type. This allows the Widget trait to be downcast into a struct that implements the Widget trait.

fn get_config(&mut self) -> &mut WidgetConfig

This function is a macro-created getter function that returns the Widget’s configuration object as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn get_system_properties(&mut self) -> &mut HashMap<i32, String>

This function is a macro-created getter function that returns the Widget’s system properties as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn get_callbacks(&mut self) -> &mut CallbackRegistry

This function is a macro-created getter function that returns the Widget’s CallbackRegistry object as a borrowed mutable reference. This code is auto-generated using the default_widget_properties!() macro.

fn tick_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], )

This function is a macro-created tick callback override, created by the default_widget_callbacks!() macro.

fn mouse_entered_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], )

This function is a macro-created mouse entered callback override, created by the default_widget_callbacks!() macro.

fn mouse_exited_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], )

This function is a macro-created mouse exited callback override, created by the default_widget_callbacks!() macro.

fn mouse_moved_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], _points: Points, )

This function is a macro-created mouse moved callback override, created by the default_widget_callbacks!() macro.

fn mouse_scrolled_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], _points: Points, )

This function is a macro-created mouse scrolled callback override, created by the default_widget_callbacks!() macro.

fn button_clicked_callback( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], _button: u8, _clicks: u8, _state: bool, )

This function is a macro-created mouse scrolled callback override, created by the default_widget_callbacks!() macro.

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

Draws the widget. If you wish to modify the canvas object, you must declare it as mut in your implementation (ie fn draw(&mut self, mut canvas: Canvas<Window>)). The _canvas is the currently active drawing canvas at the time this function is called. This called during the draw loop of the Engine. This returns a reference to the stored Texture object within the Widget. It is then copied to the canvas, and displayed in the display loop. In this function, you can just return a reference to the Texture if no invalidation state was set, otherwise, the draw can be re-performed, and the Texture returned. If the drawing function returns no texture, return a None, and it will not be rendered during the display loop, but it will still be called. A TextureCache is provided in case your Widget needs to cache an image or a font store.

fn mouse_scrolled( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], _points: Points, )

When a mouse scroll is triggered within the bounds of the Widget, this function is triggered. Movement along the X axis indicate horizontal movement, where the Y axis indicates vertical movement. Positive movement means to the right or down, respectively. Negative movement means to the left or up, respectively. This function implementation is optional.

fn tick(&mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer])

When a timer tick goes by (ie. a frame is displayed on the screen), this function is called. This function implementation is optional.

fn other_event( &mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer], _event: Event, )

When an Event is sent to the application that is not handled by the Engine::run loop, this method is called, sending the unhandled Event to the currently active Widget. This behavior is subject to change as the Engine::run loop is modified to handle more Events.

fn on_config_changed(&mut self, _k: u8, _v: Config)

This callback is called when a setter is used to configure a value. It is not called when a call to get_config() using the setter is called, so it is best to use the top-level setters and getters for the configuration values - at least, until the get_config() call can be made private.

fn set_point(&mut self, config: u8, x: i32, y: i32)

Sets a point for a configuration key.

fn set_color(&mut self, config: u8, color: Color)

Sets a color for a configuration key.

fn set_numeric(&mut self, config: u8, value: i32)

Sets a numeric value for a configuration key.

fn set_text(&mut self, config: u8, text: String)

Sets a text value for a configuration key.

fn set_toggle(&mut self, config: u8, flag: bool)

Sets a toggle for a configuration key.

fn set_compass(&mut self, config: u8, value: CompassPosition)

Sets a compass position for a configuration key.

fn get_point(&mut self, k: u8) -> Points

Retrieves a Points for a configuration key. Returns Points::default if not set.

fn get_size(&mut self, k: u8) -> Size

Retrieves a Size for a configuration key. Returns a Size::default if not set.

fn get_color(&mut self, k: u8) -> Color

Retrieves a Color for a configuration key. Returns white if not set.

fn get_numeric(&mut self, k: u8) -> i32

Retrieves a numeric value for a configuration key. Returns 0 if not set.

fn get_text(&mut self, k: u8) -> String

Retrieves text for a configuration key. Returns a blank string if not set.

fn get_toggle(&mut self, k: u8) -> bool

Retrieves a boolean toggle for a configuration key. Returns false if not set.

fn get_compass(&mut self, k: u8) -> CompassPosition

Retrieves a CompassPosition toggle for a configuration key. Returns CompassPosition::W if not set.

fn set_origin(&mut self, _origin: Points)

Sets the origin of the Widget, adjusting the X and Y coordinates. Automatically sets the invalidate flag to true when adjusted, but only if the new origin is not the same as the previous origin.

fn set_size(&mut self, _size: Vec<u32>)

Sets the size of the Widget, adjusting the width and height. Automatically sets the invalidate flag to true when adjusted, but only if the new size is not the same as the previous size.

fn get_drawing_area(&mut self) -> Rect

Returns a Rect object containing the drawing bounds of this Widget.

fn is_invalidated(&mut self) -> bool

Returns whether or not a Widget is invalidated state.

fn set_invalidated(&mut self, flag: bool)

Sets invalidation state for the current Widget.