Functions
StatusInt	mdlDialog_buttonGroupSetEnabled (RawItemHdr *bGroupP, int subItemIndex, bool enabled)
	Enables/disables a sub item of a ButtonGroup in a MSDialog. More...

StatusInt	mdlDialog_buttonGroupGetSubInfo (WChar labelP, RscType iconTypeP, RscId iconIdP, IconRsc iconPP, CommandNumber commandNumberP, int commandSourceP, UInt32 valueP, UInt32 maskP, UInt32 arrayIndexP, UInt32 attributesP, void userDataPP, RawItemHdr bGroupP, int subItemIndex)
	Gets specific information about a sub item of a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupSetSubInfo (WCharCP labelP, RscType iconTypeP, RscId iconIdP, IconRsc *iconPP, CommandNumber commandNumberP, int commandSourceP, UInt32 valueP, UInt32 maskP, UInt32 arrayIndexP, UInt32 attributesP, void userDataPP, RawItemHdr bGroupP, int subItemIndex, bool redraw)
	Gets specific information about a sub item of a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupSetGreyed (RawItemHdr *bGroupP, int subItemIndex, bool greyed, bool redraw)
	Sets the specified sub item of a ButtonGroup to be greyed out (unselectable). More...

int	mdlDialog_buttonGroupGetNItems (RawItemHdr *bGroupP)
	Gets the number of sub items in a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupInsSubItem (WCharCP labelP, RscType iconTypeP, RscId iconIdP, CommandNumber commandNumberP, int commandSourceP, UInt32 valueP, UInt32 maskP, UInt32 arrayIndexP, UInt32 attributesP, void *userDataH, RawItemHdr bGroupP, int subItemIndex, bool redraw)
	Adds a sub item to the specified ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupInsSubItemDesc (WCharCP labelP, RscType iconTypeP, RscId iconIdP, CommandNumber commandNumberP, int commandSourceP, UInt32 valueP, UInt32 maskP, UInt32 arrayIndexP, UInt32 attributesP, void *userDataH, RawItemHdr bGroupP, int subItemIndex, bool redraw, MdlDesc *ownerMD)
	Adds a sub item to the specified ButtonGroup from a given Mdl Descriptor. More...

StatusInt	mdlDialog_buttonGroupDeleteItem (RawItemHdr *bGroupP, int subItemIndex)
	Deletes a sub item from a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupDeleteAll (RawItemHdr *bGroupP)
	Deletes a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupDrawSubItem (RawItemHdr *bGroupP, int subItemIndex)
	Draws a sub item from a ButtonGroup. More...

StatusInt	mdlDialog_buttonGroupSetPositionalScanCodes (RawItemHdr *bGroupP, int iZone, int iZoneItem, bool bShow, bool bRedraw)
	Sets or unsets the positional scancodes for the items in a ButtonGroup. More...

Detailed Description

Function Documentation

StatusInt mdlDialog_buttonGroupDeleteAll ( RawItemHdr * bGroupP )

Deletes a ButtonGroup.

Parameters

[in] bGroupP specifies the ButtonGroup to delete.

Returns: SUCCESS, or non-zero value if an error occurs, otherwise false.

See also: mdlDialog_buttonGroupDeleteItem

StatusInt mdlDialog_buttonGroupDeleteItem	(	RawItemHdr *	bGroupP,
		int	subItemIndex
	)

Deletes a sub item from a ButtonGroup.

Parameters

[in]	bGroupP	specifies the ButtonGroup from which to delete the sub item.
[in]	subItemIndex	is the index of the sub item to delete from the group.

Returns: SUCCESS, or non-zero value if an error occurs, otherwise false.

See also: mdlDialog_buttonGroupDeleteAll

StatusInt mdlDialog_buttonGroupDrawSubItem	(	RawItemHdr *	bGroupP,
		int	subItemIndex
	)

Draws a sub item from a ButtonGroup.

Parameters

[in]	bGroupP	specifies the ButtonGroup sub item to draw.
[in]	subItemIndex	is the index of the sub item to draw.

Returns: SUCCESS, or non-zero value if an error occurs, otherwise false.

See also: mdlDialog_buttonGroupDeleteItem

int mdlDialog_buttonGroupGetNItems ( RawItemHdr * bGroupP )

Gets the number of sub items in a ButtonGroup.

