Symbian^3 Application Developer Library >

CControlGroup Class Reference

class CControlGroup : public CFepUiBaseCtrl

CControlGroup

CControl group. A CControl group will consists of several controls.

feplayoutcontrol.lib
Since
S60 V4.0

Inherits from

Nested Classes and Structures

Public Member Functions
~CControlGroup ()
IMPORT_C CFepUiBaseCtrl * ActiveControl ()
IMPORT_C void AddControlL ( CFepUiBaseCtrl *, TBool )
IMPORT_C CFepUiBaseCtrl * AddControlL ( CCoeControl *)
void AdjustBkCtrlPos ()
IMPORT_C CFepUiBaseCtrl * At ( TInt )
IMPORT_C void BringToBackInGroup ( CFepUiBaseCtrl *)
IMPORT_C void BringToTopInGroup ( CFepUiBaseCtrl *)
IMPORT_C void CancelPointerDownL ()
IMPORT_C void ConstructFromResourceL ()
IMPORT_C CFepUiBaseCtrl * ControlById ( TInt )
IMPORT_C CFepUiBaseCtrl * ControlByType ( TControlType , TInt )
IMPORT_C CFepUiBaseCtrl * ControlForKindOfType ( TStockBaseCtrlType , TInt )
const RPointerArray < CFepUiBaseCtrl > & ControlList ()
IMPORT_C void Draw ()
CFepUiBaseCtrl * Find ( CCoeControl *)
TInt GetIdx (const CFepUiBaseCtrl *)
TInt GetNestedLevel ()
IMPORT_C void HandlePointerEnter (const TPoint &)
IMPORT_C void HandlePointerLeave (const TPoint &)
IMPORT_C void Hide ( TBool )
IMPORT_C void HideControl ( TInt , TBool )
IMPORT_C void HideControl ( CFepUiBaseCtrl *, TBool )
IMPORT_C void Move (const TPoint &)
TBool NeedRedrawBg ()
IMPORT_C CControlGroup * NewL ( CFepUiLayout *, TInt , TBool )
CControlGroup * NewL ( CFepUiLayout *, CCoeControl *)
IMPORT_C TInt NumOfControls ()
IMPORT_C void OnActivate ()
IMPORT_C void OnDeActivate ()
IMPORT_C void OnLayoutDraggingEnd ()
IMPORT_C void OnLayoutDraggingStart ()
const RPointerArray < CFepUiBaseCtrl > & PopCtrlList ()
IMPORT_C void ReDrawRect (const TRect &)
void RedrawRectIfNeeded (const TRect &, CFepUiBaseCtrl *)
void RedrawRectInGrp ( CFepUiBaseCtrl *, const TRect &)
IMPORT_C TBool RemoveControl ( CFepUiBaseCtrl *)
IMPORT_C CFepUiBaseCtrl * SetActiveCtrl ( CFepUiBaseCtrl *)
IMPORT_C CFepUiBaseCtrl * SetActiveCtrl ( TInt )
void SetNeedRedrawBg ( TBool )
CFepUiBaseCtrl * SetTempActiveCtrl ( CFepUiBaseCtrl *)
void UpdateAreaInGrp ( CFepUiBaseCtrl *, const TRect &, TBool )
void UpdateAreaInGrpImmed ( CFepUiBaseCtrl *, const TRect &, TBool )
IMPORT_C void UpdateValidRegion ( CFepUiBaseCtrl *, TBool )
Protected Member Functions
CControlGroup ( CFepUiLayout *, TInt )
CControlGroup ( CFepUiLayout *, TInt , TBool )
void CalculateClipRegion ()
const RRegion & CalculateNonHwrStartPtArea ()
IMPORT_C void ConstructL ()
CFepUiBaseCtrl * ControlForPoints (const TPoint &)
IMPORT_C void DrawControlGroupBackground (const TRect &)
IMPORT_C void GraphicDeviceSizeChanged ()
IMPORT_C CFepUiBaseCtrl * HandlePointerDownEventL (const TPoint &)
IMPORT_C CFepUiBaseCtrl * HandlePointerMoveEventL (const TPoint &)
IMPORT_C CFepUiBaseCtrl * HandlePointerUpEventL (const TPoint &)
IMPORT_C void HandleResourceChange ( TInt )
Private Member Functions
void AddSubRegionL ( CFepUiBaseCtrl *)
void CalculateClipRegion ( CFepUiBaseCtrl *)
TInt FindSubRegion ( CFepUiBaseCtrl *)
TBool MoveSubCtrlToBack ( CFepUiBaseCtrl *, RPointerArray < CFepUiBaseCtrl > &)
TBool MoveSubCtrlToTop ( CFepUiBaseCtrl *, RPointerArray < CFepUiBaseCtrl > &)
void OnDeActivateL ()
void RemoveCtrlFromSubCtrlInfoList ( CFepUiBaseCtrl *)
TBool RemoveOwnedControl ( CFepUiBaseCtrl *)
void RemoveSubRegion ( TInt )
void SaveSubCtrlShownState ()
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()
CFepUiBaseCtrl::AbleToDraw()
CFepUiBaseCtrl::AbsOrderPos()
CFepUiBaseCtrl::ActiveExtResponseArea()
CFepUiBaseCtrl::AddEventObserver(MEventObserver *)
CFepUiBaseCtrl::AllowOverlap()
CFepUiBaseCtrl::BackgroundBmp()
CFepUiBaseCtrl::BaseConstructL()
CFepUiBaseCtrl::BaseConstructL(CFepUiLayoutRootCtrl *)
CFepUiBaseCtrl::BitGc()
CFepUiBaseCtrl::BitmapDevice()
CFepUiBaseCtrl::BkColor()
CFepUiBaseCtrl::BkMaskBmp()
CFepUiBaseCtrl::BorderColor()
CFepUiBaseCtrl::BorderSize()
CFepUiBaseCtrl::BringToBack()
CFepUiBaseCtrl::BringToTop()
CFepUiBaseCtrl::CFepUiBaseCtrl(CCoeControl *,CFepUiLayout *,TBool)
CFepUiBaseCtrl::CFepUiBaseCtrl(const TRect &,CFepUiLayout *,TInt)
CFepUiBaseCtrl::CancelExtResponseArea()
CFepUiBaseCtrl::CapturePointer(TBool)
CFepUiBaseCtrl::Clear()
CFepUiBaseCtrl::ClearRect(const TRect &)
CFepUiBaseCtrl::CompareOrder(CFepUiBaseCtrl *)
CFepUiBaseCtrl::CompareOrderInSameGroup(CFepUiBaseCtrl *)
CFepUiBaseCtrl::Contains(const TPoint &)
CFepUiBaseCtrl::ControlId()
CFepUiBaseCtrl::ControlType()
CFepUiBaseCtrl::CreateOwnDeviceL(CFbsBitmap *,CFbsBitmap *)
CFepUiBaseCtrl::DisableRegionUpdating()
CFepUiBaseCtrl::DrawBackground(TBool)
CFepUiBaseCtrl::DrawBackground(const TRect,TBool)
CFepUiBaseCtrl::DrawBackgroundToDevice(TRect,CFbsDevice *,CFbsBitmap *,const TRgb &,const TRgb &,TBool)
CFepUiBaseCtrl::DrawBitmap(const CFbsBitmap *,TBool)
CFepUiBaseCtrl::DrawBitmap(const TRect,const CFbsBitmap *,TBool)
CFepUiBaseCtrl::DrawMaskBackground(TBool)
CFepUiBaseCtrl::DrawOpaqueMaskBackground(TBool)
CFepUiBaseCtrl::DrawOpaqueMaskBackground(const TRect,TBool)
CFepUiBaseCtrl::DrawShadow()
CFepUiBaseCtrl::DrawTransparentMaskBackground(const TRect &,TBool)
CFepUiBaseCtrl::EnableExtResponseArea(TBool,const TRect &)
CFepUiBaseCtrl::EnableRegionUpdating()
CFepUiBaseCtrl::Extension_(TUint,TAny *&,TAny *)
CFepUiBaseCtrl::HandlePositionChange(const TPoint &)
CFepUiBaseCtrl::Hiden()
CFepUiBaseCtrl::IsActive()
CFepUiBaseCtrl::IsFepBaseControl()
CFepUiBaseCtrl::IsKindOfControl(TStockBaseCtrlType)
CFepUiBaseCtrl::IsOnTopOf(CFepUiBaseCtrl *)
CFepUiBaseCtrl::MaskBitmapDevice()
CFepUiBaseCtrl::MaskBkCol()
CFepUiBaseCtrl::MovingArea()
CFepUiBaseCtrl::NONSHARABLE_CLASS(CFepUiBaseCtrlExtension)
CFepUiBaseCtrl::OrderPos()const
CFepUiBaseCtrl::Overlapped(CFepUiBaseCtrl *)
CFepUiBaseCtrl::ParentCtrl()
CFepUiBaseCtrl::PenColor()
CFepUiBaseCtrl::PenSize()
CFepUiBaseCtrl::PointerDown()
CFepUiBaseCtrl::Ready()
CFepUiBaseCtrl::Rect()
CFepUiBaseCtrl::Region()
CFepUiBaseCtrl::RemoveEventObserver(MEventObserver *)
CFepUiBaseCtrl::ReportEvent(TInt,const TDesC &)
CFepUiBaseCtrl::RequireRegionUpdateL(TBool)
CFepUiBaseCtrl::ResizeDeviceL()
CFepUiBaseCtrl::ResourceId()
CFepUiBaseCtrl::RootControl()
CFepUiBaseCtrl::SetActive(TBool)
CFepUiBaseCtrl::SetAllowOverlap(TBool)
CFepUiBaseCtrl::SetBackgroundBitmapL(CFbsBitmap *)
CFepUiBaseCtrl::SetBackgroundBmp(CFbsBitmap *)
CFepUiBaseCtrl::SetBackgroundMaskBitmapL(CFbsBitmap *)
CFepUiBaseCtrl::SetBackgroundMaskBmp(CFbsBitmap *)
CFepUiBaseCtrl::SetBkColor(const TRgb &)
CFepUiBaseCtrl::SetBorderColor(const TRgb &)
CFepUiBaseCtrl::SetBorderSize(const TSize &)
CFepUiBaseCtrl::SetControlType(TControlType)
CFepUiBaseCtrl::SetHidenFlag(TBool)
CFepUiBaseCtrl::SetMaskBkCol(const TRgb &)
CFepUiBaseCtrl::SetOrdinalPos(TInt)
CFepUiBaseCtrl::SetParent(CFepUiBaseCtrl *)
CFepUiBaseCtrl::SetPenColor(const TRgb &)
CFepUiBaseCtrl::SetPenSize(const TSize &)
CFepUiBaseCtrl::SetPointerDown(TBool)
CFepUiBaseCtrl::SetReady(TBool)
CFepUiBaseCtrl::SetRect(const TRect &)
CFepUiBaseCtrl::SetRegion(const RRegion &)
CFepUiBaseCtrl::SetResourceId(TInt32)
CFepUiBaseCtrl::SetShadowAreaRect(const TRect &,TShadowBitmapIndex)
CFepUiBaseCtrl::SetShadowBmp(CFbsBitmap *,CFbsBitmap *,TShadowBitmapIndex)
CFepUiBaseCtrl::SetShadowRect(const TRect &)
CFepUiBaseCtrl::SetTactileFeedbackType(TInt)
CFepUiBaseCtrl::ShadowAreaRect(TShadowBitmapIndex)
CFepUiBaseCtrl::ShadowRect()
CFepUiBaseCtrl::SimulateRawEvent(const TRawEvent &)
CFepUiBaseCtrl::TactileFeedbackType()const
CFepUiBaseCtrl::UiLayout()
CFepUiBaseCtrl::UpdateArea(const TRect &,TBool)
CFepUiBaseCtrl::UpdateAreaImmed(const TRect &,TBool)
CFepUiBaseCtrl::ValidClipRegion()
CFepUiBaseCtrl::WholeHiden()
CFepUiBaseCtrl::WndBasedControl()
CFepUiBaseCtrl::WndControl()
CFepUiBaseCtrl::~CFepUiBaseCtrl()
Inherited Enumerations
CFepUiBaseCtrl:TZOrder
Protected Attributes
CFepUiBaseCtrl * iActiveCtrl
RPointerArray < CFepUiBaseCtrl > iCtrlList
CFepUiBaseCtrl * iCtrlWithPointerDown
RRegion iNonHwrStartPtRegion
RPointerArray < CFepUiBaseCtrl > iOwnedCtrlList
RPointerArray < CFepUiBaseCtrl > iPopCtrlList
Private Attributes
TInt iNeedRedrawBg
TInt iReserved2
RArray < TSubCtrlShownState > iSubCtrlShowStateBeforeHiden
RPointerArray < CSubRegionArea > iSubRegionArea
CFepUiBaseCtrl * iTempActiveCtrl
Inherited Attributes
CFepUiBaseCtrl::iBorderColor
CFepUiBaseCtrl::iBorderSize
CFepUiBaseCtrl::iClipRegion
CFepUiBaseCtrl::iParentCtrl
CFepUiBaseCtrl::iPointerLeft
CFepUiBaseCtrl::iRect
CFepUiBaseCtrl::iResourceId
CFepUiBaseCtrl::iShadowAreaRect
CFepUiBaseCtrl::iShadowRect
CFepUiBaseCtrl::iUpdateFlagEnabled
CFepUiBaseCtrl::iValidRegion
CFepUiBaseCtrl::iWndControl

