FxUIRibbon.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 <IdArrays.h>
 
#include "FxPragmaPush.h"
 
//ribbon
class CFxUIRibbonTab;
class CFxUIRibbonPanel;
class CFxUIRibbonRowItem;
class CFxUIRibbonRow;
class CFxUIRibbonSystemMenuItem;
class CFxUIRibbonHelpMenuItem;
class CFxUIRibbonQuickAccessBarItem;
class CFxUIItemDefinition;
class CFxUIItemDefinitionCollection;
class CFxUIRibbonCommandButton;
class CFxUIRibbonQuickAccessBar;
class QIcon;
 
class CFxUIRibbonItem
{
public:
    typedef enum _RibbonItemType
    {
        eRibbonTab,
        eRibbonPanel,
        eRibbonRow,
        eRibbonSplitButton,
        eRibbonCommandButton,
        eRibbonControl,
        eRibbonGalleryControl,
        eRibbonRowPanel,
        eRibbonSeparator,
        eRibbonButton,
        eRibbonToggleButton,
        eRibbonDataBoundDropDown,
        eRibbonQuickAccessBar,
        eRibbonSystemMenuItem,
        eRibbonQuickAccessBarItem,
        eRibbonHelpMenuItem,
    } RibbonItemType;
 
protected:
    virtual ~CFxUIRibbonItem(){};
 
public:
    virtual const CFxString& GetUID() const = 0;

    virtual RibbonItemType GetType() const = 0;
};
 
template< class T >
class CFxUIRibbonItemCollection
{
public:
    virtual ~CFxUIRibbonItemCollection() {};

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

    virtual bool Add( T* pItem ) = 0;

    virtual bool Remove( T* pItem ) = 0;

    virtual unsigned int GetCount() const = 0;

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

    virtual void Clear( bool bDeleteItems ) = 0;

    virtual bool Has( const T* pItem ) const = 0;

     virtual bool HasControl( const CFxString& strUID ) = 0;
};
 
typedef CFxUIRibbonItemCollection<CFxUIRibbonTab> CFxUIRibbonTabCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonPanel> CFxUIRibbonPanelCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonRow> CFxUIRibbonRowCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonRowItem> CFxUIRibbonRowItemCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonRowItem> CFxUIRibbonSplitButtonItemCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonQuickAccessBar> CFxUIRibbonQuickAccessBarCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonSystemMenuItem> CFxUIRibbonSystemMenuItemCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonHelpMenuItem> CFxUIRibbonHelpMenuItemCollection;
typedef CFxUIRibbonItemCollection<CFxUIRibbonQuickAccessBarItem> CFxUIRibbonQuickAccessBarItemCollection;
 
class CFxUIRibbonTab : public CFxUIRibbonItem
{
protected:
    ~CFxUIRibbonTab() override{};
 
public:

    typedef enum _ContextualDisplayType
    {
        eContextualDisplayTypeFull,
        eContextualDisplayTypeMerged,
    } ContextualDisplayType;

    virtual const CFxString& GetName() const = 0;

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

    virtual const CFxString& GetText() const = 0;

    virtual void SetText( const CFxString& text ) = 0;

    virtual CFxUIRibbonPanelCollection* GetChildren() = 0;

    virtual ContextualDisplayType GetContextualDisplayType() = 0;

    virtual void SetContextualDisplayType( ContextualDisplayType contextualType ) = 0;
};
 
class CFxUIRibbonPanel : public CFxUIRibbonItem
{
protected:
    ~CFxUIRibbonPanel() override{};
 
public:
    virtual const CFxString& GetName() const = 0;

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

    virtual const CFxString& GetText() const = 0;

    virtual void SetText( const CFxString& text ) = 0;

    virtual bool IsHiddenInEditor() const = 0;

    virtual void SetHiddenInEditor( bool isHidden ) = 0;

    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual CFxUIRibbonRowCollection* GetChildren() = 0;
};
 
 
class CFxUIRibbonRow : public CFxUIRibbonItem
{
protected:
    ~CFxUIRibbonRow() override{};
 
public:
    virtual CFxUIRibbonRowItemCollection* GetChildren() = 0;
};
 
class CFxUIRibbonRowItem : public CFxUIRibbonItem
{
protected:
    ~CFxUIRibbonRowItem() override{};
 
public:
    typedef enum _RibbonButtonStyle
    {
        eButtonStyleUnknown,
        eButtonStyleLargeWithText,
        eButtonStyleLargeWithoutText,
        eButtonStyleSmallWithText,
        eButtonStyleSmallWithoutText,
    } RibbonButtonStyle;

    typedef enum _RibbonSplitButtonBehavior
    {
        eSplitButtonBehaviorUnknown,
        eSplitButtonBehaviorSplitNoFollow,
        eSplitButtonBehaviorSplitFollow,
        eSplitButtonBehaviorSplitFollowStaticText,
        eSplitButtonBehaviorDropDownFollow,
        eSplitButtonBehaviorDropDownNoFollow,
    } RibbonSplitButtonBehavior;

    typedef enum _RibbonSplitButtonListStyle
    {
        eSplitButtonListStyleUnknown,
        eSplitButtonListStyleIcon,
        eSplitButtonListStyleIconText,
        eSplitButtonListStyleDescriptive,
    } RibbonSplitButtonListStyle;

    typedef enum _RibbonSeparatorStyle
    {
        eSeparatorStyleUnknown,
        eSeparatorStyleLine,
        eSeparatorStyleSpacer,
    } RibbonSeparatorStyle;

    typedef enum _RibbonGalleryControlDisplayMode
    {
        eGalleryControlDisplayModeUnknown,
        eGalleryControlDisplayModeCombobox,
        eGalleryControlDisplayModeWindow,
    } RibbonGalleryControlDisplayMode;
 

    typedef enum _RibbonDataBoundDropDownListStyle
    {
        eDataBoundDropDownListStyleUnknown,
        eDataBoundDropDownListStyleIcon,
        eDataBoundDropDownListStyleIconText,
        eDataBoundDropDownListStyleDescriptive,
    } RibbonDataBoundDropDownListStyle;

    virtual const CFxString& GetText() const = 0;

    virtual void SetText( const CFxString& text ) = 0;

    virtual const CFxString& GetClassID() const = 0;

    virtual void SetClassID( const CFxString& classID ) = 0;
};
 
class CFxUIRibbonCommandButton : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonCommandButton() override{};
 
public:
    virtual RibbonButtonStyle GetButtonStyle() const = 0;

    virtual void SetButtonStyle( RibbonButtonStyle buttonStyle ) = 0;

    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual void SetDefinition( CFxUIItemDefinition* def ) = 0;
};
 
class CFxUIRibbonSplitButton : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonSplitButton() override{};
 
public:
    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 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 RibbonSplitButtonBehavior GetBehavior() const = 0;

    virtual void SetBehavior( RibbonSplitButtonBehavior behavior ) = 0;

    virtual RibbonSplitButtonListStyle GetListStyle() const = 0;

    virtual void SetListStyle( RibbonSplitButtonListStyle listStyle ) = 0;

    virtual RibbonButtonStyle GetButtonStyle() const = 0;

    virtual void SetButtonStyle( RibbonButtonStyle buttonStyle ) = 0;

    virtual const bool IsGrouping() const = 0;

    virtual void SetGrouping( const bool grouping ) = 0;

    virtual CFxUIRibbonSplitButtonItemCollection* GetChildren() = 0;
};
 
 
class CFxUIRibbonControl : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonControl() override{};
 
public:
};
 
class CFxUIRibbonSeparator : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonSeparator() override{};
 
public:
    virtual void SetSeparatorStyle( RibbonSeparatorStyle seperatorStyle ) = 0;

    virtual RibbonSeparatorStyle GetSeparatorStyle() const = 0;
};
 
class CFxUIRibbonButton : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonButton() override{};
 