Parameters

[in] bGroupP is the ButtonGroup to get the sub item count from

Returns: The number of sub items in a ButtonGroup

StatusInt mdlDialog_buttonGroupGetSubInfo	(	WChar *	labelP,
		RscType *	iconTypeP,
		RscId *	iconIdP,
		IconRsc **	iconPP,
		CommandNumber *	commandNumberP,
		int *	commandSourceP,
		UInt32 *	valueP,
		UInt32 *	maskP,
		UInt32 *	arrayIndexP,
		UInt32 *	attributesP,
		void **	userDataPP,
		RawItemHdr *	bGroupP,
		int	subItemIndex
	)

Gets specific information about a sub item of a ButtonGroup.

Any of the arguments returning information about the ButtonGroup sub-item may be set to NULL if you don't want to receive that information.

Parameters

[out]	labelP	is the label of the group sub item.
[out]	iconTypeP	is the icon type of the group sub item.
[out]	iconIdP	is the icon ID of the group sub item.
[out]	iconPP	is a pointer to the icon resource for the group sub item.
[out]	commandNumberP	is the command number for the group sub item.
[out]	commandSourceP	is command source for the group sub item.
[out]	valueP	is the value for the group sub item.
[out]	maskP	is the mask for the group sub item.
[out]	arrayIndexP	is the index of the group sub item in the array of sub items.
[out]	attributesP	is a list of attributes of the group sub item.
[out]	userDataPP	is a pointer to user data associated with the group sub item.
[in]	bGroupP	specifies the ButtonGroup containing the sub item to get the specified information about.
[in]	subItemIndex	is the index of the sub item in the group about which the information is obtained.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupSetSubInfo

StatusInt mdlDialog_buttonGroupInsSubItem	(	WCharCP	labelP,
		RscType *	iconTypeP,
		RscId *	iconIdP,
		CommandNumber *	commandNumberP,
		int *	commandSourceP,
		UInt32 *	valueP,
		UInt32 *	maskP,
		UInt32 *	arrayIndexP,
		UInt32 *	attributesP,
		void **	userDataH,
		RawItemHdr *	bGroupP,
		int	subItemIndex,
		bool	redraw
	)

Adds a sub item to the specified ButtonGroup.

Parameters

[in]	labelP	is the labelf for the new sub item.
[in]	iconTypeP	specifies the icon type for the new sub item.
[in]	iconIdP	specifies the iconId for the new sub item.
[in]	commandNumberP	specifies the command number for the new sub item.
[in]	commandSourceP	set NULL if not setting command source
[in]	valueP	is the value for the sub item.
[in]	maskP	specifies the mask for the sub item.
[in]	arrayIndexP	is the index of the sub item in the array.
[in]	attributesP	specifies the attributes of the sub item.
[in]	userDataH	specifies any user data to be associated with the new sub item.
[in]	bGroupP	is the ButtonGroup to which the sub item is being added.
[in]	subItemIndex	indicates where in the list of sub items the new item is placed. The new sub item is inserted BEFORE the indicated item. To append to the end of the list, set this value to -1.
[in]	redraw	indicates whether the ButtonGroup sub item should be redrawn. Set this value to true to redraw the sub item.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupDeleteItem mdlDialog_buttonGroupGetSubInfo

StatusInt mdlDialog_buttonGroupInsSubItemDesc	(	WCharCP	labelP,
		RscType *	iconTypeP,
		RscId *	iconIdP,
		CommandNumber *	commandNumberP,
		int *	commandSourceP,
		UInt32 *	valueP,
		UInt32 *	maskP,
		UInt32 *	arrayIndexP,
		UInt32 *	attributesP,
		void **	userDataH,
		RawItemHdr *	bGroupP,
		int	subItemIndex,
		bool	redraw,
		MdlDesc *	ownerMD
	)

Adds a sub item to the specified ButtonGroup from a given Mdl Descriptor.

Parameters

