sl@0: // Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Client side sprite code
sl@0: // 
sl@0: //
sl@0: 
sl@0: #include <e32std.h>
sl@0: #include "../SERVER/w32cmd.h"
sl@0: #include "CLIENT.H"
sl@0: 
sl@0: TCmdSpriteMember::TCmdSpriteMember(const TSpriteMember &aSpriteMember)
sl@0: 	{
sl@0: 	if (aSpriteMember.iBitmap)
sl@0: 		{
sl@0: 		iBitmap=aSpriteMember.iBitmap->Handle();
sl@0: 		iMaskBitmap=(aSpriteMember.iMaskBitmap) ? aSpriteMember.iMaskBitmap->Handle() : 0;
sl@0: 		iInvertMask=aSpriteMember.iInvertMask;
sl@0: 		iDrawMode=aSpriteMember.iDrawMode;
sl@0: 		iOffset=aSpriteMember.iOffset;
sl@0: 		}
sl@0: 	else
sl@0: 		Mem::FillZ(this,sizeof(*this));
sl@0: 	iInterval=aSpriteMember.iInterval;
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // RWsSpriteBase
sl@0: //
sl@0: 
sl@0: EXPORT_C RWsSpriteBase::RWsSpriteBase()
sl@0: /** Protected constructor. 
sl@0: 
sl@0: This prevents objects of this type being directly created. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RWsSpriteBase::RWsSpriteBase(RWsSession &aWs) : MWsClientClass(aWs.iBuffer)
sl@0: /** Protected constructor with a window server session. 
sl@0: 
sl@0: This prevents objects of this type being directly created.
sl@0: 
sl@0: @param aWs The window server session owning the sprite. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt RWsSpriteBase::UpdateMember(TInt aIndex, const TSpriteMember &aMemberData)
sl@0: /** Replaces one of a sprite's members. 
sl@0: 
sl@0: This allows the appearance of the sprite to be modified after it has been 
sl@0: activated. 
sl@0: 
sl@0: You must call this function if you have changed the size of a member. After 
sl@0: calling it, the sprite starts showing member zero again.
sl@0: 
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aIndex Index of the sprite member. Sprite members are indexed in the 
sl@0: order they were added to the sprite, beginning with 0. 
sl@0: @param aMemberData New data for the sprite member. 
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes. */
sl@0: 	{
sl@0: 	TWsSpriteCmdUpdateMember params(aIndex,aMemberData);
sl@0: 	return(WriteReply(&params,sizeof(params),EWsSpriteOpUpdateMember2));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RWsSpriteBase::UpdateMember(TInt aIndex)
sl@0: /** Updates the displayed sprite, taking into account any change to the content 
sl@0: of the bitmaps for the specified member.
sl@0: 
sl@0: The appearance of a sprite can be changed after it has been activated by drawing 
sl@0: to the appropriate TSpriteMember::iBitmap member, and then calling this function. 
sl@0: Alternatively, a new sprite member can be created, containing a new bitmap, 
sl@0: and the sprite can be updated to contain this new member by calling the other 
sl@0: UpdateMember() overload.
sl@0: 
sl@0: You should only use this function if you have changed the content of 
sl@0: the bitmap or mask. If you have changed the size of the bitmap then you must 
sl@0: use the other overload.
sl@0: 
sl@0: You only need to call this function if you want the content of the screen 
sl@0: to update immediately. If you don't call this function then the appearance 
sl@0: of a member will update automatically next time that member is drawn to the 
sl@0: screen.
sl@0: 
sl@0: @param aIndex Index of the sprite member. Sprite members are indexed in the 
sl@0: order they were added to the sprite, beginning with 0. */
sl@0: 	{
sl@0: 	WriteInt(aIndex, EWsSpriteOpUpdateMember);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RWsSpriteBase::Close()
sl@0: /** Destroys the sprite or pointer cursor in the window server, and frees client-side 
sl@0: resources used by the sprite. 
sl@0: 
sl@0: Any application which constructs an RWsSprite or RWsPointerCursor should call 
sl@0: this function when the sprite or cursor is no longer needed.
sl@0: 
sl@0: Note that this function does not free resources used by sprite members. */
sl@0: 	{
sl@0: 	if (iBuffer && iWsHandle)
sl@0: 		Write(EWsSpriteOpFree);
sl@0: 	iWsHandle=NULL;
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsSpriteBase::Activate()
sl@0: /** Activates the sprite or pointer cursor.
sl@0: 
sl@0: Sprites are displayed on the screen when they are activated; pointer cursors 
sl@0: are not displayed until they are set into a window using either RWindowTreeNode::SetCustomPointerCursor() 
sl@0: or RWindowTreeNode::SetPointerCursor(). 
sl@0: 
sl@0: This function should not be called until the sprite or pointer cursor has 
sl@0: been fully initialised, and its sprite members have been added.
sl@0: 
sl@0: Before it can call this function, a sprite must be fully constructed using 
sl@0: the RWsSprite::RWsSprite(RWsSession& aWs) and RWsSprite::Construct() functions, 
sl@0: and must have at least one sprite member. Otherwise, a panic will occur. Similarly, 
sl@0: a pointer cursor must have at least one sprite member and must call RWsPointerCursor::RWsPointerCursor(RWsSession& 
sl@0: aWs) and RWsPointerCursor::Construct().
sl@0:  
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes.
sl@0: @panic If no member is present, a panic will occur. */
sl@0: 	{
sl@0: 	return(WriteReply(EWsSpriteOpActivate));
sl@0: 	}
sl@0: 
sl@0: EXPORT_C TInt RWsSpriteBase::AppendMember(const TSpriteMember &aMemberData)
sl@0: /** Adds a sprite member to a sprite or pointer cursor. 
sl@0: 
sl@0: Sprite members are displayed by the sprite in the order in which they were 
sl@0: added to the sprite. This function can be called before and after the sprite 
sl@0: has been activated.
sl@0: 
sl@0: The position of the bitmap can be changed in relation to the sprite's origin 
sl@0: using the iOffset member of aSpriteList.
sl@0:  
sl@0: This function always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aMemberData The sprite member to add.
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes. */
sl@0: 	{
sl@0: 	TCmdSpriteMember params(aMemberData);
sl@0: 	return(WriteReply(&params,sizeof(params),EWsSpriteOpAppendMember));
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // RWsSprite
sl@0: //
sl@0: 
sl@0: EXPORT_C RWsSprite::RWsSprite() : RWsSpriteBase()
sl@0: /** Default C++ constructor. 
sl@0: 
sl@0: This allows classes that contain an RWsSprite to be constructed before an 
sl@0: RWsSession exists.
sl@0: 
sl@0: Note: do not use this version of the constructor on its own. Before an RWsSprite 
sl@0: object can be used it must be constructed using the RWsSprite(RWsSession) 
sl@0: constructor. An example of this might be as follows:
sl@0: 
sl@0: @code
sl@0: RWsSprite iSprite;
sl@0: iSprite=RWsSprite(iWsSession);
sl@0: @endcode */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RWsSprite::RWsSprite(RWsSession &aWs) : RWsSpriteBase(aWs)
sl@0: /** Constructs a sprite with a window server session. 
sl@0: 
sl@0: Initialisation must be completed using the Construct() function before the 
sl@0: sprite can be activated using RWsSpriteBase::Activate().
sl@0: 
sl@0: @param aWs The window server session owning the sprite. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt RWsSprite::Construct(RWindowTreeNode &aWindow, const TPoint &aPos, TInt aFlags)
sl@0: /** Completes the construction of a sprite. 
sl@0: 
sl@0: This function must be called before a sprite is activated using RWsSpriteBase::Activate().
sl@0:  
sl@0: It always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aWindow The window in which the sprite is displayed.
sl@0: @param aPos The position of the sprite's origin relative to aWindow's origin. 
sl@0: The origin is the top left corner of the window. 
sl@0: @param aFlags Any one of the TSpriteFlags values, or a combination of the flags, 
sl@0: using a bit-wise OR operation.
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes. 
sl@0: @panic TW32Panic 17 in debug builds if called on an already constructed object.
sl@0: @see TSpriteFlags */
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iWsHandle == KNullHandle, Panic(EW32PanicGraphicDoubleConstruction));
sl@0: 	TWsClCmdCreateSprite params(aWindow.WsHandle(),aPos,aFlags);
sl@0: 	TInt ret;
sl@0: 	if ((ret=iBuffer->WriteReplyWs(&params,sizeof(params),EWsClOpCreateSprite))>=0)
sl@0: 		{
sl@0: 		iWsHandle=ret;
sl@0: 		ret=KErrNone;
sl@0: 		}
sl@0: 	return(ret);
sl@0: 	}
sl@0: 
sl@0: EXPORT_C void RWsSprite::SetPosition(const TPoint &aPos)
sl@0: /** Sets the sprite's position. 
sl@0: 
sl@0: This function can be called before or after the sprite has been activated. 
sl@0: 
sl@0: Note: the sprite's initial position is set when the sprite is constructed (see Construct()).
sl@0: 
sl@0: @param aPos Position of the sprite's origin relative to the origin of the 
sl@0: window that owns it. The origin is the top left corner of the window. */
sl@0: 	{
sl@0: 	WritePoint(aPos,EWsSpriteOpSetPosition);
sl@0: 	}
sl@0: 
sl@0: //
sl@0: // RWsPointerCursor
sl@0: //
sl@0: 
sl@0: EXPORT_C RWsPointerCursor::RWsPointerCursor() : RWsSpriteBase()
sl@0: /** Default C++ constructor. 
sl@0: 
sl@0: Use this constructor to allow classes that contain an RWsPointerCursor 
sl@0: to be constructed before an RWsSession exists.
sl@0: 
sl@0: Note: do not use this version of the constructor on its own. 
sl@0: Before an RWsPointerCursor object can be used, it must be constructed 
sl@0: using the RWsPointerCursor(RWsSession) constructor. An example of this 
sl@0: might be as follows:
sl@0: 
sl@0: @code
sl@0: RWsPointerCursor pointerCursor;
sl@0: pointerCursor=RWsPointerCursor(iWsSession);
sl@0: @endcode */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C RWsPointerCursor::RWsPointerCursor(RWsSession &aWs) : RWsSpriteBase(aWs)
sl@0: /** Constructs a pointer cursor initialised with a window server session. 
sl@0: 
sl@0: Initialisation must be completed using the Construct() function before the 
sl@0: sprite can be activated using RWsSpriteBase::Activate().
sl@0: 
sl@0: Once initialisation is complete, the pointer cursor can be passed as an argument 
sl@0: to RWsSession::SetSystemPointerCursor() or RWindowTreeNode::SetCustomPointerCursor().
sl@0: 
sl@0: @param aWs The window server session owning the pointer cursor. */
sl@0: 	{}
sl@0: 
sl@0: EXPORT_C TInt RWsPointerCursor::Construct(TInt aFlags)
sl@0: /** Completes pointer cursor construction. 
sl@0: 
sl@0: This function must be called before the pointer cursor is activated.
sl@0:  
sl@0: It always causes a flush of the window server buffer.
sl@0: 
sl@0: @param aFlags ESpriteFlash to flash the sprite on and off or 0 for a non-flashing 
sl@0: cursor. Note that pointer cursors always behave as if ESpriteNoChildClip and 
sl@0: ESpriteNoShadows are set. 
sl@0: @return KErrNone if successful, otherwise one of the system-wide error codes. 
sl@0: @panic TW32Panic 17 in debug builds if called on an already constructed object.
sl@0: */
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(iWsHandle == KNullHandle, Panic(EW32PanicGraphicDoubleConstruction));
sl@0: 	TWsClCmdCreatePointerCursor params;
sl@0: 	params.flags=aFlags;
sl@0: 	TInt ret;
sl@0: 	if ((ret=iBuffer->WriteReplyWs(&params,sizeof(params),EWsClOpCreatePointerCursor))>=0)
sl@0: 		{
sl@0: 		iWsHandle=ret;
sl@0: 		ret=KErrNone;
sl@0: 		}
sl@0: 	return(ret);
sl@0: 	}