Struct ScrollBars 

pub struct ScrollBars<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: Scrollable + Widget> ScrollBars<W>

pub fn new(inner: W) -> Self

Construct

By default scroll bars are automatically enabled based on requirements.

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

where Self: Sized,

Set fixed visibility of scroll bars (inline)

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

where Self: Sized,

Set fixed, invisible bars (inline)

In this mode scroll bars are either enabled but invisible until mouse over or disabled completely.

pub fn scroll_bar_mode(&self) -> ScrollBarMode

Get current mode of scroll bars

pub fn set_scroll_bar_mode(&mut self, cx: &mut EventState, mode: ScrollBarMode)

Set scroll bar mode

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 + Scrollable + Widget> Clone for ScrollBars<W>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<W: Debug + Scrollable + Widget> Debug for ScrollBars<W>

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

Formats the value using the given formatter.

impl<W: Default + Scrollable + Widget> Default for ScrollBars<W>

fn default() -> ScrollBars<W>

Returns the “default value” for a type.

impl<W: Scrollable + Widget> Events for ScrollBars<W>

fn handle_messages(&mut self, cx: &mut EventCx<'_>, _: &Self::Data)

Handler for messages from children/descendants

fn handle_scroll(&mut self, cx: &mut EventCx<'_>, _: &Self::Data, _: Scroll)

Handler for scrolling

fn handle_event( &mut self, _: &mut EventCx<'_>, _: &Self::Data, _: Event<'_>, ) -> IsUsed

Handle an Event

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

fn mouse_over_icon(&self) -> Option<CursorIcon>

The mouse cursor icon to use on mouse over

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 handle_mouse_over(&mut self, cx: &mut EventCx<'_>, state: bool)

Mouse focus handler

impl<W: Scrollable + Widget> Layout for ScrollBars<W>

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, hints: AlignHints)

Set size and position

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

Draw a widget and its children

fn rect(&self) -> Rect

Get the widget’s region

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

Probe a coordinate for a widget’s Id

impl<W: Scrollable + Widget> Scrollable for ScrollBars<W>

fn content_size(&self) -> Size

Get the content size (the inner size of the scrolled pane)

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: Scrollable + Widget> Tile for ScrollBars<W>

fn probe(&self, coord: Coord) -> Id

Probe a coordinate for a widget’s Id

fn as_tile(&self) -> &dyn Tile

Get as a dyn Tile

fn id_ref(&self) -> &Id

Get a reference to the widget’s identifier

fn identify(&self) -> IdentifyWidget<'_>

Return a Display-able widget identifier

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

Access a child as a dyn Tile, if available

fn role(&self, _: &mut dyn RoleCx) -> Role<'_>

Describe the widget’s role

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

Navigation in spatial order

fn id(&self) -> Id

Get the widget’s identifier

fn navigable(&self) -> bool

Whether this widget supports navigation focus

fn tooltip(&self) -> Option<&str>

Tooltip

fn role_child_properties(&self, cx: &mut dyn RoleCx, index: usize)

Specify additional role properties for child index

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

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

fn translation(&self, index: usize) -> Offset

Get translation of child index relative to this widget

impl<W: Scrollable + Widget> Widget for ScrollBars<W>

type Data = <W as Widget>::Data

Input data type

fn as_node<'__a>(&'__a mut self, data: &'__a Self::Data) -> Node<'__a>

Erase type

fn child_node<'__n>( &'__n mut self, data: &'__n Self::Data, index: usize, ) -> Option<Node<'__n>>

Access a child as a Node, if available