public:
    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual RibbonButtonStyle GetButtonStyle() const = 0;

    virtual void SetButtonStyle( RibbonButtonStyle buttonStyle ) = 0;
};
 
class CFxUIRibbonToggleButton : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonToggleButton() override{};
 
public:
    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual RibbonButtonStyle GetButtonStyle() const = 0;

    virtual void SetButtonStyle( RibbonButtonStyle buttonStyle ) = 0;
};
 
//UID Id Text KeyTip DisplayMode
class CFxUIRibbonGalleryControl : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonGalleryControl() override{};
 
public:
    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual const RibbonGalleryControlDisplayMode GetDisplayMode() const = 0;

    virtual void SetDisplayMode( const RibbonGalleryControlDisplayMode displayMode ) = 0;
};
 
class CFxUIRibbonRowPanel : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonRowPanel() override{};
 
public:
    virtual const CFxString& GetResizeStyle() const = 0;

    virtual void SetResizeStyle( const CFxString& resizeStyle ) = 0;

    virtual const int GetResizePriority() = 0;

    virtual void SetResizePriority( const int resizePriority ) = 0;

    virtual const bool& GetTopJustify() = 0;

    virtual void SetTopJustify( const bool& topJustify ) = 0;

    virtual CFxUIRibbonRowCollection* GetChildren() = 0;
};
 
class CFxUIRibbonDataBoundDropDown : public CFxUIRibbonRowItem
{
protected:
    ~CFxUIRibbonDataBoundDropDown() override{};
 
public:
    virtual const CFxString& GetKeyTip() const = 0;

    virtual void SetKeyTip( const CFxString& keyTip ) = 0;

    virtual RibbonButtonStyle GetButtonStyle() const = 0;

    virtual void SetButtonStyle( RibbonButtonStyle buttonStyle ) = 0;

    virtual RibbonDataBoundDropDownListStyle GetListStyle() const = 0;

    virtual void SetListStyle( RibbonDataBoundDropDownListStyle listStyle ) = 0;
};
 
 
class CFxUIRibbonQuickAccessBar : public CFxUIRibbonItem
{
protected:
    ~CFxUIRibbonQuickAccessBar() override{};
 
public:
    virtual const CFxString& GetName() const = 0;

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

    virtual CFxUIRibbonQuickAccessBarItemCollection* GetChildren() = 0;
};
 
class CFxUIRibbonQuickAccessBarItem : public CFxUIRibbonItem
{
 
protected:
    virtual ~CFxUIRibbonQuickAccessBarItem(){};
 
public:

    virtual const CFxUIRibbonQuickAccessBar* GetParent() const = 0;

    virtual CFxUIRibbonQuickAccessBarItemCollection* GetChildren() = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual bool GetIsWorkspace() const = 0;

    virtual bool IsVisible() const = 0;

    virtual void SetIsVisible( bool isVisible ) = 0;

    virtual const bool IsEnabled() const = 0;

    virtual void SetEnabled( const bool value ) = 0;
};
 
class CFxUIRibbonSystemMenuItem : public CFxUIRibbonItem
{
protected:
    virtual ~CFxUIRibbonSystemMenuItem(){};
 
public:
    virtual const CFxString& GetName() const = 0;

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

    virtual const CFxUIRibbonSystemMenuItem* GetParent() const = 0;

    virtual CFxUIRibbonSystemMenuItemCollection* GetChildren() = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual bool IsSeparator() const = 0;
};
 
class CFxUIRibbonHelpMenuItem : public CFxUIRibbonItem
{
protected:
    virtual ~CFxUIRibbonHelpMenuItem(){};
 
public:
    virtual const CFxString& GetName() const = 0;

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

    virtual const CFxUIRibbonHelpMenuItem* GetParent() const = 0;

    virtual CFxUIItemDefinition* GetDefinition() = 0;

    virtual void SetDefinition( CFxUIItemDefinition* pDefinition ) = 0;

    virtual bool IsSeparator() const = 0;
};
 
#include "FxPragmaPop.h"