CEikControlGroup Class Reference

#include <mw/eikctgrp.h>

class CEikControlGroup : public CEikBorderedControl

Inherits from

Protected Attributes
CArrayFix< TEikGroupControl > *iControlArray
Public Member Enumerations
enumTOrientation { ELayHorizontally, ELayVertically }
enumTStartCorner { EFromTopLeft, EFromTopRight, EFromBottomLeft, EFromBottomRight }
Protected Member Enumerations
enumanonymous { EDistributeEvenly, EAllSameSize, EDisableMSKDrawing }
Public Member Functions
CEikControlGroup()
~CEikControlGroup()
virtual IMPORT_C voidAddControlL(CCoeControl *, TInt)
virtual 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 &)
virtual IMPORT_C TIntCountComponentControls()
IMPORT_C voidDeleteControl(TInt, TInt)
virtual IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
virtual IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C TIntIndexById(TInt)
IMPORT_C voidInsertControlL(TEikGroupControl &, TInt)
IMPORT_C voidLayoutControls()
virtual 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
virtual IMPORT_C CCoeControl *ComponentControl(TInt)
voidSetMSKVisibility(TBool)
virtual IMPORT_C voidWriteInternalStateL(RWriteStream &)
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
CEikBorderedControl::iBorder
Inherited Enumerations
CCoeControl:TZoomType
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::CCoeControlArray
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)

Member Attribute Documentation

iControlArray

CArrayFix< TEikGroupControl > *iControlArray[protected]

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
EDistributeEvenly0x40
EAllSameSize0x80
EDisableMSKDrawing0x100

Enum TOrientation

EnumeratorValueDescription
ELayHorizontallySLafControlGroup::ELayHorizontally
ELayVerticallySLafControlGroup::ELayVertically

Enum TStartCorner

EnumeratorValueDescription
EFromTopLeftSLafControlGroup::EFromTopLeft
EFromTopRightSLafControlGroup::EFromTopRight
EFromBottomLeftSLafControlGroup::EFromBottomLeft
EFromBottomRightSLafControlGroup::EFromBottomRight

Constructor & Destructor Documentation

CEikControlGroup ( )

IMPORT_CCEikControlGroup()

Constructor

~CEikControlGroup ( )

IMPORT_C~CEikControlGroup()

Destructor

Member Function Documentation

AddControlL ( CCoeControl *, TInt )

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

AddControlL() adds a new control to the controlgroup

ParameterDescription
aControlcontrol to be added
aIdid of the control

AddControlL ( TEikGroupControl & )

IMPORT_C voidAddControlL(TEikGroupControl &aGroupControl)[virtual]

AddControlL() adds new control to the controlgroup

ComponentControl ( TInt )

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

ConstructL ( TStartCorner, TOrientation )

IMPORT_C voidConstructL(TStartCorneraStart,
TOrientationaOrientation
)
ParameterDescription
aStartcorner to start
aOrientationwhether controlgroup is vertical or horizontal

Control ( TInt )

IMPORT_C CCoeControl *Control(TIntaIndex)const

Control() returns CCoeControl pointer based on array index

ParameterDescription
aIndexindex to the internal array

Returns: control in that position of the array

ControlArray ( )

IMPORT_C CArrayFix< TEikGroupControl > *ControlArray()const

ControlArray() access to the actual array representation

Returns: array

ControlById ( TInt )

IMPORT_C CCoeControl *ControlById(TIntaId)const

ControlById() fetches individual controls by id

ParameterDescription
aIdid of the control

ControlId ( CCoeControl * )

IMPORT_C TIntControlId(CCoeControl *aControl)const

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

ParameterDescription
aControlcontrol stored in a control group

Returns: id of the control

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

CountComponentControls ( )

IMPORT_C TIntCountComponentControls()const [virtual]

CountComponentControls returns component controls count

DeleteControl ( TInt, TInt )

IMPORT_C voidDeleteControl(TIntaIndex,
TIntaCount
)

DeleteControl() removes control from the group

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

GetColorUseListL ( CArrayFix< TCoeColorUse > & )

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

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

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

HandlePointerEventL() handles touch pointer events

HandleResourceChange ( TInt )

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

HandleResourceChange() handles resource change event

IndexById ( TInt )

IMPORT_C TIntIndexById(TIntaId)const

IndexById() gets array index from id

ParameterDescription
aIdid number of the control

Returns: index number to the array

InsertControlL ( TEikGroupControl &, TInt )

IMPORT_C voidInsertControlL(TEikGroupControl &aGroupControl,
TIntaIndex
)

InsertControlL() inserts a control to specific position

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

LayoutControls ( )

IMPORT_C voidLayoutControls()

LayoutControls layouts the controls

MinimumSize ( )

IMPORT_C TSizeMinimumSize()[virtual]

Reimplemented from CCoeControl::MinimumSize()

MinimumSize() gets minimumsize

Orientation ( )

IMPORT_C TOrientationOrientation()const

Orientation orientation of the control group

Returns: either horizontal or vertical orientation

Reset ( )

IMPORT_C voidReset()

Reset() clears the control array

SetBreadthInPixels ( TInt )

IMPORT_C voidSetBreadthInPixels(TIntaBreadth)

SetBreadthInPixels() sets width of the control group

ParameterDescription
aBreadthwidth of the control group

SetControlLayout ( TStartCorner, TOrientation )

IMPORT_C voidSetControlLayout(TStartCorneraStart,
TOrientationaOrientation
)

SetControlLayout sets control layout parameters

ParameterDescription
aStartstart corner
aOrientationvertical or horizontal orientation

SetControlSpacing ( TInt, TInt )

IMPORT_C voidSetControlSpacing(TIntaHSpacing,
TIntaVSpacing
)

SetControlSpacing sets horizontal and vertical spacing

ParameterDescription
aHSpacinghorizontal spacing between controls
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

ParameterDescription
aLengthlength of the whole control group in pixels

SetMSKVisibility ( TBool )

voidSetMSKVisibility(TBoolaEnable)[protected]

SetNumberOfLines ( TInt, TBool )

IMPORT_C voidSetNumberOfLines(TIntaNumLines,
TBoolaDistributeEvenly
)

SetNumberOfLines() sets number of lines of the control group

ParameterDescription
aNumLinesnumber of lines
aDistributeEvenlywhether controls distribute evenly to the group

WriteInternalStateL ( RWriteStream & )

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

Writes the internal state of the control and its components to aWriteStream. Does nothing in release mode.

Designed to be overridden and base called from subclasses.

From CCoeControl

ParameterDescription
aWriteStreamA connected write stream.