DialogItem.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

typedef struct RawItemHdr RawItemHdr;

//=======================================================================================
//=======================================================================================
struct DialogItemAttributes
    {
    UInt32                      acceptsKeystrokes:1;
    UInt32                      mouseSensitive:1;
    UInt32                      traversable:1;          
    UInt32                      canHaveSynonyms:1;
    UInt32                      enabled:1;
    UInt32                      hidden:1;
    UInt32                      hasFocus:1;
    UInt32                      updateFlag:1;           
    UInt32                      xPosLocked:1;           
    UInt32                      yPosLocked:1;           
    UInt32                      containsIconCommand:1;  
    UInt32                      containsChildItems:1;   
    UInt32                      obscured:1;             
    UInt32                      created:1;              
    UInt32                      unused:2;

    UInt32                      unused2:8;
    UInt32                      unused3:8;
    };

//=======================================================================================
//=======================================================================================
struct DialogItem
    {
    /*----------------------------------------------------------------------------------+
    |   Data members
    +----------------------------------------------------------------------------------*/
    RscType                     type;                   
    RscId                       id;                     
    int                         itemIndex;              
    UInt64                      itemArg;                
    BSIRect                     rect;                   
    Sextent                     extent;                 
    Point2d                     origin;                 
    DialogItemAttributes        attributes;             
    RawItemHdr*                 rawItemP;               
    DialogItem*                 parentDiP;              
    
    /*----------------------------------------------------------------------------------+
    |   Data member / property accessors
    +----------------------------------------------------------------------------------*/
    MSCORE_EXPORT DialogItemAttributes const& GetAttributes () const;
    
    MSCORE_EXPORT RscId                       GetId () const;
    
    MSCORE_EXPORT int                         GetItemIndex () const;
    
    MSCORE_EXPORT MSDialogP                   GetDialog () const;
    
    MSCORE_EXPORT RawItemHdrP                 GetRawItem () const;
    
    MSCORE_EXPORT BSIRect const&              GetRect () const;
    
    MSCORE_EXPORT RscType                     GetType () const;
    
    /*----------------------------------------------------------------------------------+
    |   Status retrieval methods
    +----------------------------------------------------------------------------------*/
    MSCORE_EXPORT bool                        HasFocus () const;

    MSCORE_EXPORT bool                        IsEnabled () const;

    MSCORE_EXPORT bool                        IsFocusable ();

    MSCORE_EXPORT bool                        IsDisplayable ();

    MSCORE_EXPORT bool                        IsHidden ();

    /*----------------------------------------------------------------------------------+
    |   Item processing methods
    +----------------------------------------------------------------------------------*/
    MSCORE_EXPORT StatusInt                   Draw (bool eraseFirst=true);

    MSCORE_EXPORT BSIColorDescr const *       GetColor (ItemColorType colorType);

    MSCORE_EXPORT StatusInt                   GetLabel (WStringR label);

    MSCORE_EXPORT int                         GetLabelLength ();
    
    MSCORE_EXPORT int                         GetLabelWidth (int fontIndex);
    
    MSCORE_EXPORT GuiLayoutControlP           GetLayoutControl ();

    MSCORE_EXPORT GuiLayoutPropertiesP        GetLayoutProperties ();

    MSCORE_EXPORT DialogItemP                 GetNext (bool includeLayoutItems = false);

    MSCORE_EXPORT DialogItemP                 GetNextVisible (bool inclusive = false);

    MSCORE_EXPORT DialogItemP                 GetOwnerItem ();

    MSCORE_EXPORT StatusInt                   GetPopupMenuText (WStringR text);

    MSCORE_EXPORT DialogItemP                 GetPrev (bool includeLayoutItems = false);

    //  possibly filtered through a mask associated with the item.
    //  The MSValueDescr struct provides methods to query the type of data and methods to get the data.
    MSCORE_EXPORT StatusInt                   GetState (MSValueDescrR state);
    
    //  appearance when the item is drawn.
    //  The MSValueDescr struct provides methods to query the type of data and methods to get the data.
    MSCORE_EXPORT StatusInt                   GetValue (MSValueDescrR value);

    //  appearance when the item is drawn.
    MSCORE_EXPORT StatusInt                   GetValue (WStringR value);
    
    //   out errors (such as the current value being out of range) that may occur if
    //   the item to be hidden has the keyboard focus. It should usually be set to
    //   false which indicates that focus out errors should not be ignored. Defaults to false.
    MSCORE_EXPORT StatusInt                   Hide (bool ignoreFocusOutErrors = false);

    MSCORE_EXPORT StatusInt                   Move (Point2dP newPtP, bool redraw = true);

    MSCORE_EXPORT StatusInt                   Obscure ();

    MSCORE_EXPORT StatusInt                   PopupClose (bool update);

    //  set the bGrabMouse to true.
    MSCORE_EXPORT StatusInt                   PopupOpen (bool bGrabMouse, Point2dP pPopupPt, MSDialogP *popupDbPP);

    //  reloading the item information.  Defaults to true.
    MSCORE_EXPORT StatusInt                   ReloadData (bool redraw=true);

    MSCORE_EXPORT StatusInt                   SetBalloonText (WCharCP text, bool bSetPopupText=true);

    MSCORE_EXPORT StatusInt                   SetColor (ItemColorType colorType, BSIColorDescr *colorP);

    MSCORE_EXPORT StatusInt                   SetDisabledBalloonText (WCharCP text);

    //   out errors (such as the current value being out of range) that may occur if
    //   the item to be disabled has the keyboard focus. It should usually be set to
    //   false which indicates that focus out errors should not be ignored. Defaults to false.
    MSCORE_EXPORT StatusInt                   SetEnabled (bool enabled, bool ignoreFocusOutErrors = false);

    MSCORE_EXPORT StatusInt                   SetExtent (SextentCP sextent, bool redraw=true);

    MSCORE_EXPORT StatusInt                   SetFlyoverText (WCharCP text);

    MSCORE_EXPORT StatusInt                   SetLabel (WCharCP pwString);

    MSCORE_EXPORT StatusInt                   SetLabelFont (int fontIndex);

    MSCORE_EXPORT StatusInt                   SetPopupMenuText (WCharCP text);
    
    //  This is the opposite behavior of Synchronize(), which forces the appearance 
    //  and internal value of an item to match its external state.
    //    true if the item's internal value was different than its external state.
    MSCORE_EXPORT StatusInt                   SetState (bool* stateChangedP, bool synchOthers = true);
    
    //   true if the new value is different than the item's old internal value.
    MSCORE_EXPORT StatusInt                   SetValue (bool* valueChangedP, MSValueDescrCR newValue);

    //   true if the new value is different than the item's old internal value.
    MSCORE_EXPORT StatusInt                   SetValue (bool* valueChangedP, WCharCP newValue);

    MSCORE_EXPORT StatusInt                   Show ();

    //  behavior of SetState, which forces the external state of an item to match its appearance.
    MSCORE_EXPORT StatusInt                   Synchronize ();

    //  synonym list indicated for this item. All dialogs are processed.
    MSCORE_EXPORT StatusInt                   SynchronizeOthers ();
    
    MSCORE_EXPORT StatusInt                   Unobscure ();
    
    /*----------------------------------------------------------------------------------+
    |   Template Functions
    +----------------------------------------------------------------------------------*/
    
    /*----------------------------------------------------------------------------------+
    * @description Returns the specified item type pointer, if appropriate.
    * For example:
    *
    * @code
        TextBoxP    pTextBox = diP->GetTypePtr <TextBoxP> (RTYPE_Text);
    * @endcode
    +----------------------------------------------------------------------------------*/
    template <typename T>
    T GetTypePtr (RscType itemType)
        {
        if (itemType == this->type)
            return static_cast<T> (this);
        else
            return NULL;
        }

    /*----------------------------------------------------------------------------------+
    |   Constructor / Destructor
    +----------------------------------------------------------------------------------*/
    MSCORE_EXPORT DialogItem();

    MSCORE_EXPORT ~DialogItem();

    };