[−][src]Struct kas::widget::ScrollBar
A scroll bar
Scroll bars allow user-input of a value between 0 and a defined maximum, and allow the size of the handle to be specified.
Methods
impl<D: Directional + Default> ScrollBar<D>
[src]
impl<D: Directional> ScrollBar<D>
[src]
pub fn new_with_direction(direction: D) -> Self
[src]
Construct a scroll bar with the given direction
Default values are assumed for all parameters.
pub fn with_limits(self, max_value: u32, handle_value: u32) -> Self
[src]
Set the initial page length
pub fn with_value(self, value: u32) -> Self
[src]
Set the initial value
pub fn set_limits(&mut self, max_value: u32, handle_value: u32) -> TkAction
[src]
Set the page limits
The max_value
parameter specifies the maximum possible value.
(The minimum is always 0.) For a scroll region, this should correspond
to the maximum possible offset.
The handle_value
parameter specifies the size of the handle relative to
the maximum value: the handle size relative to the length of the scroll
bar is handle_value / (max_value + handle_value)
. For a scroll region,
this should correspond to the size of the visible region.
The minimum value is 1.
The choice of units is not important (e.g. can be pixels or lines), so long as both parameters use the same units.
Returns TkAction::Redraw
if a redraw is required.
pub fn value(&self) -> u32
[src]
Get the current value
pub fn set_value(&mut self, value: u32) -> TkAction
[src]
Set the value
Trait Implementations
impl<D: Clone + Directional> Clone for ScrollBar<D>
[src]
impl<D: Debug + Directional> Debug for ScrollBar<D>
[src]
impl<D: Default + Directional> Default for ScrollBar<D>
[src]
impl<D: Directional> Handler for ScrollBar<D>
[src]
type Msg = u32
Type of message returned by this widget Read more
fn activation_via_press(&self) -> bool
[src]
fn handle(&mut self, _: &mut Manager, event: Event) -> Response<Self::Msg>
[src]
impl<D: Directional> Layout for ScrollBar<D>
[src]
fn size_rules(
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
[src]
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
fn set_rect(&mut self, rect: Rect, align: AlignHints)
[src]
fn find_id(&self, coord: Coord) -> Option<WidgetId>
[src]
fn draw(
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
[src]
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
fn translation(&self, _child_index: usize) -> Coord
[src]
fn spatial_range(&self) -> (usize, usize)
[src]
impl<D: Directional> SendEvent for ScrollBar<D>
[src]
impl<D: Directional> Widget for ScrollBar<D>
[src]
impl<D: Directional> WidgetChildren for ScrollBar<D>
[src]
fn len(&self) -> usize
[src]
fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>
[src]
fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>
[src]
fn is_ancestor_of(&self, id: WidgetId) -> bool
[src]
fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>
[src]
fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>
[src]
fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))
[src]
fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))
[src]
impl<D: Directional> WidgetConfig for ScrollBar<D>
[src]
fn key_nav(&self) -> bool
[src]
fn cursor_icon(&self) -> CursorIcon
[src]
fn configure(&mut self, _: &mut Manager)
[src]
fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)
[src]
impl<D: Directional> WidgetCore for ScrollBar<D>
[src]
fn as_any(&self) -> &dyn Any
[src]
fn as_any_mut(&mut self) -> &mut dyn Any
[src]
fn core_data(&self) -> &CoreData
[src]
fn core_data_mut(&mut self) -> &mut CoreData
[src]
fn widget_name(&self) -> &'static str
[src]
fn as_widget(&self) -> &dyn WidgetConfig
[src]
fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig
[src]
fn id(&self) -> WidgetId
[src]
fn is_disabled(&self) -> bool
[src]
fn set_disabled(&mut self, disabled: bool) -> TkAction
[src]
fn rect(&self) -> Rect
[src]
fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState
[src]
Auto Trait Implementations
impl<D> RefUnwindSafe for ScrollBar<D> where
D: RefUnwindSafe,
D: RefUnwindSafe,
impl<D> Send for ScrollBar<D> where
D: Send,
D: Send,
impl<D> Sync for ScrollBar<D> where
D: Sync,
D: Sync,
impl<D> Unpin for ScrollBar<D> where
D: Unpin,
D: Unpin,
impl<D> UnwindSafe for ScrollBar<D> where
D: UnwindSafe,
D: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,
[src]
Scheme: ApproxScheme,
type Err = NoError
The error type produced by a failed conversion.
fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>
[src]
impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
[src]
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,
type Err = <Dst as ApproxFrom<Src, Scheme>>::Err
The error type produced by a failed conversion.
fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, Dst> ConvAsUtil<Dst> for T
[src]
fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
[src]
Self: ApproxInto<Dst, DefaultApprox>,
fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
[src]
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
impl<T> ConvUtil for T
[src]
fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,
[src]
Self: ApproxInto<Dst, DefaultApprox>,
fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
[src]
Scheme: ApproxScheme,
Self: ApproxInto<Dst, Scheme>,
fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,
[src]
Self: Into<Dst>,
fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,
[src]
Self: TryInto<Dst>,
fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,
[src]
Self: ValueInto<Dst>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<Src> TryFrom<Src> for Src
[src]
type Err = NoError
The error type produced by a failed conversion.
fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,
[src]
Dst: TryFrom<Src>,
type Err = <Dst as TryFrom<Src>>::Err
The error type produced by a failed conversion.
fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<Src> ValueFrom<Src> for Src
[src]
type Err = NoError
The error type produced by a failed conversion.
fn value_from(src: Src) -> Result<Src, <Src as ValueFrom<Src>>::Err>
[src]
impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,
[src]
Dst: ValueFrom<Src>,