CEikListBoxTextEditor Class Reference

API published in: S60 1st Ed

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

Capability Information

Required Capabilities

None

#include <eiklbed.h>

Inherits CAknControl, and MEikListBoxEditor.

Inherited by CEikColumnListBoxEditor.

Detailed Description

The CEikListBoxTextEditor implements a text list box item editor.

This editor is used inside of listbox items for editing the list box item text.


Public Member Functions
IMPORT_C�	CEikListBoxTextEditor (MListBoxModel *aModel)
�	C++ default constructor.
IMPORT_C�	~CEikListBoxTextEditor ()
�	Destructor.
IMPORT_C void�	SetFont (const CFont *aFont)
�	Sets font to the text editor.
IMPORT_C CEikEdwin *�	Editor ()
�	Gets text editor instance as `CEikEdwin`.
IMPORT_C void�	SetListBoxEditorObserver (MListBoxEditorObserver *aObserver)
�	Sets observer to the text editor.
IMPORT_C TPtrC�	ItemText ()
�	From `MEikListBoxEditor`.
IMPORT_C void�	StartEditingL (const CCoeControl &aContainer, const TRect &aRect, TInt aItemIndex, TInt aMaxLength)
�	From `MEikListBoxEditor`.
IMPORT_C void�	StopEditingL ()
�	From `MEikListBoxEditor`.
IMPORT_C TBool�	UpdateModelL ()
�	From `MEikListBoxEditor`.
IMPORT_C TKeyResponse�	OfferKeyEventL (const TKeyEvent &aKeyEvent, TEventCode aType)
�	From `CCoeControl`.
IMPORT_C void�	HandlePointerEventL (const TPointerEvent &aPointerEvent)
�	From `CCoeControl`.
Protected Member Functions
IMPORT_C void�	Release ()
�	From `MEikListBoxEditor`.
IMPORT_C MListBoxModel *�	ListBoxModel ()
�	Gets the list box model.
IMPORT_C TInt�	ItemIndex () const
�	Function for getting the list box item index that holds the text editor.
IMPORT_C void�	WriteInternalStateL (RWriteStream &aWriteStream) const
�	This function writes the internal state of the control and its components to `aStream` in debug mode.

Constructor & Destructor Documentation

IMPORT_C CEikListBoxTextEditor::CEikListBoxTextEditor

MListBoxModel *�

C++ default constructor.

Parameters:

Model class of the list box.

IMPORT_C CEikListBoxTextEditor::~CEikListBoxTextEditor

�	Destructor.

Member Function Documentation

IMPORT_C CEikEdwin* CEikListBoxTextEditor::Editor

�	Gets text editor instance as `CEikEdwin`. Returns: CEikEdwin* Pointer to the text editor base class instance.

IMPORT_C void CEikListBoxTextEditor::HandlePointerEventL

const TPointerEvent &�

aPointerEvent

From CCoeControl.

Handles pointer events.

Parameters:

aPointerEvent�

The pointer event.

Reimplemented in CEikColumnListBoxEditor.

IMPORT_C TInt CEikListBoxTextEditor::ItemIndex (� �)� const [protected]

�	Function for getting the list box item index that holds the text editor. Returns: TInt Index of the list box item that holds the text editor.

IMPORT_C TPtrC CEikListBoxTextEditor::ItemText (� �)� [virtual]

�	From `MEikListBoxEditor`. This function returns the text of the list box item. Returns: TPtrC Pointer descriptor to the list box item text. Implements MEikListBoxEditor. Reimplemented in CEikColumnListBoxEditor.

IMPORT_C MListBoxModel* CEikListBoxTextEditor::ListBoxModel (� �)� [protected]

�	Gets the list box model. Returns: MListBoxModel* Pointer to the list box model instance.

IMPORT_C TKeyResponse CEikListBoxTextEditor::OfferKeyEventL	(�	const TKeyEvent &�	aKeyEvent,
		TEventCode�	aType
	)�

From CCoeControl.

Handles key press events. Called by the control framework.

Parameters:

	aKeyEvent�	The key event
	aType�	The type of key event: `EEventKey`, `EEventKeyUp` or `EEventKeyDown`.

Returns:: TKeyResponse Indicates whether or not the key event was used by this control.

IMPORT_C void CEikListBoxTextEditor::Release (� �)� [protected, virtual]

�	From `MEikListBoxEditor`. Deletes the editor. Implements MEikListBoxEditor.

IMPORT_C void CEikListBoxTextEditor::SetFont

const CFont *�

Sets font to the text editor.

Parameters:

New font for the text editor.

IMPORT_C void CEikListBoxTextEditor::SetListBoxEditorObserver

MListBoxEditorObserver *�

Sets observer to the text editor.

Parameters:

The list box editor observer interface.

IMPORT_C void CEikListBoxTextEditor::StartEditingL	(�	const CCoeControl &�	aContainer,
		const TRect &�	aRect,
		TInt�	aItemIndex,
		TInt�	aMaxLength
	)�	`[virtual]`

From MEikListBoxEditor.

This function creates text editor inside the list box item and starts editing of the item text. The list box item can contain partly editable text. This text is between '\n' chars and this control does not modify it.

Parameters:

	aContainer�	Container class of the list box.
	aRect�	Retangle of the list box item.
	aItemIndex�	Index of the list box item where text editor will be created.
	aMaxLength�	Maximum length of editor in characters.

Implements MEikListBoxEditor.

IMPORT_C void CEikListBoxTextEditor::StopEditingL (� �)� [virtual]

�	From `MEikListBoxEditor`. Stops editing the current item and deletes the text editor. Implements MEikListBoxEditor.

IMPORT_C TBool CEikListBoxTextEditor::UpdateModelL (� �)� [virtual]

From MEikListBoxEditor.

Updates the list box model with new text from text editor. If text is partly editable, string between '
' chars is not updated.

Returns:: TBool EFalse if editing is not currently on otherwise ETrue

Implements MEikListBoxEditor.

Reimplemented in CEikColumnListBoxEditor.

IMPORT_C void CEikListBoxTextEditor::WriteInternalStateL (� RWriteStream &� aWriteStream �)� const [protected]

This function writes the internal state of the control and its components to aStream in debug mode.

Does nothing in release mode.

Parameters:

aWriteStream�

Stream where control and its components internal state will be written.

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

eiklbed.h

Copyright � Nokia Corporation 2001-2007