winsafe 0.0.27

Windows API and GUI in safe, idiomatic Rust.
Documentation 
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
306
307
308
309
310
311
312
313
314
315
316
317
318
319

#![doc = include_str!("lib.md")]
#![cfg_attr(any(), rustfmt::skip)]

// Declarations of macros used throughout the library.
// No macros are public, except those in pub_macros.

#[macro_use] mod macros;

// Declarations of modules themselves.

#[cfg(feature = "advapi")] mod advapi;
#[cfg(feature = "comctl")] mod comctl;
#[cfg(feature = "dshow")] mod dshow;
#[cfg(feature = "dwm")] mod dwm;
#[cfg(feature = "dxgi")] mod dxgi;
#[cfg(feature = "gdi")] mod gdi;
#[cfg(feature = "kernel")] mod kernel;
#[cfg(feature = "mf")] mod mf;
#[cfg(feature = "ole")] mod ole;
#[cfg(feature = "oleaut")] mod oleaut;
#[cfg(feature = "psapi")] mod psapi;
#[cfg(feature = "shell")] mod shell;
#[cfg(feature = "taskschd")] mod taskschd;
#[cfg(feature = "user")] mod user;
#[cfg(feature = "uxtheme")] mod uxtheme;
#[cfg(feature = "version")] mod version;
#[cfg(feature = "wininet")] mod wininet;
#[cfg(feature = "winspool")] mod winspool;
#[cfg(all(feature = "advapi", feature = "comctl"))] mod advapi_comctl;
#[cfg(all(feature = "advapi", feature = "shell"))] mod advapi_shell;
#[cfg(all(feature = "comctl", feature = "gdi"))] mod comctl_gdi;
#[cfg(all(feature = "comctl", feature = "shell"))] mod comctl_shell;
#[cfg(all(feature = "gdi", feature = "mf"))] mod gdi_mf;

// The gui module itself is public.

#[cfg(feature = "gui")] pub mod gui;

// Declarations inside decl are public, placed at the root of the crate.

mod decl {
	#[cfg(feature = "advapi")] pub use super::advapi::decl::*;
	#[cfg(feature = "comctl")] pub use super::comctl::decl::*;
	#[cfg(feature = "dshow")] pub use super::dshow::decl::*;
	#[cfg(feature = "dwm")] pub use super::dwm::decl::*;
	#[cfg(feature = "dxgi")] pub use super::dxgi::decl::*;
	#[cfg(feature = "gdi")] pub use super::gdi::decl::*;
	#[cfg(feature = "kernel")] pub use super::kernel::decl::*;
	#[cfg(feature = "mf")] pub use super::mf::decl::*;
	#[cfg(feature = "ole")] pub use super::ole::decl::*;
	#[cfg(feature = "oleaut")] pub use super::oleaut::decl::*;
	#[cfg(feature = "psapi")] pub use super::psapi::decl::*;
	#[cfg(feature = "shell")] pub use super::shell::decl::*;
	#[cfg(feature = "taskschd")] pub use super::taskschd::decl::*;
	#[cfg(feature = "user")] pub use super::user::decl::*;
	#[cfg(feature = "uxtheme")] pub use super::uxtheme::decl::*;
	#[cfg(feature = "version")] pub use super::version::decl::*;
	#[cfg(feature = "wininet")] pub use super::wininet::decl::*;
	#[cfg(feature = "winspool")] pub use super::winspool::decl::*;
	#[cfg(all(feature = "advapi", feature = "comctl"))] pub use super::advapi_comctl::decl::*;
	#[cfg(all(feature = "advapi", feature = "shell"))] pub use super::advapi_shell::decl::*;
	#[cfg(all(feature = "comctl", feature = "gdi"))] pub use super::comctl_gdi::decl::*;
}
pub use decl::*;

#[cfg(feature = "kernel")]
pub mod co {
	//! Native constants.
	//!
	//! Among these constant types, three are error types:
	//! [`CDERR`], [`ERROR`] and [`HRESULT`].

