Struct winsafe::HWND

pub struct HWND(/* private fields */);

Available on crate feature user only.

Handle to a window.

Trait Implementations

impl Debug for HWND

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for HWND

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Handle for HWND

const NULL: Self = _

Available on crate feature kernel only.

The null, uninitialized handle; equals to 0.

const INVALID: Self = _

Available on crate feature kernel only.

The invalid handle; equals to -1.

unsafe fn from_ptr(p: *mut c_void) -> Self

Available on crate feature kernel only.

Creates a new handle object by wrapping a pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Available on crate feature kernel only.

Returns a mutable reference to the underlying raw pointer.

unsafe fn raw_copy(&self) -> Self

Available on crate feature kernel only.

Returns a raw copy of the underlying handle pointer.

fn ptr(&self) -> *mut c_void

Available on crate feature kernel only.

Returns the underlying raw pointer.

fn as_opt(&self) -> Option<&Self>

Available on crate feature kernel only.

Returns None if the handle is null or invalid, otherwise returns Some(&self).

impl Hash for HWND

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for HWND

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HWND

fn eq(&self, other: &HWND) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UpperHex for HWND

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl comctl_Hwnd for HWND

Available on crate feature comctl only.

fn DefSubclassProc<M>(&self, msg: M) -> M::RetType

where M: MsgSend,

DefSubclassProc function.

fn InitializeFlatSB(&self) -> HrResult<()>

InitializeFlatSB function.

fn RemoveWindowSubclass( &self, subclass_func: SUBCLASSPROC, subclass_id: usize ) -> SysResult<()>

RemoveWindowSubclass function.

unsafe fn SetWindowSubclass( &self, subclass_proc: SUBCLASSPROC, subclass_id: usize, ref_data: usize ) -> SysResult<()>

SetWindowSubclass function.

fn TaskDialog( &self, hinstance: Option<&HINSTANCE>, window_title: Option<&str>, main_instruction: Option<&str>, content: Option<&str>, common_buttons: TDCBF, icon: IconRes ) -> HrResult<DLGID>

TaskDialog function.

fn UninitializeFlatSB(&self) -> HrResult<()>

UninitializeFlatSB function.

impl dwm_Hwnd for HWND

Available on crate feature dwm only.

fn DwmExtendFrameIntoClientArea(&self, margins_inset: &MARGINS) -> HrResult<()>

DwmExtendFrameIntoClientArea function.

fn DwmInvalidateIconicBitmaps(&self) -> HrResult<()>

DwmInvalidateIconicBitmaps function.

fn DwmSetIconicLivePreviewBitmap( &self, hbmp: HBITMAP, pt_client: Option<POINT>, sit_flags: Option<DWM_SIT> ) -> HrResult<()>

DwmSetIconicLivePreviewBitmap function.

fn DwmSetIconicThumbnail( &self, hbmp: HBITMAP, sit_flags: Option<DWM_SIT> ) -> HrResult<()>

DwmSetIconicThumbnail function.

impl ole_Hwnd for HWND

Available on crate feature ole only.

fn RegisterDragDrop(&self, drop_target: &impl ole_IDropTarget) -> HrResult<()>

RegisterDragDrop function.

fn RevokeDragDrop(&self) -> HrResult<()>

RevokeDragDrop function.

impl shell_Hwnd for HWND

Available on crate feature shell only.

fn DragAcceptFiles(&self, accept: bool)

DragAcceptFiles function.

fn ShellAbout( &self, title_bar: &str, first_line: Option<&str>, other_stuff: Option<&str>, hicon: Option<&HICON> ) -> SysResult<()>

ShellAbout function.

fn ShellExecute( &self, operation: &str, file: &str, parameters: Option<&str>, directory: Option<&str>, show_cmd: SW ) -> Result<HINSTANCE, SE_ERR>

ShellExecute function.

impl user_Hwnd for HWND

const BROADCAST: HWND = _

