Class CWindowAnim

class CWindowAnim : public CAnim;

Description

Window animation interface.

This interface is provided to create animations other than sprites. A window animation can be provided by deriving from this class.

The interface inherits from CAnim and has access to its functions. It additionally can access an interface for querying and manipulating the window in which the animation takes place, using its iWindowFunctions member.

The derived class is constructed in the DLL factory class CAnimDll::CreateInstanceL(TInt).

Derivation

• MEventHandler - Event handler interface.
• CBase - Base class for all classes to be instantiated on the heap.

• CAnim - Server side animated object base interface.

• CWindowAnim - Window animation interface.

Members

Defined in CWindowAnim:

• CWindowAnim()Protected constructor.
• ConstructL(TAny *,TBool)Server side construction and initialisation of an animation class.
• FocusChanged(TBool)Notifies change of focus.
• Redraw()Redraws the objects.
• ReservedW1()const
• ReservedW2()const
• iGcPointer to the graphics context.
• iWindowFunctionsPointer to a class containing functions implemented by the window server.

Inherited from CAnim:

• Animate(TDateTime *)Main animation function, called by the window server.
• Command(TInt,TAny *)Implements client-side initiated commands.
• CommandReplyL(TInt,TAny *)Implements client-side initiated commands, returning a value.
• HandleNotification(const TWsEvent &)
• iFunctionsPointer to a class containing functions implemented by the window server.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Inherited from MEventHandler:

• OfferRawEvent(const TRawEvent &)Handles raw events.

See also:

• CFreeTimerWindowAnimFree timer animation interface.
• CSpriteAnimSprite animation interface.

virtual void ConstructL(TAny *aArgs, TBool aHasFocus)=0;

Description

Server side construction and initialisation of an animation class.

Note: the aHasFocus argument allows the animation to start in a known focus state. For example, an animation may or may not have focus, depending on how it was started. Together with the CWindowAnim::FocusChanged(TBool) function, this allows an animation to always know its focus state.

Parameters

TAny *aArgs Packaged arguments which may be required during construction. These are transferred from the aParams argument of the client side constructor's RAnim::Construct(const RWindowBase &,TInt,const TDesC8 &). TBool aHasFocus Specifies whether or not the animation has window server focus.

protected: inline CWindowAnim();

Description

Protected constructor.

Prevents objects of this class being directly constructed.

virtual void Redraw()=0;

Description

Redraws the objects.

The function is called by the window server when it needs to redraw the object. The object must provide all the low level drawing code.

virtual void FocusChanged(TBool aState)=0;

Description

Notifies change of focus.

The function is called by the window server to notify a change of focus, allowing the animation code to track whether it does or does not have focus, and to change its appearance accordingly.

Parameters

TBool aState Indicates whether the focus has or has not changed.

private: inline virtual void ReservedW1() const;

Description

private: inline virtual void ReservedW2() const;

Description

protected: MAnimWindowFunctions * iWindowFunctions;

Description

Pointer to a class containing functions implemented by the window server.

These are available to any CWindowAnim-derived class.

Note that this and the iGc pointer are automatically set for you by the animation framework - you do not need to assign a value to them.

protected: CAnimGc * iGc;

Description

Pointer to the graphics context.