dlogitem.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "mdl.h"
#include "dlogbox.r.h"
#include "dlogmsg.r.h"
#include <DgnPlatform\ColorUtil.h>
#include <Mstn\MstnDefs.h>
#include "msinputq.h"
#include "rscdefs.r.h"
#include "treemodel.h"
#include "vartypes.h"
#include "mstypes.h"
#include "msvaluedescr.h"
#include "DialogItem.h"

#define INVALID_ITEM                (-1)
#define BUTTONTIMEOUT_CLICK         0           /* down to up > dClickTime/2 */
#define BUTTONTIMEOUT_DOUBLECLICK   1           /* down to down > dclickTime */
#define MVHND_OFFSET                5

USING_NAMESPACE_BENTLEY_MSTNPLATFORM

/*----------------------------------------------------------------------+
|                                                                       |
|   Opaque Pointer Typedefs                                             |
|                                                                       |
+----------------------------------------------------------------------*/

typedef struct IDataObject          GuiDataObject;
typedef struct mdlDesc              MdlDesc;
typedef struct UICriteria*          UICriteriaP;


/* DialogItem moved to DialogItem.h */
/* ValueUnion moved to vartypes.h */
/* DialogMessageType moved to dlogmsg.r.h */


typedef void (*PFDialogHook)(void *);                   // the void * is either a DialogMessage * or a DialogItemMessage *
typedef void (*PFDialogBoxHook)(DialogMessageP);        // This is specifically for DialogMessage *
typedef void (*PFDialogItemHook)(DialogItemMessageP);   // This is specifically for DialogItemMessage *

typedef void (*PFDialogItemHandler)(DialogItemMessageP);

//=======================================================================================
//=======================================================================================
struct DialogItemHandler
    {
    RscType                         itemType;
    PFDialogItemHandler             itemHandlerFunction;
    WChar                           name[32];
    VersionNumber                   version;
    };

//=======================================================================================
//=======================================================================================
struct DialogItemHandlerInfo
    {
    DialogItemHandler               handler;
    MdlDescP                        handlerMD;
    BSIColorDescr**                 handlerColorsP;

    UInt32                          bevelOffset:1;              
    UInt32                          informDialogResized:1;      
    UInt32                          noItemResource:1;           
    UInt32                          canKeepMouse:1;             
    UInt32                          informGuiChanged:1;         
    UInt32                          acceptsNonDataPoints:1;     
    UInt32                          informNeutralMotion:1;      
    UInt32                          informNeutralNoMotion:1;    
    UInt32                          handlesDocking:1;           
    UInt32                          informWindowMoving:1;       
    UInt32                          unused:22;

    UInt32                          attributes2;
    UInt32                          reserved1;
    UInt32                          reserved2;
    };                              
    
/* DialogItem struct moved to DialogItem.h */

//=======================================================================================
//=======================================================================================
struct RawItemHdr
    {
    void*                           userDataP;              
    CharP                           accessStrP;                     // CHAR_OK

    Point2d                         labelPt;                
    BSIRect                         itemRect;               
    UInt32                          helpInfo;               
    UInt32                          helpSource;             
    RscId                           synonymsId;             
    UShort                          highlightOn:1;          
    UShort                          informMotion:1;         
    UShort                          focusOutSetState:1;     
    UShort                          commandSource:1;        
    UShort                          prevNoMotionItem:1;     
    UShort                          prevMotionItem:1;       
    UShort                          numPadKey:1;            
    UShort                          unused:1;

    UShort                          dropSource:1;           
    UShort                          dropTarget:1;           
    UShort                          layoutItem:1;           
    UShort                          unused2:6;

    void*                           pHookList;              
    UInt64                          itemHookArg;            
    MSDialogP                       ownerDialogP;           
    DialogItemP                     diP;                    
    RawItemHdrP                     parentRiP;              
    long                            itemHookId;             
    int                             mnemonic;               
    int                             mneIndex;               
    int                             nColorPs;               
    BSIColorDescr**                 colorsPP;               
    DialogItemHandlerInfo*          itemHandlerP;           
    BSIRect                         traversalRect;          
    MdlDescP                        ownerMD;                
    CommandNumber                   commandNumber;          
    WCharP                          commandTaskIdP;         
    WCharP                          unparsedP;              
                                                            /* popupWindP removed */
    UInt32                          ulSignature;            
    RawItemHdrP                     childFocusRiP;          
    void*                           pChildList;             
    WCharP                          rscOwnerTaskIdP;        
    CharP                           dbAccessStrP;                              // CHAR_OK
    void*                           dbAuxInfoP;             
    long                            dbPageNumber;           
    void*                           appData1P;              
    void*                           appData2P;
    void*                           appData3P;
    void*                           appData4P;
    void*                           appData5P;

    RawItemHdrP                     originalParent;         
    int                             labelFontIndex;         
    RawItemHdrP                     rightClickPopupMenu;    
    RawItemHdrP                     ownerRiP;               
    UInt32                          attributesExt;          
    WStringP                        labelString;            
    WStringP                        flyoverString;          
    WStringP                        balloonString;          
    WStringP                        disabledBalloonString;  
    WStringP                        popupMenuString;        
    WCharP                          pName;                  
    RawItemHdrP                     linkedLabelP;           
    GuiLayoutControlP               layoutControlP;         
    GuiLayoutPropertiesP            layoutPropertiesP;      
    int                             positionalKeystroke;    
    virtual bool                    _CanDisplay () { return true; }

    };

//=======================================================================================
//=======================================================================================
enum class HideReasonCode
    {
    HideWindow                      = 0,        
    Exiting                         = 1,        
    WindowClose                     = 2,        
    NoDgnFile                       = 3,        
    UserClose                       = 4,        
    MdlUnload                       = 5         
    };

//=======================================================================================
//=======================================================================================
struct MouseWheelEventData
    {
    UInt32                          fwKeys;             
    long                            xPos;               
    long                            yPos;               
    long                            wheelDelta;         
    long                            scrollIncrement;    
    };

//=======================================================================================
//=======================================================================================
enum class FocusOutType
    {
    None                            = 0,
    KeySwitch                       = 1,        
    ButtonSwitch                    = 2,        
    SetItem                         = 3,
    HideItem                        = 4,
    DisableItem                     = 5,
    SwitchDialog                    = 10,
    ApplyDialog                     = 11
    };

