FxUI.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "FxString.h"
 
#include "FxUIRibbon.h"
 
#include "FxUIRibbonTabSelector.h"
 
#include <IdArrays.h>
 
#include "FxPragmaPush.h"
 
class QIcon;
class xFxKeySequence;
class CFxToolBar;
 
class CFxUIItemDefinition;
class CFxUIGroup;
class CFxUIMenuItem;
class CFxUIToolbarItem;
class CFxUIDoubleClickAction;
class CFxUIAccelerator;
class CFxUIButton;
class CFxUITabletMenu;
class CFxUITempOverrideKey;
class CFxUIDockableWindow;
class CFxUIWorkspace;
class CFxUIImageItem;
 
class CFxUIItemDefinitionCollection;
class CFxUIToolbarItemCollection;
class CFxUIMenuItemCollection;
class CFxUIDoubleClickActionsCollection;
class CFxUIButtonsCollection;
class CFxUIAcceleratorsCollection;
class CFxUITabletMenusCollection;
class CFxUITempOverrideKeysCollection;
class CFxUIImageItemCollection;
 
class CFxRibbonPreviewProxy;
 
class CFxUIContext;
 
class CFxUIReactor;

template <class T>
class CFxUIIterator
{
public:
    virtual ~CFxUIIterator(){};
 
    virtual bool Done() const = 0;
    virtual void Next() = 0;
    virtual void Rewind() = 0;
    virtual T* GetItem() = 0;
};
 
typedef CFxUIIterator<CFxUIGroup> CFxUIGroupIterator;
typedef CFxUIIterator<CFxUIItemDefinition> CFxUIItemDefinitionIterator;
typedef CFxUIIterator<CFxUIMenuItem> CFxUIMenuIterator;
typedef CFxUIIterator<CFxUIWorkspace> CFxUIWorkspaceIterator;

class CFxUI
{
public:

 
    typedef enum _MenuType
    {
        eNormal,
        eMain,
        eContextDefault,
        eContextEditDefault,
        eContextCommandDefault,
        eContextObject,
        eContextCommand
    } MenuType;

 
    typedef enum _ToolbarType
    {
        eAction,
        eControl,
        eFlyout
    } ToolbarType;

 
    typedef enum _ButtonType
    {
        eClick,
        eShiftClick,
        eCtrlClick,
        eCtrlShiftClick
    } ButtonType;

 
    typedef enum _Orientation
    {
        eLeft     = 0x0001,
        eRight    = 0x0002,
        eTop      = 0x0004,
        eBottom   = 0x0008,
        eFloating = 0x0010,
        eAll      = eFloating | eTop | eBottom | eLeft | eRight
    } Orientation;
 
    typedef enum _NavigationToolbarType
    {
        eFull = 0,
        eMedium = 1,
        eNarrow = 2
    } NavigationToolbarType;
 
    virtual ~CFxUI() {}

 
    virtual void LoadInterface() = 0;

 
    virtual void SaveInterface() = 0;

    virtual bool LoadResourceFile( const CFxString& name, CFxUIGroup** pLoadedGroup = 0 ) = 0;

    virtual CFxUIItemDefinition* FindItem( const CFxString& uiGroup, const CFxString& id ) = 0;

    virtual CFxUIItemDefinition* CreateItemDefinition( const CFxString& id, CFxUIContext* pContext ) const = 0;

    virtual void DestroyItemDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual bool RemoveItemDefinition( CFxUIItemDefinition* pDefinition ) = 0;
 
    //groups

    virtual bool AddGroup( CFxUIGroup* pItem ) = 0;

    virtual bool RemoveGroup( const CFxString& sGroupName ) = 0;

    virtual CFxUIGroup* GetStartUpGroup() = 0;

    virtual CFxUIWorkspace* GetStartUpWorkspace() = 0;

    virtual CFxUIGroup* GetGroup( const CFxString& name ) = 0;

