DialogManager.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------------------+
2 |
3 | Supplied under applicable software license agreement.
4 |
5 | Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
6 |
7 +---------------------------------------------------------------------------------------*/
8 #pragma once
9 
10 #include <Mstn\MdlApi\MSDialog.h>
11 
12 typedef struct DialogManager* DialogManagerP;
15 
16 //=======================================================================================
19 //=======================================================================================
21 {
22  /*---------------------------------------------------------------------------------**/
28  virtual void OnUserInterfaceSyncEvent (UInt32* pendingUIEventsMasksBuffer, size_t numSyncGroupsInBuffer) = 0;
29 }; // IUISyncEventMonitor
30 
31 
32 
33 //=======================================================================================
37 //=======================================================================================
39 {
42  MSCORE_EXPORT static DialogManagerP Instance();
43 
48  MSCORE_EXPORT static BSIColorDescr* GetFixedColor(int colorIndex);
49 
52  MSCORE_EXPORT static MSDialogP GetKeyin();
53 
56  MSCORE_EXPORT static MSDialogP GetStatusBar();
57 
60  MSCORE_EXPORT static MSDialogP GetTaskToolBox();
61 
64  MSCORE_EXPORT static MSDialogP GetToolSettings();
65 
69  MSCORE_EXPORT BentleyStatus RegisterUISyncEventMonitor(IUISyncEventMonitorR eventMonitor);
70 
74  MSCORE_EXPORT void DropUISyncEventMonitor(IUISyncEventMonitorR eventMonitor);
75 
79  MSCORE_EXPORT static void SendUISyncMessage(RscId syncGroupRscId, WStringR mdlTaskId, RscId syncItemId);
80 
84  MSCORE_EXPORT static void SendUISyncMessage(RscId syncGroupRscId, MdlDescP mdlDesc, RscId syncItemId);
85 
89  MSCORE_EXPORT static void SendImmediateUISyncMessage(RscId syncGroupRscId, WStringR mdlTaskId, RscId syncItemId);
90 
94  MSCORE_EXPORT static void SendImmediateUISyncMessage(RscId syncGroupRscId, MdlDescP mdlDesc, RscId syncItemId);
95 
98  MSCORE_EXPORT static void ReinitializeEventHandler();
99 
102  MSCORE_EXPORT void ActivateContextualTabSet(WCharCP key);
103 
106  MSCORE_EXPORT void DeactivateContextualTabSet(WCharCP key);
107 
110  MSCORE_EXPORT void ClearAllContextualTabSetKeys();
111 
112 };
113 
struct IUISyncEventMonitor & IUISyncEventMonitorR
Definition: DialogManager.h:13
struct DialogManager * DialogManagerP
Definition: DialogManager.h:12
static BSIColorDescr * GetFixedColor(int colorIndex)
Returns a pointer to the Color Descriptor associated with the color index.
BentleyStatus RegisterUISyncEventMonitor(IUISyncEventMonitorR eventMonitor)
Registers a UISyncEventMonitor.
static MSDialogP GetTaskToolBox()
Returns a pointer to the Task ToolBox.
void ClearAllContextualTabSetKeys()
Clear all keys that can be used to determine the active ContextualTabSets.
IUISyncEventMonitor - abstract class that allows callers to get notified when certain system events a...
Definition: DialogManager.h:20
static MSDialogP GetKeyin()
Returns a pointer to the Keyin Browser Dialog.
void DropUISyncEventMonitor(IUISyncEventMonitorR eventMonitor)
Drops/Deregisters a UISyncEventMonitor.
DialogManager is a convenience class that provides methods to obtain information about the Microstati...
Definition: DialogManager.h:38
static void SendImmediateUISyncMessage(RscId syncGroupRscId, WStringR mdlTaskId, RscId syncItemId)
Immediately send a message to UI items listening for this specific event to refresh themselves...
static void ReinitializeEventHandler()
Method only needed if loading synch groups directly and not through use of cfgvar MS_SYNCGROUP_APPS...
wchar_t const * WCharCP
Definition: Bentley.h:224
uint32_t UInt32
Definition: Bentley.r.h:128
struct Bentley::WString & WStringR
Definition: Bentley.h:239
struct IUISyncEventMonitor * IUISyncEventMonitorP
Definition: DialogManager.h:14
static MSDialogP GetToolSettings()
Returns a pointer to the Tool Settings Dialog.
static MSDialogP GetStatusBar()
Returns a pointer to the Status Bar.
BentleyStatus
Definition: Bentley.h:208
struct mdlDesc * MdlDescP
Definition: ConfigurationManager.h:13
virtual void OnUserInterfaceSyncEvent(UInt32 *pendingUIEventsMasksBuffer, size_t numSyncGroupsInBuffer)=0
Method called when one of the available event types is encountered.
void DeactivateContextualTabSet(WCharCP key)
Deactivate ContextualTabSet by specifying key.
struct colordescr BSIColorDescr
Definition: MicroStation.r.h:30
int32_t RscId
Definition: ecimagekey.h:16
void ActivateContextualTabSet(WCharCP key)
Activate ContextualTabSet by specifying key.
static void SendUISyncMessage(RscId syncGroupRscId, WStringR mdlTaskId, RscId syncItemId)
Send a message to UI items that need to refresh themselves when certain events occur.
static DialogManagerP Instance()
Retrieves the singleton pointer to the DialogManager instance.

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