Data Structures
struct	_CTRLDATA

struct	_DLGTEMPLATE

Macros
#define	DLGC_WANTARROWS 0x0001
	Control wants arrow keys. More...

#define	DLGC_WANTTAB 0x0002
	Control wants tab keys. More...

#define	DLGC_WANTALLKEYS 0x0004
	Control wants all keys. More...

#define	DLGC_WANTCHARS 0x0008
	Want MSG_CHAR messages. More...

#define	DLGC_WANTENTER 0x0010
	Control wants enter keys. More...

#define	DLGC_HASSETSEL 0x0080
	Understands EM_SETSEL message. More...

#define	DLGC_DEFPUSHBUTTON 0x0100
	Default pushbutton. More...

#define	DLGC_PUSHBUTTON 0x0200
	Non-default pushbutton. More...

#define	DLGC_RADIOBUTTON 0x0400
	Radio button. More...

#define	DLGC_3STATE 0x0800
	3 States button item. More...

#define	DLGC_STATIC 0x1000
	Static item: don't include. More...

#define	DLGC_BUTTON 0x2000
	Button item: can be checked. More...

Typedefs
typedef struct _CTRLDATA	CTRLDATA

typedef struct _DLGTEMPLATE	DLGTEMPLATE

Functions
MG_EXPORT HWND GUIAPI	CreateMainWindowIndirectParamEx (PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC WndProc, LPARAM lParam, const char werdr_name, WINDOW_ELEMENT_ATTR we_attrs, const char window_name, const char layer_name)
	Uses a dialog template and other information to create a modeless main window and controls in it, and pass a parameter to the window procedure. More...

static HWND GUIAPI	CreateMainWindowIndirectParam (PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC WndProc, LPARAM lParam)
	A simplified version of CreateMainWindowIndirectParamEx. More...

static HWND GUIAPI	CreateMainWindowIndirect (PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC WndProc)
	A simplified version of CreateMainWindowIndirectParam. More...

MG_EXPORT BOOL GUIAPI	DestroyMainWindowIndirect (HWND hMainWin)
	Destroys a main window created by CreateMainWindowIndirectParam. More...

MG_EXPORT int GUIAPI	DialogBoxIndirectParamEx (PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC DlgProc, LPARAM lParam, const char werdr_name, WINDOW_ELEMENT_ATTR we_attrs, const char window_name, const char layer_name)
	Creates a modal dialog box from a dialog box template in memory and other information. More...

static int GUIAPI	DialogBoxIndirectParam (PDLGTEMPLATE pDlgTemplate, HWND hOwner, WNDPROC DlgProc, LPARAM lParam)
	A simplified version of DialogBoxIndirectParamEx. More...

MG_EXPORT BOOL GUIAPI	EndDialog (HWND hDlg, int endCode)
	Destroys a modal dialog box, causing MiniGUI to end any processing for the dialog box. More...

MG_EXPORT void GUIAPI	DestroyAllControls (HWND hWnd)
	Destroys all controls in a window. More...

MG_EXPORT HWND GUIAPI	GetDlgDefPushButton (HWND hWnd)
	Get the default push button control in a window. More...

MG_EXPORT LINT GUIAPI	GetDlgCtrlID (HWND hwndCtl)
	Get the integer identifier of a control. More...

MG_EXPORT HWND GUIAPI	GetDlgItem (HWND hDlg, LINT nIDDlgItem)
	Retrieve the handle to a control in a dialog box. More...

MG_EXPORT UINT GUIAPI	GetDlgItemInt (HWND hDlg, LINT nIDDlgItem, BOOL *lpTranslated, BOOL bSigned)
	Translates the text of a control in a dialog box into an integer value. More...

MG_EXPORT int GUIAPI	GetDlgItemText (HWND hDlg, LINT nIDDlgItem, char *lpString, int nMaxCount)
	Retrieve the title or text associated with a control in a dialog box. More...