    virtual CFxUIGroupIterator* CreateGroupIterator() = 0;
 
    //workspace

    virtual bool AddWorkspace( CFxUIWorkspace* pItem ) = 0;

    virtual bool RemoveWorkspace( CFxUIWorkspace* pItem ) = 0;

    virtual CFxUIWorkspace* GetWorkspace( const CFxString& name ) = 0;

    virtual CFxUIWorkspaceIterator* CreateWorkspaceIterator() = 0;

    virtual CFxUIWorkspace* GetCurrentWorkspace() = 0;

    virtual void SetCurrentWorkspace(CFxUIWorkspace* ) = 0;
 
 
    //creation

    virtual CFxString CreateUniqueID() const = 0;

    virtual CFxUIGroup* CreateGroup( const CFxString& groupName, const CFxString& fileName ) const = 0;
    virtual CFxUIGroup* CreateRuntimeGroup( const CFxString& groupName ) const = 0;

    virtual CFxUIWorkspace* CreateWorkspace( const CFxString& wsName, const CFxString& fileName ) const = 0;

    virtual CFxUIMenuItem* CreateMenuItem( MenuType eType, const CFxString& pClass, const CFxString& command, const CFxString& id = CFxString()) const = 0;

    virtual void DestroyMenuItem( CFxUIMenuItem* pItem ) = 0;

    virtual CFxUIToolbarItem* CreateToolbarItem( CFxUI::ToolbarType type = CFxUI::eAction, const CFxString& sUID = CFxString() ) const = 0;

    virtual void DestroyToolbarItem( CFxUIToolbarItem* pItem ) = 0;

    virtual CFxUIRibbonTab* CreateRibbonTabItem( const CFxString& sUID = CFxString() ) const = 0;

    virtual CFxUIRibbonPanel* CreateRibbonPanelItem( const CFxString& sUID = CFxString() ) const = 0;
    
    virtual CFxUIRibbonRow* CreateRibbonRowItem( const CFxString& sUID = CFxString() ) const = 0;
    
    virtual CFxUIRibbonRowItem* CreateRibbonRowElementItem( CFxUIRibbonItem::RibbonItemType type, const CFxString& sUID = CFxString() ) const = 0;

    virtual CFxUIRibbonQuickAccessBar* CreateRibbonQuickAccessBar( const CFxString& sUID = CFxString() ) const = 0;

    virtual CFxUIRibbonSystemMenuItem* CreateRibbonSystemMenuItem( const CFxString& sUID = CFxString() ) const = 0;

    virtual CFxUIRibbonQuickAccessBarItem* CreateRibbonQuickAccessBarItem( const CFxString& sUID = CFxString() ) const = 0;

    virtual CFxUIRibbonHelpMenuItem* CreateRibbonHelpMenuItem( const CFxString& sUID = CFxString() ) const = 0;
    
    virtual void DestroyRibbonTabItem( CFxUIRibbonTab* pTab ) = 0;

    virtual void DestroyRibbonPanelItem( CFxUIRibbonPanel* pPanel ) = 0;

    virtual void DestroyRibbonRowItem( CFxUIRibbonRow* pRow ) = 0;

    virtual void DestroyRibbonRowElementItem( CFxUIRibbonRowItem* pItem ) = 0;

    virtual void DestroyRibbonQuickAccessBar( CFxUIRibbonQuickAccessBar* pQuickAccessBar ) = 0;

    virtual void DestroyRibbonSystemMenuItem( CFxUIRibbonSystemMenuItem* pSystemMenuItem ) = 0;

    virtual void DestroyRibbonHelpMenuItem( CFxUIRibbonHelpMenuItem* pHelpMenuItem ) = 0;

    virtual void DestroyRibbonQuickAccessBarItem( CFxUIRibbonQuickAccessBarItem* pQuickAccessBarItem ) = 0;

    virtual CFxUIDoubleClickAction* CreateDoubleClickAction( const CFxString& className, const CFxString& sUID = CFxString() ) const = 0;

