Struct kas::widgets::ScrollBars

pub struct ScrollBars<W>
where
    W: Scrollable + Widget,
{ /* private fields */ }

Scroll bar controls

This is a wrapper adding scroll bar controls around a child. Note that this widget does not enable scrolling; see ScrollBarRegion for that.

Scroll bar positioning does not respect the inner widget’s margins, since the result looks poor when content is scrolled. Instead the content should force internal margins by wrapping contents with a (zero-sized) frame. ScrollRegion already does this.

Implementations

impl<W> ScrollBars<W>

where W: Scrollable + Widget,

pub fn new(inner: W) -> ScrollBars<W>

Construct

By default scroll bars are automatically enabled based on requirements. Use the HasScrollBars trait to adjust this behaviour.

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 for ScrollBars<W>

where W: Clone + Scrollable + Widget,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W> Debug for ScrollBars<W>

where W: Debug + Scrollable + Widget,

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

Formats the value using the given formatter.

impl<W> Default for ScrollBars<W>

where W: Scrollable + Widget + Default,

fn default() -> ScrollBars<W>

Returns the “default value” for a type.

impl<W> Deref for ScrollBars<W>

where W: Scrollable + Widget,

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &<ScrollBars<W> as Deref>::Target

Dereferences the value.

impl<W> DerefMut for ScrollBars<W>

where W: Scrollable + Widget,

fn deref_mut(&mut self) -> &mut <ScrollBars<W> as Deref>::Target

Mutably dereferences the value.

impl<W> Events for ScrollBars<W>

where W: Scrollable + Widget,

fn handle_messages( &mut self, cx: &mut EventCx<'_>, _: &<ScrollBars<W> as Widget>::Data )

Handler for messages from children/descendants

fn handle_scroll( &mut self, cx: &mut EventCx<'_>, _: &<ScrollBars<W> as Widget>::Data, _: Scroll )

Handler for scrolling

fn steal_event( &mut self, _: &mut EventCx<'_>, _: &<ScrollBars<W> as Widget>::Data, _: &Id, _: &Event ) -> IsUsed

Potentially steal an event before it reaches a child

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &<ScrollBars<W> as Widget>::Data, _: Event ) -> IsUsed

Handle an Event

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

Make an identifier for a child

fn configure(&mut self, cx: &mut ConfigCx<'_>)

Configure self

fn configure_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Configure children

fn update(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update self using input data

fn update_recurse(&mut self, cx: &mut ConfigCx<'_>, data: &Self::Data)

Update children

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn handle_hover(&mut self, cx: &mut EventCx<'_>, state: bool) -> IsUsed

Mouse focus handler

impl<W> HasBool for ScrollBars<W>

where W: Scrollable + Widget + HasBool,

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> HasScrollBars for ScrollBars<W>

where W: Scrollable + Widget,

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) -> Self

where Self: Sized,

Set auto mode (inline)

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

where Self: Sized,

Set fixed bars (inline)

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

where Self: Sized,

Set invisible bars (inline)

impl<W> HasStr for ScrollBars<W>

where W: Scrollable + Widget + HasStr,

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<W> HasString for ScrollBars<W>

where W: Scrollable + Widget + HasString,

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> Layout for ScrollBars<ScrollRegion<W>>

where W: Widget,

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

Draw a widget and its children

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

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 num_children(&self) -> usize

Get the number of child widgets

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

Access a child as a dyn Layout

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

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

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

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

fn translation(&self) -> Offset

Get translation of children relative to this widget

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

Translate a coordinate to an Id

impl<W> Layout for ScrollBars<W>

where W: Scrollable + Widget,

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

Get size rules for the given axis

fn set_rect(&mut self, cx: &mut ConfigCx<'_>, rect: Rect)

Set size and position

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

Translate a coordinate to an Id

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

Draw a widget and its children

fn as_layout(&self) -> &dyn Layout

Get as a dyn Layout

fn id_ref(&self) -> &Id

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 num_children(&self) -> usize

Get the number of child widgets

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

Access a child as a dyn Layout

fn nav_next(&self, reverse: bool, from: Option<usize>) -> Option<usize>

Navigation in spatial order

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

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

fn translation(&self) -> Offset

Get translation of children relative to this widget

impl<W> Scrollable for ScrollBars<W>

where W: Scrollable + Widget,

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, cx: &mut EventCx<'_>, offset: Offset) -> Offset

Set the scroll offset

impl<W> Widget for ScrollBars<W>

where W: Scrollable + Widget,

type Data = <W as Widget>::Data

Input data type

fn as_node<'a>( &'a mut self, data: &'a <ScrollBars<W> as Widget>::Data ) -> Node<'a>

Erase type

fn for_child_node( &mut self, data: &<ScrollBars<W> as Widget>::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_> )

Call closure on child with given index, if index < self.num_children().