CAknInputFrame Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akninfrm.h>

Inherits CEikBorderedControl.

Detailed Description

Implements an input frame which can contain any CCoeControl.

The input frame can have additional icon and/or info text.


Public Types
enum	TInputFrameFlags { EOwnsField = 0x40, EPopupLayout = 0x80, EPinbLayout = 0x100, EClockAppLayout = 0x200, EFixedFindWithoutLine = 0x400, EShowIndicators = 0x800, EPopupWindowLayout = 0x1000 }
	Enumeration flags for different layouts. More...
Public Member Functions
	CAknInputFrame ()
	Default C++ constructor.
IMPORT_C	~CAknInputFrame ()
	Destructor.
IMPORT_C CCoeControl *	Field () const
	Returns apointer to field.
IMPORT_C void	SetInfoTextL (const TDesC &aText)
	Sets additional info text to input frame.
IMPORT_C void	SetLineState (TBool aLineVisible)
	Sets the lines visible or invisible.
void	SetIcon (CGulIcon *aIcon)
	Sets new icon to input frame.
IMPORT_C void	HandleControlEventL (CCoeControl *aControl, TCoeEvent aEventType)
	Handles focus changes.
IMPORT_C TKeyResponse	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
	Handles key events.
IMPORT_C TSize	MinimumSize ()
	Tells the minimum size of the control.
IMPORT_C void	ConstructFromResourceL (TResourceReader &aReader)
	The second phase constructor: constructs input frame from resources.
IMPORT_C void	SetInputContext (CAknsFrameBackgroundControlContext *aContext)
	Sets the implementation of this control context in this input frame.
void	HandleResourceChange (TInt aType)
	From CCoeControl.
Static Public Member Functions
static IMPORT_C CAknInputFrame *	NewL (CCoeControl *aField, TBool aComponentOwner, const TDesC &aBitmapfile, TInt aBitmapId, TInt aMaskId, TUint32 aFlags=0)
	Two-phased constructor.
static IMPORT_C CAknInputFrame *	NewL (CCoeControl aField, TBool aComponentOwner, CGulIcon aIcon, TUint32 aFlags=0)
	Two-phased constructor.

Member Enumeration Documentation

enum CAknInputFrame::TInputFrameFlags

Enumeration flags for different layouts.

Enumerator:

EOwnsField	a Standard layout.
EPopupLayout	a Popup layoyt.
EPinbLayout	a Pinboard layout.
EClockAppLayout	a ClockAppLayout.
EFixedFindWithoutLine	a Layout without lines.
EShowIndicators	a Layout that shows indicator.
EPopupWindowLayout	A layout used by list query.

Constructor & Destructor Documentation

CAknInputFrame::CAknInputFrame

(

)

Default C++ constructor.

IMPORT_C CAknInputFrame::~CAknInputFrame

(

)

Destructor.

Frees all resources owned by the object prior to its destruction.

Member Function Documentation

IMPORT_C void CAknInputFrame::ConstructFromResourceL

The second phase constructor: constructs input frame from resources.

Parameters:

The

resource reader.

IMPORT_C CCoeControl* CAknInputFrame::Field

(

)

const

Returns apointer to field.

Returns:: a Pointer to the control, which is located inside the input frame.

IMPORT_C void CAknInputFrame::HandleControlEventL	(	CCoeControl *	aControl,
		TCoeEvent	aEventType
	)

Handles focus changes.

This is called by the UI Control Framework to notify that an event occured in observed input frame.

Parameters:

	aControl	The control where event has happened.
	aEventType	a Type of the event.

void CAknInputFrame::HandleResourceChange

From CCoeControl.

Handles a change to the control's resources.

Parameters:

aType

A message UID value.

Reimplemented from CEikBorderedControl.

IMPORT_C TSize CAknInputFrame::MinimumSize

(

)

Tells the minimum size of the control.

Returns:: The minimum size of the control.

static IMPORT_C CAknInputFrame* CAknInputFrame::NewL	(	CCoeControl *	aField,
		TBool	aComponentOwner,
		CGulIcon *	aIcon,
		TUint32	aFlags = `0`
	)	`[static]`

Two-phased constructor.

Parameters:

	aField	Control which will be located inside the input frame
	aComponentOwner	Defines whether the ownership of the control is transferred or not.
	aIcon	Bitmap file name and path.
	aFlags	Flags.

Returns:: a Pointer to the new CAknInputFrame object.

static IMPORT_C CAknInputFrame* CAknInputFrame::NewL	(	CCoeControl *	aField,
		TBool	aComponentOwner,
		const TDesC &	aBitmapfile,
		TInt	aBitmapId,
		TInt	aMaskId,
		TUint32	aFlags = `0`
	)	`[static]`

Two-phased constructor.

Parameters:

	aField	Control which will be located inside the input frame
	aComponentOwner	Defines whether the ownership of the control will be transferred or not.
	aBitmapfile	Bitmap file name and path.
	aBitmapId	Bitmap Id.
	aMaskId	Bitmap Mask Id.
	aFlags	Flags.