epoc32/include/uiklaf/private/lafsrv.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/uiklaf/private/lafsrv.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,65 @@
     1.4 +// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __LAFSRV_H__
    1.20 +#define __LAFSRV_H__
    1.21 +
    1.22 +#include <w32std.h>
    1.23 +#include <coemain.h>
    1.24 +
    1.25 +
    1.26 +class LafServAppUiBase
    1.27 +/** Eikon server LAF support.
    1.28 +
    1.29 +@publishedPartner 
    1.30 +@released */
    1.31 +	{
    1.32 +public:
    1.33 +	/** Gets the number of pointer cursors supplied by the LAF.
    1.34 +	
    1.35 +	This can be zero for some devices.
    1.36 +	
    1.37 +	@return Number of pointer cursors */
    1.38 +	IMPORT_C static TInt NumberOfCursorsInSystemCursorList();
    1.39 +	/** Claims the pointer cursor list, enabling the Eikon server to change the system 
    1.40 +	pointer cursor.
    1.41 +	
    1.42 +	If this device has a global pointer cursor list, the function should claim 
    1.43 +	it by calling RWsSession::ClaimSystemPointerCursorList(); otherwise, it should 
    1.44 +	do nothing.
    1.45 +	
    1.46 +	@param aEnv Thread's control environment
    1.47 +	@return System wide error code */
    1.48 +	IMPORT_C static TInt ClaimPointerCursorListIfNeeded(CCoeEnv& aEnv);
    1.49 +	/** Releases the system pointer cursor list.
    1.50 +	
    1.51 +	If this device has a global pointer cursor list, the function should claim 
    1.52 +	it by calling RWsSession::FreeSystemPointerCursorList(); otherwise, it should 
    1.53 +	do nothing.
    1.54 +	
    1.55 +	@param aEnv Thread's control environment */
    1.56 +	IMPORT_C static void FreePointerCursorListIfNeeded(CCoeEnv& aEnv);
    1.57 +	/** Constructs a specified pointer cursor.
    1.58 +	
    1.59 +	The function should return NULL for devices with no system pointer cursors.
    1.60 +	
    1.61 +	@param aCursorNumber Index of the cursor to construct
    1.62 +	@param aSpriteMember On return, the sprite member added to the pointer cursor
    1.63 +	@param aEnv Thread's control environment
    1.64 +	@return Fully constructed pointer cursor */
    1.65 +	IMPORT_C static RWsPointerCursor* ConstructPointerCursorL(TInt aCursorNumber, TSpriteMember& aSpriteMember, CCoeEnv& aEnv);
    1.66 +	};
    1.67 +
    1.68 +#endif // __LAFSRV_H__