Struct conrod::Canvas
[−]
[src]
pub struct Canvas<'a> { pub common: CommonBuilder, pub style: Style, pub maybe_title_bar_label: Option<&'a str>, }
A widget designed to be a parent for other widgets.
Fields
common: CommonBuilder
Data necessary and common for all widget builder types.
style: Style
The builder data related to the style of the Canvas.
maybe_title_bar_label: Option<&'a str>
The label for the Canvas' TitleBar if there is one.
Methods
impl<'a> Canvas<'a>
[src]
fn new() -> Canvas<'a>
Construct a new Canvas builder.
fn title_bar(self, label: &'a str) -> Self
Show or hide the title bar.
fn pad_left(self, pad: Scalar) -> Self
Set the padding of the left of the area where child widgets will be placed.
fn pad_right(self, pad: Scalar) -> Self
Set the padding of the right of the area where child widgets will be placed.
fn pad_top(self, pad: Scalar) -> Self
Set the padding of the top of the area where child widgets will be placed.
fn pad_bottom(self, pad: Scalar) -> Self
Set the padding of the bottom of the area where child widgets will be placed.
fn padding(self, pad: Padding) -> Self
Set the padding of the area where child widgets will be placed.
fn margin_left(self, mgn: Scalar) -> Self
Set the margin of the left of the area where child widgets will be placed.
fn margin_right(self, mgn: Scalar) -> Self
Set the margin of the right of the area where child widgets will be placed.
fn margin_top(self, mgn: Scalar) -> Self
Set the margin of the top of the area where child widgets will be placed.
fn margin_bottom(self, mgn: Scalar) -> Self
Set the margin of the bottom of the area where child widgets will be placed.
fn margin(self, mgn: Margin) -> Self
Set the padding of the area where child widgets will be placed.
fn with_style(self, style: Style) -> Self
Build the Canvas with the given Style.
Trait Implementations
impl<'a> Widget for Canvas<'a>
[src]
type State = State
State to be stored within the Ui
s widget cache. Read more
type Style = Style
Styling used by the widget to draw its graphics. Read more
fn common(&self) -> &CommonBuilder
Return a reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget. Read more
fn common_mut(&mut self) -> &mut CommonBuilder
Return a mutable reference to a CommonBuilder struct owned by the Widget. This method allows us to do a blanket impl of Positionable and Sizeable for T: Widget. Read more
fn unique_kind(&self) -> Kind
Return the kind of the widget as a &'static str. Read more
fn init_state(&self) -> State
Return the initial State of the Widget. Read more
fn style(&self) -> Style
Return the styling of the widget. Read more
fn default_x_position<C: CharacterCache>(&self, _ui: &Ui<C>) -> Position
The default Position for the widget along the x axis. Read more
fn default_y_position<C: CharacterCache>(&self, _ui: &Ui<C>) -> Position
The default Position for the widget along the y axis. Read more
fn default_x_dimension<C: CharacterCache>(&self, ui: &Ui<C>) -> Dimension
The default width for the Widget. Read more
fn default_y_dimension<C: CharacterCache>(&self, ui: &Ui<C>) -> Dimension
The default height of the widget. Read more
fn drag_area(&self, dim: Dimensions, style: &Style, theme: &Theme) -> Option<Rect>
The title bar area at which the Canvas can be clicked and dragged.
Note: the position of the returned Rect should be relative to the center of the widget.
fn kid_area<C: CharacterCache>(&self, args: KidAreaArgs<Self, C>) -> KidArea
The area of the widget below the title bar, upon which child widgets will be placed.
fn update<C: CharacterCache>(self, args: UpdateArgs<Self, C>)
Update the state of the Canvas.
fn parent<I: Into<Index>>(self, parent_idx: I) -> Self
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
Specify that this widget has no parent widgets.
fn picking_passthrough(self, passthrough: bool) -> Self
Whether or not the widget should be considered when picking the topmost widget at a position. Read more
fn place_on_kid_area(self, b: bool) -> Self
Set whether or not the Widget should be placed on the kid_area. Read more
fn graphics_for<I: Into<Index>>(self, idx: I) -> Self
Indicates that the Widget is used as a non-interactive graphical element for some other widget. Read more
fn floating(self, is_floating: bool) -> Self
Set whether or not the widget is floating (the default is false
). A typical example of a floating widget would be a pop-up or alert window. Read more
fn scrolling(self, scrollable: bool) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea
, the KidArea
will become scrollable. Read more
fn vertical_scrolling(self, scrollable: bool) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea
, the KidArea
will become scrollable. Read more
fn horizontal_scrolling(self, scrollable: bool) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). If a widget is scrollable and it has children widgets that fall outside of its KidArea
, the KidArea
will become scrollable. Read more
fn set<I, U>(self, idx: I, ui: &mut U) where I: Into<Index>, U: UiRefMut
Note: There should be no need to override this method. Read more
impl<'a> Colorable for Canvas<'a>
[src]
fn color(self, color: Color) -> Self
Set the color of the widget.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget from rgba values.
fn rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget from rgb values.
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget from hsla values.
fn hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget from hsl values.
impl<'a> Frameable for Canvas<'a>
[src]
fn frame(self, width: f64) -> Self
Set the width of the widget's frame.
fn frame_color(self, color: Color) -> Self
Set the color of the widget's frame.
fn frame_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget's frame with rgba values.
fn frame_rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget's frame with rgb values.
fn frame_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget's frame with hsla values.
fn frame_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's frame with hsl values.
impl<'a> Labelable<'a> for Canvas<'a>
[src]
fn label(self, text: &'a str) -> Self
Set the label for the widget.
fn label_color(self, color: Color) -> Self
Set the color of the widget's label.
fn label_font_size(self, size: FontSize) -> Self
Set the font size for the widget's label.
fn label_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
Set the color of the widget's label from rgba values.
fn label_rgb(self, r: f32, g: f32, b: f32) -> Self
Set the color of the widget's label from rgb values.
fn label_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
Set the color of the widget's label from hsla values.
fn label_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's label from hsl values.
fn small_font<C>(self, ui: &Ui<C>) -> Self
Set a "small" font size for the widget's label.
fn medium_font<C>(self, ui: &Ui<C>) -> Self
Set a "medium" font size for the widget's label.
fn large_font<C>(self, ui: &Ui<C>) -> Self
Set a "large" font size for the widget's label.