//=======================================================================================
//=======================================================================================
enum class MotionTransType
    {
    InItem                          = 0,                    
    Enter                           = 1,                    
    Exit                            = 2,                    
    InDialog                        = 3                     
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Drag & Drop Event Data                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#define GUIDROPEFFECT_NONE          0x00000000
#define GUIDROPEFFECT_COPY          0x00000001
#define GUIDROPEFFECT_MOVE          0x00000002
#define GUIDROPEFFECT_LINK          0x00000004
#define GUIDROPEFFECT_SCROLL        0x80000000

//=======================================================================================
//=======================================================================================
enum class GuiDragDropStatus
    {
    OK      = SUCCESS,
    Drop,
    Cancel,
    Error   = ERROR
    };

//=======================================================================================
//=======================================================================================
enum class GuiDropSourceMsg
    {
    Begin,
    Query,
    PreCancel,
    PreDrop,
    Drop,
    End
    };

//=======================================================================================
//=======================================================================================
enum class GuiDropTargetMsg
    {
    Enter,
    Over,
    Leave,
    Drop,
    QueryCursorUpdate
    };

//=======================================================================================
//=======================================================================================
enum class DockingState
    {
    Docking,
    Docked,
    Undocking,
    Undocked
    };

//=======================================================================================
//=======================================================================================
enum class AutoHideState
    {
    None,
    Pinned,
    UnpinnedCollapsed,
    UnpinnedExpanded
    };

//=======================================================================================
//=======================================================================================
struct DialogHookInterests                                  /* set member true if want notification */
    {
    UInt32                          updates:1;
    UInt32                          mouses:1;
    UInt32                          keystrokes:1;
    UInt32                          dialogFocuses:1;        
    UInt32                          itemFocuses:1;          
    UInt32                          synchs:1;
    UInt32                          resizes:1;              
    UInt32                          calcSizes:1;

    UInt32                          fontChanges:1;
    UInt32                          nonDataPoints:1;        
    UInt32                          otherDialogs:1;         
    UInt32                          stateChangeds:1;
    UInt32                          minimizes:1;
    UInt32                          maximizes:1;
    UInt32                          activates:1;
    UInt32                          preButtons:1;           

    //UInt32                          itemNeutralMotions:1;   /* TODO - not hooked up yet */
    //UInt32                          itemNeutralNoMotions:1; /* TODO - not hooked up yet */
    UInt32                          windowMoving:1;         
    UInt32                          docking:1;              
    UInt32                          undocking:1;            
    UInt32                          screenChanges:1;        
    UInt32                          attaches:1;             
    UInt32                          createds:1;             
    UInt32                          mouseWheels:1;          
    UInt32                          dialogMotions:1;        
    UInt32                          dragDrops:1;            
    UInt32                          restoreds:1;            
    UInt32                          unused:4;
    };                                                      /* CREATE, INIT, & DESTROY ALWAYS SENT */


//=======================================================================================
//=======================================================================================
struct MotionFuncArg
    {
    Point2d                         pt;                     
    bool                            dragging;               
    MSDialogP                       db;                     
    RawItemHdrP                     riP;                    
    };

#if defined (mdl)
    typedef void* MdlMotionFuncP;
#else
    typedef void (*MdlMotionFuncP)(MotionFuncArg*);
#endif

/*----------------------------------------------------------------------+
|                                                                       |
|   Structures for DialogMessage types                                  |
|                                                                       |
+----------------------------------------------------------------------*/

//=======================================================================================
//=======================================================================================
struct DialogHookResolveArgs
    {
    DialogHookHandlerP              hookHandlerP;           
    };

typedef DialogHookResolveArgs&   DialogHookResolveArgsR;

//=======================================================================================
//=======================================================================================
struct DialogCreateArgs
    {
    bool                            createFailed;           
    DialogHookInterests             interests;              
    void**                          userDataPP;             
    DialogBoxRsc*                   dialogBoxRP;            
    };

typedef DialogCreateArgs&   DialogCreateArgsR;

//=======================================================================================
//=======================================================================================
struct DialogInitArgs
    {
    bool                            initFailed;             
    };

typedef DialogInitArgs&   DialogInitArgsR;

    
//=======================================================================================
//=======================================================================================
struct DialogActionButtonArgs
    {
    bool                            abortAction;            
    int                             actionType;             
    };

typedef DialogActionButtonArgs&   DialogActionButtonArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogActivateArgs
    {
    UInt32                          couldSetState;          
    RawItemHdrP                     activatedRiP;           
    int                             itemIndex;              
    int                             keystroke;              
    int                             rawKeystroke;           
    int                             qualifierMask;          
    bool                            isAccelerator;          
    CommandNumber                   commandNumber;          
    WCharCP                         unparsedP;              
    WCharCP                         commandTaskIdP;         
    };

typedef DialogActivateArgs&   DialogActivateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogAnotherOpenedArgs
    {
    MSDialogP                       db;                     
    RscType                         dialogType;             
    RscId                           dialogId;               
    };

typedef DialogAnotherOpenedArgs&   DialogAnotherOpenedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogAnotherClosedArgs
    {
    MSDialogP                       db;                     
    RscType                         dialogType;             
    RscId                           dialogId;               
    int                             actionType;             
    };

typedef DialogAnotherClosedArgs&   DialogAnotherClosedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogAttachArgs
    {
    Point2d                         attachPoint;            
    bool                            hookHandled;            
    Point2d                         cornerBuffer;           
    };

typedef DialogAttachArgs&   DialogAttachArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogAutoHideStateArgs
    {
    AutoHideState                   state;                  
    bool                            changed;                
    };

typedef DialogAutoHideStateArgs&   DialogAutoHideStateArgsR;

//=======================================================================================
//=======================================================================================
struct DialogBeforeDestroyArgs
    {
    bool                            stopDestroy;            
    bool                            userRequested;          
    int                             actionType;             
    };                            

typedef DialogBeforeDestroyArgs&   DialogBeforeDestroyArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogBeforeUndockArgs
    {
    bool                            stopUndock;             
    };

typedef DialogBeforeUndockArgs&   DialogBeforeUndockArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogButtonArgs
    {
    int                             buttonNumber;           
    int                             buttonTrans;            
    int                             qualifierMask;          
    int                             upNumber;               
    bool                            clicked;                
    UInt32                          buttonTime;             
    Point2d                         pt;                     
    int                             itemIndex;              
    Inputq_element *                iqelP;                  
    MdlMotionFuncP                  motionFunc;             
    MdlDescP                        motionMD;               
    RawItemHdrP                     buttonRiP;          
    bool                            hookHandled;            
    int                             originalButtonNumber;   
    };

typedef DialogButtonArgs&   DialogButtonArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogCalcSizeArgs
    {
    bool                            hookHandled;            
    int                             newWidth;               
    int                             newHeight;              
    int                             dialogWidth;            
    int                             dialogHeight;           
    int                             newFontHeight;          
    int                             oldFontHeight;          
    };

typedef DialogCalcSizeArgs&   DialogCalcSizeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogChildDestroyedArgs
    {
    RscId                           childDialogId;          
    int                             actionType;             
    };

typedef DialogChildDestroyedArgs&   DialogChildDestroyedArgsR;

//=======================================================================================
//=======================================================================================
struct DialogDestroyArgs
    {
    int                             actionType;             
    HideReasonCode                  reasonCode;             
    };

typedef DialogDestroyArgs&   DialogDestroyArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogDockingStateArgs
    {
    DockingState                    state;
    };

typedef DialogDockingStateArgs&   DialogDockingStateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogDockedExtentArgs
    {                                                       /* Get dialog's extent when docked */
    int                             dockPosition;           
    int                             extentFlag;             
    Point2d                         dockExtent;             
    bool                            hookHandled;            
    };

typedef DialogDockedExtentArgs&   DialogDockedExtentArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogDropTargetArgs
    {
    GuiDropTargetMsg                msgType;
    GuiDataObject*                  pDataObject;
    UInt32                          dwKeyState;
    Point2d                         localPt;
    UInt32                          guiDropEffect;
    bool                            sendToDialogItem;
    bool                            wantCursorUpdate;
    };

typedef DialogDropTargetArgs&   DialogDropTargetArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogFocusInArgs
    {
    int                             itemIndex;              
    FocusOutType                    focusOutType;           
    RawItemHdrP                     riP;                    
    MSDialogP                       previousFocusDbP;       
    };

typedef DialogFocusInArgs&   DialogFocusInArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogFocusOutArgs
    {
    bool                            outOfRange;             
    bool                            hookHandled;            
    int                             nextFocusItemIndex;     
    RawItemHdrP                     nextFocusRiP;           
    int                             itemIndex;              
    FocusOutType                    focusOutType;           
    int                             moveDirection;          
    RawItemHdrP                     riP;                    
    MSDialogP                       nextFocusDbP;           
    };

typedef DialogFocusOutArgs&   DialogFocusOutArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogFontChangedArgs
    {
    int                             newFontHeight;          
    int                             oldFontHeight;          
    };

typedef DialogFontChangedArgs&   DialogFontChangedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogHideArgs
    {
    HideReasonCode                  reason;                 
    };

typedef DialogHideArgs&   DialogHideArgsR;

//=======================================================================================
//=======================================================================================
struct DialogKeystrokeArgs
    {
    bool                            hookHandled;            
    int                             moveDirection;          
    int                             keystroke;              
    int                             rawKeystroke;           
    int                             qualifierMask;          
    int                             itemIndex;              
    Inputq_element *                iqelP;                  
    bool                            isAccelerator;          
    CommandNumber                   commandNumber;          
    WCharCP                         unparsedP;              
    WCharCP                         commandTaskIdP;         
    RawItemHdrP                     riP;                    
    };

typedef DialogKeystrokeArgs&   DialogKeystrokeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogMaximizeArgs
    {
    bool                            hookHandled;            
    BSIRect                         newRect;                
    };

typedef DialogMaximizeArgs&   DialogMaximizeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogMinimizeArgs
    {
    bool                            hookHandled;            
    int                             newWidth;               
    int                             newHeight;              
    };

typedef DialogMinimizeArgs&   DialogMinimizeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogMotionArgs
    {
    MotionTransType                 motionTrans;            
    UInt32                          motionTime;             
    Point2d                         newPoint;               
    Point2d                         oldPoint;               
    RawItemHdrP                     motionRiP;              
    MSWindowP                       otherWindowP;           
    bool                            otherWinPopup;          
    };

typedef DialogMotionArgs&   DialogMotionArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogMouseWheelArgs 
    {
    MouseWheelEventData             eventData;
    };

typedef DialogMouseWheelArgs&   DialogMouseWheelArgsR;

//=======================================================================================
//=======================================================================================
struct DialogResizeArgs
    {
    int                             whichCorners;           
    BSIRect                         oldFrame;               
    BSIRect                         oldContent;             
    BSIRect                         newContent;             
    bool                            forceCompleteRedraw;    
    int                             numUpdateRects;         
    BSIRectP                        updateRectsP;           
    };

typedef DialogResizeArgs&   DialogResizeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogRestoredArgs
    {
    bool                            hookHandled;            
    BSIRect                         newRect;                
    };

typedef DialogRestoredArgs&   DialogRestoredArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogScreenChangeArgs
    {
    int                             oldScreenNum;           
    BSIRect                         oldSizeRect;            
    int                             newScreenNum;           
    BSIRect                         newSizeRect;            
    bool                            before;                 
    bool                            hookHandled;            
    bool                            disallow;               
    };

typedef DialogScreenChangeArgs&   DialogScreenChangeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogStateChangedArgs
    {
    int                             itemIndex;              
    bool                            reallyChanged;          
    RawItemHdrP                     riP;                    
    };

typedef DialogStateChangedArgs&   DialogStateChangedArgsR;

//=======================================================================================
//=======================================================================================
struct DialogTitleChangedArgs 
    {
    WCharCP                         oldTitle;               
    WCharCP                         newTitle;               
    };

typedef DialogTitleChangedArgs&   DialogTitleChangedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogUpdateArgs
    {
    bool                            hookHandled;            
    };

typedef DialogUpdateArgs&   DialogUpdateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogUserArgs
    {
    int                             type;                   
    void*                           userDataP;              
    };                                                 

typedef DialogUserArgs&   DialogUserArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogWindowMovingArgs
    {                                                       /* Sent before move occurs */
    int                             whichCorners;           
    int                             newWidth;               
    int                             newHeight;              
    BSIRect                         oldGlobal;              
    BSIRect                         oldContent;             
    byte                            percentDone;            
    byte                            handled;                
    };

typedef DialogWindowMovingArgs&   DialogWindowMovingArgsR;
               
/*-----------------------------------------------------------------------
  The following DialogMessageType types have no arguments:

  DIALOG_MESSAGE_SYNCH            
  DIALOG_MESSAGE_CREATED          
  DIALOG_MESSAGE_DETACH           
  DIALOG_MESSAGE_LAYOUT
+-----------------------------------------------------------------------*/  

//=======================================================================================
//=======================================================================================
struct DialogMessage
    {
    bool                            msgUnderstood;          
    DialogMessageType               messageType;            
    MSDialogP                       db;                     
    RscId                           dialogId;               
    void*                           userDataP;              
    union
        {                                                   /* Arguments for DialogMessageType: */
        DialogHookResolveArgs       hookResolve;            
        DialogCreateArgs            create;                 
        DialogInitArgs              init;                   
        DialogBeforeDestroyArgs     beforeDestroy;          
        DialogDestroyArgs           destroy;                
        DialogActionButtonArgs      actionButton;           
        DialogActivateArgs          activate;               
        DialogAnotherOpenedArgs     anotherOpened;          
        DialogAnotherClosedArgs     anotherClosed;          
        DialogAttachArgs            attach;                 
        DialogAutoHideStateArgs     autoHideState;          
        DialogBeforeUndockArgs      beforeUndock;           
        DialogButtonArgs            button;                 
        DialogCalcSizeArgs          calcSize;               
        DialogChildDestroyedArgs    childDestroyed;         
        DialogDockedExtentArgs      dockedExtent;           
        DialogDockingStateArgs      dockingState;           
        DialogDropTargetArgs        dropTarget;             
        DialogResizeArgs            resize;                 
        DialogFocusInArgs           focusIn;                
        DialogFocusOutArgs          focusOut;               
        DialogFontChangedArgs       fontChanged;            
        DialogHideArgs              hide;                   
        DialogKeystrokeArgs         keystroke;              
        DialogMaximizeArgs          maximize;               
        DialogMinimizeArgs          minimize;               
        DialogMotionArgs            motion;                 
        DialogMouseWheelArgs        mouseWheel;             
        DialogRestoredArgs          restored;               
        DialogScreenChangeArgs      screenChange;           
        DialogStateChangedArgs      stateChanged;           
        DialogTitleChangedArgs      titleChanged;           
        DialogUpdateArgs            update;                 
        DialogUserArgs              user;                   
        DialogWindowMovingArgs      windowMoving;           
        } u;
    };

//=======================================================================================
//=======================================================================================
struct DialogHookHandler
{
public:
    MSCORE_EXPORT   DialogHookHandler (MSDialogP dbP);

    MSCORE_EXPORT   virtual ~DialogHookHandler();
    
    MSCORE_EXPORT   MSDialogP    GetDialog();
    
    MSCORE_EXPORT   void         SetUserData (void *data);

    MSCORE_EXPORT   void*        GetUserData ();
    
protected:
    virtual bool _OnCreate           (DialogCreateArgsR          create)             { return false; }
    virtual bool _OnInit             (DialogInitArgsR            init)               { return false; }
    virtual bool _OnBeforeDestroy    (DialogBeforeDestroyArgsR   beforeDestroy)      { return false; }
    virtual bool _OnDestroy          (DialogDestroyArgsR         destroy)            { return false; }

    virtual bool _OnActionButton     (DialogActionButtonArgsR    actionButton)       { return false; }
    virtual bool _OnActivate         (DialogActivateArgsR        activate)           { return false; }
    virtual bool _OnAnotherOpened    (DialogAnotherOpenedArgsR   anotherOpened)      { return false; }
    virtual bool _OnAnotherClosed    (DialogAnotherClosedArgsR   anotherClosed)      { return false; }
    virtual bool _OnAttach           (DialogAttachArgsR          attach)             { return false; }
    virtual bool _OnAutoHideState    (DialogAutoHideStateArgsR   autoHideState)      { return false; }
    virtual bool _OnBeforeUndock     (DialogBeforeUndockArgsR    beforeUndock)       { return false; }
    virtual bool _OnButton           (DialogButtonArgsR          button)             { return false; }
    virtual bool _OnCalcSize         (DialogCalcSizeArgsR        calcSize)           { return false; }
    virtual bool _OnChildDestroyed   (DialogChildDestroyedArgsR  childDestroyed)     { return false; }
    virtual bool _OnCreated          ()                                              { return false; }
    virtual bool _OnDetach           ()                                              { return false; }
    virtual bool _OnDockedExtent     (DialogDockedExtentArgsR    dockedExtent)       { return false; }
    virtual bool _OnDockingState     (DialogDockingStateArgsR    dockingState)       { return false; }
    virtual bool _OnDropTarget       (DialogDropTargetArgsR      dropTarget)         { return false; }
    virtual bool _OnFocusIn          (DialogFocusInArgsR         focusIn)            { return false; }
    virtual bool _OnFocusOut         (DialogFocusOutArgsR        focusOut)           { return false; }
    virtual bool _OnFontChanged      (DialogFontChangedArgsR     fontChanged)        { return false; }
    virtual bool _OnHide             (DialogHideArgsR            hide)               { return false; }
    virtual bool _OnItemFocusIn      (DialogFocusInArgsR         focusIn)            { return false; }
    virtual bool _OnItemFocusOut     (DialogFocusOutArgsR        focusOut)           { return false; }
    virtual bool _OnKeystroke        (DialogKeystrokeArgsR       keystroke)          { return false; }
    virtual bool _OnLayout           ()                                              { return false; }                 
    virtual bool _OnMaximize         (DialogMaximizeArgsR        maximize)           { return false; }
    virtual bool _OnMinimize         (DialogMinimizeArgsR        minimize)           { return false; }
    virtual bool _OnMotion           (DialogMotionArgsR          motion)             { return false; }
    virtual bool _OnMouseWheel       (DialogMouseWheelArgsR      mouseWheel)         { return false; }
    virtual bool _OnPreButton        (DialogButtonArgsR          button)             { return false; }
    virtual bool _OnRestored         (DialogRestoredArgsR        restored)           { return false; }
    virtual bool _OnResize           (DialogResizeArgsR          resize)             { return false; }
    virtual bool _OnScreenChange     (DialogScreenChangeArgsR    screenChange)       { return false; }
    virtual bool _OnStateChanged     (DialogStateChangedArgsR    stateChanged)       { return false; }
    virtual bool _OnSynchronize      ()                                              { return false; }
    virtual bool _OnTitleChanged     (DialogTitleChangedArgsR    titleChanged)       { return false; }
    virtual bool _OnUpdate           (DialogUpdateArgsR          update)             { return false; }
    virtual bool _OnUser             (DialogUserArgsR            user)               { return false; }
    virtual bool _OnWindowMoving     (DialogWindowMovingArgsR    windowMoving)       { return false; }    

    virtual bool _Reserved1 (void *)    { return false; }
    virtual bool _Reserved2 (void *)    { return false; }
    virtual bool _Reserved3 (void *)    { return false; }

    virtual void _EventMonitor       (DialogMessageP             dmP)                {}    

private:
    MSDialogP   m_dbP;                                      
    void*       m_userDataP;                                
    bool        OnDestroy  (DialogDestroyArgsR destroy);

public:
    MSCORE_EXPORT StatusInt  CallHandlerMethod(DialogMessageP dmP);
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Dialog Item Messages                                                |
|                                                                       |
|   Sent to itemHandlers & itemHooks (specified within actual item)     |
|                                                                       |
+----------------------------------------------------------------------*/
/* DialogItemMessageType moved to dlogmsg.r.h */

//=======================================================================================
//=======================================================================================
enum class MessageBoxIconType
    {
    NoSymbol                            = 0,                    
    Information                         = 1,                    
    Question                            = 2,                    
    Warning                             = 3,                    
    Critical                            = 4,                    
    /* Available index #define MSGBOX_ICON_MSBUG_LARGE 5 */     /* MicroStation Bug (Large) */
    BentleyB                            = 6,                    
    Pantone                             = 7,                    
    VBACompatibility                    = 8,                    
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Keep Mouse BitMasks -- used in u.button.couldSetState answers       |
|                                                                       |
+----------------------------------------------------------------------*/
#define BUTTONUPMASK_COULDSETSTATE      0x0001
#define BUTTONUPMASK_KEEPMOUSE          0x0002
#define BUTTONUPMASK_HOOKHANDLED        0x0004
#define BUTTONUPMASK_KEEPMOUSEMOTION    0x0008

#define BUTTONDOWNMASK_KEEPNOLONGER     0x0010

//=======================================================================================
//=======================================================================================
enum class StateChangingType
    {
    ValueChange,
    NodeExpanding,
    NodeCollapsing,
    PopOpen,
    PopClose,
    ColumnShow,
    ColumnHide,
    TabShow,
    TabHide,
    NodeExpanded,
    NodeCollapsed,    
    };

//=======================================================================================
//=======================================================================================
enum class StateChangingCause
    {
    HandleClick,
    DoubleClick,
    Programmatic,
    Keystroke,
    };

//=======================================================================================
//=======================================================================================
enum class StateChangingResponse
    {
    Allow,
    Disallow,
    Cancel,
    };

//=======================================================================================
//=======================================================================================
struct AdjustItem
    {
    DialogItemP                     pDialogItem;
    BSIRectP                        pBufferRect;
    bool                            bEraseItem;
    bool                            bFullRedraw;
    };

//=======================================================================================
//=======================================================================================
enum class EditMenuItemStatus
    {
    Enable                          = 0,
    Disable                         = 1,
    Remove                          = 2
    };

//=======================================================================================
//=======================================================================================
struct EditMenuInfo
    {
    EditMenuItemStatus              undoStatus;
    EditMenuItemStatus              redoStatus;
    EditMenuItemStatus              cutStatus;
    EditMenuItemStatus              copyStatus;
    EditMenuItemStatus              pasteStatus;
    EditMenuItemStatus              deleteStatus;
    EditMenuItemStatus              selectAllStatus;
    EditMenuItemStatus              clearStatus;
    };

//=======================================================================================
// PulldownMenu Dialog Item Structure 
//=======================================================================================
struct DItem_PulldownMenu
    {
    RscType                         type;                   
    RscId                           id;                     
    RawItemHdrP                     rawMenuP;               
    MSDialogP                       ownerDialogP;           
    // The size of this structure cannot change because an instance is the top member of TextPDM_Item

    void Init()
        {
        type = 0;
        id = 0;
        rawMenuP = NULL;
        ownerDialogP = NULL;
        }
    };

//=======================================================================================
//=======================================================================================
struct DialogItemMnemonic
    {
    WChar                           mnemonic;               
    WCharCP                         labelP;                 
    int                             mneIndex;               
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Structures for DialogItemMessage types                              |
|                                                                       |
+----------------------------------------------------------------------*/

//=======================================================================================
//=======================================================================================
struct DialogItemHookResolveArgs
    {
    DialogItemHookHandlerP          hookHandlerP;           
    };

//=======================================================================================
//=======================================================================================
struct DialogItemCreateArgs
    {
    bool                            createFailed;           
    bool                            dontDisplayAlert;       
    void*                           resourceDataP;          
    Sextent*                        itemListExtentP;        
    Utf8CP                          labelP;                 
    CharP                           auxInfoP;                     // CHAR_OK
    UInt64                          itemArg;                
    MdlDescP                        ownerMD;                
    DialogItemP                     parentDiP;              
    RscFileHandle                   childRFileH;            
    RscFileHandle                   rfHandle;               
    };

typedef DialogItemCreateArgs&   DialogItemCreateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemInitArgs
    {
    bool                            initFailed;             
    };                                                      /* sent after initial GetState */

typedef DialogItemInitArgs&   DialogItemInitArgsR;

    
//=======================================================================================
//=======================================================================================
struct DialogItemActivateArgs
    {
    UInt32                          couldSetState;          
    int                             keystroke;              
    int                             rawKeystroke;           
    int                             qualifierMask;          
    bool                            isAccelerator;          
    CommandNumber                   commandNumber;          
    WCharCP                         unparsedP;              
    WCharCP                         commandTaskIdP;         
    };

typedef DialogItemActivateArgs&   DialogItemActivateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemAllCreatedArgs
    {
    bool                            createFailed;           
    void*                           resourceDataP;          
    MdlDescP                        ownerMD;                
    };                               

typedef DialogItemAllCreatedArgs&   DialogItemAllCreatedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemAutoUpdateArgs
    {
    bool                            hookHandled;            
    bool                            outOfRange;             
    bool                            disallow;               
    MSValueDescrP                   currentValueP;          
    MSValueDescrP                   proposedValueP;         
    WCharP                          formatStrP;             
    WCharP                          minStrP;                
    WCharP                          maxStrP;                
    };

typedef DialogItemAutoUpdateArgs&   DialogItemAutoUpdateArgsR;
                                  
//=======================================================================================
//=======================================================================================
struct DialogItemButtonArgs
    {
    UInt32                          couldSetState;          
    MdlMotionFuncP                  motionFunc;             
    MdlDescP                        motionMD;               
    int                             buttonNumber;           
    int                             buttonTrans;            
    int                             qualifierMask;          
    int                             upNumber;               
    bool                            clicked;                
    UInt32                          buttonTime;             
    Point2d                         pt;                     
    Inputq_element*                 iqelP;                  
    bool                            hookHandled;            
    RawItemHdrP                     popupMenuRiP;           
    bool                            setMotionFunc;          
    int                             originalButtonNumber;   
    };

typedef DialogItemButtonArgs&   DialogItemButtonArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemDrawArgs
    {
    bool                            eraseFirst;             
    int                             nRects;                 
    BSIRectP                        rectList;               
    };

typedef DialogItemDrawArgs&   DialogItemDrawArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemDropSourceArgs
    {
    GuiDropSourceMsg                msgType;                
    GuiDataObject*                  pDataObject;            
    bool                            bEscapePressed;         
    UInt32                          dwKeyState;             
    UInt32                          guiDropEffect;          
    GuiDragDropStatus               guiDropStatus;          
    };

typedef DialogItemDropSourceArgs&   DialogItemDropSourceArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemDropTargetArgs
    {
    GuiDropTargetMsg                msgType;                
    GuiDataObject*                  pDataObject;            
    UInt32                          dwKeyState;             
    Point2d                         localPt;                
    UInt32                          guiDropEffect;          
    bool                            wantCursorUpdate;       
    int                             iRow;                   
    int                             iCol;                   
    };

typedef DialogItemDropTargetArgs&   DialogItemDropTargetArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemFocusInArgs
    {
    FocusOutType                    focusOutType;           
    };

typedef DialogItemFocusInArgs&   DialogItemFocusInArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemFocusOutArgs
    {
    bool                            hookHandled;            
    bool                            outOfRange;             
    int                             nextFocusItemIndex;     
    RawItemHdrP                     nextFocusRiP;           
    MSValueDescrP                   msValueDescrP;          
    WCharP                          formatStrP;             
    WCharP                          minStrP;                
    WCharP                          maxStrP;                
    FocusOutType                    focusOutType;           
    int                             moveDirection;          
    bool                            bDestroyAfter;          
    };

typedef DialogItemFocusOutArgs&   DialogItemFocusOutArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemFontChangedArgs
    {
    bool                            hookHandled;            
    int                             newFontHeight;          
    int                             oldFontHeight;          
    };

typedef DialogItemFontChangedArgs&   DialogItemFontChangedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemEditMenuInfoArgs
    {
    DItem_PulldownMenu*             pMenu;                  
    EditMenuInfo*                   pMenuInfo;              
    bool                            bNoDisplay;             
    };

typedef DialogItemEditMenuInfoArgs&   DialogItemEditMenuInfoArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemHideArgs
    {
    int                             reserved;
    };

typedef DialogItemHideArgs&   DialogItemHideArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemHighlightArgs
    {
    bool                            highlightOn;
    };

typedef DialogItemHighlightArgs&   DialogItemHighlightArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemKeystrokeArgs
    {
    bool                            hookHandled;            
    int                             moveDirection;          
    int                             keystroke;              
    int                             rawKeystroke;           
    bool                            isAccelerator;          
    CommandNumber                   commandNumber;          
    WCharCP                         unparsedP;              
    WCharCP                         commandTaskIdP;         
    int                             qualifierMask;          
    Inputq_element*                 iqelP;                  
    int                             cursorIndex;            
    };                                                      /* also for POSTKEYSTROKE msgs */

typedef DialogItemKeystrokeArgs&   DialogItemKeystrokeArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemLayoutArgs
    {
    // BSize minimumSize
    // BSize maximumSize
    // Margins margins
    // SizePolicy sizePolicy
    // LayoutDirection layoutDirection
    };

typedef DialogItemLayoutArgs&   DialogItemLayoutArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemMotionArgs                                         
    {                                                       /* NeutralMotion Events*/
    MotionTransType                 motionTrans;            
    UInt32                          motionTime;             
    Point2d                         newPoint;               
    Point2d                         oldPoint;               
    void                            (*motionFunc)();        
    MdlDescP                        motionMD;               
    RawItemHdrP                     motionRiP;              
    int                             eventCreatedBy;         
    bool                            otherWinPopup;          
    };

typedef DialogItemMotionArgs&   DialogItemMotionArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemMouseWheelArgs                                    
    {
    MouseWheelEventData             eventData;              
    };

typedef DialogItemMouseWheelArgs&   DialogItemMouseWheelArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemMoveArgs
    {
    Point2d                         newPt;                  
    bool                            redraw;                 
    BSIRectCP                       pParentRect;            
    };

typedef DialogItemMoveArgs&   DialogItemMoveArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemNoMotionArgs
    {
    UInt32                          time;                   
    Point2d                         pt;                     
    void                            (*noMotionFunc)();      
    MdlDescP                        noMotionMD;             
    RawItemHdrP                     noMotionRiP;            
    RawItemHdrP                     previousRiP;            
    bool                            showBalloon;            
    bool                            bBalloonTextOverride;   
    };

typedef DialogItemNoMotionArgs&   DialogItemNoMotionArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemObscuredArgs
    {
    bool                            handleChildren;         
    };

typedef DialogItemObscuredArgs&   DialogItemObscuredArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemUnobscuredArgs
    {
    bool                            handleChildren;         
    };

typedef DialogItemUnobscuredArgs&   DialogItemUnobscuredArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemPopupArgs
    {
    bool                            bOpen;                  
    bool                            bGrabMouse;             
    bool                            bUpdate;                
    Point2dCP                       pPopupPt;               
    MSDialog**                      popupDbPP;              
    };

typedef DialogItemPopupArgs&   DialogItemPopupArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemPopupClosedArgs
    {
    int                             reserved;
    };

typedef DialogItemPopupClosedArgs&   DialogItemPopupClosedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemPopupCreatedArgs
    {
    MSDialogP                       popupDbP;
    };

typedef DialogItemPopupCreatedArgs&   DialogItemPopupCreatedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemQueueCommandArgs
    {
    bool                            hookHandled;            
    int                             subItemIndex;           
    CommandNumber                   commandNumber;          
    WCharCP                         commandTaskIdP;         
    };

typedef DialogItemQueueCommandArgs&   DialogItemQueueCommandArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemRedirectArgs
    {
    bool                            hookHandled;            
    bool                            redirectAllowed;        
    int                             keystroke;              
    int                             rawKeystroke;           
    int                             qualifierMask;          
    Inputq_element*                 iqelP;                  
    CommandNumber                   commandNumber;          
    WCharCP                         unparsedP;              
    WCharCP                         commandTaskIdP;         
    };

typedef DialogItemRedirectArgs&   DialogItemRedirectArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemReloadDataArgs
    {
    bool                            redraw;                 
    };

typedef DialogItemReloadDataArgs&   DialogItemReloadDataArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemScreenChangeArgs
    {                                                       
    int                             oldScreenNum;           
    BSIRect                         oldSizeRect;            
    int                             newScreenNum;           
    BSIRect                         newSizeRect;            
    bool                            before;                 
    bool                            hookHandled;            
    bool                            disallow;               
    };

typedef DialogItemScreenChangeArgs&   DialogItemScreenChangeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemScrollingArgs
    {
    int                             topRow;                 
    int                             oldTopRow;              
    int                             bottomRow;              
    int                             oldBottomRow;           
    };

typedef DialogItemScrollingArgs&   DialogItemScrollingArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemSetEnabledStateArgs
    {
    bool                            enabled;                
    };

typedef DialogItemSetEnabledStateArgs&   DialogItemSetEnabledStateArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemSetExtentArgs
    {
    /* used as if resource extent was respecified (except in pixels)*/
    Sextent                         sextent;                
    bool                            redraw;                 
    };

typedef DialogItemSetExtentArgs&   DialogItemSetExtentArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemSetLabelArgs
    {
    WCharCP                         newLabelP;              
    };

typedef DialogItemSetLabelArgs&   DialogItemSetLabelArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemSetNamedItemArgs
    {
    WCharCP                         pStrValue;              
    bool                            valueChanged;           
    };

typedef DialogItemSetNamedItemArgs&   DialogItemSetNamedItemArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemStateChangingArgs
    {
    StateChangingResponse           response;               
    StateChangingType               changeType;             
    StateChangingCause              cause;                  
    /* Text item */
    MSValueDescrP                   currentValueP;          
    MSValueDescrP                   proposedValueP;         
    /* ListBox / Tree item */    
    int                             row;                    
    int                             column;                 
    /* TabPage item */
    int                             tabIndex;               
    };

typedef DialogItemStateChangingArgs&   DialogItemStateChangingArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemSynchronizeArgs
    {
    bool                            redrawn;                
    };

typedef DialogItemSynchronizeArgs&   DialogItemSynchronizeArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemStateChangedArgs
    {
    bool                            reallyChanged;          
    };

typedef DialogItemStateChangedArgs&   DialogItemStateChangedArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemUserArgs
    {
    int                             type;                   
    void*                           userDataP;              
    };

typedef DialogItemUserArgs&   DialogItemUserArgsR;
    
//=======================================================================================
//=======================================================================================
struct DialogItemValueArgs                                  /* used by GETSTATE, SETSTATE, GETVALUE, SETVALUE, JOURNALSTATE */
    {
    bool                            hookHandled;            
    MSValueDescrP                   msValueDescrP;          
    CharP                           accessStrP;                    // CHAR_OK

    // GET messages
    WCharCP                         formatStrP;             
    // SET messages
    bool                            valueChanged;           
    bool                            cancelled;              
    };
    
//=======================================================================================
//=======================================================================================
struct DialogItemWindowMovingArgs
    {                                           
    int                             whichCorners;           
    BSIRect                         oldGlobal;              
    BSIRect                         oldContent;             
    int                             newWidth;               
    int                             newHeight;              
    byte                            percentDone;            
    byte                            handled;                
    };

typedef DialogItemWindowMovingArgs&   DialogItemWindowMovingArgsR;

/*-----------------------------------------------------------------------
  The following DialogMessageItemType types have no C++ methods.
+-----------------------------------------------------------------------*/  
    
//=======================================================================================
//=======================================================================================
struct DialogItemChildDrawBgArgs
    {
    RawItemHdrP                     childRiP;               
    BSIRectCP                       rectP;                  
    BSIColorDescrCP                 bgColorP;               
    };
    
//=======================================================================================
//=======================================================================================
struct DialogItemCleanUpArgs
    {
    MSDialogP                       ownerDialogP;
    };
    
//=======================================================================================
//=======================================================================================
struct DialogItemShowHelpArgs
    {
    bool                            hookHandled;            
    };
    
//=======================================================================================
//=======================================================================================
struct DialogItemHandlerLoadedArgs
    {
    DialogItemHandlerInfo*          itemHandlerP;           
    };                            
    
//=======================================================================================
//=======================================================================================
struct DialogItemGetMnemonicsArgs
    {
    DialogItemMnemonic*             mnemonicsP;             
    int                             nMnemonics;             
    int                             maxNMnemonics;          
    bool                            allLabels;              
    };
    
//=======================================================================================
//=======================================================================================
struct DialogItemLinkLabelArgs
    {
    bool                            linkFailed;             
    RawItemHdrP                     labelRiP;               
    bool                            linkMin;                
    bool                            linkMax;                
    };

//=======================================================================================
//=======================================================================================
struct DialogItemDropArgs
    {                                           
    bool                            hookHandled;            
    RawItemHdrP                     rawItemP;               
    int                             startRow;               
    int                             startCol;               
    Point2d                         upPt;                   
    void*                           itemDataP;              
    };

//=======================================================================================
//=======================================================================================
struct DialogItemStartDragArgs
    {                                           
    bool                            hookHandled;            
    RawItemHdrP                     rawItemP;               
    int                             startRow;               
    int                             startCol;               
    Point2d                         downPt;                 
    void*                           itemDataP;              
    };

/*-----------------------------------------------------------------------
  The following DialogMessageItemType types have no arguments:

    DITEM_MESSAGE_DESTROY           
    DITEM_MESSAGE_POSTDRAW                  Notification only from ColorPicker and IconPopup 
    DITEM_MESSAGE_POPUPWINDOW               Sent to IconPopup item hook when using RTYPE_PopupWindow, 0 for .NET apps 
    DITEM_MESSAGE_HANDLERUNLOADED   
    DITEM_MESSAGE_PREDESTROY   
    DITEM_MESSAGE_ATTACH                  
    DITEM_MESSAGE_DIALOGHIDE                Parent dialog is about to be hidden 
    DITEM_MESSAGE_DIALOGSHOW                Parent dialog has just been shown 
    DITEM_MESSAGE_CHILDRENLOADED            Sent after children of Tab and Container items have been loaded
+-----------------------------------------------------------------------*/  

//=======================================================================================
//=======================================================================================
struct DialogItemMessage
    {
    bool                            msgUnderstood;          
    int                             messageType;            
                                                            /*    Cannot use DialogItemMessageType data type here because of AuxMessages */
    MSDialogP                       db;                     
    RscId                           dialogId;               
    int                             itemIndex;              
    DialogItemP                     dialogItemP;            
    int                             auxMessageType;         
    void*                           auxInfoP;               
    union
        {                                                   /* Arguments for DialogItemMessageType: */
        DialogItemHookResolveArgs   hookResolve;            
        DialogItemCreateArgs        create;                 
        DialogItemInitArgs          init;                   
        DialogItemAllCreatedArgs    allCreated;             
        DialogItemActivateArgs      activate;               
        DialogItemAutoUpdateArgs    autoUpdate;             
        DialogItemButtonArgs        button;                 
        DialogItemDrawArgs          draw;                   
        DialogItemDropSourceArgs    dropSource;             
        DialogItemDropTargetArgs    dropTarget;             
        DialogItemEditMenuInfoArgs  getEditMenuInfo;        
        DialogItemFocusInArgs       focusIn;                
        DialogItemFocusOutArgs      focusOut;               
        DialogItemFontChangedArgs   fontChanged;            
        DialogItemHideArgs          hide;                   
        DialogItemHighlightArgs     highlight;              
        DialogItemKeystrokeArgs     keystroke;              
        DialogItemLayoutArgs        layout;                 
        DialogItemMotionArgs        motion;                 
        DialogItemMouseWheelArgs    mouseWheel;             
        DialogItemMoveArgs          move;                   
        DialogItemNoMotionArgs      noMotion;               
        DialogItemObscuredArgs      obscured;               
        DialogItemPopupArgs         popup;                  
        DialogItemPopupClosedArgs   popupClosed;            
        DialogItemPopupCreatedArgs  popupCreated;           
        DialogItemQueueCommandArgs  queueCommand;           
        DialogItemRedirectArgs      keystrokeRedirect;      
        DialogItemReloadDataArgs    reloadData;             
        DialogItemScreenChangeArgs  screenChange;           
        DialogItemScrollingArgs     scrolling;              
        DialogItemSetEnabledStateArgs  setEnabledState;     
        DialogItemSetExtentArgs     setExtent;              
        DialogItemSetLabelArgs      setLabel;               
        DialogItemSetNamedItemArgs  setNamedItem;           
        DialogItemStateChangedArgs  stateChanged;           
        DialogItemStateChangingArgs stateChanging;          
        DialogItemSynchronizeArgs   synchronize;            
        DialogItemUnobscuredArgs    unobscured;             
        DialogItemUserArgs          user;                   
        DialogItemWindowMovingArgs  windowMoving;           
        DialogItemValueArgs         value;                  
        // Internal only        
        DialogItemChildDrawBgArgs   childDrawBg;            
        DialogItemCleanUpArgs       cleanUp;                
        DialogItemGetMnemonicsArgs  getMnemonics;           
        DialogItemHandlerLoadedArgs handlerLoaded;          
        DialogItemShowHelpArgs      showHelp;               
        DialogItemLinkLabelArgs     linkLabel;              
        // Obsolete - do not use
        DialogItemDropArgs          drop;                   
        DialogItemStartDragArgs     startDrag;              
        } u;
    };


//=======================================================================================
//=======================================================================================
struct DialogItemGetStateArgs                               
    {
    bool                            hookHandled;            
    MSValueDescrR                   msValueDescr;           
    CharCP                          accessStrP;                    // CHAR_OK
    WCharCP                         formatStrP;             
    DialogItemGetStateArgs (MSValueDescrR descr) :
        msValueDescr (descr), hookHandled(false), accessStrP(NULL), formatStrP(NULL) 
        {}
    };

typedef DialogItemGetStateArgs&   DialogItemGetStateArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemGetValueArgs                               
    {
    MSValueDescrR                   msValueDescr;           
    CharCP                          accessStrP;                    // CHAR_OK
    
    DialogItemGetValueArgs (MSValueDescrR descr) :
        msValueDescr (descr), accessStrP(NULL) 
        {}
    };

typedef DialogItemGetValueArgs&   DialogItemGetValueArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemSetStateArgs                               
    {
    bool                            hookHandled;            
    MSValueDescrCR                  msValueDescr;           
    CharCP                          accessStrP;                    // CHAR_OK
    WCharCP                         formatStrP;             
    bool                            valueChanged;           
    bool                            cancelled;              
    DialogItemSetStateArgs (MSValueDescrCR descr) :
        msValueDescr (descr), hookHandled(false), accessStrP(NULL), formatStrP(NULL), valueChanged(false), cancelled(false)
        {}
    };

typedef DialogItemSetStateArgs&   DialogItemSetStateArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemSetValueArgs                               
    {
    MSValueDescrCR                  msValueDescr;           
    CharCP                          accessStrP;                    // CHAR_OK
    bool                            valueChanged;           
    DialogItemSetValueArgs (MSValueDescrCR descr) :
        msValueDescr (descr), accessStrP(NULL), valueChanged(false)
        {}
    };

typedef DialogItemSetValueArgs&   DialogItemSetValueArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemJournalStateArgs                               
    {
    bool                            hookHandled;            
    MSValueDescrCR                  msValueDescr;           
    CharCP                          accessStrP;                    // CHAR_OK
    WCharCP                         formatStrP;             
    DialogItemJournalStateArgs (MSValueDescrCR descr) :
        msValueDescr (descr), hookHandled(false), accessStrP(NULL), formatStrP(NULL)
        {}
    };

typedef DialogItemJournalStateArgs&   DialogItemJournalStateArgsR;

//=======================================================================================
//=======================================================================================
struct DialogItemHookHandler
{
public:    
    MSCORE_EXPORT   DialogItemHookHandler (MSDialogP dbP, DialogItemP diP);

    MSCORE_EXPORT   virtual ~DialogItemHookHandler();

    //@remark Required Library : mdlbltin.lib
    MSCORE_EXPORT   MSDialogP       GetDialog();

    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   DialogItemP     GetDialogItem();

    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   int             GetItemIndex();

    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   RscId           GetItemId();

    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   RawItemHdrP     GetRawItem();
    
    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   void            SetAuxInfo (void *data);
    
    //@remark Required Library: mdlbltin.lib
    MSCORE_EXPORT   void*           GetAuxInfo ();

protected:
    virtual bool _OnCreate          (DialogItemCreateArgsR              create)             { return false; }
    virtual bool _OnInit            (DialogItemInitArgsR                init)               { return false; }                   
    virtual bool _OnAllCreated      (DialogItemAllCreatedArgsR          allCreated)         { return false; }             
    virtual bool _OnDestroy         ()                                                      { return false; }                   
    
    virtual bool _OnActivate        (DialogItemActivateArgsR            activate)           { return false; }               
    virtual bool _OnAttach          ()                                                      { return false; }               
    virtual bool _OnAutoUpdate      (DialogItemAutoUpdateArgsR          autoUpdate)         { return false; }               
    virtual bool _OnButton          (DialogItemButtonArgsR              button)             { return false; }                 
    virtual bool _OnChildrenLoaded  ()                                                      { return false; }               
    virtual bool _OnDraw            (DialogItemDrawArgsR                draw)               { return false; }                   
    virtual bool _OnDialogHide      ()                                                      { return false; }               
    virtual bool _OnDialogShow      ()                                                      { return false; }               
    virtual bool _OnDropSource      (DialogItemDropSourceArgsR          dropSource)         { return false; }             
    virtual bool _OnDropTarget      (DialogItemDropTargetArgsR          dropTarget)         { return false; }             
    virtual bool _OnGetEditMenuInfo (DialogItemEditMenuInfoArgsR        getEditMenuInfo)    { return false; }        
    virtual bool _OnFocusIn         (DialogItemFocusInArgsR             focusIn)            { return false; }                
    virtual bool _OnFocusOut        (DialogItemFocusOutArgsR            focusOut)           { return false; }               
    virtual bool _OnFontChanged     (DialogItemFontChangedArgsR         fontChanged)        { return false; }            
    virtual bool _OnGetState        (DialogItemGetStateArgsR            getState)           { return false; }                  
    virtual bool _OnGetValue        (DialogItemGetValueArgsR            getValue)           { return false; }                  
    virtual bool _OnHide            (DialogItemHideArgsR                hide)               { return false; }                   
    virtual bool _OnHighlight       (DialogItemHighlightArgsR           highlight)          { return false; }              
    virtual bool _OnJournalState    (DialogItemJournalStateArgsR        journalState)       { return false; }                  
    virtual bool _OnKeystroke       (DialogItemKeystrokeArgsR           keystroke)          { return false; }              
    virtual bool _OnLayout          (DialogItemLayoutArgsR              layout)             { return false; }                 
    virtual bool _OnMotion          (DialogItemMotionArgsR              motion)             { return false; }                 
    virtual bool _OnMouseWheel      (DialogItemMouseWheelArgsR          mouseWheel)         { return false; }             
    virtual bool _OnMove            (DialogItemMoveArgsR                move)               { return false; }                   
    virtual bool _OnNoMotion        (DialogItemNoMotionArgsR            noMotion)           { return false; }               
    virtual bool _OnObscured        (DialogItemObscuredArgsR            obscured)           { return false; }               
    virtual bool _OnPopup           (DialogItemPopupArgsR               popup)              { return false; }                  
    virtual bool _OnPopupClosed     (DialogItemPopupClosedArgsR         popupClosed)        { return false; }            
    virtual bool _OnPopupCreated    (DialogItemPopupCreatedArgsR        popupCreated)       { return false; }           
    virtual bool _OnPostKeystroke   (DialogItemKeystrokeArgsR           keystroke)          { return false; }              
    virtual bool _OnPostSetExtent   (DialogItemSetExtentArgsR           setExtent)          { return false; }              
    virtual bool _OnQueueCommand    (DialogItemQueueCommandArgsR        queueCommand)       { return false; }           
    virtual bool _OnRedirect        (DialogItemRedirectArgsR            keystrokeRedirect)  { return false; }      
    virtual bool _OnResetPreButton  (DialogItemButtonArgsR              button)             { return false; }                 
    virtual bool _OnReloadData      (DialogItemReloadDataArgsR          reloadData)         { return false; }             
    virtual bool _OnScreenChange    (DialogItemScreenChangeArgsR        screenChange)       { return false; }           
    virtual bool _OnScrolling       (DialogItemScrollingArgsR           scrolling)          { return false; }              
    virtual bool _OnSetEnabledState (DialogItemSetEnabledStateArgsR     setEnabledState)    { return false; }     
    virtual bool _OnSetExtent       (DialogItemSetExtentArgsR           setExtent)          { return false; }              
    virtual bool _OnSetLabel        (DialogItemSetLabelArgsR            setLabel)           { return false; }               
    virtual bool _OnSetNamedItem    (DialogItemSetNamedItemArgsR        setNamedItem)       { return false; }           
    virtual bool _OnSetState        (DialogItemSetStateArgsR            setState)           { return false; }                  
    virtual bool _OnSetValue        (DialogItemSetValueArgsR            setValue)           { return false; }                  
    virtual bool _OnStateChanged    (DialogItemStateChangedArgsR        stateChanged)       { return false; }           
    virtual bool _OnStateChanging   (DialogItemStateChangingArgsR       stateChanging)      { return false; }          
    virtual bool _OnSynchronize     (DialogItemSynchronizeArgsR         synchronize)        { return false; }            
    virtual bool _OnUnobscured      (DialogItemUnobscuredArgsR          unobscured)         { return false; }             
    virtual bool _OnUser            (DialogItemUserArgsR                user)               { return false; }                   
    virtual bool _OnWindowMoving    (DialogItemWindowMovingArgsR        windowMoving)       { return false; }           

    virtual bool _Reserved1 (void *)    { return false; }
    virtual bool _Reserved2 (void *)    { return false; }
    virtual bool _Reserved3 (void *)    { return false; }

    virtual void _EventMonitor      (DialogItemMessageP                 dimP)               {}    

private:
    MSDialogP                       m_dbP;              
    DialogItemP                     m_diP;              
    void*                           m_auxInfoP;         
    bool                            OnDestroy ();

public:
    MSCORE_EXPORT StatusInt  CallHandlerMethod(DialogItemMessageP dimP);
    };

//=======================================================================================
//=======================================================================================
struct DialogHookInfo
    {
    long                            hookId;             
    PFDialogHook                    dialogHookFunction; 
    };

//=======================================================================================
//=======================================================================================
enum class ViewIconSize
    {
    Small                           = 0,
    Medium                          = 1,
    Large                           = 2
    };

//=======================================================================================
//=======================================================================================
enum class IconCmdSelectType
    {
    UseLast                         = -1,
    Off                             = 0,
    SingleShot                      = 1,
    Locked                          = 2,
    On                              = Locked,
    Disabled                        = 3   
    };

//=======================================================================================
//=======================================================================================
#define LISTCELLATTR_HIGHLIGHT      0x01                
#define LISTCELLATTR_DISABLED       0x02                
//=======================================================================================
//=======================================================================================
#define DISTATUS_NEEDVERTSCROLLBAR              0x00000001
#define DISTATUS_NEEDHORIZSCROLLBAR             0x00000002

//=======================================================================================
//=======================================================================================
#define HEADER_ROW_INDEX                        -2
#define FILTER_ROW_INDEX                        -3

//=======================================================================================
//=======================================================================================
#define COLORPICKER_AUXMESSAGE_SETCOLORTABLE    1

struct ColorPicker_SetColorTable
    {
    RgbColorDef   *colorTableP;                         
    };

//=======================================================================================
//=======================================================================================
struct DItem_PulldownMenuItem
    {
    long                            searchId;
    RawItemHdrP                     rawItemP;
    DItem_PulldownMenu*             menuP;         /* set by pdmlib.cpp */

    void Init ()
        {
        searchId = 0;
        rawItemP = NULL;
        menuP = NULL;
        }
    };

//=======================================================================================
//=======================================================================================
struct TextPDM_Item         
    {
    DItem_PulldownMenu              submenu;

    byte                            enabled;
    byte                            mark;
    UInt32                          helpInfo;
    UInt32                          helpType;
    WCharCP                         helpTaskIdP;
    long                            pulldownItemHookId;
    long                            pulldownSearchId;
    CommandNumber                   commandNumber;
    WCharCP                         commandTaskIdP;
    WCharCP                         unparsedP;

    WCharCP                         labelP;
    UInt32                          accelerator;
    int                             mnemonic;
    int                             mneIndex;

    WCharCP                         extendedLabelP;
    int                             iMaxChars;

    UICriteriaP                     enableDisableCriteriaP;
    UICriteriaP                     showHideCriteriaP;
    UICriteriaP                     showMarkCriteriaP;
    };

//=======================================================================================
//=======================================================================================
struct TextPDM_ItemModify
    {
    UInt32                          submenu:1;

    UInt32                          enabled:1;
    UInt32                          mark:1;
    UInt32                          helpInfo:1;
    UInt32                          helpType:1;
    UInt32                          helpTaskIdP:1;
    UInt32                          pulldownItemHookId:1;
    UInt32                          pulldownSearchId:1;
    UInt32                          commandNumber:1;
    UInt32                          commandTaskIdP:1;
    UInt32                          unparsedP:1;

    UInt32                          labelP:1;
    UInt32                          acceleratorP:1;
    UInt32                          mnemonic:1;
    UInt32                          mneIndex:1;
    UInt32                          extendedLabelP:1;

    UInt32                          enableDisableCriteriaP:1;
    UInt32                          showHideCriteriaP:1;
    UInt32                          showMarkCriteriaP:1;
    UInt32                          unused:13;
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Pulldown Menu Messages                                              |
|                                                                       |
+----------------------------------------------------------------------*/
#define PDMENU_MESSAGE_ACTIVATEITEM     216

//=======================================================================================
//=======================================================================================
struct PulldownTrackingInfo                             /* sent to pulldown motion func */
    {
    int *                           currentItemP;       
    void*                           rawMenuP;           
    Point2d                         pt;                 
    } ;

//=======================================================================================
//=======================================================================================
struct PulldownMenuMessage
    {
    bool                            msgUnderstood;      
    int                             messageType;        
    DItem_PulldownMenu*             menuP;
    union
        {
        struct
            {
            bool                    loadFailed;         
            void*                   rawMenuP;           
            MSDialogP               db;                 
            MdlDescP                ownerMD;            
            DItem_PulldownMenu*     parentMenuP;        
            int                     parentItemIndex;    
            RawItemHdrP             mbarP;              
            } load;
        struct
            {
            BSIRectP                rectP;
            } rect;
        struct
            {
            int                     mneIndex;           
            bool                    alignRight;         
            bool                    enabled;            
            WCharCP                 titleP;             
            int                     mnemonic;           
            } title;
        struct
            {
            bool                    enabled;            
            } setEnabled;
        struct
            {
            RawItemHdrP             mbarP;              
            } display;
        struct
            {
            void                    (*motionFunc)(PulldownTrackingInfo *);    
            MSDialogP               pulldownDb;         
            } pulldown;
        struct
            {
            int                     itemIndex;          
            bool                    hasSubmenu;         
            Point2dP                ptP;                
            bool                    enabled;            
            } whichItem;
        struct
            {
            int                     itemIndex;          
            bool                    highlightOn;        
            } highlightItem;
        struct
            {
            DItem_PulldownMenu*     submenuP;           
            int                     itemIndex;          
            } getSubmenu;
        struct
            {
            int                     screen;             
            BSIRectP                rectP;              
            int                     itemIndex;          
            } getSubmenuRect;
        struct
            {
            long                    searchId;           
            int                     itemIndex;          
            } getItemSearchId;
        struct
            {
            int                     itemIndex;          
            long                    searchId;           
            DialogItemMessage*      dimP;               
            } activateItem;

        struct
            {
            DItem_PulldownMenu *    menuP;              
            RscType                 menuType;           
            RscId                   menuId;             
            } searchMenuForMenu;
        struct
            {
            DItem_PulldownMenuItem *menuItemP;          
            long                    searchId;           
            } searchMenuForId;
        struct
            {
            DItem_PulldownMenuItem *menuItemP;          
            CommandNumber           cmdNum;             
            } searchMenuForCmdNum;
        struct
            {
            DItem_PulldownMenuItem *menuItemP;          
            int                     subItemIndex;       
            } getItem;
        struct
            {
            int                     nItems;             
            } getNItems;
        struct
            {
            DItem_PulldownMenuItem  *menuItemP;         
            } deleteItem;

        struct
            {
            void                    *itemInfoP;         // unfortunately this really does point at different types, so we use void*.
            void                    *itemModifyP;
            DItem_PulldownMenuItem  *menuItemP;         
            DItem_PulldownMenuItem  *newMenuItemP;      
            MdlDesc                 *ownerMD;           
            } itemInfo;
        struct
            {
            int                     itemIndex;          
            } displayHelp;
        struct
            {
            DItem_PulldownMenuItem  *menuItemP;         
            int                     itemIndex;          
            long                    searchId;           
            DialogItemMessage*      dimP;               
            } activateAccel;
        struct
            {
            WCharP                  labelP;             
            int                     iMaxChars;          
            DItem_PulldownMenuItem* menuItemP;          
            } getItemLabel;
        struct
            {
            DItem_PulldownMenu*     parentMenuP;        
            } getParent;
        struct
            {
            DItem_PulldownMenuItem* menuItemP;
            void*                   userDataP;
            } userDataP;
        struct
            {
            MSDialogP               db;
            } attachDb;
        struct
            {
            bool                    highlightAllowed;   
            int                     itemIndex;          
            } checkHighlight;
        struct
            {
            int                     itemIndex;          
            long                    mnemonic;           
            int                     startItemIndex;     
            int                     scanCode;           
            } searchMenuForMnemonic;                    
        struct
            {
            DialogItemMnemonic*     mnemonicsP;         
            int                     nMnemonics;         
            int                     maxNMnemonics;      
            bool                    allLabels;          
            } getMnemonics;                             
        struct
            {
            MdlDescP                ownerMD;            
            } getOwnerMD;
        struct
            {
            DItem_PulldownMenuItem* menuItemP;          
            long                    accelerator;        
            } searchMenuForAccel;
        struct
            {
            DItem_PulldownMenuItem* menuItemP;
            RscType*                iconTypeP;
            RscId*                  iconIdP;
            MdlDescP*               iconOwnerMDP;
            WCharCP                 iconNameP;
            Point2dP                sizeP;
            bool                    pressed;
            } iconInfo;
        struct
            {
            int                     itemIndex;          
            bool                    bDisplay;           
            } showExtendedLabel;
        struct
            {
            int                     offScreen;          
            int                     popupHeight;        
            } setOffscreenHeight;
        struct
            {
            int                     itemIndex;          
            } scroll;
        } u;
    };

//=======================================================================================
//=======================================================================================
struct Sash_ButtonUpAuxInfo
    {
    int                             oldYPos;            /* of itemRect.origin.y */
    int                             newYPos;
    int                             oldXPos;            /* of itemRect.origin.x when vertical sash */
    int                             newXPos;
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Scale Item Auxiliary Messages                                       |
|                                                                       |
+----------------------------------------------------------------------*/
#define SCALE_AUXMESSAGE_FORMATVALUE            50

//=======================================================================================
//=======================================================================================
struct Scale_FormatValue
    {
    bool                            hookHandled;        
    WCharP                          valueStrP;          
    double                          value;              
    };

//=======================================================================================
//=======================================================================================
struct Scale_MotionFuncArg
    {
    double                          value;              
    BSIRect                         sliderRect;         
    };


/* Tree Item, Cell, Node support */
#define TREECELLATTR_HIGHLIGHT      0x00000001          /* cell is highlighted */
#define TREECELLATTR_DISABLED       0x00000002          /* cell is unselectable */

#define TREENODEATTR_ALLOWSCHILDREN 0x00000010          /* node allows children below */
#define TREENODEATTR_EXPANDED       0x00000020          /* parent node is expanded */
#define TREENODEATTR_DISPLAYABLE    0x00000040          /* node is displayable */

//=======================================================================================
//=======================================================================================
enum class TextAutoUpdateSpeed
    {
    Faster,
    Fast,
    Medium,
    Slow,
    Slower
    };

//=======================================================================================
//=======================================================================================
enum class TreeNodePortion
    {
    None = 0,
    CellEditor,
    VerticalScrollBar,
    HorizontalScrollBar,
    ExpansionHandle,
    ColumnHeading,
    Data,
    HookHandled,
    };

//=======================================================================================
//=======================================================================================
struct CompletionBarInfo
    {
    long                            percentComplete;
    WCharCP                         msgTextW;
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   Track Bar Processing Specific Defines and Structures                |
|                                                                       |
+----------------------------------------------------------------------*/
#define UPDATE_Percent1             1
#define UPDATE_Percent2             2
#define UPDATE_Msg1                 4
#define UPDATE_Msg2                 8
#define UPDATE_All                  15

//=======================================================================================
//=======================================================================================
struct TrackBarInfo
    {
    int                             update;
    long                            percentComplete1;
    long                            percentComplete2;
    WChar                           msgText1[256];
    WChar                           msgText2[256];
    };

/*----------------------------------------------------------------------+
|                                                                       |
|   DITEM_MESSAGE_USER message types                                    |
|                                                                       |
+----------------------------------------------------------------------*/
#define USERMSG_BYLEVELBTN_SETLEVEL     0     /* Used with PUSHBUTTONID_ColorByLevel to set the level for the ByLevel color */

/*----------------------------------------------------------------------+
|                                                                       |
|   Popup Padding Constants                                             |
|                                                                       |
+----------------------------------------------------------------------*/
#define MANAGED_POPUP_WINDOW_PADDING    2   /* Additional padding used when hosting .Net forms as popups to help with auto-hide detection. */

//=======================================================================================
//=======================================================================================
enum class NativeContentType
    {
    None        = 0,
    MFC         = 1,
    WinForms    = 2,
    WPF         = 3
    };