Functions
ToolBox Item

Functions

StatusInt mdlDialog_toolBoxChildSetEnabledByIndex (MSDialogP dbP, int iItem, bool enabled, bool ignoreFocusOutErrors)
 Similar to mdlDialog_itemSetEnabledState but sets the enabled state (enabled or disabled) of an item within the ToolBox in a specified Dialog Box. More...
 
StatusInt mdlDialog_toolBoxChildSetEnabledByTypeAndId (MSDialogP dbP, RscType itemType, RscId itemId, MdlDescP ownerMD, bool enabled, bool ignoreFocusOutErrors)
 Similar to mdlDialog_toolBoxChildSetEnabledByIndex but uses a type and id to find an item within the ToolBox in a specified Dialog Box. More...
 
StatusInt mdlDialog_toolBoxChildSetToolTipByIndex (MSDialogP dbP, int iItem, WCharCP pNewToolTip, bool disabledTip)
 Sets the ToolTip (Balloon) text of an item within the ToolBox in a specified Dialog Box. More...
 
StatusInt mdlDialog_toolBoxChildSetToolTipByTypeAndId (MSDialogP dbP, RscType itemType, RscId itemId, MdlDescP ownerMD, WCharCP pNewToolTip, bool disabledTip)
 Similar to mdlDialog_toolBoxChildSetToolTipByIndex but uses a type and id to find an item within the ToolBox in a Dialog Box and sets the ToolTip (Balloon) text. More...
 
StatusInt mdlDialog_createSubMenuForToolBox (DItem_PulldownMenuItem *mbarItemP, MSDialog *dbP, int tBoxId, MdlDesc *ownerMD)
 Creates a submenu for a menu item containing the contents of a ToolBox. More...
 
StatusInt mdlDialog_toolsMenuAddToolBox (WCharCP menuItemLabel, WCharCP taskId, int tBoxId, bool only3D, UICriteriaP uiCriteriaP)
 Creates a new menu item under the Tools menu containing a submenu with the contents of a ToolBox. More...
 

Detailed Description

Function Documentation

StatusInt mdlDialog_createSubMenuForToolBox ( DItem_PulldownMenuItem mbarItemP,
MSDialog dbP,
int  tBoxId,
MdlDesc ownerMD 
)

Creates a submenu for a menu item containing the contents of a ToolBox.

Parameters
[in]mbarItemPthe menu item for which to build the submenu
[in]dbPOptional MSDialog containing the ToolBox; if NULL, the ToolBox will be temporarily opened.
[in]tBoxIdResource Id of the ToolBox for which to generate the submenu.
[in]ownerMDOwning MdlDesc for the ToolBox.
Returns
SUCCESS, or ERROR if an error occurs.
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_toolBoxChildSetEnabledByIndex ( MSDialogP  dbP,
int  iItem,
bool  enabled,
bool  ignoreFocusOutErrors 
)

Similar to mdlDialog_itemSetEnabledState but sets the enabled state (enabled or disabled) of an item within the ToolBox in a specified Dialog Box.

Parameters
[in]dbPMSDialog that contains the ToolBox
[in]iItemparameter specifies the index of the item to enable or disable. itemIndex must be greater than or equal to 0, and less than the number of items in the ToolBox. Use mdlDialog_rItemChildGetCount to determine the number of items in a ToolBox.
[in]enabledparameter should be set to true to enable the item, or false to disable the item.
[in]ignoreFocusOutErrorsparameter can be used to ignore any focusing out errors (such as the current value being out of range) that may occur if the item to be disabled has the keyboard focus. It should usually be set false which indicates that focus out errors should not be ignored.
Returns
SUCCESS, or true if an error occurs. This means that dbP is not a pointer to a Dialog Box, iItem is out of range, or the item has the focus and the focus can not be removed (because the current value is out of range).
See also
mdlDialog_rItemChildGetCount mdlDialog_itemSetEnabledState
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_toolBoxChildSetEnabledByTypeAndId ( MSDialogP  dbP,
RscType  itemType,
RscId  itemId,
MdlDescP  ownerMD,
bool  enabled,
bool  ignoreFocusOutErrors 
)

