Struct conrod::widget::button::Button
[−]
[src]
pub struct Button<'a, S> { pub show: S, pub style: Style, // some fields omitted }
A pressable button widget whose reaction is triggered upon release.
Fields
show: S
Whether the Button
is a Flat
color or an Image
.
style: Style
Unique styling parameters for the Button.
Methods
impl<'a> Button<'a, Image>
[src]
pub fn image(image_id: Id) -> Self
[src]
Begin building a button displaying the given Image
on top.
pub fn source_rectangle(self, rect: Rect) -> Self
[src]
The rectangular area of the image that we wish to display.
If this method is not called, the entire image will be used.
pub fn image_color(self, color: Color) -> Self
[src]
Map the Image
's luminance to the given color.
pub fn image_color_with_feedback(self, color: Color) -> Self
[src]
Map the Image
's luminance to the given color.
The color will change slightly when the button is highlighted or clicked to give the user some visual feedback.
pub fn hover_image(self, id: Id) -> Self
[src]
The image displayed while the mouse hovers over the Button
.
pub fn press_image(self, id: Id) -> Self
[src]
The image displayed while the Button
is pressed.
impl<'a> Button<'a, Flat>
[src]
pub fn new() -> Self
[src]
Begin building a flat-colored Button
widget.
pub fn with_style(self, s: Style) -> Self
[src]
Override the default button style
pub fn hover_color(self, color: Color) -> Self
[src]
Specify a color to use when the mouse hovers over the button.
By default, this is color.highlighted()
where color
is the button's regular color.
pub fn press_color(self, color: Color) -> Self
[src]
Specify a color to use when the mouse presses the button.
By default, this is color.clicked()
where color
is the button's regular color.
impl<'a, S> Button<'a, S>
[src]
pub fn label_font_id(self, font_id: Id) -> Self
[src]
Specify the font used for displaying the label.
pub fn left_justify_label(self) -> Self
[src]
Align the label to the left of the Button
's surface.
pub fn center_justify_label(self) -> Self
[src]
Align the label to the mid-left of the Button
's surface.
This is the default label alignment.
pub fn right_justify_label(self) -> Self
[src]
Align the label to the mid-left of the Button
's surface.
pub fn label_x(self, x: Relative) -> Self
[src]
Specify the label's position relatively to Button
along the x axis.
pub fn label_y(self, y: Relative) -> Self
[src]
Specify the label's position relatively to Button
along the y axis.
pub fn enabled(self, enabled: bool) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl<'a, S: Clone> Clone for Button<'a, S>
[src]
fn clone(&self) -> Button<'a, S>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'a> Widget for Button<'a, Flat>
[src]
type State = FlatIds
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 = TimesClicked
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
[src]
Return the initial State of the Widget. Read more
fn style(&self) -> Style
[src]
Return the styling of the widget. Read more
fn update(self, args: UpdateArgs<Self>) -> Self::Event
[src]
Update the state of the Button.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the x axis. Read more
fn default_y_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the y axis. Read more
fn default_x_dimension(&self, ui: &Ui) -> Dimension
[src]
The default width for the Widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
The default height of the widget. Read more
fn drag_area(
&self,
_dim: Dimensions,
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
&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
[src]
The area on which child widgets will be placed when using the Place
Position
methods.
fn is_over(&self) -> IsOverFn
[src]
Returns either of the following: Read more
fn parent(self, parent_id: Id) -> Self
[src]
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
[src]
Specify that this widget has no parent widgets.
fn place_on_kid_area(self, b: bool) -> Self
[src]
Set whether or not the Widget should be placed on the kid_area. Read more
fn graphics_for(self, id: Id) -> Self
[src]
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
[src]
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
[src]
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
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
[src]
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,
[src]
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),
[src]
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,
[src]
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,
[src]
F: FnOnce(Self, T) -> Self,
A method that optionally builds the Widget with the given build
function. Read more
fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
Note: There should be no need to override this method. Read more
impl<'a> Widget for Button<'a, Image>
[src]
type State = ImageIds
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 = TimesClicked
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
[src]
Return the initial State of the Widget. Read more
fn style(&self) -> Style
[src]
Return the styling of the widget. Read more
fn update(self, args: UpdateArgs<Self>) -> Self::Event
[src]
Update the state of the Button.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the x axis. Read more
fn default_y_position(&self, ui: &Ui) -> Position
[src]
The default Position for the widget along the y axis. Read more
fn default_x_dimension(&self, ui: &Ui) -> Dimension
[src]
The default width for the Widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
The default height of the widget. Read more
fn drag_area(
&self,
_dim: Dimensions,
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
&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
[src]
The area on which child widgets will be placed when using the Place
Position
methods.
fn is_over(&self) -> IsOverFn
[src]
Returns either of the following: Read more
fn parent(self, parent_id: Id) -> Self
[src]
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
[src]
Specify that this widget has no parent widgets.
fn place_on_kid_area(self, b: bool) -> Self
[src]
Set whether or not the Widget should be placed on the kid_area. Read more
fn graphics_for(self, id: Id) -> Self
[src]
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
[src]
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
[src]
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
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
[src]
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
[src]
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,
[src]
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),
[src]
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,
[src]
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,
[src]
F: FnOnce(Self, T) -> Self,
A method that optionally builds the Widget with the given build
function. Read more
fn set<'a, 'b>(self, id: Id, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
Note: There should be no need to override this method. Read more
impl<'a, S> Colorable for Button<'a, S>
[src]
fn color(self, color: Color) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
Set the color of the widget from rgba values.
fn rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
Set the color of the widget from rgb values.
fn hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
Set the color of the widget from hsla values.
fn hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
Set the color of the widget from hsl values.
impl<'a, S> Borderable for Button<'a, S>
[src]
fn border(self, border: Scalar) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn border_color(self, border_color: Color) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
Set the color of the widget's border with rgba values.
fn border_rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
Set the color of the widget's border with rgb values.
fn border_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
Set the color of the widget's border with hsla values.
fn border_hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
Set the color of the widget's border with hsl values.
impl<'a, S> Labelable<'a> for Button<'a, S>
[src]
fn label(self, label: &'a str) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn label_color(self, label_color: Color) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn label_font_size(self, label_font_size: FontSize) -> Self
[src]
Build the type's self.$($assignee).+ with the given $Type.
fn label_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
Set the color of the widget's label from rgba values.
fn label_rgb(self, r: f32, g: f32, b: f32) -> Self
[src]
Set the color of the widget's label from rgb values.
fn label_hsla(self, h: f32, s: f32, l: f32, a: f32) -> Self
[src]
Set the color of the widget's label from hsla values.
fn label_hsl(self, h: f32, s: f32, l: f32) -> Self
[src]
Set the color of the widget's label from hsl values.
fn small_font(self, ui: &Ui) -> Self
[src]
Set a "small" font size for the widget's label.
fn medium_font(self, ui: &Ui) -> Self
[src]
Set a "medium" font size for the widget's label.
fn large_font(self, ui: &Ui) -> Self
[src]
Set a "large" font size for the widget's label.