MG_EXPORT char *GUIAPI	GetDlgItemText2 (HWND hDlg, LINT id, int *lenPtr)
	Retrieve the title or text associated with a control in a dialog box. More...

MG_EXPORT HWND GUIAPI	GetNextDlgGroupItem (HWND hDlg, HWND hCtl, BOOL bPrevious)
	Retrieve the handle to the first control in a group of controls that precedes (or follows) the specified control in a dialog box. More...

MG_EXPORT HWND GUIAPI	GetNextDlgTabItem (HWND hDlg, HWND hCtl, BOOL bPrevious)
	Retrieve the handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control. More...

MG_EXPORT LRESULT GUIAPI	SendDlgItemMessage (HWND hDlg, LINT nIDDlgItem, UINT message, WPARAM wParam, LPARAM lParam)
	Send a message to the specified control in a dialog box. More...

MG_EXPORT BOOL GUIAPI	SetDlgItemInt (HWND hDlg, LINT nIDDlgItem, UINT uValue, BOOL bSigned)
	Set the text of a control in a dialog box to the string representation of a specified integer value. More...

MG_EXPORT void GUIAPI	CheckDlgButton (HWND hDlg, LINT nIDDlgItem, int nCheck)
	Changes the check status of a button control. More...

MG_EXPORT void GUIAPI	CheckRadioButton (HWND hDlg, LINT idFirstButton, LINT idLastButton, LINT idCheckButton)
	Adds a check mark to (checks) a specified radio button in a group and removes a check mark from (clears) all other radio buttons in the group. More...

MG_EXPORT int GUIAPI	IsDlgButtonChecked (HWND hDlg, LINT idButton)
	Determine whether a button control has a check mark next to it or whether a three-state button control is grayed, checked, or neither. More...

Detailed Description

Macro Definition Documentation

◆ DLGC_3STATE

#define DLGC_3STATE 0x0800

3 States button item.

Definition at line 11510 of file window.h.

◆ DLGC_BUTTON

#define DLGC_BUTTON 0x2000

Button item: can be checked.

Definition at line 11520 of file window.h.

◆ DLGC_DEFPUSHBUTTON

#define DLGC_DEFPUSHBUTTON 0x0100

Default pushbutton.

Definition at line 11495 of file window.h.

◆ DLGC_HASSETSEL

#define DLGC_HASSETSEL 0x0080

Understands EM_SETSEL message.

Definition at line 11489 of file window.h.

◆ DLGC_PUSHBUTTON

#define DLGC_PUSHBUTTON 0x0200

Non-default pushbutton.

Definition at line 11500 of file window.h.

◆ DLGC_RADIOBUTTON

#define DLGC_RADIOBUTTON 0x0400

Radio button.

Definition at line 11505 of file window.h.

◆ DLGC_STATIC

#define DLGC_STATIC 0x1000

Static item: don't include.

Definition at line 11515 of file window.h.

◆ DLGC_WANTALLKEYS

#define DLGC_WANTALLKEYS 0x0004

Control wants all keys.

Definition at line 11473 of file window.h.

◆ DLGC_WANTARROWS

#define DLGC_WANTARROWS 0x0001

Control wants arrow keys.

Definition at line 11463 of file window.h.

◆ DLGC_WANTCHARS

#define DLGC_WANTCHARS 0x0008

Want MSG_CHAR messages.

Definition at line 11478 of file window.h.

◆ DLGC_WANTENTER

#define DLGC_WANTENTER 0x0010

Control wants enter keys.

Definition at line 11484 of file window.h.

◆ DLGC_WANTTAB

#define DLGC_WANTTAB 0x0002

Control wants tab keys.

Definition at line 11468 of file window.h.

Typedef Documentation

◆ CTRLDATA

typedef struct _CTRLDATA CTRLDATA

Structure which defines a control.

◆ DLGTEMPLATE

typedef struct _DLGTEMPLATE DLGTEMPLATE

Structure which defines a dialogbox.

Example:

