Struct AdaptEvents 

pub struct AdaptEvents<W: Widget> {
    pub inner: W,
    /* private fields */
}

Wrapper with configure / update / message handling callbacks.

This type is constructed by some AdaptWidget methods.

Fields

inner: W

The inner widget

Implementations

impl<W: Widget> AdaptEvents<W>

pub fn new(inner: W) -> Self

Construct

pub fn on_configure<F>(self, f: F) -> Self

where F: Fn(&mut AdaptConfigCx<'_, '_>, &mut W) + 'static,

Call the given closure on configuration

Specifically, the closure is called after Events::post_configure.

pub fn on_update<F>(self, f: F) -> Self

where F: Fn(&mut AdaptConfigCx<'_, '_>, &mut W, &W::Data) + 'static,

Call the given closure on update

The closure is called after the Self::on_configure handler during configuration and after Events::update during update.

pub fn on_message<M, H>(self, handler: H) -> Self

where M: Debug + 'static, H: Fn(&mut AdaptEventCx<'_, '_>, &mut W, M) + 'static,

Add a handler on message of type M

The child index may be inferred via EventCx::last_child. (Note: this is only possible since AdaptEvents is a special “thin” wrapper.)

Where access to input data is required, use Self::on_messages instead.

pub fn map_message<M, N, H>(self, handler: H) -> Self

where M: Debug + 'static, N: Debug + 'static, H: Fn(usize, M) -> N + 'static,

Add a child handler to map messages of type M to N

Example

use kas::messages::Select;
use kas_widgets::{AdaptWidget, Row, Tab};

#[derive(Clone, Debug)]
struct MsgSelectIndex(usize);

let tabs = Row::new([Tab::new("A")])
    .map_message(|index, Select| MsgSelectIndex(index));

pub fn on_messages<H>(self, handler: H) -> Self

where H: Fn(&mut AdaptEventCx<'_, '_>, &mut W, &W::Data) + 'static,

Add a generic message handler

The child index may be inferred via EventCx::last_child. (Note: this is only possible since AdaptEvents is a special “thin” wrapper.)

Trait Implementations

impl<W: Widget> Deref for AdaptEvents<W>

type Target = W

The resulting type after dereferencing.

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

Dereferences the value.

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

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

Mutably dereferences the value.

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

fn rect(&self) -> Rect

Get the widget’s region

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

Calculate size requirements for an axis

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

Set size and position

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

Draw a widget and its children

impl<W: Widget> Tile for AdaptEvents<W>

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 id(&self) -> Id

Get the widget’s identifier

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

Return a Display-able widget identifier

fn child_indices(&self) -> ChildIndices

Get child indices available to recursion

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

Access a child as a dyn Tile, if available

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

fn navigable(&self) -> bool

Whether this widget supports navigation focus

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

Tooltip

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

Describe the widget’s role

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

Specify additional role properties for child index

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

Probe a coordinate for a widget’s Id

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

Navigation in spatial order

impl<W> Viewport for AdaptEvents<W>

where W: Viewport + Widget,

fn content_size(&self) -> Size

Get content size

fn set_offset(&mut self, cx: &mut SizeCx<'_>, viewport: Rect, offset: Offset)

Set the scroll offset

fn update_offset( &mut self, cx: &mut ConfigCx<'_>, data: &Self::Data, viewport: Rect, offset: Offset, )

Update the scroll offset

fn draw_with_offset(&self, draw: DrawCx<'_>, viewport: Rect, offset: Offset)

Draw with a scroll offset

fn try_probe_with_offset(&self, coord: Coord, offset: Offset) -> Option<Id>

Probe a coordinate for a widget’s Id

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