Copyright	(c) Alastair Reid 1997-2003
License	BSD-style (see the file libraries/base/LICENSE)
Maintainer	Esa Ilari Vuokko <ei@vuokko.info>
Stability	provisional
Portability	portable
Safe Haskell	Trustworthy
Language	Haskell2010

Graphics.Win32.Window

Description

A collection of FFI declarations for interfacing with Win32.

Synopsis

type ClassName = LPCTSTR
mkClassName :: String -> ClassName
type ClassStyle = UINT
cS_VREDRAW :: ClassStyle
cS_HREDRAW :: ClassStyle
cS_OWNDC :: ClassStyle
cS_CLASSDC :: ClassStyle
cS_PARENTDC :: ClassStyle
cS_SAVEBITS :: ClassStyle
cS_DBLCLKS :: ClassStyle
cS_BYTEALIGNCLIENT :: ClassStyle
cS_BYTEALIGNWINDOW :: ClassStyle
cS_NOCLOSE :: ClassStyle
cS_GLOBALCLASS :: ClassStyle
type WNDCLASS = (ClassStyle, HINSTANCE, Maybe HICON, Maybe HCURSOR, Maybe HBRUSH, Maybe LPCTSTR, ClassName)
withWNDCLASS :: WNDCLASS -> (Ptr WNDCLASS -> IO a) -> IO a
genericWndProc_p :: FunPtr WindowClosure
registerClass :: WNDCLASS -> IO (Maybe ATOM)
c_RegisterClass :: Ptr WNDCLASS -> IO ATOM
unregisterClass :: ClassName -> HINSTANCE -> IO ()
type WindowStyle = DWORD
wS_OVERLAPPED :: WindowStyle
wS_POPUP :: WindowStyle
wS_CHILD :: WindowStyle
wS_CLIPSIBLINGS :: WindowStyle
wS_CLIPCHILDREN :: WindowStyle
wS_VISIBLE :: WindowStyle
wS_DISABLED :: WindowStyle
wS_MINIMIZE :: WindowStyle
wS_MAXIMIZE :: WindowStyle
wS_CAPTION :: WindowStyle
wS_BORDER :: WindowStyle
wS_DLGFRAME :: WindowStyle
wS_VSCROLL :: WindowStyle
wS_HSCROLL :: WindowStyle
wS_SYSMENU :: WindowStyle
type WindowStyleEx = DWORD
wS_THICKFRAME :: WindowStyle
wS_EX_DLGMODALFRAME :: WindowStyleEx
wS_MINIMIZEBOX :: WindowStyle
wS_EX_NOPARENTNOTIFY :: WindowStyleEx
wS_MAXIMIZEBOX :: WindowStyle
wS_EX_TOPMOST :: WindowStyleEx
wS_GROUP :: WindowStyle
wS_EX_ACCEPTFILES :: WindowStyleEx
wS_TABSTOP :: WindowStyle
wS_EX_TRANSPARENT :: WindowStyleEx
wS_OVERLAPPEDWINDOW :: WindowStyle
wS_EX_MDICHILD :: WindowStyleEx
wS_POPUPWINDOW :: WindowStyle
wS_EX_TOOLWINDOW :: WindowStyleEx
wS_CHILDWINDOW :: WindowStyle
wS_TILED :: WindowStyle
wS_EX_WINDOWEDGE :: WindowStyleEx
wS_EX_CLIENTEDGE :: WindowStyleEx
wS_ICONIC :: WindowStyle
wS_EX_CONTEXTHELP :: WindowStyleEx
wS_SIZEBOX :: WindowStyle
wS_EX_RIGHT :: WindowStyleEx
wS_TILEDWINDOW :: WindowStyle
wS_EX_LEFT :: WindowStyleEx
wS_EX_RTLREADING :: WindowStyleEx
wS_EX_LTRREADING :: WindowStyleEx
wS_EX_LEFTSCROLLBAR :: WindowStyleEx
cW_USEDEFAULT :: Pos
wS_EX_RIGHTSCROLLBAR :: WindowStyleEx
type Pos = Int
wS_EX_CONTROLPARENT :: WindowStyleEx
type MbPos = Maybe Pos
wS_EX_STATICEDGE :: WindowStyleEx
wS_EX_APPWINDOW :: WindowStyleEx
maybePos :: Maybe Pos -> Pos
wS_EX_OVERLAPPEDWINDOW :: WindowStyleEx
type WindowClosure = HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT
wS_EX_PALETTEWINDOW :: WindowStyleEx
mkWindowClosure :: WindowClosure -> IO (FunPtr WindowClosure)
mkCIntPtr :: FunPtr a -> CIntPtr
setWindowClosure :: HWND -> WindowClosure -> IO (Maybe (FunPtr WindowClosure))
c_SetWindowLongPtr :: HWND -> INT -> LONG_PTR -> IO LONG_PTR
c_GetWindowLongPtr :: HANDLE -> INT -> IO LONG_PTR
createWindow :: ClassName -> String -> WindowStyle -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe HWND -> Maybe HMENU -> HINSTANCE -> WindowClosure -> IO HWND
createWindowEx :: WindowStyle -> ClassName -> String -> WindowStyle -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe HWND -> Maybe HMENU -> HINSTANCE -> WindowClosure -> IO HWND
c_CreateWindowEx :: WindowStyle -> ClassName -> LPCTSTR -> WindowStyle -> Pos -> Pos -> Pos -> Pos -> HWND -> HMENU -> HINSTANCE -> LPVOID -> IO HWND
defWindowProc :: Maybe HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT
defWindowProcSafe :: Maybe HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT
c_DefWindowProc :: HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT
freeWindowProc :: HWND -> IO ()
getClientRect :: HWND -> IO RECT
c_GetClientRect :: HWND -> Ptr RECT -> IO Bool
getWindowRect :: HWND -> IO RECT
c_GetWindowRect :: HWND -> Ptr RECT -> IO Bool
invalidateRect :: Maybe HWND -> Maybe LPRECT -> Bool -> IO ()
c_InvalidateRect :: HWND -> LPRECT -> Bool -> IO Bool
screenToClient :: HWND -> POINT -> IO POINT
c_ScreenToClient :: HWND -> Ptr POINT -> IO Bool
clientToScreen :: HWND -> POINT -> IO POINT
c_ClientToScreen :: HWND -> Ptr POINT -> IO Bool
setWindowText :: HWND -> String -> IO ()
c_SetWindowText :: HWND -> LPCTSTR -> IO Bool
getWindowText :: HWND -> Int -> IO String
c_GetWindowText :: HWND -> LPTSTR -> Int -> IO Int
getWindowTextLength :: HWND -> IO Int
c_GetWindowTextLength :: HWND -> IO Int
type PAINTSTRUCT = (HDC, Bool, RECT)
type LPPAINTSTRUCT = Addr
sizeofPAINTSTRUCT :: DWORD
allocaPAINTSTRUCT :: (LPPAINTSTRUCT -> IO a) -> IO a
beginPaint :: HWND -> LPPAINTSTRUCT -> IO HDC
c_BeginPaint :: HWND -> LPPAINTSTRUCT -> IO HDC
endPaint :: HWND -> LPPAINTSTRUCT -> IO ()
type ShowWindowControl = DWORD
sW_HIDE :: ShowWindowControl
sW_SHOWNORMAL :: ShowWindowControl
sW_SHOWMINIMIZED :: ShowWindowControl
sW_SHOWMAXIMIZED :: ShowWindowControl
sW_MAXIMIZE :: ShowWindowControl
sW_SHOWNOACTIVATE :: ShowWindowControl
sW_SHOW :: ShowWindowControl
showWindow :: HWND -> ShowWindowControl -> IO Bool
sW_MINIMIZE :: ShowWindowControl
sW_SHOWMINNOACTIVE :: ShowWindowControl
isWindowVisible :: HWND -> IO Bool
sW_SHOWNA :: ShowWindowControl
sW_RESTORE :: ShowWindowControl
adjustWindowRect :: RECT -> WindowStyle -> Bool -> IO RECT
c_AdjustWindowRect :: Ptr RECT -> WindowStyle -> Bool -> IO Bool
adjustWindowRectEx :: RECT -> WindowStyle -> Bool -> WindowStyleEx -> IO RECT
c_AdjustWindowRectEx :: Ptr RECT -> WindowStyle -> Bool -> WindowStyleEx -> IO Bool
anyPopup :: IO Bool
arrangeIconicWindows :: HWND -> IO ()
c_ArrangeIconicWindows :: HWND -> IO Bool
beginDeferWindowPos :: Int -> IO HDWP
c_BeginDeferWindowPos :: Int -> IO HDWP
bringWindowToTop :: HWND -> IO ()
c_BringWindowToTop :: HWND -> IO Bool
childWindowFromPoint :: HWND -> POINT -> IO (Maybe HWND)
childWindowFromPointEx :: HWND -> POINT -> DWORD -> IO (Maybe HWND)
closeWindow :: HWND -> IO ()
deferWindowPos :: HDWP -> HWND -> HWND -> Int -> Int -> Int -> Int -> SetWindowPosFlags -> IO HDWP
c_DeferWindowPos :: HDWP -> HWND -> HWND -> Int -> Int -> Int -> Int -> SetWindowPosFlags -> IO HDWP
destroyWindow :: HWND -> IO ()
c_DestroyWindow :: HWND -> IO Bool
endDeferWindowPos :: HDWP -> IO ()
c_EndDeferWindowPos :: HDWP -> IO Bool
findWindow :: Maybe String -> Maybe String -> IO (Maybe HWND)
findWindowByName :: String -> IO (Maybe HWND)
c_FindWindow :: LPCTSTR -> LPCTSTR -> IO HWND
findWindowEx :: Maybe HWND -> Maybe HWND -> Maybe String -> Maybe String -> IO (Maybe HWND)
c_FindWindowEx :: HWND -> HWND -> LPCTSTR -> LPCTSTR -> IO HWND
flashWindow :: HWND -> Bool -> IO Bool
moveWindow :: HWND -> Int -> Int -> Int -> Int -> Bool -> IO ()
c_MoveWindow :: HWND -> Int -> Int -> Int -> Int -> Bool -> IO Bool
getDesktopWindow :: IO HWND
getForegroundWindow :: IO HWND
getParent :: HWND -> IO HWND
c_GetParent :: HWND -> IO HWND
getTopWindow :: HWND -> IO HWND
c_GetTopWindow :: HWND -> IO HWND
type SetWindowPosFlags = UINT
sWP_NOSIZE :: SetWindowPosFlags
sWP_NOMOVE :: SetWindowPosFlags
sWP_NOZORDER :: SetWindowPosFlags
sWP_NOREDRAW :: SetWindowPosFlags
sWP_NOACTIVATE :: SetWindowPosFlags
sWP_FRAMECHANGED :: SetWindowPosFlags
sWP_SHOWWINDOW :: SetWindowPosFlags
sWP_HIDEWINDOW :: SetWindowPosFlags
sWP_NOCOPYBITS :: SetWindowPosFlags
sWP_NOOWNERZORDER :: SetWindowPosFlags
type GetDCExFlags = DWORD
sWP_NOSENDCHANGING :: SetWindowPosFlags
dCX_WINDOW :: GetDCExFlags
sWP_DRAWFRAME :: SetWindowPosFlags
dCX_CACHE :: GetDCExFlags
sWP_NOREPOSITION :: SetWindowPosFlags
dCX_CLIPCHILDREN :: GetDCExFlags
dCX_CLIPSIBLINGS :: GetDCExFlags
dCX_PARENTCLIP :: GetDCExFlags
dCX_EXCLUDERGN :: GetDCExFlags
dCX_INTERSECTRGN :: GetDCExFlags
getDCEx :: HWND -> HRGN -> GetDCExFlags -> IO HDC
dCX_LOCKWINDOWUPDATE :: GetDCExFlags
c_GetDCEx :: HWND -> PRGN -> GetDCExFlags -> IO HDC
getDC :: Maybe HWND -> IO HDC
c_GetDC :: HWND -> IO HDC
getWindowDC :: Maybe HWND -> IO HDC
c_GetWindowDC :: HWND -> IO HDC
releaseDC :: Maybe HWND -> HDC -> IO ()
c_ReleaseDC :: HWND -> HDC -> IO Bool
getDCOrgEx :: HDC -> IO POINT
c_GetDCOrgEx :: HDC -> Ptr POINT -> IO Bool
hideCaret :: HWND -> IO ()
c_HideCaret :: HWND -> IO Bool
showCaret :: HWND -> IO ()
c_ShowCaret :: HWND -> IO Bool
createCaret :: HWND -> HBITMAP -> Maybe INT -> Maybe INT -> IO ()
c_CreateCaret :: HWND -> HBITMAP -> INT -> INT -> IO Bool
destroyCaret :: IO ()
c_DestroyCaret :: IO Bool
getCaretPos :: IO POINT
c_GetCaretPos :: Ptr POINT -> IO Bool
setCaretPos :: POINT -> IO ()
c_SetCaretPos :: LONG -> LONG -> IO Bool
type LPMSG = Addr
allocaMessage :: (LPMSG -> IO a) -> IO a
getMessage :: LPMSG -> Maybe HWND -> IO Bool
c_GetMessage :: LPMSG -> HWND -> UINT -> UINT -> IO LONG
peekMessage :: LPMSG -> Maybe HWND -> UINT -> UINT -> UINT -> IO ()
c_PeekMessage :: LPMSG -> HWND -> UINT -> UINT -> UINT -> IO LONG
translateMessage :: LPMSG -> IO BOOL
updateWindow :: HWND -> IO ()
c_UpdateWindow :: HWND -> IO Bool
dispatchMessage :: LPMSG -> IO LONG
sendMessage :: HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT

