Struct TrayConfig 

pub struct TrayConfig { /* private fields */ }

Initial configuration for a Tray.

Implementations

impl TrayConfig

pub fn new(icon: Icon) -> TrayConfig

Start a configuration with the required tray icon.

Examples found in repository

examples/basic.rs (line 30)

fn main() {
    // A 16x16 solid red icon.
    let side = 16u32;
    let mut rgba = Vec::with_capacity((side * side * 4) as usize);
    for _ in 0..side * side {
        rgba.extend_from_slice(&[220, 40, 40, 255]);
    }
    let icon = Icon::from_rgba(side, side, rgba).expect("valid icon");
    let notify_icon = icon.clone();

    let menu = Menu::new()
        .item(MenuItem::button(SAY_HI, "Say hi"))
        .item(MenuItem::checkbox(TOGGLE, "Toggle me", false))
        .item(MenuItem::separator())
        .item(MenuItem::button(QUIT, "Quit"));

    let config = TrayConfig::new(icon).tooltip("ldtray example").menu(menu);

    let tray = match Tray::new(config) {
        Ok(tray) => tray,
        Err(err) => {
            eprintln!("tray unavailable: {err}");
            eprintln!("(this is expected on a headless server — exiting cleanly)");
            return;
        }
    };

    let handle = tray.handle();
    println!("tray is up — right-click it for the menu, or Ctrl-C to abort");

    let result = tray.run(move |event| {
        println!("event: {event:?}");
        match event {
            Event::Menu(id) if id.0 == SAY_HI => {
                let _ = handle.notify(
                    Notification::new("ldtray", "Hello from the tray!")
                        .with_icon(notify_icon.clone()),
                );
            }
            Event::Menu(id) if id.0 == QUIT => {
                let _ = handle.quit();
            }
            _ => {}
        }
    });

    if let Err(err) = result {
        eprintln!("event loop ended with error: {err}");
    }
}

pub fn tooltip(self, tooltip: impl Into<String>) -> TrayConfig

Builder: set the hover tooltip text.

Examples found in repository

examples/basic.rs (line 30)

fn main() {
    // A 16x16 solid red icon.
    let side = 16u32;
    let mut rgba = Vec::with_capacity((side * side * 4) as usize);
    for _ in 0..side * side {
        rgba.extend_from_slice(&[220, 40, 40, 255]);
    }
    let icon = Icon::from_rgba(side, side, rgba).expect("valid icon");
    let notify_icon = icon.clone();

    let menu = Menu::new()
        .item(MenuItem::button(SAY_HI, "Say hi"))
        .item(MenuItem::checkbox(TOGGLE, "Toggle me", false))
        .item(MenuItem::separator())
        .item(MenuItem::button(QUIT, "Quit"));

    let config = TrayConfig::new(icon).tooltip("ldtray example").menu(menu);

    let tray = match Tray::new(config) {
        Ok(tray) => tray,
        Err(err) => {
            eprintln!("tray unavailable: {err}");
            eprintln!("(this is expected on a headless server — exiting cleanly)");
            return;
        }
    };

    let handle = tray.handle();
    println!("tray is up — right-click it for the menu, or Ctrl-C to abort");

    let result = tray.run(move |event| {
        println!("event: {event:?}");
        match event {
            Event::Menu(id) if id.0 == SAY_HI => {
                let _ = handle.notify(
                    Notification::new("ldtray", "Hello from the tray!")
                        .with_icon(notify_icon.clone()),
                );
            }
            Event::Menu(id) if id.0 == QUIT => {
                let _ = handle.quit();
            }
            _ => {}
        }
    });

    if let Err(err) = result {
        eprintln!("event loop ended with error: {err}");
    }
}

pub fn menu(self, menu: Menu) -> TrayConfig

Builder: set the context menu.

Examples found in repository

examples/basic.rs (line 30)

fn main() {
    // A 16x16 solid red icon.
    let side = 16u32;
    let mut rgba = Vec::with_capacity((side * side * 4) as usize);
    for _ in 0..side * side {
        rgba.extend_from_slice(&[220, 40, 40, 255]);
    }
    let icon = Icon::from_rgba(side, side, rgba).expect("valid icon");
    let notify_icon = icon.clone();

    let menu = Menu::new()
        .item(MenuItem::button(SAY_HI, "Say hi"))
        .item(MenuItem::checkbox(TOGGLE, "Toggle me", false))
        .item(MenuItem::separator())
        .item(MenuItem::button(QUIT, "Quit"));

    let config = TrayConfig::new(icon).tooltip("ldtray example").menu(menu);

    let tray = match Tray::new(config) {
        Ok(tray) => tray,
        Err(err) => {
            eprintln!("tray unavailable: {err}");
            eprintln!("(this is expected on a headless server — exiting cleanly)");
            return;
        }
    };

    let handle = tray.handle();
    println!("tray is up — right-click it for the menu, or Ctrl-C to abort");

    let result = tray.run(move |event| {
        println!("event: {event:?}");
        match event {
            Event::Menu(id) if id.0 == SAY_HI => {
                let _ = handle.notify(
                    Notification::new("ldtray", "Hello from the tray!")
                        .with_icon(notify_icon.clone()),
                );
            }
            Event::Menu(id) if id.0 == QUIT => {
                let _ = handle.quit();
            }
            _ => {}
        }
    });

    if let Err(err) = result {
        eprintln!("event loop ended with error: {err}");
    }
}

Trait Implementations

impl Clone for TrayConfig

fn clone(&self) -> TrayConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TrayConfig

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

Formats the value using the given formatter.