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

#include <FxUIRibbon.h>

Inheritance diagram for CFxUIRibbonPanel:
CFxUIRibbonItem

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 bool IsHiddenInEditor () const =0
 
virtual void SetHiddenInEditor (bool isHidden)=0
 
virtual const CFxStringGetKeyTip () const =0
 
virtual void SetKeyTip (const CFxString &keyTip)=0
 
virtual CFxUIRibbonRowCollectionGetChildren ()=0
 
- Public Member Functions inherited from CFxUIRibbonItem
virtual const CFxStringGetUID () const =0
 
virtual RibbonItemType GetType () const =0
 

Protected Member Functions

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

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 235 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonPanel()

CFxUIRibbonPanel::~CFxUIRibbonPanel ( )
inlineoverrideprotected

Definition at line 238 of file FxUIRibbon.h.

Member Function Documentation

◆ GetChildren()

virtual CFxUIRibbonRowCollection* CFxUIRibbonPanel::GetChildren ( )
pure virtual

Description: Gets the children of this item.

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

◆ GetKeyTip()

virtual const CFxString& CFxUIRibbonPanel::GetKeyTip ( ) const
pure virtual

Description: Gets the key tip.

Return Value: The key tip.

◆ GetName()

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

Description: Gets the name.

Return Value: The name.

◆ GetText()

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

Description: Gets the text.

Return Value: The text.

◆ IsHiddenInEditor()

virtual bool CFxUIRibbonPanel::IsHiddenInEditor ( ) const
pure virtual

Description: Gets visibility in editor.

Return Value: true if it is hidden, false if not.

◆ SetHiddenInEditor()

virtual void CFxUIRibbonPanel::SetHiddenInEditor ( bool  isHidden)
pure virtual

Description: Sets the visibility in editor. Arguments:

Parameters
isHiddenTrue if invisible in editor, false else.

◆ SetKeyTip()

virtual void CFxUIRibbonPanel::SetKeyTip ( const CFxString keyTip)
pure virtual

Description: Sets a key tip. Arguments:

Parameters
keyTipKeyTip as a string.

◆ SetName()

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

Description: Sets a name. Arguments:

Parameters
strNameName of the string.

◆ SetText()

virtual void CFxUIRibbonPanel::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: