CAknTextSettingPage Class Reference

class CAknTextSettingPage : public CAknEdwinSettingPage
Public Member Functions
CAknTextSettingPage ( TInt , TDes &, TInt )
CAknTextSettingPage (const TDesC *, TInt , TInt , TInt , TInt , TDes &, TInt )
IMPORT_C void ConstructL ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
void ProcessPopupStateChangesL ()
Protected Member Functions
~CAknTextSettingPage ()
IMPORT_C void AcceptSettingL ()
IMPORT_C void CheckAndSetDataValidity ()
IMPORT_C void DynamicInitL ()
IMPORT_C void HandleControlEventL ( CCoeControl *, TCoeEvent)
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C TBool OkToExitL ( TBool )
IMPORT_C void RestoreOriginalSettingL ()
IMPORT_C void SizeChanged ()
IMPORT_C void UpdateCbaL ()
IMPORT_C void UpdateSettingL ()
IMPORT_C void UpdateTextL ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
IMPORT_C void CAknEdwinSettingPage_Reserved_1 ()
IMPORT_C void CAknSettingPage_Reserved_1 ()
IMPORT_C void CAknSettingPage_Reserved_2 ()
IMPORT_C void * ExtensionInterface ( TUid )
IMPORT_C void Reserved_2 ()
void RestartMultitapWaitTimer ()
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CAknEdwinSettingPage::CAknEdwinSettingPage(TInt)
CAknEdwinSettingPage::CAknEdwinSettingPage(const TDesC *,TInt,TInt,TInt,TInt)
CAknEdwinSettingPage::Draw(const TRect &)const
CAknEdwinSettingPage::TextControl()
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::ComponentControl(TInt)const
CAknSettingPage::ConstructFromResourceL(TInt)
CAknSettingPage::ConstructFromResourceL(TResourceReader &)
CAknSettingPage::CountComponentControls()const
CAknSettingPage::DataValidity()const
CAknSettingPage::DefaultCbaResourceId()const
CAknSettingPage::DismissL(TBool)
CAknSettingPage::DisplayMenuL()
CAknSettingPage::DynInitMenuPaneL(TInt,CEikMenuPane *)
CAknSettingPage::EditedItemControlContext()const
CAknSettingPage::EditorControl()const
CAknSettingPage::ExecuteLD(enum CAknSettingPage::TAknSettingPageUpdateMode)
CAknSettingPage::FocusChanged(TDrawNow)
CAknSettingPage::GetCaptionForFep(TDes &)const
CAknSettingPage::GetEditorResourceInfoL(TInt,TInt &,TInt &)
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::PostDisplayCheckL()
CAknSettingPage::ProcessCommandL(TInt)
CAknSettingPage::ResetFlags()
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::Waiting()
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()
Public Member Enumerations
enum TAknTextSettingPageFlags {
EZeroLengthNotOffered  = 0x0, EPutCursorAtEnd  = 0x0, EZeroLengthAllowed  = 0x0000001, ENoInitialSelection  = 0x0000004, EPutCursorAtBeginning  = 0x0000008, EUseEdwinCursorAndSelectionFlags  = 0x0000010, EPredictiveTextEntryPermitted  = 0x0020
}
Inherited Enumerations
CAknSettingPage:TAknSettingPageUpdateMode
CAknSettingPage:TEditedItemSkinClass
CCoeControl:TZoomType
Private Attributes
HBufC * iBackupText
CAknTextSettingPageExtension * iExtension
TDes & iText
TInt iTextSettingPageFlags
Inherited Attributes
CAknEdwinSettingPage::iEdwinLayoutRect
CAknEdwinSettingPage::iHorizontalShadow
CAknEdwinSettingPage::iOutlineFrame
CAknEdwinSettingPage::iVerticalShadow
CAknSettingPage::iSettingPageObserver
CAknSettingPage::iUpdateMode
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CAknTextSettingPage(TInt, TDes &, TInt)

IMPORT_C CAknTextSettingPage ( TInt aResourceID,
TDes & aText,
TInt aTextSettingPageFlags = 0
)

Simple constructor depending only on a single resource Id. Editor resource is given via the link in the setting page resource.

Parameters

TInt aResourceID
TDes & aText Reference to text for editing
TInt aTextSettingPageFlags = 0 option flags for miscellaneous things

CAknTextSettingPage(const TDesC *, TInt, TInt, TInt, TInt, TDes &, TInt)

IMPORT_C CAknTextSettingPage ( const TDesC * aSettingTitleText,
TInt aSettingNumber,
TInt aControlType,
TInt aEditorResourceId,
TInt aSettingPageResourceId,
TDes & aText,
TInt aTextSettingPageFlags = 0
)

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 * aSettingTitleText Text at top of setting pane; OWNED EXTERNALLY
TInt aSettingNumber Number at top left (if present)
TInt aControlType Determines the type constructed and how its resource is read
TInt aEditorResourceId Editor resource to use in the setting page (if present)
TInt aSettingPageResourceId Setting Page to use (if present)
TDes & aText Reference to text for editing
TInt aTextSettingPageFlags = 0 option flags for miscellaneous things

