Struct conrod::widget::grid::Grid
[−]
[src]
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 Widget
s.
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.
Methods
impl<X, Y, I> Grid<X, Y, I>
[src]
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>>,
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.
fn x_offset(self, x: X) -> Self
Specify an offset for all vertical lines placed along the X axis.
fn y_offset(self, y: Y) -> Self
Specify an offset for all horizontal lines placed along the Y axis.
Trait Implementations
impl<X: Copy, Y: Copy, I: Copy> Copy for Grid<X, Y, I>
[src]
impl<X: Clone, Y: Clone, I: Clone> Clone for Grid<X, Y, I>
[src]
fn clone(&self) -> Grid<X, Y, I>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more
impl<X: Debug, Y: Debug, I: Debug> Debug for Grid<X, Y, I>
[src]
impl<X, Y, I> Widget for Grid<X, Y, I> where
X: Into<Scalar>,
Y: Into<Scalar>,
I: Iterator<Item = Axis<X, Y>>,
[src]
X: Into<Scalar>,
Y: Into<Scalar>,
I: Iterator<Item = Axis<X, Y>>,
type State = State
State to be stored within the Ui
s widget cache. Read more
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. Read more
type Event = ()
The type of event yielded by the widget, returned via the Widget::set
function. Read more
fn init_state(&self, id_gen: Generator) -> Self::State
Return the initial State of the Widget. Read more
fn style(&self) -> Self::Style
Return the styling of the widget. Read more
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. Read more
fn default_y_position(&self, ui: &Ui) -> Position
The default Position for the widget along the y axis. Read more
fn default_x_dimension(&self, ui: &Ui) -> Dimension
The default width for the Widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
The default height of the widget. Read more
fn drag_area(
&self,
_dim: Dimensions,
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
&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. Read more
fn kid_area(&self, args: KidAreaArgs<Self>) -> KidArea
The area on which child widgets will be placed when using the Place
Position
methods.
fn parent(self, parent_id: Id) -> 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 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(self, id: Id) -> 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 crop_kids(self) -> Self
Indicates that all widgets who are children of this widget should be cropped to the kid_area
of this widget. Read more
fn scroll_kids(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
Set whether or not the widget's KidArea
is scrollable (the default is false). Read more
fn and<F>(self, build: F) -> Self where
F: FnOnce(Self) -> Self,
F: FnOnce(Self) -> Self,
A builder method that "lifts" the Widget through the given build
function. Read more
fn and_mut<F>(self, mutate: F) -> Self where
F: FnOnce(&mut Self),
F: FnOnce(&mut Self),
A builder method that mutates the Widget with the given mutate
function. Read more
fn and_if<F>(self, cond: bool, build: F) -> Self where
F: FnOnce(Self) -> Self,
F: FnOnce(Self) -> Self,
A method that conditionally builds the Widget with the given build
function. Read more
fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
F: FnOnce(Self, T) -> Self,
F: FnOnce(Self, T) -> Self,
A method that optionally builds the the Widget with the given build
function. Read more
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. Read more
impl<X, Y, I> Colorable for Grid<X, Y, I>
[src]
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.