Struct kas_widgets::menu::SubMenu

pub struct SubMenu<D: Directional> { /* private fields */ }

A sub-menu

Implementations

impl<D: Directional> SubMenu<D>where
    D: Default,

pub fn new<S: Into<AccelString>>(label: S, list: Vec<BoxedMenu>) -> Self

Construct a sub-menu

impl SubMenu<Right>

pub fn right<S: Into<AccelString>>(label: S, list: Vec<BoxedMenu>) -> Self

Construct a sub-menu, opening to the right

impl SubMenu<Down>

pub fn down<S: Into<AccelString>>(label: S, list: Vec<BoxedMenu>) -> Self

Construct a sub-menu, opening downwards

impl<D: Directional> SubMenu<D>

pub fn new_with_direction<S: Into<AccelString>>(
    direction: D,
    label: S,
    list: Vec<BoxedMenu>
) -> Self

Construct a sub-menu

The sub-menu is opened in the direction given (contents are always vertical).

Trait Implementations

impl<D: Directional> AutoLayout for SubMenu<D>

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

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

Translate a coordinate to a WidgetId

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

Draw a widget and its children

impl<D: Directional> Debug for SubMenu<D>where
    D: Debug,

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

Formats the value using the given formatter.

impl<D: Directional> HasStr for SubMenu<D>

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<D: Directional> Layout for SubMenu<D>

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

Translate a coordinate to a WidgetId

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

Draw a widget and its children

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut ConfigMgr<'_>, rect: Rect)

Set size and position

impl<D: Directional> Menu for SubMenu<D>

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,
    mgr: &mut EventMgr<'_>,
    target: Option<&WidgetId>,
    set_focus: bool
)

Open or close a sub-menu, including parents

impl<D: Directional> Widget for SubMenu<D>

fn pre_configure(&mut self, mgr: &mut ConfigMgr<'_>, id: WidgetId)

Pre-configuration

fn navigable(&self) -> bool

Is this widget navigable via Tab key?

fn nav_next(
    &mut self,
    _: &mut ConfigMgr<'_>,
    _: bool,
    _: Option<usize>
) -> Option<usize>

Navigation in spatial order

fn handle_event(&mut self, mgr: &mut EventMgr<'_>, event: Event) -> Response

Handle an event sent to this widget

fn handle_message(&mut self, mgr: &mut EventMgr<'_>, _: usize)

Handler for messages from children/descendants

fn handle_scroll(&mut self, mgr: &mut EventMgr<'_>, _: Scroll)

Handler for scrolling

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

Configure widget

fn translation(&self) -> Offset

Get translation of children relative to this widget

fn steal_event(
    &mut self,
    mgr: &mut EventMgr<'_>,
    id: &WidgetId,
    event: &Event
) -> Response

Potentially steal an event before it reaches a child

fn handle_unused(
    &mut self,
    mgr: &mut EventMgr<'_>,
    index: usize,
    event: Event
) -> Response

Handle an event sent to child index but left unhandled

impl<D: Directional> WidgetChildren for SubMenu<D>

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn Widget>

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

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn Widget>

Mutable variant of get

fn find_child_index(&self, id: &WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn make_child_id(&mut self, index: usize) -> WidgetId

Make an identifier for a child

impl<D: Directional> WidgetCore for SubMenu<D>

fn id_ref(&self) -> &WidgetId

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 as_widget(&self) -> &dyn Widget

Erase type

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

Erase type