Collapse all Symbian^3 Product Developer Library

CAknFepCtrlBaseWindow Class Reference

class CAknFepCtrlBaseWindow : public CControlGroup

Class definiton for base window

fepcommonctrls.lib

Since: S60 v3.2

Inherits from

CAknFepCtrlBaseWindow
- CControlGroup
  - CFepUiBaseCtrl
    - CBase

Public Member Functions
	~CAknFepCtrlBaseWindow()
CControlGroup *	ClientPane()
IMPORT_C void	Close()
CAknFepCtrlCommonButton *	CloseButton()
IMPORT_C CFepUiBaseCtrl *	Control(TInt)
IMPORT_C void	Draw()
IMPORT_C void	HandleControlEvent(TInt, CFepUiBaseCtrl *, const TDesC &)
CControlGroup *	HeaderPane()
CAknFepCtrlDragButton *	MoveButton()
IMPORT_C void	SetDragEnable(TBool)
void	SizeChanged(TBool)
CControlGroup *	TitleBar()

Protected Member Functions
	CAknFepCtrlBaseWindow(CFepUiLayout *, TInt)
IMPORT_C void	BaseConstructL()
IMPORT_C TBool	DoClose()

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()
	CControlGroup::ActiveControl()
	CControlGroup::AddControlL(CCoeControl *)
	CControlGroup::AddControlL(CFepUiBaseCtrl *,TBool)
	CControlGroup::AdjustBkCtrlPos()
	CControlGroup::At(TInt)
	CControlGroup::BringToBackInGroup(CFepUiBaseCtrl *)
	CControlGroup::BringToTopInGroup(CFepUiBaseCtrl *)
	CControlGroup::CControlGroup(CFepUiLayout *,TInt)
	CControlGroup::CControlGroup(CFepUiLayout *,TInt,TBool)
	CControlGroup::CalculateClipRegion()
	CControlGroup::CalculateNonHwrStartPtArea()
	CControlGroup::CancelPointerDownL()
	CControlGroup::ConstructFromResourceL()
	CControlGroup::ConstructL()
	CControlGroup::ControlById(TInt)
	CControlGroup::ControlByType(TControlType,TInt)
	CControlGroup::ControlForKindOfType(TStockBaseCtrlType,TInt)
	CControlGroup::ControlForPoints(const TPoint &)
	CControlGroup::ControlList()const
	CControlGroup::DrawControlGroupBackground(const TRect &)
	CControlGroup::Find(CCoeControl *)
	CControlGroup::GetIdx(const CFepUiBaseCtrl *)
	CControlGroup::GetNestedLevel()
	CControlGroup::GraphicDeviceSizeChanged()
	CControlGroup::HandlePointerDownEventL(const TPoint &)
	CControlGroup::HandlePointerEnter(const TPoint &)
	CControlGroup::HandlePointerLeave(const TPoint &)
	CControlGroup::HandlePointerMoveEventL(const TPoint &)
	CControlGroup::HandlePointerUpEventL(const TPoint &)
	CControlGroup::HandleResourceChange(TInt)
	CControlGroup::Hide(TBool)
	CControlGroup::HideControl(CFepUiBaseCtrl *,TBool)
	CControlGroup::HideControl(TInt,TBool)
	CControlGroup::Move(const TPoint &)
	CControlGroup::NeedRedrawBg()const
	CControlGroup::NewL(CFepUiLayout ,CCoeControl )
	CControlGroup::NewL(CFepUiLayout *,TInt,TBool)
	CControlGroup::NumOfControls()
	CControlGroup::OnActivate()
	CControlGroup::OnDeActivate()
	CControlGroup::OnLayoutDraggingEnd()
	CControlGroup::OnLayoutDraggingStart()
	CControlGroup::PopCtrlList()const
	CControlGroup::ReDrawRect(const TRect &)
	CControlGroup::RedrawRectIfNeeded(const TRect &,CFepUiBaseCtrl *)
	CControlGroup::RedrawRectInGrp(CFepUiBaseCtrl *,const TRect &)
	CControlGroup::RemoveControl(CFepUiBaseCtrl *)
	CControlGroup::SetActiveCtrl(CFepUiBaseCtrl *)
	CControlGroup::SetActiveCtrl(TInt)
	CControlGroup::SetNeedRedrawBg(TBool)
	CControlGroup::SetTempActiveCtrl(CFepUiBaseCtrl *)
	CControlGroup::UpdateAreaInGrp(CFepUiBaseCtrl *,const TRect &,TBool)
	CControlGroup::UpdateAreaInGrpImmed(CFepUiBaseCtrl *,const TRect &,TBool)
	CControlGroup::UpdateValidRegion(CFepUiBaseCtrl *,TBool)
	CControlGroup::~CControlGroup()
	CFepUiBaseCtrl::AbleToDraw()
	CFepUiBaseCtrl::AbsOrderPos()
	CFepUiBaseCtrl::ActiveExtResponseArea()
	CFepUiBaseCtrl::AddEventObserver(MEventObserver *)
	CFepUiBaseCtrl::AllowOverlap()
	CFepUiBaseCtrl::BackgroundBmp()
	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