    virtual void DestroyDoubleClickAction( CFxUIDoubleClickAction* pItem ) = 0;

    virtual CFxUIAccelerator* CreateAccelerator( CFxUIItemDefinition* pDefinition, const CFxString& sUID = CFxString() ) const = 0;

    virtual void DestroyAccelerator( CFxUIAccelerator* pItem ) = 0;

    virtual CFxUIButton* CreateMouseButton( CFxUIItemDefinition* pDefinition, int iButtonNumber, const CFxString& sUID = CFxString()  ) const = 0;
    virtual void DestroyMouseButton( CFxUIButton* pItem ) = 0;

    virtual CFxUITabletMenu* CreateTabletMenu() const = 0;

    virtual void DestroyTabletMenu( CFxUITabletMenu* pItem ) = 0;

    virtual CFxUITempOverrideKey* CreateTempOverrideKey( const CFxString& sUID = CFxString() ) const = 0;

    virtual void DestroyTempOverrideKey( CFxUITempOverrideKey* pItem ) = 0;

    virtual CFxUIImageItem* CreateImageItem( const CFxString& sName, const CFxString& sUID = CFxString() ) const = 0;

    virtual void DestroyImageItem( CFxUIImageItem* pItem ) = 0;
 
    // Create toolbar with sToolbarName
    // Returns object name of create UI toolbar

    virtual CFxString CreateRuntimeToolbar( const CFxString& sToolbarName ) = 0;
 
    // Create toolbar with sToolbarName and add it to *sGroupName* group.
    // Returns pointer to created UI toolbar.

    virtual CFxUIToolbarItem* CreateRuntimeToolbar( const CFxString& sToolbarName, const CFxString& sGroupName ) = 0;
 
    // Destroy UI toolbar with specified object name

    virtual void DestroyRuntimeToolbar( const CFxString& sObjectName ) = 0;
 
    //context menus

    virtual void AddUserDefaultContextMenu( CFxUIContext* pContext ) = 0;

    virtual void RemoveUserDefaultContextMenu( CFxUIContext* pContext ) = 0;

    virtual void AddUserObjectContextMenu( const CFxString& pClass, CFxUIContext* pContext ) = 0;

    virtual void RemoveUserObjectContextMenu( const CFxString& pClass, CFxUIContext* pContext ) = 0;

    virtual void AddUserCommandContextMenu( const CFxString& strCommand, CFxUIContext* pContext ) = 0;

    virtual void RemoveUserCommandContextMenu( const CFxString& strCommand, CFxUIContext* pContext ) = 0;
 
    virtual bool DisplayContextMenu() = 0;

    virtual int Menucmd( const CFxString& strCmd, CFxString & strResult ) = 0;

    virtual bool CheckEvents( bool bMouseMove, bool bMouseWheel, bool bMouseButton, bool bAllKeyboard ) = 0;

    virtual void ResetEvents() = 0;
 
    // Update

    virtual void Update( bool bFullUpdate = false ) = 0;

    virtual void UpdateMenu() = 0;

    virtual void UpdateRibbon() = 0;

    virtual CFxWidget* UpdatePanelPreview( CFxUIRibbonPanel* pRibbonPanelDef, CFxWidget* parent, CFxRibbonPreviewProxy* pRibbonPreviewProxy, const CFxString& strUID ) = 0;

    virtual void SetCleanScreenState( bool bValue ) = 0;

    virtual void AddUIReactor( CFxUIReactor* pReactor ) = 0;

    virtual void RemoveUIReactor( CFxUIReactor* pReactor ) = 0;
 
    //runtime ui elements
    virtual CFxUIItemDefinition* CreateRuntimeItemDefinition( const CFxString& id, CFxUIContext* pContext ) const = 0;
    virtual void DestroyRuntimeItemDefinition( CFxUIItemDefinition* pDefinition ) = 0;
 