Constructor & Destructor Documentation

CControlGroup(CFepUiLayout *, TInt)

IMPORT_C CControlGroup ( CFepUiLayout * aUiLayout,
TInt aControlId
) [protected]

Default constructor.

Since
S60 V4.0

Parameters

CFepUiLayout * aUiLayout Ui layout who contains this control
TInt aControlId control Id

CControlGroup(CFepUiLayout *, TInt, TBool)

IMPORT_C CControlGroup ( CFepUiLayout * aUiLayout,
TInt aControlId,
TBool aRedrawBg
) [protected]

Default constructor.

Since
S60 V4.0

Parameters

CFepUiLayout * aUiLayout Ui layout who contains this control
TInt aControlId control Id
TBool aRedrawBg

~CControlGroup()

IMPORT_C ~CControlGroup ( ) [virtual]

Destructor

Since
S60 V4.0

Member Functions Documentation

ActiveControl()

IMPORT_C CFepUiBaseCtrl * ActiveControl ( )

Get active control

Since
S60 V4.0

AddControlL(CFepUiBaseCtrl *, TBool)

IMPORT_C void AddControlL ( CFepUiBaseCtrl * aControl,
TBool aOwnerFlag = ETrue
)

Add a control to group

Since
S60 V4.0

Parameters

CFepUiBaseCtrl * aControl New control to be added.Ownership transferred
TBool aOwnerFlag = ETrue The flag tells whether transfer ownership to group. ETrue if group will be the owner A owner is responsible for free the control. Deafult value is ETrue