	#[cfg(feature = "advapi")] pub use super::advapi::co::*;
	#[cfg(feature = "comctl")] pub use super::comctl::co::*;
	#[cfg(feature = "dshow")] pub use super::dshow::co::*;
	#[cfg(feature = "dwm")] pub use super::dwm::co::*;
	#[cfg(feature = "dxgi")] pub use super::dxgi::co::*;
	#[cfg(feature = "gdi")] pub use super::gdi::co::*;
	#[cfg(feature = "kernel")] pub use super::kernel::co::*;
	#[cfg(feature = "mf")] pub use super::mf::co::*;
	#[cfg(feature = "ole")] pub use super::ole::co::*;
	#[cfg(feature = "oleaut")] pub use super::oleaut::co::*;
	#[cfg(feature = "shell")] pub use super::shell::co::*;
	#[cfg(feature = "taskschd")] pub use super::taskschd::co::*;
	#[cfg(feature = "user")] pub use super::user::co::*;
	#[cfg(feature = "uxtheme")] pub use super::uxtheme::co::*;
	#[cfg(feature = "version")] pub use super::version::co::*;
	#[cfg(feature = "wininet")] pub use super::wininet::co::*;
	#[cfg(feature = "winspool")] pub use super::winspool::co::*;
	#[cfg(all(feature = "advapi", feature = "shell"))] pub use super::advapi_shell::co::*;
}

#[cfg(feature = "kernel")]
pub mod guard {
	//! RAII implementation for various resources, which automatically perform
	//! cleanup routines when the object goes out of scope.
	//!
	//! The guards are named after the functions they call.

	#[cfg(feature = "advapi")] pub use super::advapi::guards::*;
	#[cfg(feature = "comctl")] pub use super::comctl::guards::*;
	#[cfg(feature = "gdi")] pub use super::gdi::guards::*;
	#[cfg(feature = "kernel")] pub use super::kernel::guards::*;
	#[cfg(feature = "mf")] pub use super::mf::guards::*;
	#[cfg(feature = "ole")] pub use super::ole::guards::*;
	#[cfg(feature = "shell")] pub use super::shell::guards::*;
	#[cfg(feature = "user")] pub use super::user::guards::*;
	#[cfg(feature = "uxtheme")] pub use super::uxtheme::guards::*;
	#[cfg(feature = "version")] pub use super::version::guards::*;
	#[cfg(feature = "wininet")] pub use super::wininet::guards::*;
	#[cfg(feature = "winspool")] pub use super::winspool::guards::*;
}

#[cfg(feature = "user")]
pub mod msg {
	#![doc = include_str!("msg.md")]

	pub use super::user::messages::WndMsg;

	#[cfg(feature = "user")]
	pub mod bm {
		//! Button control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-button-control-reference-messages),
		//! whose constants have [`BM`](crate::co::BM) and
		//! [`BCM`](crate::co::BCM) prefixes.

		pub use super::super::user::messages::bm::*;
		#[cfg(feature = "comctl")] pub use super::super::comctl::messages::bcm::*;
	}

	#[cfg(feature = "user")]
	pub mod cb {
		//! Combo box control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-combobox-control-reference-messages),
		//! whose constants have [`CB`](crate::co::CB) prefix.

		pub use super::super::user::messages::cb::*;
		#[cfg(feature = "comctl")] pub use super::super::comctl::messages::cb::*;
	}

	#[cfg(feature = "comctl")]
	pub mod dtm {
		//! Date and time picker control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-date-and-time-picker-control-reference-messages),
		//! whose constants have [`DTM`](crate::co::DTM) prefix.

		pub use super::super::comctl::messages::dtm::*;
		#[cfg(feature = "gdi")] pub use super::super::comctl_gdi::messages::dtm::*;
	}

	#[cfg(feature = "user")]
	pub mod em {
		//! Edit control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-edit-control-reference-messages),
		//! whose constants have [`EM`](crate::co::EM) prefix.

		pub use super::super::user::messages::em::*;
		#[cfg(feature = "comctl")] pub use super::super::comctl::messages::em::*;
	}

	#[cfg(feature = "comctl")]
	pub mod hdm {
		//! Header control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-header-control-reference-messages),
		//! whose constants have [`HDM`](crate::co::HDM) prefix.

		pub use super::super::comctl::messages::hdm::*;
	}

	#[cfg(feature = "user")]
	pub mod lb {
		//! ListBox control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-list-box-control-reference-messages),
		//! whose constants have [`LB`](crate::co::LB) prefix.

		pub use super::super::user::messages::lb::*;
	}

