CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | Protected Member Functions | List of all members
CFxUIRibbonRowItem Class Referenceabstract

#include <FxUIRibbon.h>

Inheritance diagram for CFxUIRibbonRowItem:
CFxUIRibbonItem CFxUIRibbonButton CFxUIRibbonCommandButton CFxUIRibbonControl CFxUIRibbonDataBoundDropDown CFxUIRibbonGalleryControl CFxUIRibbonRowPanel CFxUIRibbonSeparator CFxUIRibbonSplitButton CFxUIRibbonToggleButton

Public Types

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
 

Public Member Functions

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

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

Detailed Description

Definition at line 320 of file FxUIRibbon.h.

Member Typedef Documentation

◆ RibbonButtonStyle

Description: Values that represent _RibbonButtonStyle for possible button styles.

◆ RibbonDataBoundDropDownListStyle

Description: Values that represent _RibbonDataBoundDropDownListStyle for possible list styles.

◆ RibbonGalleryControlDisplayMode

Description: Values that represent _RibbonGalleryControlDisplayMode for possible display modes.

◆ RibbonSeparatorStyle

Description: Values that represent _RibbonSeparatorStyle for possible separator styles.

◆ RibbonSplitButtonBehavior

Description: Values that represent _RibbonSplitButtonBehavior for possible behaviors.

◆ RibbonSplitButtonListStyle

Description: Values that represent _RibbonSplitButtonListStyle for possible list styles.

Member Enumeration Documentation

◆ _RibbonButtonStyle

Description: Values that represent _RibbonButtonStyle for possible button styles.

Enumerator
eButtonStyleUnknown 
eButtonStyleLargeWithText 
eButtonStyleLargeWithoutText 
eButtonStyleSmallWithText 
eButtonStyleSmallWithoutText 

Definition at line 329 of file FxUIRibbon.h.

◆ _RibbonDataBoundDropDownListStyle

Description: Values that represent _RibbonDataBoundDropDownListStyle for possible list styles.

Enumerator
eDataBoundDropDownListStyleUnknown 
eDataBoundDropDownListStyleIcon 
eDataBoundDropDownListStyleIconText 
eDataBoundDropDownListStyleDescriptive 

Definition at line 386 of file FxUIRibbon.h.

◆ _RibbonGalleryControlDisplayMode

Description: Values that represent _RibbonGalleryControlDisplayMode for possible display modes.

Enumerator
eGalleryControlDisplayModeUnknown 
eGalleryControlDisplayModeCombobox 
eGalleryControlDisplayModeWindow 

Definition at line 375 of file FxUIRibbon.h.

◆ _RibbonSeparatorStyle

Description: Values that represent _RibbonSeparatorStyle for possible separator styles.

Enumerator
eSeparatorStyleUnknown 
eSeparatorStyleLine 
eSeparatorStyleSpacer 

Definition at line 365 of file FxUIRibbon.h.

◆ _RibbonSplitButtonBehavior

Description: Values that represent _RibbonSplitButtonBehavior for possible behaviors.

Enumerator
eSplitButtonBehaviorUnknown 
eSplitButtonBehaviorSplitNoFollow 
eSplitButtonBehaviorSplitFollow 
eSplitButtonBehaviorSplitFollowStaticText 
eSplitButtonBehaviorDropDownFollow 
eSplitButtonBehaviorDropDownNoFollow 

Definition at line 341 of file FxUIRibbon.h.

◆ _RibbonSplitButtonListStyle

Description: Values that represent _RibbonSplitButtonListStyle for possible list styles.

Enumerator
eSplitButtonListStyleUnknown 
eSplitButtonListStyleIcon 
eSplitButtonListStyleIconText 
eSplitButtonListStyleDescriptive 

Definition at line 354 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonRowItem()

CFxUIRibbonRowItem::~CFxUIRibbonRowItem ( )
inlineoverrideprotected

Definition at line 323 of file FxUIRibbon.h.

Member Function Documentation

◆ GetClassID()

virtual const CFxString& CFxUIRibbonRowItem::GetClassID ( ) const
pure virtual

Description: Gets the class ID.

Return Value: The class ID.

◆ GetText()

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

Description: Gets the text.

Return Value: The text.

◆ SetClassID()

virtual void CFxUIRibbonRowItem::SetClassID ( const CFxString classID)
pure virtual

Description: Sets a class ID. Arguments:

Parameters
classIDClass ID of the string.

◆ SetText()

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