Documentation

type ClassName = LPCTSTR Source #

mkClassName :: String -> ClassName Source #

type ClassStyle = UINT Source #

cS_VREDRAW :: ClassStyle Source #

cS_HREDRAW :: ClassStyle Source #

cS_OWNDC :: ClassStyle Source #

cS_CLASSDC :: ClassStyle Source #

cS_PARENTDC :: ClassStyle Source #

cS_SAVEBITS :: ClassStyle Source #

cS_DBLCLKS :: ClassStyle Source #

cS_BYTEALIGNCLIENT :: ClassStyle Source #

cS_BYTEALIGNWINDOW :: ClassStyle Source #

cS_NOCLOSE :: ClassStyle Source #

cS_GLOBALCLASS :: ClassStyle Source #

type WNDCLASS = (ClassStyle, HINSTANCE, Maybe HICON, Maybe HCURSOR, Maybe HBRUSH, Maybe LPCTSTR, ClassName) Source #

withWNDCLASS :: WNDCLASS -> (Ptr WNDCLASS -> IO a) -> IO a Source #

genericWndProc_p :: FunPtr WindowClosure Source #

registerClass :: WNDCLASS -> IO (Maybe ATOM) Source #

c_RegisterClass :: Ptr WNDCLASS -> IO ATOM Source #

