Enum CheckMenuKind

Source

pub enum CheckMenuKind<G> {
    CheckBox(Rc<CheckMenuItem>, G),
    Radio(Rc<CheckMenuItem>, Rc<MenuId>, G),
    Separate(Rc<CheckMenuItem>),
}

Expand description

Represents different types of checkable menu items with their associated data

This enum defines three types of checkable menu items:

§Variants

§`CheckBox`

Contains: Rc<CheckMenuItem> and group identifier G
Purpose: A standard checkbox that can be checked/unchecked independently
Grouping: Items with the same G value belong to the same logical group

§`Radio`

Contains: Rc<CheckMenuItem>, default MenuId, and group identifier G
Purpose: A radio button where only one item in the same group can be selected
Default ID: Specifies which menu should be selected when no radio in the group is checked
Grouping: All radio buttons with the same G value form a single selection group

§`Separate`

Contains: Rc<CheckMenuItem> only
Purpose: A standalone checkbox with no grouping requirements
Use case: For independent toggle options that don’t belong to any group

§Type Parameters

G: Group identifier type for organizing related checkable items
- Used by both CheckBox and Radio variants
- Must implement Clone (for storing in the manager)
- Typically use &'static str or enum variants for type safety

§Example

use std::rc::Rc;
use tray_controls::CheckMenuKind;
use tray_icon::menu::{CheckMenuItem, MenuId};

// Create a checkbox belonging to "display_group" group
let checkbox = CheckMenuItem::with_id("show_toolbar", "Show Toolbar", true, false, None);
let check_kind = CheckMenuKind::CheckBox(Rc::new(checkbox), "display_group");

// Create a radio button in "theme_group" group with default selection
let radio = CheckMenuItem::with_id("light_theme", "Light Theme", true, true, None);
let radio_kind = CheckMenuKind::Radio(
    Rc::new(radio),
    Rc::new(MenuId::new("light_theme")),
    "theme_group"
);

// Create a standalone checkbox
let separate = CheckMenuItem::new("Auto-save", true, true, None);
let separate_kind: CheckMenuKind<&str> = CheckMenuKind::Separate(Rc::new(separate));