Classes | |
struct | MSDialog |
MSDialog is the base class for Microstation/PowerPlatform desktop-based dialog boxes and view windows. More... | |
Functions | |
int | mdlDialog_setFilterString (WCharCP filterString) |
Sets the file filter string of a user-defined File Open or File Create Dialog Box. More... | |
int | mdlDialog_autoOpen (int *numOpenedP, UInt32 dialogWindowType, bool openDialogs) |
Opens any dialogs belonging to the calling application that were present on the screen when MicroStation last shut down. More... | |
MSDialogP | mdlDialog_find (RscId dialogId, MdlDescP ownerMD) |
Gets a pointer to the currently open Dialog Box whose resource ID is dialogId. More... | |
MSDialogP | mdlDialog_findByTypeAndId (RscType dialogType, RscId dialogId, MdlDescP ownerMD) |
Obtains a pointer to an open Dialog Box according to its resource class (dialog type) and ID. More... | |
MSDialogP | mdlDialog_getFirst (void) |
Gets the first dialog in the dialog list. More... | |
MSDialogP | mdlDialog_getNext (MSDialogP dbP) |
Gets the next dialog in the dialog list, given a specific dialog. More... | |
MSDialogP | mdlDialog_getParent (MSDialogP dbP) |
Gets the dialog assigned as the parent of a given dialog. More... | |
StatusInt | mdlDialog_setParent (MSDialogP dbP, MSDialogP parentDbP) |
Sets the parent dialog of a given child dialog. More... | |
bool | mdlDialog_isAncestor (MSDialogP dbP, MSDialogP testDbP) |
Determines if a dialog is the parent or ancestor of another dialog. More... | |
MSDialogP | mdlDialog_getChild (MSDialogP dbP, MSDialogP startDbP) |
Retrieves the first child dialog of a parent after a given child. More... | |
bool | mdlDialog_getMinimumSize (int *minWidthP, int *minHeightP, MSDialogP dbP) |
Retrieves the minimum size from a dialog. More... | |
RscId | mdlDialog_getResourceId (MSDialogP dbP) |
Retrieves the resource Id from a dialog. More... | |
bool | mdlDialog_hasFocus (MSDialogP dbP) |
Determines if a given Dialog Box currently has the input focus. More... | |
MSDialogP | mdlDialog_open (RscFileHandle rFileH, RscId resourceId) |
Opens a modal or modeless Dialog Box. More... | |
MSDialogP | mdlDialog_openWithMD (RscFileHandle rFileH, MdlDescP ownerMD, RscId resourceId) |
An extension of mdlDialog_open which allows the caller to pass a MDL Descriptor of the owner task of the dialog. More... | |
int | mdlDialog_openAlert (WCharCP stringP) |
Opens a modal Dialog Box that contains two push buttons labeled OK and Cancel, and a multi-line label item that will be set to the string pointed to by stringP. More... | |
int | mdlDialog_openAlertById (RscId dialogId, WCharCP stringP) |
Opens an alternate alert dialog box. More... | |
int | mdlDialog_openMessageBox (RscId dialogId, WCharCP stringP, MessageBoxIconType whichIcon) |
Opens a modal Dialog Box which contains one to three push buttons, a multi-line label item, and one of four icons. More... | |
int | mdlDialog_openInfoBox (WCharCP stringP) |
Opens a modal Dialog Box that contains a single push button labeled OK, and a multi-line label item that will be set to the string pointed to by stringP. More... | |
StatusInt | mdlDialog_openModal (int *lastActionTypeP, RscFileHandle rFileH, RscId resourceId) |
Opens a modal Dialog Box. More... | |
StatusInt | mdlDialog_openModalWithMD (int *lastActionTypeP, RscFileHandle rFileH, RscId resourceId, MdlDesc *ownerMD) |
An extension of mdlDialog_openModal which allows the caller to pass a MDL Descriptor of the owner task of the dialog. More... | |
MdlDescP | mdlDialog_ownerMDGet (MSDialogP dbP) |
Returns the MDL descriptor of the task that owns the given Dialog Box. More... | |
int | mdlDialog_parentIdGet (MSDialogP dbP) |
Retrieves the resource ID of the parent of the specified Dialog Box. More... | |
StatusInt | mdlDialog_parentIdSet (MSDialogP dbP, long parentId) |
Sets the parent resource ID of the specified Dialog Box to be parentId. More... | |
UserDataP | mdlDialog_userDataPtrGet (MSDialogP dbP) |
Retrieves the user data pointer of the specified Dialog Box. More... | |
StatusInt | mdlDialog_userDataPtrSet (MSDialogP dbP, UserDataP userDataP) |
Sets the user data pointer of the specified Dialog Box to be userDataP. More... | |
MSDialogP | mdlDialog_commandWindowGet (void) |
Returns a MSDialog pointer of the prompt and message area, which can be referenced without having to consider the currently selected interface style. More... | |
StatusInt | mdlDialog_hookDialogSendUserMsg (MSDialogP dbP, int type, CallbackArgP userDataP) |
Sends a user message to any dialog hook function that is attached to the specified Dialog Box. More... | |
StatusInt | mdlDialog_hookItemSendUserMsg (RawItemHdr *riP, int type, CallbackArgP userDataP) |
Sends a user message to any item hook function attached to the Dialog Box item specified by rihP. More... | |
StatusInt | mdlDialog_hookPublish (int nHooks, DialogHookInfo *hooks) |
Associates hook function ID numbers with hook function addresses. More... | |
bool | mdlDialog_isFirstLoad (RscId dialogId, MdlDescP ownerMD) |
Determines if a Dialog Box has been opened before. More... | |
StatusInt | mdlDialog_lastActionTypeSet (MSDialogP dbP, int actionType) |
Sets the action type that is sent to a dialog hook function as part of the DIALOG_MESSAGE_DESTROY message when a Dialog Box is closed. More... | |
StatusInt | mdlDialog_popupClose (MSDialogP dbP, bool bUpdate) |
Closes a popup dialog in the proper manner. More... | |
RawItemHdr * | mdlDialog_popupGetOwnerItem (MSDialogP dbP) |
Retrieves the owning dialog item which opened the popup window, if any. More... | |
MSDialog * | mdlDialog_popupGetOwnerDialog (MSDialogP dbP) |
Retrieves the owning dialog box which opened the popup window. More... | |
StatusInt | mdlDialog_synonymsSynch (RscFileHandle rFileH, int synonymsId, MdlDescP ownerMD) |
Forces the appearance of all items in the synonym resource specified by synonymsId to match their external state. More... | |
StatusInt | mdlDialog_synonymsDraw (RscFileHandle rFileH, int synonymsId, MdlDescP ownerMD) |
Draws all items in the synonym resource specified by synonymsId. More... | |
StatusInt | mdlDialog_synonymSetVisibility (int synonymsId, bool visible) |
Sets the visibility flag in all items in the synonym resource specified by synonymsId. More... | |
StatusInt | mdlDialog_synonymEnable (int synonymsId, bool enable) |
Sets the enabled flag in all items in the synonym resource specified by synonymsId. More... | |
StatusInt | mdlDialog_synonymReloadData (int synonymsId, bool redraw) |
Forces all items in the synonym resource specified by synonymsId to reload their data. More... | |
RawItemHdrP | mdlDialog_viewPopupMenuPGet (int buttonNum) |
Retrieves the RawItemHdr pointer of the Popup Menu associated with a View window. More... | |
RawItemHdrP | mdlDialog_defaultViewPopupMenuPGet (int buttonNum) |
Retrieves the RawItemHdr pointer of the default (non-dgnlib) Popup Menu associated with a View window. More... | |
void | mdlDialog_refreshNamedToolBox (WCharCP toolBoxPath) |
Refreshes the context of a Named ToolBox. More... | |
void | mdlDialog_setAllowToolBoxOverrides (bool value) |
Sets processing flag to allow for customized named ToolBoxes to override the original ToolBoxes when calling mdlDialog_find and mdlDialog_open functions. More... | |
void | mdlDialog_setAdditionalAboutLegalText (WCharCP wText) |
Sets additional text to appear in the About Box - "Legal and Patent Notices" section. More... | |
WCharCP | mdlDialog_getAdditionalAboutLegalText () |
Gets any additional text set to appear in the About Box - "Legal and Patent Notices" section. More... | |
MSDialog * | mdlDialog_create (RscFileHandle rFileH, MdlDescP ownerMD, RscType dialogType, RscId dialogId, bool noWarnResourceError) |
Opens a modal or modeless Dialog Box without displaying it on the user's display. More... | |
StatusInt | mdlDialog_ownerMDSet (MSDialogP dbP, MdlDescP ownerMD) |
Sets the MDL descriptor of the task that owns the given Dialog Box. More... | |
void | mdlDialog_show (MSDialogP dbP) |
Brings a Dialog Box back into view. More... | |
void | mdlDialog_setFocusToHome () |
Sets focus to the Home position. More... | |
StatusInt | mdlDialog_initializeToolSettings (RscFileHandle rfHandle, MdlDescP ownerMD, int ditemListId) |
Populates the Tool Settings window based on the dialog item list specified. More... | |
MSDialog * | mdlDialog_getToolSettings () |
Retrieves the pointer to the Tool Settings MSDialog. More... | |
StatusInt | mdlDialog_getEditMenuInfo (DItem_PulldownMenu *pMenu, EditMenuInfo *pMenuInfo) |
Retrieves information about the popup edit menu for the current item. More... | |
void | mdlDialog_getToggleIconIds (RscId *onIconIdP, RscId *offIconIdP, MSDialogP dbP) |
Retrieves the appropriate icons Ids for on and off icons based on the current font height. More... | |
RscId | mdlDialog_getSizedColorPatchId (MSDialogP dbP, RscId iconCmdId) |
Retrieves the appropriate icon id associated with a particular IconCmd id based on the current font height. More... | |
MSWindowP | mdlDialog_getNETDockingParentWindow (MSDialogP dbP) |
Retrieves the MSWindow pointer of the .NET Docking parent of a Dialog Box. More... | |
MSDialogP | mdlDialog_getNETDockingChildWindow (MSWindowP gwP) |
Retrieves the MSDialog pointer of the .NET Docking child of a Window. More... | |
void | mdlDialog_sendMessagesOnUnload (MdlDescP mdlDescP, bool bValue) |
Indicates whether the specified MDL application wishes to receive Dialog and Dialog Item messages when the application is unloading. More... | |
StatusInt | mdlDialog_getNETDockedExtents (MSDialogP dbP) |
Gets the Docked Extents from a .NET Dockable dialog and sends those extents to the .NET docking system. More... | |
void | mdlDialog_setCacheName (MSDialogP dbP, WCharCP pName) |
Sets the dialog's unique cache name. More... | |
bool | mdlDialog_isAutoOpen (MSDialogP dbP) |
Determines whether the dialog is Auto-Open. More... | |
void | mdlDialog_setAutoOpen (MSDialogP dbP, bool autoOpen) |
Sets the dialog to Auto-Open. More... | |
void | mdlDialog_setAutoOpenKeyin (MSDialogP dbP, WCharCP keyin) |
Sets the Keyin to use when opening the dialog as Auto-Open. More... | |
bool | mdlDialog_isCloseable (MSDialogP dbP) |
Determines whether the dialog is closeable. More... | |
void | mdlDialog_setCloseable (MSDialogP dbP, bool closeable) |
Sets the Closeable property for a MSDialog. More... | |
bool | mdlDialog_isNETDocked (MSDialogP dbP) |
Determines whether the dialog is docked. More... | |
AutoHideState | mdlDialog_getAutoHideState (MSDialogP dbP) |
Gets the AutoHide / Push-pin state for a .NET Dockable dialog. More... | |
bool | mdlDialog_isAutoHideCollapsed (MSDialogP dbP) |
Determines whether the dialog is in an Auto-Hide Collapsed state. More... | |
bool | mdlDialog_isAutoHideExpanded (MSDialogP dbP) |
Determines whether the dialog is in an Auto-Hide Expanded state. More... | |
StatusInt | mdlDialog_autoHideExpand (MSDialogP dbP, BSIRectP rectP) |
Expands the dialog from an Auto-Hide Collapsed state. More... | |
StatusInt | mdlDialog_autoHideCollapse (MSDialogP dbP) |
Collapses the dialog from an Auto-Hide Expanded state. More... | |
StatusInt | mdlDialog_autoHidePin (MSDialogP dbP) |
Pins the dialog from an Auto-Hide Unpinned state. More... | |
StatusInt | mdlDialog_autoHideUnpin (MSDialogP dbP) |
Unpins the dialog from an Auto-Hide Pinned state. More... | |
StatusInt | mdlDialog_getFloatingSize (MSDialogP dbP, Point2d *floatingSize) |
Gets the .NET Dockable Dialog's floating size. More... | |
StatusInt | mdlDialog_setNETDockingMinimumSize (MSDialogP dbP, int width, int height) |
Sets the MinimumSize property for a .NET Dockable MSDialog. More... | |
StatusInt | mdlDialog_setNETDockingUndockable (MSDialogP dbP, bool undockable) |
Sets the Undockable property for a .NET Dockable MSDialog. More... | |
StatusInt | mdlDialog_setNETDockingCanAutoHide (MSDialogP dbP, bool canAutoHide) |
Sets the CanAutoHide property for a .NET Dockable MSDialog. More... | |
bool | mdlDialog_containsToolBox (MSDialogP dbP) |
Determines if a Dialog Box contains a ToolBox item. More... | |
MSDialogP | mdlDialog_toolBoxCmd (RscFileHandle rFileH, MdlDescP ownerMD, RscId resourceId, WCharCP unparsedCP) |
Processes a 'DIALOG TOOLBOX' command. More... | |
void | mdlDialog_refresh (MSDialogP dbP) |
Refreshes the contents of a Dialog Box. More... | |
StatusInt mdlDialog_autoHideCollapse | ( | MSDialogP | dbP | ) |
Collapses the dialog from an Auto-Hide Expanded state.
[in] | dbP | The .NET Dockable MSDialog |
StatusInt mdlDialog_autoHideExpand | ( | MSDialogP | dbP, |
BSIRectP | rectP | ||
) |
Expands the dialog from an Auto-Hide Collapsed state.
[in] | dbP | The .NET Dockable MSDialog |
[in] | rectP | The rectangle, in global coordinates, for the expanded dialog. If NULL, it opens near the associated Auto-Hide tab. |
StatusInt mdlDialog_autoHidePin | ( | MSDialogP | dbP | ) |
Pins the dialog from an Auto-Hide Unpinned state.
[in] | dbP | The .NET Dockable MSDialog |
StatusInt mdlDialog_autoHideUnpin | ( | MSDialogP | dbP | ) |
Unpins the dialog from an Auto-Hide Pinned state.
[in] | dbP | The .NET Dockable MSDialog |
int mdlDialog_autoOpen | ( | int * | numOpenedP, |
UInt32 | dialogWindowType, | ||
bool | openDialogs | ||
) |
Opens any dialogs belonging to the calling application that were present on the screen when MicroStation last shut down.
If this function is used, it is generally called during the application's initialization.
[out] | numOpenedP | is a pointer to an integer where the number of dialogs opened is returned. If openDialogs if false, the value pointed to by numOpenedP will indicate the number of dialogs that would have been opened if openDialogs was true. |
[in] | dialogWindowType | indicates whether dialogs should be redisplayed. |
[in] | openDialogs | indicates whether the dialogs should really be opened or whether a count should just be obtained of those that could be opened. |
MSDialogP mdlDialog_commandWindowGet | ( | void | ) |
Returns a MSDialog pointer of the prompt and message area, which can be referenced without having to consider the currently selected interface style.
bool mdlDialog_containsToolBox | ( | MSDialogP | dbP | ) |
Determines if a Dialog Box contains a ToolBox item.
[in] | dbP | MSDialog to check |
MSDialog* mdlDialog_create | ( | RscFileHandle | rFileH, |
MdlDescP | ownerMD, | ||
RscType | dialogType, | ||
RscId | dialogId, | ||
bool | noWarnResourceError | ||
) |
Opens a modal or modeless Dialog Box without displaying it on the user's display.
It returns immediately to its caller. Most dialogs should be opened with the mdlDialog_open and mdlDialog_openModal functions instead.
[in] | rFileH | specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | ownerMD | specifies the MDL descriptor of the application which is to own the Dialog Box. If NULL, the Dialog Box is owned by the calling application. |
[in] | dialogType | specifies the resource type of the Dialog Box resource that is used to create the Dialog Box. The Dialog Box will be modal if the DIALOGATTR_MODAL bit is set in the attributes field of the Dialog Box resource. |
[in] | dialogId | specifies the resource ID of the Dialog Box resource that is used to create the Dialog Box. The Dialog Box will be modal if the DIALOGATTR_MODAL bit is set in the attributes field of the Dialog Box resource. |
[in] | noWarnResourceError | indicates whether a warning message should be displayed if the resource could not be found. This parameter is usually false. |
RawItemHdrP mdlDialog_defaultViewPopupMenuPGet | ( | int | buttonNum | ) |
Retrieves the RawItemHdr pointer of the default (non-dgnlib) Popup Menu associated with a View window.
[in] | buttonNum | the RESET or TENTPNT button number |
Gets a pointer to the currently open Dialog Box whose resource ID is dialogId.
[in] | dialogId | ID of dialog to find |
[in] | ownerMD | is the MDL descriptor of the owner of the Dialog Box. If NULL is specified, then the calling application is assumed. |
Obtains a pointer to an open Dialog Box according to its resource class (dialog type) and ID.
[in] | dialogType | specifies the type of dialog. This is usually RTYPE_DialogBox. |
[in] | dialogId | is the resource ID of the Dialog Box. |
[in] | ownerMD | is the MDL descriptor of the owner of the Dialog Box. If NULL is specified, then the calling application is assumed. |
WCharCP mdlDialog_getAdditionalAboutLegalText | ( | ) |
Gets any additional text set to appear in the About Box - "Legal and Patent Notices" section.
AutoHideState mdlDialog_getAutoHideState | ( | MSDialogP | dbP | ) |
Gets the AutoHide / Push-pin state for a .NET Dockable dialog.
[in] | dbP | The .NET Dockable MSDialog |
MSDialogP mdlDialog_getChild | ( | MSDialogP | dbP, |
MSDialogP | startDbP | ||
) |
Retrieves the first child dialog of a parent after a given child.
A parent/child relationship can be established after the child dialog is opened by calling mdlDialog_setParent. By providing the previous child, mdlDialog_getChild may be used to loop through all the children of a parent dialog.
[in] | dbP | MSDialog which may have children |
[in] | startDbP | MSDialog after which to start search. NULL begins at the start of the list. |
StatusInt mdlDialog_getEditMenuInfo | ( | DItem_PulldownMenu * | pMenu, |
EditMenuInfo * | pMenuInfo | ||
) |
Retrieves information about the popup edit menu for the current item.
[in] | pMenu | the menu to obtain information about |
[in,out] | pMenuInfo | receives the information about the popup edit menu |
MSDialogP mdlDialog_getFirst | ( | void | ) |
Gets the first dialog in the dialog list.
The mdlDialog_getFirst and mdlDialog_getNext functions are used together to "walk through" all MicroStation dialogs. The program first calls mdlDialog_getFirst to get the first dialog in the list, and then repeatedly calls mdlDialog_getNext to get all the other dialogs. The current parameter must be the return value from mdlDialog_getFirst or mdlDialog_getNext.
StatusInt mdlDialog_getFloatingSize | ( | MSDialogP | dbP, |
Point2d * | floatingSize | ||
) |
bool mdlDialog_getMinimumSize | ( | int * | minWidthP, |
int * | minHeightP, | ||
MSDialogP | dbP | ||
) |
Retrieves the minimum size from a dialog.
[out] | minWidthP | Pointer to an integer receiving the minimum width |
[out] | minHeightP | Pointer to an integer receiving the minimum height |
[in] | dbP | MSDialog from which to get its minimum size |
StatusInt mdlDialog_getNETDockedExtents | ( | MSDialogP | dbP | ) |
Gets the Docked Extents from a .NET Dockable dialog and sends those extents to the .NET docking system.
[in] | dbP | The .NET Dockable MSDialog |
MSDialogP mdlDialog_getNETDockingChildWindow | ( | MSWindowP | gwP | ) |
MSWindowP mdlDialog_getNETDockingParentWindow | ( | MSDialogP | dbP | ) |
MSDialogP mdlDialog_getNext | ( | MSDialogP | dbP | ) |
Gets the next dialog in the dialog list, given a specific dialog.
The mdlDialog_getFirst and mdlDialog_getNext functions are used together to "walk through" all MicroStation dialogs. The program first calls mdlDialog_getFirst to get the first dialog in the list, and then repeatedly calls mdlDialog_getNext to get all the other dialogs. The current parameter must be the return value from mdlDialog_getFirst or mdlDialog_getNext.
[in] | dbP | current Dialog Box to get next from |
MSDialogP mdlDialog_getParent | ( | MSDialogP | dbP | ) |
Gets the dialog assigned as the parent of a given dialog.
After the child dialog is opened, the application may call mdlDialog_setParent to establish this parent/child relationship.
[in] | dbP | MSDialog to get the parent for |
RscId mdlDialog_getResourceId | ( | MSDialogP | dbP | ) |
Retrieves the appropriate icon id associated with a particular IconCmd id based on the current font height.
The icons associated with these Ids are defined in dlogids.r.h, are located in ustation.rsc and may be used in a ListBox cell to denote color and status.
[in] | dbP | MSDialog in which the icons will be shown |
[in] | iconCmdId | The id of the IconCmd associated with the sized icons. Eg. ICONCMDID_ColorPatch. |
Retrieves the appropriate icons Ids for on and off icons based on the current font height.
The icons associated with these Ids are located in ustation.rsc and may be used in a ListBox cell to denote on and off flags.
[out] | onIconIdP | receives the icon id for the ON icon |
[out] | offIconIdP | receives the icon id for the OFF icon |
[in] | dbP | MSDialog in which the icons will be shown |
MSDialog* mdlDialog_getToolSettings | ( | ) |
bool mdlDialog_hasFocus | ( | MSDialogP | dbP | ) |
Determines if a given Dialog Box currently has the input focus.
[in] | dbP | is the dialog to check for the input focus. |
StatusInt mdlDialog_hookDialogSendUserMsg | ( | MSDialogP | dbP, |
int | type, | ||
CallbackArgP | userDataP | ||
) |
Sends a user message to any dialog hook function that is attached to the specified Dialog Box.
[in] | dbP | MSDialog to send dialog hook user message |
[in] | type | type of user message |
[in] | userDataP | user defined pointer passed along in message |
StatusInt mdlDialog_hookItemSendUserMsg | ( | RawItemHdr * | riP, |
int | type, | ||
CallbackArgP | userDataP | ||
) |
Sends a user message to any item hook function attached to the Dialog Box item specified by rihP.
[in] | riP | item whose hook we're sending user message |
[in] | type | type of user message |
[in] | userDataP | user defined pointer passed along in message |
StatusInt mdlDialog_hookPublish | ( | int | nHooks, |
DialogHookInfo * | hooks | ||
) |
Associates hook function ID numbers with hook function addresses.
[in] | nHooks | parameter specifies the size of the hooks array. Each member of the hooks array consists of a hook function ID and an MDL function address. |
[in] | hooks | array of item and dialog hooks |
StatusInt mdlDialog_initializeToolSettings | ( | RscFileHandle | rfHandle, |
MdlDescP | ownerMD, | ||
int | ditemListId | ||
) |
Populates the Tool Settings window based on the dialog item list specified.
[in] | rfHandle | resource file handle of the resource containing the MSDialog item list |
[in] | ownerMD | MDL Descriptor of the owning MDL task |
[in] | ditemListId | id of the dialog item list to load into the Tool Settings window |
bool mdlDialog_isAncestor | ( | MSDialogP | dbP, |
MSDialogP | testDbP | ||
) |
Determines if a dialog is the parent or ancestor of another dialog.
A parent/child relationship can be established after the child dialog is opened by calling mdlDialog_setParent.
bool mdlDialog_isAutoHideCollapsed | ( | MSDialogP | dbP | ) |
Determines whether the dialog is in an Auto-Hide Collapsed state.
[in] | dbP | The .NET Dockable MSDialog |
bool mdlDialog_isAutoHideExpanded | ( | MSDialogP | dbP | ) |
Determines whether the dialog is in an Auto-Hide Expanded state.
[in] | dbP | The .NET Dockable MSDialog |
bool mdlDialog_isAutoOpen | ( | MSDialogP | dbP | ) |
Determines whether the dialog is Auto-Open.
[in] | dbP | a pointer to the MSDialog |
bool mdlDialog_isCloseable | ( | MSDialogP | dbP | ) |
Determines whether the dialog is closeable.
[in] | dbP | a pointer to the MSDialog |
Determines if a Dialog Box has been opened before.
[in] | dialogId | ID of dialog to find |
[in] | ownerMD | is the MDL descriptor of the owner of the Dialog Box. If NULL is specified, then the calling application is assumed. |
bool mdlDialog_isNETDocked | ( | MSDialogP | dbP | ) |
Determines whether the dialog is docked.
[in] | dbP | The .NET Dockable MSDialog |
StatusInt mdlDialog_lastActionTypeSet | ( | MSDialogP | dbP, |
int | actionType | ||
) |
Sets the action type that is sent to a dialog hook function as part of the DIALOG_MESSAGE_DESTROY message when a Dialog Box is closed.
It is used to indicate why the Dialog Box was closed.
[in] | dbP | parameter indicates which Dialog Box to set the last action type for. |
[in] | actionType | parameter specifies the Dialog Box's last action type. |
MSDialogP mdlDialog_open | ( | RscFileHandle | rFileH, |
RscId | resourceId | ||
) |
Opens a modal or modeless Dialog Box.
It returns immediately to its caller. Most modal dialogs should be opened with the mdlDialog_openModal function instead.
[in] | rFileH | parameter specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | resourceId | parameter specifies the resource ID of the Dialog Box resource that is used to create the Dialog Box. The Dialog Box will be modal if the DIALOGATTR_MODAL bit is set in the attributes field of the Dialog Box resource. |
int mdlDialog_openAlert | ( | WCharCP | stringP | ) |
Opens a modal Dialog Box that contains two push buttons labeled OK and Cancel, and a multi-line label item that will be set to the string pointed to by stringP.
It does not return to its caller until the user closes the modal Dialog Box.
[in] | stringP | string to display alert |
int mdlDialog_openAlertById | ( | RscId | dialogId, |
WCharCP | stringP | ||
) |
Opens an alternate alert dialog box.
The standard mdlDialog_openAlert function calls this routine with a dialog ID of DIALOGID_StandardAlert. An alternate alert Dialog Box must have, at a minimum, one multi-line text field (item index 0), an OK button and a Cancel button.
[in] | dialogId | is the ID of an alternate alert Dialog Box. |
[in] | stringP | is the alert message to be displayed in the multi-line text field of the dialog. |
int mdlDialog_openInfoBox | ( | WCharCP | stringP | ) |
Opens a modal Dialog Box that contains a single push button labeled OK, and a multi-line label item that will be set to the string pointed to by stringP.
It does not return to its caller until the user closes the modal dialog box.
[in] | stringP | string to display in info box |
int mdlDialog_openMessageBox | ( | RscId | dialogId, |
WCharCP | stringP, | ||
MessageBoxIconType | whichIcon | ||
) |
Opens a modal Dialog Box which contains one to three push buttons, a multi-line label item, and one of four icons.
It does not return to its caller until the user closes the modal Dialog Box.
[in] | dialogId | is the ID of the message box which will be displayed, and will be used to specify which push buttons are included in the dialog. The following values for dialogId are available for use with mdlDialog_openMessageBox:
mdlDialog_openMessageBox can also be used to display Icons in the following dialogs:
If, for example, you want to display a large information box, you can use: mdlDialog_openMessageBox(DIALOGID_LargeInfoBox, stringP, MessageBoxIconType::Information); | |||||||||||||||||||
[in] | stringP | is the multi line text string to be displayed as the alert message of the dialog. | |||||||||||||||||||
[in] | whichIcon | specifies the raster icon to be drawn in the Dialog Box to the left of the alert message. mdlDialog_openMessageBox automatically detects the current GUIMODE and displays icons appropriate to Windows or Motif interface styles.:
|
StatusInt mdlDialog_openModal | ( | int * | lastActionTypeP, |
RscFileHandle | rFileH, | ||
RscId | resourceId | ||
) |
Opens a modal Dialog Box.
It does not return to its caller until the user closes the modal Dialog Box.
[in] | rFileH | parameter specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | resourceId | parameter specifies the resource ID of the Dialog Box resource that is used to create the Dialog Box. Be sure to make the Dialog Box modal by setting the DIALOGATTR_MODAL bit in the attributes field of the Dialog Box resource. |
[out] | lastActionTypeP | parameter points to a variable that is set to indicate which push button the user used to close the modal Dialog Box. It will usually be set to ACTIONBUTTON_OK or ACTIONBUTTON_CANCEL. |
StatusInt mdlDialog_openModalWithMD | ( | int * | lastActionTypeP, |
RscFileHandle | rFileH, | ||
RscId | resourceId, | ||
MdlDesc * | ownerMD | ||
) |
An extension of mdlDialog_openModal which allows the caller to pass a MDL Descriptor of the owner task of the dialog.
[out] | lastActionTypeP | parameter points to a variable that is set to indicate which push button the user used to close the modal Dialog Box. It will be set to ACTIONBUTTON_OK or ACTIONBUTTON_CANCEL. |
[in] | rFileH | parameter specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | resourceId | parameter specifies the resource ID of the Dialog Box resource that is used to create the Dialog Box. Be sure to make the Dialog Box modal by setting the DIALOGATTR_MODAL bit in the attributes field of the Dialog Box resource. |
[in] | ownerMD | MDL Descriptor of the owner task |
MSDialogP mdlDialog_openWithMD | ( | RscFileHandle | rFileH, |
MdlDescP | ownerMD, | ||
RscId | resourceId | ||
) |
An extension of mdlDialog_open which allows the caller to pass a MDL Descriptor of the owner task of the dialog.
[in] | rFileH | parameter specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | ownerMD | MDL Descriptor of the owner task |
[in] | resourceId | parameter specifies the resource ID of the Dialog Box resource that is used to create the Dialog Box. The Dialog Box will be modal if the DIALOGATTR_MODAL bit is set in the attributes field of the Dialog Box resource. |
MdlDescP mdlDialog_ownerMDGet | ( | MSDialogP | dbP | ) |
Returns the MDL descriptor of the task that owns the given Dialog Box.
[in] | dbP | points to a Dialog Box from which the owning MDL task will be determined. |
StatusInt mdlDialog_ownerMDSet | ( | MSDialogP | dbP, |
MdlDescP | ownerMD | ||
) |
Sets the MDL descriptor of the task that owns the given Dialog Box.
[in] | dbP | points to a Dialog Box in which the owning MDL task will be set. |
[in] | ownerMD | new ownerMD of the owning MDL task |
int mdlDialog_parentIdGet | ( | MSDialogP | dbP | ) |
Retrieves the resource ID of the parent of the specified Dialog Box.
[in] | dbP | dialog whose parent ID is being found |
StatusInt mdlDialog_parentIdSet | ( | MSDialogP | dbP, |
long | parentId | ||
) |
Sets the parent resource ID of the specified Dialog Box to be parentId.
[in] | dbP | dialog whose parent ID is being set |
[in] | parentId | new parent IS |
StatusInt mdlDialog_popupClose | ( | MSDialogP | dbP, |
bool | bUpdate | ||
) |
Closes a popup dialog in the proper manner.
If the popup is owned by a dialog item, that item will close the popup window.
[in] | dbP | parameter indicates which popup Dialog Box to close. |
[in] | bUpdate | If the popup is owned by a dialog open, this indicates whether to update the item's value or discard the change. |
MSDialog* mdlDialog_popupGetOwnerDialog | ( | MSDialogP | dbP | ) |
Retrieves the owning dialog box which opened the popup window.
[in] | dbP | parameter indicates which popup Dialog Box to obtain the owning dialog item for. |
RawItemHdr* mdlDialog_popupGetOwnerItem | ( | MSDialogP | dbP | ) |
Retrieves the owning dialog item which opened the popup window, if any.
[in] | dbP | parameter indicates which popup Dialog Box to obtain the owning item item for. |
void mdlDialog_refresh | ( | MSDialogP | dbP | ) |
Refreshes the contents of a Dialog Box.
[in] | dbP | is the dialog to refresh. |
void mdlDialog_refreshNamedToolBox | ( | WCharCP | toolBoxPath | ) |
Refreshes the context of a Named ToolBox.
[in] | toolBoxPath | The path of the Named Toolbox |
void mdlDialog_sendMessagesOnUnload | ( | MdlDescP | mdlDescP, |
bool | bValue | ||
) |
Indicates whether the specified MDL application wishes to receive Dialog and Dialog Item messages when the application is unloading.
The default behavior is not to send these messages.
[in] | mdlDescP | The MDL Descriptor of the application |
[in] | bValue | true indicates to send the messages when unloading. |
void mdlDialog_setAdditionalAboutLegalText | ( | WCharCP | wText | ) |
Sets additional text to appear in the About Box - "Legal and Patent Notices" section.
[in] | wText | Unicode text used as additional text for the About Box - "Legal and Patent Notices" section. |
void mdlDialog_setAllowToolBoxOverrides | ( | bool | value | ) |
Sets processing flag to allow for customized named ToolBoxes to override the original ToolBoxes when calling mdlDialog_find and mdlDialog_open functions.
[in] | value | When true, customized ToolBoxes can override delivered ToolBoxes by name |
void mdlDialog_setAutoOpen | ( | MSDialogP | dbP, |
bool | autoOpen | ||
) |
Sets the dialog to Auto-Open.
[in] | dbP | a pointer to the MSDialog |
[in] | autoOpen | true is the MSDialog is to be Auto-Open or false otherwise |
void mdlDialog_setAutoOpenKeyin | ( | MSDialogP | dbP, |
WCharCP | keyin | ||
) |
Sets the Keyin to use when opening the dialog as Auto-Open.
In lieu of calling mdlDialog_autoOpen, this Keyin will be used to open the dialog when it is .NET Dockable.
[in] | dbP | a pointer to the MSDialog |
[in] | keyin | the Keyin to use when opening the dialog as Auto-Open |
void mdlDialog_setCacheName | ( | MSDialogP | dbP, |
WCharCP | pName | ||
) |
Sets the dialog's unique cache name.
This name should be static. When the dialog is dockable, the name is used by the dialog docking system to uniquely identify the dialog and is stored in the docking preferences file. The name may also be used in conjunction with EXTATTR_ITEMNAME for dialog items to set item values using the Key-in "set item dialogname.itemname=value". Spaces should not be included in this name.
void mdlDialog_setCloseable | ( | MSDialogP | dbP, |
bool | closeable | ||
) |
Sets the Closeable property for a MSDialog.
[in] | dbP | a pointer to the MSDialog |
[in] | closeable | indicates whether the dialog can be closed |
int mdlDialog_setFilterString | ( | WCharCP | filterString | ) |
Sets the file filter string of a user-defined File Open or File Create Dialog Box.
This, in turn, will control the files that get displayed in the file name list box. This function must be called while the target Dialog Box is displayed on the screen (implying that the mdlDialog_setFilterString function call takes place from within a hook function of one of the dialog's items).
[in] | filterString | is a file filter, for example, "*.dgn". |
void mdlDialog_setFocusToHome | ( | ) |
Sets focus to the Home position.
StatusInt mdlDialog_setNETDockingCanAutoHide | ( | MSDialogP | dbP, |
bool | canAutoHide | ||
) |
Sets the CanAutoHide property for a .NET Dockable MSDialog.
[in] | dbP | The .NET Dockable MSDialog |
[in] | canAutoHide | indicates whether the dialog can be unpinned/pinned once it is docked |
StatusInt mdlDialog_setNETDockingMinimumSize | ( | MSDialogP | dbP, |
int | width, | ||
int | height | ||
) |
StatusInt mdlDialog_setNETDockingUndockable | ( | MSDialogP | dbP, |
bool | undockable | ||
) |
Sets the Undockable property for a .NET Dockable MSDialog.
[in] | dbP | The .NET Dockable MSDialog |
[in] | undockable | indicates whether the dialog can be undocked once it is docked |
StatusInt mdlDialog_setParent | ( | MSDialogP | dbP, |
MSDialogP | parentDbP | ||
) |
void mdlDialog_show | ( | MSDialogP | dbP | ) |
Brings a Dialog Box back into view.
If the Dialog Box can accept input focus, focus is changed to the Dialog Box. If the Dialog Box is modal, the Dialog Box is raised to the top of the display and priority list and made the dominant window.
[in] | dbP | MSDialog to show |
StatusInt mdlDialog_synonymEnable | ( | int | synonymsId, |
bool | enable | ||
) |
Sets the enabled flag in all items in the synonym resource specified by synonymsId.
It does this for each occurrence of all the items in the list no matter what Dialog Box they appear in.
[in] | synonymsId | id of synonym resource to process |
[in] | enable | indicates the new enabled status of the items. |
StatusInt mdlDialog_synonymReloadData | ( | int | synonymsId, |
bool | redraw | ||
) |
Forces all items in the synonym resource specified by synonymsId to reload their data.
It does this for each occurrence of all the items in the list no matter what Dialog Box they appear in.
[in] | synonymsId | id of synonym resource to process |
[in] | redraw | indicates whether to draw the item after the data reload. |
StatusInt mdlDialog_synonymsDraw | ( | RscFileHandle | rFileH, |
int | synonymsId, | ||
MdlDescP | ownerMD | ||
) |
Draws all items in the synonym resource specified by synonymsId.
It does this by calling the mdlDialog_itemDraw function for each occurrence of all the items in the list no matter what Dialog Box they appear in.
[in] | rFileH | parameter specifies the resource file to search for the synonym resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | synonymsId | id of synonym resource to draw |
[in] | ownerMD | parameter should be set to NULL. |
StatusInt mdlDialog_synonymSetVisibility | ( | int | synonymsId, |
bool | visible | ||
) |
Sets the visibility flag in all items in the synonym resource specified by synonymsId.
It does this for each occurrence of all the items in the list no matter what Dialog Box they appear in.
[in] | synonymsId | id of synonym resource to process |
[in] | visible | indicates the new visible status of the items. |
StatusInt mdlDialog_synonymsSynch | ( | RscFileHandle | rFileH, |
int | synonymsId, | ||
MdlDescP | ownerMD | ||
) |
Forces the appearance of all items in the synonym resource specified by synonymsId to match their external state.
It does this by calling the mdlDialog_itemSynch function for each occurrence of all the items in the list no matter what Dialog Box they appear in.
[in] | rFileH | parameter specifies the resource file to search for the synonym resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | synonymsId | id of synonym resource to synch |
[in] | ownerMD | parameter should be set to NULL. |
MSDialogP mdlDialog_toolBoxCmd | ( | RscFileHandle | rFileH, |
MdlDescP | ownerMD, | ||
RscId | resourceId, | ||
WCharCP | unparsedCP | ||
) |
Processes a 'DIALOG TOOLBOX' command.
[in] | rFileH | parameter specifies the resource file to search for the Dialog Box resource. If NULL, all the calling application's open resource files and then MicroStation's open resource files will be searched. |
[in] | ownerMD | MDL Descriptor of the owner task |
[in] | resourceId | parameter specifies the resource ID of the ToolBox resource. |
[in] | unparsedCP | the unparsed string from the command function. Valid values are NULL, "OPEN", "CLOSE" and "TOGGLE". |
UserDataP mdlDialog_userDataPtrGet | ( | MSDialogP | dbP | ) |
Retrieves the user data pointer of the specified Dialog Box.
[in] | dbP | Dialog Box whose userDataPtr we're getting |
StatusInt mdlDialog_userDataPtrSet | ( | MSDialogP | dbP, |
UserDataP | userDataP | ||
) |
Sets the user data pointer of the specified Dialog Box to be userDataP.
Since the user data pointer is usually set indirectly by a dialog hook function upon receipt of the DIALOG_MESSAGE_CREATE message, the mdlDialog_userDataPtrSet function is rarely needed.
[in] | dbP | Dialog Box whose userDataPtr we're setting |
[in] | userDataP | new userDataP |
RawItemHdrP mdlDialog_viewPopupMenuPGet | ( | int | buttonNum | ) |
Retrieves the RawItemHdr pointer of the Popup Menu associated with a View window.
[in] | buttonNum | the RESET or TENTPNT button number |