Struct conrod_core::widget::grid::Grid

pub struct Grid<X, Y, I> {
    pub common: CommonBuilder,
    pub style: Style,
    pub min_x: X,
    pub max_x: X,
    pub min_y: Y,
    pub max_y: Y,
    pub x_offset: Option<X>,
    pub y_offset: Option<Y>,
    pub lines: I,
}

A widget for displaying a grid of lines across two axes.

Fields

common: CommonBuilder

Builder parameters that are common to all Widgets.

style: Style

Unique styling parameters for the Grid widget.

min_x: X

The minimum visible bound along the x axis.

max_x: X

The maximum visible bound along the x axis.

min_y: Y

The minimum visible bound along the y axis.

max_y: Y

The maximum visible bound along the y axis.

x_offset: Option<X>

An offset for all vertical lines distributed across the x axis.

y_offset: Option<Y>

An offset for all horizontal lines distributed across the y axis.

lines: I

An iterator yielding each sequence of lines to be distributed across the grid.

Implementations

impl<X, Y, I> Grid<X, Y, I>

pub fn new(
    min_x: X,
    max_x: X,
    min_y: Y,
    max_y: Y,
    lines: I
) -> Grid<X, Y, I::IntoIter> where
    X: Into<Scalar>,
    Y: Into<Scalar>,
    I: IntoIterator<Item = Axis<X, Y>>, 

Begin building a new PlotPath widget instance.

The first four arguments represent the visible range along both axes.

The final argument is an iterator yielding Lines across either Axis. The given lines will be drawn in the order that they're given.

pub fn x_offset(self, x: X) -> Self

Specify an offset for all vertical lines placed along the X axis.

pub fn y_offset(self, y: Y) -> Self

Specify an offset for all horizontal lines placed along the Y axis.

Trait Implementations

impl<X: Clone, Y: Clone, I: Clone> Clone for Grid<X, Y, I>

fn clone(&self) -> Grid<X, Y, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X, Y, I> Colorable for Grid<X, Y, I>

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<X, Y, I> Common for Grid<X, Y, I>

fn common(&self) -> &CommonBuilder

Borrows the CommonBuilder field.

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

Mutably borrows the CommonBuilder field.

impl<X: Copy, Y: Copy, I: Copy> Copy for Grid<X, Y, I>

impl<X: Debug, Y: Debug, I: Debug> Debug for Grid<X, Y, I>

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

Formats the value using the given formatter.

impl<X, Y, I> Widget for Grid<X, Y, I> where
    X: Into<Scalar>,
    Y: Into<Scalar>,
    I: Iterator<Item = Axis<X, Y>>, 

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 update(self, args: UpdateArgs<'_, '_, '_, '_, Self>) -> Self::Event

Update the state of the PlotPath.

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 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 drag_area(
    &self,
    _dim: Dimensions,
    _style: &Self::Style,
    _theme: &Theme
) -> Option<Rect>

If the widget is draggable, implement this method and return the position and dimensions of the draggable space. The position should be relative to the center of the widget.

fn kid_area(&self, args: KidAreaArgs<'_, Self>) -> KidArea

The area on which child widgets will be placed when using the Place Position methods.

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.