windowing/windowserver/inc/Graphics/displaycontrol.h
changeset 0 5d03bc08d59c
equal deleted inserted replaced
-1:000000000000 0:5d03bc08d59c
       
     1 // Copyright (c) 2008-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 "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef DISPCTRL_CLIENT_H_
       
    17 #define DISPCTRL_CLIENT_H_
       
    18 
       
    19 #include <graphics/displaycontrolbase.h>
       
    20 
       
    21 /**
       
    22  * Window Server client interface for display control.
       
    23  * 
       
    24  * All functions in MDisplayControlBase will automatically flush the client-server
       
    25  * session buffer as part of their behavior.
       
    26  * 
       
    27  * Setting the display configuration successfully shall cause the screen mode
       
    28  * index to change to one of the last two entries (dependent on rotation) and that
       
    29  * mode's size information shall be updated as necessary.
       
    30  * 
       
    31  * @publishedPartner
       
    32  * @prototype
       
    33  */
       
    34 class MDisplayControl : public MDisplayControlBase
       
    35 	{
       
    36 public:
       
    37 	enum	
       
    38 		{
       
    39 		KUidDisplayControl =  0x10286499, 	  //To    0x1028649A
       
    40 		ETypeId=	 KUidDisplayControl 
       
    41 		};
       
    42 public:
       
    43 	/** 
       
    44 	 * Returns whether changes in the display will trigger an EEventDisplayChanged 
       
    45 	 * event to be issued.
       
    46 	 *
       
    47 	 * Events will be triggered configuration changes that have taken place on 
       
    48 	 * the display, when a display has been connected / disconnected (if it can be 
       
    49 	 * detected), and when the available resolutions change.
       
    50 	 *
       
    51 	 * This function always causes a flush of the window server buffer.
       
    52 	 *	
       
    53 	 * @return ETrue if display change events are enabled, EFalse otherwise
       
    54 	 */
       
    55 	virtual TBool DisplayChangeEventsEnabled() const =0;
       
    56 	/** 
       
    57 	 * Determines whether changes in the display will trigger an EEventDisplayChanged 
       
    58 	 * event to be issued.
       
    59 	 * 
       
    60 	 * @see DisplayChangeEventsEnabled
       
    61 	 * 
       
    62 	 * @param aEnable ETrue to enable display change events, EFalse to disable them
       
    63 	 */	
       
    64 	virtual void EnableDisplayChangeEvents(TBool aEnable) =0;
       
    65 	};
       
    66 
       
    67 
       
    68 #endif /*DISPCTRL_CLIENT_H_*/