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