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

// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __LAFAPPUI_H__
#define __LAFAPPUI_H__

#include <e32std.h>
#include <lafmain.h>

class CCoeEnv;
struct TPointerEvent;


class LafAppUi
/** Application UI level LAF support. 

@publishedPartner 
@released */
	{
public:
	/** Tests whether to attempt to fade all windows of an application when that application's 
	window group moves into the background.
	
	@return True to fade, otherwise false */
	IMPORT_C static TBool FadeWhenInBackground();
	/** Adjusts a screen rectangle to allow room for any other applications that should 
	always be visible.
	
	@param aRect Pass in the rectangle to adjust; on return, the adjusted rectangle */
	IMPORT_C static void ReduceRect(TRect& aRect);
	/** Tests if bubble help should be cancelled due to a specified pointer event.
	
	This is called when processing a window server event in the AppUi.
	
	@param aEvent Pointer event
	@return True if bubble help should be cancelled */
	IMPORT_C static TBool CancelBubbleHelpOnEvent(const TPointerEvent& aEvent);
	/** Gets the screen area available to a specified client application.
	
	The screen area should exclude screen furniture such as menu bars and status 
	panes.
	
	@param aEnv Application's control environment
	@param aClientRectResolver Object that works out how screen furniture reduces 
	the available screen area 
	@return Available screen area */
	IMPORT_C static TRect ClientRect(const CCoeEnv& aEnv,const MLafClientRectResolver& aClientRectResolver);
	};

#endif //__LAFAPPUI_H__