MiniGUI API Reference (MiniGUI-Standalone)  v3.2.0
A mature and proven cross-platform GUI system for embedded and smart IoT devices
Macros | Functions
General window operations

Macros

#define SetFocus   SetFocusChild
 
#define GetFocus   GetFocusChild
 
#define GetForegroundWindow   GetActiveWindow
 
#define SetForegroundWindow   SetActiveWindow
 
#define GetWindowElementColor(iItem)   GetWindowElementPixelEx(HWND_NULL, (HDC)-1, iItem)
 Get window element color. More...
 

Functions

MG_EXPORT void GUIAPI UpdateWindow (HWND hWnd, BOOL bErase)
 Updates a window. More...
 
MG_EXPORT BOOL GUIAPI ShowWindow (HWND hWnd, int iCmdShow)
 Shows or hides a window. More...
 
MG_EXPORT BOOL GUIAPI EnableWindow (HWND hWnd, BOOL fEnable)
 Enables of disables a window. More...
 
MG_EXPORT BOOL GUIAPI IsWindowEnabled (HWND hWnd)
 Determines whether the specified window is enabled for mouse and keyboard input. More...
 
MG_EXPORT BOOL GUIAPI GetClientRect (HWND hWnd, PRECT prc)
 Retrives the client rectangle of a window. More...
 
MG_EXPORT gal_pixel GUIAPI GetWindowBkColor (HWND hWnd)
 Returns the current background color of a window. More...
 
MG_EXPORT gal_pixel GUIAPI SetWindowBkColor (HWND hWnd, gal_pixel new_bkcolor)
 Sets the background color of a window. More...
 
MG_EXPORT PLOGFONT GUIAPI GetWindowFont (HWND hWnd)
 Retrives the default font of a window. More...
 
MG_EXPORT PLOGFONT GUIAPI SetWindowFont (HWND hWnd, PLOGFONT pLogFont)
 Sets the default font of a window. More...
 
MG_EXPORT HCURSOR GUIAPI GetWindowCursor (HWND hWnd)
 Retrives the current cursor of a window. More...
 
MG_EXPORT HCURSOR GUIAPI SetWindowCursor (HWND hWnd, HCURSOR hNewCursor)
 Sets the current cursor of a window. More...
 
MG_EXPORT HICON GUIAPI GetWindowIcon (HWND hWnd)
 Retrives the current icon of a window. More...
 
MG_EXPORT HICON GUIAPI SetWindowIcon (HWND hWnd, HICON hIcon, BOOL bRedraw)
 Sets the current icon of a window. More...
 
MG_EXPORT DWORD GUIAPI GetWindowStyle (HWND hWnd)
 Retrives the style of a window. More...
 
MG_EXPORT DWORD GUIAPI GetWindowExStyle (HWND hWnd)
 Retrives the extended style of a window. More...
 
MG_EXPORT BOOL GUIAPI ExcludeWindowStyle (HWND hWnd, DWORD dwStyle)
 Removes the specific style of a window. More...
 
MG_EXPORT BOOL GUIAPI IncludeWindowStyle (HWND hWnd, DWORD dwStyle)
 Includes the specific style of a window. More...
 
MG_EXPORT BOOL GUIAPI ExcludeWindowExStyle (HWND hWnd, DWORD dwStyle)
 Removes the specific extended style of a window. More...
 
MG_EXPORT BOOL GUIAPI IncludeWindowExStyle (HWND hWnd, DWORD dwStyle)
 Includes the specific extended style of a window. More...
 
MG_EXPORT WNDPROC GUIAPI GetWindowCallbackProc (HWND hWnd)
 Retrives the callback procedure of a window. More...
 
MG_EXPORT WNDPROC GUIAPI SetWindowCallbackProc (HWND hWnd, WNDPROC newProc)
 Sets the callback procedure of a window. More...
 
MG_EXPORT DWORD GUIAPI GetWindowAdditionalData (HWND hWnd)
 Retrives the first additional data of a window. More...
 
MG_EXPORT DWORD GUIAPI SetWindowAdditionalData (HWND hWnd, DWORD newData)
 Sets the first additional data of a window. More...
 
MG_EXPORT DWORD GUIAPI GetWindowAdditionalData2 (HWND hWnd)
 Retrives the second additional data of a window. More...
 
MG_EXPORT DWORD GUIAPI SetWindowAdditionalData2 (HWND hWnd, DWORD newData)
 Sets the second additional data of a window. More...
 
MG_EXPORT DWORD GUIAPI GetWindowClassAdditionalData (HWND hWnd)
 Retrives the additional data of a control class. More...
 
MG_EXPORT DWORD GUIAPI SetWindowClassAdditionalData (HWND hWnd, DWORD newData)
 Sets the additional data of a control class. More...
 
MG_EXPORT const char *GUIAPI GetWindowCaption (HWND hWnd)
 Retrives the caption of a window. More...
 
MG_EXPORT BOOL GUIAPI SetWindowCaption (HWND hWnd, const char *spCaption)
 Sets the caption of a window. More...
 
MG_EXPORT BOOL GUIAPI InvalidateRect (HWND hWnd, const RECT *prc, BOOL bEraseBkgnd)
 Makes a rectangle region in the client area of a window invalid. More...
 
MG_EXPORT BOOL GUIAPI InvalidateRegion (HWND hWnd, const CLIPRGN *pRgn, BOOL bErase)
 Invalidates the client area within the specified region. More...
 
MG_EXPORT BOOL GUIAPI ValidateRect (HWND hWnd, const RECT *rect)
 Validates the client area within a rectangle by removing the rectangle from the update region of the specified window. More...
 
MG_EXPORT BOOL GUIAPI ValidateRegion (HWND hWnd, const CLIPRGN *pRgn)
 Validates the client area within a region by removing the region from the current update region of the specified window. More...
 
MG_EXPORT HDC GUIAPI BeginPaint (HWND hWnd)
 Prepares a window for painting. More...
 
MG_EXPORT void GUIAPI EndPaint (HWND hWnd, HDC hdc)
 Marks the end of painting in a window. More...
 
MG_EXPORT BOOL GUIAPI GetUpdateRect (HWND hWnd, RECT *update_rect)
 Retrives the bounding box of the update region of a window. More...
 
MG_EXPORT int GUIAPI GetUpdateRegion (HWND hWnd, PCLIPRGN pRgn)
 Copy the update region of a window to a region. More...
 
MG_EXPORT int GUIAPI ClientWidthToWindowWidthEx (DWORD dwStyle, int win_type, int cw)
 Calculates main window width from the width of the client area. More...
 