static DLGTEMPLATE DlgInitProgress =
{
    WS_BORDER | WS_CAPTION,
    WS_EX_NONE,
    120, 150, 400, 130,
    "VAM-CNC is initializing",
    0, 0,
    3, NULL,
    0
};
 
static CTRLDATA CtrlInitProgress [] =
{
    {
        "static",
        WS_VISIBLE | SS_SIMPLE,
        10, 10, 380, 16,
        IDC_PROMPTINFO,
        "Initialize...",
        0
    },
    {
        "progressbar",
        WS_VISIBLE,
        10, 40, 380, 20,
        IDC_PROGRESS,
        NULL,
        0
    },
    {
        "button",
        WS_TABSTOP | WS_VISIBLE | BS_DEFPUSHBUTTON,
        170, 70, 60, 25,
        IDOK,
        "OK",
        0
    }
};
 

Function Documentation

◆ CheckDlgButton()

void GUIAPI CheckDlgButton	(	HWND	hDlg,
		LINT	nIDDlgItem,
		int	nCheck
	)

Changes the check status of a button control.

This function changes the check status of the button control whose identifier is nIDDlgItem in the dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.
nCheck	The state of the button. If the button is a normal button, the value being zero means the button is checked, otherwise unchecked. If the button is a special button with three states, the value can be one of the following values: BST_UNCHECKED The button is unchecked. BST_CHECKED The button is checked. BST_INDETERMINATE The button is in indeterminate state.

Note: The type of nIDDlgItem changed from int to LINT since v3.2.

See also: CheckRadioButton, IsDlgButtonChecked

◆ CheckRadioButton()

void GUIAPI CheckRadioButton	(	HWND	hDlg,
		LINT	idFirstButton,
		LINT	idLastButton,
		LINT	idCheckButton
	)

Adds a check mark to (checks) a specified radio button in a group and removes a check mark from (clears) all other radio buttons in the group.

This function adds a check mark to (checks) the specified radio button idCheckButton in a group between idFirstButton and idLastButton, and removes a check mark from (clears) all other radio buttons in the group.

Parameters

hDlg	The handle to the dialog box.
idFirstButton	The identifier of the first control in the group.
idLastButton	The identifier of the last control in the group.
idCheckButton	The identifier of the control to be checked.

Note: The type of idFirstButton, idLastButton, and idCheckButton changed from int to LINT since v3.2.

See also: CheckDlgButton

◆ CreateMainWindowIndirect()

HWND GUIAPI CreateMainWindowIndirect	(	PDLGTEMPLATE	pDlgTemplate,
		HWND	hOwner,
		WNDPROC	WndProc
	)

inlinestatic

A simplified version of CreateMainWindowIndirectParam.

This function creates a main window by calling CreateMainWindowIndirectParam function and passing 0 for lParam parameter.

See also: CreateMainWindowIndirectParam

Definition at line 11649 of file window.h.

◆ CreateMainWindowIndirectParam()

HWND GUIAPI CreateMainWindowIndirectParam	(	PDLGTEMPLATE	pDlgTemplate,
		HWND	hOwner,
		WNDPROC	WndProc,
		LPARAM	lParam
	)

inlinestatic

A simplified version of CreateMainWindowIndirectParamEx.

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

See also: CreateMainWindowIndirectParamEx

Definition at line 11630 of file window.h.

◆ CreateMainWindowIndirectParamEx()

HWND GUIAPI CreateMainWindowIndirectParamEx	(	PDLGTEMPLATE	pDlgTemplate,
		HWND	hOwner,
		WNDPROC	WndProc,
		LPARAM	lParam,
		const char *	werdr_name,
		WINDOW_ELEMENT_ATTR *	we_attrs,
		const char *	window_name,
		const char *	layer_name
	)

Uses a dialog template and other information to create a modeless main window and controls in it, and pass a parameter to the window procedure.

