<?xml version="1.0" encoding="utf-8"?>

<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

<!-- This component and the accompanying materials are made available under the terms of the License 

"Eclipse Public License v1.0" which accompanies this distribution, 

and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

<!-- Initial Contributors:

    Nokia Corporation - initial contribution.

Contributors: 

-->

<!DOCTYPE concept

  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

<concept id="GUID-7AC3477E-09C1-519A-9079-DA969B9FC4D7" xml:lang="en"><title>General

events</title><shortdesc>In this context, a general event is any kind of event that is generated

by the Window Server and delivered to the client, with the exception of redraw

and priority key events. </shortdesc><prolog><metadata><keywords/></metadata></prolog><conbody>

<p> <b>Variant</b>: <xref href="GUID-D93978BE-11A3-5CE3-B110-1DEAA5AD566C.dita">ScreenPlay</xref> and <xref href="GUID-F64E6551-670E-5E12-8103-DE504D3EC94F.dita">non-ScreenPlay</xref>. <b>Target

audience</b>: Application developers. </p>

<p>All events generated by the Window Server, except redraw events and priority

key events, are delivered to the client in a <codeph>TWsEvent</codeph> which

is requested asynchronously by the <xref href="GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9.dita#GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9/GUID-0F961C4D-A731-3AE0-8425-BB304CCF2736"><apiname>RWsSession::EventReady()</apiname></xref> function.

When this request completes, it is handled by an active object <xref href="GUID-067293BF-B28C-3CEC-92F4-1351A795EA7F.dita#GUID-067293BF-B28C-3CEC-92F4-1351A795EA7F/GUID-5D018F25-5173-36C1-A0B9-5C3A33211C5D"><apiname>CActive::RunL()</apiname></xref> function

which must use <xref href="GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9.dita#GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9/GUID-06AA86EE-4494-3990-935A-62B9E995DAC2"><apiname>RWsSession::GetEvent()</apiname></xref> to get the <xref href="GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31.dita"><apiname>TWsEvent</apiname></xref> representing

the event. The <xref href="GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31.dita#GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31/GUID-8FA62E05-3FE8-39B0-81ED-5FBF2D941739"><apiname>TWsEvent::Type()</apiname></xref> function is used to identify

the event type which can then retrieve the appropriate type of data. </p>

<p>The following table lists for each event type returned by <xref href="GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31.dita#GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31/GUID-8FA62E05-3FE8-39B0-81ED-5FBF2D941739"><apiname>TWsEvent::Type()</apiname></xref>,

what object <xref href="GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31.dita#GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31/GUID-13CA6935-906D-368D-8AEA-C91722FD4484"><apiname>TWsEvent::EventData()</apiname></xref> returns, and what the <xref href="GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31.dita#GUID-5D0B1595-1AC7-3C44-AC6B-0EFB5EABCF31/GUID-D3C8402C-F6C1-3F9F-A3E4-0C5D782BCB3B"><apiname>TWsEvent::Handle()</apiname></xref> represents. </p>

<table id="GUID-C9628ADC-3B69-502A-86DE-9B531E4F9C36">

<tgroup cols="3"><colspec colname="col0"/><colspec colname="col1"/><colspec colname="col2"/>

<tbody>

<row>

<entry><p> <b>TWsEvent::Type()</b>  </p> </entry>

<entry><p> <b>TWsEvent::EventData()</b>  </p> </entry>

<entry><p> <b>TWsEvent::Handle()</b>  </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-A732E57F-EEF0-3276-AE32-6D43433A52C1.dita"><apiname>EEventNull</apiname></xref>  </p> </entry>

<entry><p>n/a </p> </entry>

<entry><p>n/a </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-52320E57-26F3-3CF2-833B-D133A7FF407D.dita"><apiname>EEventKey</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-0F8FA6A3-F172-36E4-9CF5-60814ABCD562.dita"><apiname>TKeyEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-134B5EE2-C56B-3B12-9392-D855C8D1E688.dita"><apiname>EEventKeyUp</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-0F8FA6A3-F172-36E4-9CF5-60814ABCD562.dita"><apiname>TKeyEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-14570DB4-92CF-3233-9B58-910BDFB7AA21.dita"><apiname>EEventKeyDown</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-0F8FA6A3-F172-36E4-9CF5-60814ABCD562.dita"><apiname>TKeyEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-B91D402F-880A-3A6C-A635-0EA596D758AB.dita"><apiname>EEventModifiersChanged</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-2BB50790-20B3-3F02-B94F-32F1F25088EC.dita"><apiname>TModifiersChangedEvent</apiname></xref>  </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableModifierChangedEvents()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-4B20CDF2-EEEC-3963-80F0-6CFE1DAD1B1E.dita"><apiname>EEventPointer</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-1FFA0073-3D83-388E-A824-08C31F90CC54.dita"><apiname>TPointerEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-683603DD-F3D3-3193-BEB3-8236C7DE7F79.dita"><apiname>RWindow</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-4C658DF7-A277-323E-8CEF-248CCB1DB5B3.dita"><apiname>EEventPointerEnter</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-1FFA0073-3D83-388E-A824-08C31F90CC54.dita"><apiname>TPointerEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-683603DD-F3D3-3193-BEB3-8236C7DE7F79.dita"><apiname>RWindow</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-41AC379A-1528-3E06-9FFC-18B084C00182.dita"><apiname>EEventPointerExit</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-1FFA0073-3D83-388E-A824-08C31F90CC54.dita"><apiname>TPointerEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-683603DD-F3D3-3193-BEB3-8236C7DE7F79.dita"><apiname>RWindow</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-0C2C336A-2477-333A-9256-440112ABFE01.dita"><apiname>EEventPointerBufferReady</apiname></xref>  </p> </entry>

<entry><p>None - call <xref href="GUID-1460DD8F-9AA1-3B99-8FFD-F309959CCA34.dita#GUID-1460DD8F-9AA1-3B99-8FFD-F309959CCA34/GUID-C6BBCA6B-1867-36D9-AFCE-23B2DBD60D41"><apiname>RWindowBase::RetrievePointerMoveBuffer()</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-683603DD-F3D3-3193-BEB3-8236C7DE7F79.dita"><apiname>RWindow</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-D8117586-0B73-3C2C-836A-0EE657307F21.dita"><apiname>EEventDragDrop</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-1FFA0073-3D83-388E-A824-08C31F90CC54.dita"><apiname>TPointerEvent</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-683603DD-F3D3-3193-BEB3-8236C7DE7F79.dita"><apiname>RWindow</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-D772DB47-64EC-3EC4-A96F-651E57950C98.dita"><apiname>EEventFocusLost</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-D676F562-6B90-34C7-9A77-094FF318F373.dita"><apiname>EEventFocusGained</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-28734D1F-0B5D-3BD7-BFEF-1BFCF86C115F.dita"><apiname>EEventSwitchOn</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableOnEvents()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-CED18E61-2843-3C6E-8097-15D94066F456.dita"><apiname>EEventPassword</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> of the

window on which <codeph>PasswordWindow()</codeph> was called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-65C5CFC3-59E5-3D23-9594-C7E9546CFA53.dita"><apiname>EEventWindowGroupsChanged</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita#GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D/GUID-69E4997A-05F8-3597-A4F6-F785D825C18F"><apiname>RWindowTreeNode::EnableGroupChangeEvents()</apiname></xref> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-3FEDC3D5-2970-3BA3-8357-D053189ABD84.dita"><apiname>EEventErrorMessage</apiname></xref>  </p> </entry>

<entry><p> <xref href="GUID-741974B7-E1A6-3D10-9428-C978E9815FF8.dita"><apiname>TWsErrorMessage</apiname></xref>  </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableErrorMessages()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-84D3B6AD-EC6C-3976-884C-B69606E572B4.dita"><apiname>EEventMessageReady</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p> <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita"><apiname>RWindowGroup</apiname></xref> client handle </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-95EA6ECD-5826-3444-8EF7-9D580F34A9B6.dita"><apiname>EEventMarkInvalid</apiname></xref>  </p> </entry>

<entry><p>n/a </p> </entry>

<entry><p>n/a </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-D32F82E6-020F-300C-957A-3FB0732AD432.dita"><apiname>EEventSwitchOff</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> passed

into <xref href="GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9.dita#GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9/GUID-5785C563-A814-33AB-B031-E7AFEE04AA52"><apiname>RWsSession::RequestOffEvents()</apiname></xref>. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-380E2291-BA47-3275-9E80-029CB5421E19.dita"><apiname>EEventKeySwitchOff</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> passed

into <xref href="GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9.dita#GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9/GUID-5785C563-A814-33AB-B031-E7AFEE04AA52"><apiname>RWsSession::RequestOffEvents()</apiname></xref>. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-CC1E6B2E-F68F-3A00-B4EA-4917007F7320.dita"><apiname>EEventScreenDeviceChanged</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the object on which <xref href="GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25.dita#GUID-64D4D428-D65F-3D9D-A0D4-C8338C848B25/GUID-347F1B5F-726F-3B1B-9764-E0D6EF2C6B12"><apiname>RWindowGroup::EnableScreenChangeEvents()</apiname></xref> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-6426E0A6-35F2-3704-962C-0A8AE8AF7226.dita"><apiname>EEventDisplayChanged</apiname></xref> </p> </entry>

