Window creating/destroying
[Windowing functions]

Data Structures

struct _MAINWINCREATE

Modules

Defines

#define HWND_DESKTOP __mg_hwnd_desktop
Desktop window handle.
#define HWND_NULL 0
Null window handle.
#define HWND_INVALID 0xFFFFFFFF
Invalid window handle.
#define MainWindowCleanup(hwnd) MainWindowThreadCleanup(hwnd)
Is an alias of MainWindowThreadCleanup.
#define DefaultMainWinProc (__mg_def_proc[0])
Is the default main window callback procedure.
#define DefaultDialogProc (__mg_def_proc[1])
The default dialog box procedure.
#define DefaultControlProc (__mg_def_proc[2])
The default control callback procedure.

Typedefs

typedef int(* WNDPROC )(HWND, int, WPARAM, LPARAM)
Type of the window callback procedure.
typedef struct _MAINWINCREATE MAINWINCREATE

Functions

MG_EXPORT int GUIAPI CreateThreadForMainWindow (pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *arg)
Create a thread for main window.
MG_EXPORT pthread_t GUIAPI GetMainWinThread (HWND hMainWnd)
Get the thread id which main window belongs to.
MG_EXPORT int GUIAPI WaitMainWindowClose (HWND hWnd, void **returnval)
Suspends execution of the calling thread which main window belongs to until the target thread terminates, unless the target thread has already terminated.
MG_EXPORT void GUIAPI MainWindowThreadCleanup (HWND hMainWnd)
Cleans up system resource associated with a main window.
MG_EXPORT HWND GUIAPI CreateMainWindowEx (PMAINWINCREATE pCreateInfo, const char *werdr_name, const WINDOW_ELEMENT_ATTR *we_attrs, const char *window_name, const char *layer_name)
Creates a main window.
static HWND GUIAPI CreateMainWindow (PMAINWINCREATE pCreateInfo)
A simplified version of CreateMainWindowEx.
MG_EXPORT BOOL GUIAPI DestroyMainWindow (HWND hWnd)
Destroys a main window.
MG_EXPORT BOOL GUIAPI SetWindowMask (HWND hWnd, const MYBITMAP *mask)
Set window (a main window, or a child window which is also known as "control")'s Mask Rect with MYBITMAP data.
MG_EXPORT BOOL GUIAPI SetWindowMaskEx (HWND hWnd, HDC hdc, const BITMAP *mask)
Set window (a main window, or a child window which is also known as "control")'s Mask Rect with BITMAP data,.
BOOL GUIAPI SetWindowRegion (HWND hWnd, const CLIPRGN *region)
Set window's Mask Rect with CLIPRGN data.
MG_EXPORT int GUIAPI DefaultWindowProc (HWND hWnd, int message, WPARAM wParam, LPARAM lParam)
The default window callback procedure.

Variables

MG_EXPORT WNDPROC __mg_def_proc [3]
The default window callback procedure array.

Define Documentation

#define DefaultControlProc (__mg_def_proc[2])

The default control callback procedure.

This function is the default control callback procedure. You should call this function for all messages, you do not want to handle in your own control procedure.

Parameters:

	hWnd	The handle to the window.
	message	The message identifier.
	wParam	The first parameter of the message.
	lParam	The second parameter of the message.

Definition at line 5191 of file window.h.

#define DefaultDialogProc (__mg_def_proc[1])

The default dialog box procedure.

This function is the default dialog box procedure. You should call this function in your dialog box procedure to process the unhandled messages.

Parameters:

	hWnd	The handle to the window.
	message	The message identifier.
	wParam	The first message parameter.
	lParam	The second message parameter.

Returns:: The return value of the message handler.

Definition at line 5176 of file window.h.

#define DefaultMainWinProc (__mg_def_proc[0])

Is the default main window callback procedure.

This function is the default main window callback procedure. You should call this function for all messages, you do not want to handle in your main window procedure.

Parameters:

	hWnd	The handle to the window.
	message	The message identifier.
	wParam	The first parameter of the message.
	lParam	The second parameter of the message.

Definition at line 5158 of file window.h.

#define HWND_DESKTOP __mg_hwnd_desktop

Desktop window handle.

Definition at line 4877 of file window.h.

#define HWND_INVALID 0xFFFFFFFF

Invalid window handle.

Definition at line 4889 of file window.h.

#define HWND_NULL 0

Null window handle.

Definition at line 4883 of file window.h.

#define MainWindowCleanup ( hwnd ) MainWindowThreadCleanup(hwnd)

Is an alias of MainWindowThreadCleanup.

See also:: MainWindowThreadCleanup

Definition at line 4996 of file window.h.

Typedef Documentation

typedef struct _MAINWINCREATE MAINWINCREATE

Structure defines a main window.

typedef int(* WNDPROC)(HWND, int, WPARAM, LPARAM)

Type of the window callback procedure.

Definition at line 4869 of file window.h.

Function Documentation

HWND GUIAPI CreateMainWindow ( PMAINWINCREATE pCreateInfo ) [inline, static]

A simplified version of CreateMainWindowEx.

This function creates a main window by calling CreateMainWindow function and passing NULL for werdr_name, we_attrs, window_name, and layer_name parameters.

See also:: CreateMainWindowEx

Definition at line 5037 of file window.h.

References CreateMainWindowEx(), and NULL.

HWND GUIAPI CreateMainWindowEx	(	PMAINWINCREATE	pCreateInfo,
		const char *	werdr_name,
		const WINDOW_ELEMENT_ATTR *	we_attrs,
		const char *	window_name,
		const char *	layer_name
	)

Creates a main window.

This function creates a main window by using some information, and returns the handle to the main window.

