CAknTextSettingItem Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Inherits CAknSettingItem.

Inherited by CAknPasswordSettingItem.

Detailed Description

Support for abstact text setting type.

Corresponds to CAknTextSettingPage


Public Member Functions
IMPORT_C  CAknTextSettingItem (TInt aIdentifier, TDes &aText)
IMPORT_C  ~CAknTextSettingItem ()
  Destructor.
virtual IMPORT_C void  StoreL ()
  This command externalizes the current setting.
virtual IMPORT_C void  LoadL ()
virtual IMPORT_C const TDesC &  SettingTextL ()
virtual IMPORT_C void  EditItemL (TBool aCalledFromMenu)
  This launches the setting page for text editing.

Protected Member Functions
IMPORT_C TPtr &  InternalTextPtr ()
  Access for re-implementors to the internal text.
IMPORT_C TPtrC  ExternalText ()
  Access for re-implementors to the external text.
IMPORT_C void  SetExternalText (TDesC &aNewExternalText)
  Allows re-implementors to set the external text No change of ownership is implied.

Constructor & Destructor Documentation

IMPORT_C CAknTextSettingItem::CAknTextSettingItem (  TInt  aIdentifier,
TDes &  aText
) 
 
IMPORT_C CAknTextSettingItem::~CAknTextSettingItem (   ) 
 

Destructor.

Member Function Documentation

virtual IMPORT_C void CAknTextSettingItem::EditItemL (  TBool  aCalledFromMenu  )  [virtual]
 

This launches the setting page for text editing.

Parameters:
aCalledFromMenu  - ignored in this class

Reimplemented from CAknSettingItem.

Reimplemented in CAknPasswordSettingItem.

IMPORT_C TPtrC CAknTextSettingItem::ExternalText (   )  [protected]
 

Access for re-implementors to the external text.

Returns:
TPtrC pointing to the external text
IMPORT_C TPtr& CAknTextSettingItem::InternalTextPtr (   )  [protected]
 

Access for re-implementors to the internal text.

Returns:
reference to a TPtr holding the internal text
virtual IMPORT_C void CAknTextSettingItem::LoadL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

IMPORT_C void CAknTextSettingItem::SetExternalText (  TDesC &  aNewExternalText  )  [protected]
 

Allows re-implementors to set the external text No change of ownership is implied.

Parameters:
a  reference to the external text
virtual IMPORT_C const TDesC& CAknTextSettingItem::SettingTextL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

Reimplemented in CAknPasswordSettingItem.

virtual IMPORT_C void CAknTextSettingItem::StoreL (   )  [virtual]
 

This command externalizes the current setting.

The displayed (internal) copy is transferred to the external copy (the one referenced in the constructor).

This must be called by the client if he wants this to happen. Note that StoreAllL() on the setting item list will call this for each setting item.

Reimplemented from CAknSettingItem.

The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top