IconPopupItem

Functions
void	mdlDialog_colorIconPopupUpdate (DialogItem *diP, UInt32 colorNumber, UInt32 byLevelColor, UInt32 byCellColor, bool bByText, DgnModelRefP modelRef)
	Updates a color IconPopup with the correct colors and text. More...
StatusInt	mdlDialog_iconPopupGetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *maskP, int *invertP, RawItemHdr *icPopP)
	Retrieves information about an IconPopup item. More...
StatusInt	mdlDialog_iconPopupSetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *maskP, int *invertP, RawItemHdr *icPopP)
	Sets information for an IconPopup item. More...
StatusInt	mdlDialog_iconPopupGetAttributes (UInt32 *attributesP, RawItemHdr *icPopP)
	Retrieves attributes for an IconPopup item. More...
StatusInt	mdlDialog_iconPopupSetAttributes (UInt32 *attributesP, RawItemHdr *icPopP)
	Sets the attributes for an IconPopup item. More...
StatusInt	mdlDialog_iconPopupSetIcon (RawItemHdr *icPopP, RscId *iconIdP, RscType *iconTypeP, MdlDesc **iconOwnerMDP)
	Sets the icon to display in an IconPopup item. More...
StatusInt	mdlDialog_iconPopupSetPressedIcon (RawItemHdr *icPopP, RscId *iconIdP, RscType *iconTypeP, MdlDesc **iconOwnerMDP)
	Sets the icon to display when an IconPopup is pressed. More...
StatusInt	mdlDialog_iconPopupSetIconP (RawItemHdr *icPopP, IconRsc **iconRscPP, IconRsc **pressedIconRscPP)
	Sets the pointers to the icon resources to display. More...
StatusInt	mdlDialog_iconPopupSetIconColors (RawItemHdr *icPopP, BSIColorDescr **iconFgColorPP, BSIColorDescr **iconBgColorPP)
	Sets the colors to be used when drawing a mono color icon in an IconPopup. More...
StatusInt	mdlDialog_iconPopupSetPopupInfo (RawItemHdr *icPopP, int *originXP, int *paddingP)
	Sets override information about the popup window. More...
StatusInt	mdlDialog_iconPopupGetPopupItem (RscType *itemTypeP, RscId *itemIdP, MdlDesc **itemOwnerMDP, RawItemHdr **childItemPP, RawItemHdr *icPopP)
	Retrieves information about the item to popup. More...
StatusInt	mdlDialog_iconPopupSetPopupItem (RawItemHdr *icPopP, RscType *itemTypeP, RscId *itemIdP, MdlDesc **itemOwnerMDP)
	Sets override information about the item to popup. More...
StatusInt	mdlDialog_iconPopupSetInsideLabel (RawItemHdr *icPopP, WCharCP pLabel)
	Sets the text drawn inside the IconPopup if ICONPOPUPATTR_LABELONSIDE has been specified in the resource to draw the label on the side. More...
StatusInt	mdlDialog_iconPopupGetMutableInfo (bool *bMutableP, bool *bVerticalP, BSIRect *horizontalRectP, BSIRect *verticalRectP, RawItemHdr *icPopP)
	Retrieves horizontal/vertical information for a mutable IconPopup item, which can mutate between horizontal and vertical orientations. More...

Detailed Description

Function Documentation

void mdlDialog_colorIconPopupUpdate	(	DialogItem *	diP,
		UInt32	colorNumber,
		UInt32	byLevelColor,
		UInt32	byCellColor,
		bool	bByText,
		DgnModelRefP	modelRef
	)

Updates a color IconPopup with the correct colors and text.

Parameters

[in]	diP	icon popup dialog item.
[in]	colorNumber	color index of the color to display in the IconPopup.
[in]	byLevelColor	color index of the By Level color.
[in]	byCellColor	color index of the By Cell color.
[in]	bByText	true = display the "ByLevel" or "ByCell" text instead of the color number.
[in]	modelRef	modelRef to use for color table. Pass ACTIVEMODEL as a default.

StatusInt mdlDialog_iconPopupGetAttributes	(	UInt32 *	attributesP,
		RawItemHdr *	icPopP
	)

Retrieves attributes for an IconPopup item.

Parameters

[out]	attributesP	set NULL if don't want attributes
[in]	icPopP	IconPopup item to get info on

Returns

SUCCESS, or a non-zero value upon encountering an error.

StatusInt mdlDialog_iconPopupGetInfo	(	CommandNumber *	commandNumberP,
		UInt32 *	commandSourceP,
		UInt32 *	maskP,
		int *	invertP,
		RawItemHdr *	icPopP
	)

Retrieves information about an IconPopup item.

For all of the pointer parameters, NULL indicates the field is not desired.

Parameters

[out]	commandNumberP	set NULL if don't want cmd number
[out]	commandSourceP	set NULL if don't want cmd source
[out]	maskP	points to a UInt32 that contains the value mask
[out]	maskP	points to a variable containing the mask for setting bits in the variable associated with the item. See the discussion of the item resource for details.
[out]	invertP	indicates whether to invert the function of the maskP variable. Again, see the discussion of the item resource for details.
[in]	icPopP	IconPopup item to get info on

Returns

SUCCESS, or a non-zero value upon encountering an error.

StatusInt mdlDialog_iconPopupGetMutableInfo	(	bool *	bMutableP,
		bool *	bVerticalP,
		BSIRect *	horizontalRectP,
		BSIRect *	verticalRectP,
		RawItemHdr *	icPopP
	)

