Class CEikListBoxTextEditor

CEikListBoxTextEditor

Support

Supported from 6.0

Description

Text list box item editor.

Derivation

CBase Base class for all classes to be instantiated on the heap CCoeControl Control base class from which all other controls are derived CEikListBoxTextEditor Text list box item editor MEikListBoxEditor List box text editor interface

Defined in CEikListBoxTextEditor:
CEikListBoxTextEditor(), Editor(), ItemIndex(), ItemText(), ListBoxModel(), OfferKeyEventL(), Release(), SetFont(), SetListBoxEditorObserver(), StartEditingL(), StopEditingL(), UpdateModelL(), ~CEikListBoxTextEditor()

Inherited from CBase:
operator new()

Inherited from CCoeControl:
ActivateGc(), ActivateL(), BackedUpWindow(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentControl(), ConstructFromResourceL(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CountComponentControls(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawDeferred(), DrawNow(), DrawableWindow(), EnableDragEvents(), FocusChanged(), GetColor(), GetColorUseListL(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandlePointerBufferReadyL(), HandlePointerEventL(), HandleRedrawEvent(), HandleResourceChange(), HasBorder(), IgnoreEventsUntilNextPointerUp(), Index(), InputCapabilities(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), MakeVisible(), MinimumSize(), Observer(), OverrideColorL(), OwnsWindow(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), ResetGc(), SetAdjacent(), SetAllowStrayPointers(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindow(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetCornerAndSizeL(), SetDimmed(), SetExtent(), SetExtentL(), SetExtentToWholeScreen(), SetExtentToWholeScreenL(), SetFocus(), SetFocusing(), SetGloballyCapturing(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetPointerCapture(), SetPosition(), SetRect(), SetRectL(), SetSize(), SetSizeL(), SetSizeWithoutNotification(), SetSizeWithoutNotificationL(), Size(), SizeChanged(), SizeChangedL(), SystemGc(), Window()

CEikListBoxTextEditor(MListBoxModel* aModel);

Description

Constructor. This constructs a text list box item editor with the specified model.

Parameters

MListBoxModel* aModel Model for the text list box item editor.

~CEikListBoxTextEditor();

Description

Destructor.

CEikEdwin* Editor();

Description

Gets a pointer to the list box editor.

Return value

CEikEdwin* Pointer to the list box editor.

TPtrC ItemText();

Description

Gets a pointer to the current editable item text.

Return value

TPtrC Pointer to the editable item text.

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

Description

Offers a key event.

If an observer exists, it is given the chance to intercept the key events before they are given to the editor, or even prevent them reaching the editor entirely.

Parameters

const TKeyEvent& aKeyEvent The key event. TEventCode aType The event type.

Return value

TKeyResponse Indicates whether the key was consumed.

void SetFont(const CFont* aFont);

Description

Sets the editor’s font.

Parameters

const CFont* aFont The font to use for the list box text editor.

void SetListBoxEditorObserver(MListBoxEditorObserver* aObserver);

Description

Sets the list box editor’s observer.

Parameters

MListBoxEditorObserver* aObserver The list box editor’s observer.

void StartEditingL(const CCoeControl& aContainer,const TRect& aRect,TInt aItemIndex,TInt aMaxLength);

Description

Creates the list box editor inside the specified container.

The editor occupies the rectangle aRect and is used to edit the contents of the item at index aItemIndex up to a maximum number of aMaxLength characters..

Parameters

const CCoeControl& aContainer List box within which the editor is created. const TRect& aRect Editor’s rectangle. TInt aItemIndex Index of the item to edit. TInt aMaxLength Maximum number of characters.

void StopEditingL();

Description

Stops editing and deletes the item editor.

TBool UpdateModelL();

Description

Updates the list box model with the new item contents. This function has no effect if editing is not currently on.

Return value

TBool ETrue if successful, EFalse if editing is not currently on.

protected: TInt ItemIndex() const;

Description

Gets the item index.

Return value

TInt The item index.

protected: MListBoxModel* ListBoxModel();

Description

Gets the list box model.

Return value

MListBoxModel* The list box model.

protected: void Release();

Description

Deletes this editor.