~CAknTextSettingPage()

IMPORT_C ~CAknTextSettingPage ( ) [protected, virtual]

C++ destructor

Member Functions Documentation

AcceptSettingL()

IMPORT_C void AcceptSettingL ( ) [protected, virtual]

Called when the user accepts the text and the setting page is about to be dismissed. The latest value of the text is written to the client's object

CAknEdwinSettingPage_Reserved_1()

IMPORT_C void CAknEdwinSettingPage_Reserved_1 ( ) [private, virtual]

Reserved method from CAknEdwinSettingPage

CAknSettingPage_Reserved_1()

IMPORT_C void CAknSettingPage_Reserved_1 ( ) [private, virtual]

Reserved methods for CAknSettingPage hierarchy

CAknSettingPage_Reserved_2()

IMPORT_C void CAknSettingPage_Reserved_2 ( ) [private, virtual]

CheckAndSetDataValidity()

IMPORT_C void CheckAndSetDataValidity ( ) [protected, virtual]

Framework method to set the validity of the data This is called when the data changes.

ConstructL()

IMPORT_C void ConstructL ( ) [virtual]

2nd stage construction for this specific type. Calls BaseConstructL in CAknSettingPage , where the object is constructed from resource.

After calling this method, the contained editor is fully constructed and has its text set, copied from the aText parameter of the constructor.

This constructor can be called prior to a call to ExecuteLD in order to ensure construction of the editor if API needs to be called on it prior to setting page launch. ExecuteLD will not attempt itself to do the construction a 2nd time.

DynamicInitL()

IMPORT_C void DynamicInitL ( ) [protected, virtual]

Called immediately prior to activation of the dialog. Framework routine for derived classes.

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Parameters

TUid aInterface

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void HandleControlEventL ( CCoeControl * aControl,
TCoeEvent aEventType
) [protected, virtual]

From MCoeControlObserver : Acts upon changes in the hosted control's state. If the EUpdateWhenChanged flag is set, this updates the setting text.

Parameters

CCoeControl * aControl The control changing its state (not used)
TCoeEvent aEventType The type of control event

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl . Handles pointer events

Parameters

const TPointerEvent & aPointerEvent

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [protected, virtual]

This routine routes the keys to the editor. However, if the menu is showing, then events are sent to the menu.

Parameters

const TKeyEvent & aKeyEvent event information
TEventCode aType type of event being handled

OkToExitL(TBool)

IMPORT_C TBool OkToExitL ( TBool aAccept ) [protected, virtual]

Framework method to determine if it is OK to exit the setting page. Derived classes may check for valid data before allowing the dismissal of the setting page.

Parameters

TBool aAccept ETrue if the user has indicated to accept the setting page; EFalse otherwise

ProcessPopupStateChangesL()

void ProcessPopupStateChangesL ( )

add for CAknTextSettingPageExtension to access the api fo CAknTextSettingPage

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

Reserved method derived from CCoeControl

RestartMultitapWaitTimer()

void RestartMultitapWaitTimer ( ) [private]

RestoreOriginalSettingL()

IMPORT_C void RestoreOriginalSettingL ( ) [protected, virtual]

Called when the user rejects the setting. A backed up copy is used to restore the initial value

SizeChanged()

IMPORT_C void SizeChanged ( ) [protected, virtual]

From CCoeControl This routine is called as part of the set-up of the control. It is the place to put the layout code.

UpdateCbaL()

IMPORT_C void UpdateCbaL ( ) [protected, virtual]

Update the CBA. This should be called after a control state change in case there has been a change in data validity.

UpdateSettingL()

IMPORT_C void UpdateSettingL ( ) [protected, virtual]

Called when something has changed and the client's object needs to have its text updated

UpdateTextL()

IMPORT_C void UpdateTextL ( ) [protected, virtual]

This method copies out the text from the editor into the client's descriptor

WriteInternalStateL(RWriteStream &)

IMPORT_C void WriteInternalStateL ( RWriteStream & aWriteStream ) const [protected, virtual]

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

RWriteStream & aWriteStream

Member Enumerations Documentation

Enum TAknTextSettingPageFlags

Enumerators

EZeroLengthNotOffered = 0x0
EPutCursorAtEnd = 0x0
EZeroLengthAllowed = 0x0000001
ENoInitialSelection = 0x0000004
EPutCursorAtBeginning = 0x0000008
EUseEdwinCursorAndSelectionFlags = 0x0000010
EPredictiveTextEntryPermitted = 0x0020

Member Data Documentation

HBufC * iBackupText

HBufC * iBackupText [private]

CAknTextSettingPageExtension * iExtension

CAknTextSettingPageExtension * iExtension [private]

TDes & iText

TDes & iText [private]

TInt iTextSettingPageFlags

TInt iTextSettingPageFlags [private]