Struct kas::widget::MenuEntry

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

A standard menu entry

Implementations

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

pub fn new<S: Into<AccelString>>(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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

pub fn default() -> MenuEntry<M>

Returns the "default value" for a type.

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

type Msg = M

Type of message returned by this widget

pub fn handle(&mut self, _: &mut Manager<'_>, event: Event) -> Response<M>

Handle an event and return a user-defined message

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

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

pub fn get_str(&self) -> &str

Get text by reference

pub fn get_string(&self) -> String

Get text as a String

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

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

Get size rules for the given axis

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

Apply a given rect to self

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

Draw a widget and its children

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

Get translation of a child

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

Iterate through children in spatial order

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

Find a widget by coordinate

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

pub fn menu_is_open(&self) -> bool

Report whether one's own menu is open

pub fn menu_path(&mut self, _mgr: &mut Manager<'_>, _target: Option<WidgetId>)

Open or close a sub-menu, including parents

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

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

Send an event

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

pub fn set_accel_string(&mut self, string: AccelString) -> TkAction

Set accel string

pub fn set_accel<T: Into<AccelString>>(&mut self, accel: T) -> TkAction where
    Self: Sized, 

Set text

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

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

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

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

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

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

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

Check whether id is a descendant

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

Find a child widget by identifier

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

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

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

pub fn configure(&mut self, mgr: &mut Manager<'_>)

Configure widget

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

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

Configure self and children

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

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

pub fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Set the disabled state of a widget

pub fn with_disabled(self, disabled: bool) -> Self where
    Self: Sized, 

Set disabled state (chaining)

pub fn rect(&self) -> Rect

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

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

Construct InputState