Collapse all Symbian^3 Product Developer Library

CHuiDisplayCoeControl Class Reference

class CHuiDisplayCoeControl : public CCoeControl

CHuiCoeControlDisplay is CCoeControl-derived, window-owning control that is attached to a CHuiDisplay instance. The entire area of the control is used for rendering.

Inherits from

CHuiDisplayCoeControl
- CCoeControl
  - CBase

Public Member Functions
	~CHuiDisplayCoeControl()
IMPORT_C CHuiDisplay &	Display()
IMPORT_C CHuiEnv &	Env()
IMPORT_C CHuiDisplayCoeControl *	NewL(CHuiEnv &, const TRect &, TInt)
IMPORT_C CHuiDisplayCoeControl *	NewLC(CHuiEnv &, const TRect &, TInt)

Protected Member Functions
	CHuiDisplayCoeControl(CHuiEnv &)
IMPORT_C void	ConstructL(const TRect &, TInt)
IMPORT_C void	DisplayCoeCntrlExtension(const TUid &, TAny **)
IMPORT_C void	HandlePointerEventL(const TPointerEvent &)

Private Member Functions
IMPORT_C void	ActivateL()
IMPORT_C CCoeControl *	ComponentControl(TInt)
IMPORT_C void	ConstructFromResourceL(TResourceReader &)
IMPORT_C TInt	CountComponentControls()
IMPORT_C void	Draw(const TRect &)
IMPORT_C void	FocusChanged(TDrawNow)
IMPORT_C void	HandleControlEventL(CCoeControl *, TCoeEvent)
IMPORT_C void	HandleResourceChange(TInt)
IMPORT_C TCoeInputCapabilities	InputCapabilities()
IMPORT_C void	MakeVisible(TBool)
IMPORT_C TKeyResponse	OfferKeyEventL(const TKeyEvent &, TEventCode)
IMPORT_C void	PositionChanged()
IMPORT_C void	PrepareForFocusGainL()
IMPORT_C void	PrepareForFocusLossL()
IMPORT_C void	SetContainerWindowL(const CCoeControl &)
IMPORT_C void	SetDimmed(TBool)
IMPORT_C void	SizeChanged()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CCoeControl::AccumulatedZoom()const
	CCoeControl::ActivateGc()const
	CCoeControl::BackedUpWindow()const
	CCoeControl::Background()const
	CCoeControl::CCoeControl()
	CCoeControl::CCoeControl(CCoeEnv *)
	CCoeControl::CCoeControl(const CCoeControl &)
	CCoeControl::CapturesPointer()const
	CCoeControl::ClaimPointerGrab(TBool)
	CCoeControl::ClaimPointerGrab(TInt,TBool)
	CCoeControl::CloseWindow()
	CCoeControl::ComponentArrayExists()const
	CCoeControl::Components()
	CCoeControl::Components()const
	CCoeControl::ControlContext()const
	CCoeControl::ControlEnv()const
	CCoeControl::CopyControlContextFrom(const CCoeControl *)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &)
	CCoeControl::CreateBackedUpWindowL(RWindowTreeNode &,TDisplayMode)
	CCoeControl::CreateWindowL()
	CCoeControl::CreateWindowL(RWindowGroup *)
	CCoeControl::CreateWindowL(RWindowTreeNode &)
	CCoeControl::CreateWindowL(const CCoeControl *)
	CCoeControl::CustomGc()const
	CCoeControl::DeactivateGc()const
	CCoeControl::DrawBackground(const TRect &)const
	CCoeControl::DrawDeferred()const
	CCoeControl::DrawForeground(const TRect &)const
	CCoeControl::DrawNow()const
	CCoeControl::DrawNow(const TRect &)const
	CCoeControl::DrawableWindow()const
	CCoeControl::EnableDragEvents()
	CCoeControl::EnableReportControlStateChange(TBool)
	CCoeControl::EnableWindowTransparency()
	CCoeControl::FindBackground()const
	CCoeControl::FindFontProvider()const
	CCoeControl::GetColor(TInt,TRgb &)const
	CCoeControl::GetColorUseListL(CArrayFix< TCoeColorUse > &)const
	CCoeControl::GetGc()const
	CCoeControl::GetHelpContext(TCoeHelpContext &)const
	CCoeControl::GrabbingComponent()const
	CCoeControl::GrabbingComponent(TInt)const
	CCoeControl::HandleComponentControlsResourceChange(TInt)
	CCoeControl::HandleControlArrayEventL(CCoeControlArray::TEvent,const CCoeControlArray ,CCoeControl ,TInt)
	CCoeControl::HandlePointerBufferReadyL()
	CCoeControl::HandleRedrawEvent(const TRect &)const
	CCoeControl::HasBorder()const
	CCoeControl::HitTest()const
	CCoeControl::IgnoreEventsUntilNextPointerUp()
	CCoeControl::Index(const CCoeControl *)const
	CCoeControl::InitComponentArrayL()
	CCoeControl::IsActivated()const
	CCoeControl::IsBackedUp()const
	CCoeControl::IsBeingDestroyed()const
	CCoeControl::IsBlank()const
	CCoeControl::IsDimmed()const
	CCoeControl::IsFocused()const
	CCoeControl::IsNonFocusing()const
	CCoeControl::IsReadyToDraw()const
	CCoeControl::IsVisible()const
	CCoeControl::LayoutManager()const
	CCoeControl::MaximumWidth()const
	CCoeControl::MinimumSize()
	CCoeControl::MopSupplyObject(TTypeUid)
	CCoeControl::NotifyFontChange(const CCoeFontProvider *)
	CCoeControl::Observer()const
	CCoeControl::OverrideColorL(TInt,TRgb)
	CCoeControl::OwnsWindow()const
	CCoeControl::Parent()
	CCoeControl::Parent()const
	CCoeControl::Position()const
	CCoeControl::PositionRelativeToScreen()const
	CCoeControl::ProcessPointerBufferReadyL()
	CCoeControl::ProcessPointerEventL(const TPointerEvent &)
	CCoeControl::Rect()const
	CCoeControl::RecursivelyMergeInputCapabilities(TCoeInputCapabilities &)const
	CCoeControl::RecursivelyMergedInputCapabilities()const
	CCoeControl::RefetchPixelMappingL()
	CCoeControl::RemoveFromParent()
	CCoeControl::ReportEventL(MCoeControlObserver::TCoeEvent)
	CCoeControl::RequestRelayout(const CCoeControl *)
	CCoeControl::ResetGc()const
	CCoeControl::ScreenFont(const TCoeFont &)const
	CCoeControl::SetAdjacent(TInt)
	CCoeControl::SetAllowStrayPointers()
	CCoeControl::SetBackground(const MCoeControlBackground *)
	CCoeControl::SetBlank()
	CCoeControl::SetCanDrawOutsideRect()
	CCoeControl::SetComponentsToInheritVisibility(TBool)
	CCoeControl::SetContainerWindowL(RBackedUpWindow &)
	CCoeControl::SetContainerWindowL(RWindow &)
	CCoeControl::SetControlContext(MCoeControlContext *)
	CCoeControl::SetCornerAndSize(TGulAlignment,const TSize &)
	CCoeControl::SetCustomGc(CWindowGc *)
	CCoeControl::SetExtent(const TPoint &,const TSize &)
	CCoeControl::SetExtentToWholeScreen()
	CCoeControl::SetFocus(TBool,TDrawNow)
	CCoeControl::SetFocusing(TBool)
	CCoeControl::SetFontProviderL(const CCoeFontProvider &)
	CCoeControl::SetGc(CWindowGc *)const
	CCoeControl::SetGloballyCapturing(TBool)
	CCoeControl::SetHitTest(const MCoeControlHitTest *)
	CCoeControl::SetLayoutManagerL(MCoeLayoutManager *)
	CCoeControl::SetMaximumWidth(TInt)
	CCoeControl::SetMopParent(MObjectProvider *)
	CCoeControl::SetNeighbor(CCoeControl *)
	CCoeControl::SetNonFocusing()
	CCoeControl::SetObserver(MCoeControlObserver *)
	CCoeControl::SetParent(CCoeControl *)
	CCoeControl::SetPointerCapture(TBool)
	CCoeControl::SetPosition(const TPoint &)
	CCoeControl::SetRect(const TRect &)
	CCoeControl::SetSize(const TSize &)
	CCoeControl::SetSizeWithoutNotification(const TSize &)
	CCoeControl::SetTextBaselineSpacing(TInt)
	CCoeControl::SetUniqueHandle(TInt)
	CCoeControl::SetZoomFactorL(TInt,TZoomType)
	CCoeControl::Size()const
	CCoeControl::SystemGc()const
	CCoeControl::TextBaselineOffset(const TSize &)const
	CCoeControl::TextDrawer(TInt)const
	CCoeControl::UniqueHandle()const
	CCoeControl::Window()const
	CCoeControl::WriteInternalStateL(RWriteStream &)const
	CCoeControl::WriteInternalStateNowL(RWriteStream &)const
	CCoeControl::ZoomWithType()const
	CCoeControl::operator=(const CCoeControl &)
	CCoeControl::~CCoeControl()

