CEikListBoxTextEditor Class Reference

#include <mw/eiklbed.h>

class CEikListBoxTextEditor : public CAknControl

Inherits from

Public Member Functions
CEikListBoxTextEditor(MListBoxModel *)
~CEikListBoxTextEditor()
IMPORT_C CEikEdwin *Editor()
virtual IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C TPtrCItemText()
virtual IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C voidSetFont(const CFont *)
IMPORT_C voidSetListBoxEditorObserver(MListBoxEditorObserver *)
IMPORT_C voidStartEditingL(const CCoeControl &, const TRect &, TInt, TInt)
IMPORT_C voidStopEditingL()
IMPORT_C TBoolUpdateModelL()
Protected Member Functions
IMPORT_C TIntItemIndex()
IMPORT_C MListBoxModel *ListBoxModel()
IMPORT_C voidRelease()
virtual IMPORT_C voidWriteInternalStateL(RWriteStream &)
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize
Inherited Enumerations
CCoeControl:TZoomType
Inherited Functions
CAknControl::CAknControl()
CAknControl::~CAknControl()
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
CCoeControl::AccumulatedZoom()const
CCoeControl::ActivateGc()const
CCoeControl::ActivateL()
CCoeControl::BackedUpWindow()const
CCoeControl::Background()const
CCoeControl::CCoeControl()
CCoeControl::CCoeControl(CCoeEnv *)
CCoeControl::CCoeControl(const CCoeControl &)
CCoeControl::CCoeControlArray
CCoeControl::CapturesPointer()const
CCoeControl::ClaimPointerGrab(TBool)
CCoeControl::ClaimPointerGrab(TInt,TBool)
CCoeControl::CloseWindow()
CCoeControl::ComponentArrayExists()const
CCoeControl::ComponentControl(TInt)const
CCoeControl::Components()
CCoeControl::Components()const
CCoeControl::ConstructFromResourceL(TResourceReader &)
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
CCoeControl::CountComponentControls()const
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
CCoeControl::CreateWindowL()
CCoeControl::CreateWindowL(RWindowGroup *)
CCoeControl::CreateWindowL(RWindowTreeNode &)
CCoeControl::CreateWindowL(const CCoeControl *)
CCoeControl::CustomGc()const
CCoeControl::DeactivateGc()const
CCoeControl::DrawBackground(const TRect &)const
CCoeControl::DrawDeferred()const
CCoeControl::DrawForeground(const TRect &)const
CCoeControl::DrawNow()const
CCoeControl::DrawNow(const TRect &)const
CCoeControl::DrawableWindow()const
CCoeControl::EnableDragEvents()
CCoeControl::EnableReportControlStateChange(TBool)
CCoeControl::EnableWindowTransparency()
CCoeControl::FindBackground()const
CCoeControl::FindFontProvider()const
CCoeControl::FocusChanged(TDrawNow)
CCoeControl::GetColor(TInt,TRgb &)const
CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
CCoeControl::GetGc()const
CCoeControl::GetHelpContext(TCoeHelpContext &)const
CCoeControl::GrabbingComponent()const
CCoeControl::GrabbingComponent(TInt)const
CCoeControl::HandleComponentControlsResourceChange(TInt)
CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray *,CCoeControl *,TInt)
CCoeControl::HandlePointerBufferReadyL()
CCoeControl::HandleRedrawEvent(const TRect &)const
CCoeControl::HandleResourceChange(TInt)
CCoeControl::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
CCoeControl::InputCapabilities()const
CCoeControl::IsActivated()const
CCoeControl::IsBackedUp()const
CCoeControl::IsBeingDestroyed()const
CCoeControl::IsBlank()const
CCoeControl::IsDimmed()const
CCoeControl::IsFocused()const
CCoeControl::IsNonFocusing()const
CCoeControl::IsReadyToDraw()const
CCoeControl::IsVisible()const
CCoeControl::LayoutManager()const
CCoeControl::MakeVisible(TBool)
CCoeControl::MaximumWidth()const
CCoeControl::MinimumSize()
CCoeControl::MopSupplyObject(TTypeUid)
CCoeControl::NotifyFontChange(const CCoeFontProvider *)
CCoeControl::Observer()const
CCoeControl::OverrideColorL(TInt,TRgb)
CCoeControl::OwnsWindow()const
CCoeControl::Parent()
CCoeControl::Parent()const
CCoeControl::Position()const
CCoeControl::PositionChanged()
CCoeControl::PositionRelativeToScreen()const
CCoeControl::PrepareForFocusGainL()
CCoeControl::PrepareForFocusLossL()
CCoeControl::ProcessPointerBufferReadyL()
CCoeControl::ProcessPointerEventL(const TPointerEvent &)
CCoeControl::Rect()const
CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
CCoeControl::RecursivelyMergedInputCapabilities()const
CCoeControl::RefetchPixelMappingL()
CCoeControl::RemoveFromParent()
CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
CCoeControl::RequestRelayout(const CCoeControl *)
CCoeControl::ResetGc()const
CCoeControl::ScreenFont(const TCoeFont &)const
CCoeControl::SetAdjacent(TInt)
CCoeControl::SetAllowStrayPointers()
CCoeControl::SetBackground(const MCoeControlBackground *)
CCoeControl::SetBlank()
CCoeControl::SetCanDrawOutsideRect()
CCoeControl::SetComponentsToInheritVisibility(TBool)
CCoeControl::SetContainerWindowL(RBackedUpWindow &)
CCoeControl::SetContainerWindowL(RWindow &)
CCoeControl::SetContainerWindowL(const CCoeControl &)
CCoeControl::SetControlContext(MCoeControlContext *)
CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
CCoeControl::SetCustomGc(CWindowGc *)
CCoeControl::SetDimmed(TBool)
CCoeControl::SetExtent(const TPoint &,const TSize &)
CCoeControl::SetExtentToWholeScreen()
CCoeControl::SetFocus(TBool,TDrawNow)
CCoeControl::SetFocusing(TBool)
CCoeControl::SetFontProviderL(const CCoeFontProvider &)
CCoeControl::SetGc(CWindowGc *)const
CCoeControl::SetGloballyCapturing(TBool)
CCoeControl::SetHitTest(const MCoeControlHitTest *)
CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
CCoeControl::SetMaximumWidth(TInt)
CCoeControl::SetMopParent(MObjectProvider *)
CCoeControl::SetNeighbor(CCoeControl *)
CCoeControl::SetNonFocusing()
CCoeControl::SetObserver(MCoeControlObserver *)
CCoeControl::SetParent(CCoeControl *)
CCoeControl::SetPointerCapture(TBool)
CCoeControl::SetPosition(const TPoint &)
CCoeControl::SetRect(const TRect &)
CCoeControl::SetSize(const TSize &)
CCoeControl::SetSizeWithoutNotification(const TSize &)
CCoeControl::SetTextBaselineSpacing(TInt)
CCoeControl::SetUniqueHandle(TInt)
CCoeControl::SetZoomFactorL(TInt,TZoomType)
CCoeControl::Size()const
CCoeControl::SizeChanged()
CCoeControl::SystemGc()const
CCoeControl::TextBaselineOffset(const TSize &)const
CCoeControl::TextDrawer(TInt)const
CCoeControl::UniqueHandle()const
CCoeControl::Window()const
CCoeControl::WriteInternalStateNowL(RWriteStream &)const
CCoeControl::ZoomWithType()const
CCoeControl::operator=(const CCoeControl &)
CCoeControl::~CCoeControl()

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.

Since
ER5U

Constructor & Destructor Documentation

CEikListBoxTextEditor ( MListBoxModel * )

IMPORT_CCEikListBoxTextEditor(MListBoxModel *aModel)

C++ default constructor.

ParameterDescription
aModelModel class of the list box.

~CEikListBoxTextEditor ( )

IMPORT_C~CEikListBoxTextEditor()

Destructor

Member Function Documentation

Editor ( )

IMPORT_C CEikEdwin *Editor()

Gets text editor instance as CEikEdwin.

Returns: CEikEdwin* Pointer to the text editor base class instance.

HandlePointerEventL ( const TPointerEvent & )

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)

From CCoeControl. Handles pointer events.

ParameterDescription
aPointerEventThe pointer event.

ItemIndex ( )

IMPORT_C TIntItemIndex()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.

ItemText ( )

IMPORT_C TPtrCItemText()

From MEikListBoxEditor. This function returns the text of the list box item.

Returns: TPtrC Pointer descriptor to the list box item text.

ListBoxModel ( )

IMPORT_C MListBoxModel *ListBoxModel()[protected]

Gets the list box model.

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

OfferKeyEventL ( const TKeyEvent &, TEventCode )

IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &aKeyEvent,
TEventCodeaType
)[virtual]

Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)

From CCoeControl. Handles key press events. Called by the control framework.

ParameterDescription
aKeyEventThe key event
aTypeThe type of key event: EEventKey, EEventKeyUp or EEventKeyDown.

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

Release ( )

IMPORT_C voidRelease()[protected]

From MEikListBoxEditor. Deletes the editor.

SetFont ( const CFont * )

IMPORT_C voidSetFont(const CFont *aFont)

Sets font to the text editor

ParameterDescription
aFontNew font for the text editor.

SetListBoxEditorObserver ( MListBoxEditorObserver * )

IMPORT_C voidSetListBoxEditorObserver(MListBoxEditorObserver *aObserver)

Sets observer to the text editor.

ParameterDescription
aObserverThe list box editor observer interface.

StartEditingL ( const CCoeControl &, const TRect &, TInt, TInt )

IMPORT_C voidStartEditingL(const CCoeControl &aContainer,
const TRect &aRect,
TIntaItemIndex,
TIntaMaxLength
)

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.

ParameterDescription
aContainerContainer class of the list box.
aRectRetangle of the list box item.
aItemIndexIndex of the list box item where text editor will be created.
aMaxLengthMaximum length of editor in characters.

StopEditingL ( )

IMPORT_C voidStopEditingL()

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

UpdateModelL ( )

IMPORT_C TBoolUpdateModelL()

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

WriteInternalStateL ( RWriteStream & )

IMPORT_C voidWriteInternalStateL(RWriteStream &aWriteStream)const [protected, virtual]

Reimplemented from CCoeControl::WriteInternalStateL(RWriteStream &)const

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

ParameterDescription
aWriteStreamStream where control and its components internal state will be written.