Functions
ToggleIcon Item

Functions

StatusInt mdlDialog_toggleIconSetIconColors (RawItemHdr *tIconP, BSIColorDescr **iconFgColorPP, BSIColorDescr **iconBgColorPP)
 Sets the colors to be used when drawing a mono color icon in the ToggleIcon. More...
 
StatusInt mdlDialog_toggleIconGetAttributes (RawItemHdr *tIconP, UInt32 *attributesP, IconCmdSelectType *selectTypeP)
 Gets attributes and the selection type from the ToggleIcon. More...
 
StatusInt mdlDialog_toggleIconSetAttributes (RawItemHdr *tIconP, UInt32 *attributesP, IconCmdSelectType *selectTypeP, int redraw)
 Sets attributes and the selection type of the ToggleIcon. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_toggleIconGetAttributes ( RawItemHdr tIconP,
UInt32 attributesP,
IconCmdSelectType selectTypeP 
)

Gets attributes and the selection type from the ToggleIcon.

Parameters
[in]tIconPpoints to the RawItemHdr of the ToggleIcon item.
[out]attributesPis a pointer to a UInt32 that receives the attributes of the ToggleIcon item.
selectTypePout is a pointer to an int that receives the selection type of the ToggleIcon item. The select types are defined in dlogitem.h and begin with "ICONCMD_SELECTTYPE_".
Returns
SUCCESS if successful, or non-zero if an error occurred.
StatusInt mdlDialog_toggleIconSetAttributes ( RawItemHdr tIconP,
UInt32 attributesP,
IconCmdSelectType selectTypeP,
int  redraw 
)

Sets attributes and the selection type of the ToggleIcon.

Parameters
[in]tIconPpoints to the RawItemHdr of the ToggleIcon item.
[in]attributesPis a pointer to the new attributes of the ToggleIcon item.
[in]selectTypePis a pointer to the new selection type of the ToggleIcon item. The select types are defined in dlogitem.h and begin with "ICONCMD_SELECTTYPE_".
[in]redrawindicates whether the ToggleIcon should be redrawn
Returns
SUCCESS if successful, or non-zero if an error occurred.
StatusInt mdlDialog_toggleIconSetIconColors ( RawItemHdr tIconP,
BSIColorDescr **  iconFgColorPP,
BSIColorDescr **  iconBgColorPP 
)

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

Parameters
[in]tIconPpoints to the RawItemHdr of the ToggleIcon item.
[in]iconFgColorPPis a pointer to the Color Descriptor of color to use for the on value of a mono color icon.
[in]iconBgColorPPis a pointer to the Color Descriptor of color to use for the off value of a mono color icon.
Returns
SUCCESS if successful, or non-zero if an error occurred.

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.