Retrieves horizontal/vertical information for a mutable IconPopup item, which can mutate between horizontal and vertical orientations.

Parameters

[out]	bMutableP	set NULL if don't want mutable status
[out]	bVerticalP	set NULL if don't want vertical status
[out]	horizontalRectP	set NULL if don't want horizontal rectangle
[out]	verticalRectP	set NULL if don't want vertical rectangle
[in]	icPopP	IconPopup item to get info on

Returns

SUCCESS, or a non-zero value upon encountering an error.

StatusInt mdlDialog_iconPopupGetPopupItem	(	RscType *	itemTypeP,
		RscId *	itemIdP,
		MdlDesc **	itemOwnerMDP,
		RawItemHdr **	childItemPP,
		RawItemHdr *	icPopP
	)

Retrieves information about the item to popup.

Parameters

[out]	itemTypeP	set NULL if don't want type of item to popup, ie. RTYPE_Container.
[out]	itemIdP	set NULL if don't want id of item to popup, ie. CONTAINERID_xxx.
[out]	itemOwnerMDP	set NULL if don't want ownerMD of item to popup.
[out]	childItemPP	set NULL if don't want RawItemHdr pointer of popup item.
[in]	icPopP	IconPopup item to get info on

Returns

SUCCESS, or a non-zero value upon encountering an error.

StatusInt mdlDialog_iconPopupSetAttributes	(	UInt32 *	attributesP,
		RawItemHdr *	icPopP
	)

Sets the attributes for an IconPopup item.

Parameters

[in]	attributesP	points to a variable indicating the new attributes
[in]	icPopP	points to the RawItemHdr of the item in question.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetIcon	(	RawItemHdr *	icPopP,
		RscId *	iconIdP,
		RscType *	iconTypeP,
		MdlDesc **	iconOwnerMDP
	)

Sets the icon to display in an IconPopup item.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	iconIdP	is a pointer to the icon ID of the icon to display in the IconPopup.
[in]	iconTypeP	is a pointer to the icon type of the icon to display.
[in]	iconOwnerMDP	is a pointer to the MDL Descriptor of the owning task of the icon.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetIconColors	(	RawItemHdr *	icPopP,
		BSIColorDescr **	iconFgColorPP,
		BSIColorDescr **	iconBgColorPP
	)

Sets the colors to be used when drawing a mono color icon in an IconPopup.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	iconFgColorPP	is a pointer to the Color Descriptor of color to use for the on value of a mono color icon.
[in]	iconBgColorPP	is a pointer to the Color Descriptor of color to use for the off value of a mono color icon.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetIconP	(	RawItemHdr *	icPopP,
		IconRsc **	iconRscPP,
		IconRsc **	pressedIconRscPP
	)

Sets the pointers to the icon resources to display.

The application is responsible for freeing the icon resources.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	iconRscPP	is a pointer to the icon resource to display when not pressed.
[in]	pressedIconRscPP	is a pointer to the icon resource to display when pressed.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetInfo	(	CommandNumber *	commandNumberP,
		UInt32 *	commandSourceP,
		UInt32 *	maskP,
		int *	invertP,
		RawItemHdr *	icPopP
	)

Sets information for an IconPopup item.

Each of the parameters except icPopP may be NULL, indicating the information is not to be set.

Parameters

[in]	commandNumberP	points to a variable indicating the command number associated with the button.
[in]	commandSourceP	points to a variable indicating the source of the command, typically MCMD for a MicroStation command or LCMD for an MDL application command.
[in]	maskP	points to a variable containing the mask for setting bits in the variable associated with the item. See the discussion of the item resource for details.
[in]	invertP	indicates whether to invert the function of the maskP variable. Again, see the discussion of the item resource for details.
[in]	icPopP	points to the RawItemHdr of the item in question.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetInsideLabel	(	RawItemHdr *	icPopP,
		WCharCP	pLabel
	)

Sets the text drawn inside the IconPopup if ICONPOPUPATTR_LABELONSIDE has been specified in the resource to draw the label on the side.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	pLabel	the value of the text to draw inside the IconPopup.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetPopupInfo	(	RawItemHdr *	icPopP,
		int *	originXP,
		int *	paddingP
	)

Sets override information about the popup window.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	originXP	pointer to the new X origin of the pop up window.
[in]	paddingP	pointer to the new padding amount of the pop up window.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetPopupItem	(	RawItemHdr *	icPopP,
		RscType *	itemTypeP,
		RscId *	itemIdP,
		MdlDesc **	itemOwnerMDP
	)

Sets override information about the item to popup.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	itemTypeP	pointer to the new item type.
[in]	itemIdP	pointer to the new item id.
[in]	itemOwnerMDP	pointer to the ownerMD of the new item.

Returns

SUCCESS, or non-zero if an error occurred.

StatusInt mdlDialog_iconPopupSetPressedIcon	(	RawItemHdr *	icPopP,
		RscId *	iconIdP,
		RscType *	iconTypeP,
		MdlDesc **	iconOwnerMDP
	)

Sets the icon to display when an IconPopup is pressed.

Parameters

[in]	icPopP	points to the RawItemHdr of the IconPopup item.
[in]	iconIdP	is a pointer to the icon ID of the icon to display in the IconPopup when pressed.
[in]	iconTypeP	is a pointer to the icon type of the icon to display.
[in]	iconOwnerMDP	is a pointer to the MDL Descriptor of the owning task of the icon.

Returns

SUCCESS, or non-zero if an error occurred.