CFx SDK Documentation  2023 SP0
Public Member Functions | Protected Member Functions | List of all members
CFxUITempOverrideKey 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 const CFxStringGetDescription () const =0
 
virtual void SetDescription (const CFxString &description)=0
 
virtual const xFxKeySequenceGetKeySequence () const =0
 
virtual void SetKeySequence (const xFxKeySequence &keySequence)=0
 
virtual const CFxStringGetKeyDownMacro () const =0
 
virtual void SetKeyDownMacro (const CFxString &macro)=0
 
virtual const CFxStringGetKeyUpMacro () const =0
 
virtual void SetKeyUpMacro (const CFxString &macro)=0
 
virtual bool IsObsolete () const =0
 
virtual void SetObsolete (bool bObsolete)=0
 
virtual bool IsRuntime () const =0
 

Protected Member Functions

virtual ~CFxUITempOverrideKey ()
 

Detailed Description

Description: Represents the temporary override key of the user interface. Library: DDKERNEL

Definition at line 2815 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUITempOverrideKey()

virtual CFxUITempOverrideKey::~CFxUITempOverrideKey ( )
inlineprotectedvirtual

Definition at line 2818 of file FxUI.h.

Member Function Documentation

◆ GetDescription()

virtual const CFxString& CFxUITempOverrideKey::GetDescription ( ) const
pure virtual

Description: Gets the description.

Return Value: The description.

◆ GetKeyDownMacro()

virtual const CFxString& CFxUITempOverrideKey::GetKeyDownMacro ( ) const
pure virtual

Description: Gets the key down macro.

Return Value: The key down macro.

◆ GetKeySequence()

virtual const xFxKeySequence& CFxUITempOverrideKey::GetKeySequence ( ) const
pure virtual

Description: Gets the key sequence.

Return Value: The key sequence.

◆ GetKeyUpMacro()

virtual const CFxString& CFxUITempOverrideKey::GetKeyUpMacro ( ) const
pure virtual

Description: Gets the key up macro.

Return Value: The key up macro.

◆ GetName()

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

Description: Gets the name.

Return Value: The name.

◆ GetUID()

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

Description: Gets the uid.

Return Value: The uid.

◆ IsObsolete()

virtual bool CFxUITempOverrideKey::IsObsolete ( ) const
pure virtual

Description: Query if this object is obsolete.

Return Value: true if obsolete, false if not.

◆ IsRuntime()

virtual bool CFxUITempOverrideKey::IsRuntime ( ) const
pure virtual

Description: Query if this object is runtime.

Return Value: true if runtime, false if not.

◆ SetDescription()

virtual void CFxUITempOverrideKey::SetDescription ( const CFxString description)
pure virtual

Description: Sets a description. Arguments:

Parameters
descriptionThe description.

◆ SetKeyDownMacro()

virtual void CFxUITempOverrideKey::SetKeyDownMacro ( const CFxString macro)
pure virtual

Description: Sets a key down macro. Arguments:

Parameters
macroThe macro.

◆ SetKeySequence()

virtual void CFxUITempOverrideKey::SetKeySequence ( const xFxKeySequence keySequence)
pure virtual

Description: Sets a key sequence. Arguments:

Parameters
keySequenceThe key sequence.

◆ SetKeyUpMacro()

virtual void CFxUITempOverrideKey::SetKeyUpMacro ( const CFxString macro)
pure virtual

Description: Sets a key up macro. Arguments:

Parameters
macroThe macro.

◆ SetName()

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

Description: Sets a name. Arguments:

Parameters
nameThe name.

◆ SetObsolete()

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

Description: Sets an obsolete. Arguments:

Parameters
bObsoletetrue to obsolete.

◆ SetUID()

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