Class MAnimWindowFunctions

MAnimWindowFunctions

Support

Supported from 5.1

Description

Window utility functions interface. The classes’ 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.

Note:

• The classes’ functions are declared as pure virtual in the header file. However, as stated above, you do not need to derive from this class, so these have not been marked as pure virtual in this document.

Defined in MAnimWindowFunctions:
Invalidate(), IsHidden(), Parameters(), SetRect(), SetVisible(), VisibleRegion(), WindowSize(), void ActivateGc()

void ActivateGc();

Description

Activate graphics context. This function should be called to enable drawing in the CAnim derived classes’ Command(), CommandReplyL(), Animate(), or FocusChanged() functions.

Note:

• The function is called automatically by the animation DLL framework in the Redraw() function.

void Invalidate(const TRect& aRect);

Description

Forces 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 re-drawn. These co-ordinates are relative to the origin of the window.

TBool IsHidden();

Description

Tests whether to draw the animation.

If the window is completely hidden/obscured 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 safe to NOT 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.

void SetRect(const TRect& aRect);

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.

void SetVisible(TBool aState);

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.

TSize WindowSize() const;

Description

Gets the window size.

Return value

TSize The window size, in pixels.

void Parameters(TWindowInfo &aData);

Support

Supported from 6.0

Description

Gets window information.

Parameters

TWindowInfo &aData The window information.

void VisibleRegion(TRegion& aRegion);

Support

Supported from 6.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 on return.

Parameters

TRegion& aRegion The visible region.