unregisterClass :: ClassName -> HINSTANCE -> IO () Source #

type WindowStyle = DWORD Source #

wS_OVERLAPPED :: WindowStyle Source #

wS_POPUP :: WindowStyle Source #

wS_CHILD :: WindowStyle Source #

wS_CLIPSIBLINGS :: WindowStyle Source #

wS_CLIPCHILDREN :: WindowStyle Source #

wS_VISIBLE :: WindowStyle Source #

wS_DISABLED :: WindowStyle Source #

wS_MINIMIZE :: WindowStyle Source #

wS_MAXIMIZE :: WindowStyle Source #

wS_CAPTION :: WindowStyle Source #

wS_BORDER :: WindowStyle Source #

wS_DLGFRAME :: WindowStyle Source #

wS_VSCROLL :: WindowStyle Source #

wS_HSCROLL :: WindowStyle Source #

wS_SYSMENU :: WindowStyle Source #

type WindowStyleEx = DWORD Source #

wS_THICKFRAME :: WindowStyle Source #

wS_EX_DLGMODALFRAME :: WindowStyleEx Source #

wS_MINIMIZEBOX :: WindowStyle Source #

wS_EX_NOPARENTNOTIFY :: WindowStyleEx Source #

wS_MAXIMIZEBOX :: WindowStyle Source #