AddControlL(CCoeControl *)

IMPORT_C CFepUiBaseCtrl * AddControlL ( CCoeControl * aControl )

Add a control to group

Since
S60 V4.0

Parameters

CCoeControl * aControl New control to be added.Ownership transferred. A CFepUiBasedCtrl will be created for this window based control

AddSubRegionL(CFepUiBaseCtrl *)

void AddSubRegionL ( CFepUiBaseCtrl * aCtrl ) [private]

Parameters

CFepUiBaseCtrl * aCtrl

AdjustBkCtrlPos()

void AdjustBkCtrlPos ( )

At(TInt)

IMPORT_C CFepUiBaseCtrl * At ( TInt aIndex )

Get control for an position index

Since
S60 V4.0

Parameters

TInt aIndex Control index in group. Index starts from 0

BringToBackInGroup(CFepUiBaseCtrl *)

IMPORT_C void BringToBackInGroup ( CFepUiBaseCtrl * aCtrl ) [virtual]

Parameters

CFepUiBaseCtrl * aCtrl

BringToTopInGroup(CFepUiBaseCtrl *)

IMPORT_C void BringToTopInGroup ( CFepUiBaseCtrl * aCtrl ) [virtual]

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

Since
S60 V5.0 aCtrl The control to be shown.

Parameters