This function uses a dialog template pointed to by pDlgTemplate and other information to create a modeless main window and controls in it. The parameter specified by lParam will be passed to the window procedure as the second paramter of MSG_INITDIALOG message.

Parameters

pDlgTemplate	The pointer to a DLGTEMPLATE structure.
hOwner	The handle to the hosting main window.
WndProc	The window procedure of the new main window.
lParam	The parameter will be passed to the window procedure.
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: Handle to the new main window, HWND_INVALID on error.

See also: CreateMainWindowIndirectParam, DestroyMainWindowIndirect, DialogBoxIndirectParam, DLGTEMPLATE

◆ DestroyAllControls()

void GUIAPI DestroyAllControls ( HWND hWnd )

Destroys all controls in a window.

This function destroys all controls (child windows) in a window.

Parameters

hWnd	The handle to the window.

See also: DestroyWindow

◆ DestroyMainWindowIndirect()

BOOL GUIAPI DestroyMainWindowIndirect ( HWND hMainWin )

Destroys a main window created by CreateMainWindowIndirectParam.

This function destroys the main window which was created by CreateMainWindowIndirectParam function.

Parameters

hMainWin The handle to the main window.

See also: CreateMainWindowIndirectParam

◆ DialogBoxIndirectParam()

int GUIAPI DialogBoxIndirectParam	(	PDLGTEMPLATE	pDlgTemplate,
		HWND	hOwner,
		WNDPROC	DlgProc,
		LPARAM	lParam
	)

inlinestatic

A simplified version of DialogBoxIndirectParamEx.

This function creates a dialog box by calling DialogBoxIndirectParamEx function and passing NULL for werdr_name, we_attrs, window_name, and layer_name parameters.

See also: DialogBoxIndirectParamEx

Definition at line 11717 of file window.h.

◆ DialogBoxIndirectParamEx()

int GUIAPI DialogBoxIndirectParamEx	(	PDLGTEMPLATE	pDlgTemplate,
		HWND	hOwner,
		WNDPROC	DlgProc,
		LPARAM	lParam,
		const char *	werdr_name,
		WINDOW_ELEMENT_ATTR *	we_attrs,
		const char *	window_name,
		const char *	layer_name
	)

Creates a modal dialog box from a dialog box template in memory and other information.

This function creates a modal dialog box from a dialog box template in memory and other information. Before displaying the dialog box, the function passes an application-defined value to the dialog box procedure as the second parameter of the MSG_INITDIALOG message. An application can use this value to initialize the controls in the dialog box.

Parameters

pDlgTemplate	The pointer to a DLGTEMPLATE structure.
hOwner	The handle to the hosting main window.
DlgProc	The window procedure of the new dialog box.
lParam	The parameter will be passed to the window procedure.
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: Return value of the dialog box, i.e., the second argument passed to EndDialog function which closes the dialog box.

See also: EndDialog, DialogBoxIndirectParam, CreateMainWindowIndirectParam, DLGTEMPLATE

◆ EndDialog()

BOOL GUIAPI EndDialog	(	HWND	hDlg,
		int	endCode
	)

Destroys a modal dialog box, causing MiniGUI to end any processing for the dialog box.

This function destroys the modal dialog box hDlg created by DialogBoxIndirectParam and ends any processing for the dialog box. The argument endCode will be returned by DialogBoxIndirectParam as the return value.

Parameters

hDlg	The handle to the dialog box.
endCode	The value will be returned by DialogBoxIndirectParam.

Returns: TRUE on success, FALSE on error.

See also: DialogBoxIndirectParam

◆ GetDlgCtrlID()

LINT GUIAPI GetDlgCtrlID ( HWND hwndCtl )

Get the integer identifier of a control.

This function gets the integer identifier of the control hwndCtl.

Parameters

hwndCtl The handle to the control.

Returns: The identifier of the control, -1 for error.

Note: The type of return value changed from int to LINT since v3.2.

See also: GetDlgItem

◆ GetDlgDefPushButton()

HWND GUIAPI GetDlgDefPushButton ( HWND hWnd )

