Functions
ToggleButton Item

Functions

StatusInt mdlDialog_toggleButtonGetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *maskP, int *invertP, RawItemHdr *tButP)
 Gets information on Toggle Button items. More...
 
StatusInt mdlDialog_toggleButtonSetInfo (CommandNumber *commandNumberP, UInt32 *commandSourceP, UInt32 *maskP, int *invertP, RawItemHdr *tButP)
 Sets information on Toggle Button items. More...
 
StatusInt mdlDialog_toggleButtonGetIcon (RawItemHdr *tButP, RscId *iconIdP, RscType *iconTypeP, MdlDesc **iconOwnerMDP, IconRsc **iconRscPP)
 Gets the icon that is specified for the given ToggleButton or ToggleIcon item. More...
 
StatusInt mdlDialog_toggleButtonSetIcon (RawItemHdr *tButP, RscId *iconIdP, RscType *iconTypeP, MdlDesc **iconOwnerMDP)
 Sets the icon information for a ToggleButton or ToggleIcon item. More...
 
StatusInt mdlDialog_toggleButtonSetPressedIcon (RawItemHdr *tButP, RscId *iconIdP, RscType *iconTypeP, MdlDesc **iconOwnerMDP)
 Sets the pressed icon id, type and owner for the specified togglebutton dialog item. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_toggleButtonGetIcon ( RawItemHdr tButP,
RscId iconIdP,
RscType iconTypeP,
MdlDesc **  iconOwnerMDP,
IconRsc **  iconRscPP 
)

Gets the icon that is specified for the given ToggleButton or ToggleIcon item.

Any of the parameters receiving information back from this function can be set to NULL if that information is not required.

Parameters
[in]tButPpoints to the RawItemHdr for the ToggleButton or ToggleIcon item
[out]iconIdPis the Id of the icon.
[out]iconTypePis the icon type of the specified pull down menu item.
[out]iconOwnerMDPis the owner MD of the icon.
[out]iconRscPPreceives a pointer to the icon resource.
Returns
SUCCESS, or non-zero value if an error occurs.
See also
mdlDialog_toggleButtonSetIcon
StatusInt mdlDialog_toggleButtonGetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
UInt32 maskP,
int *  invertP,
RawItemHdr tButP 
)

Gets information on Toggle Button items.

Each of the parameters except tButP may be NULL, indicating that the information is not to be retrieved.

Parameters
[out]commandNumberPpoints to a variable indicating the command number associated with the Toggle Button.
[out]commandSourcePpoints to a variable indicating the source of the command, typically MCMD for a MicroStation command or LCMD for an MDL application command.
[out]maskPpoints to a variable containing the mask for setting bits in the variable associated with the Toggle Button. See the discussion of the Toggle Button item resource for details.
[out]invertPindicates whether to invert the function of the maskP variable. Again, see the discussion of the Toggle Button item resource for details.
[in]tButPpoints to the RawItemHdr of the Toggle Button in question.
Returns
SUCCESS if successful, or non-zero if an error occurred.
StatusInt mdlDialog_toggleButtonSetIcon ( RawItemHdr tButP,
RscId iconIdP,
RscType iconTypeP,
MdlDesc **  iconOwnerMDP 
)

Sets the icon information for a ToggleButton or ToggleIcon item.

Parameters
[in]tButPpoints to the RawItemHdr for the ToggleButton or ToggleIcon item
[in]iconIdPpoints to a long representing the id of the icon to be used
[in]iconTypePpoints to an unsigned long representing the type of icon to be used
[in]iconOwnerMDPpoints to the MDL Descriptor of the icon to be used
Returns
SUCCESS, or non-zero value if the tButP is invalid.
See also
mdlDialog_toggleButtonSetPressedIcon
StatusInt mdlDialog_toggleButtonSetInfo ( CommandNumber *  commandNumberP,
UInt32 commandSourceP,
UInt32 maskP,
int *  invertP,
RawItemHdr tButP 
)

Sets information on Toggle Button items.

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

Parameters
[in]commandNumberPpoints to a variable indicating the command number associated with the toggle button.
[in]commandSourcePpoints to a variable indicating the source of the command, typically MCMD for a MicroStation command or LCMD for an MDL application command.
[in]maskPpoints to a variable containing the mask for setting bits in the variable associated with the Toggle Button. See the discussion of the Toggle Button item resource for details.
[in]invertPindicates whether to invert the function of the maskP variable. Again, see the discussion of the Toggle Button item resource for details.
[in]tButPpoints to the RawItemHdr of the Toggle Button in question.
Returns
SUCCESS if successful, or non-zero if an error occurred.
StatusInt mdlDialog_toggleButtonSetPressedIcon ( RawItemHdr tButP,
RscId iconIdP,
RscType iconTypeP,
MdlDesc **  iconOwnerMDP 
)

Sets the pressed icon id, type and owner for the specified togglebutton dialog item.

Parameters
[in]tButPis the togglebutton to set the pressed icon for.
[in]iconIdPis the Id of the pressed icon, or NULL if not setting this information.
[in]iconTypePis the icon type, or NULL if not setting this information.
[in]iconOwnerMDPis the icon ownerMD, or NULL if not setting this information.
Returns
SUCCESS, or non-zero value if an error occurs.
See also
mdlDialog_toggleButtonSetIcon

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