Struct MenuEntry 

pub struct MenuEntry<M: Clone + Debug + 'static> { /* private fields */ }

A standard menu entry

Messages

A MenuEntry has an associated message value of type M. A clone of this value is pushed when the entry is activated.

Messages

kas::messages::Activate may be used to trigger the menu entry.

Implementations

impl<M: Clone + Debug + 'static> MenuEntry<M>

pub fn new_msg<S: Into<AccessString>>(label: S, msg: M) -> Self

Construct a menu item with a given label and msg

The message msg is emitted on activation. Any type supporting Clone is valid, though it is recommended to use a simple Copy type (e.g. an enum).

pub fn set_msg(&mut self, msg: M)

Replace the message value

pub fn as_str(&self) -> &str

Get text contents

Trait Implementations

impl<M: Clone + Clone + Debug + 'static> Clone for MenuEntry<M>

fn clone(&self) -> MenuEntry<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug + Clone + Debug + 'static> Debug for MenuEntry<M>

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

Formats the value using the given formatter.

impl<M: Default + Clone + Debug + 'static> Default for MenuEntry<M>

fn default() -> MenuEntry<M>

Returns the “default value” for a type.

impl<M: Clone + Debug + 'static> Events for MenuEntry<M>

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

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

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

Handler for scrolling

impl<M: Clone + Debug + 'static> Layout for MenuEntry<M>

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

Draw a widget and its children

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 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<M: Clone + Debug + 'static> MacroDefinedLayout for MenuEntry<M>

fn rect(&self) -> Rect

Get the widget’s region

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 try_probe(&self, coord: Coord) -> Option<Id>

Probe a coordinate for a widget’s Id

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

Draw a widget and its children

impl<M: Clone + Debug + 'static> Menu for MenuEntry<M>

fn sub_items(&mut self) -> Option<SubItems<'_>>

Access row items for aligned layout

fn menu_is_open(&self) -> bool

Report whether a submenu (if any) is open

fn set_menu_path( &mut self, cx: &mut EventCx<'_>, data: &Self::Data, target: Option<&Id>, set_focus: bool, )

Open or close a sub-menu, including parents

impl<M> PartialEq<M> for MenuEntry<M>

where M: PartialEq + Clone + Debug + 'static,

fn eq(&self, rhs: &M) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<M: Clone + Debug + 'static> Tile for MenuEntry<M>

fn navigable(&self) -> bool

Whether this widget supports navigation focus

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

Describe the widget’s role

fn probe(&self, _: 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 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<M: Clone + Debug + 'static> Widget for MenuEntry<M>

type 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