Struct kas_widgets::ScrollBarRegion

pub struct ScrollBarRegion<W: Widget>(_);

A scrollable region with bars

This is essentially a ScrollBars<ScrollRegion<W>>: ScrollRegion handles the actual scrolling and wheel/touch events, while ScrollBars adds scroll bar controls.

Use the HasScrollBars trait to adjust scroll bar behaviour.

Implementations

impl<W: Widget> ScrollBarRegion<W>

pub fn new(inner: W) -> Self

Construct a ScrollBarRegion<W>

pub fn inner(&self) -> &W

Access inner widget directly

pub fn inner_mut(&mut self) -> &mut W

Access inner widget directly

Methods from Deref<Target = ScrollBars<ScrollRegion<W>>>

pub fn inner(&self) -> &W

Access inner widget directly

pub fn inner_mut(&mut self) -> &mut W

Access inner widget directly

Trait Implementations

impl<W: Clone + Widget> Clone for ScrollBarRegion<W>

fn clone(&self) -> ScrollBarRegion<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug + Widget> Debug for ScrollBarRegion<W>

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

Formats the value using the given formatter.

impl<W: Default + Widget> Default for ScrollBarRegion<W>

fn default() -> ScrollBarRegion<W>

Returns the “default value” for a type.

impl<W: Widget> Deref for ScrollBarRegion<W>

type Target = ScrollBars<ScrollRegion<W>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<W: Widget> DerefMut for ScrollBarRegion<W>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<W> HasBool for ScrollBarRegion<W>where W: HasBool + Widget,

fn get_bool(&self) -> bool

Get the widget’s state

fn set_bool(&mut self, state: bool) -> Action

Set the widget’s state

impl<W: Widget> HasScrollBars for ScrollBarRegion<W>

fn get_mode(&self) -> ScrollBarMode

Get mode

fn set_mode(&mut self, mode: ScrollBarMode) -> Action

Set mode

fn get_visible_bars(&self) -> (bool, bool)

Get currently visible bars

fn set_visible_bars(&mut self, bars: (bool, bool)) -> Action

Set enabled bars without adjusting mode

fn with_auto_bars(self) -> Selfwhere Self: Sized,

Set auto mode (inline)

fn with_fixed_bars(self, horiz: bool, vert: bool) -> Selfwhere Self: Sized,

Set fixed bars (inline)

fn with_invisible_bars(self, horiz: bool, vert: bool) -> Selfwhere Self: Sized,

Set invisible bars (inline)

impl<W> HasStr for ScrollBarRegion<W>where W: HasStr + Widget,

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<W> HasString for ScrollBarRegion<W>where W: HasString + Widget,

fn set_str(&mut self, text: &str) -> Action

Set text from a &str

fn set_string(&mut self, text: String) -> Action

Set text from a string

impl<W: Widget> Layout for ScrollBarRegion<W>

fn size_rules(&mut self, size_mgr: SizeMgr<'_>, axis: AxisInfo) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

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

Translate a coordinate to a WidgetId

fn draw(&mut self, draw: DrawMgr<'_>)

Draw a widget and its children

impl<W: Widget> Scrollable for ScrollBarRegion<W>

fn scroll_axes(&self, size: Size) -> (bool, bool)

Given size size, returns whether (horiz, vert) scrolling is required

fn max_scroll_offset(&self) -> Offset

Get the maximum scroll offset

fn scroll_offset(&self) -> Offset

Get the current scroll offset

fn set_scroll_offset(&mut self, mgr: &mut EventMgr<'_>, offset: Offset) -> Offset

Set the scroll offset

impl<W> SetAccel for ScrollBarRegion<W>where W: SetAccel + Widget,

fn set_accel_string(&mut self, accel: AccelString) -> Action

Set accel string

fn set_accel<T>(&mut self, accel: T) -> Actionwhere T: Into<AccelString>, Self: Sized,

Set text

impl<W: Widget> Widget for ScrollBarRegion<W>

fn pre_configure(&mut self, mgr: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an Event sent to this widget

fn configure(&mut self, mgr: &mut ConfigMgr<'_>)

Configure widget

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn handle_unused(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to child index but left unhandled

fn handle_message(&mut self, mgr: &mut EventMgr<'_>)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, scroll: Scroll)

Handler for scrolling

fn nav_next( &mut self, mgr: &mut ConfigMgr<'_>, reverse: bool, from: Option<usize> ) -> Option<usize>

Navigation in spatial order

fn steal_event( &mut self, mgr: &mut EventMgr<'_>, id: &WidgetId, event: &Event ) -> Response

Potentially steal an event before it reaches a child

impl<W: Widget> WidgetChildren for ScrollBarRegion<W>

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn Widget>

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

fn get_child_mut(&mut self, index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

fn find_child_index(&self, id: &WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn make_child_id(&mut self, index: usize) -> WidgetId

Make an identifier for a child

impl<W: Widget> WidgetCore for ScrollBarRegion<W>

fn id_ref(&self) -> &WidgetId

Get the widget’s identifier

fn rect(&self) -> Rect

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

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn Widget

Erase type

fn as_widget_mut(&mut self) -> &mut dyn Widget

Erase type