Class CEikCaptionedControl

class CEikCaptionedControl : public CCoeControl, public MCoeCaptionRetrieverForFep;

Description

Deprecated class.

Derivation

• MCoeCaptionRetrieverForFep - Retrieves a control's caption for use by a FEP
• MObjectProvider - An interface that allows an object to be part of a network of object providers
• CBase - Base class for all classes to be instantiated on the heap
• CCoeControl - Control base class from which all other controls are derived
• CEikCaptionedControl - Deprecated class

Members

Defined in CEikCaptionedControl:
CheckDimmedDisplayState(), ComponentControl(), ConstructFromResourceL(), Control(), CountComponentControls(), DividerAfter(), Draw(), EIfTooBigCtlStaysMinHeight, EIfTooBigCtlStaysMinSize, EIfTooBigCtlStaysMinWidth, EIfTooSmallCtlGetsEqualShareOfWidth, EIfTooSmallCtlGetsWidthFirst, EIfTooSmallCtlGetsWidthLast, FocusChanged(), GetCaptionForFep(), GetColorUseListL(), GetTextDrawer(), HandlePointerEventL(), HandleResourceChange(), InputCapabilities(), IsCaptionAboveControl(), IsDenselyPacked(), IsLatent(), LatentGroupLineFollows(), MinimumSize(), OfferHotKeys(), OfferKeyEventL(), ResetMinimumSizes(), SetCaptionAboveControl(), SetCaptionL(), SetCurrent(), SetDenselyPacked(), SetDimmed(), SetDividerAfter(), SetExtraAscent(), SetLatent(), SetLatentGroupLineFollows(), SetOfferHotKeys(), SetSpaceSharingFlags(), SetTakesEnterKey(), SetTrailerL(), SetUseFullWidth(), SizeChanged(), TSpaceSharingFlags, TakesEnterKey(), UsesFullWidth(), WriteInternalStateL(), iCaption, iControl, iControlType, iId, iLayoutValues, iReturnValue, iTrailer, ~CEikCaptionedControl()

Inherited from CBase:
Delete(), Extension_(), operator new()

Inherited from CCoeControl:
AccumulatedZoom(), ActivateGc(), ActivateL(), BackedUpWindow(), Background(), CapturesPointer(), ClaimPointerGrab(), CloseWindow(), ComponentArrayExists(), Components(), ControlContext(), ControlEnv(), CopyControlContextFrom(), CreateBackedUpWindowL(), CreateWindowL(), DeactivateGc(), DrawBackground(), DrawDeferred(), DrawForeground(), DrawNow(), DrawableWindow(), EAbsoluteZoom, ERelativeZoom, EnableDragEvents(), FindBackground(), FindFontProvider(), GetColor(), GetGc(), GetHelpContext(), GrabbingComponent(), HandleComponentControlsResourceChange(), HandleControlArrayEventL(), HandlePointerBufferReadyL(), HandleRedrawEvent(), HasBorder(), HitTest(), IgnoreEventsUntilNextPointerUp(), Index(), InitComponentArrayL(), IsActivated(), IsBackedUp(), IsBeingDestroyed(), IsBlank(), IsDimmed(), IsFocused(), IsNonFocusing(), IsReadyToDraw(), IsVisible(), LayoutManager(), MakeVisible(), MaximumWidth(), MopNext(), MopSupplyObject(), Observer(), OverrideColorL(), OwnsWindow(), Parent(), Position(), PositionChanged(), PositionRelativeToScreen(), PrepareForFocusGainL(), PrepareForFocusLossL(), Rect(), RecursivelyMergedInputCapabilities(), ReportEventL(), RequestRelayout(), Reserved_2(), ResetGc(), ScreenFont(), SetAdjacent(), SetAllowStrayPointers(), SetBackground(), SetBlank(), SetCanDrawOutsideRect(), SetComponentsToInheritVisibility(), SetContainerWindowL(), SetControlContext(), SetCornerAndSize(), SetExtent(), SetExtentToWholeScreen(), SetFocus(), SetFocusing(), SetFontProviderL(), SetGc(), SetGloballyCapturing(), SetHitTest(), SetLayoutManagerL(), SetMaximumWidth(), SetMopParent(), SetNeighbor(), SetNonFocusing(), SetObserver(), SetParent(), SetPointerCapture(), SetPosition(), SetRect(), SetSize(), SetSizeWithoutNotification(), SetTextBaselineSpacing(), SetUniqueHandle(), SetZoomFactorL(), Size(), SystemGc(), TZoomType, TextBaselineOffset(), TextDrawer(), UniqueHandle(), Window(), ZoomWithType(), iCoeEnv, iContext, iPosition, iSize

Inherited from MCoeCaptionRetrieverForFep:
MCoeCaptionRetrieverForFep_Reserved_1(), MCoeCaptionRetrieverForFep_Reserved_2()

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining()

IMPORT_C ~CEikCaptionedControl();

Description

IMPORT_C void SetSpaceSharingFlags(TInt aFlags);

Description

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 minimun size.

Parameters

IMPORT_C void SetExtraAscent();

Description

IMPORT_C void SetCaptionL(const TDesC &aText);

Description

Parameters

IMPORT_C void SetTrailerL(const TDesC &aText);

Description

Parameters

IMPORT_C void SetCurrent(TBool aSelected);

Description

Parameters

IMPORT_C void CheckDimmedDisplayState();

Description

IMPORT_C void ResetMinimumSizes();

Description

IMPORT_C TBool IsLatent() const;

Description

Return value

IMPORT_C void SetLatent(TBool aLatent);

Description

Parameters

IMPORT_C TBool LatentGroupLineFollows() const;

Description

Return value

IMPORT_C void SetLatentGroupLineFollows(TBool aLglf);

Description

Parameters

IMPORT_C TBool DividerAfter() const;

Description

Return value

IMPORT_C void SetDividerAfter(TBool aDividerAfter);

Description

Parameters

IMPORT_C TBool TakesEnterKey() const;

Description

Return value

IMPORT_C void SetTakesEnterKey(TBool aTakesEnter);

Description

Parameters

IMPORT_C TBool OfferHotKeys() const;

Description

Return value

IMPORT_C void SetOfferHotKeys(TBool aOffer);

Description

Parameters

IMPORT_C CCoeControl *Control();

Description

Return value

IMPORT_C TBool IsCaptionAboveControl() const;

Description

Is the caption located above the control?

Return value

IMPORT_C void SetCaptionAboveControl(TBool aAbove);

Description

Set the caption of a captioned control (i.e. dialog line) to be located above the control.

Parameters

IMPORT_C TBool IsDenselyPacked() const;

Description

Is the dialog line densly packed? If it is, the caption and control will be left aligned, and ignored when the rest of the dialog's lines are aligned.

Return value

IMPORT_C void SetDenselyPacked(TBool aDense);

Description

Set the dialog line to be densly packed. If it densly packed, the caption and control will be left aligned, and ignored when the rest of the dialog's lines are aligned.

Parameters

IMPORT_C TBool UsesFullWidth() const;

Description

Should the control use the full width of the dialog. I.e. should the control be as wide as possible?

Return value

IMPORT_C void SetUseFullWidth(TBool aFullWidth);

Description

Set the control of this line to be as wide as possible, i.e. use the full dialog width.

Parameters

virtual IMPORT_C TSize MinimumSize();

Description

Return value

virtual IMPORT_C void ConstructFromResourceL(TResourceReader &aReader);

Description

Parameters

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

Description

Parameters

Return value

virtual IMPORT_C void GetColorUseListL(CArrayFix< TCoeColorUse > &aColorUseList) const;

Description

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.

Parameters

virtual IMPORT_C void HandleResourceChange(TInt aType);

Description

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

Parameters

virtual IMPORT_C TCoeInputCapabilities InputCapabilities() const;

Description

Return value

virtual IMPORT_C void SetDimmed(TBool aDimmed);

Description

Parameters

private: virtual IMPORT_C TInt CountComponentControls() const;

Description

Return value

private: virtual IMPORT_C CCoeControl *ComponentControl(TInt aIndex) const;

Description

Parameters

Return value

private: virtual IMPORT_C void SizeChanged();

Description

private: virtual IMPORT_C void FocusChanged(TDrawNow aDrawNow);

Description

Parameters

private: virtual IMPORT_C void GetTextDrawer(CCoeTextDrawerBase *&aTextDrawer, const CCoeControl *aDrawingControl, TInt aKey) const;

Description

Parameters

protected: virtual IMPORT_C void Draw(const TRect &aRect) const;

Description

Parameters

protected: virtual IMPORT_C void HandlePointerEventL(const TPointerEvent &aPointerEvent);

Description

Parameters

protected: virtual IMPORT_C void WriteInternalStateL(RWriteStream &aWriteStream) const;

Description

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

private: virtual IMPORT_C void GetCaptionForFep(TDes &aCaption) const;

Description

An implementation of this function should fill aCaption with the target control's caption (or as much of the caption as will fit).

For example, code similar to the following might be used (assuming that your caption is stored internally in iCaption):

    const TInt maximumLength=aCaption.MaxLength();
    if (iCaption.Length()>maximumLength)
     {
     aCaption=iCaption.Left(maximumLength);
     }
    else
     {
     aCaption=iCaption;
     }

Parameters

TSpaceSharingFlags

Description

CCoeControl * iControl;

Description

CEikLabel * iCaption;

Description

CEikLabel * iTrailer;

Description

TInt iId;

Description

TInt iControlType;

Description

TAny * iReturnValue;

Description

TQikLayoutValues iLayoutValues;

Description