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

#pragma once

#include <ECObjects\ECInstanceIterable.h>
#include "ecpresentationtypedefs.h"
#include <ECObjects\ECInstance.h>

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

/*=================================================================================**/

struct IAUIItem : public RefCountedBase // Content Service Element
    {

    public:
        ECOBJECTS_EXPORT IAUIDataContextCP GetDataInstance() const;

        ECOBJECTS_EXPORT IAUIItemInfoCR    GetUIItemInfo () const;

        ECOBJECTS_EXPORT IAUIItemCP        GetParent () const;
    };

/*=================================================================================**/

struct  IAUIItemInfo 
    {
    enum ItemType
        {
        Menu,
        MenuItem,
        ToolBar,
        ToolBarItem,
        DataGrid,
        TreeView,
        ListView,
        Panel,
        DgnViewPort,
        };

    public:
    virtual ~IAUIItemInfo ()
        {}

    ECOBJECTS_EXPORT bool     IsAggregatable() const;
    ECOBJECTS_EXPORT ItemType GetItemType () const;

    };

/*=================================================================================**/

struct  IAUIDataContext 
    {
    enum ContextType
        {
        Custom                  = 0,
        InstanceID              = 1,
        InstanceInterface       = 1<<1,
        ECInstanceCollection    = 1<<2,
        //TODO Move this enum to a string for repository dependant values
        DgnECInstanceCollection = 1<<3,
        DgnHitPathInfo          = 1<<4,
        DgnActionItemInfoType   = DgnECInstanceCollection | DgnHitPathInfo,
        ECGroupingNode          = 1<<5,
        NodeCollection          = 1<<6,
        };
    
    virtual ContextType             _GetContextType() const = 0;

    virtual IECInstanceInterfaceCP  GetInstanceInterface () const {return NULL;}
    virtual void*                   GetCustomData() const         {return NULL;}
    virtual ECInstanceIterableCP    GetInstanceIterable () const  {return NULL;}
    virtual WString                 GetMoniker () const           {return NULL;}
    ECOBJECTS_EXPORT ContextType    GetContextType () const;
    virtual ~IAUIDataContext () {}
    };

END_BENTLEY_ECOBJECT_NAMESPACE