[in]	labelP	is the labelf for the new sub item.
[in]	iconTypeP	specifies the icon type for the new sub item.
[in]	iconIdP	specifies the iconId for the new sub item.
[in]	commandNumberP	specifies the command number for the new sub item.
[in]	commandSourceP	set NULL if not setting command source
[in]	valueP	is the value for the sub item.
[in]	maskP	specifies the mask for the sub item.
[in]	arrayIndexP	is the index of the sub item in the array.
[in]	attributesP	specifies the attributes of the sub item.
[in]	userDataH	specifies any user data to be associated with the new sub item.
[in]	bGroupP	is the ButtonGroup to which the sub item is being added.
[in]	subItemIndex	indicates where in the list of sub items the new item is placed. The new sub item is inserted BEFORE the indicated item. To append to the end of the list, set this value to -1.
[in]	redraw	indicates whether the ButtonGroup sub item should be redrawn. Set this value to true to redraw the sub item.
[in]	ownerMD	Mdl Descriptor in which to find the sub ite.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupDeleteItem mdlDialog_buttonGroupGetSubInfo

StatusInt mdlDialog_buttonGroupSetEnabled	(	RawItemHdr *	bGroupP,
		int	subItemIndex,
		bool	enabled
	)

Enables/disables a sub item of a ButtonGroup in a MSDialog.

Parameters

[in]	bGroupP	is the ButtonGroup containing the item to enable or disable.
[in]	subItemIndex	is the index of the subitem to set.
[in]	enabled	determines whether the button is enabled or disabled. Set this argument to true to enable the button, or false to disable the button.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupSetGreyed

StatusInt mdlDialog_buttonGroupSetGreyed	(	RawItemHdr *	bGroupP,
		int	subItemIndex,
		bool	greyed,
		bool	redraw
	)

Sets the specified sub item of a ButtonGroup to be greyed out (unselectable).

Parameters

[in]	bGroupP	is the ButtonGroup containing the button to set.
[in]	subItemIndex	is the index of the button to set within the group.
[in]	greyed	is true if the button is to be set grey, or false if the button is already greyed and to be reset to its enabled or disabled state.
[in]	redraw	determines whether the button will be redrawn after the change.

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupSetEnabled

StatusInt mdlDialog_buttonGroupSetPositionalScanCodes	(	RawItemHdr *	bGroupP,
		int	iZone,
		int	iZoneItem,
		bool	bShow,
		bool	bRedraw
	)

Sets or unsets the positional scancodes for the items in a ButtonGroup.

Parameters

[in]	bGroupP	specifies the ButtonGroup to process.
[in]	iZone	the zone within the userPrefsP->scanCodeZones array to use.
[in]	iZoneItem	the first index within the userPrefsP->scanCodeZones[iZone] to use.
[in]	bShow	show or hide the position mapping aids.
[in]	bRedraw	Whether to redraw the Button Group after the set.

Returns: SUCCESS, or non-zero value if an error occurs.

StatusInt mdlDialog_buttonGroupSetSubInfo	(	WCharCP	labelP,
		RscType *	iconTypeP,
		RscId *	iconIdP,
		IconRsc **	iconPP,
		CommandNumber *	commandNumberP,
		int *	commandSourceP,
		UInt32 *	valueP,
		UInt32 *	maskP,
		UInt32 *	arrayIndexP,
		UInt32 *	attributesP,
		void **	userDataPP,
		RawItemHdr *	bGroupP,
		int	subItemIndex,
		bool	redraw
	)

Gets specific information about a sub item of a ButtonGroup.

Any of the arguments setting specific information about the ButtonGroup sub-item may be set to NULL if you aren't setting that information.

Parameters

[in]	labelP	is the label of the group sub item.
[in]	iconTypeP	is the icon type of the group sub item.
[in]	iconIdP	is the icon ID of the group sub item.
[in]	iconPP	is a pointer to the icon resource for the group sub item.
[in]	commandNumberP	is the command number for the group sub item.
[in]	commandSourceP	is command source for the group sub item.
[in]	valueP	is the value for the group sub item.
[in]	maskP	is the mask for the group sub item.
[in]	arrayIndexP	is the index of the group sub item in the array of sub items.
[in]	attributesP	is a list of attributes of the group sub item.
[in]	userDataPP	is a pointer to user data associated with the group sub item.
[in]	bGroupP	specifies the ButtonGroup containing the sub item to get the specified information about.
[in]	subItemIndex	is the index of the sub item in the group about which the information is obtained.
[in]	redraw	redraw ButtonGroup subItem?

Returns: SUCCESS, or non-zero value if an error occurs.

See also: mdlDialog_buttonGroupGetSubInfo

Functions

Detailed Description

Function Documentation