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.

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

type Target = W

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

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_scroll( &mut self, cx: &mut EventCx<'_>, _: &Self::Data, scroll: Scroll, )

Handler for scrolling

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 navigable(&self) -> bool

Is this widget navigable via Tab key?

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

Mouse focus handler

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

Handler for messages from children/descendants

impl<W> HasBool for ScrollRegion<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> HasStr for ScrollRegion<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 ScrollRegion<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 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 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

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

impl<W: Widget> Scrollable for ScrollRegion<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, cx: &mut EventCx<'_>, offset: Offset) -> Offset

Set the scroll offset

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 for_child_node( &mut self, data: &Self::Data, index: usize, closure: Box<dyn FnOnce(Node<'_>) + '_>, )

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