MG_EXPORT int GUIAPI ClientHeightToWindowHeightEx (DWORD dwStyle, int win_type, int ch, BOOL hasMenu)
 Calculates window height from the height of the client area. More...
 
MG_EXPORT BOOL GUIAPI AdjustWindowRectEx (RECT *pRect, DWORD dwStyle, BOOL bMenu, DWORD dwExStyle)
 Calculates the required size of the window rectangle based on the desired size of the client rectangle. More...
 
MG_EXPORT void GUIAPI ClientToScreen (HWND hWnd, int *x, int *y)
 Converts the client coordinates of a point to screen coordinates. More...
 
MG_EXPORT void GUIAPI ScreenToClient (HWND hWnd, int *x, int *y)
 Converts the screen coordinates of a point to client coordinates. More...
 
MG_EXPORT void GUIAPI ClientToWindow (HWND hWnd, int *x, int *y)
 Converts the client coordinates to the window coordinates. More...
 
MG_EXPORT void GUIAPI WindowToClient (HWND hWnd, int *x, int *y)
 Converts the window coordinates to client coordinates. More...
 
MG_EXPORT void GUIAPI WindowToScreen (HWND hWnd, int *x, int *y)
 Converts the window coordinates of a point to screen coordinates. More...
 
MG_EXPORT void GUIAPI ScreenToWindow (HWND hWnd, int *x, int *y)
 Converts the screen coordinates of a point to window coordinates. More...
 
MG_EXPORT BOOL GUIAPI IsMainWindow (HWND hWnd)
 Determines whether a window is a main window. More...
 
MG_EXPORT BOOL GUIAPI IsControl (HWND hWnd)
 Determines whether a window is a control. More...
 
MG_EXPORT BOOL GUIAPI IsWindow (HWND hWnd)
 Determines whether a window handle identifies an existing window. More...
 
MG_EXPORT BOOL GUIAPI IsDialog (HWND hWnd)
 Determines whether a window handle identifies a dialog window. More...
 
MG_EXPORT HWND GUIAPI GetParent (HWND hWnd)
 Retrieves the handle to a child window's parent window. More...
 
MG_EXPORT HWND GUIAPI GetMainWindowHandle (HWND hWnd)
 Retrives the handle to the main window contains a window. More...
 
MG_EXPORT BOOL GUIAPI IsWindowVisible (HWND hWnd)
 Retrieves the visibility state of the specified window. More...
 
MG_EXPORT BOOL GUIAPI GetWindowRect (HWND hWnd, PRECT prc)
 Retrives the dimensions of the bounding rectangle of a window. More...
 
MG_EXPORT HWND GUIAPI GetNextChild (HWND hWnd, HWND hChild)
 Retrives the next control in a window. More...
 
MG_EXPORT HWND GUIAPI GetNextMainWindow (HWND hMainWnd)
 Retrives the next main window in the system according to the zorder. More...
 
MG_EXPORT HWND GUIAPI GetHosting (HWND hMainWnd)
 Retrives the hosting main window of a main window. More...
 
MG_EXPORT HWND GUIAPI GetFirstHosted (HWND hHosting)
 Retrives the first hosted main window of a main window. More...
 
MG_EXPORT HWND GUIAPI GetNextHosted (HWND hHosting, HWND hHosted)
 Retrives the next hosted main window of a main window. More...
 
MG_EXPORT int GUIAPI GetWindowTextLength (HWND hWnd)
 Retrieves the length of a window's text. More...
 
MG_EXPORT int GUIAPI GetWindowText (HWND hWnd, char *spString, int nMaxLen)
 Copies the text of a window's into a buffer. More...
 
MG_EXPORT BOOL GUIAPI SetWindowText (HWND hWnd, const char *spString)
 Sets the text of a window. More...
 
MG_EXPORT HWND GUIAPI GetFocusChild (HWND hParent)
 Retrieves the handle to the window's active child that has the keyboard focus. More...
 
MG_EXPORT HWND GUIAPI SetNullFocus (HWND hParent)
 Cancels the current active child and set the focus child to be null. More...
 
MG_EXPORT HWND GUIAPI SetFocusChild (HWND hWnd)
 Sets the active child of a window. More...
 
MG_EXPORT HWND GUIAPI GetActiveWindow (void)
 Retrieves the main window handle to the active main window. More...
 
MG_EXPORT HWND GUIAPI SetActiveWindow (HWND hMainWnd)
 Sets a main window to be the active main window. More...
 
MG_EXPORT HWND GUIAPI GetCapture (void)
 Retrives the handle to the window (if any) that has captured the mouse. More...
 
MG_EXPORT HWND GUIAPI SetCapture (HWND hWnd)
 Sets the mouse capture to the specified window. More...
 
MG_EXPORT void GUIAPI ReleaseCapture (void)
 Releases the mouse capture from a window and restores normal mouse input processing. More...
 
MG_EXPORT HWND GUIAPI GetWindowUnderCursor (void)
 Retrives the handle to the window (if any) which is just beneath the mouse cursor. More...
 
MG_EXPORT HWND GUIAPI WindowFromPointEx (POINT pt, BOOL bRecursion)
 Retrieves a handle to the window that contains the specified point. More...
 
MG_EXPORT HWND GUIAPI ChildWindowFromPointEx (HWND hParent, POINT pt, UINT uFlags)
 Retrives a handle to the child window that contains the speicified point and meets the certain criteria. More...
 
static HWND GUIAPI ChildWindowFromPoint (HWND hParent, POINT pt)
 Retrives a handle to the child window that contains the speicified point. More...
 
MG_EXPORT BOOL GUIAPI MoveWindow (HWND hWnd, int x, int y, int w, int h, BOOL fPaint)
 Changes the position and dimensions of a window. More...
 
MG_EXPORT int GUIAPI ScrollWindowEx (HWND hWnd, int dx, int dy, const RECT *prcScroll, const RECT *prcClip, PCLIPRGN pRgnUpdate, PRECT prcUpdate, UINT flags)
 Scrolls the content of a window's client area. More...
 
static void GUIAPI ScrollWindow (HWND hWnd, int dx, int dy, const RECT *prcScroll, const RECT *prcClip)
 Scrolls the content of a window's client area. More...
 

Detailed Description

Macro Definition Documentation

#define GetFocus   GetFocusChild
See also
GetFocusChild

Definition at line 6511 of file window.h.

#define GetForegroundWindow   GetActiveWindow
See also
GetActiveWindow

Definition at line 6545 of file window.h.

#define GetWindowElementColor (   iItem)    GetWindowElementPixelEx(HWND_NULL, (HDC)-1, iItem)

Get window element color.

Definition at line 6825 of file window.h.

#define SetFocus   SetFocusChild
See also
SetFocusChild

