epoc32/include/mw/animationgroup.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/animationgroup.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations

// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __AnimationGroup_H__
#define __AnimationGroup_H__

#include <animation.h>

class CAnimationTls;

/**
Handles groups of other animations.

When it is appropriate to have several animations starting and stopping
together, add them all to an animation group and control them through that.

In addition to making the code easier to both read and write, the animation
group handles synchronisation issues which can occur when issuing a sequence
of asynchronous requests.

Care must be taken to remove an animation from any groups it may have been
added to before deleting it.

@publishedAll
@released
*/
class CAnimationGroup : public CAnimation
	{
public:
	static CAnimationGroup* NewL();
	~CAnimationGroup();
	IMPORT_C const RPointerArray<CAnimation>& Animations() const;
	IMPORT_C RPointerArray<CAnimation>& Animations();
	// From CAnimation
	virtual void Start(const TAnimationConfig& aConfig);
	virtual void Stop();
	virtual void Pause();
	virtual void Resume();
	virtual void Hold();
	virtual void Unhold();
	virtual void Freeze();
	virtual void Unfreeze();
	virtual void SetPosition(const TPoint& aPoint);
protected:
	IMPORT_C virtual void CAnimationGroup_Reserved1();
	IMPORT_C virtual void CAnimationGroup_Reserved2();
private:
	TInt iCAnimationGroup_Reserved;
private:
	CAnimationGroup();
	void ConstructL();
	CAnimationGroup(const CAnimationGroup&); // no implementation
	CAnimationGroup& operator=(const CAnimationGroup&);		 // no implementation
private:
	TInt iFreezeCount;
	CAnimationTls* iTls;
	RPointerArray<CAnimation> iAnimations;
	};

#endif //__AnimationGroup_H__