Struct conrod_core::widget::canvas::Canvas

pub struct Canvas<'a> {
    pub common: CommonBuilder,
    pub style: Style,
    pub maybe_title_bar_label: Option<&'a str>,
    pub maybe_splits: Option<FlowOfSplits<'a>>,
}

Canvas is designed to be a "container"-like "parent" widget that simplifies placement of "children" widgets.

Widgets can be placed on a Canvas in a variety of ways using methods from the Positionable trait.

Canvas provides methods for padding the kid widget area which can make using the Place-related Positionable methods a little easier.

A Canvas can also be divided into a sequence of smaller Canvasses using the .flow_* methods. This creates a kind of Canvas tree, where each "split" can be sized using the .length or .length_weight methods.

See the canvas.rs example for a demonstration of the Canvas type.

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.

maybe_splits: Option<FlowOfSplits<'a>>

A list of child Canvasses as splits of this Canvas flowing in the given direction.

Methods

impl<'a> Canvas<'a>

pub fn new() -> Self

Construct a new Canvas builder.

pub fn title_bar(self, title_bar: &'a str) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn pad_left(self, pad_left: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn pad_right(self, pad_right: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn pad_bottom(self, pad_bottom: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn pad_top(self, pad_top: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn with_style(self, with_style: Style) -> Self

Build the type's self.$($assignee).+ with the given $Type.

pub fn length(self, length: Scalar) -> Self

Set the length of the Split as an absolute scalar.

pub fn length_weight(self, weight: Weight) -> Self

Set the length of the Split as a weight.

The default length weight for each widget is 1.0.

pub fn flow_right(self, splits: ListOfSplits<'a>) -> Self

Set the child Canvasses flowing to the right.

pub fn flow_left(self, splits: ListOfSplits<'a>) -> Self

Set the child Canvasses flowing to the left.

pub fn flow_up(self, splits: ListOfSplits<'a>) -> Self

Set the child Canvasses flowing upwards.

pub fn flow_down(self, splits: ListOfSplits<'a>) -> Self

Set the child Canvasses flowing downwards.

pub fn pad(self, pad: Scalar) -> Self

Set the padding for all edges of the area where child widgets will be placed.

pub fn padding(self, pad: Padding) -> Self

Set the padding of the area where child widgets will be placed.

pub fn title_bar_color(self, color: Color) -> Self

Set the color of the Canvas' TitleBar if it is visible.

Trait Implementations

impl<'a> Borderable for Canvas<'a>

fn border(self, border: Scalar) -> Self

Build the type's self.$($assignee).+ with the given $Type.

fn border_color(self, border_color: Color) -> Self

Build the type's self.$($assignee).+ with the given $Type.

fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self

Set the color of the widget's border with rgba values.

fn border_rgb(self, r: f32, g: f32, b: f32) -> Self

Set the color of the widget's border with rgb values.

fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self

Set the color of the widget's border with hsla values.

fn border_hsl(self, h: f32, s: f32, l: f32) -> Self

Set the color of the widget's border with hsl values.

impl<'a> Colorable for Canvas<'a>

fn color(self, color: Color) -> Self

Build the type's self.$($assignee).+ with the given $Type.

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> Labelable<'a> for Canvas<'a>

fn label(self, text: &'a str) -> Self

Set the label for the widget.

fn label_color(self, label_color: Color) -> Self

Build the type's self.$($assignee).+ with the given $Type.

fn label_font_size(self, label_font_size: FontSize) -> Self

Build the type's self.$($assignee).+ with the given $Type.

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(self, ui: &Ui) -> Self

Set a "small" font size for the widget's label.

fn medium_font(self, ui: &Ui) -> Self

Set a "medium" font size for the widget's label.

fn large_font(self, ui: &Ui) -> Self

Set a "large" font size for the widget's label.

impl<'a> Common for Canvas<'a>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

fn common_mut(&mut self) -> &mut CommonBuilder

Mutably borrows the CommonBuilder field.

impl<'a> Widget for Canvas<'a>

type State = State

State to be stored within the Uis widget cache.

type Style = Style

Every widget is required to have its own associated Style type. This type is intended to contain high-level styling information for the widget that can be optionally specified by a user of the widget.

type Event = ()

The type of event yielded by the widget, returned via the Widget::set function.

fn init_state(&self, id_gen: Generator) -> Self::State

Return the initial State of the Widget.

fn style(&self) -> Self::Style

Return the styling of the widget.

fn default_x_position(&self, _ui: &Ui) -> Position

The default Position for the widget along the x axis.

fn default_y_position(&self, _ui: &Ui) -> Position

The default Position for the widget along the y axis.

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(&self, args: KidAreaArgs<Self>) -> KidArea

The area of the widget below the title bar, upon which child widgets will be placed.

fn update(self, args: UpdateArgs<Self>)

Update the state of the Canvas.

fn default_x_dimension(&self, ui: &Ui) -> Dimension

The default width for the Widget.

fn default_y_dimension(&self, ui: &Ui) -> Dimension

The default height of the widget.

fn is_over(&self) -> IsOverFn

Returns either of the following:

fn parent(self, parent_id: Id) -> Self

Set the parent widget for this Widget by passing the WidgetId of the parent.

fn no_parent(self) -> Self

Specify that this widget has no parent widgets.

fn place_on_kid_area(self, b: bool) -> Self

Set whether or not the Widget should be placed on the kid_area.

fn graphics_for(self, id: Id) -> Self

Indicates that the Widget is used as a non-interactive graphical element for some other widget.

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.

fn crop_kids(self) -> Self

Indicates that all widgets who are children of this widget should be cropped to the kid_area of this widget.

fn scroll_kids(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_vertically(self) -> Self

Makes the widget's KidArea scrollable.

fn scroll_kids_horizontally(self) -> Self

Set whether or not the widget's KidArea is scrollable (the default is false).

fn and<F>(self, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A builder method that "lifts" the Widget through the given build function.

fn and_mut<F>(self, mutate: F) -> Self where
    F: FnOnce(&mut Self), 

A builder method that mutates the Widget with the given mutate function.

fn and_if<F>(self, cond: bool, build: F) -> Self where
    F: FnOnce(Self) -> Self, 

A method that conditionally builds the Widget with the given build function.

fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
    F: FnOnce(Self, T) -> Self, 

A method that optionally builds the Widget with the given build function.

fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event

Note: There should be no need to override this method.

impl<'a> Clone for Canvas<'a>

fn clone(&self) -> Canvas<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Copy for Canvas<'a>

impl<'a> Debug for Canvas<'a>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.