Definition at line 6505 of file window.h.

#define SetForegroundWindow   SetActiveWindow
See also
SetActiveWindow

Definition at line 6551 of file window.h.

Function Documentation

BOOL AdjustWindowRectEx ( RECT pRect,
DWORD  dwStyle,
BOOL  bMenu,
DWORD  dwExStyle 
)

Calculates the required size of the window rectangle based on the desired size of the client rectangle.

This function calculates the required size of the window rectangle, based on the desired size of the client rectangle. The window rectangle can then be passed to the CreateMainWindow or CreateWindow function to create a window whose client area is the desired size.

A client rectangle is the smallest rectangle that completely encloses a client area. A window rectangle is the smallest rectangle that completely encloses the window, which includes the client area and the nonclient area.

The AdjustWindowRectEx function does not add extra space when a menu bar wraps to two or more rows.

The AdjustWindowRectEx function takes the WS_VSCROLL or WS_HSCROLL styles into account.

Parameters
pRectPointer to a RECT structure that contains the coordinates of the top-left and bottom-right corners of the desired client area. When the function returns, the structure contains the coordinates of the top-left and bottom-right corners of the window to accommodate the desired client area.
dwStyleSpecifies the window style of the window whose required size is to be calculated.
bMenuSpecifies whether the window has a menu.
dwExStyleSpecifies the extended window style of the window whose required size is to be calculated.
Returns
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
See also
ClientWidthToWindowWidth, ClientHeightToWindowHeight
HDC GUIAPI BeginPaint ( HWND  hWnd)

Prepares a window for painting.

This function prepares the specified window hWnd for painting. This function is called in the handler of MSG_PAINT message normally. It returns a device context including the update region of the window. When you are done with the device context, you should call EndPaint to finish the painting of the window.

Parameters
hWndThe handle to the window.
Returns
The device context.
See also
EndPaint
HWND GUIAPI ChildWindowFromPoint ( HWND  hParent,
POINT  pt 
)
inlinestatic

Retrives a handle to the child window that contains the speicified point.

This function determines which, if any, of the child windows belonging to a parent window contains the specified point by calling ChildWindowFromPointEx and passing CWP_ALL to uFlags parameter.

See also
ChildWindowFromPointEx

Definition at line 6686 of file window.h.

References ChildWindowFromPointEx(), MoveWindow(), and ScrollWindowEx().

HWND GUIAPI ChildWindowFromPointEx ( HWND  hParent,
POINT  pt,
UINT  uFlags 
)

Retrives a handle to the child window that contains the speicified point and meets the certain criteria.

This function determines which, if any, of the child windows belonging to a parent window contains the specified point. The function can ignore invisible, disabled, and transparent child windows. The search is restricted to immediate child windows. Grandchildren, and deeper descendant windows are not searched.

Parameters
hParentHandle to the parent window.
ptSpecifies a POINT structure that defines the client coordinates (relative to hParent) of the point to be checked.
uFlagsSpecifies which child windows to skip. This parameter can be one or more of the following values.
  • CWP_ALL
    Does not skip any child windows
  • CWP_SKIPINVISIBLE
    Skips invisible child windows
  • CWP_SKIPDISABLED
    Skips disabled child windows
  • CWP_SKIPTRANSPARENT
    Skips transparent child windows
Returns
The return value is a handle to the first child window that contains the point and meets the criteria specified by uFlags. If the point is within the parent window but not within any child window that meets the criteria, the return value is a handle to the parent window. If the point lies outside the parent window or if the function fails, the return value is HWND_NULL.
See also
ChildWindowFromPoint

Referenced by ChildWindowFromPoint().

int GUIAPI ClientHeightToWindowHeightEx ( DWORD  dwStyle,
int  win_type,
int  ch,
BOOL  hasMenu 
)

Calculates window height from the height of the client area.

This function calculates the main window height from the height of the client area.

Parameters
dwStyleThe style of window.
win_typeThe type of window.
chThe height of the client area.
hasMenuIndicates whether the main window has menu.
Returns
The height of the main window.
See also
ClientWidthToWindowWidthEx
void GUIAPI ClientToScreen ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the client coordinates of a point to screen coordinates.

This function converts the client coordinates of the specified point (*x,*y) in the specified window hWnd to screen coordinates.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
ScreenToClient
void GUIAPI ClientToWindow ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the client coordinates to the window coordinates.

This function converts the client coordinates of the specified point (*x,*y) in the specified window hWnd to the window coordinates.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
WindowToClient
int GUIAPI ClientWidthToWindowWidthEx ( DWORD  dwStyle,
int  win_type,
int  cw 
)

Calculates main window width from the width of the client area.

This function calculates the window width from the width of the client area.

Parameters
dwStyleThe style of window.
win_typeThe type of window.
cwThe width of the client area.
Returns
The width of the main window.
See also
ClientHeightToWindowHeightEx
BOOL GUIAPI EnableWindow ( HWND  hWnd,
BOOL  fEnable 
)

Enables of disables a window.

This function enables or disables mouse and keyboard input to the specified window hWnd. When input is disabled, the window does not receive input such as mouse clicks and key presses. When input is enabled, the window receives all input.

Parameters
hWndThe handle to the window.
fEnableIndicates whether to enable or disable the window, TRUE for enable.
Returns
The old enable state of the window.
See also
IsWindowEnabled
void GUIAPI EndPaint ( HWND  hWnd,
HDC  hdc 
)

Marks the end of painting in a window.

This function marks the end of painting in the specified window. This function is required for each call to the BeginPaint function, but only after painting is complete.

Parameters
hWndThe handle to the window.
hdcThe device context returned by BeginPaint.
See also
BeginPaint
BOOL GUIAPI ExcludeWindowExStyle ( HWND  hWnd,
DWORD  dwStyle 
)

Removes the specific extended style of a window.

This function removes the specific extended style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
dwStyleThe specific extended style which will be removed.
Returns
TRUE on success, otherwise FALSE.
See also
ExcludeWindowStyle
BOOL GUIAPI ExcludeWindowStyle ( HWND  hWnd,
DWORD  dwStyle 
)

Removes the specific style of a window.

This function removes the specific style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
dwStyleThe specific style which will be removed.
Returns
TRUE on success, otherwise FALSE.
See also
ExcludeWindowStyle
HWND GUIAPI GetActiveWindow ( void  )

Retrieves the main window handle to the active main window.

This function retrives the main window handle to the active main window which receives the input.

Returns
The handle to the active main window.
See also
SetActiveWindow, GetFocusChild
HWND GUIAPI GetCapture ( void  )

Retrives the handle to the window (if any) that has captured the mouse.

