CFepUiBaseCtrl Class Reference

class CFepUiBaseCtrl : public CBase

CFepUiBaseCtrl

Base control for all FEP UI layout controls.

feplayoutcontrol.lib
Since
S60 v4.0

Inherits from

Public Member Functions
CFepUiBaseCtrl(const TRect &, CFepUiLayout *, TInt)
CFepUiBaseCtrl(CCoeControl *, CFepUiLayout *, TBool)
~CFepUiBaseCtrl()
TInt AbsOrderPos()
IMPORT_C voidActiveExtResponseArea()
IMPORT_C voidAddEventObserver(MEventObserver *)
TBool AllowOverlap()
IMPORT_C voidBaseConstructL()
const TRgb &BorderColor()
const TSize &BorderSize()
IMPORT_C voidBringToBack()
IMPORT_C voidBringToTop()
IMPORT_C voidCancelExtResponseArea()
IMPORT_C voidCancelPointerDownL()
IMPORT_C CFepUiBaseCtrl *CapturePointer(TBool)
IMPORT_C voidClear()
IMPORT_C voidClearRect(const TRect &)
TBool CompareOrder(CFepUiBaseCtrl *)
TBool CompareOrderInSameGroup(CFepUiBaseCtrl *)
IMPORT_C voidConstructFromResourceL()
IMPORT_C TBoolContains(const TPoint &)
TInt ControlId()
TControlType ControlType()
IMPORT_C voidDraw()
IMPORT_C voidEnableExtResponseArea(TBool, const TRect &)
IMPORT_C CFepUiBaseCtrl *HandlePointerDownEventL(const TPoint &)
IMPORT_C voidHandlePointerEnter(const TPoint &)
IMPORT_C voidHandlePointerLeave(const TPoint &)
IMPORT_C CFepUiBaseCtrl *HandlePointerMoveEventL(const TPoint &)
IMPORT_C CFepUiBaseCtrl *HandlePointerUpEventL(const TPoint &)
IMPORT_C TBoolHandlePositionChange(const TPoint &)
IMPORT_C voidHide(TBool)
TBool Hiden()
TBool IsActive()
IMPORT_C TBoolIsFepBaseControl()
TBool IsKindOfControl(TStockBaseCtrlType)
TBool IsOnTopOf(CFepUiBaseCtrl *)
IMPORT_C voidMove(const TPoint &)
IMPORT_C const TRect &MovingArea()
NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)
IMPORT_C voidOnActivate()
IMPORT_C voidOnDeActivate()
IMPORT_C voidOnLayoutDraggingEnd()
IMPORT_C voidOnLayoutDraggingStart()
TInt OrderPos()
TBool Overlapped(CFepUiBaseCtrl *)
CFepUiBaseCtrl *ParentCtrl()
const TSize &PenSize()
TBool PointerDown()
IMPORT_C voidReDrawRect(const TRect &)
TBool Ready()
const TRect &Rect()
const RRegion &Region()
IMPORT_C voidRemoveEventObserver(MEventObserver *)
IMPORT_C voidReportEvent(TInt, const TDesC &)
IMPORT_C voidRequireRegionUpdateL(TBool)
TInt32 ResourceId()
IMPORT_C voidSetActive(TBool)
voidSetAllowOverlap(TBool)
IMPORT_C voidSetBackgroundBitmapL(CFbsBitmap *)
IMPORT_C voidSetBackgroundMaskBitmapL(CFbsBitmap *)
voidSetBkColor(const TRgb &)
voidSetBorderColor(const TRgb &)
voidSetBorderSize(const TSize &)
voidSetControlType(TControlType)
voidSetMaskBkCol(const TRgb &)
IMPORT_C voidSetOrdinalPos(TInt)
IMPORT_C voidSetParent(CFepUiBaseCtrl *)
voidSetPenColor(const TRgb &)
voidSetPenSize(const TSize &)
voidSetPointerDown(TBool)
voidSetReady(TBool)
IMPORT_C voidSetRect(const TRect &)
voidSetRegion(const RRegion &)
IMPORT_C voidSetResourceId(TInt32)
IMPORT_C voidSetShadowAreaRect(const TRect &, TShadowBitmapIndex)
IMPORT_C voidSetShadowBmp(CFbsBitmap *, CFbsBitmap *, TShadowBitmapIndex)
IMPORT_C voidSetShadowRect(const TRect &)
IMPORT_C voidSetTactileFeedbackType(TInt)
TRect ShadowAreaRect(TShadowBitmapIndex)
const TRect &ShadowRect()
IMPORT_C voidSimulateRawEvent(const TRawEvent &)
TInt TactileFeedbackType()
IMPORT_C voidUpdateArea(const TRect &, TBool)
IMPORT_C voidUpdateAreaImmed(const TRect &, TBool)
IMPORT_C voidUpdateValidRegion(CFepUiBaseCtrl *, TBool)
IMPORT_C TBoolWholeHiden()
CCoeControl *WndBasedControl()
CCoeControl *WndControl()
Protected Member Functions
IMPORT_C TBoolAbleToDraw()
CFbsBitmap *BackgroundBmp()
voidBaseConstructL(CFepUiLayoutRootCtrl *)
IMPORT_C CBitmapContext *BitGc()
IMPORT_C CFbsBitmapDevice *BitmapDevice()
const TRgb &BkColor()
IMPORT_C CFbsBitmap *BkMaskBmp()
voidCreateOwnDeviceL(CFbsBitmap *, CFbsBitmap *)
voidDisableRegionUpdating()
IMPORT_C voidDrawBackground(TBool)
IMPORT_C voidDrawBackground(const TRect, TBool)
voidDrawBackgroundToDevice(TRect, CFbsDevice *, CFbsBitmap *, const TRgb &, const TRgb &, TBool)
IMPORT_C voidDrawBitmap(const CFbsBitmap *, TBool)
IMPORT_C voidDrawBitmap(const TRect, const CFbsBitmap *, TBool)
IMPORT_C voidDrawMaskBackground(TBool)
IMPORT_C voidDrawOpaqueMaskBackground(TBool)
IMPORT_C voidDrawOpaqueMaskBackground(const TRect, TBool)
IMPORT_C voidDrawShadow()
IMPORT_C voidDrawTransparentMaskBackground(const TRect &, TBool)
voidEnableRegionUpdating()
IMPORT_C TIntExtension_(TUint, TAny *&, TAny *)
IMPORT_C voidGraphicDeviceSizeChanged()
IMPORT_C voidHandleResourceChange(TInt)
IMPORT_C CFbsBitmapDevice *MaskBitmapDevice()
const TRgb &MaskBkCol()
const TRgb &PenColor()
voidResizeDeviceL()
CFepUiLayoutRootCtrl *RootControl()
voidSetBackgroundBmp(CFbsBitmap *)
voidSetBackgroundMaskBmp(CFbsBitmap *)
voidSetHidenFlag(TBool)
CFepUiLayout *UiLayout()
IMPORT_C const TRegion &ValidClipRegion()
Private Member Functions
voidDrawShadowBitmap(const TRect &, TInt)
voidUpdateExtResponseArea(const TRect &)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
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()
Public Member Enumerations
enumTZOrder { EOrderBackground = 1500, EOrderNomal = 1000, EOrderFront = 500, EOrderTopMost = 0 }
Protected Attributes
TRgb iBorderColor
TSize iBorderSize
RRegion iClipRegion
CFepUiBaseCtrl *iParentCtrl
TBool iPointerLeft
TRect iRect
TInt32 iResourceId
TRect iShadowAreaRect
TRect iShadowRect
TBool iUpdateFlagEnabled
RRegion iValidRegion
CCoeControl *iWndControl
Private Attributes
TBool iAllowOverlap
CFbsBitmap *iBackgroundBmp
TRgb iBackgroundCol
CFbsBitmap *iBkMaskBmp
RRegion iClipRegionWithoutLockedArea
TInt iControlId
TControlType iControlType
RPointerArray< MEventObserver >iEventObserverList
TEventType iEventType
CFepUiBaseCtrlExtension *iExtension
TBool iHiden
TBool iIsActive
MLayoutOwner *iLayoutOwner
TRgb iMaskBkCol
TInt iOrdinalPos
TBool iOwnWndCtrl
TRgb iPenColor
TSize iPenSize
TBool iPointerDown
TBool iReady
TInt iReservered2
CFepUiLayoutRootCtrl *iRootCtrl
CFbsBitmap *iShadowBmp
CFepUiLayout *iUiLayout

