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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
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 EditObj {
base: BaseCtrl,
events: BaseCtrlEvents,
_pin: PhantomPinned,
}
native_ctrl! { Edit: EditObj => GuiEventsEdit;
/// Native
/// [edit](https://learn.microsoft.com/en-us/windows/win32/controls/about-edit-controls)
/// (text box) control.
}
impl Edit {
/// Instantiates a new `Edit` 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 an `Edit` in an event closure.
///
/// # Examples
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, gui};
///
/// let wnd: gui::WindowMain; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
///
/// let txt = gui::Edit::new(
/// &wnd,
/// gui::EditOpts {
/// position: gui::dpi(10, 10),
/// width: gui::dpi_x(120),
/// ..Default::default()
/// },
/// );
/// ```
#[must_use]
pub fn new(parent: &(impl GuiParent + 'static), opts: EditOpts) -> Self {
let ctrl_id = auto_id::set_if_zero(opts.ctrl_id);
let new_self = Self(Arc::pin(EditObj {
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,
"EDIT",
Some(&text2),
opts.window_style | opts.control_style.into(),
opts.position.into(),
SIZE::with(opts.width, opts.height),
&parent2,
);
ui_font::set(self2.hwnd());
parent2
.as_ref()
.add_to_layout(self2.hwnd(), opts.resize_behavior);
Ok(0) // ignored
});
new_self.default_message_handlers(parent);
new_self
}
/// Instantiates a new `Edit` 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 an `Edit` 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(EditObj {
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.default_message_handlers(parent);
new_self
}
fn default_message_handlers(&self, parent: &(impl GuiParent + 'static)) {
let self2 = self.clone();
let parent2 = parent.clone();
parent
.as_ref()
.before_on()
.wm_command(self.ctrl_id(), co::EN::CHANGE, move || {
// EN_CHANGE is first sent to the control before CreateWindowEx()
// returns, so if the user handles EN_CHANGE, the Edit HWND won't be
// set yet. So we set the HWND here.
if *self2.hwnd() == HWND::NULL {
let hctrl = parent2
.as_ref()
.hwnd()
.GetDlgItem(self2.ctrl_id())
.expect(DONTFAIL);
self2.0.base.set_hwnd(hctrl);
}
Ok(())
});
}
/// Hides any balloon tip by sending an
/// [`em::HideBalloonTip`](crate::msg::em::HideBalloonTip) message.
pub fn hide_balloon_tip(&self) -> SysResult<()> {
unsafe { self.hwnd().SendMessage(em::HideBalloonTip {}) }
}
/// Limits the number of characters that can be type by sending an
/// [`em::SetLimitText`](crate::msg::em::SetLimitText) message.
pub fn limit_text(&self, max_chars: Option<u32>) {
unsafe {
self.hwnd().SendMessage(em::SetLimitText { max_chars });
}
}
/// Replaces the currently selected text by sending an
/// [`em::ReplaceSel`](crate::msg::em::ReplaceSel) message.
pub fn replace_selection(&self, text: &str) {
let text16 = WString::from_str(text);
unsafe {
self.hwnd().SendMessage(em::ReplaceSel {
can_be_undone: true,
replacement_text: text16,
})
}
}
/// Sets the selection range of the text by sending an
/// [`em::SetSel`](crate::msg::em::SetSel) message.
///
/// # Examples
///
/// Selecting all text in the control:
///
/// ```no_run
/// use winsafe::{self as w, prelude::*, gui};
///
/// let my_edit: gui::Edit; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
/// # let my_edit = gui::Edit::new(&wnd, gui::EditOpts::default());
///
/// my_edit.set_selection(0, -1);
/// ```
///
/// Clearing the selection:
///
/// ```no_run
/// use winsafe::gui;
///
/// let my_edit: gui::Edit; // initialized somewhere
/// # let wnd = gui::WindowMain::new(gui::WindowMainOpts::default());
/// # let my_edit = gui::Edit::new(&wnd, gui::EditOpts::default());
///
/// my_edit.set_selection(-1, -1);
/// ```
pub fn set_selection(&self, start: i32, end: i32) {
unsafe {
self.hwnd().SendMessage(em::SetSel { start, end });
}
}
/// Sets the text by calling
/// [`HWND::SetWindowText`](crate::HWND::SetWindowText).
pub fn set_text(&self, text: &str) -> SysResult<()> {
self.hwnd().SetWindowText(text)?;
Ok(())
}
/// Displays a balloon tip by sending an
/// [`em::ShowBalloonTip`](crate::msg::em::ShowBalloonTip) message.
pub fn show_ballon_tip(&self, title: &str, text: &str, icon: co::TTI) -> SysResult<()> {
let mut title16 = WString::from_str(title);
let mut text16 = WString::from_str(text);
let mut info = EDITBALLOONTIP::default();
info.set_pszTitle(Some(&mut title16));
info.set_pszText(Some(&mut text16));
info.ttiIcon = icon;
unsafe { self.hwnd().SendMessage(em::ShowBalloonTip { info: &info }) }
}
/// Retrieves the text by calling
/// [`HWND::GetWindowText`](crate::HWND::GetWindowText).
#[must_use]
pub fn text(&self) -> SysResult<String> {
self.hwnd().GetWindowText()
}
}
/// Options to create an [`Edit`](crate::gui::Edit) programmatically with
/// [`Edit::new`](crate::gui::Edit::new).
pub struct EditOpts<'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),
/// Control width to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `gui::dpi_x(100)`.
pub width: i32,
/// Control height to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `gui::dpi_y(23)`.
///
/// **Note:** You should change the default height only in a multi-line
/// edit, otherwise it will look off.
pub height: i32,
/// Edit styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `ES::AUTOHSCROLL | ES::NOHIDESEL`.
///
/// Suggestions:
/// * add `ES::PASSWORD` for a password input;
/// * add `ES::NUMBER` to accept only numbers;
/// * replace with `ES::MULTILINE | ES::WANTRETURN | ES::AUTOVSCROLL | ES::NOHIDESEL` for a multi-line edit.
pub control_style: co::ES,
/// 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 | WS_EX::CLIENTEDGE`.
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.
///
/// **Note:** You should use `Vert::Resize` only in a multi-line edit.
///
/// Defaults to `(gui::Horz::None, gui::Vert::None)`.
pub resize_behavior: (Horz, Vert),
}
impl<'a> Default for EditOpts<'a> {
fn default() -> Self {
Self {
text: "",
position: dpi(0, 0),
width: dpi_x(100),
height: dpi_y(23),
control_style: co::ES::AUTOHSCROLL | co::ES::NOHIDESEL,
window_style: co::WS::CHILD | co::WS::GROUP | co::WS::TABSTOP | co::WS::VISIBLE,
window_ex_style: co::WS_EX::LEFT | co::WS_EX::CLIENTEDGE,
ctrl_id: 0,
resize_behavior: (Horz::None, Vert::None),
}
}
}