Represents all top-level windows in HWND::PostMessage and HWND::SendMessage.

const DESKTOP: HWND = _

Represents the desktop window in HWND::GetDC.

fn hinstance(&self) -> HINSTANCE

Calls HWND::GetWindowLongPtr to retrieve the window HINSTANCE.

fn is_dialog(&self) -> bool

Calls HWND::GetClassLongPtr to retrieve the class atom and check whether the window was created from a dialog resource.

fn styles(&self) -> WS

Calls HWND::GetWindowLongPtr to retrieve the window styles.

fn styles_ex(&self) -> WS_EX

Calls HWND::GetWindowLongPtr to retrieve the extended window styles.

fn ArrangeIconicWindows(&self) -> SysResult<u32>

ArrangeIconicWindows function.

fn BeginPaint(&self) -> SysResult<EndPaintGuard<'_, Self>>

BeginPaint function.

fn BringWindowToTop(&self) -> SysResult<()>

BringWindowToTop function.

fn ChildWindowFromPoint(&self, pt: POINT) -> Option<HWND>

ChildWindowFromPoint function.

fn ClientToScreen(&self, pt: &mut POINT) -> SysResult<()>

ClientToScreen function.

fn ClientToScreenRc(&self, rc: &mut RECT) -> SysResult<()>

ClientToScreen method for a RECT.

fn CloseWindow(&self) -> SysResult<()>

CloseWindow function.

