CCoeControlArray Class Reference

class CCoeControlArray : public CBase

Class that represents an array of controls.

The CCoeControlArray class is used to store the child controls of a container control. The method CCoeControl::InitComponentArrayL() must be used to create the array and the method CCoeControlArray& CCoeControl::Components() can be used to get this array.

Inherits from

Nested Classes and Structures

Public Member Functions
~CCoeControlArray()
IMPORT_C TCursorAppendLC(CCoeControl *, TInt)
IMPORT_C TCoeControlWithIdAt(TInt)
IMPORT_C const TCoeControlWithIdAt(TInt)
IMPORT_C TCursorBegin()
T *ControlById(TInt)
const T *ControlById(TInt)
IMPORT_C TBoolControlsOwnedExternally()
IMPORT_C TIntCount()
IMPORT_C TCursorEnd()
IMPORT_C TCursorFind(const CCoeControl *)
IMPORT_C TCursorFind(TInt)
IMPORT_C TIntId(const CCoeControl &)
IMPORT_C TCursorInsertAfterLC(TInt, CCoeControl *, TInt)
IMPORT_C TCursorInsertLC(TCursor &, CCoeControl *, TInt)
IMPORT_C TBoolIsArrayLocked()
IMPORT_C CCoeControlArray *NewL(CCoeControl &)
IMPORT_C TIntRemove(const CCoeControl *)
IMPORT_C CCoeControl *Remove(TCursor)
IMPORT_C CCoeControl *RemoveById(TInt)
IMPORT_C TIntReplace(CCoeControl *, CCoeControl *)
IMPORT_C voidReset()
IMPORT_C voidResetAndDestroy()
IMPORT_C voidSetArrayLocked()
IMPORT_C voidSetControlsOwnedExternally(TBool)
IMPORT_C voidSort(TLinearOrder< TCoeControlWithId >)
IMPORT_C voidSortById()
Private Member Functions
CCoeControlArray(CCoeControl &)
IMPORT_C CCoeControl *CtrlById(TInt)
TInt IndexById(TInt)
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()
Public Member Enumerations
enumTEvent { EControlAdded, EControlRemoved }
Private Attributes
RArray< TCoeControlWithId >iControls
TInt iFlags
CCoeControl &iOwner

Constructor & Destructor Documentation

CCoeControlArray(CCoeControl &)

IMPORT_CCCoeControlArray(CCoeControl &aOwner)[private]

Parameters

CCoeControl & aOwner

~CCoeControlArray()

IMPORT_C~CCoeControlArray()

Member Functions Documentation

AppendLC(CCoeControl *, TInt)

IMPORT_C TCursorAppendLC(CCoeControl *aControl,
TIntaControlId =  KCoeNoControlId
)

Parameters

CCoeControl * aControl
TInt aControlId =  KCoeNoControlId

At(TInt)

IMPORT_C TCoeControlWithIdAt(TIntaIndex)

Parameters

TInt aIndex

At(TInt)

IMPORT_C const TCoeControlWithIdAt(TIntaIndex)const

Parameters

TInt aIndex

Begin()

IMPORT_C TCursorBegin()const

ControlById(TInt)

T *ControlById(TIntaControlId)[inline]

Gets the control with the given id. The control with the given id.

Parameters

TInt aControlIdThe id of the desired control.

ControlById(TInt)

const T *ControlById(TIntaControlId)const [inline]

Gets the control with the given id. The control with the given id.

Parameters

TInt aControlIdThe id of the desired control.

ControlsOwnedExternally()

IMPORT_C TBoolControlsOwnedExternally()const

Count()

IMPORT_C TIntCount()const

CtrlById(TInt)

IMPORT_C CCoeControl *CtrlById(TIntaControlId)const [private]

Parameters

TInt aControlId

End()

IMPORT_C TCursorEnd()const

Find(const CCoeControl *)

IMPORT_C TCursorFind(const CCoeControl *aControl)const

Parameters

const CCoeControl * aControl

Find(TInt)

IMPORT_C TCursorFind(TIntaControlId)const

Parameters

TInt aControlId

Id(const CCoeControl &)

IMPORT_C TIntId(const CCoeControl &aControl)const

Parameters

const CCoeControl & aControl

IndexById(TInt)

TInt IndexById(TIntaControlId)const [private]

Parameters

TInt aControlId

InsertAfterLC(TInt, CCoeControl *, TInt)

IMPORT_C TCursorInsertAfterLC(TIntaInsertAfterId,
CCoeControl *aControl,
TIntaControlId =  KCoeNoControlId
)

Parameters

TInt aInsertAfterId
CCoeControl * aControl
TInt aControlId =  KCoeNoControlId

InsertLC(TCursor &, CCoeControl *, TInt)

IMPORT_C TCursorInsertLC(TCursor &aInsertAt,
CCoeControl *aControl,
TIntaControlId =  KCoeNoControlId
)

Parameters

TCursor & aInsertAt
CCoeControl * aControl
TInt aControlId =  KCoeNoControlId

IsArrayLocked()

IMPORT_C TBoolIsArrayLocked()const

NewL(CCoeControl &)

IMPORT_C CCoeControlArray *NewL(CCoeControl &aOwner)[static]

Parameters

CCoeControl & aOwner

Remove(const CCoeControl *)

IMPORT_C TIntRemove(const CCoeControl *aControl)

Parameters

const CCoeControl * aControl

Remove(TCursor)

IMPORT_C CCoeControl *Remove(TCursoraRemoveAt)

Parameters

TCursor aRemoveAt

RemoveById(TInt)

IMPORT_C CCoeControl *RemoveById(TIntaControlId)

Parameters

TInt aControlId

Replace(CCoeControl *, CCoeControl *)

IMPORT_C TIntReplace(CCoeControl *aOriginalControl,
CCoeControl *aNewControl
)

Parameters

CCoeControl * aOriginalControl
CCoeControl * aNewControl

Reset()

IMPORT_C voidReset()

ResetAndDestroy()

IMPORT_C voidResetAndDestroy()

SetArrayLocked()

IMPORT_C voidSetArrayLocked()

SetControlsOwnedExternally(TBool)

IMPORT_C voidSetControlsOwnedExternally(TBoolaOwnedExternally)

Parameters

TBool aOwnedExternally

Sort(TLinearOrder< TCoeControlWithId >)

IMPORT_C voidSort(TLinearOrder< TCoeControlWithId >aOrder)

Parameters

TLinearOrder< TCoeControlWithId > aOrder

SortById()

IMPORT_C voidSortById()

Member Enumerations Documentation

Enum TEvent

Defines the possible events related to a change to the contents of the array.

Enumerators

EControlAdded

A control has been added to the array

EControlRemoved

A control has been removed from the array

Member Data Documentation

RArray< TCoeControlWithId > iControls

RArray< TCoeControlWithId >iControls[private]

TInt iFlags

TInt iFlags[private]

CCoeControl & iOwner

CCoeControl &iOwner[private]
© Nokia 2010.