This function retrieves the handle to the window (if any) that has captured the mouse. Only one window at a time can capture the mouse; this window receives mouse input whether or not the cursor is within its borders.

Returns
The handle to the window that has captured the mouse, 0 for no window captures the mouse.
See also
SetCapture
BOOL GUIAPI GetClientRect ( HWND  hWnd,
PRECT  prc 
)

Retrives the client rectangle of a window.

This function retrives the coordinates of the client area of the window specified by hWnd. 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 always (0,0).

Parameters
hWndThe handle to the window.
prcThe pointer to a RECT structure receives the client rectangle.
Returns
TRUE on sucess, otherwise FALSE.
Note
Note that the coordinates of the upper-left corner are always zero.
See also
MoveWindow
HWND GUIAPI GetFirstHosted ( HWND  hHosting)

Retrives the first hosted main window of a main window.

This function retrives the first hosted main window of the specified main window hMainWnd.

For MiniGUI-Threads, HWND_DESKTOP has no any "hosted" window, so do not use this function for it.

Parameters
hHostingThe handle to the hosting main window.
Returns
The handle to the first hosted main window. If an invalid window handle is passed for hHosting, HWND_INVALID will be returned. If tihs main window do not have a hosted window, HWND_NULL will be returned.
See also
GetHosting, GetNextHosted
HWND GUIAPI GetFocusChild ( HWND  hParent)

Retrieves the handle to the window's active child that has the keyboard focus.

This function retrives the handle to the window's active child that has the keyboard focus.

Parameters
hParentThe handle to the parent window.
Returns
The handle to the active child.
See also
SetFocusChild, SetNullFoucs
HWND GUIAPI GetHosting ( HWND  hMainWnd)

Retrives the hosting main window of a main window.

This function retrives the hosting main window of the specified main window hWnd. The hosting main window creates the message queue, which shared with all hosted main window of it. The hosting window of a top-level main window is HWND_DESKTOP.

HWND_DESKTOP has no hosting window, do not use this function for it.

Parameters
hMainWndThe handle to the main window.
Returns
The handle to the hosting main window. A valid window must have a hosting window. If error occurs, such as a invalid handle or HWND_DESKTOP is passed as hMainWnd, HWND_INVALID is returned.
See also
GetFirstHosted, GetNextHosted
HWND GUIAPI GetMainWindowHandle ( HWND  hWnd)

Retrives the handle to the main window contains a window.

This function retrives the handle to the main window which contains the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The handle to the main window, HWND_INVALID indicates an error.
Note
For a main window, this function always returns the handle to itself. For HWND_DESKTOP, HWND_DESKTOP is returned.
See also
GetParent
HWND GUIAPI GetNextChild ( HWND  hWnd,
HWND  hChild 
)

Retrives the next control in a window.

This function retrives the next child of the specified window hWnd. If you pass HWND_NULL for the argument of hChild, the function will return the first child of the window.

Parameters
hWndThe handle to the window.
hChildThe handle to a child of the window.
Returns
The handle of the next child. If you pass HWND_NULL for the argument of hChild, it will return the first child of the window. When the child you passed is the last one, this function will return HWND_NULL. If hWnd is not the parent of hChild, this function will return HWND_INVALID.
See also
GetNextMainWindow
Note
Do not use HWND_DESKTOP for hWnd or hChild.

Example:

/*
* Sample code for GetNextChild:
* Travles all child of a window \a hWnd.
*/
do {
child = GetNextChild (hWnd, child);
} while (child != HWND_DESKTOP);
HWND GUIAPI GetNextHosted ( HWND  hHosting,
HWND  hHosted 
)

Retrives the next hosted main window of a main window.

This function retrives the next hosted main window of the specified main window hHosting.

For MiniGUI-Threads, HWND_DESKTOP has no any "hosted" window, so do not use this function for it.

Parameters
hHostingThe handle to the hosting main window.
hHostedThe handle to a known hosted main window. This function will return the next hosted main window.
Returns
Handle to the next hosted main window. Returns 0 when hHosted is the last hosted main window; HWND_INVALID when error occurs. If hHosted is 0, this call equals GetFirstHosted(hHosting). If an invalid window handle is passed as hHosting or hHosted, HWND_INVALID will be returned; If hHosted is not the hosted window of hHosting, HWND_INVALID will be returned.
See also
GetFirstHosted
HWND GUIAPI GetNextMainWindow ( HWND  hMainWnd)

Retrives the next main window in the system according to the zorder.

This function retrives the next main window of the specified main window hMainWnd.

Parameters
hMainWndThe handle to the main window.
Returns
The handle of the next main window. If you pass HWND_NULL for the argument of hMainWnd, it will return the topmost main window. When the main window you passed is the bottommost one, this function will return HWND_NULL. If hMainWnd is not a main window, the function will return HWND_INVALID.
See also
GetNextChild
HWND GUIAPI GetParent ( HWND  hWnd)

Retrieves the handle to a child window's parent window.

This function retrieves the handle to the specified child window's parent window.

Parameters
hWndThe handle to the child window.
Returns
The handle to the parent, HWND_INVALID indicates an error.
Note
For a main window, this function always returns 0. For HWND_DESKTOP or an invalid window handle, HWND_INVALID will be returned.
See also
GetMainWindowHandle
BOOL GUIAPI GetUpdateRect ( HWND  hWnd,
RECT update_rect 
)

Retrives the bounding box of the update region of a window.

This function retrives the bounding box of the update region of the specified window hWnd.

Parameters
hWndThe handle to the window.
update_rectThe pointer to a RECT structure which will contains the bounding box of the update region.
Returns
TRUE on success, otherwise FALSE.
See also
InvalidateRect
int GUIAPI GetUpdateRegion ( HWND  hWnd,
PCLIPRGN  pRgn 
)

Copy the update region of a window to a region.

This function copies the update region of the specified window hWnd into the region pRgn.

Parameters
hWndThe handle to the window.
pRgnThe pointer to a region which receives the update region of the window.
Returns
The region type.
Return values
NULLREGIONRegion is empty.
SIMPLEREGIONRegion is a single rectangle.
COMPLEXREGIONRegion is more than one rectangle.
-1An error occurred.
See also
GetUpdateRect
DWORD GUIAPI GetWindowAdditionalData ( HWND  hWnd)

Retrives the first additional data of a window.

This function retrives the first additional data of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The first additional data of the window.
See also
SetWindowAdditionalData
DWORD GUIAPI GetWindowAdditionalData2 ( HWND  hWnd)

Retrives the second additional data of a window.

This function retrives the second additional data of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The second additional data of the window.
See also
SetWindowAdditionalData2
gal_pixel GUIAPI GetWindowBkColor ( HWND  hWnd)