Inherited Enumerations
	CCoeControl:TZoomType

Private Attributes
CHuiDisplay *	iDisplay
CHuiEnv &	iEnv
TRect	iPrevRect
TAny *	iSpare

Inherited Attributes
	CCoeControl::iCoeEnv
	CCoeControl::iContext
	CCoeControl::iPosition
	CCoeControl::iSize

Constructor & Destructor Documentation

CHuiDisplayCoeControl(CHuiEnv &)

IMPORT_C

CHuiDisplayCoeControl

(

CHuiEnv &

aEnv

)

[protected]

Constructor.

Parameters

CHuiEnv & aEnv

The environment that manages this display.

~CHuiDisplayCoeControl()

IMPORT_C

~CHuiDisplayCoeControl

(

)

Destructor.

Member Functions Documentation

ActivateL()

IMPORT_C void

ActivateL

(

)

[private, virtual]

ComponentControl(TInt)

IMPORT_C CCoeControl *

ComponentControl

(

TInt

aIndex

)

const [private, virtual]

Returns a pointer to a CoeControl inside this control.

Parameters

TInt aIndex

ConstructFromResourceL(TResourceReader &)

IMPORT_C void

ConstructFromResourceL

(

TResourceReader &

aReader

)

[private, virtual]

Parameters