	#[cfg(feature = "comctl")]
	pub mod lvm {
		//! List view control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-list-view-control-reference-messages),
		//! whose constants have [`LVM`](crate::co::LVM) prefix.

		pub use super::super::comctl::messages::lvm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod mcm {
		//! Month calendar control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-month-calendar-control-reference-messages),
		//! whose constants have [`MCM`](crate::co::MCM) prefix.

		pub use super::super::comctl::messages::mcm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod pbm {
		//! Progress bar control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-progress-bar-control-reference-messages),
		//! whose constants have [`PBM`](crate::co::PBM) prefix.

		pub use super::super::comctl::messages::pbm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod psm {
		//! Property sheet
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-property-sheets-reference-messages),
		//! whose constants have [`PSM`](crate::co::PSM) prefix.

		pub use super::super::comctl::messages::psm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod sb {
		//! Status bar control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-status-bars-reference-messages),
		//! whose constants have [`SB`](crate::co::SB) prefix.

		pub use super::super::comctl::messages::sb::*;
	}

	#[cfg(feature = "comctl")]
	pub mod stm {
		//! Static control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-static-control-reference-messages),
		//! whose constants have [`STM`](crate::co::STM) prefix.

		pub use super::super::comctl::messages::stm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod tbm {
		//! Toolbar control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-toolbar-control-reference-messages),
		//! whose constants have [`TBM`](crate::co::TBM) prefix.

		pub use super::super::comctl::messages::tbm::*;
		#[cfg(feature = "advapi")] pub use super::super::advapi_comctl::messages::tbm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod tcm {
		//! Tab control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-tab-control-reference-messages),
		//! whose constants have [`TCM`](crate::co::TCM) prefix.

		pub use super::super::comctl::messages::tcm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod trbm {
		//! Trackbar control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-trackbar-control-reference-messages),
		//! whose constants have [`TRBM`](crate::co::TRBM) prefix.
		//!
		//! Originally has `TBM` prefix.

		pub use super::super::comctl::messages::trbm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod tvm {
		//! Tree view control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-tree-view-control-reference-messages),
		//! whose constants have [`TVM`](crate::co::TVM) prefix.

		pub use super::super::comctl::messages::tvm::*;
	}

	#[cfg(feature = "comctl")]
	pub mod udm {
		//! UpDown control
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/controls/bumper-up-down-control-reference-messages),
		//! whose constants have [`UDM`](crate::co::UDM) prefix.

		pub use super::super::comctl::messages::udm::*;
	}

	#[cfg(feature = "user")]
	pub mod wm {
		//! Generic window
		//! [messages](https://learn.microsoft.com/en-us/windows/win32/winmsg/about-messages-and-message-queues),
		//! whose constants have [`WM`](crate::co::WM) prefix.

		pub use super::super::user::messages::wm::*;
		#[cfg(feature = "comctl")] pub use super::super::comctl::messages::wm::*;
		#[cfg(feature = "gdi")] pub use super::super::gdi::messages::wm::*;
		#[cfg(feature = "shell")] pub use super::super::shell::messages::wm::*;
	}
}

#[cfg(feature = "kernel")]
pub mod prelude {
	//! The WinSafe prelude.
	//!
	//! The purpose of this module is to alleviate imports of many common
	//! traits. To use it, add a glob import to the top of all your modules that
	//! use the library:
	//!
	//! ```rust,no_run
	//! use winsafe::prelude::*;
	//! ```

	#[cfg(feature = "gdi")] pub use super::gdi::traits::*;
	#[cfg(feature = "gui")] pub use super::gui::traits::*;
	#[cfg(feature = "kernel")] pub use super::kernel::traits::*;
	#[cfg(feature = "user")] pub use super::user::traits::*;

	#[cfg(feature = "dshow")] pub use super::dshow::traits::*;
	#[cfg(feature = "dxgi")] pub use super::dxgi::traits::*;
	#[cfg(feature = "mf")] pub use super::mf::traits::*;
	#[cfg(feature = "ole")] pub use super::ole::traits::*;
	#[cfg(feature = "oleaut")] pub use super::oleaut::traits::*;
	#[cfg(feature = "shell")] pub use super::shell::traits::*;
	#[cfg(feature = "taskschd")] pub use super::taskschd::traits::*;
	#[cfg(all(feature = "gdi", feature = "mf"))] pub use super::gdi_mf::traits::*;
}