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 void CheckDimmedDisplayState ()
IMPORT_C void ConstructFromResourceL ( 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 TBool DividerAfter ()
void DrawClosingLine ()
void GetAknLayoutValuesL ()
IMPORT_C void GetColorUseListL ( CArrayFix < TCoeColorUse > &)
IMPORT_C const TPtrC GetFullCaptionText ()
IMPORT_C void HandleControlEventL ( CCoeControl *, TCoeEvent)
IMPORT_C void HandlePointerEventL (const TPointerEvent &)
IMPORT_C void HandleResourceChange ( TInt )
TBool HasSeparator ()
IMPORT_C TCoeInputCapabilities InputCapabilities ()
TBool IsDisplayable ()
IMPORT_C TBool IsLatent ()
IMPORT_C TBool LatentGroupLineFollows ()
TInt MaximumNumberOfControlLinesOnVisiblePage ()
IMPORT_C TSize MinimumSize ()
TInt NumberOfLines ()
TInt NumberOfLinesForScrollBar ()
IMPORT_C TBool OfferHotKeys ()
IMPORT_C TKeyResponse OfferKeyEventL (const TKeyEvent &, TEventCode )
MPointerEventObserver * PointerEventObserver ()
void PositionFormComponents ()
TBool PressedDownState ()
void RegisterPageWithCaptionControl (CEikDialogPage *)
IMPORT_C void ResetMinimumSizes ()
void ScrollBackEditorL ()
IMPORT_C void SetBitmapFromFileL (const TDesC &, TInt , TInt )
IMPORT_C void SetCaptionL (const TDesC &)
IMPORT_C void SetCurrent ( TBool )
void SetCurrent ( TBool , TBool )
IMPORT_C void SetDimmed ( TBool )
IMPORT_C void SetDividerAfter ( TBool )
IMPORT_C void SetDrawNoWhiteBackground ( TBool )
IMPORT_C void SetEditableL ( TBool , TBool )
IMPORT_C void SetExtraAscent ()
IMPORT_C void SetFormFlags ( TInt )
IMPORT_C void SetIconL ( CFbsBitmap *, CFbsBitmap *)
IMPORT_C void SetIndicatorIconL ( TInt , CFbsBitmap *, CFbsBitmap *)
IMPORT_C void SetLatent ( TBool )
IMPORT_C void SetLatentGroupLineFollows ( TBool )
IMPORT_C void SetOfferHotKeys ( TBool )
void SetPartiallyVisible ( TBool )
void SetPictographCallBack ()
IMPORT_C void SetPointerEventObserver ( MPointerEventObserver *)
void SetPressedDownState ( TBool )
IMPORT_C void SetSpaceSharingFlags ( TInt )
IMPORT_C void SetTakesEnterKey ( TBool )
IMPORT_C void SetToolTipTextL (const TDesC &)
IMPORT_C void SetTrailerL (const TDesC &)
IMPORT_C void SetUsesEars ()
IMPORT_C TBool TakesEnterKey ()
IMPORT_C const TDesC * ToolTipText ()
Protected Member Functions
IMPORT_C void Draw (const TRect &)
TRect EditRect ()
IMPORT_C TTypeUid::Ptr MopSupplyObject ( TTypeUid )
TRect ViewRect ()
IMPORT_C void WriteInternalStateL ( RWriteStream &)
Private Member Functions
void CalculateNumberOfLinesForControl ( TInt )
IMPORT_C CCoeControl * ComponentControl ( TInt )
void ConstructExtensionL ()
void ConvertEditRectToViewRect ( TRect &)
void ConvertViewRectToEditRect ( TRect &)
IMPORT_C TInt CountComponentControls ()
void DoFormCaptionSettingsL (const TDesC &)
void DrawAsEikonDialog (const TRect &)
void DrawAsForm (const TRect &)
void DrawAsFormInEditMode (const TRect &)
void DrawAsFormInViewMode (const TRect &)
void DrawAsFormUnFocusedLine (const TRect &)
void DrawAsSkinnedForm ( CWindowGc &, const TRect &)
void DrawEars ( TWhichEars )
void DrawEarsNow ( TWhichEars )
void DrawFormSeparator ( CWindowGc &)
void DrawSingleEar ( TWhichEars , TBool )
TBool DrawingSkins ()
TRect EarRect ( TWhichEars )
TSize EditorControlSize ()
IMPORT_C void * ExtensionInterface ( TUid )
void FireEarL ( TWhichEars , TInt )
IMPORT_C void FocusChanged ( TDrawNow )
CEikDialogPage::TFormLayoutSelection FormLayout ()
void FormLayoutControlBitmap ( CEikImage *, const TRect &, TBool , TBool , TInt )
void FormLayoutControlEdwin ( CEikEdwin *, const TRect &, TBool , TBool , TInt , TBool , TBool )
void FormLayoutControlLabel ( CEikLabel *, const TRect &, TBool , TBool , TInt , TBool , TBool , TInt )
void FormLayoutControlMfne ( CEikMfne *, const TRect &, TBool , TBool , TInt , TBool , TBool )
void FormLayoutControlPopfield ( CAknPopupField *, const TRect &, TBool , TBool , TInt , TBool , TBool )
void FormLayoutControlSecretEditor ( CEikSecretEditor *, const TRect &, TBool , TBool , TInt , TBool , TBool )
void FormLayoutControlSlider (CAknSlider *, const TRect &, TBool , TBool , TInt , TBool )
IMPORT_C void GetCaptionForFep ( TDes &)
MAknsControlContext * GetDialogControlContext (const CCoeControl *)
void LayoutBitmap (const TRect &)
void LayoutCaption (const TRect &)
void LayoutSkinControlContexts ()
IMPORT_C void MCoeCaptionRetrieverForFep_Reserved_1 ()
IMPORT_C void MCoeCaptionRetrieverForFep_Reserved_2 ()
TInt PictographAnimationCallBack ( TAny *)
void PositionDialogComponents ()
IMPORT_C void Reserved_2 ()
void SetElementBrushColorsL ( TRgb )
void SetElementTextColorsL ( TRgb )
void SetHorzEdgeSpacing ( TInt )
void SetIconSizeL ( CFbsBitmap *)
void SetVertEdgeSpacing ( TInt )
TBool ShowBitmap ()
IMPORT_C void SizeChanged ()
void SizeDialogComponents ()
TInt SquashComponentWidth ( TInt &, const TInt )
void SquashComponents ()
void StretchComponents ()
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
enum TCaptionExpandingState { EInitial  = 0, EExtended  = 1, ERetracted  = 2 }
enum TSpaceSharingFlags {
EIfTooSmallCtlGetsWidthLast  = 0x0, EIfTooSmallCtlGetsWidthFirst  = 0x1, EIfTooSmallCtlGetsEqualShareOfWidth  = 0x2, EIfTooBigCtlStaysMinHeight  = 0x4, EIfTooBigCtlStaysMinWidth  = 0x8, EIfTooBigCtlStaysMinSize  = 0xc, EIfTooSmallDontStrech  = 0x10
}
Private Member Enumerations
enum TWhichEars { 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_C CEikCaptionedControl ( )

Constructor

~CEikCaptionedControl()

IMPORT_C ~CEikCaptionedControl ( )

Destructor

Member Functions Documentation

CalculateNumberOfLinesForControl(TInt)

void CalculateNumberOfLinesForControl ( TInt aLines ) [private]

Recalculates the number of required lines for a control.

Parameters

TInt aLines

CheckDimmedDisplayState()

IMPORT_C void CheckDimmedDisplayState ( )

Updates captionedcontrol's dimmed state

ComponentControl(TInt)

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

Parameters

TInt aIndex

ConstructExtensionL()

void ConstructExtensionL ( ) [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 void ConstructFromResourceL ( 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 ( TInt aControlType ) const

Parameters

TInt aControlType

ControlIsAMfne(TInt)

TBool ControlIsAMfne ( TInt aControlType ) const

Parameters

TInt aControlType

ControlIsAPopfield(TInt)

TBool ControlIsAPopfield ( TInt aControlType ) const

Parameters

TInt aControlType

ControlIsASecretEditor(TInt)

TBool ControlIsASecretEditor ( TInt aControlType ) const

Parameters

TInt aControlType

ControlIsASlider(TInt)

TBool ControlIsASlider ( TInt aControlType ) const

Parameters

TInt aControlType

ControlIsAnEdwin(TInt)

TBool ControlIsAnEdwin ( TInt aControlType ) const

Parameters

TInt aControlType

ControlType()

TInt ControlType ( ) const

ConvertEditRectToViewRect(TRect &)

void ConvertEditRectToViewRect ( TRect & aRect ) [private, static]

Parameters

TRect & aRect

ConvertViewRectToEditRect(TRect &)

void ConvertViewRectToEditRect ( TRect & aRect ) [private, static]

Parameters

TRect & aRect

CountComponentControls()

IMPORT_C TInt CountComponentControls ( ) const [private, virtual]

DialogPage()

const CEikDialogPage * DialogPage ( ) const [inline]

DividerAfter()

IMPORT_C TBool DividerAfter ( ) const

Whether there is a divider after the captionedcontrol

DoFormCaptionSettingsL(const TDesC &)

void DoFormCaptionSettingsL ( const TDesC & aText ) [private]

Parameters

const TDesC & aText

Draw(const TRect &)

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

Parameters

const TRect & aRect

DrawAsEikonDialog(const TRect &)

void DrawAsEikonDialog ( const TRect & aRect ) const [private]

Parameters

const TRect & aRect

DrawAsForm(const TRect &)

void DrawAsForm ( const TRect & aRect ) const [private]

Parameters

const TRect & aRect

DrawAsFormInEditMode(const TRect &)

void DrawAsFormInEditMode ( const TRect & aRect ) const [private]

Parameters

const TRect & aRect

DrawAsFormInViewMode(const TRect &)

void DrawAsFormInViewMode ( const TRect & aRect ) const [private]

Parameters

const TRect & aRect

DrawAsFormUnFocusedLine(const TRect &)

void DrawAsFormUnFocusedLine ( const TRect & aRect ) const [private]

Parameters

const TRect & aRect

DrawAsSkinnedForm(CWindowGc &, const TRect &)

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

Parameters

CWindowGc & aGc
const TRect & aRect

DrawClosingLine()

void DrawClosingLine ( ) const

DrawEars(TWhichEars)

void DrawEars ( TWhichEars aEar ) const [private]

Parameters

TWhichEars aEar

DrawEarsNow(TWhichEars)

void DrawEarsNow ( TWhichEars aEar ) const [private]

Parameters

TWhichEars aEar

DrawFormSeparator(CWindowGc &)

void DrawFormSeparator ( CWindowGc & gc ) const [private]

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

Parameters

CWindowGc & gc Current graphics contect

DrawSingleEar(TWhichEars, TBool)

void DrawSingleEar ( TWhichEars aEar,
TBool aPressed
) const [private]

Parameters

TWhichEars aEar
TBool aPressed

DrawingSkins()

TBool DrawingSkins ( ) const [private]

EarRect(TWhichEars)

TRect EarRect ( TWhichEars aEar ) const [private]

Parameters

TWhichEars aEar

EditRect()

TRect EditRect ( ) const [protected]

EditorControlSize()

TSize EditorControlSize ( ) const [private]

ExtensionInterface(TUid)

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

Parameters

TUid aInterface

FireEarL(TWhichEars, TInt)

void FireEarL ( TWhichEars aEar,
TInt aEarRepeat
) [private]

Parameters

TWhichEars aEar
TInt aEarRepeat

FocusChanged(TDrawNow)

IMPORT_C void FocusChanged ( TDrawNow aDrawNow ) [private, virtual]

Parameters

TDrawNow aDrawNow

FormLayout()

CEikDialogPage::TFormLayoutSelection FormLayout ( ) const [private]

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

void FormLayoutControlBitmap ( CEikImage * aBitmap,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines
) [private, static]

Parameters

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

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

void FormLayoutControlEdwin ( CEikEdwin * aEdwin,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aBitmapPresent,
TBool aIsFocused
) [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)

void FormLayoutControlLabel ( CEikLabel * aSlider,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aLayoutWithBitmap,
TBool aIsFocused,
TInt aIconCount
) [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)

void FormLayoutControlMfne ( CEikMfne * aMfne,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aBitmapPresent,
TBool aIsFocused
) [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)

void FormLayoutControlPopfield ( CAknPopupField * aPopfield,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aBitmapPresent,
TBool aIsFocused
) [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)

void FormLayoutControlSecretEditor ( CEikSecretEditor * aSecretEd,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aBitmapPresent,
TBool aIsFocused
) [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)

void FormLayoutControlSlider ( CAknSlider * aSlider,
const TRect & aParent,
TBool aIsEditable,
TBool aSingleLayout,
TInt aNumberOfLines,
TBool aBitmapPresent
) [private, static]

Parameters

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

GetAknLayoutValuesL()

void GetAknLayoutValuesL ( )

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

GetCaptionForFep(TDes &)

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

Parameters

TDes & aCaption

GetColorUseListL(CArrayFix< TCoeColorUse > &)

IMPORT_C void GetColorUseListL ( 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 * aDialog a dialog to get context for If aDialog provided does not exist, TODO

GetFullCaptionText()

IMPORT_C const TPtrC GetFullCaptionText ( ) const

GetFullCaptionText() gets caption descriptor

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void HandleControlEventL ( CCoeControl * aControl,
TCoeEvent aEventType
) [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 * aControl The control changing its state (not used)
TCoeEvent aEventType The type of control event

HandlePointerEventL(const TPointerEvent &)

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

HandlePointerEventL handles touch pointer events

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [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 TCoeInputCapabilities InputCapabilities ( ) const [virtual]

Provides ability to get input capabilities needed for fep

IsDisplayable()

TBool IsDisplayable ( ) const

IsLatent()

IMPORT_C TBool IsLatent ( ) const

Whether captionedcontrol is latent

LatentGroupLineFollows()

IMPORT_C TBool LatentGroupLineFollows ( ) const

Whether captionedcontrol has latent group following it

LayoutBitmap(const TRect &)

void LayoutBitmap ( const TRect & aRect ) [private]

Parameters

const TRect & aRect

LayoutCaption(const TRect &)

void LayoutCaption ( const TRect & aRect ) [private]

Parameters

const TRect & aRect

LayoutSkinControlContexts()

void LayoutSkinControlContexts ( ) [private]

MCoeCaptionRetrieverForFep_Reserved_1()

IMPORT_C void MCoeCaptionRetrieverForFep_Reserved_1 ( ) [private, virtual]

MCoeCaptionRetrieverForFep_Reserved_2()

IMPORT_C void MCoeCaptionRetrieverForFep_Reserved_2 ( ) [private, virtual]

MaximumNumberOfControlLinesOnVisiblePage()

TInt MaximumNumberOfControlLinesOnVisiblePage ( ) const

MinimumSize()

IMPORT_C TSize MinimumSize ( ) [virtual]

MinimumSize() returns minimum size of the control

MopSupplyObject(TTypeUid)

IMPORT_C TTypeUid::Ptr MopSupplyObject ( TTypeUid aId ) [protected]

Parameters

TTypeUid aId

NumberOfLines()

TInt NumberOfLines ( ) const

NumberOfLinesForScrollBar()

TInt NumberOfLinesForScrollBar ( ) const

OfferHotKeys()

IMPORT_C TBool OfferHotKeys ( ) const

Whether offers hot keys

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse OfferKeyEventL ( const TKeyEvent & aKeyEvent,
TEventCode aType
) [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()

void PositionDialogComponents ( ) [private]

PositionFormComponents()

void PositionFormComponents ( )

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 *)

void RegisterPageWithCaptionControl ( CEikDialogPage * aPage )

Parameters

CEikDialogPage * aPage

Reserved_2()

IMPORT_C void Reserved_2 ( ) [private, virtual]

ResetMinimumSizes()

IMPORT_C void ResetMinimumSizes ( )

Sets minimumsizes to zero

ScrollBackEditorL()

void ScrollBackEditorL ( )

SetBitmapFromFileL(const TDesC &, TInt, TInt)

IMPORT_C void SetBitmapFromFileL ( const TDesC & aFilename,
TInt aMainId,
TInt aMaskId = -1
)

SetBitmapFromFileL() sets icon contents for the captionedcontrol

Parameters

const TDesC & aFilename
TInt aMainId
TInt aMaskId = -1

SetCaptionL(const TDesC &)

IMPORT_C void SetCaptionL ( const TDesC & aText )

SetCaptionL() Sets label of the DLG_LINE

Parameters

const TDesC & aText Descriptor

SetCurrent(TBool)

IMPORT_C void SetCurrent ( TBool aSelected )

Sets the captionedcontrol to be currently focused or not

Parameters

TBool aSelected whether captionedcontrol is focused

SetCurrent(TBool, TBool)

void SetCurrent ( TBool aSelected,
TBool aRedraw
)

Sets the captionedcontrol to be currently focused or not.

Parameters

TBool aSelected whether captionedcontrol is focused
TBool aRedraw whether redraw is needed or not

SetDimmed(TBool)

IMPORT_C void SetDimmed ( TBool aDimmed ) [virtual]

SetDimmed sets captionedcontrol to dimmed state

Parameters

TBool aDimmed

SetDividerAfter(TBool)

IMPORT_C void SetDividerAfter ( TBool aDividerAfter )

Sets divider after the captionedcontrol

Parameters

TBool aDividerAfter

SetDrawNoWhiteBackground(TBool)

IMPORT_C void SetDrawNoWhiteBackground ( TBool aEnabled )

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

Since
2.1

Parameters

TBool aEnabled

SetEditableL(TBool, TBool)

IMPORT_C void SetEditableL ( TBool aEditable,
TBool aShowEmptyFields = ETrue
)

SetEditable sets captionedcontrol to editable state

Parameters

TBool aEditable
TBool aShowEmptyFields = ETrue

SetElementBrushColorsL(TRgb)

void SetElementBrushColorsL ( TRgb aColor ) [private]

Parameters

TRgb aColor

SetElementTextColorsL(TRgb)

void SetElementTextColorsL ( TRgb aColor ) [private]

Parameters

TRgb aColor

SetExtraAscent()

IMPORT_C void SetExtraAscent ( )

SetExtraAscent() modifies layout to include extra ascent for fonts

SetFormFlags(TInt)

IMPORT_C void SetFormFlags ( TInt aFlags )

Parameters

TInt aFlags

SetHorzEdgeSpacing(TInt)

void SetHorzEdgeSpacing ( TInt aHorzEdgeSpacing ) [private]

Parameters

TInt aHorzEdgeSpacing

SetIconL(CFbsBitmap *, CFbsBitmap *)

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

Parameters

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

SetIconSizeL(CFbsBitmap *)

void SetIconSizeL ( 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 void SetIndicatorIconL ( TInt aIcon,
CFbsBitmap * aBitmap,
CFbsBitmap * aMask
)

Sets one of the two small indicator icons

Parameters

TInt aIcon a index 0 or 1 depending on which icon to set
CFbsBitmap * aBitmap a bitmap pointer or NULL
CFbsBitmap * aMask a mask pointer or NULL

SetLatent(TBool)

IMPORT_C void SetLatent ( TBool aLatent )

Sets captionedcontrol latent status

Parameters

TBool aLatent

SetLatentGroupLineFollows(TBool)

IMPORT_C void SetLatentGroupLineFollows ( TBool aLglf )

Sets latent group following flag

Parameters

TBool aLglf true if latent group following

SetOfferHotKeys(TBool)

IMPORT_C void SetOfferHotKeys ( TBool aOffer )

Sets captionedcontrol to offer hotkeys

Parameters

TBool aOffer

SetPartiallyVisible(TBool)

void SetPartiallyVisible ( TBool aPVisible )

Parameters

TBool aPVisible

SetPictographCallBack()

void SetPictographCallBack ( )

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 void SetPointerEventObserver ( 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)

void SetPressedDownState ( TBool aPressed )

Parameters

TBool aPressed

SetSpaceSharingFlags(TInt)

IMPORT_C void SetSpaceSharingFlags ( TInt aFlags )

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 void SetTakesEnterKey ( TBool aTakesEnter )

Sets captionedcontrol to take enter key

Parameters

TBool aTakesEnter true if takes enter key, false if not

SetToolTipTextL(const TDesC &)

IMPORT_C void SetToolTipTextL ( const TDesC & aText )

SetToolTipTextL() sets tooltip text

Parameters

const TDesC & aText descriptor for tooltip text

SetTrailerL(const TDesC &)

IMPORT_C void SetTrailerL ( const TDesC & aText )

SetTrailerL() Sets trailer Should not be used

Parameters

const TDesC & aText Descriptor

SetUsesEars()

IMPORT_C void SetUsesEars ( )

SetUsesEars() sets a flag Uses Ears.

SetVertEdgeSpacing(TInt)

void SetVertEdgeSpacing ( TInt aVertEdgeSpacing ) [private]

Parameters

TInt aVertEdgeSpacing

ShowBitmap()

TBool ShowBitmap ( ) const [private]

SizeChanged()

IMPORT_C void SizeChanged ( ) [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()

void SizeDialogComponents ( ) [private]

SquashComponentWidth(TInt &, const TInt)

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

Parameters

TInt & aTotalWidth
const TInt aComponentWidthHint

SquashComponents()

void SquashComponents ( ) [private]

StretchComponents()

void StretchComponents ( ) [private]

TakesEnterKey()

IMPORT_C TBool TakesEnterKey ( ) 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 ( TInt aWidthRemaining ) 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 void WriteInternalStateL ( 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]