Symbian^3 Application Developer Library >

CAknTasHook Class Reference

class CAknTasHook : public CCoeStatic

Storage class for storing information about all UI objects

Since
S60 5.1

Inherits from

Public Member Functions
~CAknTasHook ()
void AddInfoL ( TAny *, TPtrC , TAknTasHookObjectType )
IMPORT_C void AddL ( TAny *, TPtrC , TAknTasHookObjectType )
void ConstructL ()
CCenRepNotifyHandler * CreateNotifyHandlerL ( CRepository &, TUint32 )
TBool ExistsL ( TAny *)
IMPORT_C CAknTasObjectInfo * Get ( TAny *)
IMPORT_C void GetAknUiLC ( MTasObject &)
IMPORT_C RPointerArray < CAknTasObjectInfo > * GetAll ()
CAknTasObjectInfo * GetInfo ( TAny *)
void HandleNotifyInt ( TUint32 , TInt )
TBool InfoExistsL ( TAny *)
TBool Initialized ()
CAknTasHook * InstanceL ()
IMPORT_C void Remove ( TAny *)
void RemoveInfoL ( TAny *)
CAknTasHook * Self ()
Private Member Functions
CAknTasHook ()
void AddCommonCoeInfoL ( CCoeControl *, MTasObject &)
TBool CheckSanityL ( CCoeControl *)
Inherited Functions
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()
CCoeStatic::CCoeStatic()
CCoeStatic::CCoeStatic(TUid,TInt,TScope)
CCoeStatic::CCoeStatic(TUid,TScope)
CCoeStatic::~CCoeStatic()
Inherited Enumerations
CCoeStatic:@63
CCoeStatic:TScope
Private Attributes
CCenRepNotifyHandler * iHookStoringNotifyHandler
CCenRepNotifyHandler * iHookingNotifyHandler
RPointerArray < CAknTasObjectInfo > * iObjectInfoArray
TBool iTasHookStoringEnabled
TBool iTasHookingEnabled
CRepository * iTasHookingRepo
CAknTasPluginInterface * iTasPlugin

Constructor & Destructor Documentation

CAknTasHook()

CAknTasHook ( ) [private]

~CAknTasHook()

~CAknTasHook ( )

Member Functions Documentation

AddCommonCoeInfoL(CCoeControl *, MTasObject &)

void AddCommonCoeInfoL ( CCoeControl * aObjPtr,
MTasObject & aObjectInfo
) [private]

Parameters

CCoeControl * aObjPtr
MTasObject & aObjectInfo

AddInfoL(TAny *, TPtrC, TAknTasHookObjectType)

void AddInfoL ( TAny * aObjPtr,
TPtrC aStrPtr,
TAknTasHookObjectType aObjType
)

Parameters

TAny * aObjPtr
TPtrC aStrPtr
TAknTasHookObjectType aObjType

AddL(TAny *, TPtrC, TAknTasHookObjectType)

IMPORT_C void AddL ( TAny * aObjPtr,
TPtrC aStrPtr,
TAknTasHookObjectType aObjType = EAknHookTypeAvkon
) [static]

Interface for adding an object (hook) to the object info data structure. This is a class function and can be conveniently used from the helper macros.

TAknTasHookObjectType

Parameters

TAny * aObjPtr Pointer to the added object
TPtrC aStrPtr Added object class name
TAknTasHookObjectType aObjType = EAknHookTypeAvkon Type of the hooked object, default EAknHookTypeAvkon

CheckSanityL(CCoeControl *)

TBool CheckSanityL ( CCoeControl * aCcontrol ) [private]

Parameters

CCoeControl * aCcontrol

ConstructL()

void ConstructL ( )

CreateNotifyHandlerL(CRepository &, TUint32)

CCenRepNotifyHandler * CreateNotifyHandlerL ( CRepository & aRepository,
TUint32 aKey
)

Parameters

CRepository & aRepository
TUint32 aKey

ExistsL(TAny *)

TBool ExistsL ( TAny * aObjPtr ) [static]

Parameters

TAny * aObjPtr

Get(TAny *)

IMPORT_C CAknTasObjectInfo * Get ( TAny * aObjPtr ) [static]

Interface for getting a stored object (hook) information from the object info data structure. This is a class function.

CAknTasObjectInfo

Parameters

TAny * aObjPtr Pointer to the object whose info to get

GetAknUiLC(MTasObject &)

IMPORT_C void GetAknUiLC ( MTasObject & aParentApplication )

Add avkon internal details to the provided tas model object. In most cases the object given represents the application being traversed.

Parameters

MTasObject & aParentApplication The object where to add the internal data

GetAll()

IMPORT_C RPointerArray < CAknTasObjectInfo > * GetAll ( )

Interface for getting all stored objects' (hooks') information from the object info data structure.

RPointerArray CAknTasObjectInfo

GetInfo(TAny *)

CAknTasObjectInfo * GetInfo ( TAny * aObjPtr )

Parameters

TAny * aObjPtr

HandleNotifyInt(TUint32, TInt)

void HandleNotifyInt ( TUint32 aId,
TInt aNewValue
)

Parameters

TUint32 aId
TInt aNewValue

InfoExistsL(TAny *)

TBool InfoExistsL ( TAny * aObjPtr )

Parameters

TAny * aObjPtr

Initialized()

TBool Initialized ( )

InstanceL()

CAknTasHook * InstanceL ( ) [static]

Remove(TAny *)

IMPORT_C void Remove ( TAny * aObjPtr ) [static]

Interface for removing an object (hook) from the object info data structure. This is a class function and can be conveniently used from the helper macros.

Parameters

TAny * aObjPtr Pointer to the object to be removed

RemoveInfoL(TAny *)

void RemoveInfoL ( TAny * aObjPtr )

Parameters

TAny * aObjPtr

Self()

CAknTasHook * Self ( ) [static]

Member Data Documentation

CCenRepNotifyHandler * iHookStoringNotifyHandler

CCenRepNotifyHandler * iHookStoringNotifyHandler [private]

CCenRepNotifyHandler * iHookingNotifyHandler

CCenRepNotifyHandler * iHookingNotifyHandler [private]

RPointerArray< CAknTasObjectInfo > * iObjectInfoArray

RPointerArray < CAknTasObjectInfo > * iObjectInfoArray [private]

TBool iTasHookStoringEnabled

TBool iTasHookStoringEnabled [private]

TBool iTasHookingEnabled

TBool iTasHookingEnabled [private]

CRepository * iTasHookingRepo

CRepository * iTasHookingRepo [private]

CAknTasPluginInterface * iTasPlugin

CAknTasPluginInterface * iTasPlugin [private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.