CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
CFxUITempOverrideKeysCollection Class Referenceabstract

#include <FxUI.h>

Public Member Functions

virtual ~CFxUITempOverrideKeysCollection ()
 
virtual bool Add (CFxUITempOverrideKey *pItem)=0
 
virtual bool Remove (CFxUITempOverrideKey *pItem)=0
 
virtual unsigned int GetCount () const =0
 
virtual CFxUITempOverrideKeyGetItem (const xFxKeySequence &keySequence)=0
 
virtual CFxUITempOverrideKeyGetItem (unsigned int index)=0
 

Detailed Description

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

Definition at line 1655 of file FxUI.h.

Constructor & Destructor Documentation

◆ ~CFxUITempOverrideKeysCollection()

virtual CFxUITempOverrideKeysCollection::~CFxUITempOverrideKeysCollection ( )
inlinevirtual

Definition at line 1658 of file FxUI.h.

Member Function Documentation

◆ Add()

virtual bool CFxUITempOverrideKeysCollection::Add ( CFxUITempOverrideKey pItem)
pure virtual

Description: Adds pItem.. Arguments:

Parameters
[in,out]pItemIf non-null, the CFxUITempOverrideKey* to add.

Return Value: true if it succeeds, false if it fails.

◆ GetCount()

virtual unsigned int CFxUITempOverrideKeysCollection::GetCount ( ) const
pure virtual

Description: Gets the count.

Return Value: The count.

◆ GetItem() [1/2]

virtual CFxUITempOverrideKey* CFxUITempOverrideKeysCollection::GetItem ( const xFxKeySequence keySequence)
pure virtual

Description: Gets an item. Arguments:

Parameters
keySequenceThe key sequence.

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

◆ GetItem() [2/2]

virtual CFxUITempOverrideKey* CFxUITempOverrideKeysCollection::GetItem ( unsigned int  index)
pure virtual

Description: Gets an item. Arguments:

Parameters
indexZero-based index of the.

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

◆ Remove()

virtual bool CFxUITempOverrideKeysCollection::Remove ( CFxUITempOverrideKey pItem)
pure virtual

Description: Removes the given pItem. Arguments:

Parameters
[in,out]pItemIf non-null, the CFxUITempOverrideKey* to remove.

Return Value: true if it succeeds, false if it fails.


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