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

#include <FxUI.h>

Public Member Functions

virtual const CFxStringGetUID () const =0
 
virtual void SetUID (const CFxString &strUID)=0
 
virtual const CFxStringGetName () const =0
 
virtual void SetName (const CFxString &name)=0
 
virtual void SetDefinition (CFxUIItemDefinition *pDefinition)=0
 
virtual CFxUIItemDefinitionGetDefinition ()=0
 
virtual int GetButtonNumber () const =0
 
virtual bool IsObsolete () const =0
 
virtual void SetObsolete (bool bObsolete)=0
 
virtual bool IsRuntime () const =0
 

Protected Member Functions

virtual ~CFxUIButton ()
 

Detailed Description

Description: Represents the user interface button. Library: DDKERNEL

Definition at line 2624 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUIButton()

virtual CFxUIButton::~CFxUIButton ( )
inlineprotectedvirtual

Definition at line 2627 of file FxUI.h.

Member Function Documentation

◆ GetButtonNumber()

virtual int CFxUIButton::GetButtonNumber ( ) const
pure virtual

Description: Gets the button number.

Return Value: The button number.

◆ GetDefinition()

virtual CFxUIItemDefinition* CFxUIButton::GetDefinition ( )
pure virtual

Description: Gets the definition.

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

◆ GetName()

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

Description: Gets the name.

Return Value: The name.

◆ GetUID()

virtual const CFxString& CFxUIButton::GetUID ( ) const
pure virtual

Description: Gets the uid.

Return Value: The uid.

◆ IsObsolete()

virtual bool CFxUIButton::IsObsolete ( ) const
pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

◆ IsRuntime()

virtual bool CFxUIButton::IsRuntime ( ) const
pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

◆ SetDefinition()

virtual void CFxUIButton::SetDefinition ( CFxUIItemDefinition pDefinition)
pure virtual

Description: Sets a definition. Arguments:

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

◆ SetName()

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

Description: Sets a name. Arguments:

Parameters
nameThe name.

◆ SetObsolete()

virtual void CFxUIButton::SetObsolete ( bool  bObsolete)
pure virtual

Description: Sets an obsolete. Arguments:

Parameters
bObsoletetrue to obsolete.

◆ SetUID()

virtual void CFxUIButton::SetUID ( const CFxString strUID)
pure virtual

Description: Sets a uid. Arguments:

Parameters
strUIDThe string uid.

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