CFepUiBaseCtrl * aCtrl

CalculateClipRegion()

void CalculateClipRegion ( ) [protected]

CalculateClipRegion(CFepUiBaseCtrl *)

void CalculateClipRegion ( CFepUiBaseCtrl * aCtrl ) [private]

Parameters

CFepUiBaseCtrl * aCtrl

CalculateNonHwrStartPtArea()

const RRegion & CalculateNonHwrStartPtArea ( ) [protected]

CancelPointerDownL()

IMPORT_C void CancelPointerDownL ( ) [virtual]

From CFepUiBaseCtrl Cancel pointer down event. This will be called when a control has pointer down but pointer up event happens in other ways.

Since
S60 V4.0

ConstructFromResourceL()

IMPORT_C void ConstructFromResourceL ( )

From CFepUiBaseCtrl Construct from resource. Handle resource change

Since
S60 V4.0

ConstructL()

IMPORT_C void ConstructL ( ) [protected]

Symbian second phrase constructor

Since
S60 V4.0

ControlById(TInt)

IMPORT_C CFepUiBaseCtrl * ControlById ( TInt aCtrlId )

Get the sub control for given control Id.

Parameters

TInt aCtrlId The control id

ControlByType(TControlType, TInt)

IMPORT_C CFepUiBaseCtrl * ControlByType ( TControlType aType,
TInt aIndex = 0
)

