epoc32/include/uiklaf/private/lafappui.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 1997-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 __LAFAPPUI_H__
    17 #define __LAFAPPUI_H__
    18 
    19 #include <e32std.h>
    20 #include <lafmain.h>
    21 
    22 class CCoeEnv;
    23 struct TPointerEvent;
    24 
    25 
    26 class LafAppUi
    27 /** Application UI level LAF support. 
    28 
    29 @publishedPartner 
    30 @released */
    31 	{
    32 public:
    33 	/** Tests whether to attempt to fade all windows of an application when that application's 
    34 	window group moves into the background.
    35 	
    36 	@return True to fade, otherwise false */
    37 	IMPORT_C static TBool FadeWhenInBackground();
    38 	/** Adjusts a screen rectangle to allow room for any other applications that should 
    39 	always be visible.
    40 	
    41 	@param aRect Pass in the rectangle to adjust; on return, the adjusted rectangle */
    42 	IMPORT_C static void ReduceRect(TRect& aRect);
    43 	/** Tests if bubble help should be cancelled due to a specified pointer event.
    44 	
    45 	This is called when processing a window server event in the AppUi.
    46 	
    47 	@param aEvent Pointer event
    48 	@return True if bubble help should be cancelled */
    49 	IMPORT_C static TBool CancelBubbleHelpOnEvent(const TPointerEvent& aEvent);
    50 	/** Gets the screen area available to a specified client application.
    51 	
    52 	The screen area should exclude screen furniture such as menu bars and status 
    53 	panes.
    54 	
    55 	@param aEnv Application's control environment
    56 	@param aClientRectResolver Object that works out how screen furniture reduces 
    57 	the available screen area 
    58 	@return Available screen area */
    59 	IMPORT_C static TRect ClientRect(const CCoeEnv& aEnv,const MLafClientRectResolver& aClientRectResolver);
    60 	};
    61 
    62 #endif //__LAFAPPUI_H__