Constructor & Destructor Documentation

CFepUiBaseCtrl(const TRect &, CFepUiLayout *, TInt)

IMPORT_CCFepUiBaseCtrl(const TRect &aRect,
CFepUiLayout *aUiLayout,
TIntaControlId
)

Constructor

Since
S60 V4.0

Parameters

const TRect & aRectThe rectangle area for this control
CFepUiLayout * aUiLayoutUi layout who contains this control. Ownership not transferred
TInt aControlIdcontrol Id

CFepUiBaseCtrl(CCoeControl *, CFepUiLayout *, TBool)

CFepUiBaseCtrl(CCoeControl *aControl,
CFepUiLayout *aUiLayout,
TBoolaOwnership = ETrue
)

Constructor. Used internally by CControlGroup

Since
S60 V4.0

Parameters

CCoeControl * aControlThe control to be added. The control must set its extent before added to the layout.
CFepUiLayout * aUiLayoutUi layout who contains this control. Ownership not transferred
TBool aOwnership = ETrueThe ownership of the window control. ETrue if it's transfered to this control

~CFepUiBaseCtrl()

IMPORT_C~CFepUiBaseCtrl()[virtual]

Destructor.

Since
S60 V4.0

Member Functions Documentation

AbleToDraw()

IMPORT_C TBoolAbleToDraw()[protected]