Parameters:

	pCreateInfo	The pointer to a MAINWINCREATE structure.
	werdr_name	The name of window element renderer. NULL for default renderer.
	we_attrs	The pointer to window element attribute table. NULL for default window attribute table.
	window_name	The window name; reserved for future use.
	layer_name	The layer name; reserved for future use.

Returns:: The handle to the new main window; HWND_INVALID indicates an error.

See also:: CreateMainWindow, MAINWINCREATE, Window styles

Example:

/*
 * The following code initializes a MAINWINCREATE struct and then
 * creates a main window.
 */
{
    MAINWINCREATE CreateInfo;
    HWND hWnd;

    /* Initialize the MAINWINCREATE structure. */
    CreateInfo.dwStyle = WS_VISIBLE | WS_VSCROLL | WS_HSCROLL | WS_CAPTION;
    CreateInfo.spCaption= "MiniGUI step three";
    CreateInfo.dwExStyle = WS_EX_NONE;
    CreateInfo.hMenu = createmenu();
    CreateInfo.hCursor = GetSystemCursor(0);
    CreateInfo.hIcon = 0;
    CreateInfo.MainWindowProc = MainWinProc;
    CreateInfo.lx = 0;
    CreateInfo.ty = 0;
    CreateInfo.rx = 640;
    CreateInfo.by = 480;
    CreateInfo.iBkColor = COLOR_lightwhite;
    CreateInfo.dwAddData = 0;
    CreateInfo.hHosting = HWND_DESKTOP;

    /* Create the main window. */
    hWnd = CreateMainWindow(&CreateInfo);
    if (hWnd == HWND_INVALID)
        return 0;
}

Referenced by CreateMainWindow().

int GUIAPI CreateThreadForMainWindow	(	pthread_t *	thread,
		pthread_attr_t *	attr,
		void ()(void *)	start_routine,
		void *	arg
	)

Create a thread for main window.

See also:: pthread_create

int DefaultWindowProc	(	HWND	hWnd,
		int	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

The default window callback procedure.

This window procedure can be used for main windows, dialog boxes, and child windows.

This function is the default window callback procedure. You should call this function for all messages you do not want to handle in your window procedure.

Parameters:

	hWnd	The handle to the window.
	message	The message identifier.
	wParam	The first parameter of the message.
	lParam	The second parameter of the message.

BOOL GUIAPI DestroyMainWindow ( HWND hWnd )

Destroys a main window.

This function destroys the main window specified by hWnd. It does not release all system resource used by the main window. You should call MainWindowThreadCleanup to destroy the main window actually.

Parameters:

hWnd

The handle to the main window.

Returns:: TRUE on success, FALSE on error.

See also:: MainWindowThreadCleanup

Example:

/*
 * The following code destroies all resource used by the main window
 * and then destroies the main window itself.
 */
                case MSG_CLOSE:
                    /* Destroy the resource used by the main window. */
                    DestroyLogFont (logfont1);
                    DestroyLogFont (logfont2);
                    DestroyLogFont (logfont3);
                    
                    /* Destroy the child windows. */
                    DestroyWindow(hWndButton);
                    DestroyWindow(hWndEdit);

                    /* Destroy the main window. */
                    DestroyMainWindow (hWnd);

                    /* Send a MSG_QUIT message to quit the message loop. */
                    PostQuitMessage(hWnd);
                    return 0;

pthread_t GUIAPI GetMainWinThread ( HWND hMainWnd )

Get the thread id which main window belongs to.

Returns:: Thread id.

void GUIAPI MainWindowThreadCleanup ( HWND hMainWnd )

Cleans up system resource associated with a main window.

This function cleans up the system resource such as message queue associated with the main window hMainWnd. DestroyMainWindow does not destroy all resource used by a main window, therefore, you should call this function after calling DestroyMainWindow and skipping out from the message loop. After calling this function, the main window object will destroyed actually.

Parameters:

hMainWnd

The handle to the main window.

See also:: DestroyMainWindow

BOOL GUIAPI SetWindowMask	(	HWND	hWnd,
		const MYBITMAP *	mask
	)

Set window (a main window, or a child window which is also known as "control")'s Mask Rect with MYBITMAP data.

Parameters:

	hWnd	The handle to the window.
	mask	The mask of the window which indicate the transparency of each pixel on this window.

Returns:: return TRUE on success, otherwise FALSE.

See also:: SetWindowRegion

BOOL GUIAPI SetWindowMaskEx	(	HWND	hWnd,
		HDC	hdc,
		const BITMAP *	mask
	)

Set window (a main window, or a child window which is also known as "control")'s Mask Rect with BITMAP data,.

Parameters:

	hWnd	The handle to the window.
	hdc	The reference dc which indicate the colorformat of the mask.
	mask	The mask of the window which indicate the transparency of each pixel on this window.

Returns:: return TRUE on success, otherwise FALSE.

See also:: SetWindowRegion

BOOL GUIAPI SetWindowRegion	(	HWND	hWnd,
		const CLIPRGN *	region
	)

Set window's Mask Rect with CLIPRGN data.

Parameters:

	hWnd	The handle to the window.
	region	The region to indicate which part of the window is visible.

Returns:: return TRUE on success, otherwise FALSE.

int GUIAPI WaitMainWindowClose	(	HWND	hWnd,
		void **	returnval
	)

Suspends execution of the calling thread which main window belongs to until the target thread terminates, unless the target thread has already terminated.

Returns:: non-NULL value on success.

Variable Documentation

WNDPROC __mg_def_proc[3]

The default window callback procedure array.

Window creating/destroying [Windowing functions]

Data Structures

Modules

Defines

Typedefs

Functions

Variables

Define Documentation

Typedef Documentation

Function Documentation

Variable Documentation

Window creating/destroying
[Windowing functions]