S60 3rd Edition API Reference: CAknIpFieldEditor Class Reference

CAknIpFieldEditor Class Reference

API published in: S60 1st Ed

Link against: avkon.lib eikctl.lib eikcoctl.lib uiklaf.lib form.lib

Capability Information

Required Capabilities

None

#include <aknipfed.h>

Inherits CEikMfne.

Detailed Description

The CAknIpFieldEditor class implements an editor for an IP address.

Based on Crystal CCknIpFieldEditor.


Public Member Functions

IMPORT_C CAknIpFieldEditor ()
 C++ default constructor.
void ConstructL (TInetAddr &aMinimumAddress, TInetAddr &aMaximumAddress, TInetAddr &aInitialAddress, const TInt aFlags=0)
 Two phased constructor.
IMPORT_C void SetAddress (const TInetAddr &aAddress)
 Sets the editor's value dynamically.
IMPORT_C TInetAddr Address () const
 Gets the editor's value.
virtual IMPORT_C void SetMinimumAndMaximum (const TInetAddr &aMinimumAddress, const TInetAddr &aMaximumAddress)
 Sets the minimum and maximum editor values.
virtual IMPORT_C void GetMinimumAndMaximum (TInetAddr &aMinimumAddress, TInetAddr &aMaximumAddress) const
 Gets the minimum and maximum editor values.
IMPORT_C TInetAddr ReadIPAddress (TResourceReader &aResourceReader)
 Gets an IP address from resources.
IMPORT_C void ConstructFromResourceL (TResourceReader &aResourceReader)
 From CCoeControl.
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
 From CCoeControl.
IMPORT_C void HandlePointerEventL (const TPointerEvent &aPointerEvent)
 From CCoeControl.

Static Public Member Functions

static IMPORT_C CAknIpFieldEditor * NewL (TInetAddr &aMinimumAddress, TInetAddr &aMaximumAddress, TInetAddr &aInitialAddress)
 Two phased constructor.
static IMPORT_C CAknIpFieldEditor * NewL ()
 Two phased constructor.

Constructor & Destructor Documentation

IMPORT_C CAknIpFieldEditor::CAknIpFieldEditor (   ) 
 

C++ default constructor.

Member Function Documentation

IMPORT_C TInetAddr CAknIpFieldEditor::Address (   )  const
 

Gets the editor's value.

Returns:
TInetAddr struct including the address.
IMPORT_C void CAknIpFieldEditor::ConstructFromResourceL ( TResourceReader &  aResourceReader  ) 
 

From CCoeControl.

Constructs controls from a resource file. Essential for Dialog/Form construction.

Parameters:
aResourceReader The resource reader with which to access IP_FIELD_EDITOR resource.
void CAknIpFieldEditor::ConstructL ( TInetAddr &  aMinimumAddress,
TInetAddr &  aMaximumAddress,
TInetAddr &  aInitialAddress,
const TInt  aFlags = 0
) 
 

Two phased constructor.

Parameters:
aMinimumAddress Reference to a TInetAddr struct. Defines lower limits for IP editor fields.
aMaximumAddress Reference to a TInetAddr struct. Defines upper limits for IP editor fields.
aInitialAddress Reference to a TInetAddr struct. Defines the initial address of the IP editor.
aFlags The number field's flags. Default is 0.
Returns:
Pointer to the fully constructed CAknIpFieldEditor object.
virtual IMPORT_C void CAknIpFieldEditor::GetMinimumAndMaximum ( TInetAddr &  aMinimumAddress,
TInetAddr &  aMaximumAddress
)  const [virtual]
 

Gets the minimum and maximum editor values.

Parameters:
aMinimumAddress Reference to a TInetAddr struct in which the lower limits are wanted to be returned.
aMaximumAddress Reference to a TInetAddr struct in which the upper limits are wanted to be returned.
IMPORT_C void CAknIpFieldEditor::HandlePointerEventL ( const TPointerEvent &  aPointerEvent  )  [virtual]
 

From CCoeControl.

Handles pointer events.

Parameters:
aPointerEvent The pointer event.

Reimplemented from CEikMfne.

static IMPORT_C CAknIpFieldEditor* CAknIpFieldEditor::NewL (   )  [static]
 

Two phased constructor.

Requires a call for ConstructFromResourcesL() method to finish construction.

Returns:
Pointer to the constructed CAknIpFieldEditor object.
static IMPORT_C CAknIpFieldEditor* CAknIpFieldEditor::NewL ( TInetAddr &  aMinimumAddress,
TInetAddr &  aMaximumAddress,
TInetAddr &  aInitialAddress
)  [static]
 

Two phased constructor.

Constructs a CAknIpFieldEditor object using given parameters.

Parameters:
aMinimumAddress Reference to a TInetAddr struct. Defines lower limits for IP editor fields.
aMaximumAddress Reference to a TInetAddr struct. Defines upper limits for IP editor fields.
aInitialAddress Reference to a TInetAddr struct. Defines the initial address of the IP editor.
Returns:
Pointer to the fully constructed CAknIpFieldEditor object.
IMPORT_C TKeyResponse CAknIpFieldEditor::OfferKeyEventL ( const TKeyEvent &  aKeyEvent,
TEventCode  aType
)  [virtual]
 

From CCoeControl.

Handles key events. Called by framework when a key event occurs.

Parameters:
aKeyEvent The key event that occured.
aType The type of key event that occured.
Returns:
EKeyWasConsumed if the event was processed, EKeyWasNotConsumed if the event was not processed

Reimplemented from CEikMfne.

IMPORT_C TInetAddr CAknIpFieldEditor::ReadIPAddress ( TResourceReader &  aResourceReader  ) 
 

Gets an IP address from resources.

Parameters:
aResourceReader Reference to a resource reader associated to the IP_FIELD resource.
Returns:
TInetAddr struct including the address.
IMPORT_C void CAknIpFieldEditor::SetAddress ( const TInetAddr &  aAddress  ) 
 

Sets the editor's value dynamically.

Parameters:
aAddress Reference to a TInetAddr struct including the new address.
virtual IMPORT_C void CAknIpFieldEditor::SetMinimumAndMaximum ( const TInetAddr &  aMinimumAddress,
const TInetAddr &  aMaximumAddress
)  [virtual]
 

Sets the minimum and maximum editor values.

Parameters:
aMinimumAddress Reference to a TInetAddr struct defining the lower limits of the editor fields.
aMaximumAddress Reference to a TInetAddr struct defining the upper limits of the editor fields.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top