    virtual CFxUIMenuItem* CreateRuntimeMenuItem( MenuType eType, const CFxString& pClass, const CFxString& command, const CFxString& id = CFxString()) const = 0;
    virtual void DestroyRuntimeMenuItem( CFxUIMenuItem* pItem ) = 0;
 
    virtual CFxUIToolbarItem* CreateRuntimeToolbarItem( CFxUI::ToolbarType type = CFxUI::eAction ) const = 0;
    virtual void DestroyRuntimeToolbarItem( CFxUIToolbarItem* pItem ) = 0;
 
    //visible top level ui elements
    virtual CFxUIMenuItemCollection* GetVisibleMenuCollection() = 0;
    virtual CFxUIToolbarItemCollection* GetVisibleToolbarCollection() = 0;
    virtual CFxUIRibbonTabCollection* GetVisibleRibbonTabCollection() = 0;
    virtual CFxUIRibbonSystemMenuItem* GetVisibleRibbonSystemMenu() = 0;
    virtual CFxUIRibbonQuickAccessBar* GetVisibleRibbonQuickAccessBar() = 0;
    virtual CFxUIRibbonHelpMenuItemCollection* GetVisibleRibbonHelpMenu() = 0;
 
#if defined Q_OS_MACX
    virtual void setBlockAppleMenuActions( bool bBlock ) = 0;
    virtual bool isMacMenuVisible() = 0;
    virtual void clearMenuOnPrinting() = 0;
    virtual void setHideFloatingToolbars( bool bHide ) = 0;
#endif
};

class CFxUIDockableWindowCollection
{
public:
    virtual ~CFxUIDockableWindowCollection() {}

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIDockableWindow* GetItem( unsigned int index ) = 0;

    virtual void UpdateCurrentState() = 0;
};

class CFxUIWorkspace
{
protected:
    virtual ~CFxUIWorkspace() {}
 
public:

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& strName ) = 0;

    virtual const CFxString& GetLocalizedName() const = 0;

    virtual void SetLocalizedName( const CFxString& strName ) = 0;

    virtual const CFxString& GetFileName() const = 0;

    virtual void SetFileName( const CFxString& strFileName ) = 0;

    virtual const CFxString& GetDescription() const = 0;

    virtual void SetDescription( const CFxString& strDesc ) = 0;

    virtual CFxUIMenuItemCollection* GetMenus() = 0;

    virtual CFxUIToolbarItemCollection* GetToolbars() = 0;

    virtual CFxUIToolbarItemCollection* GetNavigationToolbars() = 0;

    virtual CFxUIRibbonTabCollection* GetRibbonTabs() = 0;

    virtual CFxUIDockableWindowCollection* GetDockableWindows() = 0;

    virtual bool GetStatusBarVisible() const = 0;

    virtual void SetStatusBarVisible( bool bVisible ) = 0;

    virtual CFxUIRibbonQuickAccessBar* GetRibbonQuickAccessBar() = 0;

    virtual CFxUIRibbonSystemMenuItem* GetRibbonSystemMenu() = 0;

    virtual void SetRibbonQuickAccessBar( CFxUIRibbonQuickAccessBar* pQuickAccessBar, CFxString sGroupName ) = 0;
};

class CFxUIGroup
{
protected:
    virtual ~CFxUIGroup() {}
 
public:

    virtual const CFxString& GetName() const = 0;

    virtual const CFxString& GetFileName() const = 0;

    virtual bool IsBaseGroup() const = 0;

    virtual CFxUIItemDefinitionCollection* GetUIItemDefinitions() = 0;

    virtual CFxUIToolbarItemCollection* GetToolbars() = 0;

    virtual CFxUIToolbarItemCollection* GetNavigationToolbars() = 0;
 

    virtual CFxUIMenuItemCollection* GetMenus() = 0;

    virtual CFxUIMenuItemCollection* GetContextMenus() = 0;