TResourceReader & aReader

ConstructL(const TRect &, TInt)

IMPORT_C void	ConstructL	(	const TRect &	aRect,
			TInt	aFlags
		)	[protected, virtual]

Second-phase constructor. Creates a window and an OpenGL context.

Parameters

const TRect & aRect	Frame rectangle for container.
TInt aFlags	New display flags from CHuiEnv.

CountComponentControls()

IMPORT_C TInt

CountComponentControls

(

)

const [private, virtual]

Returns the number of CoeControls inside this control.

Display()

IMPORT_C CHuiDisplay &

Display

(

)

Returns the display of this CHuiDisplayCoeControl.

DisplayCoeCntrlExtension(const TUid &, TAny **)

IMPORT_C void	DisplayCoeCntrlExtension	(	const TUid &	aEstensionUid,
			TAny **	aExtensionParams
		)	[protected, virtual]

Parameters

const TUid & aEstensionUid
TAny ** aExtensionParams

Draw(const TRect &)

IMPORT_C void

Draw

(

const TRect &

aRect

)

const [private, virtual]

From CCoeControl. Invalidate drawing area. No synchronous drawing takes place here

Parameters

const TRect & aRect

Env()

IMPORT_C CHuiEnv &

Env

(

)

Returns the environment of this CHuiDisplayCoeControl.

