CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
CFxUIRibbonCommandButton Class Referenceabstract

#include <FxUIRibbon.h>

Inheritance diagram for CFxUIRibbonCommandButton:
CFxUIRibbonRowItem CFxUIRibbonItem

Public Member Functions

virtual RibbonButtonStyle GetButtonStyle () const =0
 
virtual void SetButtonStyle (RibbonButtonStyle buttonStyle)=0
 
virtual const CFxStringGetKeyTip () const =0
 
virtual void SetKeyTip (const CFxString &keyTip)=0
 
virtual CFxUIItemDefinitionGetDefinition ()=0
 
virtual void SetDefinition (CFxUIItemDefinition *def)=0
 
- Public Member Functions inherited from CFxUIRibbonRowItem
virtual const CFxStringGetText () const =0
 
virtual void SetText (const CFxString &text)=0
 
virtual const CFxStringGetClassID () const =0
 
virtual void SetClassID (const CFxString &classID)=0
 
- Public Member Functions inherited from CFxUIRibbonItem
virtual const CFxStringGetUID () const =0
 
virtual RibbonItemType GetType () const =0
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from CFxUIRibbonRowItem
enum  _RibbonButtonStyle {
  eButtonStyleUnknown , eButtonStyleLargeWithText , eButtonStyleLargeWithoutText , eButtonStyleSmallWithText ,
  eButtonStyleSmallWithoutText
}
 
enum  _RibbonSplitButtonBehavior {
  eSplitButtonBehaviorUnknown , eSplitButtonBehaviorSplitNoFollow , eSplitButtonBehaviorSplitFollow , eSplitButtonBehaviorSplitFollowStaticText ,
  eSplitButtonBehaviorDropDownFollow , eSplitButtonBehaviorDropDownNoFollow
}
 
enum  _RibbonSplitButtonListStyle { eSplitButtonListStyleUnknown , eSplitButtonListStyleIcon , eSplitButtonListStyleIconText , eSplitButtonListStyleDescriptive }
 
enum  _RibbonSeparatorStyle { eSeparatorStyleUnknown , eSeparatorStyleLine , eSeparatorStyleSpacer }
 
enum  _RibbonGalleryControlDisplayMode { eGalleryControlDisplayModeUnknown , eGalleryControlDisplayModeCombobox , eGalleryControlDisplayModeWindow }
 
enum  _RibbonDataBoundDropDownListStyle { eDataBoundDropDownListStyleUnknown , eDataBoundDropDownListStyleIcon , eDataBoundDropDownListStyleIconText , eDataBoundDropDownListStyleDescriptive }
 
typedef enum CFxUIRibbonRowItem::_RibbonButtonStyle RibbonButtonStyle
 
typedef enum CFxUIRibbonRowItem::_RibbonSplitButtonBehavior RibbonSplitButtonBehavior
 
typedef enum CFxUIRibbonRowItem::_RibbonSplitButtonListStyle RibbonSplitButtonListStyle
 
typedef enum CFxUIRibbonRowItem::_RibbonSeparatorStyle RibbonSeparatorStyle
 
typedef enum CFxUIRibbonRowItem::_RibbonGalleryControlDisplayMode RibbonGalleryControlDisplayMode
 
typedef enum CFxUIRibbonRowItem::_RibbonDataBoundDropDownListStyle RibbonDataBoundDropDownListStyle
 
- 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 422 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonCommandButton()

CFxUIRibbonCommandButton::~CFxUIRibbonCommandButton ( )
inlineoverrideprotected

Definition at line 425 of file FxUIRibbon.h.

Member Function Documentation

◆ GetButtonStyle()

virtual RibbonButtonStyle CFxUIRibbonCommandButton::GetButtonStyle ( ) const
pure virtual

Description: Gets the button style.

Return Value: The style.

◆ GetDefinition()

virtual CFxUIItemDefinition* CFxUIRibbonCommandButton::GetDefinition ( )
pure virtual

Description: Gets the definition.

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

◆ GetKeyTip()

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

Description: Gets the key tip.

Return Value: The key tip.

◆ SetButtonStyle()

virtual void CFxUIRibbonCommandButton::SetButtonStyle ( RibbonButtonStyle  buttonStyle)
pure virtual

Description: Sets the button style. Arguments:

Parameters
buttonStyleThe button style.

◆ SetDefinition()

virtual void CFxUIRibbonCommandButton::SetDefinition ( CFxUIItemDefinition def)
pure virtual

Description: Sets a definition. Arguments:

Parameters
[in,out]pDefinitionIf non-null, the definition.

◆ SetKeyTip()

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

Description: Sets a key tip. Arguments:

Parameters
keyTipKeyTip as a string.

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