    virtual CFxUIRibbonTabCollection* GetRibbonTabs() = 0;
 
    virtual CFxUIRibbonTabSelectorCollection* GetRibbonTabSelectors() = 0;

    virtual CFxUIRibbonPanelCollection* GetRibbonPanels() = 0;

    virtual CFxUIRibbonQuickAccessBarCollection* GetRibbonQuickAccessBars() = 0;

    virtual CFxUIRibbonSystemMenuItemCollection* GetRibbonSystemMenuItems() = 0;

    virtual CFxUIRibbonHelpMenuItemCollection* GetRibbonHelpMenuItems() = 0;

    virtual CFxUIDoubleClickActionsCollection* GetDoubleClickActions() = 0;

    virtual CFxUIButtonsCollection* GetMouseButtons() = 0;

    virtual CFxUIButtonsCollection* GetMouseClicks() = 0;

    virtual CFxUIButtonsCollection* GetMouseShiftClicks() = 0;

    virtual CFxUIButtonsCollection* GetMouseCtrlClicks() = 0;

    virtual CFxUIButtonsCollection* GetMouseCtrlShiftClicks() = 0;

    virtual CFxUIAcceleratorsCollection* GetAccelerators() = 0;

    virtual CFxUITabletMenusCollection* GetTabletMenus() = 0;

    virtual CFxUIButtonsCollection* GetTabletClicks() = 0;

    virtual CFxUIButtonsCollection* GetTabletShiftClicks() = 0;

    virtual CFxUIButtonsCollection* GetTabletCtrlClicks() = 0;

    virtual CFxUIButtonsCollection* GetTabletCtrlShiftClicks() = 0;

    virtual CFxUITempOverrideKeysCollection* GetTempOverrideKeys() = 0;

    virtual CFxUIItemDefinition* GetMiddleButtonDoubleClickAction() = 0;

    virtual void SetMiddleButtonDoubleClickAction( CFxUIItemDefinition* pAction ) = 0;

    virtual CFxUIImageItemCollection* GetImageItems() = 0;

    virtual bool IsRuntimeGroup() const = 0;
};

class CFxUIItemDefinitionCollection
{
public:
    virtual ~CFxUIItemDefinitionCollection() {}

    virtual bool Add( CFxUIItemDefinition* pItem ) = 0;
    //bool Remove( const CFxUIItemDefinition& item );

    virtual CFxUIItemDefinitionIterator* CreateIterator() = 0;

    virtual CFxUIItemDefinition* FindItem( const CFxString& id ) = 0;
 
    virtual bool Has( const CFxUIItemDefinition* pItem ) const = 0;
};

class CFxUIMenuItemCollection
{
public:
    virtual ~CFxUIMenuItemCollection(){}

    virtual bool InsertAfter( const CFxUIMenuItem* pPosition, CFxUIMenuItem* pItem ) = 0;

    virtual bool Add( CFxUIMenuItem* pItem ) = 0;

    virtual bool Remove( CFxUIMenuItem* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIMenuItem* GetItem( unsigned int index ) = 0;

    virtual void Clear( bool bDeleteItems ) = 0;
 
    virtual bool Has( const CFxUIMenuItem* pItem ) const = 0;
};

class CFxUIToolbarItemCollection
{
public:
    virtual ~CFxUIToolbarItemCollection() {}

    virtual bool InsertAfter( const CFxUIToolbarItem* pPosition, CFxUIToolbarItem* pItem ) = 0;

    virtual bool Add( CFxUIToolbarItem* pItem ) = 0;

    virtual bool Remove( CFxUIToolbarItem* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIToolbarItem* GetItem( unsigned int index ) = 0;

    virtual void Clear( bool bDeleteItems ) = 0;
 
    virtual bool Has( const CFxUIToolbarItem* pItem ) const = 0;
};

class CFxUIDoubleClickActionsCollection
{
public:
    virtual ~CFxUIDoubleClickActionsCollection() {}

