[−][src]Struct pushrod::render::widget::BaseWidget
This is an example top-level Widget
object that is used to draw a background and a border
of specified colors. COLOR_BASE
determines the background fill color, and the COLOR_BORDER
determines the color of the border. The width of the border is controlled by the
get_config().border_width
property.
Methods
impl BaseWidget
[src]
Base top-level implementation of the BaseWidget
, which other classes can extend.
pub fn new(points: Points, size: Size) -> Self
[src]
Constructs a new base widget, given the points of origin and size.
Trait Implementations
impl Widget for BaseWidget
[src]
Implementation for drawing a BaseWidget
, with the Widget
trait objects applied.
This code can be used as a base implementation, or an example of how to create a Widget
in
Pushrod
. The base set of Widget
s show off a multitude of different uses for handling events,
display contents, and so on. Look through the code in the pushrod::widgets
module to get
more of an idea of what is possible.
fn draw(
&mut self,
c: &mut Canvas<Window>,
_t: &mut TextureCache
) -> Option<&Texture>
[src]
&mut self,
c: &mut Canvas<Window>,
_t: &mut TextureCache
) -> Option<&Texture>
fn as_any(&mut self) -> &mut dyn Any
[src]
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
[src]
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>
[src]
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
[src]
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]
)
[src]
&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]
)
[src]
&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]
)
[src]
&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
)
[src]
&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
)
[src]
&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
)
[src]
&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 mouse_entered(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_exited(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer]
)
fn mouse_moved(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn mouse_scrolled(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_points: Points
)
fn button_clicked(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_button: u8,
_clicks: u8,
_state: bool
)
fn tick(&mut self, _widgets: &[WidgetContainer], _layouts: &[LayoutContainer])
[src]
fn other_event(
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
[src]
&mut self,
_widgets: &[WidgetContainer],
_layouts: &[LayoutContainer],
_event: Event
)
fn on_config_changed(&mut self, _k: u8, _v: Config)
[src]
fn set_point(&mut self, config: u8, x: i32, y: i32)
[src]
fn set_color(&mut self, config: u8, color: Color)
[src]
fn set_numeric(&mut self, config: u8, value: i32)
[src]
fn set_text(&mut self, config: u8, text: String)
[src]
fn set_toggle(&mut self, config: u8, flag: bool)
[src]
fn set_compass(&mut self, config: u8, value: CompassPosition)
[src]
fn get_point(&mut self, k: u8) -> Points
[src]
fn get_size(&mut self, k: u8) -> Size
[src]
fn get_color(&mut self, k: u8) -> Color
[src]
fn get_numeric(&mut self, k: u8) -> i32
[src]
fn get_text(&mut self, k: u8) -> String
[src]
fn get_toggle(&mut self, k: u8) -> bool
[src]
fn get_compass(&mut self, k: u8) -> CompassPosition
[src]
fn set_origin(&mut self, _origin: Points)
[src]
fn set_size(&mut self, _size: Vec<u32>)
[src]
fn get_drawing_area(&mut self) -> Rect
[src]
fn is_invalidated(&mut self) -> bool
[src]
fn set_invalidated(&mut self, flag: bool)
[src]
Auto Trait Implementations
impl !RefUnwindSafe for BaseWidget
impl !Send for BaseWidget
impl !Sync for BaseWidget
impl Unpin for BaseWidget
impl !UnwindSafe for BaseWidget
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,