Collapse all Symbian^3 Application Developer Library

CEikMfneField Class Reference

class CEikMfneField : public CBase

Abstract base class for fields within a multi-field numeric editor.

Inherits from

CEikMfneField
- CBase

Public Member Functions
TInt	DistanceFromStartOfFieldToEndOfTextInPixels (const CFont &)
void	Draw ( CWindowGc &, const CFont &, const TPoint &)
const TDesC &	FieldText ()
IMPORT_C void	HandleDeHighlight (const CFont &, CEikonEnv &, TBool &, TBool &)
IMPORT_C void	HandleKey (const CFont &, const TKeyEvent &, TBool , TBool &, TInt &)
IMPORT_C THighlightType	HighlightType ()
TCoeInputCapabilities	InputCapabilities ()
IMPORT_C TBool	IsEditable ()
IMPORT_C TBool	IsValid ()
TInt	MaximumWidthInPixels (const CFont &, TBool )
TInt	WidthInPixels (const CFont &)

Protected Member Functions
	CEikMfneField ()
TInt	AdditionalWidthForHighlights (const CFont &)
IMPORT_C void	HandleLeftOrRightArrow ( TChar , TBool &, TInt &)

Private Member Functions
const TDesC &	Text ()

Inherited Functions
	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()

Public Member Enumerations
enum	THighlightType { EInverseVideo , ECursor }

Protected Attributes
TInt	iMinimumWidthInPixels

Constructor & Destructor Documentation

CEikMfneField()

IMPORT_C

CEikMfneField

(

)

[protected]

Protected default constructor.

Sets the minimum width of the field to zero pixels.

Member Functions Documentation

AdditionalWidthForHighlights(const CFont &)

TInt

AdditionalWidthForHighlights

(

const CFont &

aFont

)

const [protected]

Parameters

const CFont & aFont

DistanceFromStartOfFieldToEndOfTextInPixels(const CFont &)

TInt

DistanceFromStartOfFieldToEndOfTextInPixels

(

const CFont &

aFont

)

const

Parameters

const CFont & aFont

Draw(CWindowGc &, const CFont &, const TPoint &)

void	Draw	(	CWindowGc &	aGc,
			const CFont &	aFont,
			const TPoint &	aTopLeft
		)	const

Parameters

CWindowGc & aGc
const CFont & aFont
const TPoint & aTopLeft

FieldText()

const TDesC &

FieldText

(

)

const

HandleDeHighlight(const CFont &, CEikonEnv &, TBool &, TBool &)

IMPORT_C void	HandleDeHighlight	(	const CFont &	aFont,
			CEikonEnv &	aEikonEnv,
			TBool &	aDataAltered,
			TBool &	aError
		)	[virtual]

An implementation of this function should handle de-highlighting the field.

May only be called if IsEditable() returns ETrue.

This implementation panics in debug builds and is empty in release builds.

Parameters

const CFont & aFont	The control's font.
CEikonEnv & aEikonEnv	The control's environment.
TBool & aDataAltered	On return, set to ETrue if the function caused the field's contents to change, otherwise unchanged.
TBool & aError	On return, changed to ETrue if an error occurred e.g. the user entered an invalid value, otherwise unchanged.

HandleKey(const CFont &, const TKeyEvent &, TBool, TBool &, TInt &)

IMPORT_C void	HandleKey	(	const CFont &	aFont,
			const TKeyEvent &	aKeyEvent,
			TBool	aInterpretLeftAndRightAsEarEvents,
			TBool &	aDataAltered,
			TInt &	aHighlightIncrement
		)	[virtual]

An implementation of this function should handle a key event.

May only be called if IsEditable() returns ETrue. This implementation panics in debug builds and is empty in release builds.

Parameters

const CFont & aFont	The control's font.
const TKeyEvent & aKeyEvent	The key event passed on from the multi-field numeric editor.
TBool aInterpretLeftAndRightAsEarEvents	Not used.
TBool & aDataAltered	On return, indicates whether or not the field contents changed. If EFalse, left and right arrow key presses indicate a movement to the preceding of following field, if ETrue they are ignored.
TInt & aHighlightIncrement	On return: -1 indicates the previous field is highlighted,0 indicates the highlight is unchanged and 1 indicates the following field is highlighted.

HandleLeftOrRightArrow(TChar, TBool &, TInt &)

IMPORT_C void	HandleLeftOrRightArrow	(	TChar	aKey,
			TBool &	aDataAltered,
			TInt &	aHighlightIncrement
		)	[protected]

Handles a left or right arrow key press.

panic: 3 In debug builds, if aKey is neither a left nor a right arrow key.

Parameters

TChar aKey	Left or right arrow key: either EKeyLeftArrow or EKeyRightArrow.
TBool & aDataAltered	On return, ETrue if data is altered as a result of this function.
TInt & aHighlightIncrement	On return, the direction to move the cursor: either -1 if aKey is a left arrow key, or 1 if aKey is a right arrow key.

HighlightType()

IMPORT_C THighlightType

HighlightType

(

)

const [virtual]

An implementation of this function should get the field's highlight type.

May only be called if IsEditable() returns ETrue.

This implementation panics in debug builds and returns a dummy value in release builds.

InputCapabilities()

TCoeInputCapabilities

InputCapabilities

(

)

const [pure virtual]

An implementation of this pure virtual function should return the field's input capabilities.

IsEditable()

IMPORT_C TBool

IsEditable

(

)

const [virtual]

Derived classes' implementation of function should return whether the field is editable.

This implementation returns EFalse.

IsValid()

IMPORT_C TBool

IsValid

(

)

const [virtual]

Derived classes' implementation of function should return whether the field is valid

This implementation returns ETrue.

MaximumWidthInPixels(const CFont &, TBool)

TInt	MaximumWidthInPixels	(	const CFont &	aFont,
			TBool	aShrinkToMinimumSize
		)	[pure virtual]

An implementation of this pure virtual function should get the field's maximum width in pixels.

Parameters

const CFont & aFont	The font.
TBool aShrinkToMinimumSize	ETrue to shrink the width to the minimum required.

Text()

const TDesC &

Text

(

)

const [private, pure virtual]

WidthInPixels(const CFont &)

TInt

WidthInPixels

(

const CFont &

aFont

)

const

Parameters

const CFont & aFont

Member Enumerations Documentation

Enum THighlightType

The type of highlight.

Enumerators

EInverseVideo	Inverse video.
ECursor	The cursor is visible in the field so that highlighting is not used.

Member Data Documentation

TInt iMinimumWidthInPixels

TInt

iMinimumWidthInPixels

[protected]

The field's minimum width in pixels.