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
use std::any::{Any, TypeId};
use std::cell::RefCell;
use std::marker::{PhantomData, PhantomPinned};
use std::pin::Pin;
use std::rc::Rc;
use std::sync::Arc;
use crate::co;
use crate::decl::*;
use crate::guard::*;
use crate::gui::{collections::*, privs::*, *};
use crate::msg::*;
use crate::prelude::*;
struct TreeViewObj<T> {
base: BaseCtrl,
events: BaseCtrlEvents,
_pin: PhantomPinned,
_data: PhantomData<T>,
}
native_ctrl! { TreeView: TreeViewObj<T>, T => GuiEventsTreeView;
/// Native
/// [tree view](https://learn.microsoft.com/en-us/windows/win32/controls/tree-view-controls)
/// control.
///
/// The generic parameter specifies the type of the object that will be
/// embedded on each item – if you don't want to store anything, just use
/// `()` as the type. Internally, this storage is implemented with pointers
/// in the item's `LPARAM` fields.
}
impl<T> TreeView<T> {
/// Instantiates a new `TreeView` 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 `TreeView` in an event closure.
#[must_use]
pub fn new(parent: &(impl GuiParent + 'static), opts: TreeViewOpts) -> Self {
let ctrl_id = auto_id::set_if_zero(opts.ctrl_id);
let new_self = Self(Arc::pin(TreeViewObj {
base: BaseCtrl::new(ctrl_id),
events: BaseCtrlEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
_data: PhantomData,
}));
let self2 = new_self.clone();
let parent2 = parent.clone();
parent
.as_ref()
.before_on()
.wm(parent.as_ref().wnd_ty().creation_msg(), move |_| {
self2.0.base.create_window(
opts.window_ex_style,
"SysTreeView32",
None,
opts.window_style | opts.control_style.into(),
opts.position.into(),
opts.size.into(),
&parent2,
);
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 `TreeView` 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 `TreeView` 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(TreeViewObj {
base: BaseCtrl::new(ctrl_id),
events: BaseCtrlEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
_data: PhantomData,
}));
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 AsRef<BaseWnd>) {
let self2 = self.clone();
parent
.as_ref()
.after_on()
.wm_notify(self.ctrl_id(), co::TVN::DELETEITEM, move |p| {
let nmtv = unsafe { p.cast_nmhdr::<NMTREEVIEW>() };
let item = self2.items().get(&nmtv.itemOld.hItem);
if let Some(rc_ptr) = item.data_lparam() {
let _ = unsafe { Rc::from_raw(rc_ptr) }; // drop the stored Rc
}
Ok(0) // ignored
});
let self2 = self.clone();
parent.as_ref().after_on().wm_destroy(move || {
[co::TVSIL::NORMAL, co::TVSIL::STATE]
.into_iter()
.for_each(|kind| unsafe {
self2
.hwnd()
.SendMessage(tvm::GetImageList { kind })
.map(|h| {
self2
.hwnd()
.SendMessage(tvm::SetImageList { himagelist: None, kind }); // remove from control
let _ = ImageListDestroyGuard::new(h); // destroy
});
});
Ok(())
});
}
pub(in crate::gui) fn raw_insert_item(
&self,
hparent: Option<&HTREEITEM>,
text: &str,
icon_index: Option<u32>,
data: T,
) -> SysResult<TreeViewItem<'_, T>> {
let mut tvix = TVITEMEX::default();
tvix.mask = co::TVIF::TEXT;
let mut buf = WString::from_str(text);
tvix.set_pszText(Some(&mut buf));
if let Some(icon_index) = icon_index {
tvix.mask |= co::TVIF::IMAGE;
tvix.iImage = icon_index as _;
}
if TypeId::of::<T>() != TypeId::of::<()>() {
// User has defined a generic type, so we store the object right away.
tvix.mask |= co::TVIF::PARAM;
let rc_data = Rc::new(RefCell::new(data));
tvix.lParam = Rc::into_raw(rc_data) as _; // store the Rc pointer
}
let mut tvis = TVINSERTSTRUCT::default();
if let Some(hparent) = hparent {
tvis.hParent = unsafe { hparent.raw_copy() };
}
tvis.set_hInsertAfter(TreeitemTvi::Tvi(co::TVI::LAST));
tvis.itemex = tvix;
let new_hitem = unsafe {
self.hwnd()
.SendMessage(tvm::InsertItem { item: &mut tvis })?
};
Ok(TreeViewItem::new(self, new_hitem))
}
/// Retrieves one of the associated image lists by sending a
/// [`tvm::GetImageList`](crate::msg::tvm::GetImageList) message.
///
/// Image lists are lazy-initialized: the first time you call this method
/// for a given image list, it will be created and assigned with
/// [`tvm::SetImageList`](crate::msg::tvm::SetImageList).
///
/// The image list is owned by the control.
#[must_use]
pub fn image_list(&self, kind: co::TVSIL) -> HrResult<HIMAGELIST> {
match unsafe { self.hwnd().SendMessage(tvm::GetImageList { kind }) } {
Some(h) => Ok(h), // already created
None => {
// Not created yet. Create a new image list and assign it to the list view.
let h = HIMAGELIST::Create(SIZE::with(16, 16), co::ILC::COLOR32, 1, 1)?.leak();
unsafe {
self.hwnd()
.SendMessage(tvm::SetImageList { himagelist: Some(h.raw_copy()), kind });
}
Ok(h)
},
}
}
/// Exposes the item methods.
#[must_use]
pub const fn items(&self) -> TreeViewItems<'_, T> {
TreeViewItems::new(self)
}
/// Sets or unsets the given extended list view styles by sending a
/// [`tvm::SetExtendedStyle`](crate::msg::tvm::SetExtendedStyle) message.
pub fn set_extended_style(&self, set: bool, ex_style: co::TVS_EX) -> HrResult<()> {
unsafe {
self.hwnd().SendMessage(tvm::SetExtendedStyle {
mask: ex_style,
style: if set { ex_style } else { co::TVS_EX::NoValue },
})
}
}
}
/// Options to create a [`TreeView`](crate::gui::TreeView) programmatically with
/// [`TreeView::new`](crate::gui::TreeView::new).
pub struct TreeViewOpts {
/// 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 `gui::dpi(120, 120)`.
pub size: (i32, i32),
/// Tree view styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `TVS::HASLINES | TVS::LINESATROOT | TVS::SHOWSELALWAYS | TVS::HASBUTTONS`.
pub control_style: co::TVS,
/// Extended tree view styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `TVS_EX::NoValue`.
pub contorl_ex_style: co::TVS_EX,
/// 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.
///
/// Defaults to `(gui::Horz::None, gui::Vert::None)`.
pub resize_behavior: (Horz, Vert),
}
impl Default for TreeViewOpts {
fn default() -> Self {
Self {
position: dpi(0, 0),
size: dpi(120, 120),
control_style: co::TVS::HASLINES
| co::TVS::LINESATROOT
| co::TVS::SHOWSELALWAYS
| co::TVS::HASBUTTONS,
contorl_ex_style: co::TVS_EX::NoValue,
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),
}
}
}