1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
29 #include "gdkinternals.h"
30 #include "gdkdisplayprivate.h"
38 * @Short_description: Functions for handling events from the window system
40 * @See_also: <link linkend="gdk-Event-Structures">Event Structures</link>
42 * This section describes functions dealing with events from the window
45 * In GTK+ applications the events are handled automatically in
46 * gtk_main_do_event() and passed on to the appropriate widgets, so these
47 * functions are rarely needed. Though some of the fields in the
48 * <link linkend="gdk-Event-Structures">Event Structures</link> are useful.
52 typedef struct _GdkIOClosure GdkIOClosure;
56 GDestroyNotify notify;
60 /* Private variable declarations
63 static GdkEventFunc _gdk_event_func = NULL; /* Callback for events */
64 static gpointer _gdk_event_data = NULL;
65 static GDestroyNotify _gdk_event_notify = NULL;
68 _gdk_event_emit (GdkEvent *event)
71 (*_gdk_event_func) (event, _gdk_event_data);
74 /*********************************************
75 * Functions for maintaining the event queue *
76 *********************************************/
79 * _gdk_event_queue_find_first:
80 * @display: a #GdkDisplay
82 * Find the first event on the queue that is not still
85 * Return value: Pointer to the list node for that event, or NULL.
88 _gdk_event_queue_find_first (GdkDisplay *display)
90 GList *tmp_list = display->queued_events;
94 GdkEventPrivate *event = tmp_list->data;
95 if (!(event->flags & GDK_EVENT_PENDING))
98 tmp_list = g_list_next (tmp_list);
105 * _gdk_event_queue_prepend:
106 * @display: a #GdkDisplay
107 * @event: Event to prepend.
109 * Prepends an event before the head of the event queue.
111 * Returns: the newly prepended list node.
114 _gdk_event_queue_prepend (GdkDisplay *display,
117 display->queued_events = g_list_prepend (display->queued_events, event);
118 if (!display->queued_tail)
119 display->queued_tail = display->queued_events;
120 return display->queued_events;
124 * _gdk_event_queue_append:
125 * @display: a #GdkDisplay
126 * @event: Event to append.
128 * Appends an event onto the tail of the event queue.
130 * Returns: the newly appended list node.
133 _gdk_event_queue_append (GdkDisplay *display,
136 display->queued_tail = g_list_append (display->queued_tail, event);
138 if (!display->queued_events)
139 display->queued_events = display->queued_tail;
141 display->queued_tail = display->queued_tail->next;
143 return display->queued_tail;
147 * _gdk_event_queue_insert_after:
148 * @display: a #GdkDisplay
149 * @sibling: Append after this event.
150 * @event: Event to append.
152 * Appends an event after the specified event, or if it isn't in
153 * the queue, onto the tail of the event queue.
155 * Returns: the newly appended list node.
160 _gdk_event_queue_insert_after (GdkDisplay *display,
164 GList *prev = g_list_find (display->queued_events, sibling);
165 if (prev && prev->next)
167 display->queued_events = g_list_insert_before (display->queued_events, prev->next, event);
171 return _gdk_event_queue_append (display, event);
175 * _gdk_event_queue_insert_after:
176 * @display: a #GdkDisplay
177 * @sibling: Append after this event.
178 * @event: Event to append.
180 * Appends an event before the specified event, or if it isn't in
181 * the queue, onto the tail of the event queue.
183 * Returns: the newly appended list node.
188 _gdk_event_queue_insert_before (GdkDisplay *display,
192 GList *next = g_list_find (display->queued_events, sibling);
195 display->queued_events = g_list_insert_before (display->queued_events, next, event);
199 return _gdk_event_queue_append (display, event);
204 * _gdk_event_queue_remove_link:
205 * @display: a #GdkDisplay
206 * @node: node to remove
208 * Removes a specified list node from the event queue.
211 _gdk_event_queue_remove_link (GdkDisplay *display,
215 node->prev->next = node->next;
217 display->queued_events = node->next;
220 node->next->prev = node->prev;
222 display->queued_tail = node->prev;
226 * _gdk_event_unqueue:
227 * @display: a #GdkDisplay
229 * Removes and returns the first event from the event
230 * queue that is not still being filled in.
232 * Return value: the event, or %NULL. Ownership is transferred
236 _gdk_event_unqueue (GdkDisplay *display)
238 GdkEvent *event = NULL;
241 tmp_list = _gdk_event_queue_find_first (display);
245 event = tmp_list->data;
246 _gdk_event_queue_remove_link (display, tmp_list);
247 g_list_free_1 (tmp_list);
254 * gdk_event_handler_set:
255 * @func: the function to call to handle events from GDK.
256 * @data: user data to pass to the function.
257 * @notify: the function to call when the handler function is removed, i.e. when
258 * gdk_event_handler_set() is called with another event handler.
260 * Sets the function to call to handle all events from GDK.
262 * Note that GTK+ uses this to install its own event handler, so it is
263 * usually not useful for GTK+ applications. (Although an application
264 * can call this function then call gtk_main_do_event() to pass
268 gdk_event_handler_set (GdkEventFunc func,
270 GDestroyNotify notify)
272 if (_gdk_event_notify)
273 (*_gdk_event_notify) (_gdk_event_data);
275 _gdk_event_func = func;
276 _gdk_event_data = data;
277 _gdk_event_notify = notify;
281 * gdk_events_pending:
283 * Checks if any events are ready to be processed for any display.
285 * Return value: %TRUE if any events are pending.
288 gdk_events_pending (void)
294 list = gdk_display_manager_list_displays (gdk_display_manager_get ());
295 for (l = list; l; l = l->next)
297 if (_gdk_event_queue_find_first (l->data))
304 for (l = list; l; l = l->next)
306 if (gdk_display_has_pending (l->data))
322 * Checks all open displays for a #GdkEvent to process,to be processed
323 * on, fetching events from the windowing system if necessary.
324 * See gdk_display_get_event().
326 * Return value: the next #GdkEvent to be processed, or %NULL if no events
327 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
336 list = gdk_display_manager_list_displays (gdk_display_manager_get ());
337 for (l = list; l; l = l->next)
339 event = gdk_display_get_event (l->data);
352 * If there is an event waiting in the event queue of some open
353 * display, returns a copy of it. See gdk_display_peek_event().
355 * Return value: a copy of the first #GdkEvent on some event queue, or %NULL if no
356 * events are in any queues. The returned #GdkEvent should be freed with
360 gdk_event_peek (void)
366 list = gdk_display_manager_list_displays (gdk_display_manager_get ());
367 for (l = list; l; l = l->next)
369 event = gdk_display_peek_event (l->data);
381 * @event: a #GdkEvent.
383 * Appends a copy of the given event onto the front of the event
384 * queue for event->any.window's display, or the default event
385 * queue if event->any.window is %NULL. See gdk_display_put_event().
388 gdk_event_put (const GdkEvent *event)
392 g_return_if_fail (event != NULL);
394 if (event->any.window)
395 display = gdk_window_get_display (event->any.window);
399 g_message ("Falling back to default display for gdk_event_put()"));
400 display = gdk_display_get_default ();
403 gdk_display_put_event (display, event);
406 static GHashTable *event_hash = NULL;
410 * @type: a #GdkEventType
412 * Creates a new event of the given type. All fields are set to 0.
414 * Return value: a newly-allocated #GdkEvent. The returned #GdkEvent
415 * should be freed with gdk_event_free().
420 gdk_event_new (GdkEventType type)
422 GdkEventPrivate *new_private;
426 event_hash = g_hash_table_new (g_direct_hash, NULL);
428 new_private = g_slice_new0 (GdkEventPrivate);
430 new_private->flags = 0;
431 new_private->screen = NULL;
433 g_hash_table_insert (event_hash, new_private, GUINT_TO_POINTER (1));
435 new_event = (GdkEvent *) new_private;
437 new_event->any.type = type;
440 * Bytewise 0 initialization is reasonable for most of the
441 * current event types. Explicitely initialize double fields
442 * since I trust bytewise 0 == 0. less than for integers
447 case GDK_MOTION_NOTIFY:
448 new_event->motion.x = 0.;
449 new_event->motion.y = 0.;
450 new_event->motion.x_root = 0.;
451 new_event->motion.y_root = 0.;
453 case GDK_BUTTON_PRESS:
454 case GDK_2BUTTON_PRESS:
455 case GDK_3BUTTON_PRESS:
456 case GDK_BUTTON_RELEASE:
457 new_event->button.x = 0.;
458 new_event->button.y = 0.;
459 new_event->button.x_root = 0.;
460 new_event->button.y_root = 0.;
463 new_event->scroll.x = 0.;
464 new_event->scroll.y = 0.;
465 new_event->scroll.x_root = 0.;
466 new_event->scroll.y_root = 0.;
468 case GDK_ENTER_NOTIFY:
469 case GDK_LEAVE_NOTIFY:
470 new_event->crossing.x = 0.;
471 new_event->crossing.y = 0.;
472 new_event->crossing.x_root = 0.;
473 new_event->crossing.y_root = 0.;
483 gdk_event_is_allocated (const GdkEvent *event)
486 return g_hash_table_lookup (event_hash, event) != NULL;
493 * @event: a #GdkEvent
495 * Copies a #GdkEvent, copying or incrementing the reference count of the
496 * resources associated with it (e.g. #GdkWindow's and strings).
498 * Return value: a copy of @event. The returned #GdkEvent should be freed with
502 gdk_event_copy (const GdkEvent *event)
504 GdkEventPrivate *new_private;
507 g_return_val_if_fail (event != NULL, NULL);
509 new_event = gdk_event_new (GDK_NOTHING);
510 new_private = (GdkEventPrivate *)new_event;
513 if (new_event->any.window)
514 g_object_ref (new_event->any.window);
516 if (gdk_event_is_allocated (event))
518 GdkEventPrivate *private = (GdkEventPrivate *)event;
520 new_private->screen = private->screen;
521 new_private->device = private->device;
524 switch (event->any.type)
527 case GDK_KEY_RELEASE:
528 new_event->key.string = g_strdup (event->key.string);
531 case GDK_ENTER_NOTIFY:
532 case GDK_LEAVE_NOTIFY:
533 if (event->crossing.subwindow != NULL)
534 g_object_ref (event->crossing.subwindow);
539 case GDK_DRAG_MOTION:
540 case GDK_DRAG_STATUS:
542 case GDK_DROP_FINISHED:
543 g_object_ref (event->dnd.context);
548 if (event->expose.region)
549 new_event->expose.region = cairo_region_copy (event->expose.region);
553 new_event->setting.name = g_strdup (new_event->setting.name);
556 case GDK_BUTTON_PRESS:
557 case GDK_BUTTON_RELEASE:
558 if (event->button.axes)
559 new_event->button.axes = g_memdup (event->button.axes,
560 sizeof (gdouble) * gdk_device_get_n_axes (event->button.device));
563 case GDK_MOTION_NOTIFY:
564 if (event->motion.axes)
565 new_event->motion.axes = g_memdup (event->motion.axes,
566 sizeof (gdouble) * gdk_device_get_n_axes (event->motion.device));
573 if (gdk_event_is_allocated (event))
574 _gdk_display_event_data_copy (gdk_display_get_default (), event, new_event);
581 * @event: a #GdkEvent.
583 * Frees a #GdkEvent, freeing or decrementing any resources associated with it.
584 * Note that this function should only be called with events returned from
585 * functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
586 * and gdk_event_new().
589 gdk_event_free (GdkEvent *event)
591 g_return_if_fail (event != NULL);
593 if (event->any.window)
594 g_object_unref (event->any.window);
596 switch (event->any.type)
599 case GDK_KEY_RELEASE:
600 g_free (event->key.string);
603 case GDK_ENTER_NOTIFY:
604 case GDK_LEAVE_NOTIFY:
605 if (event->crossing.subwindow != NULL)
606 g_object_unref (event->crossing.subwindow);
611 case GDK_DRAG_MOTION:
612 case GDK_DRAG_STATUS:
614 case GDK_DROP_FINISHED:
615 if (event->dnd.context != NULL)
616 g_object_unref (event->dnd.context);
619 case GDK_BUTTON_PRESS:
620 case GDK_BUTTON_RELEASE:
621 g_free (event->button.axes);
626 if (event->expose.region)
627 cairo_region_destroy (event->expose.region);
630 case GDK_MOTION_NOTIFY:
631 g_free (event->motion.axes);
635 g_free (event->setting.name);
642 _gdk_display_event_data_free (gdk_display_get_default (), event);
644 g_hash_table_remove (event_hash, event);
645 g_slice_free (GdkEventPrivate, (GdkEventPrivate*) event);
649 * gdk_event_get_time:
650 * @event: a #GdkEvent
652 * Returns the time stamp from @event, if there is one; otherwise
653 * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
655 * Return value: time stamp field from @event
658 gdk_event_get_time (const GdkEvent *event)
663 case GDK_MOTION_NOTIFY:
664 return event->motion.time;
665 case GDK_BUTTON_PRESS:
666 case GDK_2BUTTON_PRESS:
667 case GDK_3BUTTON_PRESS:
668 case GDK_BUTTON_RELEASE:
669 return event->button.time;
671 return event->scroll.time;
673 case GDK_KEY_RELEASE:
674 return event->key.time;
675 case GDK_ENTER_NOTIFY:
676 case GDK_LEAVE_NOTIFY:
677 return event->crossing.time;
678 case GDK_PROPERTY_NOTIFY:
679 return event->property.time;
680 case GDK_SELECTION_CLEAR:
681 case GDK_SELECTION_REQUEST:
682 case GDK_SELECTION_NOTIFY:
683 return event->selection.time;
684 case GDK_PROXIMITY_IN:
685 case GDK_PROXIMITY_OUT:
686 return event->proximity.time;
689 case GDK_DRAG_MOTION:
690 case GDK_DRAG_STATUS:
692 case GDK_DROP_FINISHED:
693 return event->dnd.time;
694 case GDK_CLIENT_EVENT:
695 case GDK_VISIBILITY_NOTIFY:
697 case GDK_FOCUS_CHANGE:
705 case GDK_WINDOW_STATE:
707 case GDK_OWNER_CHANGE:
708 case GDK_GRAB_BROKEN:
710 /* return current time */
714 return GDK_CURRENT_TIME;
718 * gdk_event_get_state:
719 * @event: a #GdkEvent or NULL
720 * @state: (out): return location for state
722 * If the event contains a "state" field, puts that field in @state. Otherwise
723 * stores an empty state (0). Returns %TRUE if there was a state field
724 * in the event. @event may be %NULL, in which case it's treated
725 * as if the event had no state field.
727 * Return value: %TRUE if there was a state field in the event
730 gdk_event_get_state (const GdkEvent *event,
731 GdkModifierType *state)
733 g_return_val_if_fail (state != NULL, FALSE);
738 case GDK_MOTION_NOTIFY:
739 *state = event->motion.state;
741 case GDK_BUTTON_PRESS:
742 case GDK_2BUTTON_PRESS:
743 case GDK_3BUTTON_PRESS:
744 case GDK_BUTTON_RELEASE:
745 *state = event->button.state;
748 *state = event->scroll.state;
751 case GDK_KEY_RELEASE:
752 *state = event->key.state;
754 case GDK_ENTER_NOTIFY:
755 case GDK_LEAVE_NOTIFY:
756 *state = event->crossing.state;
758 case GDK_PROPERTY_NOTIFY:
759 *state = event->property.state;
761 case GDK_VISIBILITY_NOTIFY:
762 case GDK_CLIENT_EVENT:
764 case GDK_FOCUS_CHANGE:
765 case GDK_SELECTION_CLEAR:
766 case GDK_SELECTION_REQUEST:
767 case GDK_SELECTION_NOTIFY:
768 case GDK_PROXIMITY_IN:
769 case GDK_PROXIMITY_OUT:
773 case GDK_DRAG_MOTION:
774 case GDK_DRAG_STATUS:
776 case GDK_DROP_FINISHED:
783 case GDK_WINDOW_STATE:
785 case GDK_OWNER_CHANGE:
786 case GDK_GRAB_BROKEN:
797 * gdk_event_get_coords:
798 * @event: a #GdkEvent
799 * @x_win: (out): location to put event window x coordinate
800 * @y_win: (out): location to put event window y coordinate
802 * Extract the event window relative x/y coordinates from an event.
804 * Return value: %TRUE if the event delivered event window coordinates
807 gdk_event_get_coords (const GdkEvent *event,
811 gdouble x = 0, y = 0;
812 gboolean fetched = TRUE;
814 g_return_val_if_fail (event != NULL, FALSE);
819 x = event->configure.x;
820 y = event->configure.y;
822 case GDK_ENTER_NOTIFY:
823 case GDK_LEAVE_NOTIFY:
824 x = event->crossing.x;
825 y = event->crossing.y;
831 case GDK_BUTTON_PRESS:
832 case GDK_2BUTTON_PRESS:
833 case GDK_3BUTTON_PRESS:
834 case GDK_BUTTON_RELEASE:
838 case GDK_MOTION_NOTIFY:
856 * gdk_event_get_root_coords:
857 * @event: a #GdkEvent
858 * @x_root: (out): location to put root window x coordinate
859 * @y_root: (out): location to put root window y coordinate
861 * Extract the root window relative x/y coordinates from an event.
863 * Return value: %TRUE if the event delivered root window coordinates
866 gdk_event_get_root_coords (const GdkEvent *event,
870 gdouble x = 0, y = 0;
871 gboolean fetched = TRUE;
873 g_return_val_if_fail (event != NULL, FALSE);
877 case GDK_MOTION_NOTIFY:
878 x = event->motion.x_root;
879 y = event->motion.y_root;
882 x = event->scroll.x_root;
883 y = event->scroll.y_root;
885 case GDK_BUTTON_PRESS:
886 case GDK_2BUTTON_PRESS:
887 case GDK_3BUTTON_PRESS:
888 case GDK_BUTTON_RELEASE:
889 x = event->button.x_root;
890 y = event->button.y_root;
892 case GDK_ENTER_NOTIFY:
893 case GDK_LEAVE_NOTIFY:
894 x = event->crossing.x_root;
895 y = event->crossing.y_root;
899 case GDK_DRAG_MOTION:
900 case GDK_DRAG_STATUS:
902 case GDK_DROP_FINISHED:
903 x = event->dnd.x_root;
904 y = event->dnd.y_root;
920 * gdk_event_get_axis:
921 * @event: a #GdkEvent
922 * @axis_use: (out): the axis use to look for
923 * @value: (out): location to store the value found
925 * Extract the axis value for a particular axis use from
926 * an event structure.
928 * Return value: %TRUE if the specified axis was found, otherwise %FALSE
931 gdk_event_get_axis (const GdkEvent *event,
938 g_return_val_if_fail (event != NULL, FALSE);
940 if (axis_use == GDK_AXIS_X || axis_use == GDK_AXIS_Y)
946 case GDK_MOTION_NOTIFY:
954 case GDK_BUTTON_PRESS:
955 case GDK_BUTTON_RELEASE:
959 case GDK_ENTER_NOTIFY:
960 case GDK_LEAVE_NOTIFY:
961 x = event->crossing.x;
962 y = event->crossing.y;
969 if (axis_use == GDK_AXIS_X && value)
971 if (axis_use == GDK_AXIS_Y && value)
976 else if (event->type == GDK_BUTTON_PRESS ||
977 event->type == GDK_BUTTON_RELEASE)
979 device = event->button.device;
980 axes = event->button.axes;
982 else if (event->type == GDK_MOTION_NOTIFY)
984 device = event->motion.device;
985 axes = event->motion.axes;
990 return gdk_device_get_axis (device, axes, axis_use, value);
994 * gdk_event_set_device:
995 * @event: a #GdkEvent
996 * @device: a #GdkDevice
998 * Sets the device for @event to @device. The event must
999 * have been allocated by GTK+, for instance, by
1005 gdk_event_set_device (GdkEvent *event,
1008 GdkEventPrivate *private;
1010 g_return_if_fail (gdk_event_is_allocated (event));
1012 private = (GdkEventPrivate *) event;
1014 private->device = device;
1016 switch (event->type)
1018 case GDK_MOTION_NOTIFY:
1019 event->motion.device = device;
1021 case GDK_BUTTON_PRESS:
1022 case GDK_2BUTTON_PRESS:
1023 case GDK_3BUTTON_PRESS:
1024 case GDK_BUTTON_RELEASE:
1025 event->button.device = device;
1028 event->scroll.device = device;
1030 case GDK_PROXIMITY_IN:
1031 case GDK_PROXIMITY_OUT:
1032 event->proximity.device = device;
1040 * gdk_event_get_device:
1041 * @event: a #GdkEvent.
1043 * If the event contains a "device" field, this function will return
1044 * it, else it will return %NULL.
1046 * Returns: (transfer none): a #GdkDevice, or %NULL.
1051 gdk_event_get_device (const GdkEvent *event)
1053 g_return_val_if_fail (event != NULL, NULL);
1055 if (gdk_event_is_allocated (event))
1057 GdkEventPrivate *private = (GdkEventPrivate *) event;
1059 if (private->device)
1060 return private->device;
1063 switch (event->type)
1065 case GDK_MOTION_NOTIFY:
1066 return event->motion.device;
1067 case GDK_BUTTON_PRESS:
1068 case GDK_2BUTTON_PRESS:
1069 case GDK_3BUTTON_PRESS:
1070 case GDK_BUTTON_RELEASE:
1071 return event->button.device;
1073 return event->scroll.device;
1074 case GDK_PROXIMITY_IN:
1075 case GDK_PROXIMITY_OUT:
1076 return event->proximity.device;
1081 /* Fallback if event has no device set */
1082 switch (event->type)
1084 case GDK_MOTION_NOTIFY:
1085 case GDK_BUTTON_PRESS:
1086 case GDK_2BUTTON_PRESS:
1087 case GDK_3BUTTON_PRESS:
1088 case GDK_BUTTON_RELEASE:
1089 case GDK_ENTER_NOTIFY:
1090 case GDK_LEAVE_NOTIFY:
1091 case GDK_FOCUS_CHANGE:
1092 case GDK_PROXIMITY_IN:
1093 case GDK_PROXIMITY_OUT:
1094 case GDK_DRAG_ENTER:
1095 case GDK_DRAG_LEAVE:
1096 case GDK_DRAG_MOTION:
1097 case GDK_DRAG_STATUS:
1098 case GDK_DROP_START:
1099 case GDK_DROP_FINISHED:
1101 case GDK_GRAB_BROKEN:
1103 case GDK_KEY_RELEASE:
1105 GdkDisplay *display;
1106 GdkDeviceManager *device_manager;
1107 GdkDevice *client_pointer;
1109 g_warning ("Event with type %d not holding a GdkDevice. "
1110 "It is most likely synthesized outside Gdk/GTK+\n",
1113 display = gdk_window_get_display (event->any.window);
1114 device_manager = gdk_display_get_device_manager (display);
1115 client_pointer = gdk_device_manager_get_client_pointer (device_manager);
1117 if (event->type == GDK_KEY_PRESS ||
1118 event->type == GDK_KEY_RELEASE)
1119 return gdk_device_get_associated_device (client_pointer);
1121 return client_pointer;
1130 * gdk_event_set_source_device:
1131 * @event: a #GdkEvent
1132 * @device: a #GdkDevice
1134 * Sets the slave device for @event to @device. The event
1135 * must have been allocated by GTK+, for instance, by
1141 gdk_event_set_source_device (GdkEvent *event,
1144 GdkEventPrivate *private;
1146 g_return_if_fail (gdk_event_is_allocated (event));
1147 g_return_if_fail (GDK_IS_DEVICE (device));
1149 private = (GdkEventPrivate *) event;
1151 private->source_device = device;
1155 * gdk_event_get_source_device:
1156 * @event: a #GdkEvent
1158 * This function returns the hardware (slave) #GdkDevice that has triggered the event,
1159 * falling back to the virtual (master) device (as in gdk_event_get_device()) if the
1160 * event wasn't caused by interaction with a hardware device. This may happen for
1161 * example in synthesized crossing events after a #GdkWindow updates its geometry or
1162 * a grab is acquired/released.
1164 * If the event does not contain device field, this function will return %NULL.
1166 * Returns: a #GdkDevice, or %NULL.
1171 gdk_event_get_source_device (const GdkEvent *event)
1173 GdkEventPrivate *private;
1175 g_return_val_if_fail (event != NULL, NULL);
1177 if (!gdk_event_is_allocated (event))
1180 private = (GdkEventPrivate *) event;
1182 if (private->source_device)
1183 return private->source_device;
1185 /* Fallback to event device */
1186 return gdk_event_get_device (event);
1190 * gdk_event_request_motions:
1191 * @event: a valid #GdkEvent
1193 * Request more motion notifies if @event is a motion notify hint event.
1194 * This function should be used instead of gdk_window_get_pointer() to
1195 * request further motion notifies, because it also works for extension
1196 * events where motion notifies are provided for devices other than the
1197 * core pointer. Coordinate extraction, processing and requesting more
1198 * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
1202 * /* motion_event handler */
1203 * x = motion_event->x;
1204 * y = motion_event->y;
1205 * /* handle (x,y) motion */
1206 * gdk_event_request_motions (motion_event); /* handles is_hint events */
1213 gdk_event_request_motions (const GdkEventMotion *event)
1215 GdkDisplay *display;
1217 g_return_if_fail (event != NULL);
1219 if (event->type == GDK_MOTION_NOTIFY && event->is_hint)
1221 gdk_device_get_state (event->device, event->window, NULL, NULL);
1223 display = gdk_window_get_display (event->window);
1224 _gdk_display_enable_motion_hints (display, event->device);
1229 gdk_events_get_axis_distances (GdkEvent *event1,
1231 gdouble *x_distance,
1232 gdouble *y_distance,
1235 gdouble x1, x2, y1, y2;
1238 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1239 !gdk_event_get_coords (event2, &x2, &y2))
1252 *distance = sqrt ((xd * xd) + (yd * yd));
1258 * gdk_events_get_distance:
1259 * @event1: first #GdkEvent
1260 * @event2: second #GdkEvent
1261 * @distance: return location for the distance
1263 * If both events have X/Y information, the distance between both coordinates
1264 * (as in a straight line going from @event1 to @event2) will be returned.
1266 * Returns: %TRUE if the distance could be calculated.
1271 gdk_events_get_distance (GdkEvent *event1,
1275 return gdk_events_get_axis_distances (event1, event2,
1281 * gdk_events_get_angle:
1282 * @event1: first #GdkEvent
1283 * @event2: second #GdkEvent
1284 * @angle: return location for the relative angle between both events
1286 * If both events contain X/Y information, this function will return %TRUE
1287 * and return in @angle the relative angle from @event1 to @event2. The rotation
1288 * direction for positive angles is from the positive X axis towards the positive
1291 * Returns: %TRUE if the angle could be calculated.
1296 gdk_events_get_angle (GdkEvent *event1,
1300 gdouble x_distance, y_distance, distance;
1302 if (!gdk_events_get_axis_distances (event1, event2,
1303 &x_distance, &y_distance,
1309 *angle = atan2 (x_distance, y_distance);
1312 *angle = (2 * G_PI) - *angle;
1317 /* And constraint it to 0°-360° */
1318 *angle = fmod (*angle, 2 * G_PI);
1325 * gdk_events_get_center:
1326 * @event1: first #GdkEvent
1327 * @event2: second #GdkEvent
1328 * @x: (out): return location for the X coordinate of the center
1329 * @y: (out): return location for the Y coordinate of the center
1331 * If both events contain X/Y information, the center of both coordinates
1332 * will be returned in @x and @y.
1334 * Returns: %TRUE if the center could be calculated.
1339 gdk_events_get_center (GdkEvent *event1,
1344 gdouble x1, x2, y1, y2;
1346 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1347 !gdk_event_get_coords (event2, &x2, &y2))
1360 * gdk_event_set_screen:
1361 * @event: a #GdkEvent
1362 * @screen: a #GdkScreen
1364 * Sets the screen for @event to @screen. The event must
1365 * have been allocated by GTK+, for instance, by
1371 gdk_event_set_screen (GdkEvent *event,
1374 GdkEventPrivate *private;
1376 g_return_if_fail (gdk_event_is_allocated (event));
1378 private = (GdkEventPrivate *)event;
1380 private->screen = screen;
1384 * gdk_event_get_screen:
1385 * @event: a #GdkEvent
1387 * Returns the screen for the event. The screen is
1388 * typically the screen for <literal>event->any.window</literal>, but
1389 * for events such as mouse events, it is the screen
1390 * where the pointer was when the event occurs -
1391 * that is, the screen which has the root window
1392 * to which <literal>event->motion.x_root</literal> and
1393 * <literal>event->motion.y_root</literal> are relative.
1395 * Return value: (transfer none): the screen for the event
1400 gdk_event_get_screen (const GdkEvent *event)
1402 if (gdk_event_is_allocated (event))
1404 GdkEventPrivate *private = (GdkEventPrivate *)event;
1406 if (private->screen)
1407 return private->screen;
1410 if (event->any.window)
1411 return gdk_window_get_screen (event->any.window);
1417 * gdk_set_show_events:
1418 * @show_events: %TRUE to output event debugging information.
1420 * Sets whether a trace of received events is output.
1421 * Note that GTK+ must be compiled with debugging (that is,
1422 * configured using the <option>--enable-debug</option> option)
1423 * to use this option.
1426 gdk_set_show_events (gboolean show_events)
1429 _gdk_debug_flags |= GDK_DEBUG_EVENTS;
1431 _gdk_debug_flags &= ~GDK_DEBUG_EVENTS;
1435 * gdk_get_show_events:
1437 * Gets whether event debugging output is enabled.
1439 * Return value: %TRUE if event debugging output is enabled.
1442 gdk_get_show_events (void)
1444 return (_gdk_debug_flags & GDK_DEBUG_EVENTS) != 0;
1447 /* What do we do with G_IO_NVAL?
1449 #define READ_CONDITION (G_IO_IN | G_IO_HUP | G_IO_ERR)
1450 #define WRITE_CONDITION (G_IO_OUT | G_IO_ERR)
1451 #define EXCEPTION_CONDITION (G_IO_PRI)
1454 gdk_synthesize_click (GdkDisplay *display,
1458 GdkEvent temp_event;
1459 GdkEvent *event_copy;
1462 g_return_if_fail (event != NULL);
1464 temp_event = *event;
1465 temp_event.type = (nclicks == 2) ? GDK_2BUTTON_PRESS : GDK_3BUTTON_PRESS;
1467 event_copy = gdk_event_copy (&temp_event);
1468 link = _gdk_event_queue_append (display, event_copy);
1472 _gdk_event_button_generate (GdkDisplay *display,
1475 GdkMultipleClickInfo *info;
1477 info = g_hash_table_lookup (display->multiple_click_info, event->button.device);
1479 if (G_UNLIKELY (!info))
1481 info = g_new0 (GdkMultipleClickInfo, 1);
1482 info->button_number[0] = info->button_number[1] = -1;
1484 g_hash_table_insert (display->multiple_click_info,
1485 event->button.device, info);
1488 if ((event->button.time < (info->button_click_time[1] + 2 * display->double_click_time)) &&
1489 (event->button.window == info->button_window[1]) &&
1490 (event->button.button == info->button_number[1]) &&
1491 (ABS (event->button.x - info->button_x[1]) <= display->double_click_distance) &&
1492 (ABS (event->button.y - info->button_y[1]) <= display->double_click_distance))
1494 gdk_synthesize_click (display, event, 3);
1496 info->button_click_time[1] = 0;
1497 info->button_click_time[0] = 0;
1498 info->button_window[1] = NULL;
1499 info->button_window[0] = NULL;
1500 info->button_number[1] = -1;
1501 info->button_number[0] = -1;
1502 info->button_x[0] = info->button_x[1] = 0;
1503 info->button_y[0] = info->button_y[1] = 0;
1505 else if ((event->button.time < (info->button_click_time[0] + display->double_click_time)) &&
1506 (event->button.window == info->button_window[0]) &&
1507 (event->button.button == info->button_number[0]) &&
1508 (ABS (event->button.x - info->button_x[0]) <= display->double_click_distance) &&
1509 (ABS (event->button.y - info->button_y[0]) <= display->double_click_distance))
1511 gdk_synthesize_click (display, event, 2);
1513 info->button_click_time[1] = info->button_click_time[0];
1514 info->button_click_time[0] = event->button.time;
1515 info->button_window[1] = info->button_window[0];
1516 info->button_window[0] = event->button.window;
1517 info->button_number[1] = info->button_number[0];
1518 info->button_number[0] = event->button.button;
1519 info->button_x[1] = info->button_x[0];
1520 info->button_x[0] = event->button.x;
1521 info->button_y[1] = info->button_y[0];
1522 info->button_y[0] = event->button.y;
1526 info->button_click_time[1] = 0;
1527 info->button_click_time[0] = event->button.time;
1528 info->button_window[1] = NULL;
1529 info->button_window[0] = event->button.window;
1530 info->button_number[1] = -1;
1531 info->button_number[0] = event->button.button;
1532 info->button_x[1] = 0;
1533 info->button_x[0] = event->button.x;
1534 info->button_y[1] = 0;
1535 info->button_y[0] = event->button.y;
1540 gdk_synthesize_window_state (GdkWindow *window,
1541 GdkWindowState unset_flags,
1542 GdkWindowState set_flags)
1544 GdkEvent temp_event;
1547 g_return_if_fail (window != NULL);
1549 temp_event.window_state.window = window;
1550 temp_event.window_state.type = GDK_WINDOW_STATE;
1551 temp_event.window_state.send_event = FALSE;
1553 old = temp_event.window_state.window->state;
1555 temp_event.window_state.new_window_state = old;
1556 temp_event.window_state.new_window_state |= set_flags;
1557 temp_event.window_state.new_window_state &= ~unset_flags;
1558 temp_event.window_state.changed_mask = temp_event.window_state.new_window_state ^ old;
1560 if (temp_event.window_state.new_window_state == old)
1561 return; /* No actual work to do, nothing changed. */
1563 /* Actually update the field in GdkWindow, this is sort of an odd
1564 * place to do it, but seems like the safest since it ensures we expose no
1565 * inconsistent state to the user.
1568 window->state = temp_event.window_state.new_window_state;
1570 if (temp_event.window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1571 _gdk_window_update_viewable (window);
1573 /* We only really send the event to toplevels, since
1574 * all the window states don't apply to non-toplevels.
1575 * Non-toplevels do use the GDK_WINDOW_STATE_WITHDRAWN flag
1576 * internally so we needed to update window->state.
1578 switch (window->window_type)
1580 case GDK_WINDOW_TOPLEVEL:
1581 case GDK_WINDOW_TEMP: /* ? */
1582 gdk_display_put_event (gdk_window_get_display (window), &temp_event);
1585 case GDK_WINDOW_FOREIGN:
1586 case GDK_WINDOW_ROOT:
1587 case GDK_WINDOW_CHILD:
1593 * gdk_display_set_double_click_time:
1594 * @display: a #GdkDisplay
1595 * @msec: double click time in milliseconds (thousandths of a second)
1597 * Sets the double click time (two clicks within this time interval
1598 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1599 * Applications should <emphasis>not</emphasis> set this, it is a global
1600 * user-configured setting.
1605 gdk_display_set_double_click_time (GdkDisplay *display,
1608 display->double_click_time = msec;
1612 * gdk_set_double_click_time:
1613 * @msec: double click time in milliseconds (thousandths of a second)
1615 * Set the double click time for the default display. See
1616 * gdk_display_set_double_click_time().
1617 * See also gdk_display_set_double_click_distance().
1618 * Applications should <emphasis>not</emphasis> set this, it is a
1619 * global user-configured setting.
1622 gdk_set_double_click_time (guint msec)
1624 gdk_display_set_double_click_time (gdk_display_get_default (), msec);
1628 * gdk_display_set_double_click_distance:
1629 * @display: a #GdkDisplay
1630 * @distance: distance in pixels
1632 * Sets the double click distance (two clicks within this distance
1633 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1634 * See also gdk_display_set_double_click_time().
1635 * Applications should <emphasis>not</emphasis> set this, it is a global
1636 * user-configured setting.
1641 gdk_display_set_double_click_distance (GdkDisplay *display,
1644 display->double_click_distance = distance;
1647 G_DEFINE_BOXED_TYPE (GdkEvent, gdk_event,
1653 * @name: the name of the setting.
1654 * @value: location to store the value of the setting.
1656 * Obtains a desktop-wide setting, such as the double-click time,
1657 * for the default screen. See gdk_screen_get_setting().
1659 * Returns: %TRUE if the setting existed and a value was stored
1660 * in @value, %FALSE otherwise.
1663 gdk_setting_get (const gchar *name,
1666 return gdk_screen_get_setting (gdk_screen_get_default (), name, value);