Symbian^3 Application Developer Library >

MAnimWindowFunctions Class Reference

class MAnimWindowFunctions

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.

Public Member Functions
void ActivateGc ()
void Invalidate (const TRect &)
TBool IsHidden ()
void Parameters ( TWindowInfo &)
void SetRect (const TRect &)
void SetVisible ( TBool )
void VisibleRegion ( TRegion &)
TSize WindowSize ()
Private Member Functions
void Reserved ()
void Reserved1 ()
void Reserved2 ()
void Reserved3 ()

Member Functions Documentation

ActivateGc()

void ActivateGc ( ) [pure virtual]

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.

Invalidate(const TRect &)

void Invalidate ( const TRect & aRect ) [pure virtual]

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.

IsHidden()

TBool IsHidden ( ) [pure virtual]

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.

Parameters(TWindowInfo &)

void Parameters ( TWindowInfo & aData ) [pure virtual]

Gets window information.

Parameters

TWindowInfo & aData The window information.

Reserved()

void Reserved ( ) const [private, virtual]

Reserved1()

void Reserved1 ( ) const [private, virtual]

Reserved2()

void Reserved2 ( ) const [private, virtual]

Reserved3()

void Reserved3 ( ) const [private, virtual]

SetRect(const TRect &)

void SetRect ( const TRect & aRect ) [pure virtual]

Sets the rectangle that this animation will 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. Anything that is drawn by the animation outside this rectangle may not be redrawn correctly as the window server uses this rectangle to decide when the animation should be redrawn.

Parameters

const TRect & aRect The rectangle to be drawn to.

SetVisible(TBool)

void SetVisible ( TBool aState ) [pure virtual]

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.

VisibleRegion(TRegion &)

void VisibleRegion ( TRegion & aRegion ) [pure virtual]

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.

WindowSize()

TSize WindowSize ( ) const [pure virtual]

Gets the window size.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.