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
use crate::co;
use crate::decl::*;
use crate::gui::*;
use crate::kernel::privs::*;
use crate::msg::*;
use crate::prelude::*;
/// Possible states of the arrow in a [`HeaderItem`](crate::gui::HeaderItem).
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub enum HeaderArrow {
/// No arrow.
None,
/// An arrow pointing up, indicating sorting in ascending order.
Asc,
/// An arrow pointing down, indicating sorting in descending order.
Desc,
}
impl From<HeaderArrow> for co::HDF {
fn from(v: HeaderArrow) -> Self {
use HeaderArrow as H;
match v {
H::Asc => co::HDF::SORTUP,
H::Desc => co::HDF::SORTDOWN,
H::None => co::HDF::NoValue,
}
}
}
/// Text justification for a [`HeaderItem`](crate::gui::HeaderItem).
#[derive(Clone, Copy, PartialEq, Eq, Hash)]
pub enum HeaderJustify {
Left,
Center,
Right,
}
impl From<HeaderJustify> for co::HDF {
fn from(v: HeaderJustify) -> Self {
use HeaderJustify as H;
match v {
H::Left => co::HDF::LEFT,
H::Center => co::HDF::CENTER,
H::Right => co::HDF::RIGHT,
}
}
}
/// A single item of a [`Header`](crate::gui::Header) control.
///
/// **Note:** Each object keeps the zero-based index of an item. If new items
/// are added/removed from the list view control, the object may then point to a
/// different item.
///
/// You cannot directly instantiate this object, it is created internally by the
/// control.
#[derive(Clone, Copy)]
pub struct HeaderItem<'a> {
owner: &'a Header,
index: u32,
}
impl<'a> HeaderItem<'a> {
#[must_use]
pub(in crate::gui) const fn new(owner: &'a Header, index: u32) -> Self {
Self { owner, index }
}
/// Deletes the item by sending a
/// [`hdm::DeleteItem`](crate::msg::hdm::DeleteItem) message.
pub fn delete(&self) -> SysResult<()> {
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::DeleteItem { index: self.index })
}
}
/// Sets the item as the focused one sending an
/// [`hdm:SetFocusedItem`](crate::msg::hdm::SetFocusedItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn focus(&self) -> SysResult<Self> {
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetFocusedItem { index: self.index })?;
}
Ok(*self)
}
/// Return the format flags of the item by sending a
/// [`hdm::GetItem`](crate::msg::hdm::GetItem) message.
#[must_use]
pub fn format(&self) -> co::HDF {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::FORMAT;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::GetItem { index: self.index, hditem: &mut hdi });
}
hdi.fmt
}
/// Returns the zero-based index of the item.
#[must_use]
pub const fn index(&self) -> u32 {
self.index
}
/// Retrieves the user-defined value by sending a
/// [`hdm::GetItem`](crate::msg::hdm::GetItem) message.
#[must_use]
pub fn lparam(&self) -> isize {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::LPARAM;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::GetItem { index: self.index, hditem: &mut hdi });
}
hdi.lParam
}
/// Retrieves the order of the item by sending a
/// [`hdm::GetItem`](crate::msg::hdm::GetItem) message.
#[must_use]
pub fn order(&self) -> u32 {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::ORDER;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::GetItem { index: self.index, hditem: &mut hdi });
}
hdi.iOrder as _
}
/// Sets the arrow state of the item by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_arrow(&self, arrow_state: HeaderArrow) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::FORMAT;
hdi.fmt = self.format();
hdi.fmt &= !(co::HDF::SORTUP | co::HDF::SORTDOWN); // remove both
hdi.fmt |= arrow_state.into();
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &mut hdi });
}
*self
}
/// Sets the text justification of the column by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_justify(&self, text_justification: HeaderJustify) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::FORMAT;
hdi.fmt = self.format();
hdi.fmt &= !(co::HDF::LEFT | co::HDF::CENTER | co::HDF::RIGHT); // remove all
hdi.fmt |= text_justification.into();
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &mut hdi });
}
*self
}
/// Sets the user-defined value of the item by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_lparam(&self, lparam: isize) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::LPARAM;
hdi.lParam = lparam;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &hdi });
}
*self
}
/// Sets the order of the item by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_order(&self, order: u32) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::ORDER;
hdi.iOrder = order as _;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &hdi });
}
*self
}
/// Sets the text of the item by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_text(&self, text: &str) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::TEXT;
let mut wtext = WString::from_str(text);
hdi.set_pszText(Some(&mut wtext));
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &hdi });
}
*self
}
/// Sets the width of the item by sending a
/// [`hdm::SetItem`](crate::msg::hdm::SetItem) message.
///
/// Returns the same item, so further operations can be chained.
pub fn set_width(&self, width: i32) -> Self {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::WIDTH;
hdi.cxy = width;
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::SetItem { index: self.index, hditem: &hdi });
}
*self
}
/// Retrieves the text of the item by sending a
/// [`hdm::GetItem`](crate::msg::hdm::GetItem) message.
#[must_use]
pub fn text(&self) -> String {
let mut hdi = HDITEM::default();
hdi.mask = co::HDI::TEXT;
let mut buf = WString::new_alloc_buf(MAX_PATH + 1); // arbitrary
hdi.set_pszText(Some(&mut buf));
unsafe {
self.owner
.hwnd()
.SendMessage(hdm::GetItem { index: self.index, hditem: &mut hdi });
}
buf.to_string()
}
}