Struct conrod::WidgetMatrix

pub struct WidgetMatrix<F> {
    // some fields omitted
}

Draw a matrix of any rectangular widget type, where the matrix will provide a function with the widget number, it's rows and cols position, the width and height for the widget and the location at which the widget should be drawn.

Methods

impl<F> Matrix<F>

fn new(cols: usize, rows: usize) -> Matrix<F>

Create a widget matrix context.

fn each_widget(self, each_widget: F) -> Matrix<F>

The function that will be called for each and every element in the Matrix. The function should return the widget that will be displayed in the element associated with the given row and column number. Note that the returned Widget's position and dimensions will be overridden with the dimensions and position of the matrix element's rectangle.

fn cell_padding(self, w: Scalar, h: Scalar) -> Matrix<F>

A builder method for adding padding to the cell.

Trait Implementations

impl<F: Clone> Clone for Matrix<F>

fn clone(&self) -> Matrix<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Copy> Copy for Matrix<F>

impl<'a, F, W> Widget for Matrix<F> where W: Widget, F: FnMut(WidgetNum, ColNum, RowNum) -> W

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.

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.

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.

fn init_state(&self) -> State

Return the initial State of the Widget.

fn style(&self) -> Style

Return the styling of the widget.

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

Update the state of the Matrix.

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 parent<I: Into<Index>>(self, parent_idx: I) -> 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<I: Into<Index>>(self, idx: I) -> 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 the Widget with the given build function.

fn set<'a, 'b, I>(self, idx: I, ui_cell: &'a mut UiCell<'b>) where I: Into<Index>

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