CFepUiBaseCtrl Class Reference
class CFepUiBaseCtrl : public CBase
|
CFepUiBaseCtrl
Base control for all FEP UI layout controls.
feplayoutcontrol.lib
-
Since
-
S60 v4.0
Public Member Functions
|
|
CFepUiBaseCtrl
(const
TRect
&,
CFepUiLayout
*,
TInt
)
|
|
CFepUiBaseCtrl
(
CCoeControl
*,
CFepUiLayout
*,
TBool
)
|
|
~CFepUiBaseCtrl
()
|
TInt
|
AbsOrderPos
()
|
IMPORT_C void
|
ActiveExtResponseArea
()
|
IMPORT_C void
|
AddEventObserver
(
MEventObserver
*)
|
TBool
|
AllowOverlap
()
|
IMPORT_C void
|
BaseConstructL
()
|
const
TRgb
&
|
BorderColor
()
|
const
TSize
&
|
BorderSize
()
|
IMPORT_C void
|
BringToBack
()
|
IMPORT_C void
|
BringToTop
()
|
IMPORT_C void
|
CancelExtResponseArea
()
|
IMPORT_C void
|
CancelPointerDownL
()
|
IMPORT_C
CFepUiBaseCtrl
*
|
CapturePointer
(
TBool
)
|
IMPORT_C void
|
Clear
()
|
IMPORT_C void
|
ClearRect
(const
TRect
&)
|
TBool
|
CompareOrder
(
CFepUiBaseCtrl
*)
|
TBool
|
CompareOrderInSameGroup
(
CFepUiBaseCtrl
*)
|
IMPORT_C void
|
ConstructFromResourceL
()
|
IMPORT_C
TBool
|
Contains
(const
TPoint
&)
|
TInt
|
ControlId
()
|
TControlType
|
ControlType
()
|
IMPORT_C void
|
Draw
()
|
IMPORT_C void
|
EnableExtResponseArea
(
TBool
, const
TRect
&)
|
IMPORT_C
CFepUiBaseCtrl
*
|
HandlePointerDownEventL
(const
TPoint
&)
|
IMPORT_C void
|
HandlePointerEnter
(const
TPoint
&)
|
IMPORT_C void
|
HandlePointerLeave
(const
TPoint
&)
|
IMPORT_C
CFepUiBaseCtrl
*
|
HandlePointerMoveEventL
(const
TPoint
&)
|
IMPORT_C
CFepUiBaseCtrl
*
|
HandlePointerUpEventL
(const
TPoint
&)
|
IMPORT_C
TBool
|
HandlePositionChange
(const
TPoint
&)
|
IMPORT_C void
|
Hide
(
TBool
)
|
TBool
|
Hiden
()
|
TBool
|
IsActive
()
|
IMPORT_C
TBool
|
IsFepBaseControl
()
|
TBool
|
IsKindOfControl
(
TStockBaseCtrlType
)
|
TBool
|
IsOnTopOf
(
CFepUiBaseCtrl
*)
|
IMPORT_C void
|
Move
(const
TPoint
&)
|
IMPORT_C const
TRect
&
|
MovingArea
()
|
|
NONSHARABLE_CLASS
(CFepUiBaseCtrlExtension)
|
IMPORT_C void
|
OnActivate
()
|
IMPORT_C void
|
OnDeActivate
()
|
IMPORT_C void
|
OnLayoutDraggingEnd
()
|
IMPORT_C void
|
OnLayoutDraggingStart
()
|
TInt
|
OrderPos
()
|
TBool
|
Overlapped
(
CFepUiBaseCtrl
*)
|
CFepUiBaseCtrl
*
|
ParentCtrl
()
|
const
TSize
&
|
PenSize
()
|
TBool
|
PointerDown
()
|
IMPORT_C void
|
ReDrawRect
(const
TRect
&)
|
TBool
|
Ready
()
|
const
TRect
&
|
Rect
()
|
const
RRegion
&
|
Region
()
|
IMPORT_C void
|
RemoveEventObserver
(
MEventObserver
*)
|
IMPORT_C void
|
ReportEvent
(
TInt
, const
TDesC
&)
|
IMPORT_C void
|
RequireRegionUpdateL
(
TBool
)
|
TInt32
|
ResourceId
()
|
IMPORT_C void
|
SetActive
(
TBool
)
|
void
|
SetAllowOverlap
(
TBool
)
|
IMPORT_C void
|
SetBackgroundBitmapL
(
CFbsBitmap
*)
|
IMPORT_C void
|
SetBackgroundMaskBitmapL
(
CFbsBitmap
*)
|
void
|
SetBkColor
(const
TRgb
&)
|
void
|
SetBorderColor
(const
TRgb
&)
|
void
|
SetBorderSize
(const
TSize
&)
|
void
|
SetControlType
(
TControlType
)
|
void
|
SetMaskBkCol
(const
TRgb
&)
|
IMPORT_C void
|
SetOrdinalPos
(
TInt
)
|
IMPORT_C void
|
SetParent
(
CFepUiBaseCtrl
*)
|
void
|
SetPenColor
(const
TRgb
&)
|
void
|
SetPenSize
(const
TSize
&)
|
void
|
SetPointerDown
(
TBool
)
|
void
|
SetReady
(
TBool
)
|
IMPORT_C void
|
SetRect
(const
TRect
&)
|
void
|
SetRegion
(const
RRegion
&)
|
IMPORT_C void
|
SetResourceId
(
TInt32
)
|
IMPORT_C void
|
SetShadowAreaRect
(const
TRect
&,
TShadowBitmapIndex
)
|
IMPORT_C void
|
SetShadowBmp
(
CFbsBitmap
*,
CFbsBitmap
*,
TShadowBitmapIndex
)
|
IMPORT_C void
|
SetShadowRect
(const
TRect
&)
|
IMPORT_C void
|
SetTactileFeedbackType
(
TInt
)
|
TRect
|
ShadowAreaRect
(
TShadowBitmapIndex
)
|
const
TRect
&
|
ShadowRect
()
|
IMPORT_C void
|
SimulateRawEvent
(const
TRawEvent
&)
|
TInt
|
TactileFeedbackType
()
|
IMPORT_C void
|
UpdateArea
(const
TRect
&,
TBool
)
|
IMPORT_C void
|
UpdateAreaImmed
(const
TRect
&,
TBool
)
|
IMPORT_C void
|
UpdateValidRegion
(
CFepUiBaseCtrl
*,
TBool
)
|
IMPORT_C
TBool
|
WholeHiden
()
|
CCoeControl
*
|
WndBasedControl
()
|
CCoeControl
*
|
WndControl
()
|
Protected Member Functions
|
IMPORT_C
TBool
|
AbleToDraw
()
|
CFbsBitmap
*
|
BackgroundBmp
()
|
void
|
BaseConstructL
(CFepUiLayoutRootCtrl *)
|
IMPORT_C
CBitmapContext
*
|
BitGc
()
|
IMPORT_C
CFbsBitmapDevice
*
|
BitmapDevice
()
|
const
TRgb
&
|
BkColor
()
|
IMPORT_C
CFbsBitmap
*
|
BkMaskBmp
()
|
void
|
CreateOwnDeviceL
(
CFbsBitmap
*,
CFbsBitmap
*)
|
void
|
DisableRegionUpdating
()
|
IMPORT_C void
|
DrawBackground
(
TBool
)
|
IMPORT_C void
|
DrawBackground
(const
TRect
,
TBool
)
|
void
|
DrawBackgroundToDevice
(
TRect
,
CFbsDevice
*,
CFbsBitmap
*, const
TRgb
&, const
TRgb
&,
TBool
)
|
IMPORT_C void
|
DrawBitmap
(const
CFbsBitmap
*,
TBool
)
|
IMPORT_C void
|
DrawBitmap
(const
TRect
, const
CFbsBitmap
*,
TBool
)
|
IMPORT_C void
|
DrawMaskBackground
(
TBool
)
|
IMPORT_C void
|
DrawOpaqueMaskBackground
(
TBool
)
|
IMPORT_C void
|
DrawOpaqueMaskBackground
(const
TRect
,
TBool
)
|
IMPORT_C void
|
DrawShadow
()
|
IMPORT_C void
|
DrawTransparentMaskBackground
(const
TRect
&,
TBool
)
|
void
|
EnableRegionUpdating
()
|
IMPORT_C
TInt
|
Extension_
(
TUint
,
TAny
*&,
TAny
*)
|
IMPORT_C void
|
GraphicDeviceSizeChanged
()
|
IMPORT_C void
|
HandleResourceChange
(
TInt
)
|
IMPORT_C
CFbsBitmapDevice
*
|
MaskBitmapDevice
()
|
const
TRgb
&
|
MaskBkCol
()
|
const
TRgb
&
|
PenColor
()
|
void
|
ResizeDeviceL
()
|
CFepUiLayoutRootCtrl *
|
RootControl
()
|
void
|
SetBackgroundBmp
(
CFbsBitmap
*)
|
void
|
SetBackgroundMaskBmp
(
CFbsBitmap
*)
|
void
|
SetHidenFlag
(
TBool
)
|
CFepUiLayout
*
|
UiLayout
()
|
IMPORT_C const
TRegion
&
|
ValidClipRegion
()
|
Constructor & Destructor Documentation
CFepUiBaseCtrl(const TRect &, CFepUiLayout *, TInt)
Parameters
const
TRect
& aRect
|
The rectangle area for this control
|
CFepUiLayout
* aUiLayout
|
Ui layout who contains this control. Ownership not transferred
|
TInt
aControlId
|
control Id
|
CFepUiBaseCtrl(CCoeControl *, CFepUiLayout *, TBool)
Parameters
CCoeControl
* aControl
|
The control to be added. The control must set its extent before added to the layout.
|
CFepUiLayout
* aUiLayout
|
Ui layout who contains this control. Ownership not transferred
|
TBool
aOwnership = ETrue
|
The ownership of the window control. ETrue if it's transfered to this control
|
~CFepUiBaseCtrl()
IMPORT_C
|
~CFepUiBaseCtrl
|
(
|
)
|
[virtual]
|
Member Functions Documentation
AbleToDraw()
IMPORT_C
TBool
|
AbleToDraw
|
(
|
)
|
[protected]
|
Test whether control is able to be drawn. e.g, is ready or shown?
ActiveExtResponseArea()
IMPORT_C void
|
ActiveExtResponseArea
|
(
|
)
|
|
Active extra response area
AddEventObserver(MEventObserver *)
Add event obeserver. The observer will get notified when control event happens.
Parameters
MEventObserver
* aObserver
|
An event obeserver. Ownership not transferred
|
AllowOverlap()
TBool
|
AllowOverlap
|
(
|
)
|
[inline]
|
Tell whether it allows other control moving on top of it
BackgroundBmp()
CFbsBitmap
*
|
BackgroundBmp
|
(
|
)
|
[protected, inline]
|
get control background bmp
-
Since
-
S60 V4.0
BaseConstructL()
IMPORT_C void
|
BaseConstructL
|
(
|
)
|
|
Do base contruction. Allocate event data buffer Each derived control must call this in its contruction time
BaseConstructL(CFepUiLayoutRootCtrl *)
void
|
BaseConstructL
|
(
|
CFepUiLayoutRootCtrl *
|
aRoot
|
)
|
[protected]
|
Do base contruction. Allocate event data buffer Each derived control must call this in its contruction time
Parameters
CFepUiLayoutRootCtrl * aRoot
|
The root control.
|
BitGc()
get graphics context for sprite or window
-
Since
-
S60 V4.0
BitmapDevice()
get Bitmap device for sprite or window
-
Since
-
S60 V4.0
BkColor()
const
TRgb
&
|
BkColor
|
(
|
)
|
[protected, inline]
|
BkMaskBmp()
get control background mask bmp
-
Since
-
S60 V4.0
BorderColor()
const
TRgb
&
|
BorderColor
|
(
|
)
|
[inline]
|
BorderSize()
const
TSize
&
|
BorderSize
|
(
|
)
|
[inline]
|
BringToBack()
IMPORT_C void
|
BringToBack
|
(
|
)
|
|
Bring the control to back most in current control group and show it.
BringToTop()
IMPORT_C void
|
BringToTop
|
(
|
)
|
|
Bring the control to top most in current control group and show it.
CancelExtResponseArea()
IMPORT_C void
|
CancelExtResponseArea
|
(
|
)
|
|
Cancel extra response area
CancelPointerDownL()
IMPORT_C void
|
CancelPointerDownL
|
(
|
)
|
[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.
CapturePointer(TBool)
Capture or release the pointer. After capturing, all UI layout event will be processed by this control
Parameters
TBool
aFlag = ETrue
|
The flag indicates capturing or releasing.
|
Clear()
Clear the whole control area
ClearRect(const TRect &)
IMPORT_C void
|
ClearRect
|
(
|
const
TRect
&
|
aRect
|
)
|
|
Clear a area in the control
Parameters
const
TRect
& aRect
|
The rect to be cleared.
|
CompareOrder(CFepUiBaseCtrl *)
CompareOrderInSameGroup(CFepUiBaseCtrl *)
Compare order pos for two control within the same control grop
ConstructFromResourceL()
IMPORT_C void
|
ConstructFromResourceL
|
(
|
)
|
|
Contains(const TPoint &)
IMPORT_C
TBool
|
Contains
|
(
|
const
TPoint
&
|
aPt
|
)
|
[virtual]
|
Check whether this control contains the point
ControlId()
TInt
|
ControlId
|
(
|
)
|
[inline]
|
CreateOwnDeviceL(CFbsBitmap *, CFbsBitmap *)
DisableRegionUpdating()
void
|
DisableRegionUpdating
|
(
|
)
|
[protected, inline]
|
Draw()
IMPORT_C void
|
Draw
|
(
|
)
|
[virtual]
|
Pure virtual function, draws the control
DrawBackground(TBool)
IMPORT_C void
|
DrawBackground
|
(
|
TBool
|
aBmpStretchFlag = ETrue
|
)
|
[protected]
|
Parameters
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.
|
DrawBackground(const TRect, TBool)
IMPORT_C void
|
DrawBackground
|
(
|
const
TRect
|
aRect,
|
|
TBool
|
aBmpStretchFlag = ETrue
|
|
)
|
[protected]
|
Parameters
const
TRect
aRect
|
Rect to be draw to fit the rect. Default value is ETrue.
|
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched
|
DrawBackgroundToDevice(TRect, CFbsDevice *, CFbsBitmap *, const TRgb &, const TRgb &, TBool)
Draw background to device
Parameters
TRect
aRect
|
The device rect to be filled.
|
CFbsDevice
* aDevice
|
|
CFbsBitmap
* aBmp
|
The background bmp
|
const
TRgb
& aBrushCol
|
The brush color
|
const
TRgb
& aPenCol
|
The pen color
|
TBool
aBmpStretchFlag
|
The stretch flag for drawing bitmap.
|
DrawBitmap(const CFbsBitmap *, TBool)
IMPORT_C void
|
DrawBitmap
|
(
|
const
CFbsBitmap
*
|
aBitmap,
|
|
TBool
|
aStretchFlag
|
|
)
|
[protected]
|
Draw bitmap to control rect
Parameters
const
CFbsBitmap
* aBitmap
|
The given bitmap
|
TBool
aStretchFlag
|
The flag tells whether this bitmap should be stretched
|
DrawBitmap(const TRect, const CFbsBitmap *, TBool)
IMPORT_C void
|
DrawBitmap
|
(
|
const
TRect
|
aRect,
|
|
const
CFbsBitmap
*
|
aBitmap,
|
|
TBool
|
aStretchFlag
|
|
)
|
[protected]
|
Draw bitmap to control rect
Parameters
const
TRect
aRect
|
The drawn rect
|
const
CFbsBitmap
* aBitmap
|
The given bitmap
|
TBool
aStretchFlag
|
The flag tells whether this bitmap should be stretched
|
DrawMaskBackground(TBool)
IMPORT_C void
|
DrawMaskBackground
|
(
|
TBool
|
aBmpStretchFlag = ETrue
|
)
|
[protected]
|
Parameters
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.
|
DrawOpaqueMaskBackground(TBool)
IMPORT_C void
|
DrawOpaqueMaskBackground
|
(
|
TBool
|
aBmpStretchFlag = ETrue
|
)
|
[protected]
|
Draw opaque mask background. Draw an opaque ground.
Parameters
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.
|
DrawOpaqueMaskBackground(const TRect, TBool)
IMPORT_C void
|
DrawOpaqueMaskBackground
|
(
|
const
TRect
|
aRect,
|
|
TBool
|
aBmpStretchFlag = ETrue
|
|
)
|
[protected]
|
Draw opaque mask background. Draw an opaque ground.
Parameters
const
TRect
aRect
|
Rect to be draw to fit the rect. Default value is ETrue.
|
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched
|
DrawShadow()
IMPORT_C void
|
DrawShadow
|
(
|
)
|
[protected]
|
DrawShadowBitmap(const TRect &, TInt)
void
|
DrawShadowBitmap
|
(
|
const
TRect
&
|
aRect,
|
|
TInt
|
aIndex
|
|
)
|
[private]
|
Parameters
const
TRect
& aRect
|
The rect to be drawn
|
TInt
aIndex
|
The shadow bitmap position index
|
DrawTransparentMaskBackground(const TRect &, TBool)
IMPORT_C void
|
DrawTransparentMaskBackground
|
(
|
const
TRect
&
|
aRect,
|
|
TBool
|
aBmpStretchFlag = ETrue
|
|
)
|
[protected]
|
Draw transparent mask background
Parameters
const
TRect
& aRect
|
|
TBool
aBmpStretchFlag = ETrue
|
Flag tells whether the bitmap will be stretched to fit the rect. Default value is ETrue.
|
EnableExtResponseArea(TBool, const TRect &)
IMPORT_C void
|
EnableExtResponseArea
|
(
|
TBool
|
aEnable,
|
|
const
TRect
&
|
aExtMargin
|
|
)
|
|
Enable/disable extra response area support
Parameters
TBool
aEnable
|
ETrue to enable, or EFalse to disable
|
const
TRect
& aExtMargin
|
margin of extra response area
|
EnableRegionUpdating()
void
|
EnableRegionUpdating
|
(
|
)
|
[protected, inline]
|
Extension_(TUint, TAny *&, TAny *)
IMPORT_C
TInt
|
Extension_
|
(
|
TUint
|
aExtensionId,
|
|
TAny
*&
|
a0,
|
|
TAny
*
|
a1
|
|
)
|
[protected, virtual]
|
Parameters
TUint
aExtensionId
|
Extension UID
|
TAny
*& a0
|
The extension returned
|
TAny
* a1
|
Any passed in parameter.
|
GraphicDeviceSizeChanged()
IMPORT_C void
|
GraphicDeviceSizeChanged
|
(
|
)
|
[protected, virtual]
|
Handle pen UI graphic device size change event
HandlePointerDownEventL(const TPoint &)
Handle pointer down event
Parameters
const
TPoint
& aPoint
|
The point position relative the layout
|
HandlePointerEnter(const TPoint &)
IMPORT_C void
|
HandlePointerEnter
|
(
|
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.
Parameters
const
TPoint
& aPoint
|
current pointer position
|
HandlePointerLeave(const TPoint &)
IMPORT_C void
|
HandlePointerLeave
|
(
|
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
Parameters
const
TPoint
& aPoint
|
current pointer position
|
HandlePointerMoveEventL(const TPoint &)
Handle pointer move event
Parameters
const
TPoint
& aPoint
|
The point position relative the layout
|
HandlePointerUpEventL(const TPoint &)
Parameters
const
TPoint
& aPoint
|
The point position relative the layout
|
HandlePositionChange(const TPoint &)
IMPORT_C
TBool
|
HandlePositionChange
|
(
|
const
TPoint
&
|
aOffset
|
)
|
|
From
MPositionObserver
Handle position change event. It's called to change the position after it's being dragging
Parameters
const
TPoint
& aOffset
|
The moving offset
|
HandleResourceChange(TInt)
IMPORT_C void
|
HandleResourceChange
|
(
|
TInt
|
aType
|
)
|
[protected, virtual]
|
Handle system resource change
Parameters
TInt
aType
|
The system resource change type
|
Hide(TBool)
IMPORT_C void
|
Hide
|
(
|
TBool
|
aFlag
|
)
|
[virtual]
|
Hide or shoe control. A hiden control will not handle the event.
Parameters
TBool
aFlag
|
ETrue if want to hide the control.
|
IsActive()
TBool
|
IsActive
|
(
|
)
|
[inline]
|
IsFepBaseControl()
IMPORT_C
TBool
|
IsFepBaseControl
|
(
|
)
|
|
IsKindOfControl(TStockBaseCtrlType)
TBool
|
IsKindOfControl
|
(
|
TStockBaseCtrlType
|
aCtrlClass
|
)
|
[inline]
|
Test whether the control belongs one kind of control class
Parameters
TStockBaseCtrlType
aCtrlClass
|
The control class type
|
IsOnTopOf(CFepUiBaseCtrl *)
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.
MaskBitmapDevice()
get Mask bitmap device for sprite or window
-
Since
-
S60 V4.0
MaskBkCol()
const
TRgb
&
|
MaskBkCol
|
(
|
)
|
[protected, inline]
|
get mask background color
Move(const TPoint &)
IMPORT_C void
|
Move
|
(
|
const
TPoint
&
|
aOffset
|
)
|
[virtual]
|
Parameters
const
TPoint
& aOffset
|
The offset to be moved
|
MovingArea()
IMPORT_C const
TRect
&
|
MovingArea
|
(
|
)
|
|
NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)
NONSHARABLE_CLASS
|
(
|
CFepUiBaseCtrlExtension
|
|
)
|
[inline]
|
OnActivate()
IMPORT_C void
|
OnActivate
|
(
|
)
|
[virtual]
|
OnActivate. Called when the layout is going to be shown.
OnDeActivate()
IMPORT_C void
|
OnDeActivate
|
(
|
)
|
[virtual]
|
OnDeActivate. Called when the layout is going to be hidden
OnLayoutDraggingEnd()
IMPORT_C void
|
OnLayoutDraggingEnd
|
(
|
)
|
[virtual]
|
Call back function when layout ends dragging
OnLayoutDraggingStart()
IMPORT_C void
|
OnLayoutDraggingStart
|
(
|
)
|
[virtual]
|
Call back function when layout starts dragging
OrderPos()
TInt
|
OrderPos
|
(
|
)
|
const [inline]
|
Overlapped(CFepUiBaseCtrl *)
Check whether this control has overlapped area with another one
PenColor()
const
TRgb
&
|
PenColor
|
(
|
)
|
[protected, inline]
|
Get pen color
-
Since
-
S60 V4.0
PenSize()
const
TSize
&
|
PenSize
|
(
|
)
|
[inline]
|
PointerDown()
TBool
|
PointerDown
|
(
|
)
|
[inline]
|
get control pointer down status
ReDrawRect(const TRect &)
IMPORT_C void
|
ReDrawRect
|
(
|
const
TRect
&
|
aRect
|
)
|
[virtual]
|
Redraws the content in a control
Parameters
const
TRect
& aRect
|
The rect to be redrawed
|
Ready()
Get initialization status
Rect()
const
TRect
&
|
Rect
|
(
|
)
|
[inline]
|
Region()
const
RRegion
&
|
Region
|
(
|
)
|
[inline]
|
Get valid region. A valid region is that the region responds to pointer.
RemoveEventObserver(MEventObserver *)
ReportEvent(TInt, const TDesC &)
Report event to event observer
RequireRegionUpdateL(TBool)
IMPORT_C void
|
RequireRegionUpdateL
|
(
|
TBool
|
aRequiredFlag
|
)
|
|
Register to layout to require updaing control valid region constantly.
Parameters
TBool
aRequiredFlag
|
Register or deregister. ETrue if register.
|
ResizeDeviceL()
void
|
ResizeDeviceL
|
(
|
)
|
[protected]
|
ResourceId()
TInt32
|
ResourceId
|
(
|
)
|
[inline]
|
RootControl()
CFepUiLayoutRootCtrl *
|
RootControl
|
(
|
)
|
[protected, inline]
|
Get ui layout root control
SetActive(TBool)
IMPORT_C void
|
SetActive
|
(
|
TBool
|
aFlag
|
)
|
[virtual]
|
Parameters
TBool
aFlag
|
The active flag. ETrue if active, otherwise EFalse
|
SetAllowOverlap(TBool)
void
|
SetAllowOverlap
|
(
|
TBool
|
aFlag
|
)
|
[inline]
|
Parameters
TBool
aFlag
|
The new overlap falg
|
SetBackgroundBitmapL(CFbsBitmap *)
IMPORT_C void
|
SetBackgroundBitmapL
|
(
|
CFbsBitmap
*
|
aBmp
|
)
|
[virtual]
|
SetBackgroundBmp(CFbsBitmap *)
void
|
SetBackgroundBmp
|
(
|
CFbsBitmap
*
|
aBmp
|
)
|
[protected, inline]
|
set control background bmp
-
Since
-
S60 V4.0
SetBackgroundMaskBitmapL(CFbsBitmap *)
IMPORT_C void
|
SetBackgroundMaskBitmapL
|
(
|
CFbsBitmap
*
|
aBmp
|
)
|
[virtual]
|
Set background mask bitmap
Parameters
CFbsBitmap
* aBmp
|
The background bitmap. Ownership transferred to control
|
SetBackgroundMaskBmp(CFbsBitmap *)
void
|
SetBackgroundMaskBmp
|
(
|
CFbsBitmap
*
|
aBmp
|
)
|
[protected, inline]
|
set control background mask bmp
-
Since
-
S60 V4.0
SetBkColor(const TRgb &)
void
|
SetBkColor
|
(
|
const
TRgb
&
|
aCol
|
)
|
[inline]
|
Parameters
const
TRgb
& aCol
|
Background color to be used
|
SetBorderColor(const TRgb &)
void
|
SetBorderColor
|
(
|
const
TRgb
&
|
aCol
|
)
|
[inline]
|
Parameters
const
TRgb
& aCol
|
New border color
|
SetBorderSize(const TSize &)
void
|
SetBorderSize
|
(
|
const
TSize
&
|
aSize
|
)
|
[inline]
|
Parameters
const
TSize
& aSize
|
New border size
|
SetControlType(TControlType)
SetHidenFlag(TBool)
void
|
SetHidenFlag
|
(
|
TBool
|
aFlag
|
)
|
[protected, inline]
|
SetMaskBkCol(const TRgb &)
void
|
SetMaskBkCol
|
(
|
const
TRgb
&
|
aCol
|
)
|
[inline]
|
Set mask background color
Parameters
const
TRgb
& aCol
|
The mask back ground color
|
SetOrdinalPos(TInt)
IMPORT_C void
|
SetOrdinalPos
|
(
|
TInt
|
aPos
|
)
|
|
SetParent(CFepUiBaseCtrl *)
SetPenColor(const TRgb &)
void
|
SetPenColor
|
(
|
const
TRgb
&
|
aCol
|
)
|
[inline]
|
Parameters
const
TRgb
& aCol
|
New pen color
|
SetPenSize(const TSize &)
void
|
SetPenSize
|
(
|
const
TSize
&
|
aSize
|
)
|
[inline]
|
Parameters
const
TSize
& aSize
|
New pen size
|
SetPointerDown(TBool)
void
|
SetPointerDown
|
(
|
TBool
|
aFlag
|
)
|
[inline]
|
change control pointer down status
Parameters
TBool
aFlag
|
The pointer down flag.
|
SetReady(TBool)
void
|
SetReady
|
(
|
TBool
|
aReadyFlag
|
)
|
[inline]
|
set control drawing status. It won't be drawn if not ready
Parameters
TBool
aReadyFlag
|
The control ready flag
|
SetRect(const TRect &)
IMPORT_C void
|
SetRect
|
(
|
const
TRect
&
|
aRect
|
)
|
[virtual]
|
Parameters
const
TRect
& aRect
|
The new control area
|
SetRegion(const RRegion &)
void
|
SetRegion
|
(
|
const
RRegion
&
|
aRegion
|
)
|
[inline]
|
Parameters
const
RRegion
& aRegion
|
The new control region
|
SetResourceId(TInt32)
IMPORT_C void
|
SetResourceId
|
(
|
TInt32
|
aResId
|
)
|
|
Parameters
TInt32
aResId
|
The resource id;
|
SetShadowAreaRect(const TRect &, TShadowBitmapIndex)
IMPORT_C void
|
SetShadowAreaRect
|
(
|
const
TRect
&
|
aRect,
|
|
TShadowBitmapIndex
|
aIndex
|
|
)
|
|
Set shadow rect for a shadow area. The nth shadow is drawn in this shadow rect
Parameters
const
TRect
& aRect
|
The shadow rect.
|
TShadowBitmapIndex
aIndex
|
The index position for shadow rect
|
SetShadowBmp(CFbsBitmap *, CFbsBitmap *, TShadowBitmapIndex)
set control shadow bitmap and mask bmp
-
Since
-
S60 V4.0
SetShadowRect(const TRect &)
IMPORT_C void
|
SetShadowRect
|
(
|
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
Parameters
const
TRect
& aRect
|
The shadow rect. Shadow rect must bigger than control's rect, otherwise no effect.
|
SetTactileFeedbackType(TInt)
IMPORT_C void
|
SetTactileFeedbackType
|
(
|
TInt
|
aTactileType
|
)
|
|
Set Tactile Feedback Type Advanced Tactile feedback REQ417-47932
ShadowAreaRect(TShadowBitmapIndex)
TRect
|
ShadowAreaRect
|
(
|
TShadowBitmapIndex
|
aIndex
|
)
|
[inline]
|
Parameters
TShadowBitmapIndex
aIndex
|
The index for shadow rect
|
ShadowRect()
const
TRect
&
|
ShadowRect
|
(
|
)
|
[inline]
|
Get shadow rect
-
Since
-
S60 V4.0
SimulateRawEvent(const TRawEvent &)
IMPORT_C void
|
SimulateRawEvent
|
(
|
const
TRawEvent
&
|
aEvent
|
)
|
|
Simulates a internal raw event. The event is handled inside pen input ui, will not go for window server.
TactileFeedbackType()
TInt
|
TactileFeedbackType
|
(
|
)
|
const [inline]
|
Return tactile feedback type
Advanced Tactile feedback REQ417-47932
UpdateArea(const TRect &, TBool)
IMPORT_C void
|
UpdateArea
|
(
|
const
TRect
&
|
aRect,
|
|
TBool
|
aUpdateFlag = EFalse
|
|
)
|
[virtual]
|
Update layout area, cause screen update. However the updating is buffered until refresh timer time out.
Parameters
const
TRect
& aRect
|
the rect to be flushed in screen
|
TBool
aUpdateFlag = EFalse
|
ETrue if full update.
|
UpdateAreaImmed(const TRect &, TBool)
IMPORT_C void
|
UpdateAreaImmed
|
(
|
const
TRect
&
|
aRect,
|
|
TBool
|
aUpdateFlag = EFalse
|
|
)
|
|
Update layout area immediately
Parameters
const
TRect
& aRect
|
the rect to be flushed in screen
|
TBool
aUpdateFlag = EFalse
|
ETrue if full update.
|
UpdateExtResponseArea(const TRect &)
void
|
UpdateExtResponseArea
|
(
|
const
TRect
&
|
aRect
|
)
|
[private]
|
Update extra response area
Parameters
const
TRect
& aRect
|
new response area
|
UpdateValidRegion(CFepUiBaseCtrl *, TBool)
Update control's valid region when other control hiding or displaying. This is usually used for HWR window to change it's writing area.
ValidClipRegion()
IMPORT_C const
TRegion
&
|
ValidClipRegion
|
(
|
)
|
[protected]
|
WholeHiden()
IMPORT_C
TBool
|
WholeHiden
|
(
|
)
|
|
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
TRgb
iBackgroundCol
TRgb
|
iBackgroundCol
|
[private]
|
CFbsBitmap * iBkMaskBmp
Background mask bitmap Own.
TRgb
iBorderColor
TRgb
|
iBorderColor
|
[protected]
|
TSize
iBorderSize
TSize
|
iBorderSize
|
[protected]
|
RRegion
iClipRegion
The actual drawing region. so drawing won't happend outside of the region.
RRegion
iClipRegionWithoutLockedArea
RRegion
|
iClipRegionWithoutLockedArea
|
[private]
|
TInt
iControlId
TInt
|
iControlId
|
[private]
|
TControlType
iControlType
Control type.
User
derivated control should starts from EUserCtrlBase
RPointerArray< MEventObserver > iEventObserverList
TEventType
iEventType
TEventType
|
iEventType
|
[private]
|
CFepUiBaseCtrlExtension * iExtension
CFepUiBaseCtrlExtension *
|
iExtension
|
[private]
|
TBool
iHiden
Flag indicates whether the control is hiden
TBool
iIsActive
TBool
|
iIsActive
|
[private]
|
MLayoutOwner * iLayoutOwner
TRgb
iMaskBkCol
TRgb
|
iMaskBkCol
|
[private]
|
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
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
flag to indicate whehter this control is ready to drawn
TRect
iRect
Control rect. It's relative to ui layout
TInt
iReservered2
TInt
|
iReservered2
|
[private]
|
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]
|
TRect
iShadowRect
TRect
|
iShadowRect
|
[protected]
|
Control shadow rect. It's relative to ui layout
CFepUiLayout * iUiLayout
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
Valid region which reacts to the pointer event
CCoeControl * iWndControl
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.