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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
use std::borrow::Cow;
use crate::sys;
use crate::ui::Ui;
use super::{ComboBoxFlags, ComboBoxOptions, ComboBoxPreviewMode, ComboBoxToken};
/// # Combo Box Widgets
impl Ui {
/// Creates a combo box and starts appending to it.
///
/// Returns `Some(ComboBoxToken)` if the combo box is open. After content has been
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo(
&self,
label: impl AsRef<str>,
preview_value: impl AsRef<str>,
) -> Option<ComboBoxToken<'_>> {
self.begin_combo_with_flags(label, preview_value, ComboBoxFlags::NONE)
}
/// Creates a combo box with flags and starts appending to it.
///
/// Returns `Some(ComboBoxToken)` if the combo box is open. After content has been
/// rendered, the token must be ended by calling `.end()`.
/// Returns `None` if the combo box is not open and no content should be rendered.
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_with_flags(
&self,
label: impl AsRef<str>,
preview_value: impl AsRef<str>,
flags: impl Into<ComboBoxOptions>,
) -> Option<ComboBoxToken<'_>> {
let options = flags.into();
options.validate("Ui::begin_combo_with_flags()");
let (label_ptr, preview_ptr) = self.scratch_txt_two(label, preview_value);
let should_render = unsafe { sys::igBeginCombo(label_ptr, preview_ptr, options.raw()) };
if should_render {
Some(ComboBoxToken::new(self))
} else {
None
}
}
/// Creates a combo box without preview value.
///
/// Returns `Some(ComboBoxToken)` if the combo box is open. After content has been
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_no_preview(&self, label: impl AsRef<str>) -> Option<ComboBoxToken<'_>> {
self.begin_combo_no_preview_with_flags(label, ComboBoxFlags::NONE)
}
/// Creates a combo box without preview value and with flags.
///
/// Returns `Some(ComboBoxToken)` if the combo box is open. After content has been
/// rendered, the token must be ended by calling `.end()`.
///
/// Returns `None` if the combo box is not open and no content should be rendered.
#[must_use]
#[doc(alias = "BeginCombo")]
pub fn begin_combo_no_preview_with_flags(
&self,
label: impl AsRef<str>,
flags: impl Into<ComboBoxOptions>,
) -> Option<ComboBoxToken<'_>> {
let mut options = flags.into();
options.preview_mode = ComboBoxPreviewMode::NoPreview;
options.validate("Ui::begin_combo_no_preview_with_flags()");
let label_ptr = self.scratch_txt(label);
let should_render =
unsafe { sys::igBeginCombo(label_ptr, std::ptr::null(), options.raw()) };
if should_render {
Some(ComboBoxToken::new(self))
} else {
None
}
}
/// Builds a simple combo box for choosing from a slice of values.
#[doc(alias = "Combo")]
pub fn combo<V, L>(
&self,
label: impl AsRef<str>,
current_item: &mut usize,
items: &[V],
label_fn: L,
) -> bool
where
for<'b> L: Fn(&'b V) -> Cow<'b, str>,
{
let label_fn = &label_fn;
let mut result = false;
let preview_value = items.get(*current_item).map(label_fn);
if let Some(combo_token) = self.begin_combo(
label,
preview_value.as_ref().map(|s| s.as_ref()).unwrap_or(""),
) {
for (idx, item) in items.iter().enumerate() {
let is_selected = idx == *current_item;
if is_selected {
self.set_item_default_focus();
}
let clicked = self.selectable(label_fn(item).as_ref());
if clicked {
*current_item = idx;
result = true;
}
}
combo_token.end();
}
result
}
/// Builds a simple combo box using an `i32` index (ImGui-style).
///
/// This is useful when you want to represent \"no selection\" with `-1`, matching Dear ImGui's
/// `Combo()` API.
#[doc(alias = "Combo")]
pub fn combo_i32<V, L>(
&self,
label: impl AsRef<str>,
current_item: &mut i32,
items: &[V],
label_fn: L,
) -> bool
where
for<'b> L: Fn(&'b V) -> Cow<'b, str>,
{
let label_fn = &label_fn;
let mut result = false;
let preview_value = if *current_item >= 0 {
items.get(*current_item as usize).map(|v| label_fn(v))
} else {
None
};
if let Some(combo_token) = self.begin_combo(
label,
preview_value.as_ref().map(|s| s.as_ref()).unwrap_or(""),
) {
for (idx, item) in items.iter().enumerate() {
if idx > i32::MAX as usize {
break;
}
let idx_i32 = idx as i32;
let is_selected = idx_i32 == *current_item;
if is_selected {
self.set_item_default_focus();
}
let clicked = self.selectable(label_fn(item).as_ref());
if clicked {
*current_item = idx_i32;
result = true;
}
}
combo_token.end();
}
result
}
/// Builds a simple combo box for choosing from a slice of strings
#[doc(alias = "Combo")]
pub fn combo_simple_string(
&self,
label: impl AsRef<str>,
current_item: &mut usize,
items: &[impl AsRef<str>],
) -> bool {
self.combo(label, current_item, items, |s| Cow::Borrowed(s.as_ref()))
}
/// Builds a simple combo box for choosing from a slice of strings using an `i32` index.
#[doc(alias = "Combo")]
pub fn combo_simple_string_i32(
&self,
label: impl AsRef<str>,
current_item: &mut i32,
items: &[impl AsRef<str>],
) -> bool {
self.combo_i32(label, current_item, items, |s| Cow::Borrowed(s.as_ref()))
}
/// Sets the default focus for the next item
pub fn set_item_default_focus(&self) {
unsafe {
sys::igSetItemDefaultFocus();
}
}
}