Test whether control is able to be drawn. e.g, is ready or shown?

Since
S60 v4.0

AbsOrderPos()

TInt AbsOrderPos()

ActiveExtResponseArea()

IMPORT_C voidActiveExtResponseArea()

Active extra response area

AddEventObserver(MEventObserver *)

IMPORT_C voidAddEventObserver(MEventObserver *aObserver)

Add event obeserver. The observer will get notified when control event happens.

Since
S60 V4.0

Parameters

MEventObserver * aObserverAn event obeserver. Ownership not transferred

AllowOverlap()

TBool AllowOverlap()[inline]

Tell whether it allows other control moving on top of it

Since
S60 V4.0

BackgroundBmp()

CFbsBitmap *BackgroundBmp()[protected, inline]
get control background bmp
Since
S60 V4.0

BaseConstructL()

IMPORT_C voidBaseConstructL()

Do base contruction. Allocate event data buffer Each derived control must call this in its contruction time

Since
S60 v4.0

BaseConstructL(CFepUiLayoutRootCtrl *)

voidBaseConstructL(CFepUiLayoutRootCtrl *aRoot)[protected]

Do base contruction. Allocate event data buffer Each derived control must call this in its contruction time

Since
S60 v4.0

Parameters

CFepUiLayoutRootCtrl * aRootThe root control.

BitGc()

IMPORT_C CBitmapContext *BitGc()[protected]
get graphics context for sprite or window
Since
S60 V4.0

BitmapDevice()

IMPORT_C CFbsBitmapDevice *BitmapDevice()[protected]
get Bitmap device for sprite or window
Since
S60 V4.0

BkColor()

const TRgb &BkColor()[protected, inline]

Get background color

Since
S60 V4.0

BkMaskBmp()

IMPORT_C CFbsBitmap *BkMaskBmp()[protected]
get control background mask bmp
Since
S60 V4.0

BorderColor()

const TRgb &BorderColor()[inline]

Get pen color

Since
S60 V4.0

BorderSize()

const TSize &BorderSize()[inline]

Get border size

Since
S60 V4.0

BringToBack()

IMPORT_C voidBringToBack()

Bring the control to back most in current control group and show it.

Since
S60 V5.0

BringToTop()

IMPORT_C voidBringToTop()

Bring the control to top most in current control group and show it.

Since
S60 V5.0

CancelExtResponseArea()

IMPORT_C voidCancelExtResponseArea()

Cancel extra response area

CancelPointerDownL()

IMPORT_C voidCancelPointerDownL()[virtual]

Cancel pointer down event. This will be called when a control has pointer down but pointer up event happens in other ways. If overrided, this base implementation must be called in order to report the event.

Since
S60 V4.0

CapturePointer(TBool)

IMPORT_C CFepUiBaseCtrl *CapturePointer(TBoolaFlag = ETrue)

Capture or release the pointer. After capturing, all UI layout event will be processed by this control

Since
S60 V4.0

Parameters

TBool aFlag = ETrueThe flag indicates capturing or releasing.

Clear()

IMPORT_C voidClear()

Clear the whole control area

Since
S60 V4.0

ClearRect(const TRect &)

IMPORT_C voidClearRect(const TRect &aRect)

Clear a area in the control

Since
S60 V4.0

Parameters

const TRect & aRectThe rect to be cleared.

CompareOrder(CFepUiBaseCtrl *)

TBool CompareOrder(CFepUiBaseCtrl *aCtrl)

Compare order pos

Since
S60 V5.0

Parameters

CFepUiBaseCtrl * aCtrl

CompareOrderInSameGroup(CFepUiBaseCtrl *)

TBool CompareOrderInSameGroup(CFepUiBaseCtrl *aCtrl)

Compare order pos for two control within the same control grop

Since
S60 V5.0

Parameters

CFepUiBaseCtrl * aCtrl

ConstructFromResourceL()

IMPORT_C voidConstructFromResourceL()

From MOnResourceChangFunctions Construct from resource

Since
S60 V4.0

Contains(const TPoint &)

IMPORT_C TBoolContains(const TPoint &aPt)[virtual]

Check whether this control contains the point

Since
S60 V4.0

Parameters

const TPoint & aPt

ControlId()

TInt ControlId()[inline]

Get control Id

Since
S60 V4.0

ControlType()

TControlType ControlType()[inline]

Return control type

Since
S60 V4.0

CreateOwnDeviceL(CFbsBitmap *, CFbsBitmap *)

voidCreateOwnDeviceL(CFbsBitmap *aBmp,
CFbsBitmap *aMaskBmp = 0
)[protected]

Parameters

CFbsBitmap * aBmp
CFbsBitmap * aMaskBmp = 0

DisableRegionUpdating()

