Classes | |
struct | BatchConvert_Info |
Batch convert state info. More... | |
Typedefs | |
typedef void(* | SystemFunc_NewDesignFile )(WCharCP fileP, NewDesignFileReason state) |
UserFunction called when a new design file is opened. More... | |
typedef bool(* | SystemFunc_UnloadProgram )(UnloadProgramReason reason) |
UserFunction called during the unload of an application. More... | |
typedef StatusInt(* | SystemFunc_CompressDgnFile )(WCharP errorMessage, CompressType type) |
UserFunction called during a file compress. More... | |
typedef void(* | SystemFunc_CompressDgnModel )(DgnModelP dgnModel, CompressType type) |
UserFunction called during a file compress for each model. More... | |
typedef void(* | SystemFunc_ModelChange )(DgnModelRefP modelRef, ModelChangeType changeTypeId) |
UserFunction called when a model is changed. More... | |
typedef void(* | SystemFunc_MdlChildTerminated )(MdlChildTerminated const *terminatedChild) |
UserFunction called during the unload of a child application started by the current application. More... | |
typedef void(* | SystemFunc_ReloadProgram )(int argc, WCharCP argv[]) |
UserFunction called for each app when an MDL app is reloaded. More... | |
typedef void(* | SystemFunc_ExitDesignFileState )() |
UserFunction called when exiting design file. More... | |
typedef void(* | SystemFunc_AllMdlUnloads )(MdlDesc *unloadedApp, short exitReason, WCharCP taskId, bool keepStub) |
UserFunction called for each app when all MDL apps are unloaded. More... | |
typedef bool(* | SystemFunc_MenuBarChange )(WCharCP oldTaskIdP, WCharCP newTaskIdP, bool isNewTask, bool afterMenuBarActivated, DialogItem *menuBarDiP, WCharCP menuItemLabelP) |
UserFunction called when a menu bar changes. More... | |
typedef bool(* | SystemFunc_WindowClose )(MSWindowP gwP, int closeReason) |
UserFunction called when a window is closed. More... | |
typedef void(* | SystemFunc_CmdWindowOpen )(void *cmdWindow) |
UserFunction called when the Status Bar or Command Window has been created. More... | |
typedef ElmDscrToFile_Status(* | SystemFunc_ElmDscrToFile )(ElmDscrToFile_Actions action, DgnModelRefP modelRef, UInt32 filePos, MSElementDescrP newEdP, MSElementDescrCP oldEdP, MSElementDescrH replacementEdPP) |
The userSystem_elmDscrToFile function is called by MicroStation before an element descriptor is written to the design file. More... | |
typedef void(* | SystemFunc_ColorMapChange )(int screen, byte *colorTable, UInt32 *colorMap, DgnModelRefP modelRef) |
UserFunction called when the colormap changes. More... | |
typedef void(* | SystemFunc_FenceChanged )(FenceChangedType changeType) |
UserFunction called when a fence is created or cleared. More... | |
typedef void(* | SystemFunc_FileSaveAs )(bool postSave, WCharCP destinationFileName) |
UserFunction called when a file is saved to a different name. More... | |
typedef void(* | SystemFunc_FileSave )(DgnPlatform::ProcessChangesWhen when, DgnPlatform::DgnFileChanges changesFlag, DgnPlatform::DgnSaveReason reason, double timestamp, DgnFileP pFile) |
UserFunction called to notify applications that a file is being processed for "save changes". More... | |
typedef void *(* | SystemFunc_DialogFind )(RscType dialogType, RscId dialogId, MdlDescP ownerMD) |
UserFunction called during a mdlDialog_findByTypeAndId call. More... | |
typedef StatusInt(* | SystemFunc_CreateLibraryCell )(MSElementDescrH elmdscrPP) |
UserFunction called when a cell is added to a cell library (old method). More... | |
typedef void(* | SystemFunc_SaveSettings )() |
UserFunction called when the settings are saved. More... | |
typedef StatusInt(* | SystemFunc_ReferenceAttach )(WCharP fileName, WCharCP fullSavedPath, DgnModelRefP parentModelRef, WCharCP providerId, DgnPlatform::ElementId attachmentId) |
UserFunction called before a reference is attached. More... | |
typedef StatusInt(* | SystemFunc_ReferenceDetach )(DgnModelRefP modelRef) |
UserFunction called before a reference is detached. More... | |
typedef void(* | SystemFunc_ReferenceAttached )(DgnModelRefP modelRef, DgnPlatform::DgnAttachmentAttachedReason cause) |
UserFunction called after a reference is attached. More... | |
typedef void(* | SystemFunc_ReferenceDetached )(DgnModelRefP modelRef, WCharCP fileName, DgnPlatform::DgnAttachmentDetachedReason cause) |
UserFunction called after a reference is detached. More... | |
typedef void(* | SystemFunc_ReferenceModified )(DgnAttachmentCP pOldRef, DgnAttachmentCP pNewRef, DgnModelRefP modelRef, bool changesWritten, bool isUndo) |
UserFunction called when a reference is changed. More... | |
typedef void(* | SystemFunc_AcsOperation )(WCharCP name, WCharCP description, DgnPlatform::ACSType acsType, AcsChangeType changeTypeId, IAuxCoordSysP acs, DgnPlatform::ACSEventType eventType) |
UserFunction called when ACS changes. More... | |
typedef void(* | SystemFunc_DgnFileLoaded )(DgnFileP dgnFile) |
UserFunction called after a DGN file is loaded. More... | |
typedef void(* | SystemFunc_DgnFileUnloading )(DgnFileP dgnFile) |
UserFunction called before a DGN file is unloaded. More... | |
typedef void(* | SystemFunc_DgnCacheFilled )(DgnModelP dgnCache, DgnPlatform::DgnModelSections sections, DgnModelFillContextP context) |
UserFunction called after a DGN cache is filled. More... | |
typedef void(* | SystemFunc_DgnCacheFill )(DgnModelP dgnCache, DgnPlatform::DgnModelSections sections, DgnModelFillContextP context) |
UserFunction called before a DGN cache is filled. More... | |
typedef void(* | SystemFunc_DgnCacheUnloading )(DgnModelP dgnCache) |
UserFunction called when after a DGN cache is about to be unloaded. More... | |
typedef void(* | SystemFunc_ViewGroupCacheChange )(WCharCP nameP, WCharCP descriptionP, ViewGroupChangeType changeTypeId) |
UserFunction called when ViewGroup cache changes. More... | |
typedef bool(* | SystemFunc_QueryHasPending )(DgnFileP pDgnFileObj) |
UserFunction called during a save to allow listeners to say that there are changes and the file must be saved. More... | |
typedef void(* | SystemFunc_DimStyleChange )(DgnModelRefP modelRef, DgnPlatform::ElementId styleIdIn, DimensionStyleChangeType changeType) |
UserFunction called when a Dimension Style is changed. More... | |
typedef void(* | SystemFunc_TextStyleChange )(DgnModelRefP modelRef, UInt32 styleId, TextStyleChangeType changeTypeId) |
UserFunction called when a Text Style is changed. More... | |
typedef void(* | SystemFunc_ApplicationAreaChange )() |
UserFunction called when the Application Area is changed. More... | |
typedef void(* | SystemFunc_ModelRefDestroy )(DgnModelRefP modelRef) |
UserFunction called after the master file is closed. More... | |
typedef void(* | SystemFunc_MasterfileClosed )() |
UserFunction called after the master file is closed. More... | |
typedef bool(* | SystemFunc_NativeExceptionHandler )(int exceptionCode, void *exceptionPointersP, MdlDesc *applicationCausingException) |
UserFunction called when a call into native code results in an operating system exception (such as an access violation). More... | |
typedef StatusInt(* | SystemFunc_CellLibraryChange )(CellLibAsyncMsgP pCellLibAsyncMsg) |
UserFunction called when the Cell Library changes. More... | |
typedef void(* | SystemFunc_MonitorViewCommands )(bool starting) |
UserFunction called when MicroStation starts or exits from a viewing command. More... | |
typedef void(* | SystemFunc_ElmDscrCopy )(EditElementHandleR eeh, DgnModelRefP sourceModelRef, DgnModelRefP destModelRef, bool preCopy) |
UserFunction called when MicroStation is making a copy of persistent elements. More... | |
typedef void(* | SystemFunc_UpdateSequenceChanged )(DgnModelRefP modelRef, UpdateSequenceListP sequence) |
UserFunction called when MicroStation is setting the update sequence for a modelRef. More... | |
typedef bool(* | SystemFunc_FileOutdated )(DgnFileP dgnFile, DgnModelRefP modelRef, FileOutdatedCheck_Reason reason) |
UserFunction called when MicroStation is checking to see whether a file that it is using is outdated. More... | |
typedef void(* | SystemFunc_ReferenceNesting )(DgnModelRefP refModelRef, DgnPlatform::RefAttachNestMode nestFlag, int nestDepth, DgnPlatform::RefAttachNestMode previousNestFlag, int previousNestDepth, bool changeExisting) |
UserFunction called after user has selected a refernce file/model and established the attachment settings, just before the nested references are loaded. More... | |
typedef void(* | SystemFunc_LockChanged )(LockChanged_Events eventType) |
UserFunction called after one of the MicroStation "locks" has been changed. More... | |
typedef void(* | SystemFunc_ActiveParamChanged )(UInt32 paramType) |
UserFunction called after one of the MicroStation "active parameters" has been changed. More... | |
typedef void(* | SystemFunc_MonitorBatchProcessing )(BatchProcessing_States state) |
UserFunction called when Batch Processing start, pauses, resumes, and stops. More... | |
typedef void(* | SystemFunc_MonitorBatchConvert )(BatchConvert_Info const *info) |
UserFunction called when Batch Convert start, pauses, resumes, and stops. More... | |
typedef void(* | SystemFunc_MultilineStyleChanged )(MlineStyleMsgType reason, MlineStyleAsynchP asynchData) |
Called when multi-line styles are added, deleted, or modified in the file. More... | |
typedef void(* | SystemFunc_SymbologyChanged )(SymbChangeMsgType reason, SymbChangeAsynchP asynchData) |
Called when the active symbology is changed. More... | |
typedef void(* | SystemFunc_UpgradeV7ToV8 )(DgnFileP dgnFileObj, bool permanent, bool firstInBatchUpgrade) |
UserFunction called when BatchConvert upgrades a file from V7 to V8. More... | |
typedef bool(* | SystemFunc_WindowsKeystrokeMessage )(void *windowID, UInt32 messageNumber, uintptr_t wParam, intptr_t lParam, long x, long y) |
UserFunction called for keystroke messages from Windows. More... | |
typedef void(* | SystemFunc_BeforeReferenceWrite )(DgnModelRefP modelRef, bool newAttachment) |
UserFunction called before writing a reference attachment element. More... | |
typedef void(* | SystemFunc_BeforeViewsOpen )() |
UserFunction called just before the views open. More... | |
typedef void(* | SystemFunc_WorkspaceChanged )() |
UserFunction called when the workspace has changed. More... | |
typedef void(* | SystemFunc_MessageCenterWrite )(DgnPlatform::OutputMessagePriority messageType, WCharCP pMessage, WCharCP pDetail, long detailMessageAttributes) |
UserFunction called when a message is written to the Message Center. More... | |
typedef void(* | SystemFunc_PromptOutput )(WCharCP pText, WCharCP pCombinedText, int fieldNumber) |
UserFunction called when a prompt is written to the status bar. More... | |
typedef void(* | SystemFunc_StatusOutput )(WCharCP pText, int fieldNumber) |
UserFunction called when a status message is written to the status bar. More... | |
typedef void(* | SystemFunc_SelectedViewChanged )(int oldViewIndex, int newViewIndex, bool bFromButtonEvent) |
UserFunction called when the selected View window changes. More... | |
typedef void(* | SystemFunc_TaskNavigationTaskChanged )(WCharCP pTaskPath, WCharCP pTaskName, int viewIndex, const void *pIconRsc) |
UserFunction called after the current UI task (e.g. More... | |
typedef void(* | SystemFunc_MainToolBoxTaskChanged )(WCharCP previousPath, WCharCP newPath) |
UserFunction called after the current UI "main" task (e.g. More... | |
typedef StatusInt(* | SystemFunc_LevelPreChange )(DgnModelRefP modelRef, UInt32 levelIdIn, LevelChangeType changeType) |
UserFunction called when MicroStation before a level is changed. More... | |
typedef void(* | SystemFunc_LevelChange )(DgnModelRefP modelRef, UInt32 levelId, LevelChangeType changeTypeId) |
UserFunction called when a level is changed. More... | |
typedef void(* | SystemFunc_LevelMaskCacheChange )(DgnModelRefP modelRef, UInt32 viewNumber) |
UserFunction called when MicroStation before the level mask cached is changed. More... | |
typedef void(* | SystemFunc_FilterChange )(WCharCP pFilterTableName, UInt32 filterId, FilterChangeType changeTypeId) |
UserFunction called when the level filter is changed. More... | |
typedef void(* | SystemFunc_ReferenceAttachQueue )(SystemRefAttachQueueState state) |
UserFunction called when MicroStation starts and ends processing of the reference attachment queue. More... | |
typedef void(* | SystemFunc_TaskNavigationTaskChanging )(bool *cancelTaskChange, WCharCP currentPath, WCharCP newPath) |
UserFunction called before the active task is changed. More... | |
typedef void(* | SystemFunc_ActiveElementTemplateChanged )(WCharCP previousPath, WCharCP newPath) |
UserFunction called after the active element template has changed. More... | |
typedef void(* | SystemFunc_ClipboardUpdated )() |
UserFunction called when the Clipboard has been updated. More... | |
typedef void(* | SystemFunc_DgnLibsChanged )(MstnPlatform::DgnLibSelector selectors) |
UserFunction called when the set of DgnLibs has been changed. More... | |
typedef void(* | SystemFunc_RibbonBackstageOpened )() |
UserFunction called when the Ribbon's Backstage is opened. More... | |
Functions | |
BatchProcessing_States | mdlSystem_getBatchProcessingState () |
Retrieve the current state of batch processing. More... | |
typedef void(* SystemFunc_AcsOperation)(WCharCP name, WCharCP description, DgnPlatform::ACSType acsType, AcsChangeType changeTypeId, IAuxCoordSysP acs, DgnPlatform::ACSEventType eventType) |
UserFunction called when ACS changes.
[in] | name | The ACS name. |
[in] | description | The ACS description. |
[in] | acsType | Type of the ACS. |
[in] | changeTypeId | The type of change that occurred. |
[in] | acs | The ACS |
[in] | eventType | The Event |
typedef void(* SystemFunc_ActiveElementTemplateChanged)(WCharCP previousPath, WCharCP newPath) |
UserFunction called after the active element template has changed.
If the path returned in enpty then the element template was set to "None".
[out] | previousPath | The previous element template path. |
[out] | newPath | The new element template path. |
typedef void(* SystemFunc_ActiveParamChanged)(UInt32 paramType) |
UserFunction called after one of the MicroStation "active parameters" has been changed.
[in] | paramType | Id of parameter that was just changed. |
typedef void(* SystemFunc_AllMdlUnloads)(MdlDesc *unloadedApp, short exitReason, WCharCP taskId, bool keepStub) |
UserFunction called for each app when all MDL apps are unloaded.
[in] | unloadedApp | The current application being unloaded |
[in] | exitReason | The reason the application is exiting. |
[in] | taskId | The task ID for the application being unloaded. |
[in] | keepStub | Whether we should keep the stub. |
typedef void(* SystemFunc_ApplicationAreaChange)() |
UserFunction called when the Application Area is changed.
typedef void(* SystemFunc_BeforeReferenceWrite)(DgnModelRefP modelRef, bool newAttachment) |
UserFunction called before writing a reference attachment element.
typedef void(* SystemFunc_BeforeViewsOpen)() |
UserFunction called just before the views open.
typedef StatusInt(* SystemFunc_CellLibraryChange)(CellLibAsyncMsgP pCellLibAsyncMsg) |
UserFunction called when the Cell Library changes.
[in] | starting | Pointer to a struct that can be used with mdlCellLibAsync_* functions. |
typedef void(* SystemFunc_ClipboardUpdated)() |
UserFunction called when the Clipboard has been updated.
typedef void(* SystemFunc_CmdWindowOpen)(void *cmdWindow) |
UserFunction called when the Status Bar or Command Window has been created.
[in] | cmdWindow | The command window. |
typedef void(* SystemFunc_ColorMapChange)(int screen, byte *colorTable, UInt32 *colorMap, DgnModelRefP modelRef) |
UserFunction called when the colormap changes.
[in] | screen | Screen this is applied to |
[in] | colorTable | Color table. |
[in] | colorMap | Color map. |
[in] | modelRef | ModelRef that the color map is in. |
typedef StatusInt(* SystemFunc_CompressDgnFile)(WCharP errorMessage, CompressType type) |
UserFunction called during a file compress.
[out] | errorMessage | Error message to display if failure is returned. Maximum of 256 characters. |
[in] | type | Whether it's before or after compression. |
typedef void(* SystemFunc_CompressDgnModel)(DgnModelP dgnModel, CompressType type) |
UserFunction called during a file compress for each model.
[in] | dgnModel. | Model to compress. |
[in] | type | Whether it's before or after compression. |
typedef StatusInt(* SystemFunc_CreateLibraryCell)(MSElementDescrH elmdscrPP) |
UserFunction called when a cell is added to a cell library (old method).
This will not be called when a model is created by directly editing a cell library.
[in,out] | elmdscrPP | Cell element descriptor being added. |
typedef void(* SystemFunc_DgnCacheFill)(DgnModelP dgnCache, DgnPlatform::DgnModelSections sections, DgnModelFillContextP context) |
UserFunction called before a DGN cache is filled.
[in] | dgnCache | the cache that is to be filled. |
[in] | sections | the sections that are to be filled. |
[in] | context | the fill context. |
typedef void(* SystemFunc_DgnCacheFilled)(DgnModelP dgnCache, DgnPlatform::DgnModelSections sections, DgnModelFillContextP context) |
UserFunction called after a DGN cache is filled.
[in] | dgnCache | the cache that was filled. |
[in] | sections | the sections that were filled. |
typedef void(* SystemFunc_DgnCacheUnloading)(DgnModelP dgnCache) |
UserFunction called when after a DGN cache is about to be unloaded.
[in] | dgnCache | the cache that is unloading. |
typedef void(* SystemFunc_DgnFileLoaded)(DgnFileP dgnFile) |
UserFunction called after a DGN file is loaded.
NOTE: the DgnCaches have not yet been filled.
[in] | dgnFile | the file object that was loaded |
typedef void(* SystemFunc_DgnFileUnloading)(DgnFileP dgnFile) |
UserFunction called before a DGN file is unloaded.
[in] | dgnFile | the file object that is being unloaded |
typedef void(* SystemFunc_DgnLibsChanged)(MstnPlatform::DgnLibSelector selectors) |
UserFunction called when the set of DgnLibs has been changed.
NOTE: The user function is always called between closing one master file and opening the next.
[in] | selectors | The set of selectors that were changed (one bit is set for each selector). |
UserFunction called during a mdlDialog_findByTypeAndId call.
[in] | dialogType | The type of dialog being sought. |
[in] | dialogId | The id of dialog being sought. |
[in] | ownerMD | The MDL app that owns the dialog. |
typedef void(* SystemFunc_DimStyleChange)(DgnModelRefP modelRef, DgnPlatform::ElementId styleIdIn, DimensionStyleChangeType changeType) |
UserFunction called when a Dimension Style is changed.
[in] | modelRef | The modelRef containing the style. |
[in] | styleIdIn | the ID of the style. |
[in] | changeTypeId | The type of change that occurred. |
typedef void(* SystemFunc_ElmDscrCopy)(EditElementHandleR eeh, DgnModelRefP sourceModelRef, DgnModelRefP destModelRef, bool preCopy) |
UserFunction called when MicroStation is making a copy of persistent elements.
[in] | eeh | if preCopy, the original element handle to be copied; if !preCopy, the copy of the original element |
[in] | sourceModelRef | where edPP is being copied from. |
[in] | destModelRef | where edPP is being copied to. |
[in] | preCopy | true if pre-copy, false is post-copy. |
typedef ElmDscrToFile_Status(* SystemFunc_ElmDscrToFile)(ElmDscrToFile_Actions action, DgnModelRefP modelRef, UInt32 filePos, MSElementDescrP newEdP,MSElementDescrCP oldEdP,MSElementDescrH replacementEdPP) |
The userSystem_elmDscrToFile function is called by MicroStation before
an element descriptor is written to the design file.
The function may modify the element(s) before they are written, or it may stop the operation from occurring at all.
[in] | action | indicates the reason that MicroStation called userSystem_elmDscrToFile. Possible values are:
| ||||||||
[in] | modelRef | model containing this element | ||||||||
[in] | filePos | file pos to modify | ||||||||
[in] | newEdP | the new element being written to the file (or NULL when action==ELMDTF_ACTION_DELETE) | ||||||||
[in] | oldEdP | the element in it's original state, in the case of ELMDTF_ACTION_DELETE or ELMDTF_ACTION_REPLACE. (NULL in the case of ELMDTF_ACTION_APPEND). | ||||||||
[out] | replacementEdPP | a pointer to a pointer to an element descriptor that is allocated and then returned by userSystem_elmDscrToFile. If userSystem_elmDscrToFile returns ELMDTF_STATUS_REPLACE, MicroStation writes this element descriptor to the file rather than the one pointed to by newEdP. Ownership of replacementEdPP is passed to MicroStation. It frees this element descriptor when it is done with it. |
Return Status | Meaning |
---|---|
ELMDTF_STATUS_SUCCESS | Proceed with operation unchanged. |
ELMDTF_STATUS_ABORT | Do not allow operation. Command that initiated the write receives a "write failed" status. |
ELMDTF_STATUS_REPLACE | Continue with the operation using the element descriptor pointed to by replacementEdPP. Not valid if action is ELMDTF_ACTION_DELETE. |
SystemCallback::SetElmDscrToFileFunction
. typedef void(* SystemFunc_ExitDesignFileState)() |
UserFunction called when exiting design file.
typedef void(* SystemFunc_FenceChanged)(FenceChangedType changeType) |
UserFunction called when a fence is created or cleared.
[in] | changeType | Indicates whether the fence was created or cleared. |
typedef bool(* SystemFunc_FileOutdated)(DgnFileP dgnFile, DgnModelRefP modelRef, FileOutdatedCheck_Reason reason) |
UserFunction called when MicroStation is checking to see whether a file that it is using is outdated.
(for example, to see whether a reference needs to be reloaded).
[in] | dgnFile | dgnFileObjP to check |
[in] | modelRef | dgnModelRefP, if checking whether a reference needs to be reloaded. |
[in] | reason | reason the file-outdated check was triggered. |
typedef void(* SystemFunc_FileSave)(DgnPlatform::ProcessChangesWhen when, DgnPlatform::DgnFileChanges changesFlag, DgnPlatform::DgnSaveReason reason, double timestamp, DgnFileP pFile) |
UserFunction called to notify applications that a file is being
processed for "save changes".
[in] | when | indicates whether changes have been processed yet |
[in] | changesFlag | indicates the changes processing action |
[in] | reason | indicates whether a user-request prompted the save action |
[in] | timestamp | the system clock time value at the save action |
[in] | pFile | the file to which the changes are being saved |
typedef void(* SystemFunc_FileSaveAs)(bool postSave, WCharCP destinationFileName) |
UserFunction called when a file is saved to a different name.
[in] | postSave | Indicates whether the the call is before or after the save. |
[in] | destinationFileName | If postSave is true AND it's an export, the created file name. Otherwise NULL. |
typedef void(* SystemFunc_FilterChange)(WCharCP pFilterTableName, UInt32 filterId, FilterChangeType changeTypeId) |
UserFunction called when the level filter is changed.
[in] | pFilterTableName | The Filter Table name. |
[in] | filterId | the ID of the filter. |
[in] | changeTypeId | The type of change that occurred. |
typedef void(* SystemFunc_LevelChange)(DgnModelRefP modelRef, UInt32 levelId, LevelChangeType changeTypeId) |
UserFunction called when a level is changed.
[in] | modelRef | The modelRef identifying the file that contains the level. |
[in] | levelId | The id of the level being changed. |
[in] | changeTypeId | The type of change that occurred. |
typedef void(* SystemFunc_LevelMaskCacheChange)(DgnModelRefP modelRef, UInt32 viewNumber) |
UserFunction called when MicroStation before the level mask cached is changed.
[in] | modelRef | The model ref to indicate the file with the changing level mask. |
[in] | viewNumber | The view number. |
typedef StatusInt(* SystemFunc_LevelPreChange)(DgnModelRefP modelRef, UInt32 levelIdIn, LevelChangeType changeType) |
UserFunction called when MicroStation before a level is changed.
[in] | modelRef | The model ref to indicate the file. |
[in] | levelIdIn | The level ID for the level being modified. |
[in] | changeType | The type of change. |
typedef void(* SystemFunc_LockChanged)(LockChanged_Events eventType) |
UserFunction called after one of the MicroStation "locks" has been changed.
[in] | eventType | type of lock that was just changed. |
typedef void(* SystemFunc_MainToolBoxTaskChanged)(WCharCP previousPath, WCharCP newPath) |
UserFunction called after the current UI "main" task (e.g.
via task navigation) has changed.
[in] | previousPath | The previous path used as the "main" task. |
[in] | newPath | The new (current) path used in the "main" task. |
typedef void(* SystemFunc_MasterfileClosed)() |
UserFunction called after the master file is closed.
typedef void(* SystemFunc_MdlChildTerminated)(MdlChildTerminated const *terminatedChild) |
UserFunction called during the unload of a child application started by the current application.
[in] | terminatedChild | The application being terminated. |
typedef bool(* SystemFunc_MenuBarChange)(WCharCP oldTaskIdP, WCharCP newTaskIdP, bool isNewTask, bool afterMenuBarActivated, DialogItem *menuBarDiP, WCharCP menuItemLabelP) |
UserFunction called when a menu bar changes.
[in] | oldTaskIdP | The task ID for the old menu item. |
[in] | newTaskIdP | The task ID for the new menu item. |
[in] | isNewTask | True if it is calling the new task which is implementing the menubar, false if it is calling the old task. |
[in] | afterMenuBarActivated | False when called before the change, true when called after the change. |
[in] | menuBarDiP | The Dialog Item pointer for the menubar. |
[in] | menuItemLabelP | The menu item label. |
typedef void(* SystemFunc_MessageCenterWrite)(DgnPlatform::OutputMessagePriority messageType, WCharCP pMessage, WCharCP pDetail, long detailMessageAttributes) |
UserFunction called when a message is written to the Message Center.
[in] | messageType | A message type/priority from msdefs.h (Eg. OutputMessagePriority::Error). |
[in] | pMessage | The message written to the Message Center. |
[in] | pDetail | More detail regarding the message. May be NULL. |
[in] | detailMessageAttributes | Attributes for the detailed message MLTextItem. |
typedef void(* SystemFunc_ModelChange)(DgnModelRefP modelRef, ModelChangeType changeTypeId) |
UserFunction called when a model is changed.
[in] | modelRef | The modelRef being changed. |
[in] | changeTypeId | The type of change that occurred. |
typedef void(* SystemFunc_ModelRefDestroy)(DgnModelRefP modelRef) |
UserFunction called after the master file is closed.
[in] | modelRef | The modelref being destroyed. |
typedef void(* SystemFunc_MonitorBatchConvert)(BatchConvert_Info const *info) |
UserFunction called when Batch Convert start, pauses, resumes, and stops.
[in] | info | The Information about the current state of the batch conversion process |
typedef void(* SystemFunc_MonitorBatchProcessing)(BatchProcessing_States state) |
UserFunction called when Batch Processing start, pauses, resumes, and stops.
[in] | state | The state, one of the BatchProcessing_State enum values. |
typedef void(* SystemFunc_MonitorViewCommands)(bool starting) |
UserFunction called when MicroStation starts or exits from a viewing command.
[in] | starting | true when the viewing command is starting, false when it is exiting. |
typedef void(* SystemFunc_MultilineStyleChanged)(MlineStyleMsgType reason, MlineStyleAsynchP asynchData) |
Called when multi-line styles are added, deleted, or modified in the file.
Also called when the active multi-line style is changed.
[in] | reason | The reason the asynch is called. See MlineStyleMsgType. |
[in] | asynchData | An opaque pointer to the information. See mdlMlineStyleAsynch_getNew, mdlMlineStyleAsynch_getOld, and mdlMlineStyleAsynch_getModelRef. |
typedef bool(* SystemFunc_NativeExceptionHandler)(int exceptionCode, void *exceptionPointersP, MdlDesc *applicationCausingException) |
UserFunction called when a call into native code results in an operating system exception (such as an access violation).
[in] | exceptionCode | code number for native OS exception that occurred |
[in] | exceptionPointersP | pointer to native EXCEPTION_POTERS structure |
[in] | applicationCausingException | the current MDL descriptor at the time the application occurred. |
typedef void(* SystemFunc_NewDesignFile)(WCharCP fileP, NewDesignFileReason state) |
UserFunction called when a new design file is opened.
[in] | fileP | The name of the file being opened. |
[in] | state | Whether the call is when the old file is closed or just after the new one is opened. |
typedef void(* SystemFunc_PromptOutput)(WCharCP pText, WCharCP pCombinedText, int fieldNumber) |
UserFunction called when a prompt is written to the status bar.
[in] | pText | The prompt text. |
[in] | pCombinedText | The built prompt with command and prompt text. |
[in] | fieldNumber | The fieldNumber. 0-Status, 1-Message, 2-Command, 3-Prompt, 4-Keyin, 5-Error |
typedef bool(* SystemFunc_QueryHasPending)(DgnFileP pDgnFileObj) |
UserFunction called during a save to allow listeners to say that there are changes and the file must be saved.
[in] | pDgnFileObj | The file being tested. |
typedef StatusInt(* SystemFunc_ReferenceAttach)(WCharP fileName, WCharCP fullSavedPath, DgnModelRefP parentModelRef, WCharCP providerId, DgnPlatform::ElementId attachmentId) |
UserFunction called before a reference is attached.
[in,out] | fileName | The filename of the reference. |
[in] | fullSavedPath | The full path to the reference. |
[in] | parentModelRef | The modelRef that the reference is being attached to. |
[in] | providerId | The provider. |
[in] | attachmentId | Element ID for the newly created reference element. |
typedef void(* SystemFunc_ReferenceAttached)(DgnModelRefP modelRef, DgnPlatform::DgnAttachmentAttachedReason cause) |
UserFunction called after a reference is attached.
[in] | modelRef | The modelRef containing the reference. |
[in] | fileName | The name of the reference file being detached. |
[in] | cause | The reason the message was sent. |
typedef void(* SystemFunc_ReferenceAttachQueue)(SystemRefAttachQueueState state) |
UserFunction called when MicroStation starts and ends processing of the reference attachment queue.
[in] | state | The queue state. |
typedef StatusInt(* SystemFunc_ReferenceDetach)(DgnModelRefP modelRef) |
UserFunction called before a reference is detached.
[in] | modelRef | The modelRef for the reference. |
typedef void(* SystemFunc_ReferenceDetached)(DgnModelRefP modelRef, WCharCP fileName, DgnPlatform::DgnAttachmentDetachedReason cause) |
UserFunction called after a reference is detached.
[in] | modelRef | The modelRef containing the reference. |
[in] | fileName | The name of the reference file being detached. |
[in] | cause | The reason the message was sent. |
typedef void(* SystemFunc_ReferenceModified)(DgnAttachmentCP pOldRef, DgnAttachmentCP pNewRef, DgnModelRefP modelRef, bool changesWritten, bool isUndo) |
UserFunction called when a reference is changed.
[in] | pOldRef | The reference before the change. |
[in] | pNewRef | The reference after the change. |
[in] | modelRef | The modelRef being containing the references. |
[in] | changesWritten | Whether the changes have been written. |
[in] | isUndo | Whether the changes are a result of undo operation. |
typedef void(* SystemFunc_ReferenceNesting)(DgnModelRefP refModelRef, DgnPlatform::RefAttachNestMode nestFlag, int nestDepth, DgnPlatform::RefAttachNestMode previousNestFlag, int previousNestDepth, bool changeExisting) |
UserFunction called after user has selected a refernce file/model and established the attachment settings, just before the nested references are loaded.
This hook can be used to make sure the nested references are available before MicroStation attempts to load them.
[in] | refModelRef | the reference modelRef that is getting attached |
[in] | nestFlag | one of RefAttachNestMode::None, RefAttachNestMode::Copy, RefAttachNestMode::Display |
[in] | nestDepth | the nesting depth requested for the new attachment |
[in] | previousNestFlag | the previous nesting flag of the attachment |
[in] | previousNestDepth | the previous nesting depth of the attachment |
[in] | changeExisting | true for an existing attachment, false for a new attachment |
typedef void(* SystemFunc_ReloadProgram)(int argc, WCharCP argv[]) |
UserFunction called for each app when an MDL app is reloaded.
The arguments are the same as a call to MdlMain().
[in] | argc | Number of arguments in argv. |
[in] | argv | An array of strings containing the arguments to the application. |
typedef void(* SystemFunc_RibbonBackstageOpened)() |
UserFunction called when the Ribbon's Backstage is opened.
typedef void(* SystemFunc_SaveSettings)() |
UserFunction called when the settings are saved.
typedef void(* SystemFunc_SelectedViewChanged)(int oldViewIndex, int newViewIndex, bool bFromButtonEvent) |
UserFunction called when the selected View window changes.
[in] | oldViewIndex | 0-based index of the View window which had been previously selected. |
[in] | newViewIndex | 0-based index of the View window being selected. |
[in] | bFromButtonEvent | True if the call is from a user button event. |
typedef void(* SystemFunc_StatusOutput)(WCharCP pText, int fieldNumber) |
UserFunction called when a status message is written to the status bar.
[in] | pText | The status text. |
[in] | fieldNumber | The fieldNumber. 0-Status, 1-Message, 2-Command, 3-Prompt, 4-Keyin, 5-Error |
typedef void(* SystemFunc_SymbologyChanged)(SymbChangeMsgType reason, SymbChangeAsynchP asynchData) |
Called when the active symbology is changed.
This includes color, weight, and line style. Note that it is possible for applications to change the values in the TCB directly and circumvent these messages. However, most applications will use a call to mdlParams_setActive or the keyins for ACTIVE COLOR, etc.
[in] | reason | The reason the asynch is called. See SymbChangeMsgType. |
[in] | asynchData | An opaque pointer to the information. See mdlSymbChangeAsynch_getOldColor, mdlSymbChangeAsynch_getNewColor, mdlSymbChangeAsynch_getOldWeight, mdlSymbChangeAsynch_getNewWeight, mdlSymbChangeAsynch_getOldLineStyle, mdlSymbChangeAsynch_getNewLineStyle. |
typedef void(* SystemFunc_TaskNavigationTaskChanged)(WCharCP pTaskPath, WCharCP pTaskName, int viewIndex, const void *pIconRsc) |
UserFunction called after the current UI task (e.g.
via task navigation) has changed.
[in] | pTaskPath | Path to the current task. |
[in] | pTaskName | Display name of the current task. |
[in] | viewIndex | Index of the associated view; -1 if Task Navigation not configured to be "in views". |
[in] | pIconRsc | IconRsc associated with the current task. |
typedef void(* SystemFunc_TaskNavigationTaskChanging)(bool *cancelTaskChange, WCharCP currentPath, WCharCP newPath) |
UserFunction called before the active task is changed.
This allows users to cancel the task change, leaving the current task active. As soon as the first listener sets cancelTaskChange, further changes to cancelTaskChange are ignored, and the task change will be cancelled.
1. When a workflow is selected in the task navigation dialog, the workflow itself will first send the TaskChanging event to validate whether the workflow can be activated. If valid, this will NOT be followed by a TaskChanged event. Instead, it will be followed by a second TaskChanging event for the task within the workflow that is activated. Assuming success at this point, a TaskChanged message will be sent for the task that was just activated. 2. When a task navigation dialog first opens, it will issue a TaskChanging event to validate the dialog root, which will not be followed up by an an immediate TashChanged event; similar to #1 above. Additionally, if the 'All Tasks' task navigation dialog is already open and a user cancels a new dialog's root path, no additional events will be fired (as the existing 'All Tasks' dialog is focused and left in its current state); as opposed to the initial open task's changing and changed events.
Additionally, keep in mind that this async should be used for validation only. This specifically means that you should NOT perform any actions that affect the state of the task navigation dialog or toolbox. Performing any such actions during this async could place the dialog or toolbox in an invalid state.
[out] | cancelTaskChange | If set to true, the task change will be cancelled. |
[in] | currentPath | The current task path. |
[in] | newPath | The proposed task path to activate. |
typedef void(* SystemFunc_TextStyleChange)(DgnModelRefP modelRef, UInt32 styleId, TextStyleChangeType changeTypeId) |
UserFunction called when a Text Style is changed.
[in] | modelRef | The modelRef containing the style. |
[in] | styleId | the ID of the style. |
[in] | changeTypeId | The type of change that occurred. |
typedef bool(* SystemFunc_UnloadProgram)(UnloadProgramReason reason) |
UserFunction called during the unload of an application.
[in] | reason | The reason that the application is exiting. |
typedef void(* SystemFunc_UpdateSequenceChanged)(DgnModelRefP modelRef, UpdateSequenceListP sequence) |
UserFunction called when MicroStation is setting the update sequence for a modelRef.
[in] | modelRef | modelRef for which update sequence is being set. |
[in] | sequence | the update sequence |
typedef void(* SystemFunc_UpgradeV7ToV8)(DgnFileP dgnFileObj, bool permanent, bool firstInBatchUpgrade) |
UserFunction called when BatchConvert upgrades a file from V7 to V8.
[in] | dgnFileObj | File being upgraded |
[in] | permanent | |
[in] | firstInBatchUpgrade |
typedef void(* SystemFunc_ViewGroupCacheChange)(WCharCP nameP, WCharCP descriptionP, ViewGroupChangeType changeTypeId) |
UserFunction called when ViewGroup cache changes.
[in] | nameP | The ViewGroup name. |
[in] | descriptionP | The ViewGroup description. |
[in] | changeTypeId | The type of change that occurred. |
typedef bool(* SystemFunc_WindowClose)(MSWindowP gwP, int closeReason) |
UserFunction called when a window is closed.
[in] | gwP | The window being closed. |
[in] | closeReason | The reason for the async call. Values from HideReasonCode enum. |
typedef bool(* SystemFunc_WindowsKeystrokeMessage)(void *windowID, UInt32 messageNumber, uintptr_t wParam, intptr_t lParam, long x, long y) |
UserFunction called for keystroke messages from Windows.
[in] | windowID | The ID of the window. |
[in] | messageNumber | Windows message. |
[in] | wParam | Message parameters. |
[in] | lParam | Message parameters. |
[in] | x | X coordinate. |
[in] | y | Y coordinate. |
typedef void(* SystemFunc_WorkspaceChanged)() |
UserFunction called when the workspace has changed.
The possible batch processing states returned from mdlSystem_getBatchProcessingState
.
or in BatchConvert_Info structure.
Enumerator | |
---|---|
PROCESSSTATE_Inactive | |
PROCESSSTATE_Processing | |
PROCESSSTATE_Paused | |
PROCESSSTATE_Done | |
PROCESSSTATE_Cancelled | |
PROCESSSTATE_OpeningFile | |
PROCESSSTATE_AnalyzeFile | |
PROCESSSTATE_ClosedFile |
enum LockChanged_Events |
The types of lock-changed events that can be monitored.
enum MlineStyleMsgType |
The reasons that SystemFunc_MultilineStyleChanged is called.
enum SymbChangeMsgType |
The reasons that SystemFunc_SymbologyChanged is called.
Enumerator | |
---|---|
SYMBCHANGE_PreColorChange | |
SYMBCHANGE_PostColorChange | |
SYMBCHANGE_PreWeightChange | |
SYMBCHANGE_PostWeightChange | |
SYMBCHANGE_PreLinestyleChange | |
SYMBCHANGE_PostLinestyleChange |
BatchProcessing_States mdlSystem_getBatchProcessingState | ( | ) |
Retrieve the current state of batch processing.