Struct conrod::widget::scrollbar::Scrollbar
[−]
[src]
pub struct Scrollbar<A> { /* fields omitted */ }
A widget that allows for scrolling via dragging the mouse.
Methods
impl<A> Scrollbar<A>
[src]
fn auto_hide(self, auto_hide: bool) -> Self
[src]
By default, this is set to false
.
When false, the Scrollbar
will always be visible.
When true, the Scrollbar
will only be visible when:
- The target scrollable widget is actually scrollable and:
- The target scrollable widget is being scrolled.
- The scrollbar is capturing the mouse.
fn thickness(self, thickness: Scalar) -> Self
[src]
Build the widget with the given thickness
.
This value sets the width of vertical scrollbars, or the height of horizontal scrollbars.
By default, this is 10.0
.
impl Scrollbar<X>
[src]
fn x_axis(widget: Id) -> Self
[src]
Begin building a new scrollbar widget that scrolls along the X axis along the range of the scrollable widget at the given Id.
impl Scrollbar<Y>
[src]
fn y_axis(widget: Id) -> Self
[src]
Begin building a new scrollbar widget that scrolls along the Y axis along the range of the scrollable widget at the given Id.
Trait Implementations
impl<A> Widget for Scrollbar<A> where
A: Axis,
[src]
A: Axis,
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
[src]
Return the initial State of the Widget. Read more
fn style(&self) -> Self::Style
[src]
Return the styling of the widget. 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 update(self, args: UpdateArgs<Self>) -> Self::Event
[src]
Update our Widget's unique Widget::State via the State wrapper type (the state
field within the UpdateArgs). Read more
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 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> Colorable for Scrollbar<A>
[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.