FocusChanged(TDrawNow)

IMPORT_C void

FocusChanged

(

TDrawNow

aDrawNow

)

[private, virtual]

Parameters

TDrawNow aDrawNow

HandleControlEventL(CCoeControl *, TCoeEvent)

IMPORT_C void	HandleControlEventL	(	CCoeControl *	aControl,
			TCoeEvent	aEventType
		)	[private]

Acts upon changes in the hosted control's state.

Parameters

CCoeControl * aControl	The control changing its state
TCoeEvent aEventType	The type of control event

HandlePointerEventL(const TPointerEvent &)

IMPORT_C void

HandlePointerEventL

(

const TPointerEvent &

aPointerEvent

)

[protected, virtual]

Handle pointer events.

Parameters

const TPointerEvent & aPointerEvent

HandleResourceChange(TInt)

IMPORT_C void

HandleResourceChange

(

TInt

aType

)

[private, virtual]

Handles resource change.

S60 documentation.

Parameters

TInt aType

InputCapabilities()

IMPORT_C TCoeInputCapabilities

InputCapabilities

(

)

const [private, virtual]

MakeVisible(TBool)

IMPORT_C void

MakeVisible

(

TBool

aVisible

)

[private, virtual]

! future proofing, just basecall

Parameters

TBool aVisible

NewL(CHuiEnv &, const TRect &, TInt)

IMPORT_C CHuiDisplayCoeControl *	NewL	(	CHuiEnv &	aEnv,
			const TRect &	aRect,
			TInt	aFlags = 0
		)	[static]

Construct a new CoeControl that has a rendering surface.

Parameters

CHuiEnv & aEnv	Environment.
const TRect & aRect
TInt aFlags = 0

NewLC(CHuiEnv &, const TRect &, TInt)

IMPORT_C CHuiDisplayCoeControl *	NewLC	(	CHuiEnv &	aEnv,
			const TRect &	aRect,
			TInt	aFlags = 0
		)	[static]

Construct a new CoeControl that has a rendering surface, and leaves it on the cleanup stack.

Parameters

CHuiEnv & aEnv	Environment.
const TRect & aRect
TInt aFlags = 0

OfferKeyEventL(const TKeyEvent &, TEventCode)

IMPORT_C TKeyResponse	OfferKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)	[private, virtual]

Called when a key input event is received by the display. The input event is passed on to one of the controls in the display.

Parameters

const TKeyEvent & aKeyEvent	Key event.
TEventCode aType	Type of the event.

PositionChanged()

IMPORT_C void

PositionChanged

(

)

[private, virtual]

PrepareForFocusGainL()

IMPORT_C void

PrepareForFocusGainL

(

)

[private, virtual]

PrepareForFocusLossL()

IMPORT_C void

PrepareForFocusLossL

(

)

[private, virtual]

SetContainerWindowL(const CCoeControl &)

IMPORT_C void

SetContainerWindowL

(

const CCoeControl &

aContainer

)

[private, virtual]

Parameters

const CCoeControl & aContainer

SetDimmed(TBool)

IMPORT_C void

SetDimmed

(

TBool

aDimmed

)

[private, virtual]

Parameters

TBool aDimmed

SizeChanged()

IMPORT_C void

SizeChanged

(

)

[private, virtual]

Called when the size of the control changes.

Member Data Documentation

CHuiDisplay * iDisplay

CHuiDisplay *

iDisplay

[private]

Display attached to this CoeControl. Not owned.

CHuiEnv & iEnv

CHuiEnv &

iEnv

[private]

The environment that manages this display.

TRect iPrevRect

TRect

iPrevRect

[private]

Previous working rectangle of this container control.

TAny * iSpare

TAny *

iSpare

[private]