CEikCaptionedControl Class Reference
| class CEikCaptionedControl : public CAknControl |
| 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::CCoeControlArray |
| | 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() |
Detailed Description
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.
Member Attribute Documentation
iBitmap
iCaption
iCaptionText
iControl
iControlType
iId
iIsEditable
iIsFormControl
iReturnValue
iTrailer
Member Enumeration Documentation
Enum TCaptionExpandingState
Enum TSpaceSharingFlags
Constructor & Destructor Documentation
CEikCaptionedControl ( )
| IMPORT_C | CEikCaptionedControl | ( | ) | |
~CEikCaptionedControl ( )
| IMPORT_C | ~CEikCaptionedControl | ( | ) | |
Member Function Documentation
CheckDimmedDisplayState ( )
| IMPORT_C void | CheckDimmedDisplayState | ( | ) | |
Updates captionedcontrol's dimmed state
ConstructFromResourceL ( TResourceReader & )
ControlIsAColourSelGrid ( TInt )
|
TBool
| ControlIsAColourSelGrid | ( | TInt | aControlType | ) | const |
ControlIsAMfne ( TInt )
ControlIsAPopfield ( TInt )
|
TBool
| ControlIsAPopfield | ( | TInt | aControlType | ) | const |
ControlIsASecretEditor ( TInt )
|
TBool
| ControlIsASecretEditor | ( | TInt | aControlType | ) | const |
ControlIsASlider ( TInt )
|
TBool
| ControlIsASlider | ( | TInt | aControlType | ) | const |
ControlIsAnEdwin ( TInt )
|
TBool
| ControlIsAnEdwin | ( | TInt | aControlType | ) | const |
ControlType ( )
DialogPage ( )
| const CEikDialogPage * | DialogPage | ( | ) | const [inline] |
DividerAfter ( )
| IMPORT_C TBool | DividerAfter | ( | ) | const |
Whether there is a divider after the captionedcontrol
Draw ( const TRect & )
| IMPORT_C void | Draw | ( | const TRect & | aRect | ) | const [protected, virtual] |
DrawClosingLine ( )
| void | DrawClosingLine | ( | ) | const |
GetColorUseListL ( CArrayFix< TCoeColorUse > & )
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.
GetFullCaptionText ( )
| IMPORT_C const TPtrC | GetFullCaptionText | ( | ) | const |
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
| Parameter | Description |
|---|
| aControl | The control changing its state (not used) |
| aEventType | The type of control event |
HandlePointerEventL ( const TPointerEvent & )
| IMPORT_C void | HandlePointerEventL | ( | const TPointerEvent & | aPointerEvent | ) | [virtual] |
HandlePointerEventL handles touch pointer events
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.
HasSeparator ( )
|
TBool
| HasSeparator | ( | ) | const |
InputCapabilities ( )
Provides ability to get input capabilities needed for fep
IsDisplayable ( )
|
TBool
| IsDisplayable | ( | ) | const |
IsLatent ( )
| IMPORT_C TBool | IsLatent | ( | ) | const |
Whether captionedcontrol is latent
Returns: true if is latent
LatentGroupLineFollows ( )
| IMPORT_C TBool | LatentGroupLineFollows | ( | ) | const |
Whether captionedcontrol has latent group following it
Returns: true if has latent group following
MaximumNumberOfControlLinesOnVisiblePage ( )
|
TInt
| MaximumNumberOfControlLinesOnVisiblePage | ( | ) | const |
MinimumSize ( )
| IMPORT_C TSize | MinimumSize | ( | ) | [virtual] |
MopSupplyObject ( TTypeUid )
NumberOfLines ( )
|
TInt
| NumberOfLines | ( | ) | const |
OfferHotKeys ( )
| IMPORT_C TBool | OfferHotKeys | ( | ) | const |
Returns: boolean true if offers hotkeys
OfferKeyEventL ( const TKeyEvent &, TEventCode )
PointerEventObserver ( )
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 | ) | |
ResetMinimumSizes ( )
| IMPORT_C void | ResetMinimumSizes | ( | ) | |
Sets minimumsizes to zero
ScrollBackEditorL ( )
SetBitmapFromFileL ( const TDesC &, TInt, TInt )
| IMPORT_C void | SetBitmapFromFileL | ( | const TDesC & | aFilename, |
| | TInt | aMainId, |
| | TInt | aMaskId = -1 |
| | ) | |
SetCaptionL ( const TDesC & )
| IMPORT_C void | SetCaptionL | ( | const TDesC & | aText | ) | |
| Parameter | Description |
|---|
| aText | Descriptor |
SetCurrent ( TBool )
| IMPORT_C void | SetCurrent | ( | TBool | aSelected | ) | |
Sets the captionedcontrol to be currently focused or not
| Parameter | Description |
|---|
| aSelected | whether captionedcontrol is focused |
SetCurrent ( TBool, TBool )
Sets the captionedcontrol to be currently focused or not.
| Parameter | Description |
|---|
| aSelected | whether captionedcontrol is focused |
| aRedraw | whether redraw is needed or not |
SetDimmed ( TBool )
| IMPORT_C void | SetDimmed | ( | TBool | aDimmed | ) | [virtual] |
SetDimmed sets captionedcontrol to dimmed state
SetDividerAfter ( TBool )
| IMPORT_C void | SetDividerAfter | ( | TBool | aDividerAfter | ) | |
Sets divider after the captionedcontrol
SetDrawNoWhiteBackground ( TBool )
| IMPORT_C void | SetDrawNoWhiteBackground | ( | TBool | aEnabled | ) | |
SetEditableL ( TBool, TBool )
| IMPORT_C void | SetEditableL | ( | TBool | aEditable, |
| | TBool | aShowEmptyFields = ETrue |
| | ) | |
SetEditable sets captionedcontrol to editable state
SetExtraAscent ( )
| IMPORT_C void | SetExtraAscent | ( | ) | |
SetFormFlags ( TInt )
| IMPORT_C void | SetFormFlags | ( | TInt | aFlags | ) | |
SetIconL ( CFbsBitmap *, CFbsBitmap * )
Sets icon and sets its size.
- Since
- 2.8
| 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. |
SetIndicatorIconL ( TInt, CFbsBitmap *, CFbsBitmap * )
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 |
SetLatent ( TBool )
| IMPORT_C void | SetLatent | ( | TBool | aLatent | ) | |
Sets captionedcontrol latent status
SetLatentGroupLineFollows ( TBool )
| IMPORT_C void | SetLatentGroupLineFollows | ( | TBool | aLglf | ) | |
Sets latent group following flag
| Parameter | Description |
|---|
| aLglf | true if latent group following |
SetOfferHotKeys ( TBool )
| IMPORT_C void | SetOfferHotKeys | ( | TBool | aOffer | ) | |
Sets captionedcontrol to offer hotkeys
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 * )
SetPointerEventObserver Low level observer for touch related pointer events. This can be used to receive low level pointer events.
SetPressedDownState ( TBool )
| void | SetPressedDownState | ( | 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.
SetTakesEnterKey ( TBool )
| IMPORT_C void | SetTakesEnterKey | ( | TBool | aTakesEnter | ) | |
Sets captionedcontrol to take enter key
| Parameter | Description |
|---|
| aTakesEnter | true if takes enter key, false if not |
SetToolTipTextL ( const TDesC & )
| IMPORT_C void | SetToolTipTextL | ( | const TDesC & | aText | ) | |
| Parameter | Description |
|---|
| aText | descriptor for tooltip text |
SetTrailerL ( const TDesC & )
| IMPORT_C void | SetTrailerL | ( | const TDesC & | aText | ) | |
| Parameter | Description |
|---|
| aText | Descriptor |
SetUsesEars ( )
| IMPORT_C void | SetUsesEars | ( | ) | |
TakesEnterKey ( )
| IMPORT_C TBool | TakesEnterKey | ( | ) | const |
Whether captionedcontrol consumes enter key
ToolTipText ( )
| IMPORT_C const TDesC * | ToolTipText | ( | ) | const |
Ability to query tooltip text string
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.