voidDisableRegionUpdating()[protected, inline]

Enable region update

Since
S60 v5.0

Draw()

IMPORT_C voidDraw()[virtual]

Pure virtual function, draws the control

Since
S60 V4.0

DrawBackground(TBool)

IMPORT_C voidDrawBackground(TBoolaBmpStretchFlag = ETrue)[protected]

Draw background.

Since
S60 v4.0

Parameters

TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.

DrawBackground(const TRect, TBool)

IMPORT_C voidDrawBackground(const TRectaRect,
TBoolaBmpStretchFlag = ETrue
)[protected]

Draw background.

Since
S60 v4.0

Parameters

const TRect aRectRect to be draw to fit the rect. Default value is ETrue.
TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched

DrawBackgroundToDevice(TRect, CFbsDevice *, CFbsBitmap *, const TRgb &, const TRgb &, TBool)

voidDrawBackgroundToDevice(TRectaRect,
CFbsDevice *aDevice,
CFbsBitmap *aBmp,
const TRgb &aBrushCol,
const TRgb &aPenCol,
TBoolaBmpStretchFlag
)[protected]

Draw background to device

Since
S60 v4.0

Parameters

TRect aRectThe device rect to be filled.
CFbsDevice * aDevice
CFbsBitmap * aBmpThe background bmp
const TRgb & aBrushColThe brush color
const TRgb & aPenColThe pen color
TBool aBmpStretchFlagThe stretch flag for drawing bitmap.

DrawBitmap(const CFbsBitmap *, TBool)

IMPORT_C voidDrawBitmap(const CFbsBitmap *aBitmap,
TBoolaStretchFlag
)[protected]

Draw bitmap to control rect

Parameters

const CFbsBitmap * aBitmapThe given bitmap
TBool aStretchFlagThe flag tells whether this bitmap should be stretched

DrawBitmap(const TRect, const CFbsBitmap *, TBool)

IMPORT_C voidDrawBitmap(const TRectaRect,
const CFbsBitmap *aBitmap,
TBoolaStretchFlag
)[protected]

Draw bitmap to control rect

Parameters

const TRect aRectThe drawn rect
const CFbsBitmap * aBitmapThe given bitmap
TBool aStretchFlagThe flag tells whether this bitmap should be stretched

DrawMaskBackground(TBool)

IMPORT_C voidDrawMaskBackground(TBoolaBmpStretchFlag = ETrue)[protected]

Draw mask background

Since
S60 v4.0

Parameters

TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.

DrawOpaqueMaskBackground(TBool)

IMPORT_C voidDrawOpaqueMaskBackground(TBoolaBmpStretchFlag = ETrue)[protected]

Draw opaque mask background. Draw an opaque ground.

Since
S60 v4.0

Parameters

TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.

DrawOpaqueMaskBackground(const TRect, TBool)

IMPORT_C voidDrawOpaqueMaskBackground(const TRectaRect,
TBoolaBmpStretchFlag = ETrue
)[protected]

Draw opaque mask background. Draw an opaque ground.

Since
S60 v4.0

Parameters

const TRect aRectRect to be draw to fit the rect. Default value is ETrue.
TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched

DrawShadow()

IMPORT_C voidDrawShadow()[protected]

Draw shadow

Since
S60 V4.0

DrawShadowBitmap(const TRect &, TInt)

voidDrawShadowBitmap(const TRect &aRect,
TIntaIndex
)[private]

Draw shadow bitmap

Since
S60 V4.0

Parameters

const TRect & aRectThe rect to be drawn
TInt aIndexThe shadow bitmap position index

DrawTransparentMaskBackground(const TRect &, TBool)

IMPORT_C voidDrawTransparentMaskBackground(const TRect &aRect,
TBoolaBmpStretchFlag = ETrue
)[protected]

Draw transparent mask background

Since
S60 v4.0

Parameters

const TRect & aRect
TBool aBmpStretchFlag = ETrueFlag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.

EnableExtResponseArea(TBool, const TRect &)

IMPORT_C voidEnableExtResponseArea(TBoolaEnable,
const TRect &aExtMargin
)

Enable/disable extra response area support

Parameters

TBool aEnableETrue to enable, or EFalse to disable
const TRect & aExtMarginmargin of extra response area

EnableRegionUpdating()

voidEnableRegionUpdating()[protected, inline]

Enable region update

Since
S60 v5.0

Extension_(TUint, TAny *&, TAny *)

IMPORT_C TIntExtension_(TUintaExtensionId,
TAny *&a0,
TAny *a1
)[protected, virtual]

Get the extension

Since
S60 v5.0

Parameters

TUint aExtensionIdExtension UID
TAny *& a0The extension returned
TAny * a1Any passed in parameter.

GraphicDeviceSizeChanged()

IMPORT_C voidGraphicDeviceSizeChanged()[protected, virtual]

