Collapse all Symbian^3 Application Developer Library

CEikHotKeyTable Class Reference

class CEikHotKeyTable : public CArrayFixFlat< SEikHotKey >

An array for hotkey commands and their associated key codes and modifiers.

eikcoctl.lib

Since: S60 0.9

Inherits from

CEikHotKeyTable
- CArrayFixFlat< SEikHotKey >
  - CArrayFix
    - CArrayFixBase
      - CBase

Public Member Functions
	CEikHotKeyTable ()
	~CEikHotKeyTable ()
IMPORT_C void	AddItemL ( TInt , TInt , TInt )
IMPORT_C TInt	CommandIdFromHotKey ( TInt , TInt )
IMPORT_C void	ConstructFromResourceL ( TInt )
IMPORT_C TBool	HotKeyFromCommandId ( TInt , TInt &, TInt &)
IMPORT_C void	RemoveItem ( TInt )
IMPORT_C void	Reset ()

Inherited Functions
	CArrayFix< SEikHotKey >::AppendL(const SEikHotKey &)
	CArrayFix< SEikHotKey >::AppendL(const SEikHotKey &,TInt)
	CArrayFix< SEikHotKey >::AppendL(const SEikHotKey *,TInt)
	CArrayFix< SEikHotKey >::Array()const
	CArrayFix< SEikHotKey >::At(TInt)
	CArrayFix< SEikHotKey >::At(TInt)const
	CArrayFix< SEikHotKey >::Back(TInt)
	CArrayFix< SEikHotKey >::Back(TInt)const
	CArrayFix< SEikHotKey >::CArrayFix(TBufRep,TInt)
	CArrayFix< SEikHotKey >::End(TInt)
	CArrayFix< SEikHotKey >::End(TInt)const
	CArrayFix< SEikHotKey >::ExpandL(TInt)
	CArrayFix< SEikHotKey >::ExtendL()
	CArrayFix< SEikHotKey >::Find(const SEikHotKey &,TKeyArrayFix &,TInt &)const
	CArrayFix< SEikHotKey >::FindIsq(const SEikHotKey &,TKeyArrayFix &,TInt &)const
	CArrayFix< SEikHotKey >::InsertIsqAllowDuplicatesL(const SEikHotKey &,TKeyArrayFix &)
	CArrayFix< SEikHotKey >::InsertIsqL(const SEikHotKey &,TKeyArrayFix &)
	CArrayFix< SEikHotKey >::InsertL(TInt,const SEikHotKey &)
	CArrayFix< SEikHotKey >::InsertL(TInt,const SEikHotKey &,TInt)
	CArrayFix< SEikHotKey >::InsertL(TInt,const SEikHotKey *,TInt)
	CArrayFix< SEikHotKey >::ResizeL(TInt)
	CArrayFix< SEikHotKey >::ResizeL(TInt,const SEikHotKey &)
	CArrayFix< SEikHotKey >::operator[](TInt)
	CArrayFix< SEikHotKey >::operator[](TInt)const
	CArrayFixBase::AtR(const CBase *,TInt)
	CArrayFixBase::CArrayFixBase(TBufRep,TInt,TInt)
	CArrayFixBase::Compress()
	CArrayFixBase::Count()const
	CArrayFixBase::CountR(const CBase *)
	CArrayFixBase::Delete(TInt)
	CArrayFixBase::Delete(TInt,TInt)
	CArrayFixBase::Find(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::FindIsq(const TAny *,TKeyArrayFix &,TInt &)const
	CArrayFixBase::InsertIsqAllowDuplicatesL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertIsqL(const TAny *,TKeyArrayFix &)
	CArrayFixBase::InsertL(TInt,const TAny *)
	CArrayFixBase::InsertL(TInt,const TAny *,TInt)
	CArrayFixBase::InsertRepL(TInt,const TAny *,TInt)
	CArrayFixBase::Length()const
	CArrayFixBase::ResizeL(TInt,const TAny *)
	CArrayFixBase::SetKey(TKeyArrayFix &)const
	CArrayFixBase::SetReserveFlatL(TInt)
	CArrayFixBase::Sort(TKeyArrayFix &)
	CArrayFixBase::~CArrayFixBase()
	CArrayFixFlat< SEikHotKey >::CArrayFixFlat(TInt)
	CArrayFixFlat< SEikHotKey >::SetReserveL(TInt)
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
TInt	iNumberCtrl
TInt	iNumberPlain
TInt	iNumberShiftCtrl
TInt	iSpare

Constructor & Destructor Documentation

CEikHotKeyTable()

IMPORT_C

CEikHotKeyTable

(

)

Default C++ constructor.

~CEikHotKeyTable()

IMPORT_C

~CEikHotKeyTable

(

)

Destructor

Member Functions Documentation

AddItemL(TInt, TInt, TInt)

IMPORT_C void	AddItemL	(	TInt	aCommandId,
			TInt	aKeycode,
			TInt	aModifiers
		)

Adds the specified hotkey to the hotkey array.

leave: KErrNotSupported If the specified modifier is not supported

Parameters

TInt aCommandId	The command associated with the hotkey.
TInt aKeycode	The key code used to invoke the command.
TInt aModifiers	Any modifiers used to invoke the command, shift or control for example.

CommandIdFromHotKey(TInt, TInt)

IMPORT_C TInt	CommandIdFromHotKey	(	TInt	aKeycode,
			TInt	aModifiers
		)	const

Gets the command ID associated with the specified key code and modifier.

Parameters

TInt aKeycode	The key code for which the command ID is obtained.
TInt aModifiers	The key modifier for which the command ID is obtained.

ConstructFromResourceL(TInt)

IMPORT_C void

ConstructFromResourceL

(

TInt

aResourceId

)

Constructs an empty array from resource.

Parameters

TInt aResourceId

The ID if the resource reader to use to construct the array.

HotKeyFromCommandId(TInt, TInt &, TInt &)

IMPORT_C TBool	HotKeyFromCommandId	(	TInt	aCommandId,
			TInt &	aKeycode,
			TInt &	aModifiers
		)	const

Gets the hotkey code and modifier for the specified command ID.

Parameters

TInt aCommandId	The ID of the hotkey for which the key code and modifiers are obtained.
TInt & aKeycode	On return, the key code for the specified command ID.
TInt & aModifiers	On return, the modifier for the specified command ID.

RemoveItem(TInt)

IMPORT_C void

RemoveItem

(

TInt

aCommandId

)

Removes the item specified by command ID from the array.

panic: EIKCOCTL-7 If the array contains no hotkeys.

Parameters

TInt aCommandId

The ID of the item to remove.

Reset()

IMPORT_C void

Reset

(

)

Resets the hotkey array.

Member Data Documentation

TInt iNumberCtrl

TInt

iNumberCtrl

[private]

TInt iNumberPlain

TInt

iNumberPlain

[private]

TInt iNumberShiftCtrl

TInt

iNumberShiftCtrl

[private]

TInt iSpare

TInt

iSpare

[private]