epoc32/include/uiklaf/private/lafsrv.h
branchSymbian2
changeset 2 2fe1408b6811
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
       
     1 // Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // 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
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __LAFSRV_H__
       
    17 #define __LAFSRV_H__
       
    18 
       
    19 #include <w32std.h>
       
    20 #include <coemain.h>
       
    21 
       
    22 
       
    23 class LafServAppUiBase
       
    24 /** Eikon server LAF support.
       
    25 
       
    26 @publishedPartner 
       
    27 @released */
       
    28 	{
       
    29 public:
       
    30 	/** Gets the number of pointer cursors supplied by the LAF.
       
    31 	
       
    32 	This can be zero for some devices.
       
    33 	
       
    34 	@return Number of pointer cursors */
       
    35 	IMPORT_C static TInt NumberOfCursorsInSystemCursorList();
       
    36 	/** Claims the pointer cursor list, enabling the Eikon server to change the system 
       
    37 	pointer cursor.
       
    38 	
       
    39 	If this device has a global pointer cursor list, the function should claim 
       
    40 	it by calling RWsSession::ClaimSystemPointerCursorList(); otherwise, it should 
       
    41 	do nothing.
       
    42 	
       
    43 	@param aEnv Thread's control environment
       
    44 	@return System wide error code */
       
    45 	IMPORT_C static TInt ClaimPointerCursorListIfNeeded(CCoeEnv& aEnv);
       
    46 	/** Releases the system pointer cursor list.
       
    47 	
       
    48 	If this device has a global pointer cursor list, the function should claim 
       
    49 	it by calling RWsSession::FreeSystemPointerCursorList(); otherwise, it should 
       
    50 	do nothing.
       
    51 	
       
    52 	@param aEnv Thread's control environment */
       
    53 	IMPORT_C static void FreePointerCursorListIfNeeded(CCoeEnv& aEnv);
       
    54 	/** Constructs a specified pointer cursor.
       
    55 	
       
    56 	The function should return NULL for devices with no system pointer cursors.
       
    57 	
       
    58 	@param aCursorNumber Index of the cursor to construct
       
    59 	@param aSpriteMember On return, the sprite member added to the pointer cursor
       
    60 	@param aEnv Thread's control environment
       
    61 	@return Fully constructed pointer cursor */
       
    62 	IMPORT_C static RWsPointerCursor* ConstructPointerCursorL(TInt aCursorNumber, TSpriteMember& aSpriteMember, CCoeEnv& aEnv);
       
    63 	};
       
    64 
       
    65 #endif // __LAFSRV_H__