Collapse all Symbian^3 Application Developer Library

MHuiVisualOwner Class Reference

class MHuiVisualOwner

Interface for visual owners. A class that owns a visual must implement this interface. Visual owners are expected to destroy their visuals when the owner is destroyed.

Public Member Functions
	~MHuiVisualOwner ()
void	AppendL ( CHuiVisual *)
CHuiControlGroup *	ControlGroup ()
CHuiEnv &	Env ()
MHuiEventHandler *	EventHandler ()
void	Remove ( CHuiVisual *)
void	VisualDestroyed ( CHuiVisual &)
void	VisualLayoutUpdated ( CHuiVisual &)
void	VisualPrepareDrawFailed ( CHuiVisual &, TInt )

Constructor & Destructor Documentation

~MHuiVisualOwner()

IMPORT_C

~MHuiVisualOwner

(

)

[virtual]

Member Functions Documentation

AppendL(CHuiVisual *)

void

AppendL

(

CHuiVisual *

aVisual

)

[pure virtual]

Appends a visual to the visual owner.

Parameters

CHuiVisual * aVisual

Visual to append. The owner receives ownership of the visual.

ControlGroup()

CHuiControlGroup *

ControlGroup

(

)

const [pure virtual]

Determines the control group in which the owner belong to. If the owner does not belong to a control group, NULL is returned.

Env()

CHuiEnv &

Env

(

)

const [pure virtual]

Returns the environment where this visual belongs into.

EventHandler()

MHuiEventHandler *

EventHandler

(

)

[pure virtual]

Returns the event handler resposible for handling events related to the visual, for example when the visual receives a pointer down event.

Remove(CHuiVisual *)

void

Remove

(

CHuiVisual *

aVisual

)

[pure virtual]

Removes a visual from the owner.

Parameters

CHuiVisual * aVisual

Visual to remove.

VisualDestroyed(CHuiVisual &)

void

VisualDestroyed

(

CHuiVisual &

aVisual

)

[pure virtual]

Removes a visual from the ownership of the owner. This is called when the visual is being destroyed.

Parameters

CHuiVisual & aVisual

Visual to remove.

VisualLayoutUpdated(CHuiVisual &)

void

VisualLayoutUpdated

(

CHuiVisual &

aVisual

)

[pure virtual]

Notifies the owner that the layout of a visual has been recalculated. Called only when the EHuiVisualFlagLayoutUpdateNotification flag has been set for the visual.

Parameters

CHuiVisual & aVisual

Visual that has been laid out.

VisualPrepareDrawFailed(CHuiVisual &, TInt)

void	VisualPrepareDrawFailed	(	CHuiVisual &	aVisual,
			TInt	aErrorCode
		)	[pure virtual]

Notifies the visual owner if there was an error (a leave happened) when preparing the visual for drawing. Typically the resource alloc errors such as out of memory is escalated through this callback.

Parameters

CHuiVisual & aVisual	Visual that caused the error.
TInt aErrorCode	Symbian KErr error code for the failure.