[−][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.
Implementations
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
pub fn activation_via_press(&self) -> bool
[src]
pub fn handle(
&mut self,
_: &mut Manager<'_>,
event: Event
) -> Response<Self::Msg>
[src]
&mut self,
_: &mut Manager<'_>,
event: Event
) -> Response<Self::Msg>
impl<D: Directional> Layout for ScrollBar<D>
[src]
pub fn size_rules(
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
[src]
&mut self,
size_handle: &mut dyn SizeHandle,
axis: AxisInfo
) -> SizeRules
pub fn set_rect(&mut self, rect: Rect, align: AlignHints)
[src]
pub fn find_id(&self, coord: Coord) -> Option<WidgetId>
[src]
pub fn draw(
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
[src]
&self,
draw_handle: &mut dyn DrawHandle,
mgr: &ManagerState,
disabled: bool
)
pub fn translation(&self, _child_index: usize) -> Coord
[src]
pub fn spatial_range(&self) -> (usize, usize)
[src]
impl<D: Directional> SendEvent for ScrollBar<D>
[src]
pub fn send(
&mut self,
mgr: &mut Manager<'_>,
id: WidgetId,
event: Event
) -> Response<Self::Msg>
[src]
&mut self,
mgr: &mut Manager<'_>,
id: WidgetId,
event: Event
) -> Response<Self::Msg>
impl<D: Directional> Widget for ScrollBar<D>
[src]
impl<D: Directional> WidgetChildren for ScrollBar<D>
[src]
pub fn first_id(&self) -> WidgetId
[src]
pub fn len(&self) -> usize
[src]
pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>
[src]
pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>
[src]
pub fn record_first_id(&mut self, _id: WidgetId)
[src]
pub fn is_ancestor_of(&self, id: WidgetId) -> bool
[src]
pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>
[src]
pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>
[src]
pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
Self: Sized,
[src]
Self: Sized,
pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
Self: Sized,
[src]
Self: Sized,
impl<D: Directional> WidgetConfig for ScrollBar<D>
[src]
pub fn key_nav(&self) -> bool
[src]
pub fn cursor_icon(&self) -> CursorIcon
[src]
pub fn configure(&mut self, _: &mut Manager<'_>)
[src]
pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)
[src]
impl<D: Directional> WidgetCore for ScrollBar<D>
[src]
pub fn as_any(&self) -> &dyn Any
[src]
pub fn as_any_mut(&mut self) -> &mut dyn Any
[src]
pub fn core_data(&self) -> &CoreData
[src]
pub fn core_data_mut(&mut self) -> &mut CoreData
[src]
pub fn widget_name(&self) -> &'static str
[src]
pub fn as_widget(&self) -> &dyn WidgetConfig
[src]
pub fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig
[src]
pub fn id(&self) -> WidgetId
[src]
pub fn is_disabled(&self) -> bool
[src]
pub fn set_disabled(&mut self, disabled: bool) -> TkAction
[src]
pub fn with_disabled(self, disabled: bool) -> Self where
Self: Sized,
[src]
Self: Sized,
pub fn rect(&self) -> Rect
[src]
pub 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<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
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.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[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.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,