CEikCaptionedControl Class Reference

class CEikCaptionedControl : public CAknControl

CaptionedControl

CaptionedControl is part of the dialogs. All dialogs and forms use captionedcontrol as a control for one DLG_LINE. Each DLG_LINE has one captionedcontrol in it.

Rectangle of the captionedcontrol is single form field / form line or DLG_LINE's rectangle dependent on the dialog type.

Inherits from

Public Member Functions
CEikCaptionedControl()
~CEikCaptionedControl()
IMPORT_C voidCheckDimmedDisplayState()
IMPORT_C voidConstructFromResourceL(TResourceReader &)
TBool ControlIsAColourSelGrid(TInt)
TBool ControlIsAMfne(TInt)
TBool ControlIsAPopfield(TInt)
TBool ControlIsASecretEditor(TInt)
TBool ControlIsASlider(TInt)
TBool ControlIsAnEdwin(TInt)
TInt ControlType()
const CEikDialogPage *DialogPage()
IMPORT_C TBoolDividerAfter()
voidDrawClosingLine()
voidGetAknLayoutValuesL()
IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &)
IMPORT_C const TPtrCGetFullCaptionText()
IMPORT_C voidHandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C voidHandlePointerEventL(const TPointerEvent &)
IMPORT_C voidHandleResourceChange(TInt)
TBool HasSeparator()
IMPORT_C TCoeInputCapabilitiesInputCapabilities()
TBool IsDisplayable()
IMPORT_C TBoolIsLatent()
IMPORT_C TBoolLatentGroupLineFollows()
TInt MaximumNumberOfControlLinesOnVisiblePage()
IMPORT_C TSizeMinimumSize()
TInt NumberOfLines()
TInt NumberOfLinesForScrollBar()
IMPORT_C TBoolOfferHotKeys()
IMPORT_C TKeyResponseOfferKeyEventL(const TKeyEvent &, TEventCode)
MPointerEventObserver *PointerEventObserver()
voidPositionFormComponents()
TBool PressedDownState()
voidRegisterPageWithCaptionControl(CEikDialogPage *)
IMPORT_C voidResetMinimumSizes()
voidScrollBackEditorL()
IMPORT_C voidSetBitmapFromFileL(const TDesC &, TInt, TInt)
IMPORT_C voidSetCaptionL(const TDesC &)
IMPORT_C voidSetCurrent(TBool)
voidSetCurrent(TBool, TBool)
IMPORT_C voidSetDimmed(TBool)
IMPORT_C voidSetDividerAfter(TBool)
IMPORT_C voidSetDrawNoWhiteBackground(TBool)
IMPORT_C voidSetEditableL(TBool, TBool)
IMPORT_C voidSetExtraAscent()
IMPORT_C voidSetFormFlags(TInt)
IMPORT_C voidSetIconL(CFbsBitmap *, CFbsBitmap *)
IMPORT_C voidSetIndicatorIconL(TInt, CFbsBitmap *, CFbsBitmap *)
IMPORT_C voidSetLatent(TBool)
IMPORT_C voidSetLatentGroupLineFollows(TBool)
IMPORT_C voidSetOfferHotKeys(TBool)
voidSetPartiallyVisible(TBool)
voidSetPictographCallBack()
IMPORT_C voidSetPointerEventObserver(MPointerEventObserver *)
voidSetPressedDownState(TBool)
IMPORT_C voidSetSpaceSharingFlags(TInt)
IMPORT_C voidSetTakesEnterKey(TBool)
IMPORT_C voidSetToolTipTextL(const TDesC &)
IMPORT_C voidSetTrailerL(const TDesC &)
IMPORT_C voidSetUsesEars()
IMPORT_C TBoolTakesEnterKey()
IMPORT_C const TDesC *ToolTipText()
Protected Member Functions
IMPORT_C voidDraw(const TRect &)
TRect EditRect()
IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUid)
TRect ViewRect()
IMPORT_C voidWriteInternalStateL(RWriteStream &)
Private Member Functions
voidCalculateNumberOfLinesForControl(TInt)
IMPORT_C CCoeControl *ComponentControl(TInt)
voidConstructExtensionL()
voidConvertEditRectToViewRect(TRect &)
voidConvertViewRectToEditRect(TRect &)
IMPORT_C TIntCountComponentControls()
voidDoFormCaptionSettingsL(const TDesC &)
voidDrawAsEikonDialog(const TRect &)
voidDrawAsForm(const TRect &)
voidDrawAsFormInEditMode(const TRect &)
voidDrawAsFormInViewMode(const TRect &)
voidDrawAsFormUnFocusedLine(const TRect &)
voidDrawAsSkinnedForm(CWindowGc &, const TRect &)
voidDrawEars(TWhichEars)
voidDrawEarsNow(TWhichEars)
voidDrawFormSeparator(CWindowGc &)
voidDrawSingleEar(TWhichEars, TBool)
TBool DrawingSkins()
TRect EarRect(TWhichEars)
TSize EditorControlSize()
IMPORT_C void *ExtensionInterface(TUid)
voidFireEarL(TWhichEars, TInt)
IMPORT_C voidFocusChanged(TDrawNow)
CEikDialogPage::TFormLayoutSelectionFormLayout()
voidFormLayoutControlBitmap(CEikImage *, const TRect &, TBool, TBool, TInt)
voidFormLayoutControlEdwin(CEikEdwin *, const TRect &, TBool, TBool, TInt, TBool, TBool)
voidFormLayoutControlLabel(CEikLabel *, const TRect &, TBool, TBool, TInt, TBool, TBool, TInt)
voidFormLayoutControlMfne(CEikMfne *, const TRect &, TBool, TBool, TInt, TBool, TBool)
voidFormLayoutControlPopfield(CAknPopupField *, const TRect &, TBool, TBool, TInt, TBool, TBool)
voidFormLayoutControlSecretEditor(CEikSecretEditor *, const TRect &, TBool, TBool, TInt, TBool, TBool)
voidFormLayoutControlSlider(CAknSlider *, const TRect &, TBool, TBool, TInt, TBool)
IMPORT_C voidGetCaptionForFep(TDes &)
MAknsControlContext *GetDialogControlContext(const CCoeControl *)
voidLayoutBitmap(const TRect &)
voidLayoutCaption(const TRect &)
voidLayoutSkinControlContexts()
IMPORT_C voidMCoeCaptionRetrieverForFep_Reserved_1()
IMPORT_C voidMCoeCaptionRetrieverForFep_Reserved_2()
TInt PictographAnimationCallBack(TAny *)
voidPositionDialogComponents()
IMPORT_C voidReserved_2()
voidSetElementBrushColorsL(TRgb)
voidSetElementTextColorsL(TRgb)
voidSetHorzEdgeSpacing(TInt)
voidSetIconSizeL(CFbsBitmap *)
voidSetVertEdgeSpacing(TInt)
TBool ShowBitmap()
IMPORT_C voidSizeChanged()
voidSizeDialogComponents()
TInt SquashComponentWidth(TInt &, const TInt)
voidSquashComponents()
voidStretchComponents()
TAknsQsnTextColorsIndex TextColorIndex()
TInt WidthForEars(TInt)
const CCoeControl *WindowOwningParent()
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::Components()
CCoeControl::Components()const
CCoeControl::ControlContext()const
CCoeControl::ControlEnv()const
CCoeControl::CopyControlContextFrom(const CCoeControl *)
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::GetColor(TInt,TRgb &)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::HasBorder()const
CCoeControl::HitTest()const
CCoeControl::IgnoreEventsUntilNextPointerUp()
CCoeControl::Index(const CCoeControl *)const
CCoeControl::InitComponentArrayL()
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::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::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::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()
Public Member Enumerations
enumTCaptionExpandingState { EInitial = 0, EExtended = 1, ERetracted = 2 }
enumTSpaceSharingFlags {
EIfTooSmallCtlGetsWidthLast = 0x0, EIfTooSmallCtlGetsWidthFirst = 0x1, EIfTooSmallCtlGetsEqualShareOfWidth = 0x2, EIfTooBigCtlStaysMinHeight = 0x4, EIfTooBigCtlStaysMinWidth = 0x8, EIfTooBigCtlStaysMinSize = 0xc, EIfTooSmallDontStrech = 0x10
}
Private Member Enumerations
enumTWhichEars { ENoEar = 0x00, ELeftEar = 0x01, ERightEar = 0x02, EBothEars = 0x03 }
Inherited Enumerations
CCoeControl:TZoomType
Public Attributes
CEikImage *iBitmap
CEikCapCLabel *iCaption
HBufC *iCaptionText
CCoeControl *iControl
TInt iControlType
TInt iId
TBool iIsEditable
TBool iIsFormControl
TAny *iReturnValue
CEikLabel *iTrailer
Private Attributes
TInt iAknFormControlHeight
TInt iAknFormControlWidth
TInt iCapCFlags
TInt iCaptionFontId
TInt iCaptionWidth
CEikDialogPage *iDialogPage
TBool iDoNotDisplay
TSize iEditorControlSize
TInt iEditorFontId
CEikCapCExtension *iExtension
TInt iFlags
TInt iFullWidth
TBool iHasAppendedEditIndicator
CCoeControl *iHighlightControl
TInt iHorzEdgeSpacing
TBool iIsCurrentLine
TSize iMinSize
TSize iNormalSize
TInt iNumberOfLines
TInt iOriginalHeight
TInt iPenColor
TBool iRefresh
TInt iShadowColor
HBufC *iToolTipText
TInt iVertEdgeSpacing
TInt iVerticalLineXPosition
Inherited Attributes
CCoeControl::iCoeEnv
CCoeControl::iContext
CCoeControl::iPosition
CCoeControl::iSize

