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.
Protected Member Functions | |
---|---|
IMPORT_C void | Draw (const TRect &) |
TRect | EditRect () |
IMPORT_C TTypeUid::Ptr | MopSupplyObject ( TTypeUid ) |
TRect | ViewRect () |
IMPORT_C void | WriteInternalStateL ( RWriteStream &) |
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 |
Inherited Attributes | |
---|---|
CCoeControl::iCoeEnv | |
CCoeControl::iContext | |
CCoeControl::iPosition | |
CCoeControl::iSize |
void | CalculateNumberOfLinesForControl | ( | TInt | aLines | ) | [private] |
Recalculates the number of required lines for a control.
TInt aLines |
IMPORT_C void | CheckDimmedDisplayState | ( | ) |
Updates captionedcontrol's dimmed state
IMPORT_C CCoeControl * | ComponentControl | ( | TInt | aIndex | ) | const [private, virtual] |
TInt aIndex |
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)
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() ;
TResourceReader & aReader |
TBool | ControlIsAColourSelGrid | ( | TInt | aControlType | ) | const |
TInt aControlType |
TBool | ControlIsAPopfield | ( | TInt | aControlType | ) | const |
TInt aControlType |
TBool | ControlIsASecretEditor | ( | TInt | aControlType | ) | const |
TInt aControlType |
TBool | ControlIsASlider | ( | TInt | aControlType | ) | const |
TInt aControlType |
TBool | ControlIsAnEdwin | ( | TInt | aControlType | ) | const |
TInt aControlType |
void | ConvertEditRectToViewRect | ( | TRect & | aRect | ) | [private, static] |
TRect & aRect |
void | ConvertViewRectToEditRect | ( | TRect & | aRect | ) | [private, static] |
TRect & aRect |
IMPORT_C TBool | DividerAfter | ( | ) | const |
Whether there is a divider after the captionedcontrol
void | DoFormCaptionSettingsL | ( | const TDesC & | aText | ) | [private] |
const TDesC & aText |
IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
const TRect & aRect |
void | DrawAsEikonDialog | ( | const TRect & | aRect | ) | const [private] |
const TRect & aRect |
void | DrawAsForm | ( | const TRect & | aRect | ) | const [private] |
const TRect & aRect |
void | DrawAsFormInEditMode | ( | const TRect & | aRect | ) | const [private] |
const TRect & aRect |
void | DrawAsFormInViewMode | ( | const TRect & | aRect | ) | const [private] |
const TRect & aRect |
void | DrawAsFormUnFocusedLine | ( | const TRect & | aRect | ) | const [private] |
const TRect & aRect |
void | DrawAsSkinnedForm | ( | CWindowGc & | aGc, |
const TRect & | aRect | |||
) | const [private] |
void | DrawEarsNow | ( | TWhichEars | aEar | ) | const [private] |
TWhichEars aEar |
void | DrawFormSeparator | ( | CWindowGc & | gc | ) | const [private] |
Draws the separator between (at the top of current ) caption control(s)
CWindowGc & gc | Current graphics contect |
void | DrawSingleEar | ( | TWhichEars | aEar, |
TBool | aPressed | |||
) | const [private] |
TWhichEars aEar | |
TBool aPressed |
IMPORT_C void * | ExtensionInterface | ( | TUid | aInterface | ) | [private, virtual] |
From CAknControl
TUid aInterface |
void | FireEarL | ( | TWhichEars | aEar, |
TInt | aEarRepeat | |||
) | [private] |
TWhichEars aEar | |
TInt aEarRepeat |
IMPORT_C void | FocusChanged | ( | TDrawNow | aDrawNow | ) | [private, virtual] |
TDrawNow aDrawNow |
void | FormLayoutControlBitmap | ( | CEikImage * | aBitmap, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines | |||
) | [private, static] |
void | FormLayoutControlEdwin | ( | CEikEdwin * | aEdwin, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aBitmapPresent, | |||
TBool | aIsFocused | |||
) | [private] |
void | FormLayoutControlLabel | ( | CEikLabel * | aSlider, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aLayoutWithBitmap, | |||
TBool | aIsFocused, | |||
TInt | aIconCount | |||
) | [private] |
void | FormLayoutControlMfne | ( | CEikMfne * | aMfne, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aBitmapPresent, | |||
TBool | aIsFocused | |||
) | [private] |
void | FormLayoutControlPopfield | ( | CAknPopupField * | aPopfield, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aBitmapPresent, | |||
TBool | aIsFocused | |||
) | [private] |
void | FormLayoutControlSecretEditor | ( | CEikSecretEditor * | aSecretEd, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aBitmapPresent, | |||
TBool | aIsFocused | |||
) | [private] |
void | FormLayoutControlSlider | ( | CAknSlider * | aSlider, |
const TRect & | aParent, | |||
TBool | aIsEditable, | |||
TBool | aSingleLayout, | |||
TInt | aNumberOfLines, | |||
TBool | aBitmapPresent | |||
) | [private, static] |
void | GetAknLayoutValuesL | ( | ) |
Retrieves the Series 60 European LAF layout values from avkon.rh
IMPORT_C void | GetCaptionForFep | ( | TDes & | aCaption | ) | const [private, virtual] |
TDes & aCaption |
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.
CArrayFix < TCoeColorUse > & aColorUseList |
MAknsControlContext * | GetDialogControlContext | ( | const CCoeControl * | aDialog | ) | const [private] |
Gets control context for the given control
const CCoeControl * aDialog | a dialog to get context for If aDialog provided does not exist, TODO |
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
CCoeControl * aControl | The control changing its state (not used) |
TCoeEvent aEventType | The type of control event |
IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
HandlePointerEventL handles touch pointer events
const TPointerEvent & aPointerEvent |
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.
TInt aType |
IMPORT_C TCoeInputCapabilities | InputCapabilities | ( | ) | const [virtual] |
Provides ability to get input capabilities needed for fep
IMPORT_C TBool | LatentGroupLineFollows | ( | ) | const |
Whether captionedcontrol has latent group following it
void | LayoutBitmap | ( | const TRect & | aRect | ) | [private] |
const TRect & aRect |
void | LayoutCaption | ( | const TRect & | aRect | ) | [private] |
const TRect & aRect |
IMPORT_C void | MCoeCaptionRetrieverForFep_Reserved_1 | ( | ) | [private, virtual] |
IMPORT_C void | MCoeCaptionRetrieverForFep_Reserved_2 | ( | ) | [private, virtual] |
IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
MinimumSize() returns minimum size of the control
IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
TTypeUid aId |
IMPORT_C TKeyResponse | OfferKeyEventL | ( | const TKeyEvent & | aKeyEvent, |
TEventCode | aType | |||
) | [virtual] |
OfferKeyEventL() handles key events
const TKeyEvent & aKeyEvent | |
TEventCode aType |
TInt | PictographAnimationCallBack | ( | TAny * | aPtr | ) | [private, static] |
TAny * aPtr |
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 | ) |
CEikDialogPage * aPage |
IMPORT_C void | SetBitmapFromFileL | ( | const TDesC & | aFilename, |
TInt | aMainId, | |||
TInt | aMaskId = -1 | |||
) |
SetBitmapFromFileL() sets icon contents for the captionedcontrol
IMPORT_C void | SetCaptionL | ( | const TDesC & | aText | ) |
SetCaptionL() Sets label of the DLG_LINE
const TDesC & aText | Descriptor |
IMPORT_C void | SetCurrent | ( | TBool | aSelected | ) |
Sets the captionedcontrol to be currently focused or not
TBool aSelected | whether captionedcontrol is focused |
void | SetCurrent | ( | TBool | aSelected, |
TBool | aRedraw | |||
) |
Sets the captionedcontrol to be currently focused or not.
IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
SetDimmed sets captionedcontrol to dimmed state
TBool aDimmed |
IMPORT_C void | SetDividerAfter | ( | TBool | aDividerAfter | ) |
Sets divider after the captionedcontrol
TBool aDividerAfter |
IMPORT_C void | SetDrawNoWhiteBackground | ( | TBool | aEnabled | ) |
Allows clients of CEikCaptionedControl to turn off drawing of white background of captionedcontrol.
TBool aEnabled |
IMPORT_C void | SetEditableL | ( | TBool | aEditable, |
TBool | aShowEmptyFields = ETrue | |||
) |
SetEditable sets captionedcontrol to editable state
void | SetElementBrushColorsL | ( | TRgb | aColor | ) | [private] |
TRgb aColor |
void | SetElementTextColorsL | ( | TRgb | aColor | ) | [private] |
TRgb aColor |
IMPORT_C void | SetExtraAscent | ( | ) |
SetExtraAscent() modifies layout to include extra ascent for fonts
void | SetHorzEdgeSpacing | ( | TInt | aHorzEdgeSpacing | ) | [private] |
TInt aHorzEdgeSpacing |
IMPORT_C void | SetIconL | ( | CFbsBitmap * | aBitmap, |
CFbsBitmap * | aMask | |||
) |
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. |
void | SetIconSizeL | ( | CFbsBitmap * | aBitmap | ) | [private] |
CFbsBitmap * aBitmap |
IMPORT_C void | SetIndicatorIconL | ( | TInt | aIcon, |
CFbsBitmap * | aBitmap, | |||
CFbsBitmap * | aMask | |||
) |
Sets one of the two small indicator icons
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 |
IMPORT_C void | SetLatent | ( | TBool | aLatent | ) |
Sets captionedcontrol latent status
TBool aLatent |
IMPORT_C void | SetLatentGroupLineFollows | ( | TBool | aLglf | ) |
Sets latent group following flag
TBool aLglf | true if latent group following |
IMPORT_C void | SetOfferHotKeys | ( | TBool | aOffer | ) |
Sets captionedcontrol to offer hotkeys
TBool aOffer |
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.
MPointerEventObserver * aObserver |
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.
TInt aFlags |
IMPORT_C void | SetTakesEnterKey | ( | TBool | aTakesEnter | ) |
Sets captionedcontrol to take enter key
TBool aTakesEnter | true if takes enter key, false if not |
IMPORT_C void | SetToolTipTextL | ( | const TDesC & | aText | ) |
SetToolTipTextL() sets tooltip text
const TDesC & aText | descriptor for tooltip text |
IMPORT_C void | SetTrailerL | ( | const TDesC & | aText | ) |
SetTrailerL() Sets trailer Should not be used
const TDesC & aText | Descriptor |
void | SetVertEdgeSpacing | ( | TInt | aVertEdgeSpacing | ) | [private] |
TInt aVertEdgeSpacing |
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.
TInt | SquashComponentWidth | ( | TInt & | aTotalWidth, |
const TInt | aComponentWidthHint | |||
) | [private] |
TAknsQsnTextColorsIndex | TextColorIndex | ( | ) | const [private] |
Returns correct text color index.
TInt | WidthForEars | ( | TInt | aWidthRemaining | ) | const [private] |
TInt aWidthRemaining |
const CCoeControl * | WindowOwningParent | ( | ) | const [private] |
Searches recursively for control's parents until it finds a window owning control
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.
RWriteStream & aWriteStream |
EIfTooSmallCtlGetsWidthLast = 0x0 | |
EIfTooSmallCtlGetsWidthFirst = 0x1 | |
EIfTooSmallCtlGetsEqualShareOfWidth = 0x2 | |
EIfTooBigCtlStaysMinHeight = 0x4 | |
EIfTooBigCtlStaysMinWidth = 0x8 | |
EIfTooBigCtlStaysMinSize = 0xc | |
EIfTooSmallDontStrech = 0x10 |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.