CAknEdwinSettingPage Class Reference

class CAknEdwinSettingPage : public CAknSettingPage

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

Inherits from

Public Member Functions
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C CEikEdwin *TextControl()
Protected Member Functions
CAknEdwinSettingPage(TInt)
CAknEdwinSettingPage(const TDesC *, TInt, TInt, TInt, TInt)
IMPORT_C voidDraw(const TRect &)
voidSizeChanged()
Private Member Functions
IMPORT_C voidCAknEdwinSettingPage_Reserved_1()
IMPORT_C void *ExtensionInterface(TUid)
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknSettingPage::AcceptSettingL()
CAknSettingPage::AttemptExitL(TBool)
CAknSettingPage::BaseConstructL()
CAknSettingPage::BaseConstructL(TUint)
CAknSettingPage::BaseDraw(const TRect &)const
CAknSettingPage::CAknSettingPage(TInt)
CAknSettingPage::CAknSettingPage(const TDesC *,TInt,TInt,TInt,TInt)
CAknSettingPage::Cba()const
CAknSettingPage::CheckAndSetDataValidity()
CAknSettingPage::ComponentControl(TInt)const
CAknSettingPage::ConstructFromResourceL(TInt)
CAknSettingPage::ConstructFromResourceL(TResourceReader &)
CAknSettingPage::ConstructL()
CAknSettingPage::CountComponentControls()const
CAknSettingPage::DataValidity()const
CAknSettingPage::DefaultCbaResourceId()const
CAknSettingPage::DismissL(TBool)
CAknSettingPage::DisplayMenuL()
CAknSettingPage::DynInitMenuPaneL(TInt,CEikMenuPane *)
CAknSettingPage::DynamicInitL()
CAknSettingPage::EditedItemControlContext()const
CAknSettingPage::EditorControl()const
CAknSettingPage::ExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateMode)
CAknSettingPage::FocusChanged(TDrawNow)
CAknSettingPage::GetCaptionForFep(TDes &)const
CAknSettingPage::GetEditorResourceInfoL(TInt,TInt &,TInt &)
CAknSettingPage::HandleControlEventL(CCoeControl *,TCoeEvent)
CAknSettingPage::HandleResourceChange(TInt)
CAknSettingPage::HideMenu()
CAknSettingPage::InputCapabilities()const
CAknSettingPage::InvalidDataCbaResourceId()const
CAknSettingPage::IsBackgroundDrawingEnabled()const
CAknSettingPage::IsBaseConstructed()
CAknSettingPage::IsEditable()const
CAknSettingPage::IsNumbered()const
CAknSettingPage::IsSkinsHandlingEditorFrameDrawing()const
CAknSettingPage::IsStopActiveSchudlerCalled()const
CAknSettingPage::MenuShowing()const
CAknSettingPage::MopSupplyObject(TTypeUid)
CAknSettingPage::OfferKeyEventL(const TKeyEvent &,TEventCode)
CAknSettingPage::OkToExitL(TBool)
CAknSettingPage::PostDisplayCheckL()
CAknSettingPage::ProcessCommandL(TInt)
CAknSettingPage::ResetFlags()
CAknSettingPage::RestoreOriginalSettingL()
CAknSettingPage::SelectCurrentItemL()
CAknSettingPage::SetDataValidity(TBool)
CAknSettingPage::SetDrawBackground(const TBool)
CAknSettingPage::SetEditState(const TBool)
CAknSettingPage::SetEditedItemFrameIID(const TAknsItemID &,const TAknsItemID &)
CAknSettingPage::SetEditedItemFrameRects(const TRect &,const TRect &)
CAknSettingPage::SetEditorIndicatorRect(const TRect &)
CAknSettingPage::SetEmphasis(CCoeControl *,TBool)
CAknSettingPage::SetFocusToEditor()
CAknSettingPage::SetNumbered(TBool)
CAknSettingPage::SetSettingId(TInt)
CAknSettingPage::SetSettingNumberL(const TInt)
CAknSettingPage::SetSettingPageObserver(MAknSettingPageObserver *)
CAknSettingPage::SetSettingTextL(const TDesC &)
CAknSettingPage::SetStopActiveSchedulerFlag(const TBool)
CAknSettingPage::SettingId()const
CAknSettingPage::SettingItemContentRect(TBool)
CAknSettingPage::SettingNumber()const
CAknSettingPage::SettingPageResourceId()
CAknSettingPage::ShadowText()const
CAknSettingPage::StandardSettingPageLayout()
CAknSettingPage::StopActiveScheduler()
CAknSettingPage::TextLabel()const
CAknSettingPage::UpdateCbaL()
CAknSettingPage::UpdateSettingL()
CAknSettingPage::Waiting()
CAknSettingPage::WriteInternalStateL(RWriteStream &)const
CAknSettingPage::~CAknSettingPage()
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()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()
Inherited Enumerations
CAknSettingPage:TAknSettingPageUpdateMode
CAknSettingPage:TEditedItemSkinClass
CCoeControl:TZoomType
Protected Attributes
TAknLayoutRect iEdwinLayoutRect
TAknLayoutRect iHorizontalShadow
TAknLayoutRect iOutlineFrame
TAknLayoutRect iVerticalShadow
Private Attributes
TInt iSpare
Inherited Attributes
CAknSettingPage::iSettingPageObserver
CAknSettingPage::iUpdateMode
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknEdwinSettingPage(TInt)

IMPORT_CCAknEdwinSettingPage(TIntResourceId)[protected]

Simple constructor depending only on a single resource Id.

Parameters

TInt ResourceId

CAknEdwinSettingPage(const TDesC *, TInt, TInt, TInt, TInt)

IMPORT_CCAknEdwinSettingPage(const TDesC *aSettingTitleText,
TIntaSettingNumber,
TIntaControlType,
TIntaEditorResourceId,
TIntaSettingPageResourceId
)[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

const TDesC * aSettingTitleTextText at top of setting pane; EXTERNALLY OWNED
TInt aSettingNumberNumber at top left (if present)
TInt aControlTypeDetermines the type constructed and how its resource is read
TInt aEditorResourceIdEditor resource to use in the setting page (if present)
TInt aSettingPageResourceIdSetting Page to use (if present)

Member Functions Documentation

CAknEdwinSettingPage_Reserved_1()

IMPORT_C voidCAknEdwinSettingPage_Reserved_1()[private, virtual]

New reserved method with this class

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [protected, virtual]

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

const TRect & aRectrectangle within which to perform the draw

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

From CCoeControl. Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

SizeChanged()

voidSizeChanged()[protected, pure virtual]

No implementation of SizeChanged is delivered with this class

TextControl()

IMPORT_C CEikEdwin *TextControl()

Common access to the edwin for descendant classes

Member Data Documentation

TAknLayoutRect iEdwinLayoutRect

TAknLayoutRect iEdwinLayoutRect[protected]

Rectangle within which to layout the edwin. Not drawn

TAknLayoutRect iHorizontalShadow

TAknLayoutRect iHorizontalShadow[protected]

Horizontal shadow rectangle

TAknLayoutRect iOutlineFrame

TAknLayoutRect iOutlineFrame[protected]

Rectangle drawn around the edwin

TInt iSpare

TInt iSpare[private]

TAknLayoutRect iVerticalShadow

TAknLayoutRect iVerticalShadow[protected]

Vertical shadow rectangle