Constructor & Destructor Documentation

CEikCaptionedControl()

IMPORT_CCEikCaptionedControl()

Constructor

~CEikCaptionedControl()

IMPORT_C~CEikCaptionedControl()

Destructor

Member Functions Documentation

CalculateNumberOfLinesForControl(TInt)

voidCalculateNumberOfLinesForControl(TIntaLines)[private]

Recalculates the number of required lines for a control.

Parameters

TInt aLines

CheckDimmedDisplayState()

IMPORT_C voidCheckDimmedDisplayState()

Updates captionedcontrol's dimmed state

ComponentControl(TInt)

IMPORT_C CCoeControl *ComponentControl(TIntaIndex)const [private, virtual]

Parameters

TInt aIndex

ConstructExtensionL()

voidConstructExtensionL()[private]

Constructs the extension object. There is no base constructL, so it is necessary to call this in several places

Ensure that iExtension is constructed (there is no BaseConstructL() in which to place this stuff)

ConstructFromResourceL(TResourceReader &)

IMPORT_C voidConstructFromResourceL(TResourceReader &aReader)[virtual]

ConstructFromResourceL() constructs the captionedcontrol from DLG_LINE resource

usually called with the following code: TResourceReader reader; iCoeEnv->CreateResourceReaderLC(reader, resId); control->ConstructFromResourceL(reader); CleanupStack::PopAndDestroy();

