Struct SystemTray

pub struct SystemTray {
    pub desktop_count: Cell<u32>,
    pub desktop_index: Cell<u32>,
    has_light_taskbar: Cell<bool>,
    desktop_names: RefCell<Vec<Option<Rc<str>>>>,
    pub dynamic_ui: DynamicUi<Self>,
}

Common handle used by tray plugins, usually behind an Rc stored inside SystemTrayRef.

Fields

desktop_count: Cell<u32>

The total number of virtual desktops.

desktop_index: Cell<u32>

The 0-based index of the currently active virtual desktop.

has_light_taskbar: Cell<bool>

Windows has separate modes for Windows itself and other apps. This tracks whether the taskbar and Windows uses light colors.

desktop_names: RefCell<Vec<Option<Rc<str>>>>

dynamic_ui: DynamicUi<Self>

Implementations

impl SystemTray

Plugins.

pub fn new(plugins: Vec<Box<dyn TrayPlugin>>) -> Rc<Self>

fn update_desktop_info(&self)

fn check_if_light_taskbar() -> bool

References

• https://stackoverflow.com/questions/56865923/windows-10-taskbar-color-detection-for-tray-icon
• We use this function: RegGetValueW in windows::Win32::System::Registry - Rust
  • Function docs: RegGetValueW function (winreg.h) - Win32 apps | Microsoft Learn
  • StackOverflow usage example: windows - RegGetValueW(), how to do it right - Stack Overflow

pub fn build_ui(self: Rc<Self>) -> Result<DynamicUiOwner<Self>, NwgError>

pub fn root(&self) -> Ref<'_, TrayRoot>

pub fn settings(&self) -> Ref<'_, UiSettingsPlugin>

pub fn get_desktop_name(&self, index: u32) -> Option<Rc<str>>

pub fn has_light_taskbar(&self) -> bool

Windows has separate modes for Windows itself and other apps. This tracks whether the taskbar and Windows uses light colors.

impl SystemTray

Events.

pub fn notify_quick_switch_hotkey(self: &Rc<Self>)

pub fn notify_open_menu_at_mouse_position_hotkey(self: &Rc<Self>)

pub fn notify_settings_changed( self: &Rc<Self>, prev: &Arc<UiSettings>, new: &Arc<UiSettings>, )

fn notify_windows_mode_change(self: &Rc<Self>)

fn notify_explorer_restart(&self)

fn update_desktop_count(self: &Rc<Self>)

pub fn notify_desktop_event(self: &Rc<Self>, event: DesktopEvent)

fn notify_tray_left_click(&self)

fn notify_tray_middle_click(&self)

fn notify_tray_menu_closed(&self)

fn notify_key_press_in_menu( self: &Rc<Self>, key_code: u32, active_menu_handle: isize, ) -> Option<MenuKeyPressEffect>

Note: this isn’t run inside a SystemTray::handle_action callback and so we might handle events while something is being rebuilt.

impl SystemTray

Commands.

pub fn switch_desktop(&self, desktop_ix: u32)

fn hide_menu(&self)

This doesn’t seem to actually do anything, needs to be changed to actually work.

pub fn show_menu(&self, position: MenuPosition)

pub fn reshow_menu(&self, position: MenuPosition)

Close and then re-open the context menu to ensure it is opened at the requested position.

pub fn close_menu(&self) -> bool

Close the context menu if it is open. Returns true if an existing menu was closed.

Note: the menu won’t be closed until you return to the event loop. This means that re-opening the menu immediately after will not work.

pub fn show_notification(&self, title: &str, text: &str)

pub fn apply_filters(&self)

pub fn configure_filters(&self, refocus: bool)

pub fn stop_flashing_windows(&self)

pub fn exit(&self)

Trait Implementations

impl Debug for SystemTray

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

Formats the value using the given formatter.

impl DynamicUiHooks<SystemTray> for ApplyFilters