Private Attributes
CControlGroup *	iClientPane
CAknFepCtrlCommonButton *	iCloseButton
CControlGroup *	iHeaderPane
CAknFepCtrlDragButton *	iMoveButton
CControlGroup *	iTitleBar

Inherited Attributes
	CControlGroup::iActiveCtrl
	CControlGroup::iCtrlList
	CControlGroup::iCtrlWithPointerDown
	CControlGroup::iNonHwrStartPtRegion
	CControlGroup::iOwnedCtrlList
	CControlGroup::iPopCtrlList
	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

CAknFepCtrlBaseWindow(CFepUiLayout *, TInt)

IMPORT_C	CAknFepCtrlBaseWindow	(	CFepUiLayout *	aFepUiLayout,
			TInt	aControlId
		)	[protected]

C++ default constructor

Since: S60 v3.2

Parameters

CFepUiLayout * aFepUiLayout	A Ui Layout environment (CFepUiLayout)
TInt aControlId	Control id

~CAknFepCtrlBaseWindow()

IMPORT_C

~CAknFepCtrlBaseWindow

(

)

[virtual]

destructor.

Since: S60 v3.2

Member Functions Documentation

BaseConstructL()

IMPORT_C void

BaseConstructL

(

)

[protected]

Symbian second-phase constructor

Since: S60 v3.2

ClientPane()

CControlGroup *

ClientPane

(

)

const [inline]

Get Client Pane

Since: S60 v3.2

Close()

IMPORT_C void

(

)

Close window

Since: S60 v3.2

CloseButton()

CAknFepCtrlCommonButton *

CloseButton

(

)

const [inline]

Get close button

Since: S60 v3.2

Control(TInt)

IMPORT_C CFepUiBaseCtrl *

Control

(

TInt

aCtrlId

)

Get the control by control id

Since: S60 v3.2

Parameters

TInt aCtrlId

The control id

DoClose()

IMPORT_C TBool

DoClose

(

)

[protected, virtual]

call back function when closing window

Since: S60 v3.2

Draw()

IMPORT_C void

Draw

(

)

[virtual]

From CControlGroup. Draw window

Since: S60 v3.2

HandleControlEvent(TInt, CFepUiBaseCtrl *, const TDesC &)

IMPORT_C void	HandleControlEvent	(	TInt	aEventType,
			CFepUiBaseCtrl *	aCtrl,
			const TDesC &	aEventData
		)

From MEventObserver. Handle the observer event

Since: S60 v3.2

Parameters

TInt aEventType	Event type
CFepUiBaseCtrl * aCtrl	Sender control
const TDesC & aEventData	Event data

HeaderPane()

CControlGroup *

HeaderPane

(

)

const [inline]

Get Header Pane

Since: S60 v3.2

MoveButton()

CAknFepCtrlDragButton *

MoveButton

(

)

const [inline]

Get Client Pane

Since: S60 v3.2

SetDragEnable(TBool)

IMPORT_C void

SetDragEnable

(

TBool

aEnable

)

Enable or disable drag window

Since: S60 v3.2

Parameters

TBool aEnable

ETrue to enable otherwise disable drag

SizeChanged(TBool)

void

SizeChanged

(

TBool

aLandscapeStyle

)

[pure virtual]

Resize

Since: S60 v3.2

Parameters

TBool aLandscapeStyle

Current screen is landscape or not

TitleBar()

CControlGroup *

TitleBar

(

)

const [inline]

Get the title bar

Since: S60 v3.2

Member Data Documentation

CControlGroup * iClientPane

CControlGroup *

iClientPane

[private]

The client pane (Own)

CAknFepCtrlCommonButton * iCloseButton

CAknFepCtrlCommonButton *

iCloseButton

[private]

The close button (Own)

CControlGroup * iHeaderPane

CControlGroup *

iHeaderPane

[private]

The header pane (Own)

CAknFepCtrlDragButton * iMoveButton

CAknFepCtrlDragButton *

iMoveButton

[private]

The move drag button (Own)

CControlGroup * iTitleBar

CControlGroup *

iTitleBar

[private]

The title bar (Own)