Returns the current background color of a window.

This function returns the pixel value of the current background color of the window specified by hWnd.

Parameters
hWndThe handle to the window.
Returns
The pixel value of the background color.
Note
The type of return value changed from int to gal_pixel since v3.2.
See also
SetWindowBkColor
WNDPROC GUIAPI GetWindowCallbackProc ( HWND  hWnd)

Retrives the callback procedure of a window.

This function retrives the window callback procedure of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The callback procedure of the window.
See also
SetWindowCallbackProc
const char *GUIAPI GetWindowCaption ( HWND  hWnd)

Retrives the caption of a window.

This function retrives the caption of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The pointer to the caption string of the window.
See also
SetWindowCaption
DWORD GUIAPI GetWindowClassAdditionalData ( HWND  hWnd)

Retrives the additional data of a control class.

This function retrives the additional data of the control class to which the specified control hWnd belongs.

Parameters
hWndThe handle to the control.
Returns
The additional data of the control class to which the control belongs.
Note
Note that this function always returns zero for the main window.
See also
SetWindowClassAdditionalData
HCURSOR GUIAPI GetWindowCursor ( HWND  hWnd)

Retrives the current cursor of a window.

This function retrives the current cursor of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The handle to the cursor.
See also
SetWindowCursor
DWORD GUIAPI GetWindowExStyle ( HWND  hWnd)

Retrives the extended style of a window.

This function retrives the extended style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
Returns
The extended style of the window.
See also
GetWindowStyle
PLOGFONT GUIAPI GetWindowFont ( HWND  hWnd)

Retrives the default font of a window.

This function retrives the default font of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The default logical font of the window.
See also
SetWindowFont
HICON GUIAPI GetWindowIcon ( HWND  hWnd)

Retrives the current icon of a window.

This function retrives the current icon of the specified window hWnd.

Parameters
hWndThe handle to the window.
Returns
The handle to the icon.
See also
SetWindowIcon
BOOL GUIAPI GetWindowRect ( HWND  hWnd,
PRECT  prc 
)

Retrives the dimensions of the bounding rectangle of a window.

This function retrives the dimension of the bounding rectangle of the specified window hWnd. The dimensions are given in parent's client coordinates (screen coordinates for main window) that are relative to the upper-left corner of the parent's client area (screen).

Parameters
hWndThe handle to the window.
prcThe pointer to a RECT structure which will contains the window rectangle.
Returns
TRUE on success, otherwise FALSE.
See also
GetClientRect
DWORD GUIAPI GetWindowStyle ( HWND  hWnd)

Retrives the style of a window.

This function retrives the style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
Returns
The style of the window.
See also
GetWindowExStyle
int GUIAPI GetWindowText ( HWND  hWnd,
char *  spString,
int  nMaxLen 
)

Copies the text of a window's into a buffer.

This function copies the text of the specified window hWnd into the buffer pointed to by spString. The function gets the window text by sending an MSG_GETTEXT message to the window.

Parameters
hWndThe handle to the window.
spStringThe pointer to a buffer receives the text.
nMaxLenThe maximal number of characters can be copied to the buffer.
Returns
The length of the window text string.
See also
GetWindowCaption, SetWindowText
int GUIAPI GetWindowTextLength ( HWND  hWnd)

Retrieves the length of a window's text.

This function retrieves the length, in characters, of the specified window's text. The function retrieves the length of the text by sending an MSG_GETTEXTLENGTH message to the window.

Parameters
hWndThe handle to the window.
Returns
The length of the window's text.
See also
GetWindowText
HWND GUIAPI GetWindowUnderCursor ( void  )

Retrives the handle to the window (if any) which is just beneath the mouse cursor.

This function retrieves the handle to the window (if any) that is under the mouse cursor. If a parent window and a child window are all under the mouse cursor, the handle to the child window will be returned.

Returns
The handle to the window under the mouse cursor, HWND_NULL for no window is under the mouse cursor.
BOOL GUIAPI IncludeWindowExStyle ( HWND  hWnd,
DWORD  dwStyle 
)

Includes the specific extended style of a window.

This function includes the specific extended style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
dwStyleThe specific extended style which will be included.
Returns
TRUE on success, otherwise FALSE.
See also
IncludeWindowStyle
BOOL GUIAPI IncludeWindowStyle ( HWND  hWnd,
DWORD  dwStyle 
)

Includes the specific style of a window.

This function includes the specific style of the window specified by hWnd.

Parameters
hWndThe handle to the window.
dwStyleThe specific style which will be included.
Returns
TRUE on success, otherwise FALSE.
See also
IncludeWindowStyle
BOOL GUIAPI InvalidateRect ( HWND  hWnd,
const RECT prc,
BOOL  bEraseBkgnd 
)

Makes a rectangle region in the client area of a window invalid.

This function adds a rectangle pointed to by prc to the specified window's update region. The update region represents the portion of the window's client area that must be redrawn, and erase background if argument bReaseBkgnd is set.

Parameters
hWndThe handle to the window.
prcThe pointer to a RECT structure which defines the invalid rectangle.
bEraseBkgndIndicates whether the background should be erased.
Returns
TRUE on success, otherwise FALSE.
See also
MSG_PAINT
BOOL GUIAPI InvalidateRegion ( HWND  hWnd,
const CLIPRGN pRgn,
BOOL  bErase 
)

Invalidates the client area within the specified region.

This function invalidates the client area within the specified region by adding it to the current update region of a window. The invalidated region, along with all other areas in the update region, is marked for painting when the next MSG_PAINT message occurs.

Parameters
hWndHandle to the window with an update region that is to be modified.
pRgnPointer to the region to be added to the update region. The region is assumed to have client coordinates. If this parameter is NULL, the entire client area is added to the update region.
bEraseSpecifies whether the background within the update region should be erased when the update region is processed. If this parameter is TRUE, the background is erased. If the parameter is FALSE, the background remains unchanged.
Returns
TRUE on success, otherwise FALSE.
Note
Invalidated areas accumulate in the update region until the next MSG_PAINT message is processed or until the region is validated by using the ValidateRect or ValidateRegion function. MiniGUI sends a MSG_PAINT message to a window whenever its update region is not empty and there are no other messages in the application queue for that window. The specified region must have been created by using one of the region functions. If the bErase parameter is TRUE for any part of the update region, the background in the entire region is erased, not just in the specified part.
See also
MSG_PAINT, InvalidateRect, ValidateRegion
BOOL GUIAPI IsControl ( HWND  hWnd)

Determines whether a window is a control.

This function determines whether the specified window hWnd is a control.