fn before_partial_build( &mut self, _tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for AutoStartPlugin

fn before_partial_build( &mut self, _tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for BackspaceAsEscapeAlias

fn before_partial_build( &mut self, _dynamic_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for BottomMenuItems

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for ConfigWindow

fn before_partial_build( &mut self, dynamic_ui: &Rc<SystemTray>, should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<SystemTray>, handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_rebuild(&self, _dynamic_ui: &Rc<SystemTray>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

impl DynamicUiHooks<SystemTray> for DynamicVirtualDesktopEventManager

fn before_partial_build( &mut self, tray: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn process_raw_event( &self, dynamic_ui: &Rc<SystemTray>, hwnd: isize, msg: u32, w: usize, l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for FlatSwitchMenu

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn need_rebuild(&self, tray_ui: &Rc<SystemTray>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for HotKeyPlugin

fn before_partial_build( &mut self, tray: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for OpenSubmenuPlugin

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_process_events( &self, _dynamic_ui: &Rc<SystemTray>, evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for PanicNotifier

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<T>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

impl DynamicUiHooks<SystemTray> for QuickSwitchMenuUiAdapter

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn need_rebuild(&self, tray_ui: &Rc<SystemTray>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn before_rebuild(&mut self, _tray_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for QuickSwitchTopMenu

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn need_rebuild(&self, tray_ui: &Rc<SystemTray>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for SmoothDesktopSwitcher

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_partial_build(&mut self, _dynamic_ui: &Rc<T>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for TopMenuItems

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn before_rebuild(&mut self, tray_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_process_events( &self, dynamic_ui: &Rc<SystemTray>, evt: Event, _evt_data: &EventData, handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for TrayRoot

fn before_partial_build( &mut self, _dynamic_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<SystemTray>, handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn after_process_events( &self, _dynamic_ui: &Rc<SystemTray>, evt: Event, _evt_data: &EventData, handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, tray_ui: &Rc<SystemTray>, _hwnd: isize, msg: u32, w: usize, l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<SystemTray>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for UiSettingsPlugin

fn before_partial_build( &mut self, tray_ui: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiHooks<SystemTray> for VirtualDesktopEventManager

fn before_partial_build( &mut self, tray: &Rc<SystemTray>, _should_build: &mut bool, ) -> Option<(ControlHandle, TypeId)>

Called before the item has been built. The returned parent will be passed to [nwg::PartialUi::build_partial] and used by controls in structs that make use of the [nwd::NwgPartial] derive macro.

fn after_partial_build(&mut self, tray_ui: &Rc<SystemTray>)

Called right after the ui has finished building.

fn before_rebuild(&mut self, _dynamic_ui: &Rc<SystemTray>)

Do some cleanup before the plugin is built again. By default this resets the state to its default value.

fn after_handles<'a>( &'a self, _dynamic_ui: &Rc<T>, _handles: &mut Vec<&'a ControlHandle>, )

Run right after [nwg::PartialUi::handles] and allows modifying its result.

fn need_raw_events_for_children(&self) -> bool

Called after DynamicUiHooks::after_handles to check if we should bind raw event handlers for child controls as well.

fn after_process_events( &self, _dynamic_ui: &Rc<T>, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, _window: ControlHandle, )

Run right after [nwg::PartialUi::process_event] and allows easily doing some extra processing. Useful since the original method might be implemented by a derive macro which would make it difficult to modify.

fn process_raw_event( &self, _dynamic_ui: &Rc<T>, _hwnd: isize, _msg: u32, _w: usize, _l: isize, _window: ControlHandle, ) -> Option<isize>

Listen to raw window events (not filtered or processed by [native_windows_gui]). The first result that returns Some will be used as the actual return value for the event.

fn need_rebuild(&self, _dynamic_ui: &Rc<T>) -> bool

Indicate that this item needs to be rebuilt. Maybe because its part of a context menu and its items need to be changed.

fn is_ordered_in_parent(&self) -> bool

Indicates if this item has a specific position relative to other items in its parent. If this returns true then the item will be rebuilt after previous siblings (items that share the same parent) are rebuilt.

impl DynamicUiWrapper for SystemTray

type Hooks = dyn TrayPlugin

fn get_dynamic_ui(&self) -> &DynamicUi<Self>

fn get_dynamic_ui_mut(&mut self) -> &mut DynamicUi<Self>