    virtual bool Add( CFxUIDoubleClickAction* pItem ) = 0;

    virtual bool Remove( CFxUIDoubleClickAction* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIDoubleClickAction* GetItem( unsigned int index ) = 0;

    virtual CFxUIDoubleClickAction* GetItem( const CFxString& pClass ) = 0;
};

class CFxUIButtonsCollection
{
public:
    virtual ~CFxUIButtonsCollection() {}

    virtual bool Add( CFxUIButton* pItem ) = 0;

    virtual bool Remove( CFxUIButton* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIButton* GetItem( unsigned int index ) = 0;
};

class CFxUIAcceleratorsCollection
{
public:
    virtual ~CFxUIAcceleratorsCollection() {}
 
    virtual bool Add( CFxUIAccelerator* pItem ) = 0;

    virtual bool Remove( CFxUIAccelerator* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIAccelerator* GetItem( unsigned int index ) = 0;
};

class CFxUITabletMenusCollection
{
public:
    virtual ~CFxUITabletMenusCollection() {}

    virtual bool Add( CFxUITabletMenu* pItem ) = 0;

    virtual bool Remove( CFxUITabletMenu* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUITabletMenu* GetItem( unsigned int index ) = 0;
};

class CFxUITempOverrideKeysCollection
{
public:
    virtual ~CFxUITempOverrideKeysCollection() {}

    virtual bool Add( CFxUITempOverrideKey* pItem ) = 0;

    virtual bool Remove( CFxUITempOverrideKey* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUITempOverrideKey* GetItem( const xFxKeySequence& keySequence ) = 0;

    virtual CFxUITempOverrideKey* GetItem( unsigned int index ) = 0;
};

class CFxUIImageItemCollection
{
public:
    virtual ~CFxUIImageItemCollection() {}

    virtual bool Add( CFxUIImageItem* pItem ) = 0;

    virtual bool Remove( CFxUIImageItem* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

    virtual CFxUIImageItem* GetItem( unsigned int index ) = 0;

    virtual void Clear( bool bDeleteItems ) = 0;
 
    virtual bool Has( const CFxUIImageItem* pItem ) = 0;
};

class CFxUIItemDefinition
{
protected:
    virtual ~CFxUIItemDefinition() {}
 
public:

    virtual void SetID( const CFxString& sId ) = 0;

    virtual const CFxString& GetID() const = 0;

    virtual CFxUIContext* GetContext() = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual const CFxString& GetCommand() const = 0;

    virtual void SetCommand( const CFxString& command ) = 0;
    
    virtual QIcon& GetIcon( int iSize ) = 0;

    virtual QIcon& GetDarkIcon( int iSize ) = 0;

    virtual QIcon& GetLightIcon( int iSize ) = 0;

    virtual const CFxString& GetDarkIconInfo( CFxString& iconResource ) const = 0;

    virtual void SetDarkIconInfo( const CFxString& iconName, const CFxString& iconResource ) = 0;

    virtual const CFxString& GetLightIconInfo( CFxString& iconResource ) const = 0;

    virtual void SetLightIconInfo( const CFxString& iconName, const CFxString& iconResource ) = 0;

    virtual const CFxString& GetDescription() const = 0;

    virtual void SetDescription( const CFxString& description ) = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
 };

class CFxUIMenuItem
{
protected:
    virtual ~CFxUIMenuItem() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual OdArray<CFxString>& GetAliases() = 0;

    virtual void AddAlias( const CFxString& sAlias ) = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual const CFxUIMenuItem* GetParent() const = 0;

    virtual CFxUIMenuItemCollection* GetChildren() = 0;

    virtual bool IsAction() const = 0;

    virtual bool IsSeparator() const = 0;

    virtual void SetToSeparator() = 0;

    virtual CFxUI::MenuType GetType() const = 0;

    virtual void SetType( CFxUI::MenuType type ) = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUIToolbarItem
{
protected:
    virtual ~CFxUIToolbarItem() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual OdArray<CFxString>& GetAliases() = 0;

    virtual void AddAlias( const CFxString& sAlias ) = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual const CFxUIToolbarItem* GetParent() const = 0;

    virtual CFxUIToolbarItemCollection* GetChildren() = 0;

    virtual CFxUI::ToolbarType GetType() const = 0;

    virtual bool IsAction() const = 0;

    virtual bool IsSeparator() const = 0;

    virtual void SetToSeparator() = 0;

    virtual bool GetOnByDefault() const = 0;

    virtual void SetOnByDefault( bool bOnByDefault ) = 0;

    virtual CFxUI::Orientation GetOrientation() const = 0;

    virtual void SetOrientation( CFxUI::Orientation orientation ) = 0;

    virtual bool GetMovable() const = 0;

    virtual void SetMovable( bool bMovable ) = 0;

    virtual int GetDefXLocation() const = 0;

    virtual void SetDefXLocation( int iXLocation ) = 0;

    virtual int GetDefYLocation() const = 0;

    virtual void SetDefYLocation( int iYLocation ) = 0;

    virtual bool IsInMatrixToolbar() const = 0;

    virtual void SetInMatrixToolbar( bool bInMatrixToolbar ) = 0;

    virtual int GetMatrixToolbarIndex() const = 0;

    virtual void SetMatrixToolbarIndex( int index ) = 0;

    virtual bool IsExpanded() const = 0;

    virtual void SetExpanded( bool bIsExpanded) = 0;

    virtual int GetRows() const = 0;

    virtual void SetRows( int iRows ) = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual const CFxString& GetFlyoutID() const = 0;

    virtual void SetFlyoutID(CFxString flyoutID) = 0;
 
    virtual int GetDockRow() const = 0;
    virtual void SetDockRow( int iDockRow ) = 0;
 
    virtual int GetDockColumn() const = 0;
    virtual void SetDockColumn( int iDockColumn ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUIDoubleClickAction
{
protected:
    virtual ~CFxUIDoubleClickAction() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual const CFxString& GetDxfClassName() const = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

 
    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUIAccelerator
{
protected:
    virtual ~CFxUIAccelerator() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual const xFxKeySequence& GetKeySequence() const = 0;

    virtual void SetKeySequence( const xFxKeySequence& keySequence ) = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUIButton
{
protected:
    virtual ~CFxUIButton() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual int GetButtonNumber() const = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUITabletMenu
{
protected:
    virtual ~CFxUITabletMenu() {}
 
public:

    virtual int GetRowsNumber() const = 0;

    virtual bool SetRowsNumber( int iRowsNumber ) = 0;

    virtual int GetColumnsNumber() const = 0;

    virtual bool SetColumnsNumber( int ColumnsNumber ) = 0;

    virtual CFxUIItemDefinition* GetItem( int iRow, int iColumn ) const = 0;

    virtual bool SetItem( int iRow, int iColumn, CFxUIItemDefinition* pItem ) = 0;
 
    virtual const CFxString& GetName() const = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUITempOverrideKey
{
protected:
    virtual ~CFxUITempOverrideKey() {}
 
public:

    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual const CFxString& GetDescription() const = 0;

    virtual void SetDescription( const CFxString& description ) = 0;

    virtual const xFxKeySequence& GetKeySequence() const = 0;

    virtual void SetKeySequence( const xFxKeySequence& keySequence ) = 0;

    virtual const CFxString& GetKeyDownMacro() const = 0;

    virtual void SetKeyDownMacro( const CFxString& macro ) = 0;

    virtual const CFxString& GetKeyUpMacro() const = 0;

    virtual void SetKeyUpMacro( const CFxString& macro ) = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;

    virtual bool IsRuntime() const = 0;
};

class CFxUIDockableWindow
{
public:
    virtual ~CFxUIDockableWindow() {}

    virtual bool GetShow() const = 0;

    virtual void SetShow( bool bShow ) = 0;

    virtual CFxUI::Orientation GetAvailableOrientations() const = 0;

    virtual CFxUI::Orientation GetOrientation() const = 0;

    virtual bool SetOrientation( CFxUI::Orientation orientation ) = 0;

    virtual bool GetAllowDocking() const = 0;

    virtual void SetAllowDocking( bool bDockable ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual const CFxString& GetObjectName() const = 0;

    virtual const CFxString& GetDescription() const = 0;

    virtual const CFxString& GetIconResPath() const = 0;
};

class CFxUIContext
{
public:
    virtual ~CFxUIContext() {}

    virtual void OnCommand( const CFxUIItemDefinition* ) = 0;

    virtual CFxUIMenuItem* GetMenuContext(const CFxString&, const OdDbObjectIdArray& ) = 0;

    virtual void OnUpdateMenu() = 0;
};

class CFxUIImageItem
{
protected:
    virtual ~CFxUIImageItem() {}
 
public:
    
    virtual const CFxString& GetUID() const = 0;

    virtual void SetUID( const CFxString& strUID ) = 0;

    virtual const CFxString& GetName() const = 0;

    virtual void SetName( const CFxString& name ) = 0;

    virtual const CFxString& GetUITitleName() const = 0;

    virtual void SetUITitleName( const CFxString& titlename ) = 0;

    virtual const CFxString& GetImageLibFile() const = 0;

    virtual void SetImageLibFile( const CFxString& imagelibname ) = 0;

    virtual const CFxString& GetImageName() const = 0;

    virtual void SetImageName( const CFxString& imagename ) = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual bool IsObsolete() const = 0;

    virtual void SetObsolete( bool bObsolete ) = 0;
    
    virtual const CFxUIImageItem* GetParent() const = 0;

    virtual CFxUIImageItemCollection* GetChildren() = 0;

    virtual bool IsSeparator() const = 0;

    virtual void SetToSeparator() = 0;

    virtual bool IsRuntime() const = 0; 

    virtual int GetColumns() const = 0;

    virtual void SetColumns( int iColumns ) = 0;

    virtual int GetRows() const = 0;

    virtual void SetRows( int iRows ) = 0;
};
 
class CFxUIReactor
{
public:
    CFxUIReactor() {}

    virtual void OnToolbarItemCreated( const CFxUIToolbarItem* pToolBarItem ) {}

    virtual void OnItemDefinitionCreated( const CFxUIItemDefinition* pItemDef ) {}

    virtual void OnMenuItemCreated( const CFxUIMenuItem* pMenuItem ) {}

    virtual void OnToolbarItemAboutToDestroy( const CFxUIToolbarItem* pUIToolBar ) {}

    virtual void OnItemDefinitionAboutToDestroy( const CFxUIItemDefinition* pUIItemDef ) {}

    virtual void OnMenuItemAboutToDestroy( const CFxUIMenuItem* pUIMenuItem ) {}

    virtual void OnToolbarVisibilityChanged( const CFxUIToolbarItem* pUIToolBar, bool bVisible ) {}
    virtual void OnToolbarWidgetCreated( const CFxUIToolbarItem* pToolBarDefinition, CFxToolBar* pToolBar ) {}
 
    virtual void OnSubMenuAboutToShow( CFxUIMenuItem* pSubMenu ) {}
 
    virtual void OnInterfaceAboutToReload() {}
    virtual void OnInterfaceReloaded() {}
    virtual void OnRibbonControlCreated( const CFxString& strId, CFxWidget*& pControl ){}
};
 
class CFxUIStyle
{
public:
    enum UIStyle
    {
        GraebertLightStyle,
        GraebertLightStyle2,
        GraebertDarkStyle,
        GraebertDarkStyle2,
    };
};
 
#include "FxPragmaPop.h"