Struct conrod::widget::xy_pad::XYPad

pub struct XYPad<'a, X, Y> {
    pub enabled: bool,
    // some fields omitted
}

Used for displaying and controlling a 2D point on a cartesian plane within a given range.

Its reaction is triggered when the value is updated or if the mouse button is released while the cursor is above the rectangle.

Fields

enabled: bool

Indicates whether the XYPad will respond to user input.

Methods

impl<'a, X, Y> XYPad<'a, X, Y>

pub fn new(x_val: X, min_x: X, max_x: X, y_val: Y, min_y: Y, max_y: Y) -> Self

Build a new XYPad widget.

pub fn label_font_id(self, font_id: Id) -> Self

Specify the font used for displaying the label.

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

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

pub fn value_font_size(self, value_font_size: FontSize) -> Self

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

pub fn enabled(self, enabled: bool) -> Self

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

Trait Implementations

impl<'a, X, Y> Widget for XYPad<'a, X, Y> where     X: Float + ToString + Debug + Any,     Y: Float + ToString + Debug + Any,

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 = Option<(X, Y)>

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 XYPad's cached state.

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.

impl<'a, X, Y> Colorable for XYPad<'a, X, Y>

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, X, Y> Borderable for XYPad<'a, X, Y>

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, X, Y> Labelable<'a> for XYPad<'a, X, Y>

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

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

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.