Handle pen UI graphic device size change event

Since
S60 V5.0

HandlePointerDownEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *HandlePointerDownEventL(const TPoint &aPoint)[virtual]

Handle pointer down event

Since
S60 V4.0

Parameters

const TPoint & aPointThe point position relative the layout

HandlePointerEnter(const TPoint &)

IMPORT_C voidHandlePointerEnter(const TPoint &aPoint)[virtual]

Handle pointer enter event. This will be called only when it's got pointer down event before and pointer leaves but now comes back without pointer up event.

Since
S60 V4.0

Parameters

const TPoint & aPointcurrent pointer position

HandlePointerLeave(const TPoint &)

IMPORT_C voidHandlePointerLeave(const TPoint &aPoint)[virtual]

Handle pointer levae event. This will be called only when it's got pointer down event before and now pointer leaves without pointer up event

Since
S60 V4.0

Parameters

const TPoint & aPointcurrent pointer position

HandlePointerMoveEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *HandlePointerMoveEventL(const TPoint &aPoint)[virtual]

Handle pointer move event

Since
S60 V4.0

Parameters

const TPoint & aPointThe point position relative the layout

HandlePointerUpEventL(const TPoint &)

IMPORT_C CFepUiBaseCtrl *HandlePointerUpEventL(const TPoint &aPoint)[virtual]

Handle pointer up event

Since
S60 V4.0

Parameters

const TPoint & aPointThe point position relative the layout

HandlePositionChange(const TPoint &)

IMPORT_C TBoolHandlePositionChange(const TPoint &aOffset)

From MPositionObserver Handle position change event. It's called to change the position after it's being dragging

Since
S60 V4.0

Parameters

const TPoint & aOffsetThe moving offset

HandleResourceChange(TInt)

IMPORT_C voidHandleResourceChange(TIntaType)[protected, virtual]

Handle system resource change

Since
S60 V5.0

Parameters

TInt aTypeThe system resource change type

Hide(TBool)

IMPORT_C voidHide(TBoolaFlag)[virtual]

Hide or shoe control. A hiden control will not handle the event.

Since
S60 V4.0

Parameters

TBool aFlagETrue if want to hide the control.

Hiden()

TBool Hiden()[inline]

Get hide flag

Since
S60 V4.0

IsActive()

TBool IsActive()[inline]

Get active status

Since
S60 V4.0

IsFepBaseControl()

IMPORT_C TBoolIsFepBaseControl()

From MPositionObserver Tell whether this observer is a fep base control

Since
S60 v4.0

IsKindOfControl(TStockBaseCtrlType)

TBool IsKindOfControl(TStockBaseCtrlTypeaCtrlClass)[inline]

Test whether the control belongs one kind of control class

Since
S60 V4.0

Parameters

TStockBaseCtrlType aCtrlClassThe control class type

IsOnTopOf(CFepUiBaseCtrl *)

TBool IsOnTopOf(CFepUiBaseCtrl *aCtrl)

Check whether this control is on top of another control. If a control is on top of another it will draw later so it will overwrite the overlapped area.

Since
S60 V5.0

Parameters

CFepUiBaseCtrl * aCtrlThe compared control

MaskBitmapDevice()

IMPORT_C CFbsBitmapDevice *MaskBitmapDevice()[protected]
get Mask bitmap device for sprite or window
Since
S60 V4.0

MaskBkCol()

const TRgb &MaskBkCol()[protected, inline]

get mask background color

Since
S60 V4.0

Move(const TPoint &)

IMPORT_C voidMove(const TPoint &aOffset)[virtual]

Move conntrol

Since
S60 V4.0

Parameters

const TPoint & aOffsetThe offset to be moved

MovingArea()

IMPORT_C const TRect &MovingArea()

From MPositionObserver Get observer's area to be moved when position changed

Since
S60 V4.0

NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)

NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)[inline]

Parameters

CFepUiBaseCtrlExtension

OnActivate()

IMPORT_C voidOnActivate()[virtual]

OnActivate. Called when the layout is going to be shown.

Since
S60 v4.0

OnDeActivate()

IMPORT_C voidOnDeActivate()[virtual]

OnDeActivate. Called when the layout is going to be hidden

Since
S60 v4.0

OnLayoutDraggingEnd()

IMPORT_C voidOnLayoutDraggingEnd()[virtual]

Call back function when layout ends dragging

Since
S60 V4.0

OnLayoutDraggingStart()

IMPORT_C voidOnLayoutDraggingStart()[virtual]

Call back function when layout starts dragging

Since
S60 V4.0

OrderPos()

TInt OrderPos()const [inline]

Overlapped(CFepUiBaseCtrl *)

TBool Overlapped(CFepUiBaseCtrl *aCtrl)

Check whether this control has overlapped area with another one

Since
S60 V5.0

Parameters

CFepUiBaseCtrl * aCtrlThe compared control

ParentCtrl()

