CAknEdwinSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <akntextsettingpage.h>

Inherits CAknSettingPage.

Inherited by CAknIntegerSettingPage, and CAknTextSettingPage.

Detailed Description

This class is an intermediate pure virtual class for all setting page classes that host Edwins.

It implements type-specific access to the hosted editor and common drawing code


Public Member Functions
IMPORT_C CEikEdwin *	TextControl ()
	Common access to the edwin for descendant classes.
IMPORT_C void	HandlePointerEventL (const TPointerEvent &aPointerEvent)
	From CCoeControl.
Protected Member Functions
IMPORT_C	CAknEdwinSettingPage (TInt ResourceId)
	Simple constructor depending only on a single resource Id.
IMPORT_C	CAknEdwinSettingPage (const TDesC *aSettingTitleText, TInt aSettingNumber, TInt aControlType, TInt aEditorResourceId, TInt aSettingPageResourceId)
	Constructor that allows separate setting page and editor resources.
virtual void	SizeChanged ()=0
	No implementation of SizeChanged is delivered with this class.
IMPORT_C void	Draw (const TRect &aRect) const
	Common draw function for laid-out descendent setting pages.
Protected Attributes
TAknLayoutRect	iEdwinLayoutRect
	Rectangle within which to layout the edwin.
TAknLayoutRect	iHorizontalShadow
	Horizontal shadow rectangle.
TAknLayoutRect	iVerticalShadow
	Vertical shadow rectangle.
TAknLayoutRect	iOutlineFrame
	Rectangle drawn around the edwin.

Constructor & Destructor Documentation

IMPORT_C CAknEdwinSettingPage::CAknEdwinSettingPage ( TInt ResourceId ) [protected]

Simple constructor depending only on a single resource Id.

Parameters:

aSettingPageResourceId

Setting Page resource id to use

IMPORT_C CAknEdwinSettingPage::CAknEdwinSettingPage	(	const TDesC *	aSettingTitleText,
		TInt	aSettingNumber,
		TInt	aControlType,
		TInt	aEditorResourceId,
		TInt	aSettingPageResourceId
	)	`[protected]`

Constructor that allows separate setting page and editor resources.

This constructor allows the use of setting page using only the editor resource. Other combinations are also possible

In all cases the number (if supplied i.e. <> 0 ) is used.

Editor Resource Setting Page Resource present present Both are used (but text & number overridden) = 0 present Editor resource is used via SP resource (Effectively like the other constructor) present = 0 Default Avkon SP resource if used + this editor resource = 0 = 0 uses default resource for both SP and editor. This is OK if: i) control type is present, ii) a default resource exists ( OK for text, integer, date, time, duration )

Note: THe first argument is a TDesC* (rather than TDesC&) because the other constructor cannot initialize such a member without allocation or having an internal dummy buffer. Note that this buffer must be owned by the client until ExecuteLD has been called.

Rules for text and numbers: The rules are the same for both: (non-zero length) text or number other than EAknSettingPageNoOrdinalDisplayed if given in this constructor will not override resource (unless that is zero length or EAknSettingPageNoOrdinalDisplayed). Note, however, that text or number given via the specific API for setting them, WILL override resource. It is assumed that number from resource is very rare. Special text is somewhat more likely.

Parameters:

	aSettingTitleText	Text at top of setting pane; EXTERNALLY OWNED
	aSettingNumber	Number at top left (if present)
	aControlType	Determines the type constructed and how its resource is read
	aEditorResourceId	Editor resource to use in the setting page (if present)
	aSettingPageResourceId	Setting Page to use (if present)

Member Function Documentation

IMPORT_C void CAknEdwinSettingPage::Draw ( const TRect & aRect ) const [protected]

Common draw function for laid-out descendent setting pages.

This should not need to be re-implemented as long as the rectangle members are all that is needed

Parameters:

aRect

rectangle within which to perform the draw

Reimplemented from CAknSettingPage.

IMPORT_C void CAknEdwinSettingPage::HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

From CCoeControl.

Handles pointer events

Reimplemented from CAknSettingPage.

Reimplemented in CAknTextSettingPage, and CAknIntegerSettingPage.

virtual void CAknEdwinSettingPage::SizeChanged ( ) [protected, pure virtual]

No implementation of SizeChanged is delivered with this class.

Reimplemented from CAknSettingPage.

Implemented in CAknTextSettingPage, and CAknIntegerSettingPage.

IMPORT_C CEikEdwin* CAknEdwinSettingPage::TextControl

(

)

Common access to the edwin for descendant classes.

Returns:: Pointer to contained edwin control

Field Documentation

TAknLayoutRect CAknEdwinSettingPage::iEdwinLayoutRect [protected]

Rectangle within which to layout the edwin.

Not drawn

TAknLayoutRect CAknEdwinSettingPage::iHorizontalShadow [protected]

Horizontal shadow rectangle.

TAknLayoutRect CAknEdwinSettingPage::iOutlineFrame [protected]

Rectangle drawn around the edwin.

TAknLayoutRect CAknEdwinSettingPage::iVerticalShadow [protected]

Vertical shadow rectangle.

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

akntextsettingpage.h

CAknEdwinSettingPage Class Reference

Capability Information

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation