]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gdk/tmpl/events.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gdk / tmpl / events.sgml
index 64fdbbd713b3abee5389120401ab3d1a8019943b..392cd078e53fd5797b59de8ccc3322cc3f6ae9c6 100644 (file)
@@ -2,7 +2,7 @@
 Events
 
 <!-- ##### SECTION Short_Description ##### -->
-functions for handling events from the window system.
+Functions for handling events from the window system
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -27,6 +27,12 @@ The structs used for each type of event.
 </variablelist>
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### ENUM GdkEventType ##### -->
 <para>
 Specifies the type of the event.
@@ -81,9 +87,17 @@ has changed.
 @GDK_VISIBILITY_NOTIFY: the window visibility status has changed.
 @GDK_NO_EXPOSE: indicates that the source region was completely available
 when parts of a drawable were copied. This is not very useful.
-@GDK_SCROLL: 
-@GDK_WINDOW_STATE: 
-@GDK_SETTING: 
+@GDK_SCROLL: the scroll wheel was turned
+@GDK_WINDOW_STATE: the state of a window has changed. See #GdkWindowState
+for the possible window states
+@GDK_SETTING: a setting has been modified.
+@GDK_OWNER_CHANGE: the owner of a selection has changed. This event type
+  was added in 2.6
+@GDK_GRAB_BROKEN: a pointer or keyboard grab was broken. This event type
+  was added in 2.8.
+@GDK_DAMAGE: the content of the window has been changed. This event type
+  was added in 2.14.
+@GDK_EVENT_LAST: marks the end of the GdkEventType enumeration. Added in 2.18
 
 <!-- ##### ENUM GdkEventMask ##### -->
 <para>
@@ -96,32 +110,35 @@ above.
 number of %GDK_MOTION_NOTIFY events received. Normally a %GDK_MOTION_NOTIFY
 event is received each time the mouse moves. However, if the application
 spends a lot of time processing the event (updating the display, for example),
-it can easily lag behind the position of the mouse. When using the
-%GDK_POINTER_MOTION_HINT_MASK the server will only send %GDK_MOTION_NOTIFY
-events when the application asks for them, by calling gdk_window_get_pointer().
-</para>
-
-@GDK_EXPOSURE_MASK: 
-@GDK_POINTER_MOTION_MASK: 
-@GDK_POINTER_MOTION_HINT_MASK: 
-@GDK_BUTTON_MOTION_MASK: 
-@GDK_BUTTON1_MOTION_MASK: 
-@GDK_BUTTON2_MOTION_MASK: 
-@GDK_BUTTON3_MOTION_MASK: 
-@GDK_BUTTON_PRESS_MASK: 
-@GDK_BUTTON_RELEASE_MASK: 
-@GDK_KEY_PRESS_MASK: 
-@GDK_KEY_RELEASE_MASK: 
-@GDK_ENTER_NOTIFY_MASK: 
-@GDK_LEAVE_NOTIFY_MASK: 
-@GDK_FOCUS_CHANGE_MASK: 
-@GDK_STRUCTURE_MASK: 
-@GDK_PROPERTY_CHANGE_MASK: 
-@GDK_VISIBILITY_NOTIFY_MASK: 
-@GDK_PROXIMITY_IN_MASK: 
-@GDK_PROXIMITY_OUT_MASK: 
-@GDK_SUBSTRUCTURE_MASK: 
-@GDK_SCROLL_MASK: 
+it can lag behind the position of the mouse. When using
+%GDK_POINTER_MOTION_HINT_MASK, fewer %GDK_MOTION_NOTIFY events will be sent,
+some of which are marked as a hint (the is_hint member is %TRUE).
+To receive more motion events after a motion hint event, the application
+needs to asks for more, by calling gdk_event_request_motions().
+</para>
+
+@GDK_EXPOSURE_MASK: receive expose events
+@GDK_POINTER_MOTION_MASK: receive all pointer motion events
+@GDK_POINTER_MOTION_HINT_MASK: see the explanation above
+@GDK_BUTTON_MOTION_MASK: receive pointer motion events while any button is pressed
+@GDK_BUTTON1_MOTION_MASK: receive pointer motion events while 1 button is pressed
+@GDK_BUTTON2_MOTION_MASK: receive pointer motion events while 2 button is pressed
+@GDK_BUTTON3_MOTION_MASK: receive pointer motion events while 3 button is pressed
+@GDK_BUTTON_PRESS_MASK: receive button press events
+@GDK_BUTTON_RELEASE_MASK: receive button release events
+@GDK_KEY_PRESS_MASK: receive key press events
+@GDK_KEY_RELEASE_MASK: receive key release events
+@GDK_ENTER_NOTIFY_MASK: receive window enter events
+@GDK_LEAVE_NOTIFY_MASK: receive window leave events
+@GDK_FOCUS_CHANGE_MASK: receive focus change events
+@GDK_STRUCTURE_MASK: receive events about window configuration change
+@GDK_PROPERTY_CHANGE_MASK: receive property change events
+@GDK_VISIBILITY_NOTIFY_MASK: receive visibility change events
+@GDK_PROXIMITY_IN_MASK: receive proximity in events
+@GDK_PROXIMITY_OUT_MASK: receive proximity out events
+@GDK_SUBSTRUCTURE_MASK: receive events about window configuration changes of 
+  child windows
+@GDK_SCROLL_MASK: receive scroll events
 @GDK_ALL_EVENTS_MASK: the combination of all the above event masks.
 
 <!-- ##### MACRO GDK_CURRENT_TIME ##### -->