CFepUiBaseCtrl *ParentCtrl()[inline]

PenColor()

const TRgb &PenColor()[protected, inline]
Get pen color
Since
S60 V4.0

PenSize()

const TSize &PenSize()[inline]

Get pen size

Since
S60 V4.0

PointerDown()

TBool PointerDown()[inline]

get control pointer down status

Since
S60 V4.0

ReDrawRect(const TRect &)

IMPORT_C voidReDrawRect(const TRect &aRect)[virtual]

Redraws the content in a control

Since
S60 V4.0

Parameters

const TRect & aRectThe rect to be redrawed

Ready()

TBool Ready()[inline]

Get initialization status

Since
S60 V4.0

Rect()

const TRect &Rect()[inline]

Get control size in rect

Since
S60 V4.0

Region()

const RRegion &Region()[inline]

Get valid region. A valid region is that the region responds to pointer.

Since
S60 V4.0

RemoveEventObserver(MEventObserver *)

IMPORT_C voidRemoveEventObserver(MEventObserver *aObserver)

Remove event obeserver

Since
S60 V4.0

Parameters

MEventObserver * aObserverAn event obeserver to be removed.

ReportEvent(TInt, const TDesC &)

IMPORT_C voidReportEvent(TIntaEventType,
const TDesC &aEventData =  KNullDesC
)

Report event to event observer

Since
S60 V4.0

Parameters

TInt aEventTypethe event type
const TDesC & aEventData =  KNullDesC Event data

RequireRegionUpdateL(TBool)

IMPORT_C voidRequireRegionUpdateL(TBoolaRequiredFlag)

Register to layout to require updaing control valid region constantly.

Since
S60 v4.0

Parameters

TBool aRequiredFlagRegister or deregister. ETrue if register.

ResizeDeviceL()

voidResizeDeviceL()[protected]

ResourceId()

TInt32 ResourceId()[inline]

Get resource Id

Since
S60 V4.0

RootControl()

CFepUiLayoutRootCtrl *RootControl()[protected, inline]

Get ui layout root control

Since
S60 v4.0

SetActive(TBool)

IMPORT_C voidSetActive(TBoolaFlag)[virtual]

Set control active

Since
S60 V4.0

Parameters

TBool aFlagThe active flag. ETrue if active, otherwise EFalse

SetAllowOverlap(TBool)

voidSetAllowOverlap(TBoolaFlag)[inline]

Set overlap flag

Since
S60 V4.0

Parameters

TBool aFlagThe new overlap falg

SetBackgroundBitmapL(CFbsBitmap *)

IMPORT_C voidSetBackgroundBitmapL(CFbsBitmap *aBmp)[virtual]

Parameters

CFbsBitmap * aBmp

SetBackgroundBmp(CFbsBitmap *)

voidSetBackgroundBmp(CFbsBitmap *aBmp)[protected, inline]
set control background bmp
Since
S60 V4.0

Parameters

CFbsBitmap * aBmp

SetBackgroundMaskBitmapL(CFbsBitmap *)

IMPORT_C voidSetBackgroundMaskBitmapL(CFbsBitmap *aBmp)[virtual]

Set background mask bitmap

Since
S60 V4.0

Parameters

CFbsBitmap * aBmpThe background bitmap. Ownership transferred to control

SetBackgroundMaskBmp(CFbsBitmap *)

voidSetBackgroundMaskBmp(CFbsBitmap *aBmp)[protected, inline]
set control background mask bmp
Since
S60 V4.0

Parameters

CFbsBitmap * aBmp

SetBkColor(const TRgb &)

voidSetBkColor(const TRgb &aCol)[inline]

Set background color

Since
S60 V4.0

Parameters

const TRgb & aColBackground color to be used

SetBorderColor(const TRgb &)

voidSetBorderColor(const TRgb &aCol)[inline]

Set pen color

Since
S60 V4.0

Parameters

const TRgb & aColNew border color

SetBorderSize(const TSize &)

voidSetBorderSize(const TSize &aSize)[inline]

Set border size

Since
S60 V4.0

Parameters

const TSize & aSizeNew border size

SetControlType(TControlType)

voidSetControlType(TControlTypeaCtrlType)[inline]

Set control type

Since
S60 V4.0

Parameters

TControlType aCtrlTypeThe control type

SetHidenFlag(TBool)

voidSetHidenFlag(TBoolaFlag)[protected, inline]

Parameters

TBool aFlag

SetMaskBkCol(const TRgb &)

voidSetMaskBkCol(const TRgb &aCol)[inline]

Set mask background color

Since
S60 V4.0

Parameters

const TRgb & aColThe mask back ground color

SetOrdinalPos(TInt)

IMPORT_C voidSetOrdinalPos(TIntaPos)

Parameters

TInt aPos

SetParent(CFepUiBaseCtrl *)

IMPORT_C voidSetParent(CFepUiBaseCtrl *aParent)

