auicommand.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 "ecimagekey.h"
#include "ecpresentationtypedefs.h"
#include "auiprovider.h"

BEGIN_BENTLEY_ECOBJECT_NAMESPACE

typedef RefCountedPtr<IUICommand> IUICommandPtr;

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

struct IUICommand : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:
    public:
    /*=================================================================================**/

    enum EditActionMenuMark
        {
        MENUMARK_None       = 0,
        MENUMARK_ToggleOut  = 1,
        MENUMARK_ToggleIn   = 2,
        MENUMARK_RadioOut   = 3,
        MENUMARK_RadioIn    = 4,
        MENUMARK_RightArrow = 5,
        };

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

    enum EditActionPriority
        {
        EDITACTION_PRIORITY_Highest            = 1000,
        EDITACTION_PRIORITY_TopGroup1          = 950,
        EDITACTION_PRIORITY_TopGroup2          = 940,
        EDITACTION_PRIORITY_TopGroup3          = 930,
        EDITACTION_PRIORITY_TopGroup4          = 920,
        EDITACTION_PRIORITY_TopGroup5          = 900,

        EDITACTION_PRIORITY_UserCommon         = 700,
        EDITACTION_PRIORITY_CommonManipulation = 500,
        EDITACTION_PRIORITY_ElementSpecific    = 400,
        EDITACTION_PRIORITY_UserSelection      = 350,
        EDITACTION_PRIORITY_Selection          = 300,

        EDITACTION_PRIORITY_UserClipboard      = 250,
        EDITACTION_PRIORITY_Clipboard          = 200,
        EDITACTION_PRIORITY_UserDelete         = 150,
        EDITACTION_PRIORITY_Delete             = 100,

        EDITACTION_PRIORITY_UserProperties     = 50,
        EDITACTION_PRIORITY_Properties         = 0,

        EDITACTION_PRIORITY_BottomGroup1       = -2,
        EDITACTION_PRIORITY_BottomGroup2       = -4,
        EDITACTION_PRIORITY_BottomGroup3       = -6,
        EDITACTION_PRIORITY_BottomGroup4       = -8,
        EDITACTION_PRIORITY_BottomGroup5       = -10,
        EDITACTION_PRIORITY_Lowest             = -1000,

        #if defined (BEIJING_DGNPLATFORM_WIP_SWW)
        #endif // defined (BEIJING_DGNPLATFORM_WIP_SWW)
        EDITACTION_PRIORITY_MiscGroup1,
        EDITACTION_PRIORITY_MiscGroup2,
        EDITACTION_PRIORITY_MiscGroup3,
        EDITACTION_PRIORITY_MiscGroup4,
        EDITACTION_PRIORITY_MiscGroup5,
        EDITACTION_PRIORITY_MiscGroup6
        };

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

    enum ApplicationPurpose
        {
        Unknown              = 0,
        ViewWindowRightClick = 1,
        ToolBar              = 2,
        ExplorerMenu         = 3,
        };

    
    protected:
        
        virtual BentleyStatus       _ExecuteCmd(IAUIDataContextCP instance) = 0;

        virtual WCharCP             _GetCommandId() const = 0;

        virtual WString             _GetLabel() const = 0;

        virtual void                _SetLabel(WCharCP label) {}

        virtual WString             _GetDescription() const { return WString(); }
        
        virtual void                _SetDescription(WCharCP description) {}

        virtual ECImageKeyCP        _GetImageId() const = 0;

        virtual void                _SetImageId(ECImageKeyCR key) {}

        virtual bool                _GetIsEnabled() const { return false; }

        virtual void                _SetIsEnabled(bool enabled) { ; }
        
    public:
        virtual ~IUICommand () {}

        ECOBJECTS_EXPORT BentleyStatus      ExecuteCmd (IAUIDataContextCP instance);

        ECOBJECTS_EXPORT void               Journal (IJournalItemR journalEntry);

        ECOBJECTS_EXPORT WCharCP            GetCommandId () const;
        
        ECOBJECTS_EXPORT WString            GetLabel ()  const;

        ECOBJECTS_EXPORT void               SetLabel (WCharCP label);

        ECOBJECTS_EXPORT WString            GetDescription ()  const;

        ECOBJECTS_EXPORT void               SetDescription (WCharCP description);
        
        ECOBJECTS_EXPORT ECImageKeyCP       GetImageId ()  const;

        ECOBJECTS_EXPORT void               SetImageId (ECImageKeyCR key);
        
        ECOBJECTS_EXPORT bool               IsSeparator ()  const;
        
        ECOBJECTS_EXPORT WString            GetApplicatonArg ()  const;
        
        ECOBJECTS_EXPORT void               SetApplicationArg (WCharCP arg);

        ECOBJECTS_EXPORT EditActionMenuMark GetMenuMark() const;
        
        ECOBJECTS_EXPORT void               SetMenuMark(EditActionMenuMark mark);

        ECOBJECTS_EXPORT bool               GetIsEnabled () const;
        
        ECOBJECTS_EXPORT void               SetIsEnabled (bool enabled);

        ECOBJECTS_EXPORT IUICommand*        GetParent() const;
        
        ECOBJECTS_EXPORT void               GetChildren (bvector<IUICommandPtr>& children) const;
        ECOBJECTS_EXPORT void               GetChildren(bvector<IUICommandPtr>& children);

        ECOBJECTS_EXPORT EditActionPriority GetPriority () const;
        
        ECOBJECTS_EXPORT void               SetPriority (EditActionPriority priority);
        
    };

typedef RefCountedPtr<UICommand> UICommandPtr;
/*=================================================================================**/

struct ActionPriorityComparer
    {
    bool operator () (IUICommandPtr const& lhs, IUICommandPtr const& rhs)
        {
        return lhs->GetPriority() > rhs->GetPriority();
        }
    };

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

struct UICommand : public IUICommand
    {

    };

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

struct ECPresentationCommandProvider : public IECPresentationProvider
    {

    public:
        virtual ~ECPresentationCommandProvider() {}

        ECOBJECTS_EXPORT void GetCommand (bvector<IUICommandPtr>&commands, IAUIDataContextCR instance, int purpose);
    };


END_BENTLEY_ECOBJECT_NAMESPACE