Get the default push button control in a window.

This function gets the handle to the default push button (with BS_DEFPUSHBUTTON style) in the specified window hWnd.

Parameters

hWnd	The handle to the window.

Returns: The handle to the default push button, zero for non default push button in the window.

◆ GetDlgItem()

HWND GUIAPI GetDlgItem	(	HWND	hDlg,
		LINT	nIDDlgItem
	)

Retrieve the handle to a control in a dialog box.

This function retrieves the handle to a control, whose identifier is nIDDlgItem, in the specified dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.

Note: The type of nIDDlgItem changed from int to LINT since v3.2.

Returns: The handle to the control, zero for not found.

◆ GetDlgItemInt()

UINT GUIAPI GetDlgItemInt	(	HWND	hDlg,
		LINT	nIDDlgItem,
		BOOL *	lpTranslated,
		BOOL	bSigned
	)

Translates the text of a control in a dialog box into an integer value.

This function translates the text of the control, whose identifier is nIDDlgItem in the dialog box hDlg into an integer value.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.
lpTranslated	The pointer to a boolean value, which indicates whether translated successfully.
bSigned	Indicates whether handle the text as a signed integer.

Returns: The translated 32-bit integer.

Note: MiniGUI uses strtol or strtoul to convert the string value to a 32-bit integer, and pass the base as 0. Thus, the valid string value should be in the following forms:

[+|-]0x[0-9|A-F]*
Will be read in base 16.
[+|-]0[0-7]*
Will be read in base 8.
[+|-][1-9][0-9]*
Will be read in base 10.

Note: The type of nIDDlgItem changed from int to LINT since v3.2.

See also: GetDlgItemText, SetDlgItemInt

◆ GetDlgItemText()

int GUIAPI GetDlgItemText	(	HWND	hDlg,
		LINT	nIDDlgItem,
		char *	lpString,
		int	nMaxCount
	)

Retrieve the title or text associated with a control in a dialog box.

This function retrieves the title or text associated with a control, whose identifier is nIDDlgItem in the dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.
lpString	The pointer to a buffer which receives the text.
nMaxCount	The maximal length of the string, not including the null character.

Returns: The length of the null-terminated text.

Note: The buffer should at least have size of (nMaxCount + 1).; The type of nIDDlgItem changed from int to LINT since v3.2.

See also: GetDlgItemInt, GetDlgItemText2

◆ GetDlgItemText2()

char *GUIAPI GetDlgItemText2	(	HWND	hDlg,
		LINT	id,
		int *	lenPtr
	)

Retrieve the title or text associated with a control in a dialog box.

This function is similiar as GetDlgItemText function, but it allocates memory for the text and returns the pointer to the allocated buffer. You should free the buffer when done by using free function.

Parameters

hDlg	The handle to the dialog box.
id	The identifier of the control.
lenPtr	The pointer to an integer which receives the length of the text if it is not NULL.

Returns: The pointer to the allocated buffer.

Note: The type of id changed from int to LINT since v3.2.

See also: GetDlgItemText

◆ GetNextDlgGroupItem()

HWND GUIAPI GetNextDlgGroupItem	(	HWND	hDlg,
		HWND	hCtl,
		BOOL	bPrevious
	)

Retrieve the handle to the first control in a group of controls that precedes (or follows) the specified control in a dialog box.

This function retrieves the handle to the first control in a group of controls that precedes (or follows) the specified control hCtl in the dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
hCtl	The handle to the control.
bPrevious	A boolean value indicates to retrive the preceding or following control. TRUE for preceding control.

Returns: The handle to the preceding or following control.

See also: GetNextDlgTabItem

◆ GetNextDlgTabItem()

HWND GUIAPI GetNextDlgTabItem	(	HWND	hDlg,
		HWND	hCtl,
		BOOL	bPrevious
	)

Retrieve the handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control.

