Class TEikGroupControl

TEikGroupControl

Support

Supported from 6.0

Description

Wraps a control pointer. The control pointer is wrapped with other information such as; an ID, whether the control is of a fixed size or is stretchable and, if a set size, the control’s length.

This class is used by CEikControlGroup.

Defined in TEikGroupControl:
EAllowStretch, ESetLength, IsLengthSet(), IsStretchable(), Length(), SetLength(), SetStretchable(), TControlFlags, TEikGroupControl(), iControl, iId

See also:

• CEikControlGroup

TEikGroupControl();

Description

Default constructor.

TEikGroupControl(CCoeControl* aControl,TInt aId,TInt aLength,TInt aFlags);

Description

Constructor. This function wraps aControl with the specified information.

Parameters

CCoeControl* aControl The control. TInt aId The control’s ID. TInt aLength The control’s length in pixels. TInt aFlags The control’s flags. This determines whether the control is of a fixed size or can be stretched.

TBool IsLengthSet() const;

Description

Tests whether the control’s length is set.

Return value

TBool ETrue if the control’s length is set. EFalse if the control’s length is not set.

TInt Length() const;

Description

Gets the control’s length.

Return value

TInt The control’s length.

void SetLength(TInt aLength);

Description

Sets the control’s length. Also sets the ESetLength flag, indicating the control is not stretchable.

Parameters

TInt aLength The control’s length.

TBool IsStretchable() const;

Description

Tests whether the control is stretchable.

Return value

TBool ETrue if the EAllowStretch flag is set. EFalse otherwise.

void SetStretchable();

Description

Sets the control as stretchable.

TControlFlags

Description

Specifies whether the control is of a specific length or is stretchable.

ESetLength Specifies the control is of a set length, and so cannot be stretched. EAllowStretch Specifies the control can be stretched.

CCoeControl* iControl

Description

A control in the control group.

TInt iId

Description

ID of a control in the control group.