Struct nannou::ui::prelude::widget::bordered_rectangle::BorderedRectangle [−][src]
pub struct BorderedRectangle { pub common: CommonBuilder, pub style: Style, }
A filled rectangle widget that may or may not have some border.
NOTE: BorderedRectangle is currently implemented as two filled rectangles:
- A
Rectangle
for the border. - A
Rectangle
for the non-border area.
This is flawed in that, if a user specifies an alpha lower than 1.0, the front Rectangle
will
blend with the border Rectangle
, which is likely unexpected behaviour. This should be changed
so that the border is drawn using a outlined Rectangle
.
Fields
common: CommonBuilder
Data necessary and common for all widget builder types.
style: Style
Unique styling for the BorderedRectangle.
Methods
impl BorderedRectangle
[src]
impl BorderedRectangle
pub fn new(dim: [f64; 2]) -> BorderedRectangle
[src]
pub fn new(dim: [f64; 2]) -> BorderedRectangle
Build a new BorderedRectangle.
pub fn with_style(self, with_style: Style) -> BorderedRectangle
[src]
pub fn with_style(self, with_style: Style) -> BorderedRectangle
Build the type's self.$($assignee).+ with the given $Type.
Trait Implementations
impl Widget for BorderedRectangle
[src]
impl Widget for BorderedRectangle
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) -> <BorderedRectangle as Widget>::State
[src]
fn init_state(&self, id_gen: Generator) -> <BorderedRectangle as Widget>::State
Return the initial State of the Widget. Read more
fn style(&self) -> <BorderedRectangle as Widget>::Style
[src]
fn style(&self) -> <BorderedRectangle as Widget>::Style
Return the styling of the widget. Read more
fn update(
self,
args: UpdateArgs<BorderedRectangle>
) -> <BorderedRectangle as Widget>::Event
[src]
fn update(
self,
args: UpdateArgs<BorderedRectangle>
) -> <BorderedRectangle as Widget>::Event
Update the state of the Rectangle.
fn default_x_position(&self, ui: &Ui) -> Position
[src]
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
[src]
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
[src]
fn default_x_dimension(&self, ui: &Ui) -> Dimension
The default width for the Widget. Read more
fn default_y_dimension(&self, ui: &Ui) -> Dimension
[src]
fn default_y_dimension(&self, ui: &Ui) -> Dimension
The default height of the widget. Read more
fn drag_area(
&self,
_dim: [f64; 2],
_style: &Self::Style,
_theme: &Theme
) -> Option<Rect>
[src]
fn drag_area(
&self,
_dim: [f64; 2],
_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]
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) -> fn(&Container, [f64; 2], &Theme) -> IsOver
[src]
fn is_over(&self) -> fn(&Container, [f64; 2], &Theme) -> IsOver
Returns either of the following: Read more
fn parent(self, parent_id: NodeIndex<u32>) -> Self
[src]
fn parent(self, parent_id: NodeIndex<u32>) -> Self
Set the parent widget for this Widget by passing the WidgetId of the parent. Read more
fn no_parent(self) -> Self
[src]
fn no_parent(self) -> Self
Specify that this widget has no parent widgets.
fn place_on_kid_area(self, b: bool) -> Self
[src]
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: NodeIndex<u32>) -> Self
[src]
fn graphics_for(self, id: NodeIndex<u32>) -> 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
[src]
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
[src]
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
[src]
fn scroll_kids(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_vertically(self) -> Self
[src]
fn scroll_kids_vertically(self) -> Self
Makes the widget's KidArea
scrollable. Read more
fn scroll_kids_horizontally(self) -> Self
[src]
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,
[src]
fn and<F>(self, build: F) -> Self where
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]
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. Read more
fn and_if<F>(self, cond: bool, build: F) -> Self where
F: FnOnce(Self) -> Self,
[src]
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. Read more
fn and_then<T, F>(self, maybe: Option<T>, build: F) -> Self where
F: FnOnce(Self, T) -> Self,
[src]
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. Read more
fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event
[src]
fn set(self, id: NodeIndex<u32>, ui_cell: &'a mut UiCell<'b>) -> Self::Event
Note: There should be no need to override this method. Read more
impl Common for BorderedRectangle
[src]
impl Common for BorderedRectangle
fn common(&self) -> &CommonBuilder
[src]
fn common(&self) -> &CommonBuilder
Borrows the CommonBuilder
field.
fn common_mut(&mut self) -> &mut CommonBuilder
[src]
fn common_mut(&mut self) -> &mut CommonBuilder
Mutably borrows the CommonBuilder
field.
impl Clone for BorderedRectangle
[src]
impl Clone for BorderedRectangle
fn clone(&self) -> BorderedRectangle
[src]
fn clone(&self) -> BorderedRectangle
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Colorable for BorderedRectangle
[src]
impl Colorable for BorderedRectangle
fn color(self, color: Color) -> BorderedRectangle
[src]
fn color(self, color: Color) -> BorderedRectangle
Build the type's self.$($assignee).+ with the given $Type.
fn rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
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
[src]
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
[src]
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
[src]
fn hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget from hsl values.
impl Debug for BorderedRectangle
[src]
impl Debug for BorderedRectangle
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl Copy for BorderedRectangle
[src]
impl Copy for BorderedRectangle
impl Borderable for BorderedRectangle
[src]
impl Borderable for BorderedRectangle
fn border(self, border: f64) -> BorderedRectangle
[src]
fn border(self, border: f64) -> BorderedRectangle
Build the type's self.$($assignee).+ with the given $Type.
fn border_color(self, border_color: Color) -> BorderedRectangle
[src]
fn border_color(self, border_color: Color) -> BorderedRectangle
Build the type's self.$($assignee).+ with the given $Type.
fn border_rgba(self, r: f32, g: f32, b: f32, a: f32) -> Self
[src]
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
[src]
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
[src]
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
[src]
fn border_hsl(self, h: f32, s: f32, l: f32) -> Self
Set the color of the widget's border with hsl values.
Auto Trait Implementations
impl Send for BorderedRectangle
impl Send for BorderedRectangle
impl Sync for BorderedRectangle
impl Sync for BorderedRectangle