This function retrieves the handle to the first control that has the WS_TABSTOP style that precedes (or follows) the specified control hCtl in the dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
hCtl	The handle to the control.
bPrevious	A boolean value indicates to retrive the preceding or following control. TRUE for preceding control.

Returns: The handle to the preceding or following control.

See also: GetNextDlgGroupItem

◆ IsDlgButtonChecked()

int GUIAPI IsDlgButtonChecked	(	HWND	hDlg,
		LINT	idButton
	)

Determine whether a button control has a check mark next to it or whether a three-state button control is grayed, checked, or neither.

This function determines whether the button control whose identifier is idButton has a check mark next to it or whether a three-state button control is grayed, checked, or neither.

Parameters

hDlg	The handle to the dialog box.
idButton	The identifier of the button.

Returns

The check state of the button. If the button is a normal button, the value being zero means the button is checked, otherwise unchecked. If the button is a special button with three states, the value can be one of the following values:

BST_UNCHECKED
The button is unchecked.
BST_CHECKED
The button is checked.
BST_INDETERMINATE
The button is in indeterminate state.

Note: The type of idButton tem changed from int to LINT since v3.2.

See also: CheckDlgButton

◆ SendDlgItemMessage()

LRESULT GUIAPI SendDlgItemMessage	(	HWND	hDlg,
		LINT	nIDDlgItem,
		UINT	message,
		WPARAM	wParam,
		LPARAM	lParam
	)

Send a message to the specified control in a dialog box.

This function sends a message specified by (message, wParam, lParam) to the specified control whose identifier is nIDDlgItem in the dialog box hDlg.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.
message	The message identifier.
wParam	The first message parameter.
lParam	The second message parameter.

Returns: The return value of the message handler.

Note: The type of nIDDlgItem changed from int to LINT since v3.2.

See also: SendMessage, GetDlgItem

◆ SetDlgItemInt()

BOOL GUIAPI SetDlgItemInt	(	HWND	hDlg,
		LINT	nIDDlgItem,
		UINT	uValue,
		BOOL	bSigned
	)

Set the text of a control in a dialog box to the string representation of a specified integer value.

This function sets the text of the control whose identifier is nIDDlgItem in the dialog box hDlg to the string representation of the specified integer value nValue.

Parameters

hDlg	The handle to the dialog box.
nIDDlgItem	The identifier of the control.
uValue	The 32-bit integer value.
bSigned	A boolean value indicates whether the integer value is a signed integer.

Returns: TRUE on success, FALSE on error.

Note: The type of nIDDlgItem changed from int to LINT since v3.2.

See also: GetDlgItemInt, SetDlgItemText

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ DLGC_3STATE

◆ DLGC_BUTTON

◆ DLGC_DEFPUSHBUTTON

◆ DLGC_HASSETSEL

◆ DLGC_PUSHBUTTON

◆ DLGC_RADIOBUTTON

◆ DLGC_STATIC

◆ DLGC_WANTALLKEYS

◆ DLGC_WANTARROWS

◆ DLGC_WANTCHARS

◆ DLGC_WANTENTER

◆ DLGC_WANTTAB

Typedef Documentation

◆ CTRLDATA

◆ DLGTEMPLATE

Function Documentation

◆ CheckDlgButton()

◆ CheckRadioButton()

◆ CreateMainWindowIndirect()

◆ CreateMainWindowIndirectParam()

◆ CreateMainWindowIndirectParamEx()

◆ DestroyAllControls()

◆ DestroyMainWindowIndirect()

◆ DialogBoxIndirectParam()

◆ DialogBoxIndirectParamEx()

◆ EndDialog()

◆ GetDlgCtrlID()

◆ GetDlgDefPushButton()

◆ GetDlgItem()

◆ GetDlgItemInt()

◆ GetDlgItemText()

◆ GetDlgItemText2()

◆ GetNextDlgGroupItem()

◆ GetNextDlgTabItem()

◆ IsDlgButtonChecked()

◆ SendDlgItemMessage()

◆ SetDlgItemInt()