Struct QuickSwitchMenu

pub struct QuickSwitchMenu {
    tray_virtual_desktops_quick: Vec<(MenuItem, u32)>,
    tray_separators: Vec<MenuSeparator>,
    tray_submenus: Vec<(Menu, u32)>,
    pub shortcuts: BTreeMap<String, u32>,
    pub shortcuts_only_in_root: bool,
    call_queue: Vec<(ControlHandle, u32, u32, u32)>,
    is_recursive_call: bool,
}

Fields

tray_virtual_desktops_quick: Vec<(MenuItem, u32)>

Menu items that map to specific virtual desktops.

tray_separators: Vec<MenuSeparator>

tray_submenus: Vec<(Menu, u32)>

[nwg::Menu] won’t be automatically removed from their parent when dropped so make sure to use [crate::nwg_ext::remove_menu] to manually remove them.

shortcuts: BTreeMap<String, u32>

Support shortcut access keys to specific virtual desktop indexes. This keys should not be numbers since those access keys are already in use by the quick switch menu.

shortcuts_only_in_root: bool

Only show the shortcut menu items in the root of the quick switch menu.

call_queue: Vec<(ControlHandle, u32, u32, u32)>

Used to limit recursion in order to prevent stack overflow, should be empty when not inside a Self::create_quick_switch_menu call.

We could have used a VecDeque here to more faithfully remember the call order but its actually more performant to not do that since the normal call order is breadth first which means we would store more items in this queue.

is_recursive_call: bool

true if we are in a recursive call of Self::create_quick_switch_menu.

Implementations

impl QuickSwitchMenu

pub fn get_clicked_desktop_index(&self, handle: ControlHandle) -> Option<usize>

Get the virtual desktop index that should be selected when a specific context menu item is pressed.

pub fn get_desktop_index_so_far(&self, submenu_handle: isize) -> Option<usize>

Get the number that would be generated by the keyboard shortcuts needed to open the specified submenu.

pub fn first_item_in_submenu( &self, submenu_handle: isize, ) -> Option<ControlHandle>

Find first item/menu inside a submenu.

pub fn clear(&mut self)

pub fn has_submenu(&self, menu_handle: isize) -> bool

fn create_shortcut_items(&mut self, parent: ControlHandle)

Extra menu items that don’t use numbers as access keys. These allow the user to give specific keys as shortcuts for frequently visited virtual desktops.

fn try_create_leaf_items( &mut self, parent: ControlHandle, range: Range<u32>, ) -> bool

If there are 10 items or less in a submenu then each one could get a unique access key. This function will only create context menu items if that is the case.

fn create_submenus( &mut self, parent: ControlHandle, desktop_count: u32, prefix: u32, remaining_digits: u32, start_digit: u32, ) -> usize

If there are too many items to assign each a unique access key then we create up to 10 submenus that divide the range into smaller parts.

Returns part of the range for the first created submenu, but changes its start value so that it doesn’t overlap with the submenus’ access keys.

pub fn create_quick_switch_menu( &mut self, parent: ControlHandle, desktop_count: u32, )

Create a menu that is easily navigable with keyboard access keys.

Here is an example of what it can look like:

quick -> &00 - 09 ------------> 0&1
         &10 - 19 --> 1&0       0&2
         &20 - 29     1&1       0&3
         &30 - 39     1&2       0&4
         &40 - 49     1&3       0&5
         &50 - 59     1&4       0&6
        ----------    1%5       0&7
         &6           1&6       0&8
         &7           1&7       0&9
         &8           1&8
         &9           1&9

fn _create_quick_switch_menu( &mut self, parent: ControlHandle, desktop_count: u32, prefix: u32, remaining_digits: u32, )

Trait Implementations

impl Default for QuickSwitchMenu

fn default() -> QuickSwitchMenu

Returns the “default value” for a type.

impl Drop for QuickSwitchMenu

fn drop(&mut self)

Executes the destructor for this type.