Struct TrayRoot

pub struct TrayRoot {

    tray_ui: DynamicUiRef<SystemTray>,
    no_parent: ParentCapture,
    pub window: TrayWindow,
    pub icon: Icon,
    pub tray: TrayNotification,
    last_tray_key_event: Cell<Option<Instant>>,
    last_left_click: Cell<Option<Instant>>,
    pub tray_menu: Menu,
    selected_tray_menu_item: Cell<Option<ControlHandle>>,
    last_menu_pos: Cell<Option<(i32, i32)>>,
    reshow_tray_menu: Cell<Option<(Instant, MenuPosition)>>,
    reshow_tray_menu_delay: FastTimerControl,
    rebuild_at_startup: FastTimerControl,
    first_created_at: Option<Instant>,
    recheck_virtual_desktop_init: FastTimerControl,
    need_rebuild: Cell<bool>,
}

Basic state used by the program.

Fields

tray_ui: DynamicUiRef<SystemTray>

no_parent: ParentCapture

window: TrayWindow

icon: Icon

The initial icon for the tray.

tray: TrayNotification

last_tray_key_event: Cell<Option<Instant>>

last_left_click: Cell<Option<Instant>>

tray_menu: Menu

selected_tray_menu_item: Cell<Option<ControlHandle>>

last_menu_pos: Cell<Option<(i32, i32)>>

The location where we last showed the context menu.

reshow_tray_menu: Cell<Option<(Instant, MenuPosition)>>

reshow_tray_menu_delay: FastTimerControl

rebuild_at_startup: FastTimerControl

If the app is auto started with Windows then the taskbar might not exist when the program is started and if so we need to re-register our tray icon.

first_created_at: Option<Instant>

The program was started at approximately this time.

recheck_virtual_desktop_init: FastTimerControl

Initial virtual desktop count might be incorrect if program is started with Windows.

need_rebuild: Cell<bool>

Implementations

impl TrayRoot

pub fn notify_that_tray_icon_exists(&self)

fn notify_tray_left_click(&self)

fn notify_startup_rebuild(&self)

fn notify_check_desktop_count(&self)

fn notify_reshow_tray_menu_delayed(&self)

pub fn get_selected_tray_menu_item(&self) -> Option<ControlHandle>

pub fn update_tray_icon(&self, tray_ui: &Rc<SystemTray>, new_ix: u32)

Trait Implementations

impl Default for TrayRoot

fn default() -> TrayRoot

Returns the “default value” for a type.

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 PartialUi for TrayRoot

fn build_partial<W: Into<ControlHandle>>( data: &mut Self, _parent: Option<W>, ) -> Result<(), NwgError>

Should initialize the GUI components. Similar to NativeUi::build_ui except it doesn’t handle event binding.

fn process_event<'a>( &self, _evt: Event, _evt_data: &EventData, _handle: ControlHandle, )

Should process the events of the partial. This method will probably be called from an event handler bound in the parent GUI structure.

fn handles(&self) -> Vec<&ControlHandle>

Should return the handles of the top level parent controls (such as Windows). Those handle should be used to bind the default events handler.

impl TrayPlugin for TrayRoot

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

fn on_current_desktop_changed(&self, tray_ui: &Rc<SystemTray>, new_ix: u32)

fn on_settings_changed( &self, tray_ui: &Rc<SystemTray>, previous: &Arc<UiSettings>, new: &Arc<UiSettings>, )

fn on_desktop_event(&self, _tray_ui: &Rc<SystemTray>, _event: &DesktopEvent)

React to Virtual Desktop events.

fn on_desktop_count_changed( &self, _tray_ui: &Rc<SystemTray>, _new_desktop_count: u32, )

fn on_menu_key_press( &self, _tray_ui: &Rc<SystemTray>, _key_code: u32, _menu_handle: isize, ) -> Option<MenuKeyPressEffect>

Handle keyboard button press on tray context menu. The first return value that is Some will be used; if there is no such return value then MenuKeyPressEffect::Ignore will be used.