Parameters

TResourceReader & aReader

ControlIsAColourSelGrid(TInt)

TBool ControlIsAColourSelGrid(TIntaControlType)const

Parameters

TInt aControlType

ControlIsAMfne(TInt)

TBool ControlIsAMfne(TIntaControlType)const

Parameters

TInt aControlType

ControlIsAPopfield(TInt)

TBool ControlIsAPopfield(TIntaControlType)const

Parameters

TInt aControlType

ControlIsASecretEditor(TInt)

TBool ControlIsASecretEditor(TIntaControlType)const

Parameters

TInt aControlType

ControlIsASlider(TInt)

TBool ControlIsASlider(TIntaControlType)const

Parameters

TInt aControlType

ControlIsAnEdwin(TInt)

TBool ControlIsAnEdwin(TIntaControlType)const

Parameters

TInt aControlType

ControlType()

TInt ControlType()const

ConvertEditRectToViewRect(TRect &)

voidConvertEditRectToViewRect(TRect &aRect)[private, static]

Parameters

TRect & aRect

ConvertViewRectToEditRect(TRect &)

voidConvertViewRectToEditRect(TRect &aRect)[private, static]

Parameters

TRect & aRect

CountComponentControls()

IMPORT_C TIntCountComponentControls()const [private, virtual]

DialogPage()

const CEikDialogPage *DialogPage()const [inline]

DividerAfter()

IMPORT_C TBoolDividerAfter()const

Whether there is a divider after the captionedcontrol

DoFormCaptionSettingsL(const TDesC &)

