CFx SDK Documentation  2022 SP0
Public Types | Public Member Functions | Protected Member Functions | List of all members
CFxUIRibbonTab Class Referenceabstract

#include <FxUIRibbon.h>

Inheritance diagram for CFxUIRibbonTab:
CFxUIRibbonItem

Public Types

enum  _ContextualDisplayType { eContextualDisplayTypeFull , eContextualDisplayTypeMerged }
 
typedef enum CFxUIRibbonTab::_ContextualDisplayType ContextualDisplayType
 
- Public Types inherited from CFxUIRibbonItem
enum  _RibbonItemType {
  eRibbonTab , eRibbonPanel , eRibbonRow , eRibbonSplitButton ,
  eRibbonCommandButton , eRibbonControl , eRibbonGalleryControl , eRibbonRowPanel ,
  eRibbonSeparator , eRibbonButton , eRibbonToggleButton , eRibbonDataBoundDropDown ,
  eRibbonQuickAccessBar , eRibbonSystemMenuItem , eRibbonQuickAccessBarItem , eRibbonHelpMenuItem
}
 
typedef enum CFxUIRibbonItem::_RibbonItemType RibbonItemType
 

Public Member Functions

virtual const CFxStringGetName () const =0
 
virtual void SetName (const CFxString &name)=0
 
virtual const CFxStringGetText () const =0
 
virtual void SetText (const CFxString &text)=0
 
virtual CFxUIRibbonPanelCollectionGetChildren ()=0
 
virtual ContextualDisplayType GetContextualDisplayType ()=0
 
virtual void SetContextualDisplayType (ContextualDisplayType contextualType)=0
 
- Public Member Functions inherited from CFxUIRibbonItem
virtual const CFxStringGetUID () const =0
 
virtual RibbonItemType GetType () const =0
 

Protected Member Functions

 ~CFxUIRibbonTab () override
 
- Protected Member Functions inherited from CFxUIRibbonItem
virtual ~CFxUIRibbonItem ()
 

Detailed Description

Definition at line 169 of file FxUIRibbon.h.

Member Typedef Documentation

◆ ContextualDisplayType

Description: Values that represent _ContextualDisplayType for contextual tabs.

Member Enumeration Documentation

◆ _ContextualDisplayType

Description: Values that represent _ContextualDisplayType for contextual tabs.

Enumerator
eContextualDisplayTypeFull 
eContextualDisplayTypeMerged 

Definition at line 179 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonTab()

CFxUIRibbonTab::~CFxUIRibbonTab ( )
inlineoverrideprotected

Definition at line 172 of file FxUIRibbon.h.

Member Function Documentation

◆ GetChildren()

virtual CFxUIRibbonPanelCollection* CFxUIRibbonTab::GetChildren ( )
pure virtual

Description: Gets the children of this item.

Return Value: null if it fails, else the children.

◆ GetContextualDisplayType()

virtual ContextualDisplayType CFxUIRibbonTab::GetContextualDisplayType ( )
pure virtual

Description: Gets contextual display type(full or merged).

Return Value: contextual display type

◆ GetName()

virtual const CFxString& CFxUIRibbonTab::GetName ( ) const
pure virtual

Description: Gets the name.

Return Value: The name.

◆ GetText()

virtual const CFxString& CFxUIRibbonTab::GetText ( ) const
pure virtual

Description: Gets the text.

Return Value: The text.

◆ SetContextualDisplayType()

virtual void CFxUIRibbonTab::SetContextualDisplayType ( ContextualDisplayType  contextualType)
pure virtual

Description: Sets contextual display type(full or merged). Arguments:

Parameters
contextualTypeContextualType of the type

◆ SetName()

virtual void CFxUIRibbonTab::SetName ( const CFxString name)
pure virtual

Description: Sets a name. Arguments:

Parameters
strNameName of the string.

◆ SetText()

virtual void CFxUIRibbonTab::SetText ( const CFxString text)
pure virtual

Description: Sets a text. Arguments:

Parameters
textText of the string.

The documentation for this class was generated from the following file: