Class MAnimWindowFunctions

class MAnimWindowFunctions;

Description

Window utility functions interface.

The member functions define the interface for querying and manipulating the window in which the animation takes place.

You do not have to create an object of this type. The class is implemented by the window server, and provides these utility functions to all CWindowAnim and CFreeTimerWindowAnim derived classes via the iWindowFunctions pointer.

It is not intended for user derivation.

Members

Defined in MAnimWindowFunctions:
ActivateGc(), Invalidate(), IsHidden(), Parameters(), Reserved(), Reserved1(), Reserved2(), Reserved3(), SetRect(), SetVisible(), VisibleRegion(), WindowSize()

virtual void ActivateGc()=0;

Description

Activates the graphics context.

This function should be called to enable drawing in the CAnim-derived classes' Command(), CommandReplyL(), Animate(), or FocusChanged() functions.

Note: this function is called automatically by the animation DLL framework in the Redraw() function.

virtual void SetRect(const TRect &aRect)=0;

Description

Sets the rectangle that this animation is to draw to.

This function must be called as part of the initialisation/construction of the CAnim-derived object, i.e. in CAnim::ConstructL(). This is so that the window server knows which area the animation is operating in.

Parameters

const TRect &aRect The rectangle to be drawn to.

virtual TSize WindowSize() const=0;

Description

Gets the window size.

Return value

TSize The window size, in pixels.

virtual TBool IsHidden()=0;

Description

Tests whether to draw the animation.

If the window is completely hidden, there is normally no need to draw the animation. However in some conditions the animation should be drawn even if it is obscured. The window server is aware of these cases, and returns ETrue if it is not safe to draw the animation.

Return value

TBool True if the window is completely hidden and there is no requirement to continue drawing the animation, otherwise false.

virtual void SetVisible(TBool aState)=0;

Description

Sets the visibility of the window the animation is drawing to.

This does the same as RWindowBase::SetVisible().

Parameters

TBool aState True for visible, false otherwise.

virtual void Invalidate(const TRect &aRect)=0;

Description

Forces a redraw of a rectangular part of the window.

The function causes a redraw message on the part of the window specified, which provides a non-immediate way to do drawing.

It can be used to redraw the whole of the window, not just the part used by the animation.

Parameters

const TRect &aRect The rectangle to be redrawn. These co-ordinates are relative to the origin of the window.

virtual void Parameters(TWindowInfo &aData)=0;

Description

Gets window information.

Parameters

TWindowInfo &aData The window information.

virtual void VisibleRegion(TRegion &aRegion)=0;

Description

Gets the visible region.

This region is the area of the visible window which is currently unshadowed. If there is not enough memory to calculate this region then aRegion's error flag is set.

Parameters

TRegion &aRegion The visible region.

private: virtual void Reserved() const;

Description

private: virtual void Reserved1() const;

Description

private: virtual void Reserved2() const;

Description

private: virtual void Reserved3() const;

Description