snora-core 0.8.0

Vocabulary and contract layer for the Snora iced GUI framework.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

//! Header menus (File / Edit / View / ... drop-downs).
//!
//! A menu is a **pure data contract**. The application supplies a list of
//! [`Menu`] values, the engine renders them into a header bar, and
//! interaction is reported back via [`MenuAction`] messages. snora-core
//! has no opinion on how the menu is rendered.
//!
//! `MenuId` and `MenuItemId` are application-defined types. They must
//! implement `Clone` for message dispatch and `PartialEq` for tracking
//! which menu is currently open.
//!
//! The recommended pattern is a pair of application-owned enums:
//!
//! ```rust
//! #[derive(Clone, Debug, PartialEq, Eq)]
//! enum MyMenuId { File, View, Help }
//!
//! #[derive(Clone, Debug, PartialEq, Eq)]
//! enum MyMenuItemId { New, Open, Quit, ToggleLogs, About }
//! ```

use std::fmt::Debug;

use crate::icon::Icon;

/// An event emitted by a header menu.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum MenuAction<MenuId, MenuItemId> {
    /// The menu header (not an item) was pressed. Convention: toggle open /
    /// closed, or switch the currently-open menu.
    MenuPressed(MenuId),

    /// An item within a menu was chosen.
    MenuItemPressed {
        /// Id of the parent menu.
        menu_id: MenuId,
        /// Id of the chosen item.
        menu_item_id: MenuItemId,
    },
}

/// A top-level menu in the header (e.g. "File", "View").
#[derive(Debug, Clone)]
pub struct Menu<MenuId, MenuItemId>
where
    MenuId: Clone + Debug + PartialEq,
    MenuItemId: Clone + Debug,
{
    /// Application-defined identity of this menu.
    pub id: MenuId,
    /// Visible label (e.g. "File", "View").
    pub label: String,
    /// Optional icon shown next to the label.
    pub icon: Option<Icon>,
    /// Items shown in the dropdown when this menu is active.
    pub items: Vec<MenuItem<MenuId, MenuItemId>>,
}

/// A single entry in a menu's dropdown.
#[derive(Debug, Clone)]
pub struct MenuItem<MenuId, MenuItemId>
where
    MenuId: Clone + Debug + PartialEq,
    MenuItemId: Clone + Debug,
{
    /// The id of the parent menu. Stored on each item so that
    /// [`MenuAction::MenuItemPressed`] can carry it without a second lookup.
    pub menu_id: MenuId,
    /// Application-defined identity of this item.
    pub id: MenuItemId,
    /// Visible label.
    pub label: String,
    /// Optional icon shown before the label.
    pub icon: Option<Icon>,
}