dear-imgui-rs 0.16.0

High-level Rust bindings to Dear ImGui v1.92.9b with docking, WGPU/GL backends, and extensions (ImPlot/ImPlot3D, ImNodes, ImGuizmo, file browser, reflection-based UI)
Documentation 
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use crate::scope::{NativeScopePop, NativeScopeToken};
use crate::ui::Ui;

/// Tracks a main menu bar that can be ended by calling `.end()` or by dropping.
///
/// The token must finish after every nested menu or window-like scope and in its originating
/// window `Begin` scope. Prefer [`crate::Ui::main_menu_bar`] for ordinary use.
#[must_use]
#[doc(alias = "EndMainMenuBar")]
pub struct MainMenuBarToken<'ui> {
    scope: NativeScopeToken<'ui>,
}

impl<'ui> MainMenuBarToken<'ui> {
    /// Creates a new main menu bar token
    pub(super) fn new(ui: &'ui Ui) -> Self {
        Self {
            scope: ui.begin_native_scope(NativeScopePop::EndMainMenuBar, "MainMenuBarToken"),
        }
    }

    /// Ends the main menu bar
    ///
    /// # Panics
    ///
    /// Panics before FFI if a nested scope is active or this token is outside its originating
    /// window `Begin` scope.
    pub fn end(self) {
        // The drop implementation will handle the actual ending
    }
}

impl Drop for MainMenuBarToken<'_> {
    fn drop(&mut self) {
        self.scope.finish();
    }
}

/// Tracks a menu bar that can be ended by calling `.end()` or by dropping.
///
/// The token must finish after every nested menu and in its originating window `Begin` scope.
/// Prefer [`crate::Ui::menu_bar`] for ordinary use.
#[must_use]
#[doc(alias = "EndMenuBar")]
pub struct MenuBarToken<'ui> {
    scope: NativeScopeToken<'ui>,
}

impl<'ui> MenuBarToken<'ui> {
    /// Creates a new menu bar token
    pub(super) fn new(ui: &'ui Ui) -> Self {
        Self {
            scope: ui.begin_native_scope(NativeScopePop::EndMenuBar, "MenuBarToken"),
        }
    }

    /// Ends the menu bar
    ///
    /// # Panics
    ///
    /// Panics before FFI if a nested menu-bar scope is active or this token is outside its
    /// originating window `Begin` scope.
    pub fn end(self) {
        // The drop implementation will handle the actual ending
    }
}

impl Drop for MenuBarToken<'_> {
    fn drop(&mut self) {
        self.scope.finish();
    }
}

/// Tracks a menu that can be ended by calling `.end()` or by dropping.
///
/// The token must finish after every nested window-like scope and in its originating window
/// `Begin` scope. Prefer [`crate::Ui::menu`] for ordinary use.
#[must_use]
#[doc(alias = "EndMenu")]
pub struct MenuToken<'ui> {
    scope: NativeScopeToken<'ui>,
}

impl<'ui> MenuToken<'ui> {
    /// Creates a new menu token
    pub(super) fn new(ui: &'ui Ui) -> Self {
        Self {
            scope: ui.begin_native_scope(NativeScopePop::EndMenu, "MenuToken"),
        }
    }

    /// Ends the menu
    ///
    /// # Panics
    ///
    /// Panics before FFI if a nested window-like scope is active or this token is outside its
    /// originating window `Begin` scope.
    pub fn end(self) {
        // The drop implementation will handle the actual ending
    }
}

impl Drop for MenuToken<'_> {
    fn drop(&mut self) {
        self.scope.finish();
    }
}