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

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

/// Token representing an active tab bar.
///
/// Tab-bar and tab-item tokens from the same window must finish in reverse creation order and in
/// their originating window `Begin` scope. Prefer [`crate::TabBar::build`] for ordinary use.
#[derive(Debug)]
#[must_use]
#[doc(alias = "EndTabBar")]
pub struct TabBarToken<'ui> {
    scope: NativeScopeToken<'ui>,
}

impl<'ui> TabBarToken<'ui> {
    /// Creates a new tab bar token
    pub(crate) fn new(ui: &'ui Ui) -> Self {
        Self {
            scope: ui.begin_native_scope(NativeScopePop::EndTabBar, "TabBarToken"),
        }
    }

    /// Ends the tab bar
    ///
    /// # Panics
    ///
    /// Panics before FFI if a tab item or later tab-bar token is active, or if this token is
    /// outside its originating window `Begin` scope.
    pub fn end(self) {
        // Token is consumed, destructor will be called
    }
}

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

/// Token representing an active tab item.
///
/// Tab-bar and tab-item tokens from the same window must finish in reverse creation order and in
/// their originating window `Begin` scope. Prefer [`crate::TabItem::build`] for ordinary use.
#[derive(Debug)]
#[must_use]
#[doc(alias = "EndTabItem")]
pub struct TabItemToken<'ui> {
    scope: NativeScopeToken<'ui>,
}

impl<'ui> TabItemToken<'ui> {
    /// Creates a new tab item token
    pub(crate) fn new(ui: &'ui Ui) -> Self {
        Self {
            scope: ui.begin_native_scope(NativeScopePop::EndTabItem, "TabItemToken"),
        }
    }

    /// Ends the tab item
    ///
    /// # Panics
    ///
    /// Panics before FFI if a later tab token is active or this token is outside its originating
    /// window `Begin` scope.
    pub fn end(self) {
        // Token is consumed, destructor will be called
    }
}

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