Struct ScrollRegion 

pub struct ScrollRegion<W: Widget> { /* private fields */ }

A scrollable region

This region supports scrolling via mouse wheel and click/touch drag.

The ideal size of a ScrollRegion is the ideal size of its content: that is, all content may be shown at ideal size without scrolling. The minimum size of a ScrollRegion is somewhat arbitrary (currently, fixed at the height of three lines of standard text). The inner size (content size) is max(content_min_size, outer_size - content_margin).

Scroll bars are not included; use ScrollBarRegion if you want those.

Messages

kas::messages::SetScrollOffset may be used to set the scroll offset.

Implementations

impl<W: Widget> ScrollRegion<W>

pub fn new(inner: W) -> Self

Construct a new scroll region around an inner widget

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 ScrollRegion<W>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> ScrollRegion<W>

Returns the “default value” for a type.

impl<W: Widget> Events for ScrollRegion<W>

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

The mouse cursor icon to use on mouse over

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

Configure self

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

Handle an Event

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: Scroll, )

Handler for scrolling

const REDRAW_ON_MOUSE_OVER: bool = false

Does this widget have a different appearance on mouse over?

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

Make an identifier for a child

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: Widget> Layout for ScrollRegion<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: Widget> Scrollable for ScrollRegion<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: Widget> Tile for ScrollRegion<W>

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

Describe the widget’s role

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

Get translation of child index relative to this widget

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

impl<W: Widget> Widget for ScrollRegion<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