Parameters

CFepUiBaseCtrl * aParent

SetPenColor(const TRgb &)

voidSetPenColor(const TRgb &aCol)[inline]

Set pen color

Since
S60 V4.0

Parameters

const TRgb & aColNew pen color

SetPenSize(const TSize &)

voidSetPenSize(const TSize &aSize)[inline]

Set pen size

Since
S60 V4.0

Parameters

const TSize & aSizeNew pen size

SetPointerDown(TBool)

voidSetPointerDown(TBoolaFlag)[inline]

change control pointer down status

Since
S60 V4.0

Parameters

TBool aFlagThe pointer down flag.

SetReady(TBool)

voidSetReady(TBoolaReadyFlag)[inline]

set control drawing status. It won't be drawn if not ready

Since
S60 V4.0

Parameters

TBool aReadyFlagThe control ready flag

SetRect(const TRect &)

IMPORT_C voidSetRect(const TRect &aRect)[virtual]

Set control's rectangle

Since
S60 V4.0

Parameters

const TRect & aRectThe new control area

SetRegion(const RRegion &)

voidSetRegion(const RRegion &aRegion)[inline]

Set control valid region

Since
S60 V4.0

Parameters

const RRegion & aRegionThe new control region

SetResourceId(TInt32)

IMPORT_C voidSetResourceId(TInt32aResId)

From MOnResourceChangFunctions Set resource Id

Since
S60 V4.0

Parameters

TInt32 aResIdThe resource id;

SetShadowAreaRect(const TRect &, TShadowBitmapIndex)

IMPORT_C voidSetShadowAreaRect(const TRect &aRect,
TShadowBitmapIndexaIndex
)

Set shadow rect for a shadow area. The nth shadow is drawn in this shadow rect

Since
S60 V4.0

Parameters

const TRect & aRectThe shadow rect.
TShadowBitmapIndex aIndexThe index position for shadow rect

SetShadowBmp(CFbsBitmap *, CFbsBitmap *, TShadowBitmapIndex)

IMPORT_C voidSetShadowBmp(CFbsBitmap *aBmp,
CFbsBitmap *aMaskBmp,
TShadowBitmapIndexaIndex
)
set control shadow bitmap and mask bmp
Since
S60 V4.0

Parameters

CFbsBitmap * aBmp
CFbsBitmap * aMaskBmp
TShadowBitmapIndex aIndexThe shadow bitmap position index

SetShadowRect(const TRect &)

IMPORT_C voidSetShadowRect(const TRect &aRect)

Set shadow rect. Shadow rect defines the outside rect of the control. The shadow is drawn between this rect and control's rect using bitmaps

Since
S60 V4.0

Parameters

const TRect & aRectThe shadow rect. Shadow rect must bigger than control's rect, otherwise no effect.

SetTactileFeedbackType(TInt)

IMPORT_C voidSetTactileFeedbackType(TIntaTactileType)

Set Tactile Feedback Type Advanced Tactile feedback REQ417-47932

Since
S60 v4.0

Parameters

TInt aTactileType

ShadowAreaRect(TShadowBitmapIndex)

TRect ShadowAreaRect(TShadowBitmapIndexaIndex)[inline]

Get shadow area rect

Since
S60 V4.0

Parameters

TShadowBitmapIndex aIndexThe index for shadow rect

ShadowRect()

const TRect &ShadowRect()[inline]
Get shadow rect
Since
S60 V4.0

SimulateRawEvent(const TRawEvent &)

IMPORT_C voidSimulateRawEvent(const TRawEvent &aEvent)

Simulates a internal raw event. The event is handled inside pen input ui, will not go for window server.

Since
S60 V5.0

Parameters

const TRawEvent & aEvent

TactileFeedbackType()

TInt TactileFeedbackType()const [inline]

Return tactile feedback type

Advanced Tactile feedback REQ417-47932

UiLayout()

CFepUiLayout *UiLayout()[protected, inline]

Get Ui layout

Since
S60 V4.0

UpdateArea(const TRect &, TBool)

IMPORT_C voidUpdateArea(const TRect &aRect,
TBoolaUpdateFlag = EFalse
)[virtual]

Update layout area, cause screen update. However the updating is buffered until refresh timer time out.

Since
S60 V4.0

Parameters

const TRect & aRectthe rect to be flushed in screen
TBool aUpdateFlag = EFalseETrue if full update.

UpdateAreaImmed(const TRect &, TBool)

IMPORT_C voidUpdateAreaImmed(const TRect &aRect,
TBoolaUpdateFlag = EFalse
)

Update layout area immediately

Since
S60 V4.0

Parameters

const TRect & aRectthe rect to be flushed in screen
TBool aUpdateFlag = EFalseETrue if full update.

UpdateExtResponseArea(const TRect &)

voidUpdateExtResponseArea(const TRect &aRect)[private]

Update extra response area

