Functions
Icon and IconCommand

Functions

void mdlDialog_selectIconsByCmd (MSDialog *initiatingDbP, CommandNumber commandNumber, WCharCP taskId, IconCmdSelectType selectType)
 Sets the selection state of an icon given its command number and the task ID of its owner. More...
 
void mdlDialog_selectIconsByCmdNoMsg (MSDialog *initiatingDbP, CommandNumber commandNumber, WCharCP taskId, IconCmdSelectType selectType)
 Sets the selection state of an icon given its command number and the task ID of its owner, but does not display the command message in the Command Window. More...
 
void mdlDialog_selectIconsById (RscId iconId, MdlDescP ownerMD, IconCmdSelectType selectType, bool deselectOthers, bool updateToolSettings)
 Sets the selection state of an icon given its ID and a pointer to the MDL descriptor of its owner, and displays the command message in the Command Window. More...
 
void mdlDialog_selectIconsByIdNoMsg (RscId iconId, MdlDescP ownerMD, IconCmdSelectType selectType, bool deselectOthers, bool updateToolSettings)
 Sets the selection state of an icon given its ID and a pointer to the MDL descriptor of its owner, but does not display the command message in the Command Window. More...
 

Detailed Description

Function Documentation

void mdlDialog_selectIconsByCmd ( MSDialog initiatingDbP,
CommandNumber  commandNumber,
WCharCP  taskId,
IconCmdSelectType  selectType 
)

Sets the selection state of an icon given its command number and the task ID of its owner.

Parameters
[in]initiatingDbPpoints to the initiating Dialog Box, or may be NULL.
[in]commandNumberindicates which icon to set be specifying the command number. A value of 0 indicates that the number of the currently active command should be used.
[in]taskIdindicates the task owning the command number and icon to seek. If it is NULL, the currently active task is used.
[in]selectTypegives the desired selection state of the icon. It may be IconCmdSelectType::Off, IconCmdSelectType::SingleShot or IconCmdSelectType::Locked. If it is -1, the previous value of selectType is used.
See also
mdlDialog_selectIconsById mdlDialog_selectIconsByIdNoMsg
Remarks
Required Library: mdlbltin.lib
void mdlDialog_selectIconsByCmdNoMsg ( MSDialog initiatingDbP,
CommandNumber  commandNumber,
WCharCP  taskId,
IconCmdSelectType  selectType 
)

Sets the selection state of an icon given its command number and the task ID of its owner, but does not display the command message in the Command Window.

Parameters
[in]initiatingDbPpoints to the initiating Dialog Box, or may be NULL.
[in]commandNumberindicates which icon to set be specifying the command number. A value of 0 indicates that the number of the currently active command should be used.
[in]taskIdindicates the task owning the command number and icon to seek. If it is NULL, the currently active task is used.
[in]selectTypegives the desired selection state of the icon. It may be IconCmdSelectType::Off, IconCmdSelectType::SingleShot or IconCmdSelectType::Locked. If it is -1, the previous value of selectType is used.
See also
mdlDialog_selectIconsById mdlDialog_selectIconsByIdNoMsg
Remarks
Required Library: mdlbltin.lib
void mdlDialog_selectIconsById ( RscId  iconId,
MdlDescP  ownerMD,
IconCmdSelectType  selectType,
bool  deselectOthers,
bool  updateToolSettings 
)

Sets the selection state of an icon given its ID and a pointer to the MDL descriptor of its owner, and displays the command message in the Command Window.

Parameters
[in]iconIdid of icon to select
[in]ownerMDNULL or ownerMD of icon
[in]selectTypeICONCMD_SELECTTYPE_xxx
[in]deselectOthersshould be true
[in]updateToolSettingstrue means update TS Dialog Box
See also
mdlDialog_selectIconsByCmd mdlDialog_selectIconsByCmdNoMsg mdlDialog_selectIconsByIdNoMsg
Remarks
Required Library: mdlbltin.lib
void mdlDialog_selectIconsByIdNoMsg ( RscId  iconId,
MdlDescP  ownerMD,
IconCmdSelectType  selectType,
bool  deselectOthers,
bool  updateToolSettings 
)

Sets the selection state of an icon given its ID and a pointer to the MDL descriptor of its owner, but does not display the command message in the Command Window.

Parameters
[in]iconIdis the ID of the icon whose selection state is to be modified.
[in]ownerMDpoints to the MDL descriptor of the icon's owner.
[in]selectTypegives the desired selection state of the icon. It may be IconCmdSelectType::Off, IconCmdSelectType::SingleShot or IconCmdSelectType::Locked.
[in]deselectOthersindicates whether all other icons should be set to IconCmdSelectType::Off, and should usually be true.
[in]updateToolSettingsindicates whether the Tool Settings dialog should be updated to show the settings associated with the icon whose selection state is being updated.
See also
mdlDialog_selectIconsByCmd mdlDialog_selectIconsByCmdNoMsg
Remarks
Required Library: mdlbltin.lib

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