Struct kas::widget::ScrollRegion

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

A scrollable region

This region supports scrolling via mouse wheel and drag. Optionally, it can have scroll bars (see ScrollRegion::show_bars and ScrollRegion::with_bars).

Scroll regions translate their contents by an offset, which has a minimum value of Coord::ZERO and a maximum value of ScrollRegion::max_offset.

Methods

impl<W: Widget> ScrollRegion<W>

pub fn new(inner: W) -> Self

Construct a new scroll region around an inner widget

pub fn with_auto_bars(self, enable: bool) -> Self

Auto-enable bars

If enabled, this automatically enables/disables scroll bars when resized.

This has the side-effect of reserving enough space for scroll bars even when not required.

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

Set which scroll bars are visible

pub fn show_bars(&mut self, horiz: bool, vert: bool)

Set which scroll bars are visible

pub fn inner(&self) -> &W

Access inner widget directly

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

Access inner widget directly

pub fn max_offset(&self) -> Coord

Get the maximum offset

pub fn offset(&self) -> Coord

Get the current offset

pub fn set_offset(&mut self, offset: Coord) -> TkAction

Set the scroll offset

Returns TkAction::None if the offset is identical to the old offset, or a greater action if not identical.

Trait Implementations

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

fn clone(&self) -> ScrollRegion<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 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> Handler for ScrollRegion<W>

type Msg = <W as Handler>::Msg

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn handle(&mut self, _: &mut Manager, event: Event) -> Response<Self::Msg>

Handle an event and return a user-defined message

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

fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, rect: Rect, _: AlignHints)

Apply a given rect to self

fn translation(&self, child_index: usize) -> Coord

Get translation of a child

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

Find a widget by coordinate

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

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

fn send(
    &mut self,
    mgr: &mut Manager,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

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

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

fn len(&self) -> usize

Get the number of child widgets

fn get(&self, _index: usize) -> Option<&dyn WidgetConfig>

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

fn get_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

fn walk(&self, f: &mut dyn FnMut(&dyn WidgetConfig))

Walk through all widgets, calling f once on each.

fn walk_mut(&mut self, f: &mut dyn FnMut(&mut dyn WidgetConfig))

Walk through all widgets, calling f once on each.

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

fn configure(&mut self, mgr: &mut Manager)

Configure widget

fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

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

fn as_any(&self) -> &dyn Any

Get self as type Any

fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

fn core_data_mut(&mut self) -> &mut CoreData

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

fn id(&self) -> WidgetId

Get the widget's numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

fn set_disabled(&mut self, disabled: bool) -> TkAction

Get the disabled state of a widget

fn rect(&self) -> Rect

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

fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState