CEikListBoxTextEditor Class Reference

class CEikListBoxTextEditor : public CAknControl

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

Inherits from

Public Member Functions
CEikListBoxTextEditor ( MListBoxModel *)
~CEikListBoxTextEditor ()
IMPORT_C CEikEdwin * Editor ()
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C TPtrC ItemText ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
IMPORT_C void SetFont (const CFont *)
IMPORT_C void SetListBoxEditorObserver ( MListBoxEditorObserver *)
IMPORT_C void StartEditingL (const CCoeControl &, const TRect &, TInt , TInt )
IMPORT_C void StopEditingL ()
IMPORT_C TBool UpdateModelL ()
Protected Member Functions
IMPORT_C TInt ItemIndex ()
IMPORT_C MListBoxModel * ListBoxModel ()
IMPORT_C void Release ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
TPtrC EditableItemText ( TRect *)
IMPORT_C void * ExtensionInterface ( TUid )
IMPORT_C void MEikListBoxEditor_Reserved_1 ()
void UseFontL ( CEikEdwin &, const CFont &)
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::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()
Inherited Enumerations
CCoeControl:TZoomType
Private Attributes
CCharFormatLayer * iCharFormatLayer
CEikEdwin * iEditor
MListBoxEditorObserver * iEditorObserver
CFont * iFont
TInt iItemIndex
TInt iItemLen
TInt iItemPos
MListBoxModel * iModel
CParaFormatLayer * iParaFormatLayer
TInt iSpare
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CEikListBoxTextEditor(MListBoxModel *)

IMPORT_C CEikListBoxTextEditor ( MListBoxModel * aModel )

C++ default constructor.

Parameters

MListBoxModel * aModel Model class of the list box.

~CEikListBoxTextEditor()

IMPORT_C ~CEikListBoxTextEditor ( )

Destructor

Member Functions Documentation

EditableItemText(TRect *)

TPtrC EditableItemText ( TRect * aRect = NULL ) [private]

Parameters

TRect * aRect = NULL

Editor()

IMPORT_C CEikEdwin * Editor ( )

Gets text editor instance as CEikEdwin .

ExtensionInterface(TUid)

IMPORT_C void * ExtensionInterface ( TUid aInterface ) [private, virtual]

Parameters

TUid aInterface

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void HandlePointerEventL ( const TPointerEvent & aPointerEvent ) [virtual]

From CCoeControl . Handles pointer events.

Parameters

const TPointerEvent & aPointerEvent The pointer event.

ItemIndex()

IMPORT_C TInt ItemIndex ( ) const [protected]

Function for getting the list box item index that holds the text editor.

ItemText()

IMPORT_C TPtrC ItemText ( )

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

ListBoxModel()

IMPORT_C MListBoxModel * ListBoxModel ( ) [protected]

Gets the list box model.

MEikListBoxEditor_Reserved_1()

IMPORT_C void MEikListBoxEditor_Reserved_1 ( ) [private]

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

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

Parameters

const TKeyEvent & aKeyEvent The key event
TEventCode aType The type of key event: EEventKey, EEventKeyUp or EEventKeyDown.

Release()

IMPORT_C void Release ( ) [protected]

From MEikListBoxEditor . Deletes the editor.

SetFont(const CFont *)

IMPORT_C void SetFont ( const CFont * aFont )

Sets font to the text editor

Parameters

const CFont * aFont New font for the text editor.

SetListBoxEditorObserver(MListBoxEditorObserver *)

IMPORT_C void SetListBoxEditorObserver ( MListBoxEditorObserver * aObserver )

Sets observer to the text editor.

Parameters

MListBoxEditorObserver * aObserver The list box editor observer interface.

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

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

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

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

StopEditingL()

IMPORT_C void StopEditingL ( )

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

Stops editing the current item, if editing was taking place. Does not Leave.

Since
Uikon1.2

UpdateModelL()

IMPORT_C TBool UpdateModelL ( )

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

UseFontL(CEikEdwin &, const CFont &)

void UseFontL ( CEikEdwin & editor,
const CFont & aFont
) [private]

Parameters

CEikEdwin & editor
const CFont & aFont

WriteInternalStateL(RWriteStream &)

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

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

Writes the internal state of the control and its components to aStream. Does nothing in release mode. Designed to be overidden and base called by subclasses.

Parameters

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

Member Data Documentation

CCharFormatLayer * iCharFormatLayer

CCharFormatLayer * iCharFormatLayer [private]

CEikEdwin * iEditor

CEikEdwin * iEditor [private]

MListBoxEditorObserver * iEditorObserver

MListBoxEditorObserver * iEditorObserver [private]

CFont * iFont

CFont * iFont [private]

TInt iItemIndex

TInt iItemIndex [private]

TInt iItemLen

TInt iItemLen [private]

TInt iItemPos

TInt iItemPos [private]

MListBoxModel * iModel

MListBoxModel * iModel [private]

CParaFormatLayer * iParaFormatLayer

CParaFormatLayer * iParaFormatLayer [private]

TInt iSpare

TInt iSpare [private]