unsafe fn CreateWindowEx( ex_style: WS_EX, class_name: AtomStr, title: Option<&str>, style: WS, pos: POINT, size: SIZE, hwnd_parent: Option<&HWND>, hmenu: IdMenu<'_>, hinstance: &HINSTANCE, lparam: Option<isize> ) -> SysResult<HWND>

CreateWindowEx function.

fn DefWindowProc<M>(&self, msg: M) -> M::RetType

where M: MsgSend,

DefWindowProc function.

fn DestroyWindow(&self) -> SysResult<()>

DestroyWindow function.

fn DragDetect(&self, pt: POINT) -> bool

DragDetect function.

fn DrawCaption( &self, hdc: &HDC, rect: &RECT, flags: Option<DC> ) -> SysResult<()>

DrawCaption function.

fn DrawMenuBar(&self) -> SysResult<()>

DrawMenuBar function.

fn EnableScrollBar(&self, sb_flags: SBB, arrows: ESB) -> SysResult<()>

EnableScrollBar function.

fn EnableWindow(&self, enable: bool) -> bool

EnableWindow function.

fn EndDialog(&self, result: isize) -> SysResult<()>

EndDialog function.

fn EnumChildWindows<F>(&self, func: F)

where F: FnMut(HWND) -> bool,

EnumChildWindows function.

fn FindWindow( class_name: Option<AtomStr>, title: Option<&str> ) -> SysResult<Option<HWND>>

FindWindow function.

fn FindWindowEx( &self, hwnd_child_after: Option<&HWND>, class_name: AtomStr, title: Option<&str> ) -> SysResult<Option<HWND>>

FindWindowEx function.

fn GetActiveWindow() -> Option<HWND>

GetActiveWindow function.

fn GetAltTabInfo( &self, item: Option<u32>, ati: &mut ALTTABINFO, sz_item_text: Option<u32> ) -> SysResult<String>

GetAltTabInfo function.

fn GetAncestor(&self, flags: GA) -> Option<HWND>

GetAncestor function.

fn GetCapture() -> Option<HWND>

GetCapture function.

fn GetClassLongPtr(&self, index: GCLP) -> usize

GetClassLongPtr function.

fn GetClassName(&self) -> SysResult<String>

GetClassName function.

fn GetClientRect(&self) -> SysResult<RECT>

GetClientRect function.

fn GetDC(&self) -> SysResult<ReleaseDCGuard<'_, Self>>

GetDC function.

fn GetDesktopWindow() -> HWND

GetDesktopWindow function.

fn GetDialogDpiChangeBehavior(&self) -> SysResult<DDC>

GetDialogDpiChangeBehavior function.

fn GetDlgCtrlID(&self) -> SysResult<u16>

GetDlgCtrlID function.

fn GetDlgItem(&self, ctrl_id: u16) -> SysResult<HWND>

GetDlgItem function.

fn GetDpiForWindow(&self) -> u32

GetDpiForWindow function.

fn GetFocus() -> Option<HWND>

GetFocus function.

fn GetForegroundWindow() -> Option<HWND>

GetForegroundWindow function.

fn GetLastActivePopup(&self) -> Option<HWND>

GetLastActivePopup function.

fn GetMenu(&self) -> Option<HMENU>

GetMenu function.

fn GetMenuBarInfo( &self, obj_id: OBJID, item_id: u32, mbi: &mut MENUBARINFO ) -> SysResult<()>

GetMenuBarInfo function.

fn GetMenuItemRect(&self, hmenu: &HMENU, item_pos: u32) -> SysResult<RECT>

GetMenuItemRect function.

fn GetNextDlgGroupItem( &self, hwnd_ctrl: &HWND, previous: bool ) -> SysResult<HWND>

GetNextDlgGroupItem function.

fn GetNextDlgTabItem(&self, hwnd_ctrl: &HWND, previous: bool) -> SysResult<HWND>

GetNextDlgTabItem function.

fn GetParent(&self) -> SysResult<HWND>

GetParent function.

fn GetScrollInfo(&self, bar: SBB, si: &mut SCROLLINFO) -> SysResult<()>

GetScrollInfo function.

fn GetScrollPos(&self, bar: SBB) -> SysResult<i32>

GetScrollPos function.

fn GetShellWindow() -> Option<HWND>

GetShellWindow function.

fn GetSystemMenu(&self, revert: bool) -> Option<HMENU>

GetSystemMenu function.

fn GetTopWindow(&self) -> SysResult<Option<HWND>>

GetTopWindow function.

fn GetUpdateRect(&self, erase: bool) -> Option<RECT>

GetUpdateRect function.

fn GetUpdateRgn(&self, hrgn: &HRGN, erase: bool) -> SysResult<REGION>

GetUpdateRgn function.

fn GetWindow(&self, cmd: GW) -> SysResult<HWND>

GetWindow function.

fn GetWindowDC(&self) -> SysResult<ReleaseDCGuard<'_, Self>>

GetWindowDC function.

fn GetWindowDisplayAffinity(&self) -> SysResult<WDA>

GetWindowDisplayAffinity function.

fn GetWindowDpiHostingBehavior(&self) -> DPI_HOSTING_BEHAVIOR

GetWindowDpiHostingBehavior function.

fn GetWindowInfo(&self, wi: &mut WINDOWINFO) -> SysResult<()>

GetWindowInfo function.

fn GetWindowLongPtr(&self, index: GWLP) -> isize

GetWindowLong function (x32) or GetWindowLongPtr function (x64).

fn GetWindowModuleFileName(&self) -> String

GetWindowModuleFileName function.

fn GetWindowPlacement(&self, wp: &mut WINDOWPLACEMENT) -> SysResult<()>

GetWindowPlacement function.

fn GetWindowRect(&self) -> SysResult<RECT>

GetWindowRect function.

fn GetWindowRgn(&self, hrgn: &HRGN) -> SysResult<REGION>

GetWindowRgn function.

fn GetWindowRgnBox(&self) -> SysResult<(RECT, REGION)>

GetWindowRgnBox function.

fn GetWindowText(&self) -> SysResult<String>

GetWindowText function.

fn GetWindowTextLength(&self) -> SysResult<i32>

GetWindowTextLength function.

fn GetWindowThreadProcessId(&self) -> (u32, u32)

GetWindowThreadProcessId function.

fn HiliteMenuItem(&self, hmenu: &HMENU, id_or_pos: IdPos, hilite: bool) -> bool

HiliteMenuItem function.

fn InheritWindowMonitor(&self, hwnd_inherit: &HWND) -> SysResult<()>

InheritWindowMonitor function.

fn InvalidateRect(&self, rc: Option<&RECT>, erase: bool) -> SysResult<()>

InvalidateRect function.

fn InvalidateRgn(&self, hrgn: &HRGN, erase: bool)

InvalidateRgn function.

fn IsChild(&self, hwnd_possible_child: &HWND) -> bool

IsChild function.

fn IsDialogMessage(&self, msg: &mut MSG) -> bool

IsDialogMessage function.

fn IsIconic(&self) -> bool

IsIconic function.

fn IsWindow(&self) -> bool

IsWindow function.

fn IsWindowEnabled(&self) -> bool

IsWindowEnabled function.

fn IsWindowUnicode(&self) -> bool

IsWindowUnicode function.

fn IsWindowVisible(&self) -> bool

IsWindowVisible function.

fn IsZoomed(&self) -> bool

IsZoomed function.

fn KillTimer(&self, event_id: usize) -> SysResult<()>

KillTimer function.

fn LockWindowUpdate(&self) -> SysResult<()>

LockWindowUpdate function.

fn LogicalToPhysicalPoint(&self, pt: *mut POINT) -> SysResult<()>

LogicalToPhysicalPoint function.

fn MapDialogRect(&self, rc: &mut RECT) -> SysResult<()>

MapDialogRect function.

fn MapWindowPoints( &self, hdest: &HWND, points: PtsRc<'_> ) -> SysResult<(i16, i16)>

MapWindowPoints function.

fn MessageBox(&self, text: &str, caption: &str, flags: MB) -> SysResult<DLGID>

MessageBox function.

fn MonitorFromWindow(&self, flags: MONITOR) -> HMONITOR

MonitorFromWindow function.

fn MoveWindow(&self, pos: POINT, size: SIZE, repaint: bool) -> SysResult<()>

MoveWindow function.

fn OpenClipboard(&self) -> SysResult<CloseClipboardGuard<'_>>

OpenClipboard function.

fn PostMessage<M>(&self, msg: M) -> SysResult<()>

where M: MsgSend + Send + Copy + 'static,

PostMessage function.

fn RealChildWindowFromPoint( &self, pt_parent_client_coords: POINT ) -> Option<HWND>

RealChildWindowFromPoint function.

fn RealGetWindowClass(&self) -> SysResult<String>

RealGetWindowClass function.

fn RedrawWindow( &self, rc_update: &RECT, hrgn_update: &HRGN, flags: RDW ) -> SysResult<()>

RedrawWindow function.

fn ScreenToClient(&self, pt: &mut POINT) -> SysResult<()>

ScreenToClient function.

fn ScreenToClientRc(&self, rc: &mut RECT) -> SysResult<()>

ScreenToClient method for a RECT.

fn ScrollWindowEx( &self, dx: i32, dy: i32, client_area_portion: Option<&RECT>, clipping_rect: Option<&RECT>, hrgn_update: Option<&HRGN>, updated_boundaries: Option<&mut RECT>, flags: SCROLLW ) -> SysResult<REGION>

ScrollWindowEx function.

fn SendMessage<M>(&self, msg: M) -> M::RetType

where M: MsgSend,

SendMessage function.

fn SendMessageTimeout<M>( &self, msg: M, flags: SMTO, timeout_ms: u32 ) -> SysResult<M::RetType>

where M: MsgSend,

SendMessageTimeout function.

fn SetActiveWindow(&self) -> SysResult<HWND>

SetActiveWindow function.

fn SetCapture(&self) -> ReleaseCaptureGuard<'_, Self>

SetCapture function.

fn SetDialogDpiChangeBehavior(&self, mask: DDC, values: DDC) -> SysResult<()>

SetDialogDpiChangeBehavior function.

fn SetFocus(&self) -> Option<HWND>

SetFocus function.

fn SetForegroundWindow(&self) -> bool

SetForegroundWindow function.

fn SetLayeredWindowAttributes( &self, transparency_color_key: COLORREF, alpha: u8, flags: LWA ) -> SysResult<()>

SetLayeredWindowAttributes function.

fn SetMenu(&self, hmenu: &HMENU) -> SysResult<()>

SetMenu function.

fn SetParent(&self, hwnd_new_parent: &HWND) -> SysResult<Option<HWND>>

SetParent function.

fn SetScrollInfo(&self, bar: SBB, si: &SCROLLINFO, redraw: bool) -> i32

SetScrollInfo function.

fn SetScrollPos(&self, b: SBB, pos: i32, redraw: bool) -> SysResult<i32>

SetScrollPos function.

fn SetScrollRange( &self, bar: SBB, min_pos: i32, max_pos: i32, redraw: bool ) -> SysResult<()>

SetScrollRange function.

fn SetTimer( &self, event_id: usize, elapse_ms: u32, timer_func: Option<TIMERPROC> ) -> SysResult<usize>

This method returns the timer ID, to be passed to HWND::KillTimer.

fn SetWindowDisplayAffinity(&self, affinity: WDA) -> SysResult<()>

SetWindowDisplayAffinity function.

fn SetWindowLongPtr(&self, index: GWLP, new_long: isize) -> isize

SetWindowLongPtr function.

fn SetWindowPlacement(&self, wp: &WINDOWPLACEMENT) -> SysResult<()>

SetWindowPlacement function.

fn SetWindowPos( &self, hwnd_insert_after: HwndPlace, pos: POINT, size: SIZE, flags: SWP ) -> SysResult<()>

SetWindowPos function.

fn SetWindowRgn(&self, hrgn: &HRGN, redraw: bool) -> SysResult<()>

SetWindowRgn function.

fn SetWindowText(&self, text: &str) -> SysResult<()>

SetWindowText function.

fn ShowCaret(&self) -> SysResult<()>

ShowCaret function.

fn ShowOwnedPopups(&self, show: bool) -> SysResult<()>

ShowOwnedPopups function.

fn ShowWindow(&self, show_cmd: SW) -> bool

ShowWindow function.

fn ShowWindowAsync(&self, show_cmd: SW) -> SysResult<()>

ShowWindowAsync function.

fn TileWindows( &self, how: MDITILE, rect: Option<RECT>, kids: Option<&[&HWND]> ) -> SysResult<u16>

TileWindows function.

fn TranslateAccelerator( &self, haccel_table: &HACCEL, msg: &mut MSG ) -> SysResult<()>

TranslateAccelerator function.

fn UpdateLayeredWindow( &self, hdc_dest: Option<&HDC>, pt_dest: Option<&POINT>, size: Option<&SIZE>, hdc_src: Option<&HDC>, pt_src: Option<&POINT>, key: COLORREF, blend: &BLENDFUNCTION, flags: ULW ) -> SysResult<()>

UpdateLayeredWindow function.

fn UpdateWindow(&self) -> SysResult<()>

UpdateWindow function.

fn ValidateRect(&self, rc: &RECT) -> SysResult<()>

ValidateRect function.

fn ValidateRgn(&self, hrgn: &HRGN) -> SysResult<()>

ValidateRgn function.

fn WindowFromPhysicalPoint(pt: POINT) -> Option<HWND>

WindowFromPhysicalPoint function.

fn WindowFromPoint(pt: POINT) -> Option<HWND>

WindowFromPoint function.

fn WinHelp(&self, help_file: &str, cmd: HELPW, data: usize) -> SysResult<()>

WinHelp function.

impl uxtheme_Hwnd for HWND

Available on crate feature uxtheme only.

fn OpenThemeData(&self, class_list: &str) -> Option<CloseThemeDataGuard>

OpenThemeData function.

impl Eq for HWND

impl Send for HWND

impl StructuralPartialEq for HWND