Find qualified control in layout whose control type is exactly the same as the given one.

Since
S60 v4.0

Parameters

TControlType aType The contol type
TInt aIndex = 0 The control index. The nth control for such type in this group. The index is counted seperated for different control type.

ControlForKindOfType(TStockBaseCtrlType, TInt)

IMPORT_C CFepUiBaseCtrl * ControlForKindOfType ( TStockBaseCtrlType aType,
TInt aIndex = 0
)

Find qualified control in layout according to the type and index. Unlike ControlByType, it finds all controls which is kind of such type, includes those derived controls.

Since
S60 v4.0

Parameters

TStockBaseCtrlType aType The contol type
TInt aIndex = 0 The control index. The nth control for such type in this group. The index is counted seperated for different control type.

ControlForPoints(const TPoint &)

CFepUiBaseCtrl * ControlForPoints ( const TPoint & aPt ) [protected]

Parameters

const TPoint & aPt

ControlList()

const RPointerArray < CFepUiBaseCtrl > & ControlList ( ) const [inline]

Get control list

Since
S60 v4.0

Draw()

IMPORT_C void Draw ( ) [virtual]

From base class CFepUiBaseCtrl /** From CFepUiBaseCtrl Draw control

Since
S60 V4.0

DrawControlGroupBackground(const TRect &)

IMPORT_C void DrawControlGroupBackground ( const TRect & aUpdateRegion ) [protected, virtual]

Draw ControlGroup Background

Since
S60 V5.0

Parameters

const TRect & aUpdateRegion The rect to be updated

Find(CCoeControl *)

CFepUiBaseCtrl * Find ( CCoeControl * aCtrl )

Check whether this control is in the control group

Since
S60 v4.0

Parameters

CCoeControl * aCtrl The control to be found

FindSubRegion(CFepUiBaseCtrl *)

TInt FindSubRegion ( CFepUiBaseCtrl * aCtrl ) [private]

Parameters

CFepUiBaseCtrl * aCtrl

GetIdx(const CFepUiBaseCtrl *)

TInt GetIdx ( const CFepUiBaseCtrl * aCtrl )

Parameters

const CFepUiBaseCtrl * aCtrl

GetNestedLevel()

TInt GetNestedLevel ( )

GraphicDeviceSizeChanged()

IMPORT_C void GraphicDeviceSizeChanged ( ) [protected, virtual]

Handle pen UI graphic device size change event

Since
S60 V5.0

HandlePointerDownEventL(const TPoint &)

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

From CFepUiBaseCtrl Handle pointer down event

Since
S60 V4.0

Parameters

const TPoint & aPoint The point position relative the layout

HandlePointerEnter(const TPoint &)

IMPORT_C void HandlePointerEnter ( const TPoint & aPoint ) [virtual]

From CFepUiBaseCtrl 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 & aPoint current pointer position

HandlePointerLeave(const TPoint &)

IMPORT_C void HandlePointerLeave ( const TPoint & aPoint ) [virtual]

From CFepUiBaseCtrl 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 & aPoint current pointer position

HandlePointerMoveEventL(const TPoint &)

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

From CFepUiBaseCtrl Handle pointer move event

Since
S60 V4.0

Parameters

const TPoint & aPoint The point position relative the layout

HandlePointerUpEventL(const TPoint &)

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

From CFepUiBaseCtrl Handle pointer up event

Since
S60 V4.0

Parameters

const TPoint & aPoint The point position relative the layout

HandleResourceChange(TInt)

IMPORT_C void HandleResourceChange ( TInt aType ) [protected, virtual]

Handle system resource change

Since
S60 V5.0

Parameters

TInt aType The system resource change type

Hide(TBool)

IMPORT_C void Hide ( TBool aFlag ) [virtual]

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

Since
S60 V4.0

Parameters

TBool aFlag ETrue if want to hide the control.

HideControl(TInt, TBool)

IMPORT_C void HideControl ( TInt aIndex,
TBool aFlag = ETrue
)

Hide Control

Since
S60 V4.0

Parameters

TInt aIndex control index
TBool aFlag = ETrue control hide flag. ETrue if going to be hiden. Otherwise EFalse Deafult value is ETrue

HideControl(CFepUiBaseCtrl *, TBool)

IMPORT_C void HideControl ( CFepUiBaseCtrl * aControl,
TBool aFlag = ETrue
)

Hide Control

Since
S60 V4.0

Parameters

CFepUiBaseCtrl * aControl The button to be hiden
TBool aFlag = ETrue Contrl hide flag. ETrue if going to be hiden. Otherwise EFalse Default value is ETrue

Move(const TPoint &)

IMPORT_C void Move ( const TPoint & aOffset ) [virtual]

From CFepUiBaseCtrl Move control

Since
S60 V4.0

Parameters

const TPoint & aOffset The offset to be moved

MoveSubCtrlToBack(CFepUiBaseCtrl *, RPointerArray< CFepUiBaseCtrl > &)

TBool MoveSubCtrlToBack ( CFepUiBaseCtrl * aCtrl,
RPointerArray < CFepUiBaseCtrl > & aList
) [private]

Parameters

CFepUiBaseCtrl * aCtrl
RPointerArray < CFepUiBaseCtrl > & aList

MoveSubCtrlToTop(CFepUiBaseCtrl *, RPointerArray< CFepUiBaseCtrl > &)

TBool MoveSubCtrlToTop ( CFepUiBaseCtrl * aCtrl,
RPointerArray < CFepUiBaseCtrl > & aList
) [private]

Parameters

CFepUiBaseCtrl * aCtrl
RPointerArray < CFepUiBaseCtrl > & aList

NeedRedrawBg()

TBool NeedRedrawBg ( ) const [inline]

NewL(CFepUiLayout *, TInt, TBool)

IMPORT_C CControlGroup * NewL ( CFepUiLayout * aUiLayout,
TInt aControlId,
TBool aRedrawBg = ETrue
) [static]

Factory function.

Since
S60 V4.0

Parameters

CFepUiLayout * aUiLayout Ui layout who contains this control.Ownership not transferred
TInt aControlId control Id
TBool aRedrawBg = ETrue

NewL(CFepUiLayout *, CCoeControl *)

CControlGroup * NewL ( CFepUiLayout * aUiLayout,
CCoeControl * aControl
)

Parameters

CFepUiLayout * aUiLayout
CCoeControl * aControl

NumOfControls()

IMPORT_C TInt NumOfControls ( )

Get control counts

Since
S60 V4.0

OnActivate()

IMPORT_C void OnActivate ( ) [virtual]

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

Since
S60 v4.0

OnDeActivate()

IMPORT_C void OnDeActivate ( ) [virtual]

From CFepUiBaseCtrl OnDeActivate. Called when the layout is going to be hidden

Since
S60 v4.0

OnDeActivateL()

void OnDeActivateL ( ) [private]

OnLayoutDraggingEnd()

IMPORT_C void OnLayoutDraggingEnd ( ) [virtual]

From CFepUiBaseCtrl Call back function when layout ends dragging

Since
S60 V4.0

OnLayoutDraggingStart()

IMPORT_C void OnLayoutDraggingStart ( ) [virtual]

From CFepUiBaseCtrl Call back function when layout starts dragging

Since
S60 V4.0

PopCtrlList()

const RPointerArray < CFepUiBaseCtrl > & PopCtrlList ( ) const [inline]

ReDrawRect(const TRect &)

IMPORT_C void ReDrawRect ( const TRect & aRect ) [virtual]

From CFepUiBaseCtrl Redraws the content in a control

Since
S60 V4.0

Parameters

const TRect & aRect The rect to be redrawed

RedrawRectIfNeeded(const TRect &, CFepUiBaseCtrl *)

void RedrawRectIfNeeded ( const TRect & aRect,
CFepUiBaseCtrl * aCtrl
)

Redraws the content in a control if needed. The redraw is caused by aCtrl's updating aRect.

Since
S60 V5.0

Parameters

const TRect & aRect The rect to be redrawed
CFepUiBaseCtrl * aCtrl The control who initiates the updating.

RedrawRectInGrp(CFepUiBaseCtrl *, const TRect &)

void RedrawRectInGrp ( CFepUiBaseCtrl * aControl,
const TRect & aRect
)

Parameters

CFepUiBaseCtrl * aControl
const TRect & aRect

RemoveControl(CFepUiBaseCtrl *)

IMPORT_C TBool RemoveControl ( CFepUiBaseCtrl * aControl )

RemoveControl Remove a control from the control group

Since
S60 v4.0

Parameters

CFepUiBaseCtrl * aControl The control to be removed.

RemoveCtrlFromSubCtrlInfoList(CFepUiBaseCtrl *)

void RemoveCtrlFromSubCtrlInfoList ( CFepUiBaseCtrl * aControl ) [private]

Parameters

CFepUiBaseCtrl * aControl

RemoveOwnedControl(CFepUiBaseCtrl *)

TBool RemoveOwnedControl ( CFepUiBaseCtrl * aControl ) [private]

RemoveOwnedControl Remove a control from group's owned control list

Since
S60 v4.0

Parameters

CFepUiBaseCtrl * aControl The control to be removed.

RemoveSubRegion(TInt)

void RemoveSubRegion ( TInt aIdx ) [private]

Parameters

TInt aIdx

SaveSubCtrlShownState()

void SaveSubCtrlShownState ( ) [private]

SetActiveCtrl(CFepUiBaseCtrl *)

IMPORT_C CFepUiBaseCtrl * SetActiveCtrl ( CFepUiBaseCtrl * aControl ) [virtual]

Set control to be actived.

Since
S60 V4.0

Parameters

CFepUiBaseCtrl * aControl The control to be set to actived. Ownership not transferred.

SetActiveCtrl(TInt)

IMPORT_C CFepUiBaseCtrl * SetActiveCtrl ( TInt aIndex )

Set control to be actived

Since
S60 V4.0

Parameters

TInt aIndex The control index. Ownership not transferred.

SetNeedRedrawBg(TBool)

void SetNeedRedrawBg ( TBool aNeedRedrawBg ) [inline]

Parameters

TBool aNeedRedrawBg

SetTempActiveCtrl(CFepUiBaseCtrl *)

CFepUiBaseCtrl * SetTempActiveCtrl ( CFepUiBaseCtrl * aCtrl )

Set control to be temparory actived. When button is pressed, the control is temparary set to be actived. When button is up, it's set to be actived.

Since
S60 V4.0

Parameters

CFepUiBaseCtrl * aCtrl

UpdateAreaInGrp(CFepUiBaseCtrl *, const TRect &, TBool)

void UpdateAreaInGrp ( CFepUiBaseCtrl * aControl,
const TRect & aRect,
TBool aUpdateFlag
)

Parameters

CFepUiBaseCtrl * aControl
const TRect & aRect
TBool aUpdateFlag

UpdateAreaInGrpImmed(CFepUiBaseCtrl *, const TRect &, TBool)

void UpdateAreaInGrpImmed ( CFepUiBaseCtrl * aControl,
const TRect & aRect,
TBool aUpdateFlag
)

Parameters

CFepUiBaseCtrl * aControl
const TRect & aRect
TBool aUpdateFlag

UpdateValidRegion(CFepUiBaseCtrl *, TBool)

IMPORT_C void UpdateValidRegion ( CFepUiBaseCtrl * aCtrl,
TBool aRemoveFlag
) [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 * aCtrl The control whose displaying status changed
TBool aRemoveFlag

Member Data Documentation

CFepUiBaseCtrl * iActiveCtrl

CFepUiBaseCtrl * iActiveCtrl [protected]

Active control Not own

RPointerArray< CFepUiBaseCtrl > iCtrlList

RPointerArray < CFepUiBaseCtrl > iCtrlList [protected]

Control list for all controls

CFepUiBaseCtrl * iCtrlWithPointerDown

CFepUiBaseCtrl * iCtrlWithPointerDown [protected]

Control which gets the pointer down event Not own

TInt iNeedRedrawBg

TInt iNeedRedrawBg [private]

Reserved item1

RRegion iNonHwrStartPtRegion

RRegion iNonHwrStartPtRegion [protected]

RPointerArray< CFepUiBaseCtrl > iOwnedCtrlList

RPointerArray < CFepUiBaseCtrl > iOwnedCtrlList [protected]

Control list for all owned controls. Control group will be responsible for release owned controls

RPointerArray< CFepUiBaseCtrl > iPopCtrlList

RPointerArray < CFepUiBaseCtrl > iPopCtrlList [protected]

This is the control list for those control which must be shown on top, and which doesn't directly belong ( as a direct child of) to current group

TInt iReserved2

TInt iReserved2 [private]

Reserved item2

RArray< TSubCtrlShownState > iSubCtrlShowStateBeforeHiden

RArray < TSubCtrlShownState > iSubCtrlShowStateBeforeHiden [private]

list to record sub control's hide/show state before control group is hidden

RPointerArray< CSubRegionArea > iSubRegionArea

RPointerArray < CSubRegionArea > iSubRegionArea [private]

CFepUiBaseCtrl * iTempActiveCtrl

CFepUiBaseCtrl * iTempActiveCtrl [private]

temparory active control Not own

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.