Class CQikIpEditor

class CQikIpEditor : public CEikBorderedControl, public MQikControlStreamInterface, public MQikTextRepresentationInterface, public MQikCommandHandler, public MQikCommandListOwner;

Description

IP editor.

This class provides a control to edit IP addresses. It handles IPv4 and IPv6 addresses. The IP mode is determined by the address passed to the editor or by setting it explicity.

Input format:

• IPv4 addresses: n.n.n.n where n is decimal 0-255.

• IPv6 addresses: n:n:n:n:n:n:n:n where n is hexadecimal 0-ffff.

• Pv4 compatible addresses: 0:0:0:0:0:0:n.n.n.n where n is decimal 0-255.

• IPv4 mapped address: 0:0:0:0:0:ffff:n.n.n.n where n is decimal 0-255.

• All types of short verisons for IPv6 addresses are also supported.

Output format: The output is always given in normal form, i.e. not short form for IPv6 address.

Assosicated resource: QIK_IP_EDITOR.

Derivation

• MQikCommandListOwner - Interface for classes adding commands
• MQikCommandHandler - Interface for classes responsible of executing commands
• MQikTextRepresentationInterface - MQikTextRepresentationInterface should be implemented by controls that are normally shown in a container pop-out e.g
• MQikControlStreamInterface - MQikControlStreamInterface is used by controls to be able to handle cancel behaviour from e.g
• MEikBorderedControl - Interface for bordered controls

MObjectProvider - An interface that allows an object to be part of a network of object providers

CBase - Base class for all classes to be instantiated on the heap

• CCoeControl - Control base class from which all other controls are derived
• CEikBorderedControl - A control which is drawn surrounded by a rectangular border
• CQikIpEditor - IP editor

Members

Defined in CQikIpEditor:
CQikIpEditor(), ConstructFromResourceL(), ConstructL(), Draw(), FocusChanged(), GetColorUseListL(), HandleCommandL(), HandlePointerEventL(), HandleResourceChange(), IpAddress(), MapCommandHandler(), MinimumSize(), Mode(), MopSupplyObject(), OfferKeyEventL(), PrepareForFocusGainL(), PrepareForFocusLossL(), RestoreUserDataL(), SetControlValueObserver(), SetIpAddress(), SetMode(), SizeChanged(), StoreUserDataL(), TextRepresentationL(), WriteInternalStateL(), ~CQikIpEditor()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleRedrawEvent(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MaximumWidth(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionRelativeToScreen(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), Reserved_CCoeControl_10(), Reserved_CCoeControl_11(), Reserved_CCoeControl_12(), Reserved_CCoeControl_13(), ResetGc(), ScreenFont(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetMaximumWidth(), SetMopParent(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from CEikBorderedControl:
ActivateL(), Border(), ComponentControl(), CountComponentControls(), GetHelpContext(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HasBorder(), InputCapabilities(), MakeVisible(), PositionChanged(), RequestRelayout(), SetAdjacent(), SetBorder(), SetContainerWindowL(), SetDimmed(), SetLayoutManagerL(), SetNeighbor(), SetParent(), SetTextBaselineSpacing(), TextBaselineOffset(), iBorder

Inherited from MEikBorderedControl:
ETypeId, anonymous

Inherited from MObjectProvider:
MopGetObject(), MopGetObjectNoChaining()

Inherited from MQikCommandHandler:
HandleAttemptDimmedSelectionL()

IMPORT_C CQikIpEditor();

Description

Constructor.

virtual IMPORT_C ~CQikIpEditor();

Description

Destructor.

IMPORT_C void ConstructL();

Description

Second phase construction.

IMPORT_C void SetMode(TIpType aIPMode);

Description

Set mode of the ip editor.

Parameters

TIpType aIPMode The mode to use.

Panic codes

EQikPanicUnknownIPMode DEBUG_BUILDS: Unknown IP mode. RELEASE_BUILDS: does nothing.

IMPORT_C TIpType Mode() const;

Description

Get the mode the editor is in.

Return value

TIpType The current mode.

IMPORT_C TInt SetIpAddress(const TDesC &aIpAddress);

Description

Set IP address in editor.

Parameters

const TDesC &aIpAddress The IP address.

Return value

TInt KErrNone if no error, else KErrArgument .

IMPORT_C void IpAddress(TDes &aIpAddress) const;

Description

Get IP address in editor.

Parameters

TDes &aIpAddress IP address in editor.

protected: virtual IMPORT_C TTypeUid::Ptr MopSupplyObject(TTypeUid aId);

Description

Gets an object whose type is encapsulated by the specified TTypeUid object.

Parameters

TTypeUid aId Encapsulates the Uid that identifies the type of object required.

Return value

TTypeUid::Ptr Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Parameters

TResourceReader &aReader

See also:

• CCoeControl::ConstructFromResourceL()

virtual IMPORT_C TSize MinimumSize();

Description

Return value

TSize

See also:

• CCoeControl::MinimumSize()

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

Parameters

TInt aType

See also:

• CCoeControl::HandleResourceChange()

virtual IMPORT_C TKeyResponse OfferKeyEventL(const TKeyEvent &aKeyEvent, TEventCode aType);

Description

Parameters

const TKeyEvent &aKeyEvent TEventCode aType

Return value

TKeyResponse

See also:

• CCoeControl::OfferKeyEventL()

virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;

Description

Parameters

CArrayFix< TCoeColorUse > &aColorUseList

See also:

• CCoeControl::GetColorUseListL()

virtual IMPORT_C void PrepareForFocusLossL();

Description

See also:

• CCoeControl::PrepareForFocusLossL()

virtual IMPORT_C void PrepareForFocusGainL();

Description

See also:

• CCoeControl::PrepareForFocusGainL()

protected: virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Parameters

const TPointerEvent &aPointerEvent

See also:

• CCoeControl::HandlePointerEventL()

protected: virtual IMPORT_C void SizeChanged();

Description

See also:

• CCoeControl::SizeChanged()

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

Parameters

RWriteStream &aWriteStream

See also:

• CCoeControl::WriteInternalStateL()

protected: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);

Description

Parameters

TDrawNow aDrawNow

protected: virtual IMPORT_C void Draw(const TRect &aRect) const;

Description

Parameters

const TRect &aRect

See also:

• CCoeControl::Draw()

virtual IMPORT_C HBufC *TextRepresentationL() const;

Description

This method shall return a textual representation of the controls current value

Return value

HBufC *

virtual IMPORT_C void SetControlValueObserver(MQikControlValueObserver *aObserver);

Description

This method is used to set the control value observer that shall later be notified of control value changes.

Parameters

MQikControlValueObserver *aObserver

protected: virtual IMPORT_C void HandleCommandL(CQikCommand &aCommand);

Description

HandleCommandL is called when the command has been activated by the user.

Parameters

CQikCommand &aCommand

protected: virtual IMPORT_C MQikCommandHandler *MapCommandHandler(CQikCommand &aCommand);

Description

Called from the CQikCommandManager for each command being added which do not already has its handler set.

Parameters

CQikCommand &aCommand

Return value

MQikCommandHandler *

virtual IMPORT_C void StoreUserDataL(RWriteStream &aWriteStream) const;

Description

Write the current value of the control to aWriteStream

Parameters

RWriteStream &aWriteStream The stream that the current control value should be written to

virtual IMPORT_C void RestoreUserDataL(RReadStream &aReadStream);

Description

Read the previously written value of the control from aReadStream

Parameters

RReadStream &aReadStream The stream that holds the previously stored control value