commonuisupport/uilaf/inc/lafsrv.h
author Pat Downey <patd@symbian.org>
Tue, 13 Jul 2010 11:36:42 +0100
branchRCL_3
changeset 43 07b3ec0df257
parent 0 2f259fa3e83a
permissions -rw-r--r--
Merge workaround for bug 2846 to conditionally compile out the use of CAlfEffectObserver.

// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// under the terms of "Eclipse Public License v1.0"
// which accompanies this distribution, and is available
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __LAFSRV_H__
#define __LAFSRV_H__

#include <w32std.h>
#include <coemain.h>


class LafServAppUiBase
/** Eikon server LAF support.

@publishedPartner 
@released */
	{
public:
	/** Gets the number of pointer cursors supplied by the LAF.
	
	This can be zero for some devices.
	
	@return Number of pointer cursors */
	IMPORT_C static TInt NumberOfCursorsInSystemCursorList();
	/** Claims the pointer cursor list, enabling the Eikon server to change the system 
	pointer cursor.
	
	If this device has a global pointer cursor list, the function should claim 
	it by calling RWsSession::ClaimSystemPointerCursorList(); otherwise, it should 
	do nothing.
	
	@param aEnv Thread's control environment
	@return System wide error code */
	IMPORT_C static TInt ClaimPointerCursorListIfNeeded(CCoeEnv& aEnv);
	/** Releases the system pointer cursor list.
	
	If this device has a global pointer cursor list, the function should claim 
	it by calling RWsSession::FreeSystemPointerCursorList(); otherwise, it should 
	do nothing.
	
	@param aEnv Thread's control environment */
	IMPORT_C static void FreePointerCursorListIfNeeded(CCoeEnv& aEnv);
	/** Constructs a specified pointer cursor.
	
	The function should return NULL for devices with no system pointer cursors.
	
	@param aCursorNumber Index of the cursor to construct
	@param aSpriteMember On return, the sprite member added to the pointer cursor
	@param aEnv Thread's control environment
	@return Fully constructed pointer cursor */
	IMPORT_C static RWsPointerCursor* ConstructPointerCursorL(TInt aCursorNumber, TSpriteMember& aSpriteMember, CCoeEnv& aEnv);
	};

#endif // __LAFSRV_H__