CEikControlGroup Class Reference

API published in: S60 1st Ed

Link against: eikdlg.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikctgrp.h>


Public Types
enum �	TStartCorner { EFromTopLeft = SLafControlGroup::EFromTopLeft, EFromTopRight = SLafControlGroup::EFromTopRight, EFromBottomLeft = SLafControlGroup::EFromBottomLeft, EFromBottomRight = SLafControlGroup::EFromBottomRight }
enum �	TOrientation { ELayHorizontally = SLafControlGroup::ELayHorizontally, ELayVertically = SLafControlGroup::ELayVertically }
Public Member Functions
IMPORT_C�	CEikControlGroup ()
IMPORT_C�	~CEikControlGroup ()
IMPORT_C void�	ConstructL (TStartCorner aStart, TOrientation aOrientation)
virtual IMPORT_C void�	AddControlL (CCoeControl *aControl, TInt aId)
virtual IMPORT_C void�	AddControlL (TEikGroupControl &aGroupControl)
IMPORT_C void�	InsertControlL (TEikGroupControl &aGroupControl, TInt aIndex)
IMPORT_C void�	DeleteControl (TInt aIndex, TInt aCount)
IMPORT_C void�	SetLengthInPixels (TInt aLength)
IMPORT_C void�	SetBreadthInPixels (TInt aBreadth)
IMPORT_C void�	SetControlSpacing (TInt aHSpacing, TInt aVSpacing)
IMPORT_C void�	SetControlLayout (TStartCorner aStart, TOrientation aOrientation)
IMPORT_C void�	SetNumberOfLines (TInt aNumLines, TBool aDistributeEvenly)
IMPORT_C void�	SetControlsAllSameSize ()
IMPORT_C void�	LayoutControls ()
IMPORT_C CCoeControl *�	ControlById (TInt aId) const
IMPORT_C TInt�	IndexById (TInt aId) const
IMPORT_C void�	Reset ()
IMPORT_C TInt�	ControlId (CCoeControl *aControl) const
IMPORT_C CCoeControl *�	Control (TInt aIndex) const
IMPORT_C CArrayFix< TEikGroupControl > *�	ControlArray () const
IMPORT_C TOrientation�	Orientation () const
IMPORT_C void�	ControlSpacing (TInt &aHSpacing, TInt &aVSpacing) const
IMPORT_C TSize�	MinimumSize ()
IMPORT_C TInt�	CountComponentControls () const
virtual IMPORT_C void�	GetColorUseListL (CArrayFix< TCoeColorUse > &aColorUseList) const
�	Not used in S60.
virtual IMPORT_C void�	HandleResourceChange (TInt aType)
�	Handles a change to the control's resources.
IMPORT_C void�	HandlePointerEventL (const TPointerEvent &aPointerEvent)
�	Handles pointer events.
Protected Types
enum �	{ EDistributeEvenly = 0x40, EAllSameSize = 0x80, EDisableMSKDrawing = 0x100 }
Protected Member Functions
IMPORT_C CCoeControl *�	ComponentControl (TInt aIndex) const
IMPORT_C void�	WriteInternalStateL (RWriteStream &aWriteStream) const
�	Writes the internal state of the control and its components to `aWriteStream`.
void�	SetMSKVisibility (TBool aEnable)
�	Public Since 3rd Ed FP1 only used from CEikCba.
Protected Attributes
CArrayFix< TEikGroupControl > *�	iControlArray
Friends
class�	CTestControlGroup
class�	CEikCba

Member Enumeration Documentation

anonymous enum [protected]

�

Enumerator:

EDistributeEvenly�
EAllSameSize�
EDisableMSKDrawing�

enum CEikControlGroup::TOrientation

�

Enumerator:

ELayHorizontally�
ELayVertically�

enum CEikControlGroup::TStartCorner

�

Enumerator:

EFromTopLeft�
EFromTopRight�
EFromBottomLeft�
EFromBottomRight�

Constructor & Destructor Documentation

IMPORT_C CEikControlGroup::CEikControlGroup

(�

�)�

�

IMPORT_C CEikControlGroup::~CEikControlGroup

(�

�)�

�

Member Function Documentation

virtual IMPORT_C void CEikControlGroup::AddControlL (� TEikGroupControl &� aGroupControl �)� [virtual]

�	Reimplemented in CEikToolBar.

virtual IMPORT_C void CEikControlGroup::AddControlL	(�	CCoeControl *�	aControl,
		TInt�	aId
	)�	`[virtual]`

�	Reimplemented in CEikToolBar.

IMPORT_C CCoeControl* CEikControlGroup::ComponentControl (� TInt� aIndex �)� const [protected]

�

IMPORT_C void CEikControlGroup::ConstructL	(�	TStartCorner�	aStart,
		TOrientation�	aOrientation
	)�

�

IMPORT_C CCoeControl* CEikControlGroup::Control

IMPORT_C CArrayFix<TEikGroupControl>* CEikControlGroup::ControlArray

IMPORT_C CCoeControl* CEikControlGroup::ControlById

IMPORT_C TInt CEikControlGroup::ControlId

IMPORT_C void CEikControlGroup::ControlSpacing	(�	TInt &�	aHSpacing,
		TInt &�	aVSpacing
	)�	const

�

IMPORT_C TInt CEikControlGroup::CountComponentControls

IMPORT_C void CEikControlGroup::DeleteControl	(�	TInt�	aIndex,
		TInt�	aCount
	)�

�

virtual IMPORT_C void CEikControlGroup::GetColorUseListL (� CArrayFix< TCoeColorUse > &� aColorUseList �)� const [virtual]

�

Not used in S60.

From CCoeControl.

Parameters:

aColorUseList�

Not used.

Reimplemented from CEikBorderedControl.

Reimplemented in CEikCba, and CEikToolBar.

IMPORT_C void CEikControlGroup::HandlePointerEventL

(�

const TPointerEvent &�

aPointerEvent

�)�

�

Handles pointer events.

This function gets called whenever a pointer event occurs in the control, i.e. when the pointer is within the control's extent, or when the control has grabbed the pointer.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:

aPointerEvent�

The pointer event.

Reimplemented from CEikBorderedControl.

Reimplemented in CEikCba, and CEikToolBar.

virtual IMPORT_C void CEikControlGroup::HandleResourceChange (� TInt� aType �)� [virtual]

�

Handles a change to the control's resources.

The types of resources handled are those which are shared across the environment, e.g. colours or fonts. For colour scheme changes, DrawDeferred() is called in order to redraw the control.

If overriding this method, the implementation must include a base call to this method.

From CCoeControl.

Parameters:

aType�

The type of resource that has changed.

Reimplemented from CEikBorderedControl.

Reimplemented in CEikCba, and CEikToolBar.

IMPORT_C TInt CEikControlGroup::IndexById