CAknNumericPasswordSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None

#include <aknpasswordsettingpage.h>

Inherits CAknPasswordSettingPage.

Detailed Description

This class is used for numeric passwords.

The API uses text descriptors rather than integers for the PIN numbers as this is the usage


Public Member Functions
IMPORT_C  CAknNumericPasswordSettingPage (TInt aResourceID, TDes &aNewPassword, const TDesC &aOldPassword)
  Simple constructor depending only on a single resource Id and the new and old password.
IMPORT_C  CAknNumericPasswordSettingPage (const TDesC *aSettingTitleText, TInt aSettingNumber, TInt aControlType, TInt aEditorResourceId, TInt aSettingPageResourceId, TDes &aNewPassword, const TDesC &aOldPassword)
  Constructor that allows separate setting page and editor resources.
virtual IMPORT_C void  ConstructL ()
  2nd stage construction.
IMPORT_C CAknNumericSecretEditor *  NumericPasswordEditor ()
  Type specific access to hosted editor.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions
virtual IMPORT_C  ~CAknNumericPasswordSettingPage ()
  Destructor.
virtual IMPORT_C void  UpdateTextL ()
  From CAknPasswordSettingPage - Implemented in this class Copy text from the editor to the client's descriptor.
virtual IMPORT_C void  WriteInternalStateL (RWriteStream &aWriteStream) const
  Writes the internal state of the control and its components to aStream.

Constructor & Destructor Documentation

IMPORT_C CAknNumericPasswordSettingPage::CAknNumericPasswordSettingPage (  TInt  aResourceID,
TDes &  aNewPassword,
const TDesC &  aOldPassword
) 
 

Simple constructor depending only on a single resource Id and the new and old password.

Editor resource is given via the link in the setting page resource.

Parameters:
aSettingPageResourceId  Setting Page to use (if present)
aNewPassword 
aOldPassword  password to be checked against
IMPORT_C CAknNumericPasswordSettingPage::CAknNumericPasswordSettingPage (  const TDesC *  aSettingTitleText,
TInt  aSettingNumber,
TInt  aControlType,
TInt  aEditorResourceId,
TInt  aSettingPageResourceId,
TDes &  aNewPassword,
const TDesC &  aOldPassword
) 
 

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. This descriptor must be owned by the client since not copy is taken until ExecuteLD()

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)
aNewPassword  Descriptor for the new password
aOldPassword  Descriptor for the old password
virtual IMPORT_C CAknNumericPasswordSettingPage::~CAknNumericPasswordSettingPage (   )  [protected, virtual]
 

Destructor.

Member Function Documentation

virtual IMPORT_C void CAknNumericPasswordSettingPage::ConstructL (   )  [virtual]
 

2nd stage construction.

This uses stored values from the conststuctor to allocate the required aggregate objects, and then set the Date value.

Reimplemented from CAknSettingPage.

IMPORT_C void CAknNumericPasswordSettingPage::HandlePointerEventL (  const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Handles pointer events

Parameters:
aPointerEvent  The pointer event.

Reimplemented from CAknPasswordSettingPage.

IMPORT_C CAknNumericSecretEditor* CAknNumericPasswordSettingPage::NumericPasswordEditor (   ) 
 

Type specific access to hosted editor.

Returns:
the hosted (numeric secret) editor
virtual IMPORT_C void CAknNumericPasswordSettingPage::UpdateTextL (   )  [protected, virtual]
 

From CAknPasswordSettingPage - Implemented in this class Copy text from the editor to the client's descriptor.

Implements CAknPasswordSettingPage.

virtual IMPORT_C void CAknNumericPasswordSettingPage::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:
aWriteSteam  A connected write stream

Reimplemented from CAknPasswordSettingPage.

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