CEikControlGroup Class Reference

class CEikControlGroup : public CEikBorderedControl
Public Member Functions
CEikControlGroup()
~CEikControlGroup()
IMPORT_C voidAddControlL(CCoeControl *, TInt)
IMPORT_C voidAddControlL(TEikGroupControl &)
IMPORT_C voidConstructL(TStartCorner, TOrientation)
IMPORT_C CCoeControl *Control(TInt)
IMPORT_C CArrayFix< TEikGroupControl > *ControlArray()
IMPORT_C CCoeControl *ControlById(TInt)
IMPORT_C TIntControlId(CCoeControl *)
IMPORT_C voidControlSpacing(TInt &, TInt &)
IMPORT_C TIntCountComponentControls()
IMPORT_C voidDeleteControl(TInt, TInt)
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C TIntIndexById(TInt)
IMPORT_C voidInsertControlL(TEikGroupControl &, TInt)
IMPORT_C voidLayoutControls()
IMPORT_C TSizeMinimumSize()
IMPORT_C TOrientationOrientation()
IMPORT_C voidReset()
IMPORT_C voidSetBreadthInPixels(TInt)
IMPORT_C voidSetControlLayout(TStartCorner, TOrientation)
IMPORT_C voidSetControlSpacing(TInt, TInt)
IMPORT_C voidSetControlsAllSameSize()
IMPORT_C voidSetLengthInPixels(TInt)
IMPORT_C voidSetNumberOfLines(TInt, TBool)
Protected Member Functions
IMPORT_C CCoeControl *ComponentControl(TInt)
voidSetMSKVisibility(TBool)
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
IMPORT_C TIntAdjacent(TInt, TInt, TInt, TInt, TInt)
IMPORT_C TBoolAllSameSize()
IMPORT_C TIntControlMinimumLength(TInt)
IMPORT_C TSizeControlMinimumSize(TInt)
IMPORT_C voidDeleteAllComponents()
IMPORT_C TBoolDistributeEvenly()
IMPORT_C voidDraw(const TRect &)
IMPORT_C void *ExtensionInterface(TUid)
IMPORT_C TSizeLargestControlSize()
IMPORT_C voidReserved_2()
IMPORT_C voidSizeChanged()
IMPORT_C TStartCornerStartCorner()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
CEikBorderedControl::Border()const
CEikBorderedControl::CEikBorderedControl()
CEikBorderedControl::CEikBorderedControl(const TGulBorder &)
CEikBorderedControl::HasBorder()const
CEikBorderedControl::SetAdjacent(TInt)
CEikBorderedControl::SetBorder(TGulBorder::TBorderType)
CEikBorderedControl::SetBorder(TInt)
Public Member Enumerations
enumTOrientation { ELayHorizontally = SLafControlGroup::ELayHorizontally, ELayVertically = SLafControlGroup::ELayVertically }
enumTStartCorner { EFromTopLeft = SLafControlGroup::EFromTopLeft, EFromTopRight = SLafControlGroup::EFromTopRight, EFromBottomLeft = SLafControlGroup::EFromBottomLeft, EFromBottomRight = SLafControlGroup::EFromBottomRight }
Protected Member Enumerations
enumanonymous { EDistributeEvenly = 0x40, EAllSameSize = 0x80, EDisableMSKDrawing = 0x100 }
Inherited Enumerations
CCoeControl:TZoomType
Protected Attributes
CArrayFix< TEikGroupControl > *iControlArray
Private Attributes
TInt iBreadth
TInt iHSpacing
TSize iLargestControl
TInt iLayout
TInt iLength
TInt iLines
TInt iVSpacing
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder

Constructor & Destructor Documentation

CEikControlGroup()

IMPORT_CCEikControlGroup()

Constructor

~CEikControlGroup()

IMPORT_C~CEikControlGroup()

Destructor

Member Functions Documentation

AddControlL(CCoeControl *, TInt)

IMPORT_C voidAddControlL(CCoeControl *aControl,
TIntaId
)[virtual]

AddControlL() adds a new control to the controlgroup

Parameters

CCoeControl * aControlcontrol to be added
TInt aIdid of the control

AddControlL(TEikGroupControl &)

IMPORT_C voidAddControlL(TEikGroupControl &aGroupControl)[virtual]

AddControlL() adds new control to the controlgroup

Parameters

TEikGroupControl & aGroupControl

Adjacent(TInt, TInt, TInt, TInt, TInt)

IMPORT_C TIntAdjacent(TIntaRow,
TIntaColumn,
TIntaCtrlIndex,
TIntaTotalRows,
TIntaTotalColumns
)const [private]

Parameters

TInt aRow
TInt aColumn
TInt aCtrlIndex
TInt aTotalRows
TInt aTotalColumns

AllSameSize()

IMPORT_C TBoolAllSameSize()[private]

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [protected, virtual]

Parameters

TInt aIndex

ConstructL(TStartCorner, TOrientation)

IMPORT_C voidConstructL(TStartCorneraStart,
TOrientationaOrientation
)

Parameters

TStartCorner aStartcorner to start
TOrientation aOrientationwhether controlgroup is vertical or horizontal

Control(TInt)

IMPORT_C CCoeControl *Control(TIntaIndex)const

Control() returns CCoeControl pointer based on array index

Parameters

TInt aIndexindex to the internal array

ControlArray()

IMPORT_C CArrayFix< TEikGroupControl > *ControlArray()const

ControlArray() access to the actual array representation

ControlById(TInt)

IMPORT_C CCoeControl *ControlById(TIntaId)const

ControlById() fetches individual controls by id

Parameters

TInt aIdid of the control

ControlId(CCoeControl *)

IMPORT_C TIntControlId(CCoeControl *aControl)const

ControlId() finds id of the control based on CCoeCOntrol pointer

Parameters

CCoeControl * aControlcontrol stored in a control group

ControlMinimumLength(TInt)

IMPORT_C TIntControlMinimumLength(TIntaIndex)[private]

Parameters

TInt aIndex

ControlMinimumSize(TInt)

IMPORT_C TSizeControlMinimumSize(TIntaIndex)const [private]

Parameters

TInt aIndex

ControlSpacing(TInt &, TInt &)

IMPORT_C voidControlSpacing(TInt &aHSpacing,
TInt &aVSpacing
)const

ControlSpacing() gets control's spacing modifies variable to get horizontal spacing modifies variable to get vertical spacing

Parameters

TInt & aHSpacing
TInt & aVSpacing

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [virtual]

CountComponentControls returns component controls count

DeleteAllComponents()

IMPORT_C voidDeleteAllComponents()[private]

DeleteControl(TInt, TInt)

IMPORT_C voidDeleteControl(TIntaIndex,
TIntaCount
)

DeleteControl() removes control from the group

Parameters

TInt aIndexat which position of the array to delete
TInt aCounthow many controls to delete

DistributeEvenly()

IMPORT_C TBoolDistributeEvenly()const [private]

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [private, virtual]

From CCoeControl. Draws the border around the control. This function also clears the central area if the IsBlank() method returns ETrue.

From CCoeControl

CCoeControl::IsBlank() Border()

Parameters

const TRect & aRectNot used.

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList)const [virtual]

GetColorUseListL() sets the color use list of the control group

Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Since
ER5U

Parameters

CArrayFix< TCoeColorUse > & aColorUseList

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

HandlePointerEventL() handles touch pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

HandleResourceChange() handles resource change event

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since
ER5U

Parameters

TInt aType

IndexById(TInt)

IMPORT_C TIntIndexById(TIntaId)const

IndexById() gets array index from id

Parameters

TInt aIdid number of the control

InsertControlL(TEikGroupControl &, TInt)

IMPORT_C voidInsertControlL(TEikGroupControl &aGroupControl,
TIntaIndex
)

InsertControlL() inserts a control to specific position

Parameters

TEikGroupControl & aGroupControlcontrol and its id packed to a struct
TInt aIndexindex of the array where new control is to be inserted

LargestControlSize()

IMPORT_C TSizeLargestControlSize()const [private]

LayoutControls()

IMPORT_C voidLayoutControls()

LayoutControls layouts the controls

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

MinimumSize() gets minimumsize

Orientation()

IMPORT_C TOrientationOrientation()const

Orientation orientation of the control group

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

Reset()

IMPORT_C voidReset()

Reset() clears the control array

SetBreadthInPixels(TInt)

IMPORT_C voidSetBreadthInPixels(TIntaBreadth)

SetBreadthInPixels() sets width of the control group

Parameters

TInt aBreadthwidth of the control group

SetControlLayout(TStartCorner, TOrientation)

IMPORT_C voidSetControlLayout(TStartCorneraStart,
TOrientationaOrientation
)

SetControlLayout sets control layout parameters

Parameters

TStartCorner aStartstart corner
TOrientation aOrientationvertical or horizontal orientation

SetControlSpacing(TInt, TInt)

IMPORT_C voidSetControlSpacing(TIntaHSpacing,
TIntaVSpacing
)

SetControlSpacing sets horizontal and vertical spacing

Parameters

TInt aHSpacinghorizontal spacing between controls
TInt aVSpacingvertical spacing between controls

SetControlsAllSameSize()

IMPORT_C voidSetControlsAllSameSize()

SetControlsAllSameSize() sets all controls to be the same size

SetLengthInPixels(TInt)

IMPORT_C voidSetLengthInPixels(TIntaLength)

SetLengthInPixels() sets length of the control group in pixels

Parameters

TInt aLengthlength of the whole control group in pixels

SetMSKVisibility(TBool)

voidSetMSKVisibility(TBoolaEnable)[protected]

Parameters

TBool aEnable

SetNumberOfLines(TInt, TBool)

IMPORT_C voidSetNumberOfLines(TIntaNumLines,
TBoolaDistributeEvenly
)

SetNumberOfLines() sets number of lines of the control group

Parameters

TInt aNumLinesnumber of lines
TBool aDistributeEvenlywhether controls distribute evenly to the group

SizeChanged()

IMPORT_C voidSizeChanged()[private, virtual]

StartCorner()

IMPORT_C TStartCornerStartCorner()const [private]

WriteInternalStateL(RWriteStream &)

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum anonymous

Enumerators

EDistributeEvenly = 0x40
EAllSameSize = 0x80
EDisableMSKDrawing = 0x100

Enum TOrientation

Enumerators

ELayHorizontally = SLafControlGroup::ELayHorizontally
ELayVertically = SLafControlGroup::ELayVertically

Enum TStartCorner

Enumerators

EFromTopLeft = SLafControlGroup::EFromTopLeft
EFromTopRight = SLafControlGroup::EFromTopRight
EFromBottomLeft = SLafControlGroup::EFromBottomLeft
EFromBottomRight = SLafControlGroup::EFromBottomRight

Member Data Documentation

TInt iBreadth

TInt iBreadth[private]

CArrayFix< TEikGroupControl > * iControlArray

CArrayFix< TEikGroupControl > *iControlArray[protected]

TInt iHSpacing

TInt iHSpacing[private]

TSize iLargestControl

TSize iLargestControl[private]

TInt iLayout

TInt iLayout[private]

TInt iLength

TInt iLength[private]

TInt iLines

TInt iLines[private]

TInt iVSpacing

TInt iVSpacing[private]