Class MEikListBoxEditor

MEikListBoxEditor

Support

Supported from 6.0

Description

List box text editor interface.

The class specifies an interface to a text editor which can be used inside a list box.

Defined in MEikListBoxEditor:
ItemText(), Release(), StartEditingL(), StopEditingL(), UpdateModelL()

virtual TPtrC ItemText()=0;

Description

Gets a pointer to the current editable item text.

Return value

TPtrC Pointer to the editable item text.

virtual void Release();

Description

Deletes the editor.

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

Description

Creates the editor inside the specified list box 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.

virtual void StopEditingL();

Description

Stops editing and deletes the item editor.

virtual TBool UpdateModelL();

Description

Updates the list box model with the new item contents.

Return value

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