Similar to mdlDialog_toolBoxChildSetEnabledByIndex but uses a type and id to find an item within the ToolBox in a specified Dialog Box.

Parameters
[in]dbPMSDialog that contains the ToolBox
[in]itemTypetype of item to get
[in]itemIdparameter specifies the resource id of the item to retrieve a pointer to.
[in]ownerMDparameter should be set to NULL.
[in]enabledparameter should be set to true to enable the item, or false to disable the item.
[in]ignoreFocusOutErrorsparameter can be used to ignore any focusing out errors (such as the current value being out of range) that may occur if the item to be disabled has the keyboard focus. It should usually be set false which indicates that focus out errors should not be ignored.
Returns
SUCCESS, or true if an error occurs. This means that dbP is not a pointer to a Dialog Box or the specified item is not found.
See also
mdlDialog_itemSetEnabledState mdlDialog_itemGetByTypeAndId
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_toolBoxChildSetToolTipByIndex ( MSDialogP  dbP,
int  iItem,
WCharCP  pNewToolTip,
bool  disabledTip 
)

Sets the ToolTip (Balloon) text of an item within the ToolBox in a specified Dialog Box.

Parameters
[in]dbPMSDialog that contains the ToolBox
[in]iItemparameter specifies the index of the item to enable or disable. itemIndex must be greater than or equal to 0, and less than the number of items in the ToolBox. Use mdlDialog_rItemChildGetCount to determine the number of items in a ToolBox.
[in]pNewToolTipstring to be displayed as the ToolTip for this item to disable the item.
[in]disabledTipindicates whether the text is displayed when the item is disabled (true) or enabled (false)
Returns
SUCCESS, or true if an error occurs. This means that dbP is not a pointer to a Dialog Box or iItem is out of range.
See also
mdlDialog_rItemChildGetCount mdlDialog_rItemBalloonTextSetA
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_toolBoxChildSetToolTipByTypeAndId ( MSDialogP  dbP,
RscType  itemType,
RscId  itemId,
MdlDescP  ownerMD,
WCharCP  pNewToolTip,
bool  disabledTip 
)

Similar to mdlDialog_toolBoxChildSetToolTipByIndex but uses a type and id to find an item within the ToolBox in a Dialog Box and sets the ToolTip (Balloon) text.

Parameters
[in]dbPMSDialog that contains the ToolBox
[in]itemTypetype of item to get
[in]itemIdparameter specifies the resource id of the item to retrieve a pointer to.
[in]ownerMDparameter should be set to NULL.
[in]pNewToolTipstring to be displayed as the ToolTip for this item to disable the item.
[in]disabledTipindicates whether the text is displayed when the item is disabled (true) or enabled (false)
Returns
SUCCESS, or ERROR if an error occurs. This means that dbP is not a pointer to a Dialog Box or or the specified item is not found.
See also
mdlDialog_itemGetByTypeAndId mdlDialog_rItemBalloonTextSetA
Remarks
Required Library: mdlbltin.lib
StatusInt mdlDialog_toolsMenuAddToolBox ( WCharCP  menuItemLabel,
WCharCP  taskId,
int  tBoxId,
bool  only3D,
UICriteriaP  uiCriteriaP 
)

Creates a new menu item under the Tools menu containing a submenu with the contents of a ToolBox.

Parameters
[in]menuItemLabelthe label for the new menu item
[in]tBoxIdResource Id of the ToolBox for which to generate the menu item.
[in]taskIdTask ID of the application owning the ToolBox
[in]only3DIndicates whether this is a toolbox that only applies in a 3D file
[in]uiCriteriaPAn instance of a UICriteria subclass that evaluates a condition to determine if the toolbox should be enabled. The Dialog Manager will delete this object.
Returns
SUCCESS, or ERROR if an error occurs.
Remarks
Required Library: mdlbltin.lib

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