CAknIntegerSettingItem Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknsettingitemlist.h>

Inherits CAknSettingItem.

Inherited by CAknIntegerEdwinSettingItem.

Detailed Description

Abstract setting item for integer editing.

This class is not disposed toward any particular type of setting page


Public Member Functions
IMPORT_C  CAknIntegerSettingItem (TInt aIdentifier, TInt &aValue)
IMPORT_C  ~CAknIntegerSettingItem ()
virtual IMPORT_C void  StoreL ()
  This command externalizes the current setting.
virtual IMPORT_C void  LoadL ()
virtual IMPORT_C const TDesC &  SettingTextL ()
virtual void  EditItemL (TBool aCalledFromMenu)=0
  Pure virtual editItemL.

Protected Member Functions
virtual IMPORT_C void  CompleteConstructionL ()
  Method called by framework to complete the construction.
IMPORT_C TInt &  InternalValueRef ()
  Method to access the internal value.
IMPORT_C TInt &  ExternalValueRef ()
  Method to access the external reference to the external value.
IMPORT_C void  SetExternalValue (TInt &aValue)
  Sets the external value's reference.

Constructor & Destructor Documentation

IMPORT_C CAknIntegerSettingItem::CAknIntegerSettingItem (  TInt  aIdentifier,
TInt &  aValue
) 
 
IMPORT_C CAknIntegerSettingItem::~CAknIntegerSettingItem (   ) 
 

Member Function Documentation

virtual IMPORT_C void CAknIntegerSettingItem::CompleteConstructionL (   )  [protected, virtual]
 

Method called by framework to complete the construction.

Extra allocations of memory or extra resource reading can happen here.

Reimplemented from CAknSettingItem.

virtual void CAknIntegerSettingItem::EditItemL (  TBool  aCalledFromMenu  )  [pure virtual]
 

Pure virtual editItemL.

Parameters:
aCalledFromMenu  - ignored in this class

Reimplemented from CAknSettingItem.

Implemented in CAknIntegerEdwinSettingItem.

IMPORT_C TInt& CAknIntegerSettingItem::ExternalValueRef (   )  [protected]
 

Method to access the external reference to the external value.

Note that this class only accesses the external integer via a copy of a reference to it.

Returns:
a reference to the external integer value
IMPORT_C TInt& CAknIntegerSettingItem::InternalValueRef (   )  [protected]
 

Method to access the internal value.

Returns:
a reference to the internal integer value
virtual IMPORT_C void CAknIntegerSettingItem::LoadL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

IMPORT_C void CAknIntegerSettingItem::SetExternalValue (  TInt &  aValue  )  [protected]
 

Sets the external value's reference.

The external vlue is externally owned, so this does not make a copy.

Parameters:
TInt&  aValue a reference to the external value
virtual IMPORT_C const TDesC& CAknIntegerSettingItem::SettingTextL (   )  [virtual]
 

Reimplemented from CAknSettingItem.

virtual IMPORT_C void CAknIntegerSettingItem::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