CEikCapCArray Class Reference

API published in: S60 1st Ed

Link against: eikdlg.lib eikcoctl.lib

Capability Information

Required Capabilities

None

#include <eikcapca.h>


Public Member Functions
IMPORT_C	CEikCapCArray (TInt aGranularity)
	Constructor.
IMPORT_C	~CEikCapCArray ()
	Destructor.
IMPORT_C TSize	MinimumSize ()
	MinimumSize() returns minimum size for the array.
IMPORT_C void	SetRect (const TRect &aRect)
	SetRect() sets the rectangle of the captionedcontrolarray.
IMPORT_C void	ResetMinimumSizes ()
	ResetMinimumSizes() clears size information.
IMPORT_C TInt	LineIndexFromId (TInt aControlId) const
	LineIndexFromId() provides line index in array based on id number.
IMPORT_C TInt	FindLineIndex (const CCoeControl *aControl) const
	FindLineIndex() finds line index based on control.
IMPORT_C void	DeleteLine (TInt aIndex)
	DeleteLine() removes line from captionedcontrolarray.
IMPORT_C void	AdjustAllIds (TInt aControlIdDelta)
	AdjustAllIds() modified iId fields of the captionedcontrols.
IMPORT_C void	SetDensePacking (TBool aDensePacking)
	SetDensePacking() sets dense packing flag.
TBool	CalcItemIndexes (TInt &aTopItemIndex, TInt &aMiddleItems, TInt &aBottomItemIndex, TSize aAreaSize)
TInt	NumberOfTextLines () const
TInt	NumberOfTextLinesBeforeLine (TInt aLine) const
TInt	FindItemFromTextLine (TInt aTextLine) const
TRect	Rect () const
void	SetRect (const TRect &aRect, TInt aTop, TInt aMiddle, TInt aBottom)
TInt	YPosToLine (const TRect &aRect, TInt aTop, TInt aMiddle, TInt aBottom, TInt aYCoord)
void	CreateExtensionL ()
CEikCapCArrayExtension *	ExtensionOrNull () const

Constructor & Destructor Documentation

IMPORT_C CEikCapCArray::CEikCapCArray

(

TInt

aGranularity

)

Constructor.

Creates CEikCapCArray with a granilarity.

Parameters:

aGranularity

how many items will be allocated each time allocation happens

IMPORT_C CEikCapCArray::~CEikCapCArray

(

)

Destructor.

Destroys CEikCapCArray

Member Function Documentation

IMPORT_C void CEikCapCArray::AdjustAllIds

(

TInt

aControlIdDelta

)

AdjustAllIds() modified iId fields of the captionedcontrols.

Parameters:

aControlIdDelta

how much to increase or decrease control id's

TBool CEikCapCArray::CalcItemIndexes	(	TInt &	aTopItemIndex,
		TInt &	aMiddleItems,
		TInt &	aBottomItemIndex,
		TSize	aAreaSize
	)

void CEikCapCArray::CreateExtensionL

(

)

IMPORT_C void CEikCapCArray::DeleteLine

(

TInt

aIndex

)

DeleteLine() removes line from captionedcontrolarray.

Elements from CaptionedControlArray can be removed by calling DeleteLine method.

Parameters:

aIndex

index of the line to be removed

CEikCapCArrayExtension* CEikCapCArray::ExtensionOrNull

(

)

const

TInt CEikCapCArray::FindItemFromTextLine

(

TInt

aTextLine

)

const

IMPORT_C TInt CEikCapCArray::FindLineIndex

(

const CCoeControl *

aControl

)

const

FindLineIndex() finds line index based on control.

Every captionedcontrol has iControl CCoeControl which implements the control for the DLG_LINE. FindLineIndex goes through all captionedcontrols and finds the one which has aControl as it's control.

Parameters:

aControl

control to be found

IMPORT_C TInt CEikCapCArray::LineIndexFromId

(

TInt

aControlId

)

const

LineIndexFromId() provides line index in array based on id number.

Every captionedcontrol has iId and based on the id, LineIndexFromId goes through the captionedcontrolarray and finds the captionedcontrol's position in the array based on the id provided

Parameters:

aControlId

captionedcontrol's iId.

IMPORT_C TSize CEikCapCArray::MinimumSize

(

)

MinimumSize() returns minimum size for the array.

MinimumSize calculates minimum possible size for the captioned control array.

Returns:: size in pixels

TInt CEikCapCArray::NumberOfTextLines

(

)

const

TInt CEikCapCArray::NumberOfTextLinesBeforeLine

(

TInt

aLine

)

const

TRect CEikCapCArray::Rect

(

)

const

IMPORT_C void CEikCapCArray::ResetMinimumSizes

(

)

ResetMinimumSizes() clears size information.

ResetMinimumSizes goes through all captionedcontrols and resets the minimum size information of the captionedcontrols

IMPORT_C void CEikCapCArray::SetDensePacking

(

TBool

aDensePacking

)

SetDensePacking() sets dense packing flag.

Parameters:

aDensePacking

whether dense packing flag is on

void CEikCapCArray::SetRect	(	const TRect &	aRect,
		TInt	aTop,
		TInt	aMiddle,
		TInt	aBottom
	)

IMPORT_C void CEikCapCArray::SetRect

(

const TRect &

aRect

)

SetRect() sets the rectangle of the captionedcontrolarray.

SetRect layouts the captionedcontrolarray. Captioned control rectangles are calculated based on provided rectangle and sizes of the captioned controls.

Parameters:

aRect

Rectangle for the whole array

TInt CEikCapCArray::YPosToLine	(	const TRect &	aRect,
		TInt	aTop,
		TInt	aMiddle,
		TInt	aBottom,
		TInt	aYCoord
	)

The documentation for this class was generated from the following file:

eikcapca.h

CEikCapCArray Class Reference

Capability Information

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation