#include <mw/eikcapc.h>
| class CEikCaptionedControl : public CAknControl |
| Public Attributes | |
|---|---|
| CEikImage * | iBitmap |
| CEikCapCLabel * | iCaption |
| HBufC * | iCaptionText |
| CCoeControl * | iControl |
| TInt | iControlType |
| TInt | iId |
| TBool | iIsEditable |
| TBool | iIsFormControl |
| TAny * | iReturnValue |
| CEikLabel * | iTrailer |
| Public Member Enumerations | |
|---|---|
| enum | TCaptionExpandingState { EInitial, EExtended, ERetracted } |
| enum | TSpaceSharingFlags { EIfTooSmallCtlGetsWidthLast, EIfTooSmallCtlGetsWidthFirst, EIfTooSmallCtlGetsEqualShareOfWidth, EIfTooBigCtlStaysMinHeight, ..., EIfTooSmallDontStrech } |
| Protected Member Functions | |
|---|---|
| virtual IMPORT_C void | Draw(const TRect &) |
| IMPORT_C TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| virtual IMPORT_C void | WriteInternalStateL(RWriteStream &) |
| Inherited Attributes | |
|---|---|
| CCoeControl::iCoeEnv | |
| CCoeControl::iContext | |
| CCoeControl::iPosition | |
| CCoeControl::iSize | |
| Inherited Enumerations | |
|---|---|
| CCoeControl:TZoomType | |
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.
| IMPORT_C void | CheckDimmedDisplayState | ( | ) |
Updates captionedcontrol's dimmed state
| IMPORT_C void | ConstructFromResourceL | ( | TResourceReader & | aReader | ) | [virtual] |
Reimplemented from CCoeControl::ConstructFromResourceL(TResourceReader &)
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();
| IMPORT_C TBool | DividerAfter | ( | ) | const |
Whether there is a divider after the captionedcontrol
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
Reimplemented from CCoeControl::Draw(const TRect &)const
| IMPORT_C void | GetColorUseListL | ( | CArrayFix< TCoeColorUse > & | aColorUseList | ) | const [virtual] |
Reimplemented from CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
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.
| IMPORT_C const TPtrC | GetFullCaptionText | ( | ) | const |
GetFullCaptionText() gets caption descriptor
| 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
| Parameter | Description |
|---|---|
| aControl | The control changing its state (not used) |
| aEventType | The type of control event |
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
Reimplemented from CCoeControl::HandlePointerEventL(const TPointerEvent &)
HandlePointerEventL handles touch pointer events
| IMPORT_C void | HandleResourceChange | ( | TInt | aType | ) | [virtual] |
Reimplemented from CCoeControl::HandleResourceChange(TInt)
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.
| IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
Reimplemented from CCoeControl::InputCapabilities()const
Provides ability to get input capabilities needed for fep
| IMPORT_C TBool | LatentGroupLineFollows | ( | ) | const |
Whether captionedcontrol has latent group following it
Returns: true if has latent group following
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
Reimplemented from CCoeControl::MinimumSize()
MinimumSize() returns minimum size of the control
| IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
Reimplemented from CCoeControl::MopSupplyObject(TTypeUid)
| IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
| TEventCode | aType | |||
| ) | [virtual] | |||
Reimplemented from CCoeControl::OfferKeyEventL(const TKeyEvent &,TEventCode)
OfferKeyEventL() handles key events
| 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
| void | RegisterPageWithCaptionControl | ( | CEikDialogPage * | aPage | ) |
SetBitmapFromFileL() sets icon contents for the captionedcontrol
| IMPORT_C void | SetCaptionL | ( | const TDesC & | aText | ) |
SetCaptionL() Sets label of the DLG_LINE
| Parameter | Description |
|---|---|
| aText | Descriptor |
| IMPORT_C void | SetCurrent | ( | TBool | aSelected | ) |
Sets the captionedcontrol to be currently focused or not
| Parameter | Description |
|---|---|
| aSelected | whether captionedcontrol is focused |
| IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
Reimplemented from CCoeControl::SetDimmed(TBool)
SetDimmed sets captionedcontrol to dimmed state
| IMPORT_C void | SetDividerAfter | ( | TBool | aDividerAfter | ) |
Sets divider after the captionedcontrol
| IMPORT_C void | SetDrawNoWhiteBackground | ( | TBool | aEnabled | ) |
Allows clients of CEikCaptionedControl to turn off drawing of white background of captionedcontrol.
| IMPORT_C void | SetExtraAscent | ( | ) |
SetExtraAscent() modifies layout to include extra ascent for fonts
| IMPORT_C void | SetIconL | ( | CFbsBitmap * | aBitmap, |
| CFbsBitmap * | aMask | |||
| ) | ||||
| Parameter | Description |
|---|---|
| aBitmap | a bitmap which has already been loaded. Must not be NULL. |
| aMask | a mask bitmap which has already been loaded. Can be NULL. Takes ownership of the bitmap objects. |
| IMPORT_C void | SetIndicatorIconL | ( | TInt | aIcon, |
| CFbsBitmap * | aBitmap, | |||
| CFbsBitmap * | aMask | |||
| ) | ||||
Sets one of the two small indicator icons
| Parameter | Description |
|---|---|
| aIcon | a index 0 or 1 depending on which icon to set |
| aBitmap | a bitmap pointer or NULL |
| aMask | a mask pointer or NULL |
| IMPORT_C void | SetLatentGroupLineFollows | ( | TBool | aLglf | ) |
Sets latent group following flag
| Parameter | Description |
|---|---|
| aLglf | true if latent group following |
| IMPORT_C void | SetOfferHotKeys | ( | TBool | aOffer | ) |
Sets captionedcontrol to offer hotkeys
| 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.
| 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.
| 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.
| IMPORT_C void | SetTakesEnterKey | ( | TBool | aTakesEnter | ) |
Sets captionedcontrol to take enter key
| Parameter | Description |
|---|---|
| aTakesEnter | true if takes enter key, false if not |
| IMPORT_C void | SetToolTipTextL | ( | const TDesC & | aText | ) |
SetToolTipTextL() sets tooltip text
| Parameter | Description |
|---|---|
| aText | descriptor for tooltip text |
| IMPORT_C void | SetTrailerL | ( | const TDesC & | aText | ) |
SetTrailerL() Sets trailer Should not be used
| Parameter | Description |
|---|---|
| aText | Descriptor |
| IMPORT_C void | WriteInternalStateL | ( | RWriteStream & | aWriteStream | ) | const [protected, virtual] |
Reimplemented from CCoeControl::WriteInternalStateL(RWriteStream &)const
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.