Struct cat_engine_basement::windows::core::window::Window

pub struct Window;

Implementations

impl Window

pub const fn new() -> Window

impl Window

pub unsafe fn create<P>(
    &self,
    class_name: *const u16,
    window_name: *const u16,
    style: u32,
    extended_style: u32,
    [x, y, width, height]: [i32; 4],
    parent_window: HWND,
    menu: HMENU,
    instance: HINSTANCE,
    create_parameters: *mut P
) -> HWND

pub unsafe fn destroy(&self, window: HWND) -> bool

Destroys the specified window.

The function sends WM_DESTROY and WM_NCDESTROY messages to the window to deactivate it and remove the keyboard focus from it. The function also destroys the window’s menu, flushes the thread message queue, destroys timers, removes clipboard ownership, and breaks the clipboard viewer chain (if the window is at the top of the viewer chain).

If the specified window is a parent or owner window, Window::destroy automatically destroys the associated child or owned windows when it destroys the parent or owner window. The function first destroys child or owned windows, and then it destroys the parent or owner window.

Window::destroy also destroys modeless dialog boxes created by the CreateDialog function.

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.

A thread cannot use Window::destroy to destroy a window created by a different thread.

If the window being destroyed is a child window that does not have the WS_EX_NOPARENTNOTIFY style, a WM_PARENTNOTIFY message is sent to the parent.

pub unsafe fn get_window_rectangle(
    &self,
    window: HWND,
    rectangle: &mut [i32; 4]
) -> bool

Retrieves the dimensions of the bounding rectangle of the specified window. The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen.

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.

In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words, the pixel at (right, bottom) lies immediately outside the rectangle.

Window::get_window_rectangle is virtualized for DPI.

In Windows Vista and later, the Window Rect now includes the area occupied by the drop shadow.

Calling Window::get_window_rectangle will have different behavior depending on whether the window has ever been shown or not. If the window has not been shown before, Window::get_window_rectangle will not include the area of the drop shadow.

To get the window bounds excluding the drop shadow, use DwmGetWindowAttribute, specifying DWMWA_EXTENDED_FRAME_BOUNDS. Note that unlike the Window Rect, the DWM Extended Frame Bounds are not adjusted for DPI. Getting the extended frame bounds can only be done after the window has been shown at least once.

pub unsafe fn get_client_rectangle(
    &self,
    window: HWND,
    rectangle: &mut [i32; 4]
) -> bool

Retrieves the coordinates of a window’s client area. The client coordinates specify the upper-left and lower-right corners of the client area. Because client coordinates are relative to the upper-left corner of a window’s client area, the coordinates of the upper-left corner are (0,0).

If the function succeeds, the return value is nonzero.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

In conformance with conventions for the RECT structure, the bottom-right coordinates of the returned rectangle are exclusive. In other words, the pixel at (right, bottom) lies immediately outside the rectangle.

pub unsafe fn set_window_position(
    &self,
    window: HWND,
    insert_after: HWND,
    [x, y, width, height]: [i32; 4],
    flag: u32
) -> bool

Changes the size, position, and Z order of a child, pop-up, or top-level window. These windows are ordered according to their appearance on the screen. The topmost window receives the highest rank and is the first window in the Z order.

If the function succeeds, the return value is nonzero. If the function fails, the return value is zero. To get extended error information, call GetLastError.

If you have changed certain window data using SetWindowLong, you must call SetWindowPos for the changes to take effect. Use the following combination for uFlags: SWP_NOMOVE | SWP_NOSIZE | SWP_NOZORDER | SWP_FRAMECHANGED.

A window can be made a topmost window either by setting the hWndInsertAfter parameter to HWND_TOPMOST and ensuring that the SWP_NOZORDER flag is not set, or by setting a window’s position in the Z order so that it is above any existing topmost windows. When a non-topmost window is made topmost, its owned windows are also made topmost. Its owners, however, are not changed.

If neither the SWP_NOACTIVATE nor SWP_NOZORDER flag is specified (that is, when the application requests that a window be simultaneously activated and its position in the Z order changed), the value specified in hWndInsertAfter is used only in the following circumstances.

Neither the HWND_TOPMOST nor HWND_NOTOPMOST flag is specified in hWndInsertAfter. The window identified by hWnd is not the active window. An application cannot activate an inactive window without also bringing it to the top of the Z order. Applications can change an activated window’s position in the Z order without restrictions, or it can activate a window and then move it to the top of the topmost or non-topmost windows. If a topmost window is repositioned to the bottom (HWND_BOTTOM) of the Z order or after any non-topmost window, it is no longer topmost. When a topmost window is made non-topmost, its owners and its owned windows are also made non-topmost windows.

A non-topmost window can own a topmost window, but the reverse cannot occur. Any window (for example, a dialog box) owned by a topmost window is itself made a topmost window, to ensure that all owned windows stay above their owner.

If an application is not in the foreground, and should be in the foreground, it must call the SetForegroundWindow function.

To use SetWindowPos to bring a window to the top, the process that owns the window must have SetForegroundWindow permission.

pub unsafe fn set_window_long_ptr(
    &self,
    window: HWND,
    index: WindowData,
    value: isize
) -> isize

Changes an attribute of the specified window. The function also sets a value at the specified offset in the extra window memory.

If the function succeeds, the return value is the previous value of the specified offset. If the function fails, the return value is zero. To get extended error information, call GetLastError. If the previous value is zero and the function succeeds, the return value is zero, but the function does not clear the last error information. To determine success or failure, clear the last error information by calling SetLastError with 0, then call Window::set_window_long_ptr. Function failure will be indicated by a return value of zero and a GetLastError resultthat is nonzero.

pub unsafe fn get_window_long_ptr(
    &self,
    window: HWND,
    index: WindowData
) -> isize

Retrieves information about the specified window. The function also retrieves the value at a specified offset into the extra window memory.

If the function succeeds, the return value is the requested value. If the function fails, the return value is zero. To get extended error information, call GetLastError. If SetWindowLong or SetWindowLongPtr has not been called previously, GetWindowLongPtr returns zero for values in the extra window or class memory.