Struct kas::widget::ScrollBar

pub struct ScrollBar<D: Directional> { /* fields omitted */ }

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>

pub fn new() -> Self

Construct a scroll bar

Default values are assumed for all parameters.

impl<D: Directional> ScrollBar<D>

pub fn new_with_direction(direction: D) -> Self

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

Set the initial page length

See ScrollBar::set_limits.

pub fn with_value(self, value: u32) -> Self

Set the initial value

pub fn set_limits(&mut self, max_value: u32, handle_value: u32) -> TkAction

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

Get the current value

pub fn set_value(&mut self, value: u32) -> TkAction

Set the value

Trait Implementations

impl<D: Clone + Directional> Clone for ScrollBar<D>

pub fn clone(&self) -> ScrollBar<D>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<D: Debug + Directional> Debug for ScrollBar<D>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D: Default + Directional> Default for ScrollBar<D>

pub fn default() -> ScrollBar<D>

Returns the "default value" for a type.

impl<D: Directional> Handler for ScrollBar<D>

type Msg = u32

Type of message returned by this widget

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

pub fn handle(
    &mut self,
    _: &mut Manager<'_>,
    event: Event
) -> Response<Self::Msg>

Handle an event and return a user-defined message

impl<D: Directional> Layout for ScrollBar<D>

pub fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

pub fn find_id(&self, coord: Coord) -> Option<WidgetId>

Find a widget by coordinate

pub fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

pub fn translation(&self, _child_index: usize) -> Coord

Get translation of a child

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

impl<D: Directional> SendEvent for ScrollBar<D>

pub fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<D: Directional> Widget for ScrollBar<D>

impl<D: Directional> WidgetChildren for ScrollBar<D>

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

pub fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

Get a reference to a child widget by index, or None if the index is out of bounds.

pub fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

pub fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

impl<D: Directional> WidgetConfig for ScrollBar<D>

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

pub fn configure(&mut self, _: &mut Manager<'_>)

Configure widget

pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

impl<D: Directional> WidgetCore for ScrollBar<D>

pub fn as_any(&self) -> &dyn Any

Get self as type Any

pub fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

pub fn core_data_mut(&mut self) -> &mut CoreData

pub fn widget_name(&self) -> &'static str

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

pub fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

pub fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

pub fn with_disabled(self, disabled: bool) -> Self where
    Self: Sized, 

Set disabled state (chaining)

pub fn rect(&self) -> Rect

Get the widget's region, relative to its parent.

pub fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState