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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
use std::any::Any;
use std::marker::PhantomPinned;
use std::pin::Pin;
use std::sync::Arc;
use crate::co;
use crate::decl::*;
use crate::gui::{privs::*, *};
use crate::msg::*;
use crate::prelude::*;
struct CheckBoxObj {
base: BaseCtrl,
events: BaseCtrlEvents,
_pin: PhantomPinned,
}
native_ctrl! { CheckBox: CheckBoxObj => GuiEventsButton;
/// Native
/// [check box](https://learn.microsoft.com/en-us/windows/win32/controls/button-types-and-styles#check-boxes)
/// control, actually a variation of the ordinary
/// [`Button`](crate::gui::Button): just a button with a specific style.
}
impl CheckBox {
/// Instantiates a new `CheckBox` object, to be created on the parent window
/// with [`HWND::CreateWindowEx`](crate::HWND::CreateWindowEx).
///
/// # Panics
///
/// Panics if the parent window was already created – that is, you cannot
/// dynamically create a `CheckBox` in an event closure.
#[must_use]
pub fn new(parent: &(impl GuiParent + 'static), opts: CheckBoxOpts) -> Self {
let ctrl_id = auto_id::set_if_zero(opts.ctrl_id);
let new_self = Self(Arc::pin(CheckBoxObj {
base: BaseCtrl::new(ctrl_id),
events: BaseCtrlEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
}));
let self2 = new_self.clone();
let parent2 = parent.clone();
let text2 = opts.text.to_owned();
parent
.as_ref()
.before_on()
.wm(parent.as_ref().wnd_ty().creation_msg(), move |_| {
self2.0.base.create_window(
opts.window_ex_style,
"BUTTON",
Some(&text2),
opts.window_style | opts.control_style.into(),
opts.position.into(),
if opts.size == (0, 0) {
text_calc::bound_box_with_check(&text_calc::remove_accel_ampersands(&text2))
} else {
opts.size.into()
},
&parent2,
);
ui_font::set(self2.hwnd());
self2.set_state(opts.check_state);
parent2
.as_ref()
.add_to_layout(self2.hwnd(), opts.resize_behavior);
Ok(0) // ignored
});
new_self
}
/// Instantiates a new `CheckBox` object, to be loaded from a dialog
/// resource with [`HWND::GetDlgItem`](crate::HWND::GetDlgItem).
///
/// # Panics
///
/// Panics if the parent dialog was already created – that is, you cannot
/// dynamically create a `CheckBox` in an event closure.
#[must_use]
pub fn new_dlg(
parent: &(impl GuiParent + 'static),
ctrl_id: u16,
resize_behavior: (Horz, Vert),
) -> Self {
let new_self = Self(Arc::pin(CheckBoxObj {
base: BaseCtrl::new(ctrl_id),
events: BaseCtrlEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
}));
let self2 = new_self.clone();
let parent2 = parent.clone();
parent.as_ref().before_on().wm_init_dialog(move |_| {
self2.0.base.assign_dlg(&parent2);
parent2
.as_ref()
.add_to_layout(self2.hwnd(), resize_behavior);
Ok(true) // ignored
});
new_self
}
/// Sends a [`bm::GetCheck`](crate::msg::bm::GetCheck) message and returns
/// `true` if current state is `co::BST::CHECKED`.
#[must_use]
pub fn is_checked(&self) -> bool {
self.state() == co::BST::CHECKED
}
/// Sets or unsets the check mark by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message.
pub fn set_check(&self, check: bool) {
self.set_state(if check { co::BST::CHECKED } else { co::BST::UNCHECKED });
}
/// Sets the current check state by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message, then sends a
/// [`wm::Command`](crate::msg::wm::Command) message to the parent, so it
/// can handle the event.
pub fn set_check_and_trigger(&self, check: bool) -> SysResult<()> {
self.set_state_and_trigger(if check { co::BST::CHECKED } else { co::BST::UNCHECKED })
}
/// Sets the current check state by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message.
pub fn set_state(&self, state: co::BST) {
unsafe {
self.hwnd().SendMessage(bm::SetCheck { state });
}
}
/// Sets the current check state by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message, then sends a
/// [`wm::Command`](crate::msg::wm::Command) message to the parent, so it
/// can handle the event.
pub fn set_state_and_trigger(&self, state: co::BST) -> SysResult<()> {
self.set_state(state);
self.hwnd().GetParent()?.SendCommand(AccelMenuCtrl::Ctrl {
notif_code: co::BN::CLICKED.into(),
ctrl_id: self.ctrl_id(),
ctrl_hwnd: unsafe { self.hwnd().raw_copy() },
});
Ok(())
}
/// Calls [`HWND::SetWindowText`](crate::HWND::SetWindowText) to set the
/// text and resizes the control to exactly fit it.
pub fn set_text_and_resize(&self, text: &str) -> SysResult<()> {
let bound_box = text_calc::bound_box_with_check(&text_calc::remove_accel_ampersands(text));
self.hwnd().SetWindowPos(
HwndPlace::None,
POINT::default(),
bound_box,
co::SWP::NOZORDER | co::SWP::NOMOVE,
)?;
self.hwnd().SetWindowText(text)?;
Ok(())
}
/// Retrieves the current check state by sending a
/// [`bm::GetCheck`](crate::msg::bm::GetCheck) message.
#[must_use]
pub fn state(&self) -> co::BST {
unsafe { self.hwnd().SendMessage(bm::GetCheck {}) }
}
/// Fires the click event for the check box by sending a
/// [`bm::Click`](crate::msg::bm::Click) message.
pub fn trigger_click(&self) {
unsafe {
self.hwnd().SendMessage(bm::Click {});
}
}
}
/// Options to create a [`CheckBox`](crate::gui::CheckBox) programmatically with
/// [`CheckBox::new`](crate::gui::CheckBox::new).
pub struct CheckBoxOpts<'a> {
/// Text of the control to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to empty string.
pub text: &'a str,
/// Left and top position coordinates of control within parent's client
/// area, to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `gui::dpi(0, 0)`.
pub position: (i32, i32),
/// Width and height of control to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to the size needed to fit the text.
pub size: (i32, i32),
/// Check box styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `BS::AUTOCHECKBOX`.
///
/// Suggestions:
/// * replace with `BS::AUTO3STATE` for a 3-state check box.
pub control_style: co::BS,
/// Window styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `WS::CHILD | WS::GROUP | WS::TABSTOP | WS::VISIBLE`.
pub window_style: co::WS,
/// Extended window styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `WS_EX::LEFT`.
pub window_ex_style: co::WS_EX,
/// The control ID.
///
/// Defaults to an auto-generated ID.
pub ctrl_id: u16,
/// Horizontal and vertical behavior of the control when the parent window
/// is resized.
///
/// Defaults to `(gui::Horz::None, gui::Vert::None)`.
pub resize_behavior: (Horz, Vert),
/// Initial check state.
///
/// Defaults to `co::BST::UNCHECKED`.
pub check_state: co::BST,
}
impl<'a> Default for CheckBoxOpts<'a> {
fn default() -> Self {
Self {
text: "",
position: dpi(0, 0),
size: (0, 0), // will resize to fit the text
control_style: co::BS::AUTOCHECKBOX,
window_style: co::WS::CHILD | co::WS::GROUP | co::WS::TABSTOP | co::WS::VISIBLE,
window_ex_style: co::WS_EX::LEFT,
ctrl_id: 0,
resize_behavior: (Horz::None, Vert::None),
check_state: co::BST::UNCHECKED,
}
}
}