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