@@ -151,43 +168,48 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 <para>
 </para>
 
-@Returns:
+@void: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_event_peek ##### -->
 <para>
 </para>
 
-@Returns:
+@void: 
+@Returns: 
+
 
 <!-- ##### FUNCTION gdk_event_get ##### -->
 <para>
 </para>
 
-@Returns:
+@void: 
+@Returns: 
 
 
-<!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
+<!-- ##### FUNCTION gdk_event_put ##### -->
 <para>
 </para>
 
-@window:
-@Returns:
+@event: 
 
 
-<!-- ##### FUNCTION gdk_event_put ##### -->
+<!-- ##### FUNCTION gdk_event_new ##### -->
 <para>
+
 </para>
 
-@event:
+@type: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_event_copy ##### -->
 <para>
 </para>
 
-@event:
-@Returns:
+@event: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_event_free ##### -->
@@ -201,8 +223,8 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 <para>
 </para>
 
-@event:
-@Returns:
+@event: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_event_get_state ##### -->
@@ -248,13 +270,21 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
 @Returns: 
 
 
+<!-- ##### FUNCTION gdk_event_request_motions ##### -->
+<para>
+
+</para>
+
+@event: 
+
+
 <!-- ##### FUNCTION gdk_event_handler_set ##### -->
 <para>
 </para>
 
-@func:
-@data:
-@notify:
+@func: 
+@data: 
+@notify: 
 
 
 <!-- ##### USER_FUNCTION GdkEventFunc ##### -->
@@ -272,16 +302,27 @@ gdk_event_handler_set().
 <para>
 </para>
 
-@event:
-@xid:
-@Returns:
+@event: 
+@winid: 
+@Returns: 
+
+
+<!-- ##### FUNCTION gdk_event_send_client_message_for_display ##### -->
+<para>
+
+</para>
+
+@display: 
+@event: 
+@winid: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
 <para>
 </para>
 
-@event:
+@event: 
 
 
 <!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
@@ -289,30 +330,49 @@ gdk_event_handler_set().
 </para>
 
 @message_type: 
-@func:
-@data:
+@func: 
+@data: 
 
 
 <!-- ##### FUNCTION gdk_get_show_events ##### -->
 <para>
 </para>
 
-@Returns:
+@void: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_set_show_events ##### -->
 <para>
 </para>
 
-@show_events:
+@show_events: 
+
+
+<!-- ##### FUNCTION gdk_event_set_screen ##### -->
+<para>
+
+</para>
+
+@event: 
+@screen: 
+
+
+<!-- ##### FUNCTION gdk_event_get_screen ##### -->
+<para>
+
+</para>
+
+@event: 
+@Returns: 
 
 
 <!-- ##### FUNCTION gdk_setting_get ##### -->
 <para>
 </para>
 
-@name:
-@value:
-@Returns:
+@name: 
+@value: 
+@Returns: