Symaptic: os/graphics/windowing/windowserver/inc/W32STD.H@260cb5ec6c19 (annotated)

sl@0	1	// Copyright (c) 1994-2010 Nokia Corporation and/or its subsidiary(-ies).
sl@0	2	// All rights reserved.
sl@0	3	// This component and the accompanying materials are made available
sl@0	4	// under the terms of "Eclipse Public License v1.0"
sl@0	5	// which accompanies this distribution, and is available
sl@0	6	// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0	7	//
sl@0	8	// Initial Contributors:
sl@0	9	// Nokia Corporation - initial contribution.
sl@0	10	//
sl@0	11	// Contributors:
sl@0	12	//
sl@0	13	// Description:
sl@0	14	// Standard window server header file
sl@0	15	//
sl@0	16	//
sl@0	17
sl@0	18	#ifndef __W32STD_H__
sl@0	19	#define __W32STD_H__
sl@0	20
sl@0	21	#ifndef __FNTSTORE_H__
sl@0	22	#include <fntstore.h>
sl@0	23	#endif
sl@0	24	#ifndef __BITDEV_H__
sl@0	25	#include <bitdev.h>
sl@0	26	#endif
sl@0	27	#ifndef __BITSTD_H__
sl@0	28	#include <bitstd.h>
sl@0	29	#endif
sl@0	30	#include <e32keys.h>
sl@0	31	#include <textcursor.h>
sl@0	32	#include <pointerevent.h>
sl@0	33	#include <advancedpointerevent.h>
sl@0	34	#include <sizemode.h>
sl@0	35	#include <babitflags.h>
sl@0	36	#include <wspublishandsubscribedata.h>
sl@0	37
sl@0	38	#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0	39	#include <graphics/windowserverconstants.h>
sl@0	40	#include <graphics/pointereventdata.h>
sl@0	41	#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
sl@0	42
sl@0	43	_LIT(KWSERVThreadName,"Wserv");
sl@0	44
sl@0	45	class RWindowBase;
sl@0	46	class RWindow;
sl@0	47	class RWsBuffer;
sl@0	48	class MWsObjectProvider;
sl@0	49	class RWsDrawableSource;
sl@0	50	class TSizeMode;
sl@0	51
sl@0	52	/** Screen mode enforcement flags.
sl@0	53
sl@0	54	Screen mode enforcement ensures that windows must meet certain requirements
sl@0	55	if they are to be displayed. When the screen mode changes, window groups that
sl@0	56	are incorrectly set up, according to these requirements, are locked out. The
sl@0	57	windows are notified of the change, and will be displayed if they are updated
sl@0	58	(according to the current enforcement requirement) to match the new screen
sl@0	59	mode.
sl@0	60
sl@0	61	@publishedAll
sl@0	62	@released
sl@0	63	@see CWsScreenDevice::ScreenModeEnforcement()
sl@0	64	@see CWsScreenDevice::SetScreenModeEnforcement() */
sl@0	65	enum TScreenModeEnforcement
sl@0	66	{
sl@0	67	/** No enforcement.
sl@0	68
sl@0	69	All windows that are the children of window groups will be displayed, irrespective
sl@0	70	of the screen mode.
sl@0	71
sl@0	72	This is not properly supported and is provided for testing purposes. */
sl@0	73	ESizeEnforcementNone,
sl@0	74	/** Pixels and rotation enforcement.
sl@0	75
sl@0	76	Group windows must be set up for the correct rotation and be working in the
sl@0	77	correct size in pixels to be displayed. */
sl@0	78	ESizeEnforcementPixelsAndRotation,
sl@0	79	/** Pixels and Twips enforcement.
sl@0	80
sl@0	81	Group windows must have the correct rotation and be working in the correct
sl@0	82	size in pixels and twips to be displayed.
sl@0	83
sl@0	84	This setting might be used if the display pixels are not square, and would
sl@0	85	distort fonts when rotated. */
sl@0	86	ESizeEnforcementPixelsTwipsAndRotation,
sl@0	87	};
sl@0	88
sl@0	89	struct TPixelsAndRotation
sl@0	90	/** Pixels and rotation struct.
sl@0	91
sl@0	92	This is used to define a particular screen mode's screen size in pixels,
sl@0	93	and its rotation.
sl@0	94
sl@0	95	@publishedAll
sl@0	96	@released
sl@0	97	@see CWsScreenDevice::GetScreenModeSizeAndRotation() */
sl@0	98	{
sl@0	99	/** The screen size, for a given screen mode, in pixels. */
sl@0	100	TSize iPixelSize;
sl@0	101	/** The current screen orientation. */
sl@0	102	CFbsBitGc::TGraphicsOrientation iRotation;
sl@0	103	};
sl@0	104
sl@0	105	struct TPixelsTwipsAndRotation
sl@0	106	/** Pixels, twips and rotation struct.
sl@0	107
sl@0	108	This is used to define a particular screen mode's screen size in twips
sl@0	109	and pixels, and its rotation.
sl@0	110
sl@0	111	@publishedAll
sl@0	112	@released
sl@0	113	@see CWsScreenDevice::GetScreenModeSizeAndRotation() */
sl@0	114	{
sl@0	115	/** The screen size, for a given screen mode, in pixels. */
sl@0	116	TSize iPixelSize;
sl@0	117	/** The screen size, for a given screen mode, in twips. */
sl@0	118	TSize iTwipsSize;
sl@0	119	/** The screen rotation. */
sl@0	120	CFbsBitGc::TGraphicsOrientation iRotation;
sl@0	121	};
sl@0	122
sl@0	123	/** Log message text length.
sl@0	124
sl@0	125	This defines the length of the log text message buffer TLogMessageText,
sl@0	126	which is used in RWsSession::LogMessage().
sl@0	127
sl@0	128	@publishedAll
sl@0	129	@released */
sl@0	130	enum {
sl@0	131	/** The length of the log message text buffer in characters. */
sl@0	132	KLogMessageLength=0x80
sl@0	133	};
sl@0	134
sl@0	135	/** Log message text buffer.
sl@0	136
sl@0	137	This is used in RWsSession::LogMessage().
sl@0	138
sl@0	139	@publishedAll
sl@0	140	@released */
sl@0	141	typedef TBuf<KLogMessageLength> TLogMessageText;
sl@0	142
sl@0	143	/** Password window group priority.
sl@0	144
sl@0	145	This priority is assigned to the password window group when the window server is displaying the password window.
sl@0	146	This is the highest priority, which ensures that the machine password window is in front of all other windows -
sl@0	147	hence password tests cannot be bypassed.
sl@0	148
sl@0	149	@publishedAll
sl@0	150	@deprecated */
sl@0	151	enum
sl@0	152	{
sl@0	153	/** Password window group priority. */
sl@0	154	KPasswordWindowGroupPriority=1000
sl@0	155	};
sl@0	156
sl@0	157	/** Switch ordinal position to owning window.
sl@0	158
sl@0	159	This enum can be specified as the 2nd parameter to RWsSession::SetWindowGroupOrdinalPosition()
sl@0	160	or as the 1st parameter to RWindowTreeNode::SetOrdinalPosition() (if this is being called on an
sl@0	161	RWindowGroup).
sl@0	162
sl@0	163	When called with this value, the functions don't change the ordinal position of the group window
sl@0	164	in question, but rather bring to the front the window that would come to the front if that group
sl@0	165	window were to die with keyboard focus.
sl@0	166
sl@0	167	@publishedAll
sl@0	168	@released
sl@0	169	@see RWsSession::SetWindowGroupOrdinalPosition()
sl@0	170	@see RWindowTreeNode::SetOrdinalPosition() */
sl@0	171	enum {
sl@0	172	/** Switch ordinal position to owning window. */
sl@0	173	KOrdinalPositionSwitchToOwningWindow=0x80000000
sl@0	174	};
sl@0	175
sl@0	176	/** Window corner types.
sl@0	177
sl@0	178	Corners may be specified square or stepped, with varying numbers of pixels
sl@0	179	removed to make the stepping. Picturing a corner as the top left corner of
sl@0	180	a window, the numbers denote the number of pixels removed from the top row
sl@0	181	to give corners.
sl@0	182
sl@0	183	@publishedAll
sl@0	184	@released
sl@0	185	@see TCornerFlags
sl@0	186	@see RWindowBase::SetCornerType() */
sl@0	187	enum TCornerType
sl@0	188	// Bottom 16 bits available for corner type
sl@0	189	{
sl@0	190	/** Square corner. */
sl@0	191	EWindowCornerSquare,
sl@0	192	/** Corner pixel removed. */
sl@0	193	EWindowCorner1,
sl@0	194	/** Two pixel step.
sl@0	195
sl@0	196	3 pixels are removed: the corner pixel and a single pixel from each side. */
sl@0	197	EWindowCorner2,
sl@0	198	/** Three pixel step.
sl@0	199
sl@0	200	5 pixels are removed: the corner pixel, the two pixels next to it and the
sl@0	201	2 pixels above or below it. */
sl@0	202	EWindowCorner3,
sl@0	203	/** Five pixel step.
sl@0	204
sl@0	205	12 pixels are removed: the corner pixel, the four pixels next to it, the
sl@0	206	four pixels above or below it, the pixel which was diagonal to the corner
sl@0	207	pixel, and the pixels to both sides of that pixel. */
sl@0	208	EWindowCorner5,
sl@0	209	EWindowCornerRegion, // Private
sl@0	210	/** Corner type mask.
sl@0	211
sl@0	212	This value is used by the window server, and may be used by developers, to
sl@0	213	separate TCornerType and TCornerFlags values from a TInt which contains both
sl@0	214	types. */
sl@0	215	ECornerTypeMask=0xFFFF
sl@0	216	};
sl@0	217
sl@0	218	/** Corner flags.
sl@0	219
sl@0	220	These are used by RWindowBase::SetCornerType() to set which corners of a window
sl@0	221	are not to have corner types applied to them.
sl@0	222
sl@0	223	@publishedAll
sl@0	224	@released
sl@0	225	@see TCornerType */
sl@0	226	enum TCornerFlags
sl@0	227	// Top 16 bits available for corner flags
sl@0	228	{
sl@0	229	/** Do not apply corner shape to top left corner. */
sl@0	230	EWindowCornerNotTL=0x10000,
sl@0	231	/** Do not apply corner shape to top right corner. */
sl@0	232	EWindowCornerNotTR=0x20000,
sl@0	233	/** Do not apply corner shape to bottom left corner. */
sl@0	234	EWindowCornerNotBL=0x40000,
sl@0	235	/** Do not apply corner shape to bottom right corner. */
sl@0	236	EWindowCornerNotBR=0x80000,
sl@0	237	};
sl@0	238
sl@0	239	/** Window backup type flags.
sl@0	240
sl@0	241	@publishedAll
sl@0	242	@released
sl@0	243	@see RWindowBase::EnableBackup() */
sl@0	244	enum TWindowBackupType
sl@0	245	{
sl@0	246	/** Backup the area behind the current window only.
sl@0	247
sl@0	248	This is the default behaviour for the RWindowBase::EnableBackup() function. */
sl@0	249	EWindowBackupAreaBehind=0x0001,
sl@0	250	/** Backup the entire screen.
sl@0	251
sl@0	252	This is provided for windows that require the rest
sl@0	253	of the screen to fade when they are displayed. When the rest of the screen
sl@0	254	should become unfaded, the window server redraws the whole screen from the
sl@0	255	backed up bitmap. */
sl@0	256	EWindowBackupFullScreen=0x0002,
sl@0	257	};
sl@0	258
sl@0	259	/** Types of standard events.
sl@0	260
sl@0	261	These are events that the window server passes to its clients, as opposed
sl@0	262	to events that the base passes to the window server.
sl@0	263
sl@0	264	@publishedAll
sl@0	265	@released
sl@0	266	@see CClickMaker */
sl@0	267	enum TEventCode
sl@0	268	{
sl@0	269	/** Null event.
sl@0	270
sl@0	271	This can be sent, but should be ignored by clients. */
sl@0	272	EEventNull,
sl@0	273	/** Key event.
sl@0	274
sl@0	275	This is the event that is sent when a character has been received from the
sl@0	276	keyboard.
sl@0	277
sl@0	278	If an EEventKey event is associated with an EEventKeyDown or EEventKeyUp
sl@0	279	event (typically EEventKeyDown), the EEventKey event occurs after the
sl@0	280	EEventKeyDown/EEventKeyUp event.
sl@0	281
sl@0	282	In practice, the only keys potentially likely to have their EEventKey event
sl@0	283	generated on the up rather than the down are modifier keys. */
sl@0	284	EEventKey,
sl@0	285	/** Key up event.
sl@0	286
sl@0	287	If an EEventKey event is associated with an EEventKeyUp event (which is
sl@0	288	rarely the case), the EEventKey event occurs after the EEventKeyUp event. */
sl@0	289	EEventKeyUp,
sl@0	290	/** Key down event.
sl@0	291
sl@0	292	If an EEventKey event is associated with an EEventKeyDown event (which
sl@0	293	is typically the case), the EEventKey event occurs after the EEventKeyDown event. */
sl@0	294	EEventKeyDown,
sl@0	295	/** Modifier changed event.
sl@0	296
sl@0	297	This is an event generated by the window server when
sl@0	298	the state of one of the modifier keys changes.
sl@0	299	It is not reported unless explicitly requested by a window.
sl@0	300
sl@0	301	@see RWindowTreeNode::EnableModifierChangedEvents(). */
sl@0	302	EEventModifiersChanged,
sl@0	303	/** Pointer event.
sl@0	304
sl@0	305	This event is sent when the user presses or releases a pointer button (or
sl@0	306	the equivalent action, depending on the type of pointing device), drags the
sl@0	307	pointer, moves it or uses the pointer to switch on the device. */
sl@0	308	EEventPointer, //5
sl@0	309	/** Pointer enter event.
sl@0	310
sl@0	311	This occurs when the user moves the pointer into a window with a pointer button
sl@0	312	pressed (or equivalent action depending on the type of pointing device). If
sl@0	313	move events are being generated, this event also occurs when the user moves
sl@0	314	the pointer into the window. */
sl@0	315	EEventPointerEnter,
sl@0	316	/** Pointer exit event.
sl@0	317
sl@0	318	Occurs when the user moves the pointer out of a window with a pointer button
sl@0	319	pressed (or equivalent action depending on the type of pointing device). If
sl@0	320	move events are being generated, this event also occurs when the user moves
sl@0	321	the pointer out of the window. */
sl@0	322	EEventPointerExit,
sl@0	323	/** Pointer move buffer ready event.
sl@0	324
sl@0	325	Occurs when the pointer move buffer is ready to be retrieved by the client. */
sl@0	326	EEventPointerBufferReady,
sl@0	327	/** Occurs as a duplicate of each pointer event if a window sets pointer capture
sl@0	328	with the TCaptureFlagDragDrop flag set. */
sl@0	329	EEventDragDrop,
sl@0	330	/** Focus lost event.
sl@0	331
sl@0	332	Occurs when a window group loses keyboard focus. */
sl@0	333	EEventFocusLost, //10
sl@0	334	/** Focus gained event.
sl@0	335
sl@0	336	Occurs when a window group gains keyboard focus. */
sl@0	337	EEventFocusGained,
sl@0	338	/** On event.
sl@0	339
sl@0	340	This event type is not reported unless explicitly requested by a window.
sl@0	341
sl@0	342	@see RWindowTreeNode::EnableOnEvents(). */
sl@0	343	EEventSwitchOn,
sl@0	344	/** Password event.
sl@0	345
sl@0	346	Occurs when the window server enters password mode. It is sent to the group
sl@0	347	window of the currently active password window.
sl@0	348
sl@0	349	This is the window server mode where the user is required to enter a password
sl@0	350	before any further actions can be performed.
sl@0	351
sl@0	352	@deprecated */
sl@0	353	EEventPassword,
sl@0	354	/** Window group changed event. This occurs whenever a window group is destroyed,
sl@0	355	and whenever a window group's name changes
sl@0	356
sl@0	357	This event type is not reported unless explicitly requested by a window.
sl@0	358
sl@0	359	@see RWindowTreeNode::EnableGroupChangeEvents(). */
sl@0	360	EEventWindowGroupsChanged,
sl@0	361	/** Error event.
sl@0	362
sl@0	363	Occurs when an error occurs. See TWsErrorMessage::TErrorCategory for the types
sl@0	364	of errors.
sl@0	365
sl@0	366	This event type is not reported unless explicitly requested by a window.
sl@0	367
sl@0	368	@see RWindowTreeNode::EnableErrorMessages(). */
sl@0	369	EEventErrorMessage, //15
sl@0	370	/** Message ready event.
sl@0	371
sl@0	372	Occurs when a session sends a message to this window group using RWsSession::SendMessageToWindowGroup(). */
sl@0	373	EEventMessageReady,
sl@0	374	EEventMarkInvalid, // For internal use only
sl@0	375	/** Off event.
sl@0	376
sl@0	377	This is issued when an off event is received by the window server from the
sl@0	378	base.
sl@0	379
sl@0	380	If for some reason the event can't be delivered, or there is no-one to deliver
sl@0	381	it to, then a call to the base is made to power down the processor.
sl@0	382
sl@0	383	This event is only delivered if explicitly requested using RWsSession:RequestOffEvent(). */
sl@0	384	EEventSwitchOff,
sl@0	385	/** Event issued to off-event requesting windows when the off key is pressed. */
sl@0	386	EEventKeySwitchOff,
sl@0	387	/** Screen size mode change event.
sl@0	388
sl@0	389	This is issued when the screen size mode has changed, for instance when
sl@0	390	the cover on a phone that supports screen flipping is opened or closed. */
sl@0	391	EEventScreenDeviceChanged, //20
sl@0	392	/** Event sent whenever the window group with focus changes.
sl@0	393
sl@0	394	Requested by RWindowTreeNode::EnableFocusChangeEvents(). */
sl@0	395	EEventFocusGroupChanged,
sl@0	396	/** Case opened event.
sl@0	397
sl@0	398	This event is sent to those windows that have requested EEventSwitchOn
sl@0	399	events. Unlike with EEventSwitchOn events, the screen will not be switched
sl@0	400	on first. */
sl@0	401	EEventCaseOpened,
sl@0	402	/** Case closed event.
sl@0	403
sl@0	404	This event is sent to those windows that have requested EEventSwitchOff
sl@0	405	events.
sl@0	406
sl@0	407	Unlike EEventSwitchOff events, which make a call to the base to power down
sl@0	408	the processor if for some reason the event can't be delivered (or there is
sl@0	409	no-one to deliver it to), failure to deliver case closed events has no repercussions. */
sl@0	410	EEventCaseClosed,
sl@0	411	/** Window group list change event.
sl@0	412
sl@0	413	The window group list is a list of all window groups and their z-order. This
sl@0	414	event indicates any change in the window group list: additions, removals and
sl@0	415	reorderings.
sl@0	416
sl@0	417	Notification of this event is requested by calling RWindowTreeNode::EnableGroupListChangeEvents(). */
sl@0	418	EEventWindowGroupListChanged,
sl@0	419	/** The visibility of a window has changed
sl@0	420
sl@0	421	This is sent to windows when they change from visible to invisible, or visa versa, usually due
sl@0	422	to another window obscuring them.
sl@0	423
sl@0	424	Notification of this event is requested by calling RWindowTreeNode::EnableVisibilityChangeEvents(). */
sl@0	425	EEventWindowVisibilityChanged,
sl@0	426	#ifdef SYMBIAN_PROCESS_MONITORING_AND_STARTUP
sl@0	427	/** Restart event.
sl@0	428
sl@0	429	This is issued when an restart event is received by the window server from the
sl@0	430	base. This event is also an off event, because it might power-cycle the device.
sl@0	431
sl@0	432	If for some reason the event can't be delivered, or there is no-one to deliver
sl@0	433	it to, then a call to the base is made to power down the processor.
sl@0	434
sl@0	435	This event is only delivered if explicitly requested using RWsSession:RequestOffEvent(). */
sl@0	436	EEventRestartSystem,
sl@0	437	#endif
sl@0	438	/** The display state or configuration has changed
sl@0	439
sl@0	440	Either change of the current resolution list (state change) or current resolution/background
sl@0	441	(mode change) will trigger this event.
sl@0	442
sl@0	443	Notification of this event is requested by calling MDisplayControl::EnableDisplayChangeEvents()
sl@0	444	*/
sl@0	445	EEventDisplayChanged = EEventWindowVisibilityChanged+2,
sl@0	446	//Codes for events only passed into Key Click DLL's
sl@0	447	/** Repeating key event.
sl@0	448
sl@0	449	This is only sent to a key click plug-in DLL (if one is present) to indicate
sl@0	450	a repeating key event.
sl@0	451
sl@0	452	@see CClickMaker */
sl@0	453	EEventKeyRepeat=100,
sl@0	454	EEventGroupWindowOpen,
sl@0	455	EEventGroupWindowClose,
sl@0	456	EEventWindowClose,
sl@0	457	//Codes for events only passed into anim dlls
sl@0	458	/** Direct screen access begin
sl@0	459	This is only sent to anim dlls (if they register to be notified). It indicates that
sl@0	460	the number of direct screen access sessions has increased from zero to one.*/
sl@0	461	EEventDirectScreenAccessBegin=200,
sl@0	462	/** Direct screen access end
sl@0	463	This is only sent to anim dlls (if they register to be notified). It indicates that
sl@0	464	the number of direct screen access sessions has decreased from one to zero.*/
sl@0	465	EEventDirectScreenAccessEnd,
sl@0	466	/** Event to signal the starting or stopping of the wserv heartbeat timer
sl@0	467	This is only sent to anim dlls (if they register to be notified). */
sl@0	468	EEventHeartbeatTimerStateChange,
sl@0	469
sl@0	470	//The range 900-999 is reserved for UI Framework events
sl@0	471	/** 900-909 WSERV protects with PowerMgmt */
sl@0	472	EEventPowerMgmt = 900,
sl@0	473	EEventReserved = 910,
sl@0	474
sl@0	475	//Event codes from EEventUser upwards may be used for non-wserv events.
sl@0	476	//No event codes below this should be defined except by the window server
sl@0	477
sl@0	478	/** User defined event.
sl@0	479
sl@0	480	The client can use this and all higher values to define their own
sl@0	481	events. These events can be sent between windows of the same client or windows
sl@0	482	of different clients.
sl@0	483
sl@0	484	@see RWs::SendEventToWindowGroup(). */
sl@0	485	EEventUser=1000,
sl@0	486
sl@0	487	};
sl@0	488
sl@0	489
sl@0	490	/** Window server hot keys.
sl@0	491
sl@0	492	@publishedAll
sl@0	493	@released
sl@0	494	@see RWsSession::SetHotKey() */
sl@0	495	enum THotKey
sl@0	496	{
sl@0	497	/** Enables logging of all messages to and from the window server.
sl@0	498
sl@0	499	Note that the required type of logging must have been specified in the wsini.ini
sl@0	500	file (using the LOG keyword), and the appropriate logging DLL must be available.
sl@0	501
sl@0	502	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\>E */
sl@0	503	EHotKeyEnableLogging,
sl@0	504	/** Always disables window server logging, if active. Does nothing otherwise.
sl@0	505
sl@0	506	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\>D */
sl@0	507	EHotKeyDisableLogging,
sl@0	508	/** Dumps a list of all windows to the log. (If logging is disabled, it is temporarily
sl@0	509	enabled in order to do this.)
sl@0	510
sl@0	511	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\>W */
sl@0	512	EHotKeyStateDump,
sl@0	513	/** Kills the foreground application.
sl@0	514
sl@0	515	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\>K */
sl@0	516	EHotKeyOfDeath,
sl@0	517	/** Shuts down the window server.
sl@0	518
sl@0	519	Be cautious! This may mean resetting the machine to re-start the window server.
sl@0	520
sl@0	521	Default key mapping: release (not available), debug (\<Ctrl\>\<Alt\>\<Shift\>X). */
sl@0	522	EHotKeyShutDown,
sl@0	523	/** Dumps a list of cells allocated on the window server's heap to the log. (If
sl@0	524	logging is disabled, it is temporarily enabled in order to do this.)
sl@0	525
sl@0	526	Note that logging requires that the type of logging has been set up in the
sl@0	527	wsini.ini file, and that the appropriate logging DLL is available.
sl@0	528
sl@0	529	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\>H */
sl@0	530	EHotKeyHeapDump,
sl@0	531	/** Increases the LCD contrast.
sl@0	532
sl@0	533	Default key mapping: EKeyIncContrast. Note that this value is from an enum
sl@0	534	in e32keys.h. The contrast wraps around when it reaches the maximum. */
sl@0	535	EHotKeyIncContrast,
sl@0	536	/** Decreases the LCD contrast.
sl@0	537
sl@0	538	Default key mapping: EKeyDecContrast. Note that this value is from an enum
sl@0	539	in e32keys.h. The contrast wraps around when it reaches the minimum. */
sl@0	540	EHotKeyDecContrast,
sl@0	541	/** Switches the machine off.
sl@0	542
sl@0	543	Default key mapping: EKeyOff. Note that this value is from an enum in e32keys.h. */
sl@0	544	EHotKeyOff,
sl@0	545	/** Switches the backlight on.
sl@0	546
sl@0	547	Default key mapping: EKeyBacklightOn. Note that this value is from an enum
sl@0	548	in e32keys.h. */
sl@0	549	EHotKeyBacklightOn,
sl@0	550	/** Switches the backlight off.
sl@0	551
sl@0	552	Default key mapping: EKeyBacklightOff. Note that this value is from an enum
sl@0	553	in e32keys.h. */
sl@0	554	EHotKeyBacklightOff,
sl@0	555	/** Toggles the backlight.
sl@0	556
sl@0	557	Default key mapping: EKeyBacklightToggle. Note that this value is from an
sl@0	558	enum in e32keys.h. */
sl@0	559	EHotKeyBacklightToggle,
sl@0	560	/** Switches to screen size 0.
sl@0	561
sl@0	562	This, and the following 3 keys are used to switch screen sizes on real hardware,
sl@0	563	for instance when the cover is closed on a phone that supports screen flipping. */
sl@0	564	EHotKeyScreenDimension0,
sl@0	565	/** Switches to screen size 1.
sl@0	566
sl@0	567	This might be generated when the cover is opened on a phone that supports screen
sl@0	568	flipping. */
sl@0	569	EHotKeyScreenDimension1,
sl@0	570	/** Switches to screen size 2. */
sl@0	571	EHotKeyScreenDimension2,
sl@0	572	/** Switches to screen size 3. */
sl@0	573	EHotKeyScreenDimension3,
sl@0	574	/** Cycles the display though its possible sizes.
sl@0	575
sl@0	576	This is used only for debugging.
sl@0	577
sl@0	578	A device may have several screen sizes, each with a default orientation. For
sl@0	579	example a phone that supports screen flipping will have different display
sl@0	580	sizes when the cover is opened and closed.
sl@0	581
sl@0	582	Default key mapping: debug : \<Ctrl\>\<Alt\>\<Shift\> U. Release : none. */
sl@0	583	EHotKeyCycleDisplaySize,
sl@0	584	/** Cycles the screen orientation through the specified rotations for the particular
sl@0	585	size mode you are in.
sl@0	586
sl@0	587	For example, phones that support screen flipping may
sl@0	588	use this feature for changing between right and left handed use.
sl@0	589
sl@0	590	For rectangular display modes you can only specify 2 orientations, 180 degrees
sl@0	591	apart. For square modes you can specify 4 rotations (90 degrees) or however
sl@0	592	many you want.
sl@0	593
sl@0	594	Specification of the list of rotations takes place in the WSINI.INI file.
sl@0	595
sl@0	596	Default key mapping: debug : \<Ctrl\>\<Alt\>\<Shift\> O. Release : none. */
sl@0	597	EHotKeyCycleOrientation,
sl@0	598	/** Increases the screen's brightness.
sl@0	599
sl@0	600	The brightness wraps around to the minimum
sl@0	601	value after it has reached the maximum. */
sl@0	602	EHotKeyIncBrightness,
sl@0	603	/** Decreases the screen's brightness.
sl@0	604
sl@0	605	The brightness wraps around to the maximum value after it has reached the minimum. */
sl@0	606	EHotKeyDecBrightness,
sl@0	607
sl@0	608	/** Cycle focus screen from one to another in multiple screen environment. Start
sl@0	609	from current focused screen, switch to next the screen, and wraps around when it
sl@0	610	reaches the last screen.
sl@0	611
sl@0	612	Default key mapping: \<Ctrl\>\<Alt\>\<Shift\> I. */
sl@0	613	EHotKeyCycleFocusScreen,
sl@0	614
sl@0	615	/** Value for first hot key.
sl@0	616
sl@0	617	Used with EHotKeyLastKeyType to make it easy to write a for loop that steps
sl@0	618	through all the different key values. */
sl@0	619	EHotKeyFirstKeyType=EHotKeyEnableLogging, //Must always be set to the first one
sl@0	620	/** Value for last hot key.
sl@0	621
sl@0	622	Used with EHotKeyFirstKeyType to make it easy to write a for loop that steps
sl@0	623	through all the different key values. */
sl@0	624	EHotKeyLastKeyType=EHotKeyCycleFocusScreen, //Must always be set to the last one
sl@0	625	};
sl@0	626
sl@0	627
sl@0	628	/** Password mode flags.
sl@0	629
sl@0	630	@publishedAll
sl@0	631	@deprecated */
sl@0	632	enum TPasswordMode
sl@0	633	{
sl@0	634	/** Releases ownership of password handling.
sl@0	635
sl@0	636	This allows another window to become the password window. A client will be
sl@0	637	panicked with code 46 if it sets this mode when it is not the current password
sl@0	638	window. */
sl@0	639	EPasswordCancel,
sl@0	640	/** No password handling is performed by this window, but no other window
sl@0	641	can become the password window. */
sl@0	642	EPasswordNone,
sl@0	643	/** Password mode is enabled only once a day.
sl@0	644
sl@0	645	When enabled, password mode requires the user to enter a password
sl@0	646	before any further actions can be performed. */
sl@0	647	EPasswordOnceADay,
sl@0	648	/** Password mode is enabled every time the machine is switched on. */
sl@0	649	EPasswordAlways,
sl@0	650	/** Equivalent to setting the password mode to EPasswordAlways and triggering an
sl@0	651	instant password check. */
sl@0	652	EPasswordAlwaysTriggerNow,
sl@0	653	/** Equivalent to setting the password mode to EPasswordOnceADay and triggering
sl@0	654	an instant password check. */
sl@0	655	EPasswordOnceADayTriggerNow,
sl@0	656	};
sl@0	657	enum TPriorities {
sl@0	658	/**
sl@0	659	Defines the value EAllPriorities.
sl@0	660	*/
sl@0	661	EAllPriorities=KMinTInt,
sl@0	662	};
sl@0	663
sl@0	664	/** Sprite flags.
sl@0	665
sl@0	666	These can be combined using a bit-wise OR operation.
sl@0	667
sl@0	668	@publishedAll
sl@0	669	@released
sl@0	670	@see RWsPointerCursor::Construct()
sl@0	671	@see RWsSprite::Construct() */
sl@0	672	enum TSpriteFlags
sl@0	673	{
sl@0	674	/** Flash sprite on and off.
sl@0	675
sl@0	676	All flashing is done on the same timer, including the text cursor. */
sl@0	677	ESpriteFlash=0x1,
sl@0	678	/** This flag no longer has any effect.
sl@0	679
sl@0	680	If you want a sprite to appear on top of all windows, you can create a floating sprite
sl@0	681	by specifying a RWindowGroup as parent to the sprite. */
sl@0	682	ESpriteNoChildClip=0x2,
sl@0	683	/** The sprite's appearance will not change when it is on a shadowed part of the
sl@0	684	screen.
sl@0	685
sl@0	686	(Typically this is used for sprites attached to window groups so that
sl@0	687	they are perceived to be floating above the windows). */
sl@0	688	ESpriteNoShadows=0x4
sl@0	689	};
sl@0	690
sl@0	691	struct TSpriteMember
sl@0	692	/** Sprite member.
sl@0	693
sl@0	694	This structure is used to define the parameters of a sprite member, which
sl@0	695	can be added to a sprite or pointer cursor.
sl@0	696	@publishedAll
sl@0	697	@released */
sl@0	698	{
sl@0	699	/** The bitmap to be displayed in the sprite or pointer cursor during the time
sl@0	700	interval specified by iInterval.
sl@0	701
sl@0	702	If NULL, the sprite or pointer cursor will be invisible for the time specified
sl@0	703	by iInterval. */
sl@0	704	CFbsBitmap *iBitmap;
sl@0	705	/** The bitmap mask.
sl@0	706
sl@0	707	This defines which areas of iBitmap are drawn to the screen.
sl@0	708	It enables the bitmap to have a non-rectangular shape on the screen. Areas
sl@0	709	which are not drawn to, retain the appearance of the window underneath the
sl@0	710	sprite or cursor.
sl@0	711
sl@0	712	The bits in iBitmap are AND'ed with those in iMaskBitmap before being drawn
sl@0	713	to the screen. In practice, the mask bitmap is normally white in those areas
sl@0	714	drawn to by iBitmap, and black in all other areas.
sl@0	715
sl@0	716	Note:
sl@0	717
sl@0	718	This bitmap should be in the same mode as iBitmap, otherwise the masking
sl@0	719	out operation becomes inefficient. */
sl@0	720	CFbsBitmap *iMaskBitmap;
sl@0	721	/** EFalse if the mask bitmap is not to be inverted (the default) or ETrue if it
sl@0	722	is to be inverted. */
sl@0	723	TBool iInvertMask;
sl@0	724	/** Specifies the drawing mode to use when drawing iBitmap if the mask is NULL. */
sl@0	725	CGraphicsContext::TDrawMode iDrawMode;
sl@0	726	/** Offset from the sprite's central position.
sl@0	727
sl@0	728	Specifies an offset between the origin of iBitmap and the sprite or pointer
sl@0	729	cursor's origin. (The origin is the top left corner of the bitmap.) */
sl@0	730	TPoint iOffset;
sl@0	731	/** Time interval for which iBitmap is displayed.
sl@0	732
sl@0	733	Note that if only one sprite member is added to a sprite or pointer cursor,
sl@0	734	it will be displayed continuously, regardless of the value of iInterval. */
sl@0	735	TTimeIntervalMicroSeconds32 iInterval;
sl@0	736	};
sl@0	737
sl@0	738	/** Event reporting control.
sl@0	739
sl@0	740	This enumeration defines flags which can be used to control how events are
sl@0	741	reported.
sl@0	742
sl@0	743	@publishedAll
sl@0	744	@released
sl@0	745	@see RWindowTreeNode::EnableOnEvents()
sl@0	746	@see RWindowTreeNode::EnableModifierChangedEvents()
sl@0	747	@see RWindowTreeNode::EnableErrorMessages() */
sl@0	748	enum TEventControl
sl@0	749	{
sl@0	750	/** Requested events are sent in all circumstances. */
sl@0	751	EEventControlAlways,
sl@0	752	/** Events are delivered only when the requesting window's window group has keyboard
sl@0	753	focus. */
sl@0	754	EEventControlOnlyWithKeyboardFocus,
sl@0	755	/** Events are delivered only when the requesting window or any of its children
sl@0	756	are visible on the screen. */
sl@0	757	EEventControlOnlyWhenVisible
sl@0	758	};
sl@0	759
sl@0	760	/** Pointer event filter types.
sl@0	761
sl@0	762	These flags are used by RWindowBase::PointerFilter() to define which pointer
sl@0	763	events are filtered out by the window server and not sent to the client session.
sl@0	764	They also allow the window server to simulate a move event prior to each pen
sl@0	765	down event.
sl@0	766
sl@0	767	@publishedAll
sl@0	768	@released
sl@0	769	@see RWindowBase::PointerFilter() */
sl@0	770	enum TPointerFilter
sl@0	771	{
sl@0	772	//Basic Types
sl@0	773	/** Filters out both pointer enter and pointer exit events for this window. */
sl@0	774	EPointerFilterEnterExit=0x1,
sl@0	775	/** Filters out pointer-move events for this window. */
sl@0	776	EPointerFilterMove=0x2,
sl@0	777	/** Filters out pointer-drag events for this window. */
sl@0	778	EPointerFilterDrag=0x4,
sl@0	779	/** Simulates a pointer move event before each pen down event.
sl@0	780
sl@0	781	This makes the pen appear more like a mouse, with simulated movement between
sl@0	782	two pointer events. You can only get these events while you are in pen mode. */
sl@0	783	EPointerGenerateSimulatedMove=0x8,
sl@0	784	//Combinations of the above
sl@0	785	/** Filters move and drag-pointer events from the event stream and simulates the
sl@0	786	move event before each pen down event.
sl@0	787
sl@0	788	This enum is useful when you want to get simulated move events. Use it as shown
sl@0	789	below to turn on simulated moves:
sl@0	790
sl@0	791	@code
sl@0	792	win->PointerFilter(EPointerMoveEvents, EPointerGenerateSimulateMoves)
sl@0	793	@endcode
sl@0	794	@see RWindowBase::PointerFilter() */
sl@0	795	EPointerMoveEvents=EPointerFilterMove\|EPointerGenerateSimulatedMove,
sl@0	796	};
sl@0	797
sl@0	798	struct TKeyEvent
sl@0	799	/** Key event details.
sl@0	800
sl@0	801	When processing a TKeyEvent, the TStdScanCode in iScanCode should usually
sl@0	802	be ignored in favour of the TKeyCode in iCode. Using iScanCode would bypass
sl@0	803	the keyboard mapping and any FEP that happens to be installed. The exceptions
sl@0	804	to this general rule are games where the positions of the keys are more important
sl@0	805	than their translations, and FEPs that are implementing keyboard maps themselves.
sl@0	806	In these cases, if the iCode is used rather than iScanCode to determine the
sl@0	807	key pressed, there will be two unfortunate consequences. Firstly, the low-level
sl@0	808	keyboard mapping might re-arrange the mapping that you are trying to impose.
sl@0	809	Secondly, you will subvert the CTRL+number method of entering Unicode literals.
sl@0	810
sl@0	811	@publishedAll
sl@0	812	@released */
sl@0	813	{
sl@0	814	/** The character code generated for an EEventKey, or 0 for a down or up event.
sl@0	815
sl@0	816	Key codes for special keys are defined in TKeyCode. */
sl@0	817	TUint iCode;
sl@0	818	/** The scan code of the key that caused the event.
sl@0	819
sl@0	820	Standard scan codes are defined in TStdScanCode. */
sl@0	821	TInt iScanCode;
sl@0	822	/** State of modifier keys and pointing device. Modifier keys are defined in TEventModifier. */
sl@0	823	TUint iModifiers;
sl@0	824	/** Count of auto repeats generated.
sl@0	825
sl@0	826	0 means an event without repeats. 1 or more means "this many auto repeat events".
sl@0	827	It is normal to ignore this value and treat it as a single event. */
sl@0	828	TInt iRepeats;
sl@0	829	};
sl@0	830
sl@0	831	struct TModifiersChangedEvent
sl@0	832	/** Details of changed modifier keys.
sl@0	833
sl@0	834	@publishedAll
sl@0	835	@released
sl@0	836	@see TWsEvent::ModifiersChanged() */
sl@0	837	{
sl@0	838	/** Contains a set bit for any modifier which has changed. Modifiers are defined
sl@0	839	in TEventModifier. */
sl@0	840	TUint iChangedModifiers;
sl@0	841	/** Current state of all modifiers, combined using a bitwise-OR. Modifiers are
sl@0	842	defined in TEventModifier. */
sl@0	843	TUint iModifiers;
sl@0	844	};
sl@0	845
sl@0	846	struct TWsVisibilityChangedEvent
sl@0	847	/** Visibility changed events.
sl@0	848
sl@0	849	These events are generated in response to a window being obscured, or being fully or partially
sl@0	850	revealed after being obscured.
sl@0	851	@publishedAll
sl@0	852	@released
sl@0	853	@see RWindowTreeNode::EnableVisibilityChangeEvents() */
sl@0	854	{
sl@0	855	enum
sl@0	856	{
sl@0	857	/** Some or all of the window is visible, either directly or through a transparent window.
sl@0	858	@deprecated Use EPartiallyVisible instead. */
sl@0	859	ECanBeSeen = 0x01,
sl@0	860	/** None of the window is visible, either directly or through a transparent window.
sl@0	861	@deprecated Use ENotVisible instead. */
sl@0	862	ECantBeSeen = 0x02,
sl@0	863	};
sl@0	864	enum
sl@0	865	{
sl@0	866	/** Some (or all) of the window is visible, either directly or through a transparent window. */
sl@0	867	EPartiallyVisible = 0x01,
sl@0	868	/** None of the window is visible, either directly or through a transparent window. */
sl@0	869	ENotVisible = 0x02,
sl@0	870	/** All of the window is directly visible. */
sl@0	871	EFullyVisible = 0x04,
sl@0	872	};
sl@0	873	/** A combination of one or more visibility event flags. */
sl@0	874	TUint iFlags;
sl@0	875	};
sl@0	876
sl@0	877	struct TWsDisplayChangedEvent
sl@0	878	/** Display changed events.
sl@0	879
sl@0	880	These events are generated by attaching, detaching the display device, changing the resolution list or change
sl@0	881	current resolution or backgound (change the current configuration).
sl@0	882	@publishedAll
sl@0	883	@released
sl@0	884	@see MDisplayControl::EnableDisplayChangeEvents() */
sl@0	885	{
sl@0	886	/**
sl@0	887	Number of display that has changed, causing this event. This is
sl@0	888	also known as the screen number, and is zero-based.
sl@0	889
sl@0	890	@see CWsScreenDevice::Construct(TInt)
sl@0	891	*/
sl@0	892	TInt iDisplayNumber;
sl@0	893	/**
sl@0	894	Opaque value that changes when the current display configuration
sl@0	895	has changed.
sl@0	896
sl@0	897	Compare values in subsequent events to determine whether the
sl@0	898	current resolution has changed since the last event.
sl@0	899	*/
sl@0	900	TInt iConfigurationChangeId;
sl@0	901	/**
sl@0	902	Opaque value that changes when the resolution list has changed.
sl@0	903
sl@0	904	Compare values in subsequent events to determine whether the list
sl@0	905	of available resolutions has changed since the last event.
sl@0	906
sl@0	907	@see MDisplayControlBase::GetResolutions
sl@0	908	*/
sl@0	909	TInt iResolutionListChangeId;
sl@0	910	};
sl@0	911
sl@0	912	struct TWsErrorMessage
sl@0	913	/** Error event details.
sl@0	914
sl@0	915	@publishedAll
sl@0	916	@released
sl@0	917	@see RWindowTreeNode::EnableErrorMessages() */
sl@0	918	{
sl@0	919	/** Error event types */
sl@0	920	enum TErrorCategory
sl@0	921	{
sl@0	922	/** An error that occurs while the window server is calculating a drawing region
sl@0	923	for a particular window.
sl@0	924
sl@0	925	When the window server can't calculate a drawing region due to lack of memory
sl@0	926	it goes into a mode where it draws the whole of a window. Any window that
sl@0	927	is covering this window is also told to redraw. */
sl@0	928	EDrawingRegion,
sl@0	929	/** An error occured while trying to turn the backlight on or off.
sl@0	930
sl@0	931	This would usually only happen when the batteries are low. */
sl@0	932	EBackLight,
sl@0	933	/** An error occured while trying to enable logging. */
sl@0	934	ELogging,
sl@0	935	/** An error that occured while trying to change the contrast. */
sl@0	936	EContrast,
sl@0	937	};
sl@0	938	/** The error category. */
sl@0	939	TErrorCategory iErrorCategory;
sl@0	940	/** The error code */
sl@0	941	TUint iError;
sl@0	942	};
sl@0	943
sl@0	944	class TWsRedrawEvent
sl@0	945	/** Window server redraw event.
sl@0	946
sl@0	947	All redraw events generated by the window server are delivered to the client
sl@0	948	in an object of this type. The class provides a handle to the window which
sl@0	949	generated the redraw event, and the rectangle which should be redrawn.
sl@0	950
sl@0	951	@publishedAll
sl@0	952	@released
sl@0	953	@see RWsSession::GetRedraw() */
sl@0	954	{
sl@0	955	public:
sl@0	956	inline TUint Handle() const;
sl@0	957	inline TRect Rect() const;
sl@0	958	public:
sl@0	959	void SetHandle(TUint aHandle);
sl@0	960	void SetRect(TRect aRect);
sl@0	961	protected:
sl@0	962	TUint iHandle; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	963	TRect iRect; /*< Rectangle to redraw. WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	964	};
sl@0	965
sl@0	966	class TWsPriorityKeyEvent
sl@0	967	/** Priority key events.
sl@0	968
sl@0	969	These events are configured using RWindowGroup::AddPriorityKey(), and obtained
sl@0	970	by the client using the functions RWsSession::PriorityKeyReady() and RWsSession::GetPriorityKey().
sl@0	971
sl@0	972	@publishedAll
sl@0	973	@released */
sl@0	974	{
sl@0	975	public:
sl@0	976	inline TKeyEvent *Key() const;
sl@0	977	inline TUint Handle() const;
sl@0	978	inline void SetHandle(TUint aHandle);
sl@0	979	protected:
sl@0	980	TUint iHandle; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	981	TUint8 iEventData[sizeof(TKeyEvent)]; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	982	};
sl@0	983
sl@0	984	class TWsEvent
sl@0	985	/** Window server event.
sl@0	986
sl@0	987	All events generated by the window server, except redraw events and priority
sl@0	988	key events, are delivered to the client in a TWsEvent. The client obtains
sl@0	989	the TWsEvent by calling RWsSession::GetEvent(). The type of data contained
sl@0	990	in the TWsEvent depends on the type of event. The client can inquire the event
sl@0	991	type using Type(), and then retrieve the appropriate type of data.
sl@0	992
sl@0	993	@publishedAll
sl@0	994	@released */
sl@0	995	{
sl@0	996	public:
sl@0	997	/** Event data size. */
sl@0	998	enum
sl@0	999	{
sl@0	1000	/**
sl@0	1001	This is the maximum number of bytes of data that can be returned by EventData().
sl@0	1002	Note: this value is 32 bytes.*/
sl@0	1003	EWsEventDataSize=sizeof(TAdvancedPointerEvent)
sl@0	1004	};
sl@0	1005	public:
sl@0	1006	inline TWsEvent();
sl@0	1007	inline TAdvancedPointerEvent* Pointer() const;
sl@0	1008	inline TKeyEvent* Key() const;
sl@0	1009	inline TModifiersChangedEvent* ModifiersChanged() const;
sl@0	1010	inline TWsVisibilityChangedEvent* VisibilityChanged();
sl@0	1011	inline const TWsVisibilityChangedEvent* VisibilityChanged() const;
sl@0	1012	inline TWsDisplayChangedEvent* DisplayChanged();
sl@0	1013	inline const TWsDisplayChangedEvent* DisplayChanged() const;
sl@0	1014	inline TWsErrorMessage* ErrorMessage() const;
sl@0	1015	inline TUint8* EventData() const;
sl@0	1016	inline TInt Type() const;
sl@0	1017	inline TUint Handle() const;
sl@0	1018	inline TTime Time() const;
sl@0	1019	inline void SetType(TInt aType);
sl@0	1020	inline void SetHandle(TUint aHandle);
sl@0	1021	inline void SetTimeNow();
sl@0	1022	inline TInt* Int() const;
sl@0	1023	IMPORT_C void InitAdvancedPointerEvent(TPointerEvent::TType aType, TUint aModifiers, const TPoint3D &aPoint3D, TUint8 aPointerNumber);
sl@0	1024	IMPORT_C void SetPointerNumber(TUint8 aPointerNumber);
sl@0	1025	IMPORT_C void SetPointerZ(TInt aZ);
sl@0	1026	protected:
sl@0	1027	TInt iType; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1028	TUint iHandle; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1029	TTime iTime; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1030	TUint8 iEventData[EWsEventDataSize]; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1031	};
sl@0	1032
sl@0	1033
sl@0	1034	class RWsPointerCursor;
sl@0	1035
sl@0	1036	/** Pointer cursor mode flags.
sl@0	1037
sl@0	1038	These flags define the current cursor mode, and hence which sprite to use
sl@0	1039	for the pointer cursor.
sl@0	1040
sl@0	1041	@publishedAll
sl@0	1042	@released
sl@0	1043	@see RWsSession::SetPointerCursorMode()
sl@0	1044	@see RWsSession::PointerCursorMode() */
sl@0	1045	enum TPointerCursorMode
sl@0	1046	{
sl@0	1047	/** Don't have a pointer cursor. */
sl@0	1048	EPointerCursorNone,
sl@0	1049	/** The default system pointer cursor is used whenever there is a pointer cursor. */
sl@0	1050	EPointerCursorFixed,
sl@0	1051	/** The default system pointer cursor is used unless the window the pointer cursor
sl@0	1052	is above specifies one, in which case that cursor is used. */
sl@0	1053	EPointerCursorNormal,
sl@0	1054	/** There is no pointer cursor unless the pointer is above a window that has specified
sl@0	1055	one. */
sl@0	1056	EPointerCursorWindow,
sl@0	1057	/** First pointer cursor mode.
sl@0	1058
sl@0	1059	This is used in test code for iterating though available modes. */
sl@0	1060	EPointerCursorFirstMode=EPointerCursorNone,
sl@0	1061	/** The final pointer cursor mode.
sl@0	1062
sl@0	1063	This is used in test code for iterating though available modes. It will be
sl@0	1064	updated if more modes are added. */
sl@0	1065	EPointerCursorLastMode=EPointerCursorWindow,
sl@0	1066	};
sl@0	1067
sl@0	1068	/** Flags which customise a long key press capture request made by a window group.
sl@0	1069
sl@0	1070	These flags are passed to RWindowGroup::CaptureLongKey().
sl@0	1071
sl@0	1072	Two things can be configured using this enum: the normal key event that is
sl@0	1073	generated immediately, and the long key event that is generated after a short
sl@0	1074	time interval. The normal key event can be sent immediately (on key down)
sl@0	1075	to the application with keyboard focus, or, if the key is not held down long
sl@0	1076	enough to generate a long key event, when the key is released. The long key
sl@0	1077	event can be customised to generate a single key event only, or to auto repeat.
sl@0	1078
sl@0	1079	@publishedAll
sl@0	1080	@released
sl@0	1081	@see RWindowGroup::CaptureLongKey() */
sl@0	1082	enum TLongCaptureFlags
sl@0	1083	{
sl@0	1084	/** If specified, the normal ("short") key event is sent immediately (on key down)
sl@0	1085	to the application with keyboard focus. If not specified, the normal key event
sl@0	1086	is sent when the key is released (if the key is not held down long enough
sl@0	1087	to generate a long key event). */
sl@0	1088	ELongCaptureShortEventImmediately=0x01,
sl@0	1089	/** If specified, causes the long key press to automatically repeat. If not specified,
sl@0	1090	the long key press will generate a single key event only. */
sl@0	1091	ELongCaptureRepeatEvents=0x02,
sl@0	1092	/** Equivalent to ELongCaptureShortEventImmediately being set and the other flags
sl@0	1093	unset. */
sl@0	1094	ELongCaptureNormal=ELongCaptureShortEventImmediately,
sl@0	1095	/** Equivalent to the first two values being unset. */
sl@0	1096	ELongCaptureWaitShort=0,
sl@0	1097	};
sl@0	1098
sl@0	1099
sl@0	1100	class TIpcArgs;
sl@0	1101	class TReadDescriptorType;
sl@0	1102	class TWriteDescriptorType;
sl@0	1103	class CWindowGc;
sl@0	1104	class RWsSession;
sl@0	1105
sl@0	1106	class TWsGraphicId
sl@0	1107	/** Identifies an abstract artwork
sl@0	1108
sl@0	1109	This is a piece of artwork that might be owned and authored by another process.
sl@0	1110	A client can draw a piece of artwork, but that doesn't confer the ability to
sl@0	1111	access the pixel representation of that artwork directly.
sl@0	1112
sl@0	1113	@publishedAll
sl@0	1114	@released */
sl@0	1115	{
sl@0	1116	public:
sl@0	1117	enum TUninitialized
sl@0	1118	{
sl@0	1119	EUninitialized
sl@0	1120	};
sl@0	1121	TWsGraphicId(TUninitialized): iFlags(0) {}
sl@0	1122	IMPORT_C TWsGraphicId(TUid aUid);
sl@0	1123	IMPORT_C TWsGraphicId(TInt aId);
sl@0	1124	IMPORT_C TWsGraphicId(const TWsGraphicId& aCopy);
sl@0	1125	IMPORT_C TUid Uid() const;
sl@0	1126	IMPORT_C TBool IsUid() const;
sl@0	1127	IMPORT_C void Set(TUid aUid);
sl@0	1128	IMPORT_C TInt Id() const;
sl@0	1129	IMPORT_C TBool IsId() const;
sl@0	1130	IMPORT_C void Set(TInt aId);
sl@0	1131	IMPORT_C TInt Compare(const TWsGraphicId& aOther) const;
sl@0	1132	private:
sl@0	1133	friend class CWsGraphic;
sl@0	1134	TUint iFlags;
sl@0	1135	TInt iId;
sl@0	1136	TInt iWsGraphicIdSpare[2];
sl@0	1137	};
sl@0	1138
sl@0	1139	class CWsGraphic: public CBase
sl@0	1140	/** Client representation of a window-server-side piece of artwork owned by this Client
sl@0	1141
sl@0	1142	@publishedAll
sl@0	1143	@released
sl@0	1144	*/
sl@0	1145	{
sl@0	1146	protected:
sl@0	1147	IMPORT_C CWsGraphic();
sl@0	1148	public:
sl@0	1149	IMPORT_C ~CWsGraphic();
sl@0	1150	protected:
sl@0	1151	// 2nd phase construction
sl@0	1152	IMPORT_C void BaseConstructL(TUid aUid,TUid aType,const TDesC8& aData);
sl@0	1153	IMPORT_C void BaseConstructL(TUid aType,const TDesC8& aData);
sl@0	1154	IMPORT_C void BaseConstructL(const TWsGraphicId& aReplace,TUid aType,const TDesC8& aData);
sl@0	1155	// sharing between clients
sl@0	1156	IMPORT_C virtual TInt ShareGlobally();
sl@0	1157	IMPORT_C virtual TInt Share(TSecureId aClientId);
sl@0	1158	IMPORT_C virtual TInt UnShare(TSecureId aClientId);
sl@0	1159	IMPORT_C virtual TInt UnShareGlobally();
sl@0	1160	public:
sl@0	1161	IMPORT_C const TWsGraphicId& Id() const;
sl@0	1162	IMPORT_C TBool IsActive() const;
sl@0	1163	IMPORT_C void Destroy();
sl@0	1164	protected:
sl@0	1165	IMPORT_C void SendMessage(const TDesC8& aData) const;
sl@0	1166	IMPORT_C TInt SendSynchronMessage(const TDesC8& aData) const;
sl@0	1167	IMPORT_C TInt Flush() const;
sl@0	1168	IMPORT_C void SetGraphicExtension(MWsObjectProvider* aExt);
sl@0	1169	IMPORT_C RWsSession& Session();
sl@0	1170
sl@0	1171	private:
sl@0	1172	// events from wserv, to be implemented by derived classes
sl@0	1173	/**
sl@0	1174	Handles message from this graphic artwork peer on the server.
sl@0	1175	@param aData Message from peer CWsGraphicDrawer.
sl@0	1176	*/
sl@0	1177	virtual void HandleMessage(const TDesC8& aData) = 0;
sl@0	1178
sl@0	1179	/**
sl@0	1180	Handles custom operation when this graphic artwork is replaced. When this method
sl@0	1181	is invoked, the replaced peer CWsGraphicDrawer on the server has been destroyed.
sl@0	1182	*/
sl@0	1183	virtual void OnReplace() = 0;
sl@0	1184	IMPORT_C virtual void OnClientClose();
sl@0	1185	private:
sl@0	1186	void BaseConstructL();
sl@0	1187	IMPORT_C virtual TInt CWsGraphic_Reserved1();
sl@0	1188	IMPORT_C virtual TInt CWsGraphic_Reserved2();
sl@0	1189	IMPORT_C virtual TInt CWsGraphic_Reserved3();
sl@0	1190	public:
sl@0	1191	class CManager;
sl@0	1192	private:
sl@0	1193	friend class CManager;
sl@0	1194	class CPimpl;
sl@0	1195	friend class CPimpl;
sl@0	1196	CPimpl* iPimpl;
sl@0	1197	TInt iWsGraphicSpare[2];
sl@0	1198	};
sl@0	1199
sl@0	1200	class MWsClientClass
sl@0	1201	/** Base class for all classes whose objects are clients of the window server.
sl@0	1202
sl@0	1203	@publishedAll
sl@0	1204	@released */
sl@0	1205	{
sl@0	1206	friend class RTFXEffect;
sl@0	1207	public:
sl@0	1208	MWsClientClass();
sl@0	1209	MWsClientClass(RWsBuffer *aBuffer);
sl@0	1210	inline TInt WsHandle() const;
sl@0	1211	protected:
sl@0	1212	void Write(const TAny *aData1,TInt aLength1,TInt aLength2,TUint aOpcode) const;
sl@0	1213	void Write(const TAny aData, TInt aLength,const TAny aData2, TInt aLength2,TUint aOpcode,const TIpcArgs* aIpcArgs=NULL) const;
sl@0	1214	void Write(const TAny aBuf, TInt aBufLen,TUint aOpcode,const TIpcArgs aIpcArgs=NULL) const;
sl@0	1215	void Write(TUint aOpcode) const;
sl@0	1216	void WriteInt(TInt aInt, TUint aOpcode) const;
sl@0	1217	void WriteRect(const TRect &aRect, TUint aOpcode) const;
sl@0	1218	void WritePoint(const TPoint &aPoint, TUint aOpcode) const;
sl@0	1219	void WriteSize(const TSize &aSize, TUint aOpcode) const;
sl@0	1220	TInt WriteReply(TUint aOpcode,const TIpcArgs* aIpcArgs=NULL) const;
sl@0	1221	TInt WriteReplyInt(TInt aInt, TUint aOpcode,const TIpcArgs* aIpcArgs=NULL) const;
sl@0	1222	TInt WriteReply(const TAny aBuf, TInt aBufLen,TUint aOpcode,const TIpcArgs aIpcArgs=NULL) const;
sl@0	1223	TInt WriteReply(const TAny aBuf, TInt aBufLen,const TAny aBuf2, TInt aBuflen2,TUint aOpcode,const TIpcArgs* aIpcArgs=NULL) const;
sl@0	1224	TInt WriteReplyP(const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const;
sl@0	1225	TInt WriteReplyIntP(TInt aInt, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const;
sl@0	1226	TInt WriteReplyP(const TAny *aBuf, TInt aBufLen, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const;
sl@0	1227	TInt WriteReplyP(const TAny aBuf, TInt aBufLen,const TAny aBuf2, TInt aBuflen2, const TWriteDescriptorType& aReplyPackage,TUint aOpcode) const;
sl@0	1228	TInt WriteReplyByProvidingRemoteReadAccess(const TAny* aBuf, TInt aBufLen,const TReadDescriptorType& aRemoteReadBuffer,TUint aOpcode) const;
sl@0	1229	void AddToBitmapArray(const TInt aBitmapHandle)const;
sl@0	1230	void AsyncRequest(TRequestStatus& aStatus, TUint aOpcode) const;
sl@0	1231
sl@0	1232	TBool WindowSizeCacheEnabled() const;
sl@0	1233	void MarkWindowSizeCacheDirty();
sl@0	1234	void RefreshWindowSizeCache(const TSize& aNewSize) const;
sl@0	1235	TInt CachedWindowSize(TSize& aSize) const;
sl@0	1236	void DestroyWindowSizeCacheEntry();
sl@0	1237
sl@0	1238	private:
sl@0	1239	void AppendData(const TAny *aData,TInt aLength,TBool aFinished);
sl@0	1240
sl@0	1241	protected:
sl@0	1242	TInt32 iWsHandle; /*< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1243	RWsBuffer iBuffer; /< WARNING: Member variable for internal use ONLY. Compatibility is not guaranteed in future releases. Please access using the provided get/set APIs only. /
sl@0	1244	};
sl@0	1245
sl@0	1246
sl@0	1247	class RWindowTreeNode;
sl@0	1248	class CWsScreenDevice;
sl@0	1249	class CWsBitmap;
sl@0	1250	class RAnimDll;
sl@0	1251	class RWsSpriteBase;
sl@0	1252	class RDirectScreenAccess;
sl@0	1253	class RSoundPlugIn;
sl@0	1254
sl@0	1255
sl@0	1256	class RWsSession : public MWsClientClass, public RSessionBase
sl@0	1257	/** Window server session.
sl@0	1258
sl@0	1259	The session between the client and the window server can be used to mediate
sl@0	1260	asynchronous events, for client interface control and for system control.
sl@0	1261	A description of each of these capabilities is given below.
sl@0	1262
sl@0	1263	Mediating asynchronous events:
sl@0	1264
sl@0	1265	Primarily, the session mediates asynchronous events to the user. Three event
sl@0	1266	streams are available: the standard event stream which all applications must
sl@0	1267	use; the redraw event stream which must be used by all applications except
sl@0	1268	those which exclusively use backed-up windows; and the priority key event
sl@0	1269	stream which may be used for abort keys and the like for specialist applications.
sl@0	1270
sl@0	1271	All these events are mediated as standard asynchronous services. Typical window
sl@0	1272	server client programs encapsulate each service they require in an active
sl@0	1273	object whose RunL() identifies the event and calls the appropriate member
sl@0	1274	function of a class associated with an application framework, or a window.
sl@0	1275
sl@0	1276	Client interface control:
sl@0	1277
sl@0	1278	The client's interface with the window server has several aspects, each of
sl@0	1279	which is controlled through the window server session.
sl@0	1280
sl@0	1281	Flushing defines how requests to the window server are handled.
sl@0	1282
sl@0	1283	System control:
sl@0	1284
sl@0	1285	Many system-wide settings may be controlled through the window server session.
sl@0	1286	Typically, these functions are only used by the system shell and its associated
sl@0	1287	sessions/applications. They include: auto-repeat and double-click, querying
sl@0	1288	all window groups in the system, setting the default shadow vector, setting
sl@0	1289	the system pointer cursors, counting resources used by the window server
sl@0	1290	(this is only useful for debugging checks), getting and setting the state of
sl@0	1291	the modifier keys (for instance Shift and Ctrl), setting the window server
sl@0	1292	background colour, getting and setting thresholds for window server generated
sl@0	1293	pointer events.
sl@0	1294
sl@0	1295	@publishedAll
sl@0	1296	@released */
sl@0	1297	{
sl@0	1298	friend class RWsBuffer;
sl@0	1299	friend class RWindowTreeNode;
sl@0	1300	friend class CWsScreenDevice;
sl@0	1301	friend class CWsBitmap;
sl@0	1302	friend class RAnimDll;
sl@0	1303	friend class RWsSpriteBase;
sl@0	1304	friend class RDirectScreenAccess;
sl@0	1305	friend class RSoundPlugIn;
sl@0	1306	friend class CWsGraphic;
sl@0	1307	friend class RWsDrawableSource;
sl@0	1308	public:
sl@0	1309	/** Compute mode flags.
sl@0	1310
sl@0	1311	When a window group takes focus or loses it, the window server can boost its
sl@0	1312	client's thread or process priority to provide a better response to the user.
sl@0	1313	How it alters the priority is determined by the current compute mode of the
sl@0	1314	client.
sl@0	1315
sl@0	1316	@see ComputeMode() */
sl@0	1317	enum TComputeMode
sl@0	1318	{
sl@0	1319	/** Client priority is permanently set to its current level. It is not altered
sl@0	1320	or set by the windowing system if the focus changes.
sl@0	1321
sl@0	1322	Thus if ComputeMode() is called with this flag when a client is in the foreground,
sl@0	1323	it will subsequently have foreground priority even if it is in the background. */
sl@0	1324	EPriorityControlDisabled,
sl@0	1325	/** Client process's priority is always set to EPriorityBackground. */
sl@0	1326	EPriorityControlComputeOn,
sl@0	1327	/** Client process's priority is set to EPriorityForeground when the window group
sl@0	1328	takes focus, and set to EPriorityBackground when it loses focus.
sl@0	1329
sl@0	1330	This is the default behaviour. */
sl@0	1331	EPriorityControlComputeOff
sl@0	1332	};
sl@0	1333	enum {ESystemInfoArraySize=16};
sl@0	1334	/** Window server logging commands passed to LogCommand().
sl@0	1335
sl@0	1336	@see RWsSession::LogCommand() */
sl@0	1337	enum TLoggingCommand
sl@0	1338	{
sl@0	1339	/** Enables logging. */
sl@0	1340	ELoggingEnable,
sl@0	1341	/** Disables logging. */
sl@0	1342	ELoggingDisable,
sl@0	1343	/** Logs the current status of all the windows in the tree, even if logging is
sl@0	1344	not currently enabled. */
sl@0	1345	ELoggingStatusDump, //Window Tree Dump
sl@0	1346	/** Logs information about the window server's heap size and usage, even if logging
sl@0	1347	is not currently enabled. */
sl@0	1348	ELoggingHeapDump,
sl@0	1349	};
sl@0	1350
sl@0	1351	struct TWindowGroupChainInfo
sl@0	1352	{
sl@0	1353	/*Stores id and Parent id window group
sl@0	1354
sl@0	1355	This is used to define chained window groups's id and it's parent id.
sl@0	1356	An array of these structures is returned by some of the varients of the function WindowGroupList.
sl@0	1357	@publishedAll
sl@0	1358	@released */
sl@0	1359	TInt iId;
sl@0	1360	TInt iParentId;
sl@0	1361	};
sl@0	1362
sl@0	1363	struct SSystemInfo
sl@0	1364	/** WARNING: Struct for internal use ONLY. Compatibility is not guaranteed in future releases. */
sl@0	1365	{
sl@0	1366	TInt iInfo[ESystemInfoArraySize];
sl@0	1367	};
sl@0	1368	/** The vertical alignment of a custom text cursor sprite.
sl@0	1369
sl@0	1370	One of these values must be set, see SetCustomTextCursor(). This value also
sl@0	1371	determines which part of each sprite member bitmap is clipped when the cursor's
sl@0	1372	TTextCursor::EFlagClipVertical flag is set. */
sl@0	1373	enum TCustomTextCursorAlignment
sl@0	1374	{
sl@0	1375	/** The y-origin of each sprite member bitmap is aligned with the top of the line. */
sl@0	1376	ECustomTextCursorAlignTop,
sl@0	1377	/** The y-origin of each sprite member bitmap is aligned with the baseline of the
sl@0	1378	line. */
sl@0	1379	ECustomTextCursorAlignBaseline,
sl@0	1380	/** The y-origin of each sprite member bitmap is aligned with the bottom of the
sl@0	1381	line. */
sl@0	1382	ECustomTextCursorAlignBottom
sl@0	1383	};
sl@0	1384
sl@0	1385	//
sl@0	1386	public:
sl@0	1387	IMPORT_C RWsSession();
sl@0	1388	IMPORT_C TInt Connect();
sl@0	1389	IMPORT_C TInt Connect(RFs& aFileServer);
sl@0	1390	IMPORT_C void Close();
sl@0	1391	IMPORT_C TVersion Version() const;
sl@0	1392
sl@0	1393	IMPORT_C TInt SetHotKey(THotKey aType, TUint aKeyCode, TUint aModifierMask, TUint aModifier);
sl@0	1394	IMPORT_C TInt ClearHotKeys(THotKey aType);
sl@0	1395	IMPORT_C TInt RestoreDefaultHotKey(THotKey aType);
sl@0	1396	//
sl@0	1397	IMPORT_C void EventReady(TRequestStatus *aStat);
sl@0	1398	IMPORT_C void EventReadyCancel();
sl@0	1399	IMPORT_C void GetEvent(TWsEvent &aEvent) const;
sl@0	1400	IMPORT_C void PurgePointerEvents();
sl@0	1401	//
sl@0	1402	IMPORT_C void RedrawReady(TRequestStatus *aStat);
sl@0	1403	IMPORT_C void RedrawReadyCancel();
sl@0	1404	IMPORT_C void GetRedraw(TWsRedrawEvent &aEvent);
sl@0	1405	//
sl@0	1406	IMPORT_C void PriorityKeyReady(TRequestStatus *aStat);
sl@0	1407	IMPORT_C void PriorityKeyReadyCancel();
sl@0	1408	IMPORT_C void GetPriorityKey(TWsPriorityKeyEvent &aEvent) const;
sl@0	1409	//
sl@0	1410	IMPORT_C void Flush();
sl@0	1411	IMPORT_C TBool SetAutoFlush(TBool aState);
sl@0	1412	IMPORT_C TInt SetKeyboardRepeatRate(const TTimeIntervalMicroSeconds32 &aInitialTime, const TTimeIntervalMicroSeconds32 &aTime);
sl@0	1413	IMPORT_C void GetKeyboardRepeatRate(TTimeIntervalMicroSeconds32 &aInitialTime, TTimeIntervalMicroSeconds32 &aTime) const;
sl@0	1414	IMPORT_C void GetDoubleClickSettings(TTimeIntervalMicroSeconds32 &aInterval, TInt &aDistance) const;
sl@0	1415	IMPORT_C TInt SetDoubleClick(const TTimeIntervalMicroSeconds32 &aInterval, TInt aDistance);
sl@0	1416	//
sl@0	1417	IMPORT_C TInt NumWindowGroups() const;
sl@0	1418	IMPORT_C TInt WindowGroupList(CArrayFixFlat<TInt> *aWindowList) const;
sl@0	1419	IMPORT_C TInt WindowGroupList(RArray<TWindowGroupChainInfo>* aWindowList) const;
sl@0	1420	IMPORT_C TInt NumWindowGroups(TInt aPriority) const;
sl@0	1421	IMPORT_C TInt WindowGroupList(TInt aPriority, CArrayFixFlat<TInt> *aWindowList) const;
sl@0	1422	IMPORT_C TInt WindowGroupList(TInt aPriority, RArray<TWindowGroupChainInfo>* aWindowList) const;
sl@0	1423	IMPORT_C TInt GetFocusWindowGroup() const;
sl@0	1424	IMPORT_C TInt GetDefaultOwningWindow() const;
sl@0	1425	IMPORT_C TInt SetWindowGroupOrdinalPosition(TInt aIdentifier, TInt aPosition);
sl@0	1426	IMPORT_C TInt GetWindowGroupClientThreadId(TInt aIdentifier, TThreadId &aThreadId) const;
sl@0	1427	IMPORT_C TInt GetWindowGroupHandle(TInt aIdentifier) const;
sl@0	1428	IMPORT_C TInt GetWindowGroupOrdinalPriority(TInt aIdentifier) const;
sl@0	1429	IMPORT_C TInt SendEventToWindowGroup(TInt aIdentifier, const TWsEvent &aEvent);
sl@0	1430	IMPORT_C TInt SendEventToAllWindowGroups(const TWsEvent &aEvent);
sl@0	1431	IMPORT_C TInt SendEventToAllWindowGroups(TInt aPriority, const TWsEvent &aEvent);
sl@0	1432	IMPORT_C TInt SendEventToOneWindowGroupsPerClient(const TWsEvent &aEvent);
sl@0	1433	IMPORT_C TInt GetWindowGroupNameFromIdentifier(TInt aIdentifier, TDes &aWindowName) const;
sl@0	1434	IMPORT_C TInt FindWindowGroupIdentifier(TInt aPreviousIdentifier,const TDesC& aMatch,TInt aOffset=0) const;
sl@0	1435	IMPORT_C TInt FindWindowGroupIdentifier(TInt aPreviousIdentifier,TThreadId aThreadId) const;
sl@0	1436	IMPORT_C TInt SendMessageToWindowGroup(TInt aIdentifier, TUid aUid, const TDesC8 &aParams);
sl@0	1437	IMPORT_C TInt SendMessageToAllWindowGroups(TUid aUid, const TDesC8& aParams);
sl@0	1438	IMPORT_C TInt SendMessageToAllWindowGroups(TInt aPriority, TUid aUid, const TDesC8& aParams);
sl@0	1439	IMPORT_C TInt FetchMessage(TUid &aUid, TPtr8 &aParams, const TWsEvent& aMessageEvent) const;
sl@0	1440	//
sl@0	1441	IMPORT_C void SetShadowVector(const TPoint &aVector);
sl@0	1442	IMPORT_C TPoint ShadowVector() const;
sl@0	1443	//
sl@0	1444	IMPORT_C void SetBackgroundColor(TRgb aColor);
sl@0	1445	IMPORT_C TRgb GetBackgroundColor() const;
sl@0	1446	//
sl@0	1447	IMPORT_C TInt RegisterSurface(TInt aScreenNumber, const TSurfaceId& aSurface);
sl@0	1448	IMPORT_C void UnregisterSurface(TInt aScreenNumber, const TSurfaceId& aSurface);
sl@0	1449	IMPORT_C TInt PreferredSurfaceConfigurationSize() const;
sl@0	1450	//
sl@0	1451	IMPORT_C TInt SetSystemPointerCursor(const RWsPointerCursor &aPointerCursor,TInt aCursorNumber);
sl@0	1452	IMPORT_C void ClearSystemPointerCursor(TInt aCursorNumber);
sl@0	1453	IMPORT_C TInt ClaimSystemPointerCursorList();
sl@0	1454	IMPORT_C void FreeSystemPointerCursorList();
sl@0	1455	//
sl@0	1456	IMPORT_C TInt SetCustomTextCursor(TInt aIdentifier, const TArray<TSpriteMember>& aSpriteMemberArray, TUint aSpriteFlags, TCustomTextCursorAlignment aAlignment);
sl@0	1457	//
sl@0	1458	IMPORT_C TInt ResourceCount() const;
sl@0	1459	IMPORT_C void PasswordEntered();
sl@0	1460	IMPORT_C void ComputeMode(TComputeMode aMode);
sl@0	1461	//
sl@0	1462	IMPORT_C TInt HeapCount() const;
sl@0	1463	IMPORT_C TInt DebugInfo(TInt aFunction, TInt aParam=0) const;
sl@0	1464	IMPORT_C TInt DebugInfo(TInt aFunction, TDes8& aReturnBuf, TInt aParam=0) const;
sl@0	1465	IMPORT_C void HeapSetFail(TInt aTAllocFail,TInt aValue);
sl@0	1466	IMPORT_C void HeapSetBurstFail(TInt aTAllocFail,TInt aRate,TInt aBurst);
sl@0	1467	IMPORT_C TInt SetModifierState(TEventModifier aModifier,TModifierState aState);
sl@0	1468	IMPORT_C TInt GetModifierState() const;
sl@0	1469	//
sl@0	1470	IMPORT_C TInt RequestOffEvents(TBool aOn,RWindowTreeNode *aWin=NULL);
sl@0	1471	IMPORT_C TDisplayMode GetDefModeMaxNumColors(TInt& aColor,TInt& aGray) const;
sl@0	1472	IMPORT_C TInt GetColorModeList(CArrayFixFlat<TInt> *aModeList) const;
sl@0	1473	//
sl@0	1474	IMPORT_C void SetPointerCursorArea(const TRect& aArea);
sl@0	1475	IMPORT_C void SetPointerCursorArea(TInt aScreenSizeMode,const TRect& aArea);
sl@0	1476	IMPORT_C TRect PointerCursorArea() const;
sl@0	1477	IMPORT_C TRect PointerCursorArea(TInt aScreenSizeMode) const;
sl@0	1478	IMPORT_C void SetPointerCursorMode(TPointerCursorMode aMode);
sl@0	1479	IMPORT_C TInt SetClientCursorMode(TPointerCursorMode aMode);
sl@0	1480	IMPORT_C TPointerCursorMode PointerCursorMode() const;
sl@0	1481	IMPORT_C void SetDefaultSystemPointerCursor(TInt aCursorNumber);
sl@0	1482	IMPORT_C void ClearDefaultSystemPointerCursor();
sl@0	1483	IMPORT_C TInt SetPointerCursorPosition(const TPoint& aPosition);
sl@0	1484	IMPORT_C TPoint PointerCursorPosition() const;
sl@0	1485
sl@0	1486	IMPORT_C void SetDefaultFadingParameters(TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0	1487	IMPORT_C void PrepareForSwitchOff();
sl@0	1488	IMPORT_C void SetBufferSizeL(TInt aBufSize);
sl@0	1489	IMPORT_C void SetMaxBufferSizeL(TInt aMaxBufSize);
sl@0	1490	IMPORT_C TInt SetSystemFaded(TBool aFaded);
sl@0	1491	IMPORT_C TInt SetSystemFaded(TBool aFaded,TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0	1492
sl@0	1493	// Functions for multiple screens
sl@0	1494	IMPORT_C TInt SetFocusScreen(TInt aScreenNumber);
sl@0	1495	IMPORT_C TInt GetFocusScreen() const;
sl@0	1496	IMPORT_C void ClearAllRedrawStores();
sl@0	1497	IMPORT_C TInt NumWindowGroups(TInt aScreenNumber,TInt aPriority) const;
sl@0	1498	IMPORT_C TInt NumberOfScreens() const;
sl@0	1499	IMPORT_C TInt WindowGroupList(CArrayFixFlat<TInt>* aWindowList,TInt aScreenNumber,TInt aPriority=EAllPriorities) const;
sl@0	1500	IMPORT_C TInt GetFocusWindowGroup(TInt aScreenNumber) const;
sl@0	1501	IMPORT_C TInt GetDefaultOwningWindow(TInt aScreenNumber) const;
sl@0	1502	IMPORT_C TDisplayMode GetDefModeMaxNumColors(TInt aScreenNumber,TInt& aColor,TInt& aGray) const;
sl@0	1503	IMPORT_C TInt GetColorModeList(TInt aScreenNumber,CArrayFixFlat<TInt>* aModeList) const;
sl@0	1504	#if defined(__WINS__)
sl@0	1505	// Function for WINS behaviour only
sl@0	1506	IMPORT_C void SetRemoveKeyCode(TBool aRemove);
sl@0	1507	IMPORT_C void SimulateXyInputType(TInt aInputType); //Only for testing WSERV
sl@0	1508	#endif
sl@0	1509	//
sl@0	1510	IMPORT_C void SimulateRawEvent(TRawEvent aEvent);
sl@0	1511	IMPORT_C void SimulateKeyEvent(TKeyEvent aEvent);
sl@0	1512	IMPORT_C void LogCommand(TLoggingCommand aCommand);
sl@0	1513	IMPORT_C void LogMessage(const TLogMessageText &aMessage);
sl@0	1514
sl@0	1515	// Functions for test code use only
sl@0	1516	IMPORT_C void SystemInfo(TInt &aSystemInfoNumber, SSystemInfo &aSystemInfo);
sl@0	1517	IMPORT_C void TestWrite(TInt aHandle,TInt aOpcode,const TAny *aData, TInt aLength);
sl@0	1518	IMPORT_C void TestWriteReply(TInt aHandle,TInt aOpcode,const TAny *aData, TInt aLength);
sl@0	1519	IMPORT_C void TestWriteReplyP(TInt aHandle,TInt aOpcode,const TAny aData,TInt aLength,TDes8 aReplyPackage);
sl@0	1520	IMPORT_C TInt TestWriteReplyByProvidingRemoteReadAccess(TInt aHandle,TInt aOpcode,const TDesC8& aData,const TDesC8& aRemoteReadBuffer);
sl@0	1521	IMPORT_C TInt TestWriteReplyByProvidingRemoteReadAccess(TInt aHandle,TInt aOpcode,const TDesC8& aData,const TDesC16& aRemoteReadBuffer);
sl@0	1522
sl@0	1523	IMPORT_C TInt Finish();
sl@0	1524	IMPORT_C void SyncMsgBuf();
sl@0	1525
sl@0	1526	// Getters and setters for pointer event's thresholds
sl@0	1527	IMPORT_C TInt SetCloseProximityThresholds(TInt aEnterCloseProximityThreshold, TInt aExitCloseProximityThreshold);
sl@0	1528	IMPORT_C TInt GetEnterCloseProximityThreshold() const;
sl@0	1529	IMPORT_C TInt GetExitCloseProximityThreshold() const;
sl@0	1530	IMPORT_C TInt SetHighPressureThresholds(TInt aEnterHighPressureThreshold, TInt aExitHighPressureThreshold);
sl@0	1531	IMPORT_C TInt GetEnterHighPressureThreshold() const;
sl@0	1532	IMPORT_C TInt GetExitHighPressureThreshold() const;
sl@0	1533	//
sl@0	1534	IMPORT_C void EnableWindowSizeCacheL();
sl@0	1535	IMPORT_C void SendEffectCommand(TInt aTfxCmd, const TDesC8& aTfxCmdData=KNullDesC8);
sl@0	1536
sl@0	1537	// Registering/Unregistering of TFX effect, to allow animations to be associated with each transition
sl@0	1538	IMPORT_C void RegisterEffect(TInt aAction, TInt aPurpose, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TUint aAppUid=0, TBitFlags aFlags=0);
sl@0	1539	IMPORT_C void UnregisterEffect(TInt aAction, TInt aPurpose, TUint aAppUid=0);
sl@0	1540	IMPORT_C void UnregisterAllEffects();
sl@0	1541	IMPORT_C void OverrideEffects(TInt aAction, TInt aPurpose, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TBitFlags aFlags=0);
sl@0	1542
sl@0	1543	//Application tells the window server the orientation of rendering it intends to use
sl@0	1544	IMPORT_C void IndicateAppOrientation(TRenderOrientation aOrientation);
sl@0	1545
sl@0	1546	// functions not exported, used by CWsGraphic
sl@0	1547	void GraphicMessageReady(TRequestStatus *aStat);
sl@0	1548	void GetGraphicMessage(TDes8& aData) const;
sl@0	1549	void GraphicMessageCancel();
sl@0	1550	void GraphicAbortMessage(TInt aError);
sl@0	1551	TInt GraphicFetchHeaderMessage();
sl@0	1552	private:
sl@0	1553	TInt doWindowGroupList(TInt aPriority, RArray<TWindowGroupChainInfo>* aWindowListCh, TInt aNumOpcode, TInt aListOpcode) const;
sl@0	1554	TInt doWindowGroupList(TInt aScreenNumber, TInt aPriority, CArrayFixFlat<TInt>* aWindowListId, TInt aNumOpcode, TInt aListOpcode) const;
sl@0	1555	TInt doSetHotKey(TInt aOpcode, TInt aType, TUint aKeycode, TUint aModifierMask, TUint aModifiers);
sl@0	1556	void doReadEvent(TRequestStatus *aStat, TInt aOpcode);
sl@0	1557
sl@0	1558	private:
sl@0	1559	void connectL();
sl@0	1560	TInt DoFlush(const TIpcArgs& aIpcArgs);
sl@0	1561	TInt DoSyncMsgBuf(const TIpcArgs& aIpcArgs);
sl@0	1562	void DirectAcessActivation(TBool aIsNowActive);
sl@0	1563	};
sl@0	1564
sl@0	1565	class RWindowGroup;
sl@0	1566	class RWsSprite;
sl@0	1567
sl@0	1568
sl@0	1569	class RWindowTreeNode : public MWsClientClass
sl@0	1570	/** A handle to a node in the server-side window tree.
sl@0	1571
sl@0	1572	This handle class is used as the base for both window groups and the windows
sl@0	1573	within them; it is not intended for user derivation, and may not be directly
sl@0	1574	constructed: use one of the standard derived classes instead.
sl@0	1575
sl@0	1576	@publishedAll
sl@0	1577	@released */
sl@0	1578	{
sl@0	1579	friend class RWindowGroup;
sl@0	1580	friend class RWindowBase;
sl@0	1581	friend class CWindowGc;
sl@0	1582	friend class RAnimDll;
sl@0	1583	friend class RWsSprite;
sl@0	1584	public:
sl@0	1585	/** Fade control flags.
sl@0	1586
sl@0	1587	These flags define whether fading is applied to all child windows when SetFaded()
sl@0	1588	is called on a window. */
sl@0	1589	enum TFadeControl
sl@0	1590	{
sl@0	1591	/** Include all child windows when fading/un-fading. */
sl@0	1592	EFadeIncludeChildren=ETrue,
sl@0	1593	/** Fade only the parent window.
sl@0	1594
sl@0	1595	Note that a panic will occur if this value is used when SetFaded() is called
sl@0	1596	on a window group. */
sl@0	1597	EFadeWindowOnly=EFalse,
sl@0	1598	};
sl@0	1599	protected:
sl@0	1600	RWindowTreeNode();
sl@0	1601	RWindowTreeNode(RWsSession &aWs);
sl@0	1602	public:
sl@0	1603	IMPORT_C void Close();
sl@0	1604	IMPORT_C void Destroy();
sl@0	1605	IMPORT_C TUint32 ClientHandle() const;
sl@0	1606	IMPORT_C TUint32 Parent() const;
sl@0	1607	IMPORT_C TUint32 PrevSibling() const;
sl@0	1608	IMPORT_C TUint32 NextSibling() const;
sl@0	1609	IMPORT_C TUint32 Child() const;
sl@0	1610	IMPORT_C TInt OrdinalPriority() const;
sl@0	1611	IMPORT_C TInt OrdinalPosition() const;
sl@0	1612	IMPORT_C TInt FullOrdinalPosition() const;
sl@0	1613	IMPORT_C void SetOrdinalPosition(TInt aPos);
sl@0	1614	IMPORT_C void SetOrdinalPosition(TInt aPos,TInt aOrdinalPriority);
sl@0	1615	IMPORT_C TInt ScreenNumber() const;
sl@0	1616	IMPORT_C TInt WindowGroupId() const;
sl@0	1617	IMPORT_C TInt SetPointerCursor(TInt aCursorNumber);
sl@0	1618	IMPORT_C void SetCustomPointerCursor(const RWsPointerCursor &aPointerCursor);
sl@0	1619	IMPORT_C TInt EnableOnEvents(TEventControl aCircumstances=EEventControlOnlyWithKeyboardFocus);
sl@0	1620	IMPORT_C void DisableOnEvents();
sl@0	1621	IMPORT_C TInt EnableGroupChangeEvents();
sl@0	1622	IMPORT_C void DisableGroupChangeEvents();
sl@0	1623	IMPORT_C TInt EnableFocusChangeEvents();
sl@0	1624	IMPORT_C void DisableFocusChangeEvents();
sl@0	1625	IMPORT_C TInt EnableGroupListChangeEvents();
sl@0	1626	IMPORT_C void DisableGroupListChangeEvents();
sl@0	1627	IMPORT_C TInt EnableVisibilityChangeEvents();
sl@0	1628	IMPORT_C void DisableVisibilityChangeEvents();
sl@0	1629	IMPORT_C TInt EnableErrorMessages(TEventControl aCircumstances);
sl@0	1630	IMPORT_C void DisableErrorMessages();
sl@0	1631	IMPORT_C TInt EnableModifierChangedEvents(TUint aModifierMask, TEventControl aCircumstances);
sl@0	1632	IMPORT_C void DisableModifierChangedEvents();
sl@0	1633	IMPORT_C void SetNonFading(TBool aNonFading);
sl@0	1634	IMPORT_C void SetFaded(TBool aFaded,TFadeControl aIncludeChildren);
sl@0	1635	IMPORT_C void SetFaded(TBool aFaded,TFadeControl aIncludeChildren,TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0	1636	IMPORT_C void ClearPointerCursor();
sl@0	1637	IMPORT_C RWsSession* Session() const;
sl@0	1638	protected:
sl@0	1639	__DECLARE_TEST;
sl@0	1640	};
sl@0	1641
sl@0	1642
sl@0	1643	class TSurfaceId;
sl@0	1644	class TSurfaceConfiguration;
sl@0	1645
sl@0	1646	class RWindowBase : public RWindowTreeNode
sl@0	1647	/** Client-side handle to a server-side window.
sl@0	1648
sl@0	1649	The server-side windows of handles derived from this class can be displayed
sl@0	1650	on the device's screen, and associated with pointer events.
sl@0	1651
sl@0	1652	This class is not for user derivation; however derived classes form part of
sl@0	1653	the Window Server API.
sl@0	1654
sl@0	1655	@publishedAll
sl@0	1656	@released */
sl@0	1657	{
sl@0	1658	public:
sl@0	1659	/** Capture behaviour flags.
sl@0	1660
sl@0	1661	@see SetPointerCapture()
sl@0	1662	@see EEventDragDrop */
sl@0	1663	enum TCaptureFlags
sl@0	1664	{
sl@0	1665	// Flags, these can be combined to customise pointer capture
sl@0	1666	/** If set, capture is enabled, disabled otherwise. */
sl@0	1667	TCaptureFlagEnabled=0x01,
sl@0	1668	/** If set, drag-drop events are sent to the window in which the pointer was lifted.
sl@0	1669	Drag-drop is a tap-drag-lift sequence. */
sl@0	1670	TCaptureFlagDragDrop=0x02,
sl@0	1671	/** Capture events from windows belonging to any group, not just the group of the
sl@0	1672	window on which the flag was set */
sl@0	1673	TCaptureFlagAllGroups=0x04,
sl@0	1674	// States, made up of a set of flags
sl@0	1675	/** Equivalent to disabling all the above flags. */
sl@0	1676	TCaptureDisabled=0,
sl@0	1677	/** Equivalent to TCaptureFlagEnabled. */
sl@0	1678	TCaptureEnabled=TCaptureFlagEnabled,
sl@0	1679	/** Equivalent to the OR of the first three flags. */
sl@0	1680	TCaptureDragDrop=TCaptureFlagEnabled\|TCaptureFlagDragDrop\|TCaptureFlagAllGroups,
sl@0	1681	};
sl@0	1682	protected:
sl@0	1683	RWindowBase();
sl@0	1684	RWindowBase(RWsSession &aWs);
sl@0	1685	public:
sl@0	1686	IMPORT_C void Activate();
sl@0	1687	IMPORT_C void SetPosition(const TPoint &point);
sl@0	1688	IMPORT_C TInt SetSizeErr(const TSize &size);
sl@0	1689	IMPORT_C TInt SetExtentErr(const TPoint &point,const TSize &size);
sl@0	1690	IMPORT_C TSize Size() const;
sl@0	1691	IMPORT_C TPoint InquireOffset(const RWindowTreeNode &aWindow) const;
sl@0	1692	IMPORT_C void PointerFilter(TUint32 aFilterMask, TUint32 aFilter);
sl@0	1693	IMPORT_C void SetPointerGrab(TBool aState);
sl@0	1694	IMPORT_C void ClaimPointerGrab(TBool aSendUpEvent=ETrue);
sl@0	1695	IMPORT_C TInt ClaimPointerGrab(const TUint8 aPointerNumber, const TBool aSendUpEvent=ETrue);
sl@0	1696	IMPORT_C void SetPointerCapture(TInt aFlags);
sl@0	1697	IMPORT_C void SetPointerCapturePriority(TInt aPriority);
sl@0	1698	IMPORT_C TInt GetPointerCapturePriority() const;
sl@0	1699	IMPORT_C void SetVisible(TBool aState);
sl@0	1700	IMPORT_C void SetShadowHeight(TInt aHeight);
sl@0	1701	IMPORT_C void SetShadowDisabled(TBool aState);
sl@0	1702	IMPORT_C TPoint Position() const;
sl@0	1703	IMPORT_C TPoint AbsPosition() const;
sl@0	1704	IMPORT_C TInt SetCornerType(TCornerType aCornerType, TInt aCornerFlags=0);
sl@0	1705	IMPORT_C TInt SetShape(const TRegion &aRegion);
sl@0	1706	IMPORT_C TInt SetRequiredDisplayMode(TDisplayMode aMode);
sl@0	1707	IMPORT_C TDisplayMode DisplayMode() const;
sl@0	1708	IMPORT_C void EnableBackup(TUint aBackupType=EWindowBackupAreaBehind);
sl@0	1709	IMPORT_C void RequestPointerRepeatEvent(TTimeIntervalMicroSeconds32 aTime,const TRect &aRect);
sl@0	1710	IMPORT_C void CancelPointerRepeatEventRequest();
sl@0	1711	IMPORT_C TInt RequestPointerRepeatEvent(TTimeIntervalMicroSeconds32 aTime,const TRect &aRect, const TUint8 aPointerNumber); //< @prototype
sl@0	1712	IMPORT_C TInt CancelPointerRepeatEventRequest(const TUint8 aPointerNumber); //< @prototype
sl@0	1713	IMPORT_C TInt AllocPointerMoveBuffer(TInt aMaxPoints, TUint aFlags);
sl@0	1714	IMPORT_C void FreePointerMoveBuffer();
sl@0	1715	IMPORT_C void EnablePointerMoveBuffer();
sl@0	1716	IMPORT_C void DisablePointerMoveBuffer();
sl@0	1717	IMPORT_C TInt RetrievePointerMoveBuffer(TDes8 &aBuf) const;
sl@0	1718	IMPORT_C void DiscardPointerMoveBuffer();
sl@0	1719	IMPORT_C TInt AddKeyRect(const TRect &aRect, TInt aScanCode, TBool aActivatedByPointerSwitchOn);
sl@0	1720	IMPORT_C void RemoveAllKeyRects();
sl@0	1721	IMPORT_C TInt PasswordWindow(TPasswordMode aPasswordMode);
sl@0	1722	IMPORT_C void FadeBehind(TBool aFade);
sl@0	1723	IMPORT_C TBool IsFaded() const;
sl@0	1724	IMPORT_C TBool IsNonFading() const;
sl@0	1725	IMPORT_C TInt MoveToGroup(TInt aIdentifier);
sl@0	1726	IMPORT_C TInt SetBackgroundSurface(const TSurfaceId& aSurface);
sl@0	1727	IMPORT_C TInt SetBackgroundSurface(const TSurfaceConfiguration& aConfiguration, TBool aTriggerRedraw);
sl@0	1728	IMPORT_C void RemoveBackgroundSurface(TBool aTriggerRedraw);
sl@0	1729	IMPORT_C TInt GetBackgroundSurface(TSurfaceConfiguration& aConfiguration) const;
sl@0	1730	IMPORT_C void SetSurfaceTransparency(TBool aSurfaceTransparency);
sl@0	1731	IMPORT_C TRgb KeyColor() const;
sl@0	1732	IMPORT_C void EnableAdvancedPointers();
sl@0	1733	IMPORT_C void SetPurpose(TInt aPurpose);
sl@0	1734	IMPORT_C void SendEffectCommand(TInt aTfxCmd, const TDesC8& aTfxCmdData=KNullDesC8);
sl@0	1735	IMPORT_C void OverrideEffects(TInt aAction, const TFileName& aResourceDir, const TFileName& aFilenameOutgoing, const TFileName& aFilenameIncoming, TBitFlags aFlags=0);
sl@0	1736	IMPORT_C TInt FixNativeOrientation();
sl@0	1737	IMPORT_C TSize SizeForEgl() const;
sl@0	1738	protected:
sl@0	1739	TInt construct(const RWindowTreeNode &parent,TUint32 aHandle, TInt aType, TDisplayMode aDisplayMode);
sl@0	1740	};
sl@0	1741
sl@0	1742
sl@0	1743	class RBlankWindow : public RWindowBase
sl@0	1744	/** Blank window.
sl@0	1745
sl@0	1746	A blank window may have its extent and colour changed, but nothing else may
sl@0	1747	be drawn to it. Blank windows provide no functionality that is not provided
sl@0	1748	by the RWindow class. However, they are useful when the application requires
sl@0	1749	a window that cannot be drawn to, for example a container window.
sl@0	1750
sl@0	1751	@publishedAll
sl@0	1752	@released */
sl@0	1753	{
sl@0	1754	public:
sl@0	1755	IMPORT_C RBlankWindow();
sl@0	1756	IMPORT_C RBlankWindow(RWsSession &aWs);
sl@0	1757	IMPORT_C TInt Construct(const RWindowTreeNode &parent, TUint32 aHandle);
sl@0	1758	IMPORT_C void SetColor(TRgb aColor);
sl@0	1759	IMPORT_C void SetColor();
sl@0	1760	IMPORT_C void SetSize(const TSize &size);
sl@0	1761	IMPORT_C void SetExtent(const TPoint &point,const TSize &size);
sl@0	1762	};
sl@0	1763
sl@0	1764
sl@0	1765	class RDrawableWindow : public RWindowBase
sl@0	1766	/** Handle to a drawable window.
sl@0	1767
sl@0	1768	This class cannot be constructed directly.
sl@0	1769	The two concrete derived classes, RWindow and RBackedUpWindow, allow
sl@0	1770	drawing but use different protocols because RWindow relies on the client to
sl@0	1771	redraw invalid areas.
sl@0	1772
sl@0	1773	@publishedAll
sl@0	1774	@released */
sl@0	1775	{
sl@0	1776	protected:
sl@0	1777	RDrawableWindow();
sl@0	1778	RDrawableWindow(RWsSession &aWs);
sl@0	1779	public:
sl@0	1780	IMPORT_C void Scroll(const TPoint &aOffset);
sl@0	1781	IMPORT_C void Scroll(const TRect &aClipRect, const TPoint &aOffset);
sl@0	1782	IMPORT_C void Scroll(const TPoint &aOffset, const TRect &aRect);
sl@0	1783	IMPORT_C void Scroll(const TRect &aClipRect, const TPoint &aOffset, const TRect &aRect);
sl@0	1784	IMPORT_C TRect GetDrawRect() const;
sl@0	1785	protected:
sl@0	1786	void SetDrawRect(const TRect &aRect);
sl@0	1787	private:
sl@0	1788	void doScroll(const TRect &aClipRect, const TPoint &aOffset, const TRect &aRect, TInt aOpcode);
sl@0	1789
sl@0	1790	TRect iDrawRect;
sl@0	1791	};
sl@0	1792
sl@0	1793	/** Transparency policies
sl@0	1794
sl@0	1795	These policies are to control the behaviour of a transparent window.
sl@0	1796	@publishedAll
sl@0	1797	@released
sl@0	1798	@see RWindow::SetTransparencyPolicy() */
sl@0	1799	enum TWsTransparencyPolicy {
sl@0	1800	/** Default behaviour. */
sl@0	1801	ETransparencyDefault,
sl@0	1802	/** Freeze the content of underneath the transparent window to prevent redraw everytime
sl@0	1803	the overlying window changes. */
sl@0	1804	ETransparencyFreezeUnder,
sl@0	1805	};
sl@0	1806
sl@0	1807	class RWindow : public RDrawableWindow
sl@0	1808	/** Handle to a standard window.
sl@0	1809
sl@0	1810	An RWindow is a handle to a server-side window which can be displayed and
sl@0	1811	drawn to, and whose redraws are performed by the application.
sl@0	1812
sl@0	1813	@publishedAll
sl@0	1814	@released */
sl@0	1815	{
sl@0	1816	public:
sl@0	1817	IMPORT_C RWindow();
sl@0	1818	IMPORT_C RWindow(RWsSession &aWs);
sl@0	1819	IMPORT_C TInt Construct(const RWindowTreeNode &parent,TUint32 aHandle);
sl@0	1820	IMPORT_C void BeginRedraw();
sl@0	1821	IMPORT_C void BeginRedraw(const TRect &aRect);
sl@0	1822	IMPORT_C void EndRedraw();
sl@0	1823	IMPORT_C void Invalidate();
sl@0	1824	IMPORT_C void Invalidate(const TRect &aRect);
sl@0	1825	IMPORT_C void GetInvalidRegion(RRegion &aRegion) const;
sl@0	1826	IMPORT_C void SetBackgroundColor(TRgb aColor);
sl@0	1827	IMPORT_C void SetBackgroundColor();
sl@0	1828	IMPORT_C void SetSize(const TSize &size);
sl@0	1829	IMPORT_C void SetExtent(const TPoint &point,const TSize &size);
sl@0	1830	IMPORT_C void HandleTransparencyUpdate();
sl@0	1831	IMPORT_C TInt SetTransparencyFactor(const TRgb& aTransparencyFactor);
sl@0	1832	IMPORT_C TInt SetTransparencyBitmap(const CFbsBitmap& aTransparencyBitmap);
sl@0	1833	IMPORT_C TInt SetTransparencyWsBitmap(const CWsBitmap& aTransparencyBitmap);
sl@0	1834	IMPORT_C void SetNonTransparent();
sl@0	1835	IMPORT_C void EnableRedrawStore(TBool aEnabled);
sl@0	1836	IMPORT_C TInt SetTransparencyAlphaChannel();
sl@0	1837	IMPORT_C TInt SetTransparentRegion(const TRegion& aRegion);
sl@0	1838	IMPORT_C TInt SetTransparencyPolicy(TWsTransparencyPolicy aPolicy);
sl@0	1839	IMPORT_C TBool IsRedrawStoreEnabled() const;
sl@0	1840	IMPORT_C void EnableOSB(TBool);
sl@0	1841	IMPORT_C void ClearRedrawStore();
sl@0	1842	};
sl@0	1843
sl@0	1844
sl@0	1845	class RBackedUpWindow : public RDrawableWindow
sl@0	1846	/** Client-side handle to a drawable window with a backup bitmap.
sl@0	1847
sl@0	1848	A backed-up window is associated with a backup bitmap which retains the contents
sl@0	1849	of the window. When an area of the window is invalidated, the window server
sl@0	1850	uses the bitmap directly to update the window without requiring an application
sl@0	1851	redraw. The backup bitmap is owned by the font and bitmap server and resides
sl@0	1852	on the font and bitmap server's shared heap, which is accessible to all client
sl@0	1853	programs: functions are provided to allow the client application to access
sl@0	1854	this bitmap directly and perform updates to the window under application control.
sl@0	1855
sl@0	1856	@publishedAll
sl@0	1857	@deprecated
sl@0	1858	*/
sl@0	1859	{
sl@0	1860	public:
sl@0	1861	IMPORT_C RBackedUpWindow();
sl@0	1862	IMPORT_C RBackedUpWindow(RWsSession &aWs);
sl@0	1863	IMPORT_C TInt Construct(const RWindowTreeNode &parent,TDisplayMode aDisplayMode, TUint32 aHandle);
sl@0	1864	IMPORT_C TInt BitmapHandle() const;
sl@0	1865	IMPORT_C void UpdateScreen();
sl@0	1866	IMPORT_C void UpdateScreen(const TRegion &aRegion);
sl@0	1867	IMPORT_C void UpdateBackupBitmap();
sl@0	1868	IMPORT_C void MaintainBackup();
sl@0	1869	};
sl@0	1870
sl@0	1871
sl@0	1872	class RWindowGroup : public RWindowTreeNode
sl@0	1873	/** Client-side handle to a server-side window group.
sl@0	1874
sl@0	1875	@publishedAll
sl@0	1876	@released */
sl@0	1877	{
sl@0	1878	public:
sl@0	1879	IMPORT_C RWindowGroup();
sl@0	1880	IMPORT_C RWindowGroup(RWsSession &aWs);
sl@0	1881	IMPORT_C TInt Construct(TUint32 aClientHandle);
sl@0	1882	IMPORT_C TInt Construct(TUint32 aClientHandle,CWsScreenDevice* aScreenDevice);
sl@0	1883	IMPORT_C TInt Construct(TUint32 aClientHandle,TBool aIsFocusable,CWsScreenDevice* aScreenDevice);
sl@0	1884	IMPORT_C TInt Construct(TUint32 aClientHandle,TBool aIsFocusable);
sl@0	1885	IMPORT_C TInt ConstructChildApp(TInt aIdOfParentWindowGroup,TUint32 aClientHandle);
sl@0	1886	IMPORT_C TInt ConstructChildApp(TInt aIdOfParentWindowGroup,TUint32 aClientHandle,TBool aIsFocusable);
sl@0	1887	IMPORT_C void AllowProcessToCreateChildWindowGroups(TUid aProcessSID);
sl@0	1888	IMPORT_C void EnableReceiptOfFocus(TBool aState);
sl@0	1889	IMPORT_C void AutoForeground(TBool aState);
sl@0	1890	IMPORT_C void SetOrdinalPriorityAdjust(TInt aAdjust);
sl@0	1891	IMPORT_C TInt SetOrdinalPositionErr(TInt aPos,TInt aOrdinalPriority);
sl@0	1892	IMPORT_C TInt32 CaptureKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);
sl@0	1893	IMPORT_C TInt32 CaptureKey(TUint aKeycode, TUint aModifierMask, TUint aModifier, TInt aPriority);
sl@0	1894	IMPORT_C void CancelCaptureKey(TInt32 aCaptureKey);
sl@0	1895	IMPORT_C TInt32 CaptureKeyUpAndDowns(TUint aScanCode, TUint aModifierMask, TUint aModifier);
sl@0	1896	IMPORT_C TInt32 CaptureKeyUpAndDowns(TUint aScanCode, TUint aModifierMask, TUint aModifier, TInt aPriority);
sl@0	1897	IMPORT_C void CancelCaptureKeyUpAndDowns(TInt32 aCaptureKey);
sl@0	1898	IMPORT_C TInt32 CaptureLongKey(TUint aInputKeyCode,TUint aOutputKeyCode,TUint aModifierMask,TUint aModifier
sl@0	1899	,TInt aPriority,TUint aFlags);
sl@0	1900	IMPORT_C TInt32 CaptureLongKey(TTimeIntervalMicroSeconds32 aRepeatTime,TUint aInputKeyCode,TUint aOutputKeyCode
sl@0	1901	,TUint aModifierMask,TUint aModifier,TInt aPriority,TUint aFlags);
sl@0	1902	IMPORT_C void CancelCaptureLongKey(TInt32 aCaptureKey);
sl@0	1903	IMPORT_C TInt AddPriorityKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);
sl@0	1904	IMPORT_C void RemovePriorityKey(TUint aKeycode, TUint aModifierMask, TUint aModifier);
sl@0	1905	IMPORT_C void SetTextCursor(RWindowBase &aWin, const TPoint &aPos, const TTextCursor &aCursor);
sl@0	1906	IMPORT_C void SetTextCursor(RWindowBase &aWin, const TPoint &aPos, const TTextCursor &aCursor, const TRect &aClipRect);
sl@0	1907	IMPORT_C void CancelTextCursor();
sl@0	1908	IMPORT_C void SetOwningWindowGroup(TInt aIdentifier);
sl@0	1909	IMPORT_C void DefaultOwningWindow();
sl@0	1910	IMPORT_C TInt SetName(const TDesC &aName);
sl@0	1911	IMPORT_C TInt Name(TDes &aWindowName) const;
sl@0	1912	IMPORT_C TInt Identifier() const;
sl@0	1913	IMPORT_C void DisableKeyClick(TBool aState);
sl@0	1914	IMPORT_C TInt EnableScreenChangeEvents();
sl@0	1915	IMPORT_C void DisableScreenChangeEvents();
sl@0	1916	IMPORT_C void SimulatePointerEvent(TRawEvent aEvent);
sl@0	1917	IMPORT_C void SimulateAdvancedPointerEvent(TRawEvent aEvent);
sl@0	1918	IMPORT_C TInt ClearChildGroup();
sl@0	1919	IMPORT_C TInt SetChildGroup(TInt aId);
sl@0	1920	private:
sl@0	1921	TInt32 doCaptureKey(TUint aKey, TUint aModifierMask, TUint aModifiers, TInt aPriority, TInt aOpcode);
sl@0	1922	void doCancelCaptureKey(TInt32 aCaptureKeyHandle, TInt aOpcode);
sl@0	1923	TInt Construct(TInt aIdOfParentWindowGroup, TUint32 aClientHandle, TBool aIsFocusable, CWsScreenDevice* aScreenDevice);
sl@0	1924	};
sl@0	1925
sl@0	1926
sl@0	1927	class CWsBitmap : public CFbsBitmap, public MWsClientClass
sl@0	1928	/** Window server bitmap.
sl@0	1929
sl@0	1930	This is a bitmap to which the window server already has a handle. Functions
sl@0	1931	which take a window server bitmap are faster than equivalent functions which
sl@0	1932	take a CFbsBitmap.
sl@0	1933
sl@0	1934	@publishedAll
sl@0	1935	@released */
sl@0	1936	{
sl@0	1937	public:
sl@0	1938	IMPORT_C CWsBitmap();
sl@0	1939	IMPORT_C CWsBitmap(RWsSession &aWs);
sl@0	1940	IMPORT_C ~CWsBitmap();
sl@0	1941	IMPORT_C TInt Create(const TSize& aSizeInPixels,TDisplayMode aDispMode);
sl@0	1942	IMPORT_C TInt Duplicate(TInt aHandle);
sl@0	1943	IMPORT_C TInt Load(const TDesC& aFileName,TInt32 aId,TBool aShareIfLoaded=ETrue);
sl@0	1944	IMPORT_C void InternalizeL(RReadStream& aStream);
sl@0	1945	IMPORT_C void Reset();
sl@0	1946	private:
sl@0	1947	TInt createWsBitmap(TInt aErr);
sl@0	1948	};
sl@0	1949
sl@0	1950	class RWsGraphicMsgBuf;
sl@0	1951
sl@0	1952	class TWsGraphicMsgFixedBase
sl@0	1953	/** Base class for fixed-size messages to be attached to CWindowGc::DrawWsGraphic commands
sl@0	1954	@publishedAll
sl@0	1955	@released
sl@0	1956	*/ {
sl@0	1957	public:
sl@0	1958	IMPORT_C TPtrC8 Pckg() const;
sl@0	1959	IMPORT_C TUid TypeId() const;
sl@0	1960	IMPORT_C TInt Size() const;
sl@0	1961	protected:
sl@0	1962	IMPORT_C TWsGraphicMsgFixedBase(TUid aTypeId,TInt aSizeOfDerived);
sl@0	1963	private:
sl@0	1964	const TUid iTypeId;
sl@0	1965	const TInt iSize;
sl@0	1966	};
sl@0	1967
sl@0	1968	class RWsGraphicMsgBuf: private RBuf8
sl@0	1969	/** Utility class for building data buffers to be attached to CWindowGc::DrawWsGraphic commands
sl@0	1970	Useful when there is more than one piece of data to be attached to the draw command
sl@0	1971	@publishedAll
sl@0	1972	@released */
sl@0	1973	{
sl@0	1974	public:
sl@0	1975	IMPORT_C RWsGraphicMsgBuf();
sl@0	1976	using RBuf8::Close;
sl@0	1977	using RBuf8::CleanupClosePushL;
sl@0	1978	IMPORT_C TInt Append(TUid aTypeId,const TDesC8& aData);
sl@0	1979	IMPORT_C TInt Append(TUid aTypeId,const TDesC16& aData);
sl@0	1980	IMPORT_C TInt Append(TUid aTypeId,TInt aLen,TPtr8& aPtr);
sl@0	1981	IMPORT_C TInt Append(const TWsGraphicMsgFixedBase& aMsg);
sl@0	1982	IMPORT_C void Remove(TInt aIndex);
sl@0	1983	IMPORT_C TInt Count() const;
sl@0	1984	IMPORT_C TUid TypeId(TInt aIndex) const;
sl@0	1985	IMPORT_C TPtrC8 Data(TInt aIndex) const;
sl@0	1986	IMPORT_C TPtr8 Data(TInt aIndex);
sl@0	1987	IMPORT_C void GetFixedMsg(TWsGraphicMsgFixedBase& aMsg,TInt aIndex) const;
sl@0	1988	IMPORT_C const TDesC8& Pckg() const;
sl@0	1989	private:
sl@0	1990	TInt ExpandForAppend(TInt aDataLen);
sl@0	1991	void WriteHeader(TUid aUid,TInt aLen);
sl@0	1992	TInt IntAt(TInt aOfs) const;
sl@0	1993	private:
sl@0	1994	TInt iRMsgBufSpare[2];
sl@0	1995	};
sl@0	1996
sl@0	1997
sl@0	1998	class CWindowGc : public CBitmapContext, public MWsClientClass
sl@0	1999	/** Window graphics context.
sl@0	2000
sl@0	2001	Most window graphics context drawing functions map to equivalent CFbsBitGc
sl@0	2002	functions. They are implemented on the screen with any co-ordinates being
sl@0	2003	relative to the top left corner of the window. However extra clipping is applied.
sl@0	2004	The drawing will always be clipped to the visible part of the window. In addition
sl@0	2005	it will be clipped to the non-invalid part if you are not doing a redraw and
sl@0	2006	to the region being validated if you are doing a redraw.
sl@0	2007
sl@0	2008	Note:
sl@0	2009
sl@0	2010	In general, server side functions which encounter conditions which would normally
sl@0	2011	cause a leave, do not leave but instead return an error value indicating the
sl@0	2012	leave condition. In this way the leave can be handled on the appropriate side
sl@0	2013	of the client/server boundary. For example, a client can choose to wrap server
sl@0	2014	calls with User::LeaveIfError(), which causes a leave with the specified
sl@0	2015	error.
sl@0	2016
sl@0	2017	The above advice is true of many functions in this class, and in its derived
sl@0	2018	classes.
sl@0	2019
sl@0	2020	@publishedAll
sl@0	2021	@released
sl@0	2022	@see CGraphicsContext */
sl@0	2023	{
sl@0	2024	friend class CWsScreenDevice;
sl@0	2025	public:
sl@0	2026	/** Defines possible clockwise rotation values.
sl@0	2027
sl@0	2028	WARNING: Enum for internal and partner use ONLY. Compatibility is not guaranteed in future releases.
sl@0	2029
sl@0	2030	@prototype
sl@0	2031	*/
sl@0	2032	enum TGraphicsRotation
sl@0	2033	{
sl@0	2034	/** No rotation. */
sl@0	2035	EGraphicsRotationNone,
sl@0	2036	/** A 90 degree rotation. */
sl@0	2037	EGraphicsRotation90,
sl@0	2038	/** A 180 degree rotation. */
sl@0	2039	EGraphicsRotation180,
sl@0	2040	/** A 270 degree rotation. */
sl@0	2041	EGraphicsRotation270
sl@0	2042	};
sl@0	2043
sl@0	2044	IMPORT_C CWindowGc(CWsScreenDevice *aDevice);
sl@0	2045	IMPORT_C virtual ~CWindowGc();
sl@0	2046	IMPORT_C virtual TInt Construct();
sl@0	2047	IMPORT_C virtual void Activate(RDrawableWindow &aDevice);
sl@0	2048	IMPORT_C virtual void Deactivate();
sl@0	2049	//====================FROM CGraphicsContext.H===============================
sl@0	2050	IMPORT_C virtual CGraphicsDevice* Device() const;
sl@0	2051	IMPORT_C virtual void SetOrigin(const TPoint &aPoint=TPoint(0,0));
sl@0	2052	IMPORT_C virtual void SetDrawMode(TDrawMode aDrawingMode);
sl@0	2053	IMPORT_C virtual void SetClippingRect(const TRect& aRect);
sl@0	2054	IMPORT_C virtual void CancelClippingRect();
sl@0	2055	IMPORT_C virtual void Reset();
sl@0	2056
sl@0	2057	IMPORT_C virtual void UseFont(const CFont *aFont);
sl@0	2058	IMPORT_C virtual void DiscardFont();
sl@0	2059	IMPORT_C virtual void SetUnderlineStyle(TFontUnderline aUnderlineStyle);
sl@0	2060	IMPORT_C virtual void SetStrikethroughStyle(TFontStrikethrough aStrikethroughStyle);
sl@0	2061	// Used to do justified text properly
sl@0	2062	IMPORT_C virtual void SetWordJustification(TInt aExcessWidth,TInt aNumGaps);
sl@0	2063	// Used primarily to get accurate WYSIWYG
sl@0	2064	IMPORT_C virtual void SetCharJustification(TInt aExcessWidth,TInt aNumChars);
sl@0	2065
sl@0	2066	IMPORT_C virtual void SetPenColor(const TRgb &aColor);
sl@0	2067	IMPORT_C virtual void SetPenStyle(TPenStyle aPenStyle);
sl@0	2068	IMPORT_C virtual void SetPenSize(const TSize& aSize);
sl@0	2069
sl@0	2070	IMPORT_C virtual void SetBrushColor(const TRgb &aColor);
sl@0	2071	IMPORT_C virtual void SetBrushStyle(TBrushStyle aBrushStyle);
sl@0	2072	IMPORT_C virtual void SetBrushOrigin(const TPoint &aOrigin);
sl@0	2073	IMPORT_C virtual void UseBrushPattern(const CFbsBitmap *aDevice);
sl@0	2074	IMPORT_C virtual void DiscardBrushPattern();
sl@0	2075	//
sl@0	2076	// Move the internal position, as used by DrawLineTo & DrawLineBy, and set by MoveTo,
sl@0	2077	// MoveBy, DrawLine, DrawLineTo, DrawLineBy and DrawPolyline
sl@0	2078	IMPORT_C virtual void MoveTo(const TPoint &aPoint);
sl@0	2079	IMPORT_C virtual void MoveBy(const TPoint &aPoint);
sl@0	2080	IMPORT_C virtual void Plot(const TPoint &aPoint);
sl@0	2081	//
sl@0	2082	// Line drawing subject to pen color, width and style and draw mode
sl@0	2083	IMPORT_C virtual void DrawArc(const TRect &aRect,const TPoint &aStart,const TPoint &aEnd);
sl@0	2084	IMPORT_C virtual void DrawLine(const TPoint &aPoint1,const TPoint &aPoint2);
sl@0	2085	IMPORT_C virtual void DrawLineTo(const TPoint &aPoint);
sl@0	2086	IMPORT_C virtual void DrawLineBy(const TPoint &aPoint);
sl@0	2087	IMPORT_C virtual void DrawPolyLine(const CArrayFix<TPoint> *aPointList);
sl@0	2088	IMPORT_C virtual void DrawPolyLine(const TPoint* aPointList,TInt aNumPoints);
sl@0	2089	//
sl@0	2090	// Filled outlines
sl@0	2091	// Outlines subject to pen color, width and style and draw mode
sl@0	2092	// (set pen to ENullPen for no outline)
sl@0	2093	// Fill subject to brush style (color, hash or pattern) and origin and
sl@0	2094	// drawing mode (set brush to ENullBrush for no fill)
sl@0	2095	IMPORT_C virtual void DrawPie(const TRect &aRect,const TPoint &aStart,const TPoint &aEnd);
sl@0	2096	IMPORT_C virtual void DrawEllipse(const TRect &aRect);
sl@0	2097	IMPORT_C virtual void DrawRect(const TRect &aRect);
sl@0	2098	IMPORT_C virtual void DrawRoundRect(const TRect &aRect,const TSize &aEllipse);
sl@0	2099	IMPORT_C virtual TInt DrawPolygon(const CArrayFix<TPoint> *aPointList,TFillRule aFillRule=EAlternate);
sl@0	2100	IMPORT_C virtual TInt DrawPolygon(const TPoint* aPointList,TInt aNumPoints,TFillRule aFillRule=EAlternate);
sl@0	2101	//
sl@0	2102	// Uses the bitmap's Twips size and does a "stretch" blit in general
sl@0	2103	IMPORT_C virtual void DrawBitmap(const TPoint &aTopLeft, const CFbsBitmap *aDevice);
sl@0	2104	IMPORT_C virtual void DrawBitmap(const TRect &aDestRect, const CFbsBitmap *aDevice);
sl@0	2105	IMPORT_C virtual void DrawBitmap(const TRect &aDestRect, const CFbsBitmap *aDevice, const TRect &aSourceRect);
sl@0	2106	IMPORT_C virtual void DrawBitmapMasked(const TRect& aDestRect, const CFbsBitmap* aBitmap, const TRect& aSourceRect, const CFbsBitmap* aMaskBitmap, TBool aInvertMask);
sl@0	2107	IMPORT_C virtual void DrawBitmapMasked(const TRect& aDestRect, const CWsBitmap* aBitmap, const TRect& aSourceRect, const CWsBitmap* aMaskBitmap, TBool aInvertMask);
sl@0	2108
sl@0	2109	// Required as not all DrawText and DrawTextVertical functions are implemented in CWindowGc
sl@0	2110	using CBitmapContext::DrawText;
sl@0	2111	using CBitmapContext::DrawTextVertical;
sl@0	2112	//
sl@0	2113	// Text drawing subject to drawing mode
sl@0	2114	// Subject to used font, pen color, drawing mode,
sl@0	2115	// word and char justification
sl@0	2116	IMPORT_C virtual void DrawText(const TDesC &aBuf,const TPoint &aPos);
sl@0	2117	//
sl@0	2118	// Subject to same as above plus brush for background
sl@0	2119	// (set brush to ENullBrush for no effect on background)
sl@0	2120	IMPORT_C virtual void DrawText(const TDesC &aBuf,const TRect &aBox,TInt aBaselineOffset,TTextAlign aHoriz=ELeft,TInt aLeftMrg=0);
sl@0	2121	//================Extra functions from CBitmapContext==============
sl@0	2122	IMPORT_C virtual void Clear();
sl@0	2123	IMPORT_C virtual void Clear(const TRect &aRect);
sl@0	2124	IMPORT_C virtual void CopyRect(const TPoint &anOffset,const TRect &aRect);
sl@0	2125	IMPORT_C virtual void BitBlt(const TPoint &aPos, const CFbsBitmap *aBitmap);
sl@0	2126	IMPORT_C virtual void BitBlt(const TPoint &aDestination, const CFbsBitmap *aBitmap, const TRect &aSource);
sl@0	2127	IMPORT_C virtual void BitBltMasked(const TPoint& aPoint,const CFbsBitmap* aBitmap,const TRect& aSourceRect,const CFbsBitmap* aMaskBitmap,TBool aInvertMask);
sl@0	2128	IMPORT_C virtual void BitBlt(const TPoint &aPoint, const CWsBitmap *aBitmap);
sl@0	2129	IMPORT_C virtual void BitBlt(const TPoint &aDestination, const CWsBitmap *aBitmap, const TRect &aSource);
sl@0	2130	IMPORT_C virtual void BitBltMasked(const TPoint& aPoint,const CWsBitmap aBitmap,const TRect& aSourceRect,const CWsBitmap aMaskBitmap,TBool aInvertMask);
sl@0	2131	IMPORT_C virtual void MapColors(const TRect& aRect,const TRgb* aColors,TInt aNumPairs=2,TBool aMapForwards=ETrue);
sl@0	2132
sl@0	2133	IMPORT_C virtual void DrawTextVertical(const TDesC& aText,const TPoint& aPos,TBool aUp);
sl@0	2134	IMPORT_C virtual void DrawTextVertical(const TDesC& aText,const TRect& aBox,TInt aBaselineOffset,TBool aUp,TTextAlign aVert=ELeft,TInt aMargin=0);
sl@0	2135	//=================Extra functions specific to wserv GDI==============
sl@0	2136	IMPORT_C virtual void SetDitherOrigin(const TPoint& aPoint);
sl@0	2137	IMPORT_C virtual TInt SetClippingRegion(const TRegion &aRegion);
sl@0	2138	IMPORT_C virtual void CancelClippingRegion();
sl@0	2139	IMPORT_C virtual void SetOpaque(TBool aDrawOpaque=ETrue);
sl@0	2140	//=================Functions also supplied by CFbsBitGc==============
sl@0	2141	IMPORT_C virtual void SetFaded(TBool aFaded);
sl@0	2142	IMPORT_C virtual void SetFadingParameters(TUint8 aBlackMap,TUint8 aWhiteMap);
sl@0	2143	IMPORT_C virtual TInt AlphaBlendBitmaps(const TPoint& aDestPt, const CFbsBitmap* aSrcBmp, const TRect& aSrcRect, const CFbsBitmap* aAlphaBmp, const TPoint& aAlphaPt);
sl@0	2144	IMPORT_C virtual TInt AlphaBlendBitmaps(const TPoint& aDestPt, const CWsBitmap* aSrcBmp, const TRect& aSrcRect, const CWsBitmap* aAlphaBmp, const TPoint& aAlphaPt);
sl@0	2145	//
sl@0	2146	IMPORT_C TAny* Interface(TUid aInterfaceId);
sl@0	2147	IMPORT_C const TAny* Interface(TUid aInterfaceId) const;
sl@0	2148
sl@0	2149	protected:
sl@0	2150	IMPORT_C TInt APIExtension(TUid aUid, TAny& aOutput, TAny aInput);
sl@0	2151
sl@0	2152	private:
sl@0	2153
sl@0	2154	IMPORT_C void Reserved_CGraphicsContext_2();
sl@0	2155
sl@0	2156	IMPORT_C void Reserved_CBitmapContext_1();
sl@0	2157	IMPORT_C void Reserved_CBitmapContext_2();
sl@0	2158	IMPORT_C void Reserved_CBitmapContext_3();
sl@0	2159
sl@0	2160	public:
sl@0	2161	IMPORT_C virtual void DrawWsGraphic(const TWsGraphicId& aId,const TRect& aDestRect);
sl@0	2162	IMPORT_C virtual void DrawWsGraphic(const TWsGraphicId& aId,const TRect& aDestRect,const TDesC8& aData);
sl@0	2163	private:
sl@0	2164	IMPORT_C virtual void Reserved_CWindowGc_3();
sl@0	2165	IMPORT_C virtual void Reserved_CWindowGc_4();
sl@0	2166	IMPORT_C virtual void Reserved_CWindowGc_5();
sl@0	2167
sl@0	2168	//=============================================================
sl@0	2169	private: // Private code
sl@0	2170	TRgb Color(TInt aOpcode)const;
sl@0	2171	void SetJustification(TInt aExcessWidth,TInt aNumGaps, TInt aOpcode);
sl@0	2172	void DrawArcOrPie(const TRect &aRect,const TPoint &aStart,const TPoint &aEnd, TInt aOpcode);
sl@0	2173	void doDrawPolyLine(const CArrayFix<TPoint> aPointArray, const TPoint aPointList,TInt aNumPoints);
sl@0	2174	TInt doDrawPolygon(const CArrayFix<TPoint> aPointArray,const TPoint aPointList,TInt aNumPoints,TFillRule aFillRule);
sl@0	2175	void WriteTextPos(TInt aOpcode,TInt aOpcodePtr,const TPoint &aPos,const TDesC &aBuf) const;
sl@0	2176	void WriteTextCommand(TAny *aCmd, TInt aLen,const TDesC &aBuf,TInt aOpcode,TInt aOpcodePtr) const;
sl@0	2177	void WriteTextCommand(TAny *aCmd, TInt aLen,const TDesC8 &aBuf,TInt aOpcode,TInt aOpcodePtr) const;
sl@0	2178	TInt APIExGetUnderlineMetrics(TAny*& aOutput);
sl@0	2179	TInt APIExSetShadowColor(TAny* aShadowColor);
sl@0	2180	TInt APIExGetShadowColor(TAny*& aOutput);
sl@0	2181	// New DrawText API's that take in context
sl@0	2182	TInt APIExDrawText(const TDesC &aBuf,const TTextParameters* aParam,const TPoint &aPos);
sl@0	2183	TInt APIExDrawText(const TDesC &aBuf,const TTextParameters* aParam,const TRect &aBox,TInt aBaselineOffset,TTextAlign aHoriz=ELeft,TInt aLeftMrg=0);
sl@0	2184	TInt APIExDrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TPoint& aPos,TBool aUp);
sl@0	2185	TInt APIExDrawTextVertical(const TDesC& aText,const TTextParameters* aParam,const TRect& aBox,TInt aBaselineOffset,TBool aUp,TTextAlign aVert=ELeft,TInt aMargin=0);
sl@0	2186	TInt APIExInterface(TAny*& aInterface, TUid aInterfaceId);
sl@0	2187
sl@0	2188	void DrawResource(const TPoint& aPos, const RWsDrawableSource& aSource, TGraphicsRotation aRotation=EGraphicsRotationNone);
sl@0	2189	void DrawResource(const TRect& aDestRect, const RWsDrawableSource& aSource, TGraphicsRotation aRotation=EGraphicsRotationNone);
sl@0	2190	void DrawResource(const TRect& aDestRect, const RWsDrawableSource& aSource, const TRect& aSrcRect, TGraphicsRotation aRotation=EGraphicsRotationNone);
sl@0	2191	void DrawResource(const TRect& aDestRect, const RWsDrawableSource& aSource, const TDesC8& aParam);
sl@0	2192
sl@0	2193	private: // Private data
sl@0	2194	class CPimpl;
sl@0	2195	CPimpl* iPimpl;
sl@0	2196	CWsScreenDevice *iDevice;
sl@0	2197	};
sl@0	2198
sl@0	2199
sl@0	2200	class CWsScreenDevice : public CBitmapDevice, public MWsClientClass
sl@0	2201	/** Software device screen.
sl@0	2202
sl@0	2203	An object of this class can be used to enquire or set parameters of the software
sl@0	2204	screen, and determine the physical limits of the device.
sl@0	2205
sl@0	2206	CWsScreenDevice gives access to the list of screen modes. These are the combinations
sl@0	2207	of screen rotation and screen size supported by the device. One of them is
sl@0	2208	selected as the current screen mode. The possible screen modes are initialised
sl@0	2209	in wsini.ini.
sl@0	2210
sl@0	2211	@publishedAll
sl@0	2212	@released
sl@0	2213	@see CFbsScreenDevice */
sl@0	2214	{
sl@0	2215	public:
sl@0	2216	/** Whether or not to include sprites when comparing areas of the screen*/
sl@0	2217	enum TSpriteInCompare
sl@0	2218	{
sl@0	2219	/** This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1,
sl@0	2220	const TRect &aRect2,TUint aFlags).
sl@0	2221	When called with the value ERemoveSprite if there are any sprites visible in the areas of the screen being compared then these
sl@0	2222	will not be included in the comparison.
sl@0	2223	The function CWsScreenDevice::RectCompare(const TRect &aRect1,const TRect &aRect2) will not include
sl@0	2224	sprites in the comparison.
sl@0	2225	*/
sl@0	2226	ERemoveSprite=0,
sl@0	2227	/** This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1,
sl@0	2228	const TRect &aRect2,TUint aFlags).
sl@0	2229	When called with the value EIncludeSprite if there are any sprites visible in the areas of the screen being compared then these
sl@0	2230	will be included in the comparison.*/
sl@0	2231	EIncludeSprite=1,
sl@0	2232	/** This enum can be specified as the 3rd parameter to CWsScreenDevice::RectCompare(const TRect &aRect1,
sl@0	2233	const TRect &aRect2,TUint aFlags).
sl@0	2234	When called with the value EIncludeTextCursor if there are any text cursors visible in the areas of the screen being compared then these
sl@0	2235	will be included in the comparison.*/
sl@0	2236	EIncludeTextCursor=2
sl@0	2237	};
sl@0	2238	public:
sl@0	2239	IMPORT_C CWsScreenDevice();
sl@0	2240	IMPORT_C CWsScreenDevice(RWsSession &aWs);
sl@0	2241	IMPORT_C ~CWsScreenDevice();
sl@0	2242	IMPORT_C TInt Construct();
sl@0	2243	IMPORT_C TInt Construct( TInt aDefaultScreenNumber ) ;
sl@0	2244	IMPORT_C TAny* GetInterface(TUint aInterfaceId);
sl@0	2245	inline const TAny* GetInterface(TUint aInterfaceId) const;
sl@0	2246	IMPORT_C TBool IsModeDynamic(TInt aSizeMode) const;
sl@0	2247	IMPORT_C TBool IsCurrentModeDynamic() const;
sl@0	2248	//==== From CGraphicsDevice ====//
sl@0	2249	IMPORT_C TDisplayMode DisplayMode() const;
sl@0	2250	IMPORT_C TSize SizeInPixels() const;
sl@0	2251	IMPORT_C TSize SizeInTwips() const;
sl@0	2252	IMPORT_C TInt HorizontalTwipsToPixels(TInt aTwips) const;
sl@0	2253	IMPORT_C TInt VerticalTwipsToPixels(TInt aTwips) const;
sl@0	2254	IMPORT_C TInt HorizontalPixelsToTwips(TInt aPixels) const;
sl@0	2255	IMPORT_C TInt VerticalPixelsToTwips(TInt aPixels) const;
sl@0	2256	IMPORT_C TRect PointerRect() const;
sl@0	2257	IMPORT_C TInt CreateContext(CGraphicsContext *&aGc);
sl@0	2258	inline TInt CreateContext(CWindowGc*& aGc);
sl@0	2259	IMPORT_C virtual TInt GetNearestFontInTwips(CFont*& aFont,const TFontSpec& aFontSpec);
sl@0	2260	IMPORT_C virtual TInt GetNearestFontToDesignHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec);
sl@0	2261	IMPORT_C virtual TInt GetNearestFontToMaxHeightInTwips(CFont*& aFont,const TFontSpec& aFontSpec,TInt aMaxHeight);
sl@0	2262	IMPORT_C TInt NumTypefaces() const;
sl@0	2263	IMPORT_C void TypefaceSupport(TTypefaceSupport& aTypefaceSupport,TInt aTypefaceIndex) const;
sl@0	2264	IMPORT_C TInt FontHeightInTwips(TInt aTypefaceIndex,TInt aHeightIndex) const;
sl@0	2265	// ==== From CBitmapDevice ====//
sl@0	2266	IMPORT_C void GetPixel(TRgb& aColor,const TPoint& aPixel) const;
sl@0	2267	IMPORT_C void GetScanLine(TDes8& aScanLine,const TPoint& aStartPixel,TInt aPixelLength, TDisplayMode aDispMode) const;
sl@0	2268	IMPORT_C TInt AddFile(const TDesC& aName,TInt& aId);
sl@0	2269	IMPORT_C void RemoveFile(TInt aId=0);
sl@0	2270	IMPORT_C virtual TInt GetNearestFontInPixels(CFont*& aFont,const TFontSpec& aFontSpec);
sl@0	2271	IMPORT_C virtual TInt GetNearestFontToDesignHeightInPixels(CFont*& aFont,const TFontSpec& aFontSpec);
sl@0	2272	IMPORT_C virtual TInt GetNearestFontToMaxHeightInPixels(CFont*& aFont,const TFontSpec& aFontSpec,TInt aMaxHeight);
sl@0	2273	IMPORT_C TInt FontHeightInPixels(TInt aTypefaceIndex,TInt aHeightIndex) const;
sl@0	2274	IMPORT_C void ReleaseFont(CFont* aFont);
sl@0	2275	//===== From CFbsScreenDevice ====//
sl@0	2276	IMPORT_C void PaletteAttributes(TBool& aModifiable,TInt& aNumEntries) const;
sl@0	2277	IMPORT_C void SetPalette(CPalette* aPalette);
sl@0	2278	IMPORT_C TInt GetPalette(CPalette*& aPalette) const;
sl@0	2279	//===== Extra functions ====//
sl@0	2280	IMPORT_C TInt SetCustomPalette(const CPalette* aPalette);
sl@0	2281	IMPORT_C TInt GetFontById(CFont*& aFont,TUid aUid,const TAlgStyle& aAlgStyle);
sl@0	2282	IMPORT_C TBool RectCompare(const TRect &aRect1,const TRect &aRect2) const;
sl@0	2283	IMPORT_C TBool RectCompare(const TRect& aRect1,const TRect &aRect2,TUint aFlags) const;
sl@0	2284	IMPORT_C TInt CopyScreenToBitmap(const CFbsBitmap *aBitmap) const;
sl@0	2285	IMPORT_C TInt CopyScreenToBitmap(const CFbsBitmap *aBitmap, const TRect &aRect) const;
sl@0	2286	IMPORT_C TInt SetBackLight(TBool aBackLight);
sl@0	2287	//===== Screen Rotation functions ====//
sl@0	2288	IMPORT_C void SetScreenSizeAndRotation(const TPixelsTwipsAndRotation &aSizeAndRotation);
sl@0	2289	IMPORT_C void GetDefaultScreenSizeAndRotation(TPixelsTwipsAndRotation &aSizeAndRotation) const;
sl@0	2290	IMPORT_C void SetScreenSizeAndRotation(const TPixelsAndRotation &aSizeAndRotation);
sl@0	2291	IMPORT_C void GetDefaultScreenSizeAndRotation(TPixelsAndRotation &aSizeAndRotation) const;
sl@0	2292	IMPORT_C TScreenModeEnforcement ScreenModeEnforcement() const;
sl@0	2293	IMPORT_C void SetScreenModeEnforcement(TScreenModeEnforcement aMode) const;
sl@0	2294	IMPORT_C void GetScreenModeSizeAndRotation(TInt aMode, TPixelsTwipsAndRotation &aSizeAndRotation) const;
sl@0	2295	IMPORT_C void GetScreenModeSizeAndRotation(TInt aMode, TPixelsAndRotation &aSizeAndRotation) const;
sl@0	2296	IMPORT_C void SetCurrentRotations(TInt aMode, CFbsBitGc::TGraphicsOrientation aRotation) const;
sl@0	2297	IMPORT_C TInt GetRotationsList(TInt aMode, CArrayFixFlat<TInt> *aRotationList) const;
sl@0	2298	IMPORT_C TInt NumScreenModes() const;
sl@0	2299	IMPORT_C void SetScreenMode(TInt aMode);
sl@0	2300	IMPORT_C TInt CurrentScreenMode() const;
sl@0	2301	IMPORT_C void SetAppScreenMode(TInt aMode);
sl@0	2302	IMPORT_C TPoint GetDefaultScreenModeOrigin() const;
sl@0	2303	IMPORT_C TPoint GetScreenModeOrigin(TInt aMode) const;
sl@0	2304	IMPORT_C TSize GetCurrentScreenModeScale() const;
sl@0	2305	IMPORT_C TSize GetScreenModeScale(TInt aMode) const;
sl@0	2306	IMPORT_C TPoint GetCurrentScreenModeScaledOrigin() const;
sl@0	2307	IMPORT_C TPoint GetScreenModeScaledOrigin(TInt aMode) const;
sl@0	2308	IMPORT_C TInt GetScreenSizeModeList(RArray<TInt>* aModeList) const;
sl@0	2309	IMPORT_C TDisplayMode GetScreenModeDisplayMode(const TInt &aMode) const;
sl@0	2310	//===== Used for testing purpose only ====//
sl@0	2311	IMPORT_C TSizeMode GetCurrentScreenModeAttributes() const;
sl@0	2312	IMPORT_C void SetCurrentScreenModeAttributes(const TSizeMode &aModeAtt);
sl@0	2313	IMPORT_C TInt GetScreenNumber() const;
sl@0	2314	private:
sl@0	2315	CFbsTypefaceStore* TypeFaceStore()const;
sl@0	2316	TSize DisplaySizeInPixels()const;
sl@0	2317	TSize PhysicalScreenSizeInTwips()const;
sl@0	2318	private: // Private data
sl@0	2319	class CScrDevExtension; //Implements extension interfaces, including and replacing typeface store
sl@0	2320	CScrDevExtension* iExtension;
sl@0	2321	TSize iPhysicalScreenSizeInTwips;
sl@0	2322	TSize iDisplaySizeInPixels;
sl@0	2323	friend class CWindowGc;
sl@0	2324	};
sl@0	2325
sl@0	2326
sl@0	2327	class RWsSpriteBase : public MWsClientClass
sl@0	2328	// Client side class base class for sprites and pointer cursors
sl@0	2329	/** Sprite base class.
sl@0	2330
sl@0	2331	Unless stated otherwise, references to sprites in the documentation for this class also
sl@0	2332	apply to pointer cursors.
sl@0	2333
sl@0	2334	@publishedAll
sl@0	2335	@released
sl@0	2336	@see RWsSprite
sl@0	2337	@see RWsPointerCursor */
sl@0	2338	{
sl@0	2339	protected:
sl@0	2340	IMPORT_C RWsSpriteBase();
sl@0	2341	IMPORT_C RWsSpriteBase(RWsSession &aWs);
sl@0	2342	public:
sl@0	2343	IMPORT_C TInt Activate();
sl@0	2344	IMPORT_C TInt AppendMember(const TSpriteMember &aMemberData);
sl@0	2345	IMPORT_C void UpdateMember(TInt aIndex);
sl@0	2346	IMPORT_C TInt UpdateMember(TInt aIndex, const TSpriteMember &aMemberData);
sl@0	2347	IMPORT_C void Close();
sl@0	2348	};
sl@0	2349
sl@0	2350
sl@0	2351	class RWsSprite : public RWsSpriteBase
sl@0	2352	/** Sprite.
sl@0	2353
sl@0	2354	This class defines functions to create and initialise a sprite, and to set
sl@0	2355	its position.
sl@0	2356
sl@0	2357	@publishedAll
sl@0	2358	@released */
sl@0	2359	{
sl@0	2360	public:
sl@0	2361	IMPORT_C RWsSprite();
sl@0	2362	IMPORT_C RWsSprite(RWsSession &aWs);
sl@0	2363	IMPORT_C TInt Construct(RWindowTreeNode &aWindow, const TPoint &aPos, TInt aFlags);
sl@0	2364	IMPORT_C void SetPosition(const TPoint &aPos);
sl@0	2365	};
sl@0	2366
sl@0	2367
sl@0	2368	class RWsPointerCursor : public RWsSpriteBase
sl@0	2369	/** Pointer cursor.
sl@0	2370
sl@0	2371	The pointer cursor is created in a similar way to a sprite. After creating it,
sl@0	2372	one or more sprite members containing the bitmaps to be displayed are added.
sl@0	2373
sl@0	2374	After a pointer cursor has been created and activated, it does not become
sl@0	2375	visible until the application calls RWindowTreeNode::SetPointerCursor() or
sl@0	2376	RWindowTreeNode::SetCustomPointerCursor(). The pointer cursor's origin automatically
sl@0	2377	tracks the position of the pointing device, or position of emulated single pointer if there
sl@0	2378	are more pointers in the system (see documentation of RWindowBase::EnableAdvancedPointers()
sl@0	2379	for more details), and the origin forms the pointer cursor's "hot spot", i.e., the point
sl@0	2380	whose co-ordinates are sent to the client if a pointer event occurs.
sl@0	2381	If the pointer cursor's bitmap needs to extend to the left or upwards from the pointer
sl@0	2382	position, its sprite member should be given a negative offset in TSpriteMember::iOffset.
sl@0	2383
sl@0	2384	Note:
sl@0	2385
sl@0	2386	Pointer cursors are rarely used in pure pen architectures, but they are supported
sl@0	2387	for mouse or tablet use.
sl@0	2388
sl@0	2389	@see RWindowBase::EnableAdvancedPointers()
sl@0	2390
sl@0	2391	@publishedAll
sl@0	2392	@released */
sl@0	2393	{
sl@0	2394	public:
sl@0	2395	IMPORT_C RWsPointerCursor();
sl@0	2396	IMPORT_C RWsPointerCursor(RWsSession &aWs);
sl@0	2397	IMPORT_C TInt Construct(TInt aFlags);
sl@0	2398	};
sl@0	2399
sl@0	2400
sl@0	2401	class RAnim;
sl@0	2402
sl@0	2403
sl@0	2404	class RAnimDll : public MWsClientClass
sl@0	2405	/** Client-side interface to the server-side animation DLL.
sl@0	2406
sl@0	2407	This is the client side class matching the server side CAnimDLL class. It
sl@0	2408	provides functions to create, load, close and destroy a server-side CAnimDll
sl@0	2409	object.
sl@0	2410
sl@0	2411	@publishedAll
sl@0	2412	@released
sl@0	2413	@see CreateCAnimDllL()
sl@0	2414	@see CAnimDll */
sl@0	2415	{
sl@0	2416	public:
sl@0	2417	IMPORT_C RAnimDll();
sl@0	2418	IMPORT_C virtual ~RAnimDll();
sl@0	2419	IMPORT_C RAnimDll(RWsSession &aWs);
sl@0	2420	IMPORT_C TInt Load(const TDesC &aFileName);
sl@0	2421	IMPORT_C void Destroy();
sl@0	2422	IMPORT_C virtual void Close();
sl@0	2423	private:
sl@0	2424	TInt CommandReply(TInt aHandle, TInt aOpcode, const TIpcArgs* aIpcArgs=NULL);
sl@0	2425	TInt CommandReply(TInt aHandle, TInt aOpcode, const TDesC8& aArgs, const TIpcArgs* aIpcArgs=NULL);
sl@0	2426	void Command(TInt aHandle, TInt aOpcode, const TPtrC8 &aArgs);
sl@0	2427	void Command(TInt aHandle, TInt aOpcode);
sl@0	2428	void AsyncCommandReply(TRequestStatus& aStatus, TInt aOpcode, TIpcArgs& aIpcArgs);
sl@0	2429	TInt CreateInstance(TInt32& aHandle, const MWsClientClass &aDevice, TInt aType, const TDesC8 &aArgs, TInt aOpcode, const TIpcArgs* aIpcArgs);
sl@0	2430	void DestroyInstance(TInt aHandle);
sl@0	2431	private:
sl@0	2432	friend class RAnim;
sl@0	2433	};
sl@0	2434
sl@0	2435
sl@0	2436	class RAnim
sl@0	2437	/** Client-side handle to a server-side animation class.
sl@0	2438
sl@0	2439	This class should be sub-classed to provide a client side interface to the
sl@0	2440	server side animation DLL. The server side animation DLL is derived from CAnim.
sl@0	2441
sl@0	2442	@publishedAll
sl@0	2443	@released */
sl@0	2444	{
sl@0	2445	public:
sl@0	2446	IMPORT_C virtual ~RAnim();
sl@0	2447	IMPORT_C virtual void Close();
sl@0	2448	IMPORT_C void Destroy();
sl@0	2449	protected:
sl@0	2450	IMPORT_C RAnim();
sl@0	2451	IMPORT_C RAnim(RAnimDll &aDll);
sl@0	2452	IMPORT_C TInt Construct(const RWindowBase &aDevice, TInt aType, const TDesC8 &aParams);
sl@0	2453	IMPORT_C TInt Construct(const RWindowBase &aDevice, TInt aType, const TDesC8 &aParams, const TIpcArgs& aIpcArgs);
sl@0	2454	IMPORT_C TInt Construct(const RWsSprite &aDevice, TInt aType, const TDesC8 &aParams);
sl@0	2455	IMPORT_C TInt Construct(const RWsSprite &aDevice, TInt aType, const TDesC8 &aParams, const TIpcArgs& aIpcArgs);
sl@0	2456	IMPORT_C TInt CommandReply(TInt aOpcode);
sl@0	2457	IMPORT_C TInt CommandReply(TInt aOpcode, const TPtrC8 &aArgs);
sl@0	2458	IMPORT_C TInt CommandReply(TInt aOpcode, const TDesC8& aArgs, const TIpcArgs& aIpcArgs);
sl@0	2459	IMPORT_C void Command(TInt aOpcode, const TPtrC8 &aArgs);
sl@0	2460	IMPORT_C void Command(TInt aOpcode);
sl@0	2461	IMPORT_C void AsyncCommandReply(TRequestStatus& aRequestStatus,TInt aOpcode, const TIpcArgs& aIpcArgs);
sl@0	2462	private:
sl@0	2463	TInt32 iHandle;
sl@0	2464	RAnimDll *iAnimDll;
sl@0	2465	};
sl@0	2466
sl@0	2467	class CDsaMsgQueue;
sl@0	2468
sl@0	2469	class RDirectScreenAccess : public MWsClientClass
sl@0	2470	/** The interface between an application that directly accesses the screen and
sl@0	2471	the window server.
sl@0	2472
sl@0	2473	Note that most applications that need to access the screen directly should
sl@0	2474	use CDirectScreenAccess instead. RDirectScreenAccess only needs to be used
sl@0	2475	directly by applications without access to an active scheduler.
sl@0	2476
sl@0	2477	@publishedAll
sl@0	2478	@released */
sl@0	2479	{
sl@0	2480	public:
sl@0	2481	/** Provides the reason why direct screen access must terminate. This enum is used
sl@0	2482	in the MAbortDirectScreenAccess::AbortNow() and MDirectScreenAccess::Restart()
sl@0	2483	functions.
sl@0	2484
sl@0	2485	The first value (ETerminateCancel) indicates that direct screen access is
sl@0	2486	being terminated by the application. The final three values indicate that
sl@0	2487	direct screen access is being terminated by the window server. Note that
sl@0	2488	for users of CDirectScreenAccess, the termination code is not important
sl@0	2489	because these issues are dealt with by CDirectScreenAccess::StartL(). */
sl@0	2490	enum TTerminationReasons
sl@0	2491	{
sl@0	2492	/** The application has finished direct screen access. */
sl@0	2493	ETerminateCancel,
sl@0	2494	/** A window is about to come in front of a part of the area that is being used
sl@0	2495	for direct screen access. */
sl@0	2496	ETerminateRegion,
sl@0	2497	/** The screen's color depth (as enumerated by TDisplayMode) is about to change. */
sl@0	2498	ETerminateScreenMode,
sl@0	2499	/** The current screen mode (the combination of screen rotation and screen size)
sl@0	2500	is about to change. */
sl@0	2501	ETerminateRotation,
sl@0	2502	};
sl@0	2503	/** The priority of the active object that responds to notification that direct
sl@0	2504	screen access must stop. */
sl@0	2505	enum TPriority
sl@0	2506	{
sl@0	2507	/** A suggested value for the priority of the active object that responds to notification
sl@0	2508	from the window server that direct screen access must stop. This is also the
sl@0	2509	value used by CDirectScreenAccess for this purpose. */
sl@0	2510	EPriorityVeryHigh=2000,
sl@0	2511	};
sl@0	2512	public:
sl@0	2513	IMPORT_C RDirectScreenAccess();
sl@0	2514	IMPORT_C RDirectScreenAccess(RWsSession& aWs);
sl@0	2515	IMPORT_C TInt Construct();
sl@0	2516	IMPORT_C TInt Construct(TBool aRegionTrackingOnly);
sl@0	2517	IMPORT_C TInt Request(RRegion*& aRegion,TRequestStatus& aStatus,const RWindowBase& aWindow);
sl@0	2518	IMPORT_C void Completed();
sl@0	2519	IMPORT_C void Cancel();
sl@0	2520	IMPORT_C void Close();
sl@0	2521	private:
sl@0	2522	RWsSession* iWs;
sl@0	2523	CDsaMsgQueue* iMsgQueue;
sl@0	2524	// To maintain BC we need the following
sl@0	2525	RThread iWsThread;
sl@0	2526	TRequestStatus* iDummyRequest;
sl@0	2527	};
sl@0	2528
sl@0	2529
sl@0	2530	class MAbortDirectScreenAccess
sl@0	2531	/** The interface for terminating direct screen access.
sl@0	2532
sl@0	2533	An object of a class which implements this interface should be passed to CDirectScreenAccess::NewL().
sl@0	2534
sl@0	2535	@publishedAll
sl@0	2536	@released
sl@0	2537	@see MDirectScreenAccess */
sl@0	2538	{
sl@0	2539	public:
sl@0	2540	/** This function is called by the window server when direct screen access must
sl@0	2541	stop (for example because a dialogue is moved in front of the area where direct
sl@0	2542	screen access is taking place).
sl@0	2543
sl@0	2544	In response to this, direct screen access must stop immediately. In simple cases,
sl@0	2545	this will involve cancelling the active object that is driving the drawing to the
sl@0	2546	screen.
sl@0	2547
sl@0	2548	No attempt to call a Window Server API function can be made from
sl@0	2549	AbortNow(), because then a temporary deadlock will occur. This is because WSERV
sl@0	2550	is waiting to receive the client's acknowledgment that it has aborted, and so will
sl@0	2551	not be able to service the call. As soon as the restriction no longer applies,
sl@0	2552	the function Restart() will be called.
sl@0	2553
sl@0	2554	@param aReason The reason why direct screen access was terminated. */
sl@0	2555	virtual void AbortNow(RDirectScreenAccess::TTerminationReasons aReason)=0;
sl@0	2556	};
sl@0	2557
sl@0	2558
sl@0	2559	class MDirectScreenAccess : public MAbortDirectScreenAccess
sl@0	2560	/** The interface for restarting direct screen access.
sl@0	2561
sl@0	2562	The Restart() function is called by the window server as soon as direct screen
sl@0	2563	access can resume. It is called after the window server has called AbortNow().
sl@0	2564
sl@0	2565	An object of the derived class is passed to CDirectScreenAccess::NewL().
sl@0	2566
sl@0	2567	@publishedAll
sl@0	2568	@released
sl@0	2569	@see CDirectScreenAccess::NewL() */
sl@0	2570	{
sl@0	2571	public:
sl@0	2572	/** This function is called by the window server as soon as direct screen access
sl@0	2573	can resume.
sl@0	2574
sl@0	2575	This function should call CDirectScreenAccess::StartL() within a trap harness.
sl@0	2576	If this leaves, e.g. through lack of memory, direct screen access cannot be
sl@0	2577	restarted. StartL() re-calculates the clipping region, so that if direct screen
sl@0	2578	access was aborted because another window appeared in front of it, that window
sl@0	2579	will not be overwritten when direct screen access resumes.
sl@0	2580
sl@0	2581	In this function, you can resume calls to Window Server Client Side API functions.
sl@0	2582
sl@0	2583	@param aReason Provides the reason why direct screen access was terminated. */
sl@0	2584	virtual void Restart(RDirectScreenAccess::TTerminationReasons aReason)=0;
sl@0	2585	};
sl@0	2586
sl@0	2587
sl@0	2588	class CDirectScreenAccess : public CActive
sl@0	2589	/** An active object used to start direct screen access.
sl@0	2590
sl@0	2591	Direct screen access is a way of drawing to the screen without using the window
sl@0	2592	server. As this avoids client-server communication, it is much faster, and
sl@0	2593	may be useful for games and video. Note that some interaction with the window
sl@0	2594	server is needed in order to prevent the application from drawing over other
sl@0	2595	application's data.
sl@0	2596
sl@0	2597	The object's (private) RunL() function is called by the window server in order
sl@0	2598	to abort direct screen access. This might occur when another window needs
sl@0	2599	to be displayed in front or when the window with direct screen access is moved.
sl@0	2600	The active object's priority is RDirectScreenAccess::EPriorityVeryHigh so
sl@0	2601	that direct screen access will be aborted as quickly as possible.
sl@0	2602
sl@0	2603	@publishedAll
sl@0	2604	@released */
sl@0	2605	{
sl@0	2606	public:
sl@0	2607	IMPORT_C static CDirectScreenAccess* NewL(RWsSession& aWs,CWsScreenDevice& aScreenDevice,RWindowBase& aWin,MDirectScreenAccess& aAbort);
sl@0	2608	IMPORT_C static CDirectScreenAccess* NewL(RWsSession& aWs,CWsScreenDevice& aScreenDevice,RWindowBase& aWin,MDirectScreenAccess& aAbort,TBool aRegionTrackingOnly);
sl@0	2609	~CDirectScreenAccess();
sl@0	2610	IMPORT_C void StartL();
sl@0	2611	inline CFbsBitGc* Gc();
sl@0	2612	inline CFbsScreenDevice*& ScreenDevice();
sl@0	2613	inline RRegion* DrawingRegion();
sl@0	2614	private:
sl@0	2615	enum TFlags
sl@0	2616	{
sl@0	2617	EDirectCheckModeChange = 0x01,
sl@0	2618	EDirectCheckSizeModeChange = 0x02,
sl@0	2619	EDirectRegionTrackingOnly = 0x04,
sl@0	2620	};
sl@0	2621	private:
sl@0	2622	inline CDirectScreenAccess(RWsSession& aWs,CWsScreenDevice* aScreenDevice,RWindowBase& aWindow,MDirectScreenAccess& aAbort);
sl@0	2623	void ConstructL(RWsSession& aWs,TBool aRegionTrackingOnly);
sl@0	2624	void CreateScreenObjectsL(TDisplayMode aCurrentMode);
sl@0	2625	void UpdateSizeAndRotation(CFbsBitGc* aGc);
sl@0	2626	static TInt Restart(TAny* aDirect);
sl@0	2627	void Restart();
sl@0	2628	//Pure virtual functions from CActive
sl@0	2629	void DoCancel();
sl@0	2630	void RunL();
sl@0	2631	private:
sl@0	2632	CFbsBitGc* iGc;
sl@0	2633	CFbsScreenDevice* iScreenDevice;
sl@0	2634	RRegion* iDrawingRegion;
sl@0	2635	RWindowBase& iWindow;
sl@0	2636	CWsScreenDevice* iWsScreenDevice;
sl@0	2637	MDirectScreenAccess& iAbort;
sl@0	2638	RDirectScreenAccess iDirectAccess;
sl@0	2639	RDirectScreenAccess::TTerminationReasons iReason;
sl@0	2640	CIdle* iRestart;
sl@0	2641	TSize iScreenSize;
sl@0	2642	TBool iAborting;
sl@0	2643	TUint iFlags;
sl@0	2644	TInt iScreenNumber;
sl@0	2645	};
sl@0	2646
sl@0	2647
sl@0	2648	class RSoundPlugIn : public MWsClientClass
sl@0	2649	/** Client interface to the key or pointer click plug-in DLL.
sl@0	2650
sl@0	2651	The plug-in DLL implements the CClickMaker class.
sl@0	2652
sl@0	2653	@publishedAll
sl@0	2654	@released
sl@0	2655	@see CClickMaker */
sl@0	2656	{
sl@0	2657	public:
sl@0	2658	/** A possible return value for CommandReply(). */
sl@0	2659	enum
sl@0	2660	{
sl@0	2661	/** The value returned by CommandReply() if no plug-in is loaded,
sl@0	2662	or if the plug-in identified by the aUid parameter in Construct() is not loaded.
sl@0	2663	Its value is set to KMinTInt so that it should not clash with any other expected
sl@0	2664	return value from this function. */
sl@0	2665	ESoundWrongPlugIn=KMinTInt
sl@0	2666	};
sl@0	2667	public:
sl@0	2668	IMPORT_C RSoundPlugIn();
sl@0	2669	IMPORT_C RSoundPlugIn(RWsSession &aWs);
sl@0	2670	IMPORT_C TInt Construct(TUid aUid=KNullUid);
sl@0	2671	IMPORT_C void Close();
sl@0	2672	IMPORT_C void Destroy();
sl@0	2673	IMPORT_C TBool IsLoaded(TBool& aIsChangeable) const;
sl@0	2674	IMPORT_C TInt Unload();
sl@0	2675	IMPORT_C TInt Load(const TDesC &aFileName);
sl@0	2676	IMPORT_C void SetKeyClick(TBool aEnabled);
sl@0	2677	IMPORT_C void SetPenClick(TBool aEnabled);
sl@0	2678	IMPORT_C TBool KeyClickEnabled() const;
sl@0	2679	IMPORT_C TBool PenClickEnabled() const;
sl@0	2680	IMPORT_C TInt CommandReply(TInt aOpcode, const TPtrC8 &aArgs);
sl@0	2681	};
sl@0	2682
sl@0	2683	inline TInt MWsClientClass::WsHandle() const
sl@0	2684	/** Gets the server side handle for the object.
sl@0	2685
sl@0	2686	@return The server-side handle for the object. */
sl@0	2687	{return(iWsHandle);}
sl@0	2688
sl@0	2689	inline const TAny* CWsScreenDevice::GetInterface(TUint aInterfaceId) const
sl@0	2690	{
sl@0	2691	return const_cast<CWsScreenDevice*>(this)->GetInterface(aInterfaceId);
sl@0	2692	}
sl@0	2693
sl@0	2694	inline TInt CWsScreenDevice::CreateContext(CWindowGc *&aGc)
sl@0	2695	/** Creates a graphics context for this device.
sl@0	2696
sl@0	2697	This function always causes a flush of the window server buffer.
sl@0	2698
sl@0	2699	@param aGc On successful return, contains a new graphics context referring
sl@0	2700	to this screen device.
sl@0	2701	@return KErrNone if successful, otherwise one of the system-wide error codes.
sl@0	2702	@see CGraphicsDevice::CreateContext() */
sl@0	2703	{return(CreateContext((CGraphicsContext *&)aGc));}
sl@0	2704
sl@0	2705	inline TUint TWsRedrawEvent::Handle() const
sl@0	2706	/** Gets the handle of the window which is the target of the redraw event.
sl@0	2707
sl@0	2708	This is the handle that was passed to the window's Construct() function: typically
sl@0	2709	it will be a pointer to the object owning the window, providing access to
sl@0	2710	its member functions.
sl@0	2711
sl@0	2712	@return The window's handle. */
sl@0	2713	{return(iHandle);}
sl@0	2714
sl@0	2715	inline TRect TWsRedrawEvent::Rect() const
sl@0	2716	/** Gets the rectangle to redraw.
sl@0	2717
sl@0	2718	@return The rectangle that needs redrawing. Co-ordinates are relative to
sl@0	2719	the window whose handle is given by Handle(). */
sl@0	2720	{return(iRect);}
sl@0	2721
sl@0	2722	inline TWsEvent::TWsEvent()
sl@0	2723	/** Constructor. Zero Initialise Data
sl@0	2724	@publishedAll
sl@0	2725	@released */
sl@0	2726	{
sl@0	2727	iType=0;
sl@0	2728	iHandle=0;
sl@0	2729	iTime=0;
sl@0	2730	Mem::FillZ(iEventData,EWsEventDataSize);
sl@0	2731	}
sl@0	2732
sl@0	2733	inline TAdvancedPointerEvent* TWsEvent::Pointer() const
sl@0	2734	/** Gets the pointer event.
sl@0	2735
sl@0	2736	This method can be used to get information about the pointer event if Type()
sl@0	2737	returns an event of type EEventPointer or EEventDragDrop.
sl@0	2738
sl@0	2739	If the event has been received by the window without advanced pointer events enabled,
sl@0	2740	this method will return a pointer to TPointerEvent with additional fields of
sl@0	2741	TAdvancedPointerEvent being cleared to 0.
sl@0	2742
sl@0	2743	@return Structure containing advanced pointer event data.
sl@0	2744	@see TPointerEvent::AdvancedPointerEvent()
sl@0	2745	@see RWindowBase::EnableAdvancedPointers() */
sl@0	2746	{return((TAdvancedPointerEvent *)&iEventData);}
sl@0	2747
sl@0	2748	inline TInt TAdvancedPointerEvent::PointerNumber() const
sl@0	2749	/** Gets the pointer number of the pointer whose state change is described by this event.
sl@0	2750
sl@0	2751	As soon as the pointer (for example a finger) is detected by the device's sensors,
sl@0	2752	it is assigned a pointer number. Then all events related to this pointer always
sl@0	2753	use the same pointer number. When the device loses track of the pointer,
sl@0	2754	TPointerEvent::EOutOfRange is sent with its pointer number and the number is released
sl@0	2755	- from this time it may be re-used to identify another pointer coming into range.
sl@0	2756
sl@0	2757	On a particular device, the pointer number is always an integer in the range 0 to
sl@0	2758	HALData::EPointerNumberOfPointers - 1. If the device doesn't provide value for
sl@0	2759	this attribute, it is assumed to be 1.
sl@0	2760
sl@0	2761	Please note that in order to receive events from multiple pointers in a window, the method
sl@0	2762	RWindowBase::EnableAdvancedPointers() has to be called for this window's instance
sl@0	2763	before it is activated. Otherwise this window will only receive TPointerEvents from one
sl@0	2764	emulated pointer, which will always have pointer number 0.
sl@0	2765
sl@0	2766	@return Pointer number of the pointer whose state change is described by this event.
sl@0	2767	@see RWindowBase::EnableAdvancedPointers()
sl@0	2768	@see HALData::EPointerNumberOfPointers */
sl@0	2769	{
sl@0	2770	return IsAdvancedPointerEvent() ? DoGetPointerNumber() : ENonAdvancedPointerPointerNumber;
sl@0	2771	}
sl@0	2772
sl@0	2773	inline TInt TAdvancedPointerEvent::Proximity() const
sl@0	2774	/** Gets the proximity of the pointer to the screen's surface.
sl@0	2775	Proximity units may vary between devices and may be non-linear.
sl@0	2776	Returned value will be a negative integer as the maximum supported proximity
sl@0	2777	range in Symbian OS is from KMinTInt to 0, where KMinTInt means the highest
sl@0	2778	proximity that Symbian OS can support and 0 means touching the screen.
sl@0	2779	HALData attributes provide more information about proximity support on particular
sl@0	2780	device.
sl@0	2781
sl@0	2782	On platforms without pointer proximity support, proximity is always assumed to be 0.
sl@0	2783
sl@0	2784	@return Proximity of the pointer to the screen's surface.
sl@0	2785	@see TAdvancedPointerEvent::Position3D()
sl@0	2786	@see TAdvancedPointerEvent::ProximityAndPressure()
sl@0	2787	@see HALData::EPointer3DMaxProximity
sl@0	2788	@see HALData::EPointer3DProximityStep */
sl@0	2789	{
sl@0	2790	return IsAdvancedPointerEvent() ? DoGetProximity() : ENonAdvancedPointerZCoordinate;
sl@0	2791	}
sl@0	2792
sl@0	2793	inline TInt TAdvancedPointerEvent::Pressure() const
sl@0	2794	/** Gets the pressure applied by the pointer to the screen.
sl@0	2795	Pressure units may vary between devices and may be non-linear.
sl@0	2796	Returned value will be a positive integer as the maximum supported pressure range
sl@0	2797	in Symbian OS is from 0 to KMaxTInt. HALData attributes provide more information
sl@0	2798	about pressure support on particular device.
sl@0	2799
sl@0	2800	On platforms without pointer pressure support, pressure is always assumed to be 0.
sl@0	2801
sl@0	2802	@return Pressure applied by the pointer to the screen.
sl@0	2803	@see TAdvancedPointerEvent::Pressure3D()
sl@0	2804	@see TAdvancedPointerEvent::ProximityAndPressure()
sl@0	2805	@see HALData::EPointer3DMaxPressure
sl@0	2806	@see HALData::EPointer3DPressureStep */
sl@0	2807	{
sl@0	2808	return IsAdvancedPointerEvent() ? DoGetPressure() : ENonAdvancedPointerZCoordinate;
sl@0	2809	}
sl@0	2810
sl@0	2811	inline TInt TAdvancedPointerEvent::ProximityAndPressure() const
sl@0	2812	/** Gets pressure applied by the pointer to the screen and proximity of the pointer
sl@0	2813	to the screen as one value. This is possible because the pointer is never in proximity
sl@0	2814	to the screen and pressing the screen at the same time.
sl@0	2815
sl@0	2816	@return The value of proximity if the pointer is in proximity to the screen; proximity
sl@0	2817	is always represented as negative TInt. The value of pressure if the pointer
sl@0	2818	is touching the screen; pressure is always represented as positive TInt.
sl@0	2819	@see TAdvancedPointerEvent::Proximity()
sl@0	2820	@see TAdvancedPointerEvent::Pressure()
sl@0	2821	@see TAdvancedPointerEvent::PositionAndPressure3D() */
sl@0	2822	{return IsAdvancedPointerEvent() ? DoGetProximityAndPressure() : ENonAdvancedPointerZCoordinate;}
sl@0	2823
sl@0	2824	inline TPoint3D TAdvancedPointerEvent::PositionAndPressure3D() const
sl@0	2825	/**
sl@0	2826	@return Pointer's X and Y coordinates plus combined proximity and pressure as
sl@0	2827	Z coordinate.
sl@0	2828	@see TAdvancedPointerEvent::ProximityAndPressure() */
sl@0	2829	{
sl@0	2830	TPoint3D point3D;
sl@0	2831	point3D.iX=iPosition.iX;
sl@0	2832	point3D.iY=iPosition.iY;
sl@0	2833	point3D.iZ=ProximityAndPressure();
sl@0	2834	return point3D;
sl@0	2835	}
sl@0	2836
sl@0	2837	inline TPoint3D TAdvancedPointerEvent::Position3D() const
sl@0	2838	/**
sl@0	2839	@return Pointer's X and Y coordinates plus pointer's proximity to the screen as
sl@0	2840	Z coordinate. Please note that returned Z coordinate will be always negative or 0.
sl@0	2841	@see TAdvancedPointerEvent::Proximity() */
sl@0	2842	{
sl@0	2843	TPoint3D point3D;
sl@0	2844	point3D.iX=iPosition.iX;
sl@0	2845	point3D.iY=iPosition.iY;
sl@0	2846	point3D.iZ=IsAdvancedPointerEvent() ? DoGetProximity() : ENonAdvancedPointerZCoordinate;
sl@0	2847	return point3D;
sl@0	2848	}
sl@0	2849
sl@0	2850	inline TPoint3D TAdvancedPointerEvent::Pressure3D() const
sl@0	2851	/**
sl@0	2852	@return Pointer's X and Y coordinates plus pressure applied by the pointer to the screen
sl@0	2853	as Z coordinate.
sl@0	2854	@see TAdvancedPointerEvent::Pressure() */
sl@0	2855	{
sl@0	2856	TPoint3D point3D;
sl@0	2857	point3D.iX=iPosition.iX;
sl@0	2858	point3D.iY=iPosition.iY;
sl@0	2859	point3D.iZ=IsAdvancedPointerEvent() ? DoGetPressure() : ENonAdvancedPointerZCoordinate;
sl@0	2860	return point3D;
sl@0	2861	}
sl@0	2862
sl@0	2863	inline TKeyEvent *TWsEvent::Key() const
sl@0	2864	/** Gets the key event.
sl@0	2865
sl@0	2866	This function can be used to get information about the key event if Type()
sl@0	2867	returns an event of type EEventKey, EEventKeyUp or EEventKeyDown.
sl@0	2868
sl@0	2869	@return Structure containing key event data */
sl@0	2870	{return((TKeyEvent *)&iEventData);}
sl@0	2871
sl@0	2872	inline TWsVisibilityChangedEvent* TWsEvent::VisibilityChanged()
sl@0	2873	/** Gets information about the visibility changed event.
sl@0	2874
sl@0	2875	This function can be used to get information about the visibility changed event
sl@0	2876	if Type() returns an event of type EEventWindowVisibilityChanged.
sl@0	2877
sl@0	2878	@return Structure containing visibility changed event data */
sl@0	2879	{ return reinterpret_cast<TWsVisibilityChangedEvent*>(iEventData); }
sl@0	2880
sl@0	2881	inline const TWsVisibilityChangedEvent* TWsEvent::VisibilityChanged() const
sl@0	2882	/** Gets information about the visibility changed event.
sl@0	2883
sl@0	2884	This function can be used to get information about the visibility changed event
sl@0	2885	if Type() returns an event of type EEventWindowVisibilityChanged.
sl@0	2886
sl@0	2887	@return Structure containing visibility changed event data */
sl@0	2888	{ return reinterpret_cast<const TWsVisibilityChangedEvent*>(iEventData); }
sl@0	2889
sl@0	2890	inline TWsDisplayChangedEvent* TWsEvent::DisplayChanged()
sl@0	2891	/** Gets information about the display changed event.
sl@0	2892
sl@0	2893	This function can be used to get information about the display changed event
sl@0	2894	if Type() returns an event of type EEventDisplayChanged.
sl@0	2895
sl@0	2896	@return Structure containing display changed event data */
sl@0	2897	{ return reinterpret_cast<TWsDisplayChangedEvent*>(iEventData); }
sl@0	2898
sl@0	2899	inline const TWsDisplayChangedEvent* TWsEvent::DisplayChanged() const
sl@0	2900	/** Gets information about the display changed event.
sl@0	2901
sl@0	2902	This function can be used to get information about the display changed event
sl@0	2903	if Type() returns an event of type EEventDisplayChanged.
sl@0	2904
sl@0	2905	@return Structure containing display changed event data */
sl@0	2906	{ return reinterpret_cast<const TWsDisplayChangedEvent*>(iEventData); }
sl@0	2907
sl@0	2908	inline TModifiersChangedEvent *TWsEvent::ModifiersChanged() const
sl@0	2909	/** Gets information about the modifier changed event.
sl@0	2910
sl@0	2911	This function can be used to get information about the modifier changed event
sl@0	2912	if Type() returns an event of type EEventModifiersChanged.
sl@0	2913
sl@0	2914	@return Structure containing modifier changed event data */
sl@0	2915	{return((TModifiersChangedEvent *)&iEventData);}
sl@0	2916
sl@0	2917	inline TWsErrorMessage *TWsEvent::ErrorMessage() const
sl@0	2918	/** Gets an error event.
sl@0	2919
sl@0	2920	This function can be used to get information about the error event if Type()
sl@0	2921	returns an event of type EEventErrorMessage.
sl@0	2922
sl@0	2923	@return The error event. */
sl@0	2924	{return((TWsErrorMessage *)&iEventData);}
sl@0	2925
sl@0	2926	inline TUint8 *TWsEvent::EventData() const
sl@0	2927	/** Gets information about the event.
sl@0	2928
sl@0	2929	This function gives you direct access to the event data as a whole. The event
sl@0	2930	can be a key or pointer event or it could be a new special event that only
sl@0	2931	you and another application know about. You are limited to EWsEventDataSize
sl@0	2932	bytes worth of data.
sl@0	2933
sl@0	2934	@return A pointer to the event data. */
sl@0	2935	{return((TUint8 *)&iEventData);}
sl@0	2936
sl@0	2937	inline TInt TWsEvent::Type() const
sl@0	2938	/** Gets the type of event that occurred.
sl@0	2939
sl@0	2940	@return The event type. Event types are defined in TEventCode. */
sl@0	2941	{return(iType);}
sl@0	2942
sl@0	2943	inline TUint TWsEvent::Handle() const
sl@0	2944	/** Gets the window handle.
sl@0	2945
sl@0	2946	This is the handle that was passed to the window's Construct() function: typically
sl@0	2947	it will be a pointer to the client-side object owning the window, providing
sl@0	2948	access to its member functions.
sl@0	2949
sl@0	2950	@return The window handle. */
sl@0	2951	{return(iHandle);}
sl@0	2952
sl@0	2953	inline TTime TWsEvent::Time() const
sl@0	2954	/** Gets the time when the event occurred.
sl@0	2955
sl@0	2956	@return The time when the event occurred. */
sl@0	2957	{return(iTime);}
sl@0	2958
sl@0	2959	inline void TWsEvent::SetType(TInt aType)
sl@0	2960	/** Sets the event type.
sl@0	2961
sl@0	2962	@param aType The event type. Event types are defined in TEventCode. */
sl@0	2963	{iType=aType;}
sl@0	2964
sl@0	2965	inline void TWsEvent::SetHandle(TUint aHandle)
sl@0	2966	/** Sets the event handle.
sl@0	2967
sl@0	2968	This is the client handle of the window that is being sent the event.
sl@0	2969
sl@0	2970	@param aHandle The event handle. */
sl@0	2971	{iHandle=aHandle;}
sl@0	2972
sl@0	2973	inline void TWsEvent::SetTimeNow()
sl@0	2974	/** Sets the event time to the current time. */
sl@0	2975	{iTime.UniversalTime();}
sl@0	2976
sl@0	2977	inline TInt *TWsEvent::Int() const
sl@0	2978	/** Gets the event data as a TInt.
sl@0	2979
sl@0	2980	For TWsEvents of type EEventPointerEnter and EEventPointerExit this is the pointer number
sl@0	2981	of the pointer that entered/exited the window. Please note that on platforms that
sl@0	2982	use the older Symbian OS, without multipointer support, pointer number is not initialized
sl@0	2983	for EEventPointerEnter and EEventPointerExit and thus it is random.
sl@0	2984
sl@0	2985	If the value of the attribute returned from HALData::EPointerNumberOfPointers is greater than 1,
sl@0	2986	then the system has multipointer support.
sl@0	2987
sl@0	2988	@see HALData::EPointerNumberOfPointers
sl@0	2989	@see HAL::Get(TAttribute,TInt&)
sl@0	2990	*/
sl@0	2991	{ return (TInt*)&iEventData; }
sl@0	2992
sl@0	2993	inline TUint TWsPriorityKeyEvent::Handle() const
sl@0	2994	/** Gets the handle for the window group which added the priority key.
sl@0	2995
sl@0	2996	This is the handle that was passed to the window group's Construct() function.
sl@0	2997	Since most applications have only one window group, however, this function
sl@0	2998	is rarely used.
sl@0	2999
sl@0	3000	@return The window group handle. */
sl@0	3001	{return(iHandle);}
sl@0	3002
sl@0	3003	inline TKeyEvent *TWsPriorityKeyEvent::Key() const
sl@0	3004	/** Gets the priority key event.
sl@0	3005
sl@0	3006	@return Structure containing priority key event data */
sl@0	3007	{return((TKeyEvent *)&iEventData);}
sl@0	3008
sl@0	3009	inline void TWsPriorityKeyEvent::SetHandle(TUint aHandle)
sl@0	3010	/** Sets the window group event handle.
sl@0	3011
sl@0	3012	This is the client handle of the window that is being sent the event.
sl@0	3013
sl@0	3014	@param aHandle The event handle. */
sl@0	3015	{iHandle=aHandle;}
sl@0	3016
sl@0	3017	inline CDirectScreenAccess::CDirectScreenAccess(RWsSession& aWs,CWsScreenDevice* aScreenDevice,RWindowBase& aWindow,MDirectScreenAccess& aAbort)
sl@0	3018	:CActive(RDirectScreenAccess::EPriorityVeryHigh), iWindow(aWindow), iAbort(aAbort), iDirectAccess(aWs)
sl@0	3019	{iWsScreenDevice=aScreenDevice;}
sl@0	3020
sl@0	3021	inline CFbsBitGc* CDirectScreenAccess::Gc()
sl@0	3022	/** Gets the graphics context for drawing to the screen.
sl@0	3023
sl@0	3024	This is set up by calling StartL(). Its origin is set so that you should use
sl@0	3025	window coordinates to specify which part of the screen to draw to and its
sl@0	3026	clipping region is set to the visible part of the window.
sl@0	3027
sl@0	3028	Code built to run on the Emulator must call CFbsScreenDevice::Update() in
sl@0	3029	order to see the results of drawing to this graphics context, but this may
sl@0	3030	not be required on all target hardware.
sl@0	3031
sl@0	3032	@return The graphics context for drawing to the screen. */
sl@0	3033	{ return iGc; }
sl@0	3034
sl@0	3035	inline CFbsScreenDevice*& CDirectScreenAccess::ScreenDevice()
sl@0	3036	/** Gets the screen device to draw to.
sl@0	3037
sl@0	3038	You should not use this screen device to create fonts because the object is
sl@0	3039	deleted and recreated when direct screen access is aborted and restarted.
sl@0	3040	Instead, create and use your own CFbsScreenDevice object to create fonts.
sl@0	3041
sl@0	3042	@return The target screen device. */
sl@0	3043	{ return iScreenDevice; }
sl@0	3044
sl@0	3045	inline RRegion* CDirectScreenAccess::DrawingRegion()
sl@0	3046	/** Gets the clipping region to draw to.
sl@0	3047
sl@0	3048	You must not draw outside of this region.
sl@0	3049
sl@0	3050	The clipping region is calculated when StartL() is called, and is only updated
sl@0	3051	if StartL() is called again.
sl@0	3052
sl@0	3053	The region is specified in screen coordinates. This can be useful if you need
sl@0	3054	to reapply the clipping region to the graphics context (CFbsBitGc::SetClippingRegion()).
sl@0	3055
sl@0	3056	@return The clipping region to draw to. */
sl@0	3057	{ return iDrawingRegion; }
sl@0	3058
sl@0	3059	#endif //__W32STD_H__

author	sl
	Tue, 10 Jun 2014 14:32:02 +0200
changeset 1	260cb5ec6c19
permissions	-rw-r--r--