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

#include <FxUIRibbon.h>

Inheritance diagram for CFxUIRibbonSplitButton:
CFxUIRibbonRowItem CFxUIRibbonItem

Public Member Functions

virtual const CFxStringGetKeyTip () 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 CFxStringGetDarkIconInfo (CFxString &iconResource) const =0
 
virtual void SetDarkIconInfo (const CFxString &iconName, const CFxString &iconResource)=0
 
virtual const CFxStringGetLightIconInfo (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 CFxUIRibbonSplitButtonItemCollectionGetChildren ()=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

 ~CFxUIRibbonSplitButton () 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 471 of file FxUIRibbon.h.

Constructor & Destructor Documentation

◆ ~CFxUIRibbonSplitButton()

CFxUIRibbonSplitButton::~CFxUIRibbonSplitButton ( )
inlineoverrideprotected

Definition at line 474 of file FxUIRibbon.h.

Member Function Documentation

◆ GetBehavior()

virtual RibbonSplitButtonBehavior CFxUIRibbonSplitButton::GetBehavior ( ) const
pure virtual

Description: Gets the behavior.

Return Value: The behavior.

◆ GetButtonStyle()

virtual RibbonButtonStyle CFxUIRibbonSplitButton::GetButtonStyle ( ) const
pure virtual

Description: Gets the button style.

Return Value: The style.

◆ GetChildren()

virtual CFxUIRibbonSplitButtonItemCollection* CFxUIRibbonSplitButton::GetChildren ( )
pure virtual

Description: Gets the children of this item. Return Value: null if it fails, else the children.

◆ GetDarkIcon()

virtual QIcon& CFxUIRibbonSplitButton::GetDarkIcon ( int  iSize)
pure virtual

Description: Gets the dark theme SVG icon.

Return Value: The dark theme SVG icon.

◆ GetDarkIconInfo()

virtual const CFxString& CFxUIRibbonSplitButton::GetDarkIconInfo ( CFxString iconResource) const
pure virtual

Description: Gets a dark theme SVG icon information. Arguments:

Parameters
[in,out]iconResourceThe icon resource.

Return Value: The dark theme SVG icon information.

◆ GetIcon()

virtual QIcon& CFxUIRibbonSplitButton::GetIcon ( int  iSize)
pure virtual

Description: Gets the icon.

Return Value: The icon.

◆ GetKeyTip()

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

Description: Gets the key tip.

Return Value: The key tip.

◆ GetLightIcon()

virtual QIcon& CFxUIRibbonSplitButton::GetLightIcon ( int  iSize)
pure virtual

Description: Gets the light theme SVG icon.

Return Value: The light theme SVG icon.

◆ GetLightIconInfo()

virtual const CFxString& CFxUIRibbonSplitButton::GetLightIconInfo ( CFxString iconResource) const
pure virtual

Description: Gets a light theme SVG icon information. Arguments:

Parameters
[in,out]iconResourceThe icon resource.

Return Value: The light theme SVG icon information.

◆ GetListStyle()

virtual RibbonSplitButtonListStyle CFxUIRibbonSplitButton::GetListStyle ( ) const
pure virtual

Description: Gets the list style.

Return Value: The list style.

◆ IsGrouping()

virtual const bool CFxUIRibbonSplitButton::IsGrouping ( ) const
pure virtual

Description: Gets grouping value.

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

◆ SetBehavior()

virtual void CFxUIRibbonSplitButton::SetBehavior ( RibbonSplitButtonBehavior  behavior)
pure virtual

Description: Sets the behavior. Arguments:

Parameters
behaviorThe behavior.

◆ SetButtonStyle()

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

Description: Sets the button style. Arguments:

Parameters
buttonStyleThe button style.

◆ SetDarkIconInfo()

virtual void CFxUIRibbonSplitButton::SetDarkIconInfo ( const CFxString iconName,
const CFxString iconResource 
)
pure virtual

Description: Sets a dark theme SVG icon information. Arguments:

Parameters
iconNameName of the icon.
iconResourceThe dark theme SVG icon resource.

◆ SetGrouping()

virtual void CFxUIRibbonSplitButton::SetGrouping ( const bool  grouping)
pure virtual

Description: Sets the grouping value. Arguments:

Parameters
groupingTrue if it is grouping, false else.

◆ SetKeyTip()

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

Description: Sets a key tip. Arguments:

Parameters
keyTipKeyTip as a string.

◆ SetLightIconInfo()

virtual void CFxUIRibbonSplitButton::SetLightIconInfo ( const CFxString iconName,
const CFxString iconResource 
)
pure virtual

Description: Sets a light theme SVG icon information. Arguments:

Parameters
iconNameName of the icon.
iconResourceThe icon resource.

◆ SetListStyle()

virtual void CFxUIRibbonSplitButton::SetListStyle ( RibbonSplitButtonListStyle  listStyle)
pure virtual

Description: Sets the list style. Arguments:

Parameters
listStyleThe list style.

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