Parameters
hWndThe handle to the window.
Returns
TRUE for control, otherwise FALSE.
See also
IsMainWindow, IsWindow
BOOL GUIAPI IsDialog ( HWND  hWnd)

Determines whether a window handle identifies a dialog window.

This function determines whether the specified window handle hWnd identifies a dialog window.

Parameters
hWndThe window handle.
Returns
TRUE for dialog window, otherwise FALSE.
See also
IsMainWindow, IsControl
BOOL GUIAPI IsMainWindow ( HWND  hWnd)

Determines whether a window is a main window.

This function determines whether the specified window hWnd is a main window or not.

Parameters
hWndThe handle to the window.
Returns
TRUE for main window, otherwise FALSE.
See also
IsControl, IsWindow
BOOL GUIAPI IsWindow ( HWND  hWnd)

Determines whether a window handle identifies an existing window.

This function determines whether the specified window handle hWnd identifies an existing window.

Parameters
hWndThe window handle.
Returns
TRUE for window, otherwise FALSE.
See also
IsMainWindow, IsControl
BOOL GUIAPI IsWindowEnabled ( HWND  hWnd)

Determines whether the specified window is enabled for mouse and keyboard input.

This function returns the enable/disable state of the window specified by hWnd.

Parameters
hWndThe handle to the window.
Returns
The enable/disable state of the window, TRUE for enabled.
See also
EnableWindow
BOOL GUIAPI IsWindowVisible ( HWND  hWnd)

Retrieves the visibility state of the specified window.

This function retrives the visibility state of the specified window hWnd.

Parameters
hWndHandle to the window to test.
Returns
If the specified window, its parent window, its parent's parent window, and so forth, all have the WS_VISIBLE style, the return value is nonzero. Otherwise the return value is zero.
See also
ShowWindow
BOOL GUIAPI MoveWindow ( HWND  hWnd,
int  x,
int  y,
int  w,
int  h,
BOOL  fPaint 
)

Changes the position and dimensions of a window.

This function changes the position and dimensions of the specified window hWnd. For a main window, the position and dimensions are relative to the upper-left corner of the screen. For a control, they are relative to the upper-left corner of the parent window's client area.

Parameters
hWndThe handle to the window.
xThe new x coordinate of the upper-left corner of the window.
yThe new y coordinate of the upper-left corner of the window.
wThe new width of the window.
hThe new height of the window.
fPaintIndicates whether the window should be repainted.
Returns
TRUE on success, otherwise FALSE.
See also
ScrollWindow

Referenced by ChildWindowFromPoint().

void GUIAPI ReleaseCapture ( void  )

Releases the mouse capture from a window and restores normal mouse input processing.

This function releases the mouse capture from a window and restores normal mouse input processing. A window that has captured the mouse receives all mouse input, regardless of the position of the cursor.

See also
GetCapture, SetCapture
void GUIAPI ScreenToClient ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the screen coordinates of a point to client coordinates.

This function converts the screen coordinates of the specified point (*x,*y) to client coordinates of the specified window hWnd.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
ClientToScreen
void GUIAPI ScreenToWindow ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the screen coordinates of a point to window coordinates.

This function converts the screen coordinates of the specified point (*x,*y) to the window coordinates of the specfied window hWnd.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
WindowToScreen
void GUIAPI ScrollWindow ( HWND  hWnd,
int  dx,
int  dy,
const RECT prcScroll,
const RECT prcClip 
)
inlinestatic

Scrolls the content of a window's client area.

This function scrolls the content of the specified window's client area.

Parameters
hWndThe handle to the window.
dxThe new x coordinate of the origin in the client coordinates system after scrolling.
dyThe new y coordinate of the origin in the client coordinates system after scrolling.
prcScrollThe rectangle of the area which will be scrolled actually. NULL for whole client area.
prcClipA rectangle, all children covered totally by this rectangle will be moved after scrolling. All of the children will be moved if prcClip is NULL.
See also
MoveWindow

Definition at line 6814 of file window.h.

References NULL, and ScrollWindowEx().

int GUIAPI ScrollWindowEx ( HWND  hWnd,
int  dx,
int  dy,
const RECT prcScroll,
const RECT prcClip,
PCLIPRGN  pRgnUpdate,
PRECT  prcUpdate,
UINT  flags 
)

Scrolls the content of a window's client area.

This function scrolls the content of a window's client area.

If the SW_INVALIDATE and SW_ERASE flags are not specified, ScrollWindowEx does not invalidate the area that is scrolled from. If either of these flags is set, ScrollWindowEx invalidates this area. The area is not updated until the application calls the UpdateWindow function or retrieves the MSG_PAINT message from the application queue.

If the window has the WS_CLIPCHILDREN style, the returned areas specified by pRgnUpdate and prcUpdate represent the total area of the scrolled window that must be updated, including any areas in child windows that need updating.

If the SW_SCROLLCHILDREN flag is specified, the system does not properly update the screen if part of a child window is scrolled. The part of the scrolled child window that lies outside the source rectangle is not erased and is not properly redrawn in its new destination. To move child windows that do not lie completely within the rectangle specified by prcScroll, use the DeferWindowPos function. The cursor is repositioned if the SW_SCROLLCHILDREN flag is set and the caret rectangle intersects the scroll rectangle.

All input and output coordinates (for prcScroll, prcClip, prcUpdate, and pRgnUpdate) are determined as client coordinates.

Parameters
hWndHandle to the window where the client area is to be scrolled.
dxSpecifies the amount, in device units, of horizontal scrolling. This parameter must be a negative value to scroll to the left.
dySpecifies the amount, in device units, of vertical scrolling. This parameter must be a negative value to scroll up.
prcScrollPointer to a RECT structure that specifies the portion of the client area to be scrolled. If this parameter is NULL, the entire client area is scrolled.
prcClipPointer to a RECT structure that contains the coordinates of the clipping rectangle. Only device bits within the clipping rectangle are affected. Bits scrolled from the outside of the rectangle to the inside are painted; bits scrolled from the inside of the rectangle to the outside are not painted. This parameter may be NULL.
pRgnUpdatePointer to the region that is modified to hold the region invalidated by scrolling. This parameter may be NULL.
prcUpdatePointer to a RECT structure that receives the boundaries of the rectangle invalidated by scrolling. This parameter may be NULL.
flagsSpecifies flags that control scrolling. This parameter can be one of the following values:
  • SW_ERASE
    Erases the newly invalidated region by sending a MSG_ERASEBKGND message to the window when specified with the SW_INVALIDATE flag.
  • SW_INVALIDATE
    Invalidates the region identified by the pRgnUpdate parameter after scrolling.
  • SW_SCROLLCHILDREN
    Scrolls all child windows that intersect the rectangle pointed to by the prcScroll parameter. The child windows are scrolled by the number of pixels specified by the dx and dy parameters. MiniGUI calls MoveWindow to all child windows that intersect the prcScroll rectangle, even if they do not move.
Returns
If the function succeeds, the return value is SIMPLEREGION (rectangular invalidated region), COMPLEXREGION (nonrectangular invalidated region; overlapping rectangles), or NULLREGION (no invalidated region). If the function fails, the return value is -1.

Referenced by ChildWindowFromPoint(), and ScrollWindow().

HWND GUIAPI SetActiveWindow ( HWND  hMainWnd)

Sets a main window to be the active main window.

This function sets the specified main window hMainWnd to be the active main window which receives the input.

Parameters
hMainWndThe handle to the new active main window.
Returns
The handle to the old active main window.
See also
GetActiveWindow, SetFocusChild
HWND GUIAPI SetCapture ( HWND  hWnd)

Sets the mouse capture to the specified window.

This function sets the mouse capture to the specified window hWnd. Once a window has captured the mouse, all mouse input is directed to that window, regardless of whether the cursor is within the borders of that window. Only one window at a time can capture the mouse.

Parameters
hWndThe handle to the window.
Returns
The old capture window.
See also
GetCapture
HWND GUIAPI SetFocusChild ( HWND  hWnd)

Sets the active child of a window.

This function sets the specified window hWnd as the active child of its parent.

Parameters
hWndThe handle to the window.
Returns
The handle to the old active child of its parent.
See also
GetFocusChild, SetNullFocus
HWND GUIAPI SetNullFocus ( HWND  hParent)

Cancels the current active child and set the focus child to be null.

This function cancels the current active child and set the focus child of the window hParent to be null.

Parameters
hParentThe handle to the parent window.
Returns
The handle to the old active child.
See also
GetFocusChild, SetFocusChild
DWORD GUIAPI SetWindowAdditionalData ( HWND  hWnd,
DWORD  newData 
)

Sets the first additional data of a window.

This function sets the first additional data of the specified window hWnd.

Parameters
hWndThe handle to the window.
newDataThe new first additional data of the window.
Returns
The old first additional data of the window.
Note
For a dialog box created by DialogBoxIndirectParam, its second additional data used internally by the system to save the return value of the box. So you should avoid setting the second additional data of a dialog box.
See also
GetWindowAdditionalData
DWORD GUIAPI SetWindowAdditionalData2 ( HWND  hWnd,
DWORD  newData 
)

Sets the second additional data of a window.

This function sets the second additional data of the specified window hWnd.

Parameters
hWndThe handle to the window.
newDataThe new second additional data of the window.
Returns
The old second additional data of the window.
Note
For a control created by CreateWindowEx, its second additional data is reserved for internal use. So you should avoid setting the second additional data of a control.
See also
GetWindowAdditionalData2
gal_pixel GUIAPI SetWindowBkColor ( HWND  hWnd,
gal_pixel  new_bkcolor 
)

Sets the background color of a window.

This function sets the background color of the specified window hWnd to be new pixel value new_backcolor. You should call UpdateWindow or InvalidateRect in order that the new background color runs into affect.

Parameters
hWndThe handle to the window.
new_bkcolorThe pixel value of the new background color.
Returns
The pixel value of the old background color.
Note
The type of return value and new_bkcolor changed from int to gal_pixel since v3.2.
See also
GetWindowBkColor
WNDPROC GUIAPI SetWindowCallbackProc ( HWND  hWnd,
WNDPROC  newProc 
)

Sets the callback procedure of a window.

This function sets the window callback procedure of the specified window hWnd to be the procedure newProc.

Parameters
hWndThe handle to the window.
newProcThe new callback procedure of the window.
Returns
The old callback procedure of the window.
See also
GetWindowCallbackProc

Example:

/*
* The following code uses SetWindowCallbackProc function to
* change the default window callback procedures of some controls.
*/
#define IDC_CTRL1 100
#define IDC_CTRL2 110
#define IDC_CTRL3 120
#define IDC_CTRL4 130
#define MY_ES_DIGIT_ONLY 0x0001
#define MY_ES_ALPHA_ONLY 0x0002
static WNDPROC old_edit_proc;
static LRESULT RestrictedEditBox (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
{
if (message == MSG_CHAR) {
DWORD my_style = GetWindowAdditionalData (hwnd);
/* Determine whether the character should be masked. */
if ((my_style & MY_ES_DIGIT_ONLY) && (wParam < '0' || wParam > '9'))
return 0;
else if (my_style & MY_ES_ALPHA_ONLY)
if (!((wParam >= 'A' && wParam <= 'Z') || (wParam >= 'a' && wParam <= 'z')))
/* It is not the desired character, just return. */
return 0;
}
/* Calling old procedure to handle the messages using default handler. */
return (*old_edit_proc) (hwnd, message, wParam, lParam);
}
static LRESULT ControlTestWinProc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam)
{
switch (message) {
case MSG_CREATE:
{
HWND hWnd1, hWnd2, hWnd3;
CreateWindow (CTRL_STATIC, "Digit-only box:", WS_CHILD | WS_VISIBLE | SS_RIGHT, 0,
10, 10, 180, 24, hWnd, 0);
hWnd1 = CreateWindow (CTRL_EDIT, "", WS_CHILD | WS_VISIBLE | WS_BORDER, IDC_CTRL1,
200, 10, 180, 24, hWnd, MY_ES_DIGIT_ONLY);
CreateWindow (CTRL_STATIC, "Alpha-only box:", WS_CHILD | WS_VISIBLE | SS_RIGHT, 0,
10, 40, 180, 24, hWnd, 0);
hWnd2 = CreateWindow (CTRL_EDIT, "", WS_CHILD | WS_BORDER | WS_VISIBLE, IDC_CTRL2,
200, 40, 180, 24, hWnd, MY_ES_ALPHA_ONLY);
CreateWindow (CTRL_STATIC, "Normal edit box:", WS_CHILD | WS_VISIBLE | SS_RIGHT, 0,
10, 70, 180, 24, hWnd, 0);
hWnd3 = CreateWindow (CTRL_EDIT, "", WS_CHILD | WS_BORDER | WS_VISIBLE, IDC_CTRL2,
200, 70, 180, 24, hWnd, MY_ES_ALPHA_ONLY);
CreateWindow ("button", "Close", WS_CHILD | BS_PUSHBUTTON | WS_VISIBLE, IDC_CTRL4,
100, 100, 60, 24, hWnd, 0);
/* Set new window procedure and save the old procedure. */
old_edit_proc = SetWindowCallbackProc (hWnd1, RestrictedEditBox);
SetWindowCallbackProc (hWnd2, RestrictedEditBox);
break;
}
......
}
return DefaultMainWinProc (hWnd, message, wParam, lParam);
}
BOOL GUIAPI SetWindowCaption ( HWND  hWnd,
const char *  spCaption 
)

Sets the caption of a window.

This function sets the caption of the specified window hWnd.

Parameters
hWndThe handle to the window.
spCaptionThe pointer to the new caption of the window.
Returns
TRUE on success, otherwise FALSE.
See also
GetWindowCaption, SetWindowText
DWORD GUIAPI SetWindowClassAdditionalData ( HWND  hWnd,
DWORD  newData 
)

Sets the additional data of a control class.

This function sets the additional data of the control class to which the specified control hWnd belongs.

Parameters
hWndThe handle to the control.
newDataThe new additional data of the control class.
Returns
The old additional data of the control class.
Note
This function always does nothing and returns zero for the main window.
See also
SetWindowClassAdditionalData
HCURSOR GUIAPI SetWindowCursor ( HWND  hWnd,
HCURSOR  hNewCursor 
)

Sets the current cursor of a window.

This function sets the current cursor of the specified window hWnd with argument hNewCursor.

Parameters
hWndThe handle to the window.
hNewCursorThe handle to the new cursor.
Returns
The handle to the old cursor.
See also
GetWindowCursor
PLOGFONT GUIAPI SetWindowFont ( HWND  hWnd,
PLOGFONT  pLogFont 
)

Sets the default font of a window.

This function sets the default font of the specified window hWnd to be the logical font pLogFont. This function will send an MSG_FONTCHANGING message to the window. If the handler of the message returns non-zero value, this function will return immediately with the unchanged default font. Or, after the new default font set, this function will send an MSG_FONTCHANGED message to the window as a notification.

Parameters
hWndThe handle to the window.
pLogFontThe new default logical font. If it is NULL, this function will set the default font to be the system wchar font.
Returns
The old default logical font of the window, NULL on error.
See also
GetWindowFont, GetSystemFont
HICON GUIAPI SetWindowIcon ( HWND  hWnd,
HICON  hIcon,
BOOL  bRedraw 
)

Sets the current icon of a window.

This function sets the current icon of the specified window hWnd with argument hIcon.

Parameters
hWndThe handle to the window.
hIconThe handle to the new icon.
bRedrawIndicates whether to update the whole window.
Returns
The handle to the old icon.
Note
Note that MiniGUI only provides icon support for main window so far.
See also
GetWindowIcon
BOOL GUIAPI SetWindowText ( HWND  hWnd,
const char *  spString 
)

Sets the text of a window.

This function copies the string in the buffer pointed to by spString to be the text of the specified window hWnd. The function sets the window text by sending an MSG_SETTEXT message to the window.

Parameters
hWndThe handle to the window.
spStringThe pointer to the buffer.
Returns
TRUE on success, otherwise FALSE.
See also
SetWindowCaption, GetWindowText
BOOL GUIAPI ShowWindow ( HWND  hWnd,
int  iCmdShow 
)

Shows or hides a window.

This function shows or hides the window specified by hWnd.

Parameters
hWndThe handle to the window.
iCmdShowThe command to show or hide, can be one of the following values:
  • SW_SHOW
    Shows the window.
  • SW_HIDE
    Hides the window.
  • SW_SHOWNORMAL
    Shows the window, and if the window is a main window sets it to be the top most main window.
Returns
TRUE on sucess, otherwise FALSE.
void GUIAPI UpdateWindow ( HWND  hWnd,
BOOL  bErase 
)

Updates a window.

This function updates the window specified by hWnd. It will redraw the caption, the frame, and the menu bar of the window. It will invalidate the client area of the window as well, and if bErase is TRUE, the client area will be erased by using background color.

Parameters
hWndThe handle to the window.
bEraseIndicates whether to erase the client area of the window.
See also
InvalidateRect
BOOL GUIAPI ValidateRect ( HWND  hWnd,
const RECT rect 
)

Validates the client area within a rectangle by removing the rectangle from the update region of the specified window.

This function validates the client area within a rectangle by removing the rectangle from the update region of the specified window.

Parameters
hWndHandle to the window whose update region is to be modified.
rectPointer to a RECT structure that contains the client coordinates of the rectangle to be removed from the update region. If this parameter is NULL, the entire client area is removed.
Returns
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
Note
The BeginPaint function automatically validates the entire client area. Neither the ValidateRect nor ValidateRegion function should be called if a portion of the update region must be validated before the next MSG_PAINT message is generated. The system continues to generate MSG_PAINT messages until the current update region is validated.
See also
MSG_PAINT, BeginPaint, ValidateRegion, InvalidateRect
BOOL GUIAPI ValidateRegion ( HWND  hWnd,
const CLIPRGN pRgn 
)

Validates the client area within a region by removing the region from the current update region of the specified window.

This function validates the client area within a region by removing the region pRgn from the current update region of the specified window hWnd.

Parameters
hWndHandle to the window whose update region is to be modified.
pRgnA region that defines the area to be removed from the update region. If this parameter is NULL, the entire client area is removed.
Returns
If the function succeeds, the return value is nonzero. If the function fails, the return value is zero.
Note
The specified region must have been created by a region function. The region coordinates are assumed to be client coordinates. The BeginPaint function automatically validates the entire client area. Neither the ValidateRect nor ValidateRegion function should be called if a portion of the update region must be validated before the next MSG_PAINT message is generated.
See also
MSG_PAINT, BeginPaint, ValidateRect, InvalidateRegion
HWND GUIAPI WindowFromPointEx ( POINT  pt,
BOOL  bRecursion 
)

Retrieves a handle to the window that contains the specified point.

This function retrieves a handle to the main window that contains the specified point pt.

Parameters
ptSpecifies a POINT structure that defines the point to be checked.
bRecursionTry find the child window of the mMainWindow
Returns
The return value is a handle to the main window that contains the point. If no main window exists at the given point, the return value is HWND_NULL.
void GUIAPI WindowToClient ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the window coordinates to client coordinates.

This function converts the window coordinates of the specified point (*x,*y) in the specified window hWnd to the client coordinates.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
WindowToScreen
void GUIAPI WindowToScreen ( HWND  hWnd,
int *  x,
int *  y 
)

Converts the window coordinates of a point to screen coordinates.

This function converts the window coordinates of the specified point (*x,*y) in the specified window hWnd to the screen coordinates.

Parameters
hWndThe handle to the window.
xThe pointer to the x coordinate.
yThe pointer to the y coordinate.
See also
ScreenToWindow