<entry><p> <xref href="GUID-BE2F1305-EB64-3A15-9BD7-38267A96D332.dita"><apiname>TWsDisplayChangedEvent</apiname></xref>  </p> </entry>

<entry><p>The client handle of the <xref href="GUID-30479BE3-296E-3B4D-914D-B080ABD733E4.dita"><apiname>CWsScreenDevice</apiname></xref> object

on which <xref href="GUID-0C384D35-77DD-318E-AF3E-C9ED5ADD9D11.dita#GUID-0C384D35-77DD-318E-AF3E-C9ED5ADD9D11/GUID-6C3311C5-658A-372A-8E71-27E0D728E8B5"><apiname>MDisplayControl::                 EnableDisplayChangeEvents()</apiname></xref> was

called. See <xref href="GUID-B1CB6374-2C2B-5D6C-9A7C-6E49D8F235B8.dita">Display

Control and Mapping in the Window Server Client</xref> for more information. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-C2615B3C-9429-31F0-94B5-2EA336F506DE.dita"><apiname>EEventFocusGroupChanged</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableFocusChangeEvents()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-724E8B4B-A018-35FE-A976-B50B4AD37A9A.dita"><apiname>EEventWindowVisibilityChanged</apiname></xref>  </p></entry>

<entry><p> <xref href="GUID-F7CDA73B-AA31-3174-B7DD-0D7DC1505447.dita"><apiname>TWsVisibilityChangedEvent</apiname></xref>  </p></entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableVisibilityChangeEvents()</codeph> was

called. </p></entry>

</row>

<row>

<entry><p> <xref href="GUID-1CBB7D32-8544-3291-ADE5-2BCDAD5840E3.dita"><apiname>EEventCaseOpened</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableOnEvents()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-8E2BB38A-13A6-309F-AC32-4966DAF9CEB9.dita"><apiname>EEventCaseClosed</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> passed

into <xref href="GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9.dita#GUID-643DDA78-C7A7-386D-AB3F-8710141DDDA9/GUID-5785C563-A814-33AB-B031-E7AFEE04AA52"><apiname>RWsSession::RequestOffEvents()</apiname></xref>. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-BAD749BC-47D1-3FE1-8073-FF404DA65A2E.dita"><apiname>EEventWindowGroupListChanged</apiname></xref>  </p> </entry>

<entry><p>None </p> </entry>

<entry><p>The client handle of the <xref href="GUID-9FFD28C7-8747-3438-84BF-44AF26ACEC7D.dita"><apiname>RWindowTreeNode</apiname></xref> on which <codeph>EnableGroupListChangeEvents()</codeph> was

called. </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-9D83496D-2DE1-3217-8BB8-F0A6D82BA9FF.dita"><apiname>EEventKeyRepeat</apiname></xref>  </p> </entry>

<entry><p>n/a (only sent to the key click plug-in interface) </p> </entry>

<entry><p>n/a </p> </entry>

</row>

<row>

<entry><p> <xref href="GUID-946FF333-2651-35ED-A2D4-CC417DB32F2A.dita"><apiname>EEventUser</apiname></xref>  </p> </entry>

<entry><p>n/a </p> </entry>

<entry><p>n/a </p> </entry>

</row>

</tbody>

</tgroup>

</table></conbody><related-links>

<link href="GUID-CD550DE7-D013-527B-BADE-5CB122C352C8.dita"><linktext>Pointer Handling</linktext>

</link>

<link href="GUID-B7FF0B9C-3A17-5AAA-A986-7BA4F44DBD41.dita"><linktext>Declaring

a Window Server Event-Handling Class</linktext></link>

<link href="GUID-B830A1F7-9220-5879-80BE-C494A4CD155B.dita"><linktext>Handling

General Events</linktext></link>

<link href="GUID-A51D3749-442A-54E8-8EB5-BF907694CD8C.dita"><linktext>Processing

Window-Group Events</linktext></link>

<link href="GUID-E1E11C95-3400-548B-AEEE-577DA8FB9ECB.dita"><linktext>Processing

Window Events</linktext></link>

<link href="GUID-930A3ABD-84FB-5D76-938C-79383273DAE6.dita"><linktext>Processing

System Events</linktext></link>

</related-links></concept>