hwnd 0.0.0-2024-01-05

Well documented, safe-leaning, sound, low-level API bindings to `HWND`-adjacent APIs
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

use crate::*;

use winapi::shared::minwindef::BOOL;
use winapi::um::winuser::*;



/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrect)\]
/// AdjustWindowRect
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      **In:** The desired client area.  **Out:** the required outer area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let mut area = Rect { left: 0, right: 800, top: 0, bottom: 600 };
/// adjust_window_rect(&mut area, WS::OVERLAPPEDWINDOW, false).unwrap();
/// #
/// # let mut area = Rect { left: 0, right: -800, top: 0, bottom: 600 };
/// # adjust_window_rect(&mut area, WS::OVERLAPPEDWINDOW, false).unwrap();
/// ```
pub fn adjust_window_rect(rect: &mut impl AsMut<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>) -> Result<(), Error> {
    fn_context!(adjust_window_rect => AdjustWindowRect);
    fn_succeeded!(unsafe { AdjustWindowRect(rect.as_mut().as_mut(), style.into().into(), menu.into() as BOOL) })
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrect)\]
/// AdjustWindowRect
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      The desired client area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
///
/// ### Returns
/// *   The required outer window area.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let area = adjust_window_rect_copy(Rect { left: 0, right: 800, top: 0, bottom: 600 }, WS::OVERLAPPEDWINDOW, false).unwrap();
/// # let area = adjust_window_rect_copy(Rect { left: 0, right:-800, top: 0, bottom: 600 }, WS::OVERLAPPEDWINDOW, false).unwrap();
/// ```
pub fn adjust_window_rect_copy(rect: impl Into<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>) -> Result<Rect, Error> {
    let mut rect = rect.into();
    adjust_window_rect(&mut rect, style, menu)?;
    Ok(rect)
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrectex)\]
/// AdjustWindowRectEx
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      **In:** The desired client area.  **Out:** the required outer area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
/// *   `ex_style`  The [extended window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/extended-window-styles) of the window in question.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let mut area = Rect { left: 0, right: 800, top: 0, bottom: 600 };
/// adjust_window_rect_ex(&mut area, WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW).unwrap();
/// #
/// # let mut area = Rect { left: 0, right: -800, top: 0, bottom: 600 };
/// # adjust_window_rect_ex(&mut area, WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW).unwrap();
/// ```
pub fn adjust_window_rect_ex(rect: &mut impl AsMut<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>, ex_style: impl Into<WindowStyleExtended>) -> Result<(), Error> {
    fn_context!(adjust_window_rect_ex => AdjustWindowRectEx);
    fn_succeeded!(unsafe { AdjustWindowRectEx(rect.as_mut().as_mut(), style.into().into(), menu.into() as BOOL, ex_style.into().into()) })
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrectex)\]
/// AdjustWindowRectEx
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      The desired client area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
/// *   `ex_style`  The [extended window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/extended-window-styles) of the window in question.
///
/// ### Returns
/// *   The required outer window area.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let area = adjust_window_rect_ex_copy(
///     Rect { left: 0, right: 800, top: 0, bottom: 600 },
///     WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW,
/// ).unwrap();
/// #
/// # let area = adjust_window_rect_ex_copy(
/// #     Rect { left: 0, right:-800, top: 0, bottom: 600 },
/// #     WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW,
/// # ).unwrap();
/// ```
pub fn adjust_window_rect_ex_copy(rect: impl Into<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>, ex_style: impl Into<WindowStyleExtended>) -> Result<Rect, Error> {
    let mut rect = rect.into();
    adjust_window_rect_ex(&mut rect, style, menu, ex_style)?;
    Ok(rect)
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrectexfordpi)\]
/// AdjustWindowRectExForDpi
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      **In:** The desired client area.  **Out:** the required outer area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
/// *   `ex_style`  The [extended window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/extended-window-styles) of the window in question.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let mut area = Rect { left: 0, right: 800, top: 0, bottom: 600 };
/// adjust_window_rect_ex_for_dpi(&mut area, WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW, 100).unwrap();
/// #
/// # let mut area = Rect { left: 0, right: -800, top: 0, bottom: 600 };
/// # adjust_window_rect_ex_for_dpi(&mut area, WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW, 100).unwrap();
/// ```
pub fn adjust_window_rect_ex_for_dpi(rect: &mut impl AsMut<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>, ex_style: impl Into<WindowStyleExtended>, dpi: u32) -> Result<(), Error> {
    fn_context!(adjust_window_rect_ex_for_dpi => AdjustWindowRectExForDpi);
    fn_succeeded!(unsafe { AdjustWindowRectExForDpi(rect.as_mut().as_mut(), style.into().into(), menu.into() as BOOL, ex_style.into().into(), dpi) })
}

/// \[[learn.microsoft.com](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-adjustwindowrectexfordpi)\]
/// AdjustWindowRectExForDpi
///
/// Calculates the outer window size required for a given client area.
///
/// ### Arguments
/// *   `rect`      The desired client area.
/// *   `style`     The [window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/window-styles) of the window in question.
/// *   `menu`      Use `true` if the window in question has a menu, `false` otherwise.
/// *   `ex_style`  The [extended window style](https://learn.microsoft.com/en-us/windows/win32/winmsg/extended-window-styles) of the window in question.
///
/// ### Returns
/// *   The required outer window area.
///
/// ### Errors
/// *   ???
///
/// ### Example
/// ```rust
/// # use hwnd::*;
/// let area = adjust_window_rect_ex_for_dpi_copy(
///     Rect { left: 0, right: 800, top: 0, bottom: 600 },
///     WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW, 100,
/// ).unwrap();
/// #
/// # let area = adjust_window_rect_ex_for_dpi_copy(
/// #     Rect { left: 0, right:-800, top: 0, bottom: 600 },
/// #     WS::OVERLAPPEDWINDOW, false, WS_EX::TOOLWINDOW, 100,
/// # ).unwrap();
/// ```
pub fn adjust_window_rect_ex_for_dpi_copy(rect: impl Into<Rect>, style: impl Into<WindowStyle>, menu: impl Into<bool>, ex_style: impl Into<WindowStyleExtended>, dpi: u32) -> Result<Rect, Error> {
    let mut rect = rect.into();
    adjust_window_rect_ex_for_dpi(&mut rect, style, menu, ex_style, dpi)?;
    Ok(rect)
}