wS_EX_TOPMOST :: WindowStyleEx Source #

wS_GROUP :: WindowStyle Source #

wS_EX_ACCEPTFILES :: WindowStyleEx Source #

wS_TABSTOP :: WindowStyle Source #

wS_EX_TRANSPARENT :: WindowStyleEx Source #

wS_OVERLAPPEDWINDOW :: WindowStyle Source #

wS_EX_MDICHILD :: WindowStyleEx Source #

wS_POPUPWINDOW :: WindowStyle Source #

wS_EX_TOOLWINDOW :: WindowStyleEx Source #

wS_CHILDWINDOW :: WindowStyle Source #

wS_TILED :: WindowStyle Source #

wS_EX_WINDOWEDGE :: WindowStyleEx Source #

wS_EX_CLIENTEDGE :: WindowStyleEx Source #

wS_ICONIC :: WindowStyle Source #

wS_EX_CONTEXTHELP :: WindowStyleEx Source #

wS_SIZEBOX :: WindowStyle Source #

wS_EX_RIGHT :: WindowStyleEx Source #

wS_TILEDWINDOW :: WindowStyle Source #

wS_EX_LEFT :: WindowStyleEx Source #

wS_EX_RTLREADING :: WindowStyleEx Source #

wS_EX_LTRREADING :: WindowStyleEx Source #

wS_EX_LEFTSCROLLBAR :: WindowStyleEx Source #

cW_USEDEFAULT :: Pos Source #

wS_EX_RIGHTSCROLLBAR :: WindowStyleEx Source #

type Pos = Int Source #

wS_EX_CONTROLPARENT :: WindowStyleEx Source #