Parameters

const TRect & aRectnew response area

UpdateValidRegion(CFepUiBaseCtrl *, TBool)

IMPORT_C voidUpdateValidRegion(CFepUiBaseCtrl *aCtrl,
TBoolaRemoveFlag
)[virtual]

Update control's valid region when other control hiding or displaying. This is usually used for HWR window to change it's writing area.

Since
S60 V4.0

Parameters

CFepUiBaseCtrl * aCtrlThe control whose displaying status changed
TBool aRemoveFlag

ValidClipRegion()

IMPORT_C const TRegion &ValidClipRegion()[protected]

Get the clip region

Since
S60 v5.0

WholeHiden()

IMPORT_C TBoolWholeHiden()

Get hide flag

Since
S60 V4.0

WndBasedControl()

CCoeControl *WndBasedControl()[inline]

Get window based control

Since
S60 V4.0

WndControl()

CCoeControl *WndControl()[inline]

Get the associated CCoeControl control

Since
S60 V5.0

Member Enumerations Documentation

Enum TZOrder

Enumerators

EOrderBackground = 1500
EOrderNomal = 1000
EOrderFront = 500
EOrderTopMost = 0

Member Data Documentation

TBool iAllowOverlap

TBool iAllowOverlap[private]

Flag tells whether a draging component can be moved on top of this control

CFbsBitmap * iBackgroundBmp

CFbsBitmap *iBackgroundBmp[private]

Background bitmap Own.

TRgb iBackgroundCol

TRgb iBackgroundCol[private]

Background color

CFbsBitmap * iBkMaskBmp

CFbsBitmap *iBkMaskBmp[private]

Background mask bitmap Own.

TRgb iBorderColor

TRgb iBorderColor[protected]

Control border color

TSize iBorderSize

TSize iBorderSize[protected]

Control border size

RRegion iClipRegion

RRegion iClipRegion[protected]

The actual drawing region. so drawing won't happend outside of the region.

RRegion iClipRegionWithoutLockedArea

RRegion iClipRegionWithoutLockedArea[private]

TInt iControlId

TInt iControlId[private]

Control id

TControlType iControlType

TControlType iControlType[private]

Control type. User derivated control should starts from EUserCtrlBase

RPointerArray< MEventObserver > iEventObserverList

RPointerArray< MEventObserver >iEventObserverList[private]

event observer list

TEventType iEventType

TEventType iEventType[private]

CFepUiBaseCtrlExtension * iExtension

CFepUiBaseCtrlExtension *iExtension[private]

Reservered

TBool iHiden

TBool iHiden[private]

Flag indicates whether the control is hiden

TBool iIsActive

TBool iIsActive[private]

control active status.

MLayoutOwner * iLayoutOwner

MLayoutOwner *iLayoutOwner[private]

Layout owner Not own

TRgb iMaskBkCol

TRgb iMaskBkCol[private]

Maks backgroud color

TInt iOrdinalPos

TInt iOrdinalPos[private]

TBool iOwnWndCtrl

TBool iOwnWndCtrl[private]

Ownership of the window control. If true, it will delete the window control during destruction.

CFepUiBaseCtrl * iParentCtrl

CFepUiBaseCtrl *iParentCtrl[protected]

Parent control Not own

TRgb iPenColor

TRgb iPenColor[private]

Pen color

TSize iPenSize

TSize iPenSize[private]

pen size

TBool iPointerDown

TBool iPointerDown[private]

flag to show whether pen has beed pressed down in this control

TBool iPointerLeft

TBool iPointerLeft[protected]

Indicate whether the pointer has leaved a control

TBool iReady

TBool iReady[private]

flag to indicate whehter this control is ready to drawn

TRect iRect

TRect iRect[protected]

Control rect. It's relative to ui layout

TInt iReservered2

TInt iReservered2[private]

Reservered

TInt32 iResourceId

TInt32 iResourceId[protected]

The resource Id associatied with this control

CFepUiLayoutRootCtrl * iRootCtrl

CFepUiLayoutRootCtrl *iRootCtrl[private]

Root control. It's a control group. Not Own

TRect iShadowAreaRect

TRect iShadowAreaRect[protected]

Shadow area rect

CFbsBitmap * iShadowBmp

CFbsBitmap *iShadowBmp[private]

Shadow bitmaps. Own

TRect iShadowRect

TRect iShadowRect[protected]

Control shadow rect. It's relative to ui layout

CFepUiLayout * iUiLayout

CFepUiLayout *iUiLayout[private]

The ui layout which contains this control Not own.

TBool iUpdateFlagEnabled

TBool iUpdateFlagEnabled[protected]

Flag indicates whether rect changed should report to parent

RRegion iValidRegion

RRegion iValidRegion[protected]

Valid region which reacts to the pointer event

CCoeControl * iWndControl

CCoeControl *iWndControl[protected]

CCoeControl based control Own