CAknIpFieldSettingPage Class Reference

API published in: S60 1st Ed

Link against: avkon.lib

Capability Information

Required Capabilities

None


#include <aknmfnesettingpage.h>

Inherits CAknMfneSettingPage.


Detailed Description

Setting page class for entering an IP Address.

Public Member Functions

IMPORT_C  CAknIpFieldSettingPage (TInt aResourceID, TInetAddr &aIpAddress)
  Constructor using purely Setting page resource.
IMPORT_C  CAknIpFieldSettingPage (const TDesC *aSettingTitleText, TInt aSettingNumber, TInt aControlType, TInt aEditorResourceId, TInt aSettingPageResourceId, TInetAddr &aIpAddress)
  Constructor that allows separate setting page and editor resources.
virtual IMPORT_C void  ConstructL ()
  Specific 2nd stage contructor for this type.
IMPORT_C CAknIpFieldEditor IpFieldEditor ()
  Type-specific access to the editor.
IMPORT_C void  HandlePointerEventL (const TPointerEvent &aPointerEvent)
  From CCoeControl.

Protected Member Functions

virtual IMPORT_C  ~CAknIpFieldSettingPage ()
  Destructor.
virtual IMPORT_C void  UpdateSettingL ()
  This framework method is called when the editor changes its value and the mode of execution of the setting page is a continuous update mode.
virtual IMPORT_C void  AcceptSettingL ()
  Called when the user has accepted the value.
virtual IMPORT_C void  RestoreOriginalSettingL ()
  The backup value, stored at construction time, is re-loaded into the referenced Date.
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 CAknIpFieldSettingPage::CAknIpFieldSettingPage TInt  aResourceID,
TInetAddr &  aIpAddress
 

Constructor using purely Setting page resource.

Parameters:
aResourceId  Setting page resource Id
aIpAddress  Reference to the maintained IP address
IMPORT_C CAknIpFieldSettingPage::CAknIpFieldSettingPage const TDesC *  aSettingTitleText,
TInt  aSettingNumber,
TInt  aControlType,
TInt  aEditorResourceId,
TInt  aSettingPageResourceId,
TInetAddr &  aIpAddress
 

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 descriptor must be owned by the client at least until the 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; OWNED EXTERNALLY
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)
aIpAddress  reference to a duration
virtual IMPORT_C CAknIpFieldSettingPage::~CAknIpFieldSettingPage  )  [protected, virtual]
 

Destructor.


Member Function Documentation

virtual IMPORT_C void CAknIpFieldSettingPage::AcceptSettingL  )  [protected, virtual]
 

Called when the user has accepted the value.

The external value is updated once again, in case we were not in continuous update mode. A specific observer event is generated for the observer to say that the value is accepted.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknIpFieldSettingPage::ConstructL  )  [virtual]
 

Specific 2nd stage contructor for this type.

Construction is performed according to the resources and parameters set in the C++ constructors

Reimplemented from CAknMfneSettingPage.

IMPORT_C void CAknIpFieldSettingPage::HandlePointerEventL const TPointerEvent &  aPointerEvent  ) 
 

From CCoeControl.

Reimplemented from CAknMfneSettingPage.

IMPORT_C CAknIpFieldEditor* CAknIpFieldSettingPage::IpFieldEditor  ) 
 

Type-specific access to the editor.

virtual IMPORT_C void CAknIpFieldSettingPage::RestoreOriginalSettingL  )  [protected, virtual]
 

The backup value, stored at construction time, is re-loaded into the referenced Date.

An event is sent to the observer saying that the event was dismissed.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknIpFieldSettingPage::UpdateSettingL  )  [protected, virtual]
 

This framework method is called when the editor changes its value and the mode of execution of the setting page is a continuous update mode.

Reimplemented from CAknSettingPage.

virtual IMPORT_C void CAknIpFieldSettingPage::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 CAknSettingPage.


The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2008
Back to top