type MbPos = Maybe Pos Source #

wS_EX_STATICEDGE :: WindowStyleEx Source #

wS_EX_APPWINDOW :: WindowStyleEx Source #

maybePos :: Maybe Pos -> Pos Source #

wS_EX_OVERLAPPEDWINDOW :: WindowStyleEx Source #

type WindowClosure = HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT Source #

wS_EX_PALETTEWINDOW :: WindowStyleEx Source #

mkWindowClosure :: WindowClosure -> IO (FunPtr WindowClosure) Source #

mkCIntPtr :: FunPtr a -> CIntPtr Source #

setWindowClosure :: HWND -> WindowClosure -> IO (Maybe (FunPtr WindowClosure)) Source #

The standard C wndproc for every window class registered by registerClass is a C function pointer provided with this library. It in turn delegates to a Haskell function pointer stored in gWLP_USERDATA. This action creates that function pointer. All Haskell function pointers must be freed in order to allow the objects they close over to be garbage collected. Consequently, if you are replacing a window closure previously set via this method or indirectly with createWindow or createWindowEx you must free it. This action returns a function pointer to the old window closure for you to free. The current window closure is freed automatically by defWindowProc when it receives wM_NCDESTROY.

c_SetWindowLongPtr :: HWND -> INT -> LONG_PTR -> IO LONG_PTR Source #

c_GetWindowLongPtr :: HANDLE -> INT -> IO LONG_PTR Source #

createWindow :: ClassName -> String -> WindowStyle -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe HWND -> Maybe HMENU -> HINSTANCE -> WindowClosure -> IO HWND Source #

Creates a window with a default extended window style. If you create many windows over the life of your program, WindowClosure may leak memory. Be sure to delegate to defWindowProc for wM_NCDESTROY and see defWindowProc and setWindowClosure for details.

createWindowEx :: WindowStyle -> ClassName -> String -> WindowStyle -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe Pos -> Maybe HWND -> Maybe HMENU -> HINSTANCE -> WindowClosure -> IO HWND Source #

Creates a window and allows your to specify the extended window style. If you create many windows over the life of your program, WindowClosure may leak memory. Be sure to delegate to defWindowProc for wM_NCDESTROY and see defWindowProc and setWindowClosure for details.

c_CreateWindowEx :: WindowStyle -> ClassName -> LPCTSTR -> WindowStyle -> Pos -> Pos -> Pos -> Pos -> HWND -> HMENU -> HINSTANCE -> LPVOID -> IO HWND Source #

defWindowProc :: Maybe HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT Source #

Delegates to the Win32 default window procedure. If you are using a window created by createWindow, createWindowEx or on which you have called setWindowClosure, please note that the window will leak memory once it is destroyed unless you call freeWindowProc when it receives wM_NCDESTROY. If you wish to do this, instead of using this function directly, you can delegate to defWindowProcSafe which will handle it for you. As an alternative, you can manually retrieve the window closure function pointer and free it after the window has been destroyed. Check the implementation of freeWindowProc for a guide.

defWindowProcSafe :: Maybe HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT Source #

Delegates to the standard default window procedure, but if it receives the wM_NCDESTROY message it first frees the window closure to allow the closure and any objects it closes over to be garbage collected. wM_NCDESTROY is the last message a window receives prior to being deleted.

c_DefWindowProc :: HWND -> WindowMessage -> WPARAM -> LPARAM -> IO LRESULT Source #

freeWindowProc :: HWND -> IO () Source #

Frees a function pointer to the window closure which has been set directly by setWindowClosure or indirectly by createWindowEx. You should call this function in your window closure's wM_NCDESTROY case unless you delegate that case to defWindowProc (e.g. as part of the default).

getClientRect :: HWND -> IO RECT Source #

c_GetClientRect :: HWND -> Ptr RECT -> IO Bool Source #

getWindowRect :: HWND -> IO RECT Source #

c_GetWindowRect :: HWND -> Ptr RECT -> IO Bool Source #

invalidateRect :: Maybe HWND -> Maybe LPRECT -> Bool -> IO () Source #

c_InvalidateRect :: HWND -> LPRECT -> Bool -> IO Bool Source #

screenToClient :: HWND -> POINT -> IO POINT Source #

c_ScreenToClient :: HWND -> Ptr POINT -> IO Bool Source #

clientToScreen :: HWND -> POINT -> IO POINT Source #

c_ClientToScreen :: HWND -> Ptr POINT -> IO Bool Source #

setWindowText :: HWND -> String -> IO () Source #

c_SetWindowText :: HWND -> LPCTSTR -> IO Bool Source #