voidDoFormCaptionSettingsL(const TDesC &aText)[private]

Parameters

const TDesC & aText

Draw(const TRect &)

IMPORT_C voidDraw(const TRect &aRect)const [protected, virtual]

Parameters

const TRect & aRect

DrawAsEikonDialog(const TRect &)

voidDrawAsEikonDialog(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DrawAsForm(const TRect &)

voidDrawAsForm(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DrawAsFormInEditMode(const TRect &)

voidDrawAsFormInEditMode(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DrawAsFormInViewMode(const TRect &)

voidDrawAsFormInViewMode(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DrawAsFormUnFocusedLine(const TRect &)

voidDrawAsFormUnFocusedLine(const TRect &aRect)const [private]

Parameters

const TRect & aRect

DrawAsSkinnedForm(CWindowGc &, const TRect &)

voidDrawAsSkinnedForm(CWindowGc &aGc,
const TRect &aRect
)const [private]

Parameters

CWindowGc & aGc
const TRect & aRect

DrawClosingLine()

voidDrawClosingLine()const

DrawEars(TWhichEars)

voidDrawEars(TWhichEarsaEar)const [private]

Parameters

TWhichEars aEar

DrawEarsNow(TWhichEars)

voidDrawEarsNow(TWhichEarsaEar)const [private]

Parameters

TWhichEars aEar

DrawFormSeparator(CWindowGc &)

voidDrawFormSeparator(CWindowGc &gc)const [private]

Draws the separator between (at the top of current ) caption control(s)

Parameters

CWindowGc & gcCurrent graphics contect

DrawSingleEar(TWhichEars, TBool)

voidDrawSingleEar(TWhichEarsaEar,
TBoolaPressed
)const [private]

Parameters

TWhichEars aEar
TBool aPressed

DrawingSkins()

TBool DrawingSkins()const [private]

EarRect(TWhichEars)

TRect EarRect(TWhichEarsaEar)const [private]

Parameters

TWhichEars aEar

EditRect()

TRect EditRect()const [protected]

EditorControlSize()

TSize EditorControlSize()const [private]

ExtensionInterface(TUid)

IMPORT_C void *ExtensionInterface(TUidaInterface)[private, virtual]

Parameters

TUid aInterface

FireEarL(TWhichEars, TInt)

voidFireEarL(TWhichEarsaEar,
TIntaEarRepeat
)[private]

Parameters

TWhichEars aEar
TInt aEarRepeat

FocusChanged(TDrawNow)

IMPORT_C voidFocusChanged(TDrawNowaDrawNow)[private, virtual]

Parameters

TDrawNow aDrawNow

FormLayout()

CEikDialogPage::TFormLayoutSelectionFormLayout()const [private]

FormLayoutControlBitmap(CEikImage *, const TRect &, TBool, TBool, TInt)

voidFormLayoutControlBitmap(CEikImage *aBitmap,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines
)[private, static]

Parameters

CEikImage * aBitmap
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines

FormLayoutControlEdwin(CEikEdwin *, const TRect &, TBool, TBool, TInt, TBool, TBool)

voidFormLayoutControlEdwin(CEikEdwin *aEdwin,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaBitmapPresent,
TBoolaIsFocused
)[private]

Parameters

CEikEdwin * aEdwin
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aBitmapPresent
TBool aIsFocused

FormLayoutControlLabel(CEikLabel *, const TRect &, TBool, TBool, TInt, TBool, TBool, TInt)

voidFormLayoutControlLabel(CEikLabel *aSlider,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaLayoutWithBitmap,
TBoolaIsFocused,
TIntaIconCount
)[private]

Parameters

CEikLabel * aSlider
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aLayoutWithBitmap
TBool aIsFocused
TInt aIconCount

FormLayoutControlMfne(CEikMfne *, const TRect &, TBool, TBool, TInt, TBool, TBool)

voidFormLayoutControlMfne(CEikMfne *aMfne,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaBitmapPresent,
TBoolaIsFocused
)[private]

Parameters

CEikMfne * aMfne
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aBitmapPresent
TBool aIsFocused

FormLayoutControlPopfield(CAknPopupField *, const TRect &, TBool, TBool, TInt, TBool, TBool)

voidFormLayoutControlPopfield(CAknPopupField *aPopfield,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaBitmapPresent,
TBoolaIsFocused
)[private]

Parameters

CAknPopupField * aPopfield
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aBitmapPresent
TBool aIsFocused

FormLayoutControlSecretEditor(CEikSecretEditor *, const TRect &, TBool, TBool, TInt, TBool, TBool)

voidFormLayoutControlSecretEditor(CEikSecretEditor *aSecretEd,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaBitmapPresent,
TBoolaIsFocused
)[private]

Parameters

CEikSecretEditor * aSecretEd
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aBitmapPresent
TBool aIsFocused

FormLayoutControlSlider(CAknSlider *, const TRect &, TBool, TBool, TInt, TBool)

voidFormLayoutControlSlider(CAknSlider *aSlider,
const TRect &aParent,
TBoolaIsEditable,
TBoolaSingleLayout,
TIntaNumberOfLines,
TBoolaBitmapPresent
)[private, static]

Parameters

CAknSlider * aSlider
const TRect & aParent
TBool aIsEditable
TBool aSingleLayout
TInt aNumberOfLines
TBool aBitmapPresent

GetAknLayoutValuesL()

voidGetAknLayoutValuesL()

Retrieves the Series 60 European LAF layout values from avkon.rh

GetCaptionForFep(TDes &)

IMPORT_C voidGetCaptionForFep(TDes &aCaption)const [private, virtual]

Parameters

TDes & aCaption

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C voidGetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList)const [virtual]

GetColorUseListL() gets color use list

Gets the list of logical colors employed in the drawing of the control, paired with an explanation of how they are used. Appends the list to aColorUseList.

Since
ER5U

Parameters

CArrayFix< TCoeColorUse > & aColorUseList

GetDialogControlContext(const CCoeControl *)

MAknsControlContext *GetDialogControlContext(const CCoeControl *aDialog)const [private]

Gets control context for the given control

Parameters

const CCoeControl * aDialoga dialog to get context for If aDialog provided does not exist, TODO

GetFullCaptionText()

IMPORT_C const TPtrCGetFullCaptionText()const

GetFullCaptionText() gets caption descriptor

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C voidHandleControlEventL(CCoeControl *aControl,
TCoeEventaEventType
)[virtual]

From MCoeControlObserver: Acts upon changes in the hosted control's state.

This class's implementation handles events from MFNE editor editing buttons in touch enabled builds

Parameters

CCoeControl * aControlThe control changing its state (not used)
TCoeEvent aEventTypeThe type of control event

HandlePointerEventL(const TPointerEvent &)

IMPORT_C voidHandlePointerEventL(const TPointerEvent &aPointerEvent)[virtual]

HandlePointerEventL handles touch pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[virtual]

HandleResourceChange handles several kinds of resource change event

Handles a change to the control's resources of type aType which are shared across the environment, e.g. colors or fonts.

Since
ER5U

Parameters

TInt aType

HasSeparator()

TBool HasSeparator()const

InputCapabilities()

IMPORT_C TCoeInputCapabilitiesInputCapabilities()const [virtual]

Provides ability to get input capabilities needed for fep

IsDisplayable()

TBool IsDisplayable()const

IsLatent()

IMPORT_C TBoolIsLatent()const

Whether captionedcontrol is latent

LatentGroupLineFollows()

IMPORT_C TBoolLatentGroupLineFollows()const

Whether captionedcontrol has latent group following it

LayoutBitmap(const TRect &)

voidLayoutBitmap(const TRect &aRect)[private]

Parameters

const TRect & aRect

LayoutCaption(const TRect &)

voidLayoutCaption(const TRect &aRect)[private]

Parameters

const TRect & aRect

LayoutSkinControlContexts()

voidLayoutSkinControlContexts()[private]

MCoeCaptionRetrieverForFep_Reserved_1()

IMPORT_C voidMCoeCaptionRetrieverForFep_Reserved_1()[private, virtual]

MCoeCaptionRetrieverForFep_Reserved_2()

IMPORT_C voidMCoeCaptionRetrieverForFep_Reserved_2()[private, virtual]

MaximumNumberOfControlLinesOnVisiblePage()

TInt MaximumNumberOfControlLinesOnVisiblePage()const

MinimumSize()

IMPORT_C TSizeMinimumSize()[virtual]

MinimumSize() returns minimum size of the control

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::PtrMopSupplyObject(TTypeUidaId)[protected]

Parameters

TTypeUid aId

NumberOfLines()

TInt NumberOfLines()const

NumberOfLinesForScrollBar()

TInt NumberOfLinesForScrollBar()const

OfferHotKeys()

IMPORT_C TBoolOfferHotKeys()const

Whether offers hot keys

OfferKeyEventL(const TKeyEvent &, TEventCode)

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

OfferKeyEventL() handles key events

Parameters

const TKeyEvent & aKeyEvent
TEventCode aType

PictographAnimationCallBack(TAny *)

TInt PictographAnimationCallBack(TAny *aPtr)[private, static]

Parameters

TAny * aPtr

PointerEventObserver()

MPointerEventObserver *PointerEventObserver()const

PositionDialogComponents()

voidPositionDialogComponents()[private]

PositionFormComponents()

voidPositionFormComponents()

Positions form components in accordance with dialog page flags. If the dialog instance is not registered, them flags set with SetFormFlags() are used.

Avkon component positioning for Forms

PressedDownState()

TBool PressedDownState()const

RegisterPageWithCaptionControl(CEikDialogPage *)

voidRegisterPageWithCaptionControl(CEikDialogPage *aPage)

Parameters

CEikDialogPage * aPage

Reserved_2()

IMPORT_C voidReserved_2()[private, virtual]

ResetMinimumSizes()

IMPORT_C voidResetMinimumSizes()

Sets minimumsizes to zero

ScrollBackEditorL()

voidScrollBackEditorL()

SetBitmapFromFileL(const TDesC &, TInt, TInt)

IMPORT_C voidSetBitmapFromFileL(const TDesC &aFilename,
TIntaMainId,
TIntaMaskId = -1
)

SetBitmapFromFileL() sets icon contents for the captionedcontrol

Parameters

const TDesC & aFilename
TInt aMainId
TInt aMaskId = -1

SetCaptionL(const TDesC &)

IMPORT_C voidSetCaptionL(const TDesC &aText)

SetCaptionL() Sets label of the DLG_LINE

Parameters

const TDesC & aTextDescriptor

SetCurrent(TBool)

IMPORT_C voidSetCurrent(TBoolaSelected)

Sets the captionedcontrol to be currently focused or not

Parameters

TBool aSelectedwhether captionedcontrol is focused

SetCurrent(TBool, TBool)

voidSetCurrent(TBoolaSelected,
TBoolaRedraw
)

Sets the captionedcontrol to be currently focused or not.

Parameters

TBool aSelectedwhether captionedcontrol is focused
TBool aRedrawwhether redraw is needed or not

SetDimmed(TBool)

IMPORT_C voidSetDimmed(TBoolaDimmed)[virtual]

SetDimmed sets captionedcontrol to dimmed state

Parameters

TBool aDimmed

SetDividerAfter(TBool)

IMPORT_C voidSetDividerAfter(TBoolaDividerAfter)

Sets divider after the captionedcontrol

Parameters

TBool aDividerAfter

SetDrawNoWhiteBackground(TBool)

IMPORT_C voidSetDrawNoWhiteBackground(TBoolaEnabled)

Allows clients of CEikCaptionedControl to turn off drawing of white background of captionedcontrol.

Since
2.1

Parameters

TBool aEnabled

SetEditableL(TBool, TBool)

IMPORT_C voidSetEditableL(TBoolaEditable,
TBoolaShowEmptyFields = ETrue
)

SetEditable sets captionedcontrol to editable state

Parameters

TBool aEditable
TBool aShowEmptyFields = ETrue

SetElementBrushColorsL(TRgb)

voidSetElementBrushColorsL(TRgbaColor)[private]

Parameters

TRgb aColor

SetElementTextColorsL(TRgb)

voidSetElementTextColorsL(TRgbaColor)[private]

Parameters

TRgb aColor

SetExtraAscent()

IMPORT_C voidSetExtraAscent()

SetExtraAscent() modifies layout to include extra ascent for fonts

SetFormFlags(TInt)

IMPORT_C voidSetFormFlags(TIntaFlags)

Parameters

TInt aFlags

SetHorzEdgeSpacing(TInt)

voidSetHorzEdgeSpacing(TIntaHorzEdgeSpacing)[private]

Parameters

TInt aHorzEdgeSpacing

SetIconL(CFbsBitmap *, CFbsBitmap *)

IMPORT_C voidSetIconL(CFbsBitmap *aBitmap,
CFbsBitmap *aMask
)
Sets icon and sets its size.
Since
2.8

Parameters

CFbsBitmap * aBitmapa bitmap which has already been loaded. Must not be NULL.
CFbsBitmap * aMaska mask bitmap which has already been loaded. Can be NULL. Takes ownership of the bitmap objects.

SetIconSizeL(CFbsBitmap *)

voidSetIconSizeL(CFbsBitmap *aBitmap)[private]
Sets a size for a bitmap that has already been loaded.
Since
2.8

Parameters

CFbsBitmap * aBitmap

SetIndicatorIconL(TInt, CFbsBitmap *, CFbsBitmap *)

IMPORT_C voidSetIndicatorIconL(TIntaIcon,
CFbsBitmap *aBitmap,
CFbsBitmap *aMask
)

Sets one of the two small indicator icons

Parameters

TInt aIcona index 0 or 1 depending on which icon to set
CFbsBitmap * aBitmapa bitmap pointer or NULL
CFbsBitmap * aMaska mask pointer or NULL

SetLatent(TBool)

IMPORT_C voidSetLatent(TBoolaLatent)

Sets captionedcontrol latent status

Parameters

TBool aLatent

SetLatentGroupLineFollows(TBool)

IMPORT_C voidSetLatentGroupLineFollows(TBoolaLglf)

Sets latent group following flag

Parameters

TBool aLglftrue if latent group following

SetOfferHotKeys(TBool)

IMPORT_C voidSetOfferHotKeys(TBoolaOffer)

Sets captionedcontrol to offer hotkeys

Parameters

TBool aOffer

SetPartiallyVisible(TBool)

voidSetPartiallyVisible(TBoolaPVisible)

Parameters

TBool aPVisible

SetPictographCallBack()

voidSetPictographCallBack()

In case of an editor control residing in a form, sets up a pictograph animation callback to redraw the form highlight control when pictograph animations are updated.

SetPointerEventObserver(MPointerEventObserver *)

IMPORT_C voidSetPointerEventObserver(MPointerEventObserver *aObserver)

SetPointerEventObserver Low level observer for touch related pointer events. This can be used to receive low level pointer events.

Parameters

MPointerEventObserver * aObserver

SetPressedDownState(TBool)

voidSetPressedDownState(TBoolaPressed)

Parameters

TBool aPressed

SetSpaceSharingFlags(TInt)

IMPORT_C voidSetSpaceSharingFlags(TIntaFlags)

SetSpaceSharingFlags() sets flags for space sharing

Sets the flags, aFlags, (see TSpaceSharingFlags), which determine the way space is distributed if the captioned control is given too much or too little space, relative to its minimum size.

Parameters

TInt aFlags

SetTakesEnterKey(TBool)

IMPORT_C voidSetTakesEnterKey(TBoolaTakesEnter)

Sets captionedcontrol to take enter key

Parameters

TBool aTakesEntertrue if takes enter key, false if not

SetToolTipTextL(const TDesC &)

IMPORT_C voidSetToolTipTextL(const TDesC &aText)

SetToolTipTextL() sets tooltip text

Parameters

const TDesC & aTextdescriptor for tooltip text

SetTrailerL(const TDesC &)

IMPORT_C voidSetTrailerL(const TDesC &aText)

SetTrailerL() Sets trailer Should not be used

Parameters

const TDesC & aTextDescriptor

SetUsesEars()

IMPORT_C voidSetUsesEars()

SetUsesEars() sets a flag Uses Ears.

SetVertEdgeSpacing(TInt)

voidSetVertEdgeSpacing(TIntaVertEdgeSpacing)[private]

Parameters

TInt aVertEdgeSpacing

ShowBitmap()

TBool ShowBitmap()const [private]

SizeChanged()

IMPORT_C voidSizeChanged()[private, virtual]

This routine should always called when any state affecting layout changed, including dynamically notified changes to the environment.

This is also called from Cone as a matter of course when SetRect is called on the object.

SizeDialogComponents()

voidSizeDialogComponents()[private]

SquashComponentWidth(TInt &, const TInt)

TInt SquashComponentWidth(TInt &aTotalWidth,
const TIntaComponentWidthHint
)[private]

Parameters

TInt & aTotalWidth
const TInt aComponentWidthHint

SquashComponents()

voidSquashComponents()[private]

StretchComponents()

voidStretchComponents()[private]

TakesEnterKey()

IMPORT_C TBoolTakesEnterKey()const

Whether captionedcontrol consumes enter key

TextColorIndex()

TAknsQsnTextColorsIndex TextColorIndex()const [private]

Returns correct text color index.

Since
S60 5.2

ToolTipText()

IMPORT_C const TDesC *ToolTipText()const

Ability to query tooltip text string

ViewRect()

TRect ViewRect()const [protected]

WidthForEars(TInt)

TInt WidthForEars(TIntaWidthRemaining)const [private]

Parameters

TInt aWidthRemaining

WindowOwningParent()

const CCoeControl *WindowOwningParent()const [private]

Searches recursively for control's parents until it finds a window owning control

WriteInternalStateL(RWriteStream &)

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

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

Member Enumerations Documentation

Enum TCaptionExpandingState

Enumerators

EInitial = 0
EExtended = 1
ERetracted = 2

Enum TSpaceSharingFlags

Enumerators

EIfTooSmallCtlGetsWidthLast = 0x0
EIfTooSmallCtlGetsWidthFirst = 0x1
EIfTooSmallCtlGetsEqualShareOfWidth = 0x2
EIfTooBigCtlStaysMinHeight = 0x4
EIfTooBigCtlStaysMinWidth = 0x8
EIfTooBigCtlStaysMinSize = 0xc
EIfTooSmallDontStrech = 0x10

Enum TWhichEars

Enumerators

ENoEar = 0x00
ELeftEar = 0x01
ERightEar = 0x02
EBothEars = 0x03

Member Data Documentation

TInt iAknFormControlHeight

TInt iAknFormControlHeight[private]

TInt iAknFormControlWidth

TInt iAknFormControlWidth[private]

CEikImage * iBitmap

CEikImage *iBitmap

TInt iCapCFlags

TInt iCapCFlags[private]

CEikCapCLabel * iCaption

CEikCapCLabel *iCaption

TInt iCaptionFontId

TInt iCaptionFontId[private]

HBufC * iCaptionText

HBufC *iCaptionText

TInt iCaptionWidth

TInt iCaptionWidth[private]

CCoeControl * iControl

CCoeControl *iControl

TInt iControlType

TInt iControlType

CEikDialogPage * iDialogPage

CEikDialogPage *iDialogPage[private]

TBool iDoNotDisplay

TBool iDoNotDisplay[private]

TSize iEditorControlSize

TSize iEditorControlSize[private]

TInt iEditorFontId

TInt iEditorFontId[private]

CEikCapCExtension * iExtension

CEikCapCExtension *iExtension[private]

TInt iFlags

TInt iFlags[private]

TInt iFullWidth

TInt iFullWidth[private]

TBool iHasAppendedEditIndicator

TBool iHasAppendedEditIndicator[private]

CCoeControl * iHighlightControl

CCoeControl *iHighlightControl[private]

TInt iHorzEdgeSpacing

TInt iHorzEdgeSpacing[private]

TInt iId

TInt iId

TBool iIsCurrentLine

TBool iIsCurrentLine[private]

TBool iIsEditable

TBool iIsEditable

TBool iIsFormControl

TBool iIsFormControl

TSize iMinSize

TSize iMinSize[private]

TSize iNormalSize

TSize iNormalSize[private]

TInt iNumberOfLines

TInt iNumberOfLines[private]

TInt iOriginalHeight

TInt iOriginalHeight[private]

TInt iPenColor

TInt iPenColor[private]

TBool iRefresh

TBool iRefresh[private]

TAny * iReturnValue

TAny *iReturnValue

TInt iShadowColor

TInt iShadowColor[private]

HBufC * iToolTipText

HBufC *iToolTipText[private]

CEikLabel * iTrailer

CEikLabel *iTrailer

TInt iVertEdgeSpacing

TInt iVertEdgeSpacing[private]

TInt iVerticalLineXPosition

TInt iVerticalLineXPosition[private]