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;
522 new_private->source_device = private->source_device;
525 switch (event->any.type)
528 case GDK_KEY_RELEASE:
529 new_event->key.string = g_strdup (event->key.string);
532 case GDK_ENTER_NOTIFY:
533 case GDK_LEAVE_NOTIFY:
534 if (event->crossing.subwindow != NULL)
535 g_object_ref (event->crossing.subwindow);
540 case GDK_DRAG_MOTION:
541 case GDK_DRAG_STATUS:
543 case GDK_DROP_FINISHED:
544 g_object_ref (event->dnd.context);
549 if (event->expose.region)
550 new_event->expose.region = cairo_region_copy (event->expose.region);
554 new_event->setting.name = g_strdup (new_event->setting.name);
557 case GDK_BUTTON_PRESS:
558 case GDK_BUTTON_RELEASE:
559 if (event->button.axes)
560 new_event->button.axes = g_memdup (event->button.axes,
561 sizeof (gdouble) * gdk_device_get_n_axes (event->button.device));
564 case GDK_MOTION_NOTIFY:
565 if (event->motion.axes)
566 new_event->motion.axes = g_memdup (event->motion.axes,
567 sizeof (gdouble) * gdk_device_get_n_axes (event->motion.device));
574 if (gdk_event_is_allocated (event))
575 _gdk_display_event_data_copy (gdk_display_get_default (), event, new_event);
582 * @event: a #GdkEvent.
584 * Frees a #GdkEvent, freeing or decrementing any resources associated with it.
585 * Note that this function should only be called with events returned from
586 * functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
587 * and gdk_event_new().
590 gdk_event_free (GdkEvent *event)
592 g_return_if_fail (event != NULL);
594 if (event->any.window)
595 g_object_unref (event->any.window);
597 switch (event->any.type)
600 case GDK_KEY_RELEASE:
601 g_free (event->key.string);
604 case GDK_ENTER_NOTIFY:
605 case GDK_LEAVE_NOTIFY:
606 if (event->crossing.subwindow != NULL)
607 g_object_unref (event->crossing.subwindow);
612 case GDK_DRAG_MOTION:
613 case GDK_DRAG_STATUS:
615 case GDK_DROP_FINISHED:
616 if (event->dnd.context != NULL)
617 g_object_unref (event->dnd.context);
620 case GDK_BUTTON_PRESS:
621 case GDK_BUTTON_RELEASE:
622 g_free (event->button.axes);
627 if (event->expose.region)
628 cairo_region_destroy (event->expose.region);
631 case GDK_MOTION_NOTIFY:
632 g_free (event->motion.axes);
636 g_free (event->setting.name);
643 _gdk_display_event_data_free (gdk_display_get_default (), event);
645 g_hash_table_remove (event_hash, event);
646 g_slice_free (GdkEventPrivate, (GdkEventPrivate*) event);
650 * gdk_event_get_time:
651 * @event: a #GdkEvent
653 * Returns the time stamp from @event, if there is one; otherwise
654 * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
656 * Return value: time stamp field from @event
659 gdk_event_get_time (const GdkEvent *event)
664 case GDK_MOTION_NOTIFY:
665 return event->motion.time;
666 case GDK_BUTTON_PRESS:
667 case GDK_2BUTTON_PRESS:
668 case GDK_3BUTTON_PRESS:
669 case GDK_BUTTON_RELEASE:
670 return event->button.time;
672 return event->scroll.time;
674 case GDK_KEY_RELEASE:
675 return event->key.time;
676 case GDK_ENTER_NOTIFY:
677 case GDK_LEAVE_NOTIFY:
678 return event->crossing.time;
679 case GDK_PROPERTY_NOTIFY:
680 return event->property.time;
681 case GDK_SELECTION_CLEAR:
682 case GDK_SELECTION_REQUEST:
683 case GDK_SELECTION_NOTIFY:
684 return event->selection.time;
685 case GDK_PROXIMITY_IN:
686 case GDK_PROXIMITY_OUT:
687 return event->proximity.time;
690 case GDK_DRAG_MOTION:
691 case GDK_DRAG_STATUS:
693 case GDK_DROP_FINISHED:
694 return event->dnd.time;
695 case GDK_CLIENT_EVENT:
696 case GDK_VISIBILITY_NOTIFY:
698 case GDK_FOCUS_CHANGE:
706 case GDK_WINDOW_STATE:
708 case GDK_OWNER_CHANGE:
709 case GDK_GRAB_BROKEN:
711 /* return current time */
715 return GDK_CURRENT_TIME;
719 * gdk_event_get_state:
720 * @event: a #GdkEvent or NULL
721 * @state: (out): return location for state
723 * If the event contains a "state" field, puts that field in @state. Otherwise
724 * stores an empty state (0). Returns %TRUE if there was a state field
725 * in the event. @event may be %NULL, in which case it's treated
726 * as if the event had no state field.
728 * Return value: %TRUE if there was a state field in the event
731 gdk_event_get_state (const GdkEvent *event,
732 GdkModifierType *state)
734 g_return_val_if_fail (state != NULL, FALSE);
739 case GDK_MOTION_NOTIFY:
740 *state = event->motion.state;
742 case GDK_BUTTON_PRESS:
743 case GDK_2BUTTON_PRESS:
744 case GDK_3BUTTON_PRESS:
745 case GDK_BUTTON_RELEASE:
746 *state = event->button.state;
749 *state = event->scroll.state;
752 case GDK_KEY_RELEASE:
753 *state = event->key.state;
755 case GDK_ENTER_NOTIFY:
756 case GDK_LEAVE_NOTIFY:
757 *state = event->crossing.state;
759 case GDK_PROPERTY_NOTIFY:
760 case GDK_VISIBILITY_NOTIFY:
761 case GDK_CLIENT_EVENT:
763 case GDK_FOCUS_CHANGE:
764 case GDK_SELECTION_CLEAR:
765 case GDK_SELECTION_REQUEST:
766 case GDK_SELECTION_NOTIFY:
767 case GDK_PROXIMITY_IN:
768 case GDK_PROXIMITY_OUT:
772 case GDK_DRAG_MOTION:
773 case GDK_DRAG_STATUS:
775 case GDK_DROP_FINISHED:
782 case GDK_WINDOW_STATE:
784 case GDK_OWNER_CHANGE:
785 case GDK_GRAB_BROKEN:
796 * gdk_event_get_coords:
797 * @event: a #GdkEvent
798 * @x_win: (out): location to put event window x coordinate
799 * @y_win: (out): location to put event window y coordinate
801 * Extract the event window relative x/y coordinates from an event.
803 * Return value: %TRUE if the event delivered event window coordinates
806 gdk_event_get_coords (const GdkEvent *event,
810 gdouble x = 0, y = 0;
811 gboolean fetched = TRUE;
813 g_return_val_if_fail (event != NULL, FALSE);
818 x = event->configure.x;
819 y = event->configure.y;
821 case GDK_ENTER_NOTIFY:
822 case GDK_LEAVE_NOTIFY:
823 x = event->crossing.x;
824 y = event->crossing.y;
830 case GDK_BUTTON_PRESS:
831 case GDK_2BUTTON_PRESS:
832 case GDK_3BUTTON_PRESS:
833 case GDK_BUTTON_RELEASE:
837 case GDK_MOTION_NOTIFY:
855 * gdk_event_get_root_coords:
856 * @event: a #GdkEvent
857 * @x_root: (out): location to put root window x coordinate
858 * @y_root: (out): location to put root window y coordinate
860 * Extract the root window relative x/y coordinates from an event.
862 * Return value: %TRUE if the event delivered root window coordinates
865 gdk_event_get_root_coords (const GdkEvent *event,
869 gdouble x = 0, y = 0;
870 gboolean fetched = TRUE;
872 g_return_val_if_fail (event != NULL, FALSE);
876 case GDK_MOTION_NOTIFY:
877 x = event->motion.x_root;
878 y = event->motion.y_root;
881 x = event->scroll.x_root;
882 y = event->scroll.y_root;
884 case GDK_BUTTON_PRESS:
885 case GDK_2BUTTON_PRESS:
886 case GDK_3BUTTON_PRESS:
887 case GDK_BUTTON_RELEASE:
888 x = event->button.x_root;
889 y = event->button.y_root;
891 case GDK_ENTER_NOTIFY:
892 case GDK_LEAVE_NOTIFY:
893 x = event->crossing.x_root;
894 y = event->crossing.y_root;
898 case GDK_DRAG_MOTION:
899 case GDK_DRAG_STATUS:
901 case GDK_DROP_FINISHED:
902 x = event->dnd.x_root;
903 y = event->dnd.y_root;
919 * gdk_event_get_axis:
920 * @event: a #GdkEvent
921 * @axis_use: the axis use to look for
922 * @value: (out): location to store the value found
924 * Extract the axis value for a particular axis use from
925 * an event structure.
927 * Return value: %TRUE if the specified axis was found, otherwise %FALSE
930 gdk_event_get_axis (const GdkEvent *event,
937 g_return_val_if_fail (event != NULL, FALSE);
939 if (axis_use == GDK_AXIS_X || axis_use == GDK_AXIS_Y)
945 case GDK_MOTION_NOTIFY:
953 case GDK_BUTTON_PRESS:
954 case GDK_BUTTON_RELEASE:
958 case GDK_ENTER_NOTIFY:
959 case GDK_LEAVE_NOTIFY:
960 x = event->crossing.x;
961 y = event->crossing.y;
968 if (axis_use == GDK_AXIS_X && value)
970 if (axis_use == GDK_AXIS_Y && value)
975 else if (event->type == GDK_BUTTON_PRESS ||
976 event->type == GDK_BUTTON_RELEASE)
978 device = event->button.device;
979 axes = event->button.axes;
981 else if (event->type == GDK_MOTION_NOTIFY)
983 device = event->motion.device;
984 axes = event->motion.axes;
989 return gdk_device_get_axis (device, axes, axis_use, value);
993 * gdk_event_set_device:
994 * @event: a #GdkEvent
995 * @device: a #GdkDevice
997 * Sets the device for @event to @device. The event must
998 * have been allocated by GTK+, for instance, by
1004 gdk_event_set_device (GdkEvent *event,
1007 GdkEventPrivate *private;
1009 g_return_if_fail (gdk_event_is_allocated (event));
1011 private = (GdkEventPrivate *) event;
1013 private->device = device;
1015 switch (event->type)
1017 case GDK_MOTION_NOTIFY:
1018 event->motion.device = device;
1020 case GDK_BUTTON_PRESS:
1021 case GDK_2BUTTON_PRESS:
1022 case GDK_3BUTTON_PRESS:
1023 case GDK_BUTTON_RELEASE:
1024 event->button.device = device;
1027 event->scroll.device = device;
1029 case GDK_PROXIMITY_IN:
1030 case GDK_PROXIMITY_OUT:
1031 event->proximity.device = device;
1039 * gdk_event_get_device:
1040 * @event: a #GdkEvent.
1042 * If the event contains a "device" field, this function will return
1043 * it, else it will return %NULL.
1045 * Returns: (transfer none): a #GdkDevice, or %NULL.
1050 gdk_event_get_device (const GdkEvent *event)
1052 g_return_val_if_fail (event != NULL, NULL);
1054 if (gdk_event_is_allocated (event))
1056 GdkEventPrivate *private = (GdkEventPrivate *) event;
1058 if (private->device)
1059 return private->device;
1062 switch (event->type)
1064 case GDK_MOTION_NOTIFY:
1065 return event->motion.device;
1066 case GDK_BUTTON_PRESS:
1067 case GDK_2BUTTON_PRESS:
1068 case GDK_3BUTTON_PRESS:
1069 case GDK_BUTTON_RELEASE:
1070 return event->button.device;
1072 return event->scroll.device;
1073 case GDK_PROXIMITY_IN:
1074 case GDK_PROXIMITY_OUT:
1075 return event->proximity.device;
1080 /* Fallback if event has no device set */
1081 switch (event->type)
1083 case GDK_MOTION_NOTIFY:
1084 case GDK_BUTTON_PRESS:
1085 case GDK_2BUTTON_PRESS:
1086 case GDK_3BUTTON_PRESS:
1087 case GDK_BUTTON_RELEASE:
1088 case GDK_ENTER_NOTIFY:
1089 case GDK_LEAVE_NOTIFY:
1090 case GDK_FOCUS_CHANGE:
1091 case GDK_PROXIMITY_IN:
1092 case GDK_PROXIMITY_OUT:
1093 case GDK_DRAG_ENTER:
1094 case GDK_DRAG_LEAVE:
1095 case GDK_DRAG_MOTION:
1096 case GDK_DRAG_STATUS:
1097 case GDK_DROP_START:
1098 case GDK_DROP_FINISHED:
1100 case GDK_GRAB_BROKEN:
1102 case GDK_KEY_RELEASE:
1104 GdkDisplay *display;
1105 GdkDeviceManager *device_manager;
1106 GdkDevice *client_pointer;
1108 g_warning ("Event with type %d not holding a GdkDevice. "
1109 "It is most likely synthesized outside Gdk/GTK+\n",
1112 display = gdk_window_get_display (event->any.window);
1113 device_manager = gdk_display_get_device_manager (display);
1114 client_pointer = gdk_device_manager_get_client_pointer (device_manager);
1116 if (event->type == GDK_KEY_PRESS ||
1117 event->type == GDK_KEY_RELEASE)
1118 return gdk_device_get_associated_device (client_pointer);
1120 return client_pointer;
1129 * gdk_event_set_source_device:
1130 * @event: a #GdkEvent
1131 * @device: a #GdkDevice
1133 * Sets the slave device for @event to @device.
1135 * The event must have been allocated by GTK+,
1136 * for instance by gdk_event_copy().
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
1159 * triggered the event, falling back to the virtual (master) device
1160 * (as in gdk_event_get_device()) if the event wasn't caused by
1161 * interaction with a hardware device. This may happen for example
1162 * in synthesized crossing events after a #GdkWindow updates its
1163 * geometry or a grab is acquired/released.
1165 * If the event does not contain a device field, this function will
1168 * Returns: (transfer none): a #GdkDevice, or %NULL.
1173 gdk_event_get_source_device (const GdkEvent *event)
1175 GdkEventPrivate *private;
1177 g_return_val_if_fail (event != NULL, NULL);
1179 if (!gdk_event_is_allocated (event))
1182 private = (GdkEventPrivate *) event;
1184 if (private->source_device)
1185 return private->source_device;
1187 /* Fallback to event device */
1188 return gdk_event_get_device (event);
1192 * gdk_event_request_motions:
1193 * @event: a valid #GdkEvent
1195 * Request more motion notifies if @event is a motion notify hint event.
1197 * This function should be used instead of gdk_window_get_pointer() to
1198 * request further motion notifies, because it also works for extension
1199 * events where motion notifies are provided for devices other than the
1200 * core pointer. Coordinate extraction, processing and requesting more
1201 * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
1205 * /* motion_event handler */
1206 * x = motion_event->x;
1207 * y = motion_event->y;
1208 * /* handle (x,y) motion */
1209 * gdk_event_request_motions (motion_event); /* handles is_hint events */
1216 gdk_event_request_motions (const GdkEventMotion *event)
1218 GdkDisplay *display;
1220 g_return_if_fail (event != NULL);
1222 if (event->type == GDK_MOTION_NOTIFY && event->is_hint)
1224 gdk_device_get_state (event->device, event->window, NULL, NULL);
1226 display = gdk_window_get_display (event->window);
1227 _gdk_display_enable_motion_hints (display, event->device);
1232 gdk_events_get_axis_distances (GdkEvent *event1,
1234 gdouble *x_distance,
1235 gdouble *y_distance,
1238 gdouble x1, x2, y1, y2;
1241 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1242 !gdk_event_get_coords (event2, &x2, &y2))
1255 *distance = sqrt ((xd * xd) + (yd * yd));
1261 * gdk_events_get_distance:
1262 * @event1: first #GdkEvent
1263 * @event2: second #GdkEvent
1264 * @distance: (out): return location for the distance
1266 * If both events have X/Y information, the distance between both coordinates
1267 * (as in a straight line going from @event1 to @event2) will be returned.
1269 * Returns: %TRUE if the distance could be calculated.
1274 gdk_events_get_distance (GdkEvent *event1,
1278 return gdk_events_get_axis_distances (event1, event2,
1284 * gdk_events_get_angle:
1285 * @event1: first #GdkEvent
1286 * @event2: second #GdkEvent
1287 * @angle: (out): return location for the relative angle between both events
1289 * If both events contain X/Y information, this function will return %TRUE
1290 * and return in @angle the relative angle from @event1 to @event2. The rotation
1291 * direction for positive angles is from the positive X axis towards the positive
1294 * Returns: %TRUE if the angle could be calculated.
1299 gdk_events_get_angle (GdkEvent *event1,
1303 gdouble x_distance, y_distance, distance;
1305 if (!gdk_events_get_axis_distances (event1, event2,
1306 &x_distance, &y_distance,
1312 *angle = atan2 (x_distance, y_distance);
1315 *angle = (2 * G_PI) - *angle;
1320 /* And constraint it to 0°-360° */
1321 *angle = fmod (*angle, 2 * G_PI);
1328 * gdk_events_get_center:
1329 * @event1: first #GdkEvent
1330 * @event2: second #GdkEvent
1331 * @x: (out): return location for the X coordinate of the center
1332 * @y: (out): return location for the Y coordinate of the center
1334 * If both events contain X/Y information, the center of both coordinates
1335 * will be returned in @x and @y.
1337 * Returns: %TRUE if the center could be calculated.
1342 gdk_events_get_center (GdkEvent *event1,
1347 gdouble x1, x2, y1, y2;
1349 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1350 !gdk_event_get_coords (event2, &x2, &y2))
1363 * gdk_event_set_screen:
1364 * @event: a #GdkEvent
1365 * @screen: a #GdkScreen
1367 * Sets the screen for @event to @screen. The event must
1368 * have been allocated by GTK+, for instance, by
1374 gdk_event_set_screen (GdkEvent *event,
1377 GdkEventPrivate *private;
1379 g_return_if_fail (gdk_event_is_allocated (event));
1381 private = (GdkEventPrivate *)event;
1383 private->screen = screen;
1387 * gdk_event_get_screen:
1388 * @event: a #GdkEvent
1390 * Returns the screen for the event. The screen is
1391 * typically the screen for <literal>event->any.window</literal>, but
1392 * for events such as mouse events, it is the screen
1393 * where the pointer was when the event occurs -
1394 * that is, the screen which has the root window
1395 * to which <literal>event->motion.x_root</literal> and
1396 * <literal>event->motion.y_root</literal> are relative.
1398 * Return value: (transfer none): the screen for the event
1403 gdk_event_get_screen (const GdkEvent *event)
1405 if (gdk_event_is_allocated (event))
1407 GdkEventPrivate *private = (GdkEventPrivate *)event;
1409 if (private->screen)
1410 return private->screen;
1413 if (event->any.window)
1414 return gdk_window_get_screen (event->any.window);
1420 * gdk_set_show_events:
1421 * @show_events: %TRUE to output event debugging information.
1423 * Sets whether a trace of received events is output.
1424 * Note that GTK+ must be compiled with debugging (that is,
1425 * configured using the <option>--enable-debug</option> option)
1426 * to use this option.
1429 gdk_set_show_events (gboolean show_events)
1432 _gdk_debug_flags |= GDK_DEBUG_EVENTS;
1434 _gdk_debug_flags &= ~GDK_DEBUG_EVENTS;
1438 * gdk_get_show_events:
1440 * Gets whether event debugging output is enabled.
1442 * Return value: %TRUE if event debugging output is enabled.
1445 gdk_get_show_events (void)
1447 return (_gdk_debug_flags & GDK_DEBUG_EVENTS) != 0;
1450 /* What do we do with G_IO_NVAL?
1452 #define READ_CONDITION (G_IO_IN | G_IO_HUP | G_IO_ERR)
1453 #define WRITE_CONDITION (G_IO_OUT | G_IO_ERR)
1454 #define EXCEPTION_CONDITION (G_IO_PRI)
1457 gdk_synthesize_click (GdkDisplay *display,
1461 GdkEvent *event_copy;
1464 event_copy = gdk_event_copy (event);
1465 event_copy->type = (nclicks == 2) ? GDK_2BUTTON_PRESS : GDK_3BUTTON_PRESS;
1467 link = _gdk_event_queue_append (display, event_copy);
1471 _gdk_event_button_generate (GdkDisplay *display,
1474 GdkMultipleClickInfo *info;
1476 g_return_if_fail (event->type == GDK_BUTTON_PRESS);
1478 info = g_hash_table_lookup (display->multiple_click_info, event->button.device);
1480 if (G_UNLIKELY (!info))
1482 info = g_new0 (GdkMultipleClickInfo, 1);
1483 info->button_number[0] = info->button_number[1] = -1;
1485 g_hash_table_insert (display->multiple_click_info,
1486 event->button.device, info);
1489 if ((event->button.time < (info->button_click_time[1] + 2 * display->double_click_time)) &&
1490 (event->button.window == info->button_window[1]) &&
1491 (event->button.button == info->button_number[1]) &&
1492 (ABS (event->button.x - info->button_x[1]) <= display->double_click_distance) &&
1493 (ABS (event->button.y - info->button_y[1]) <= display->double_click_distance))
1495 gdk_synthesize_click (display, event, 3);
1497 info->button_click_time[1] = 0;
1498 info->button_click_time[0] = 0;
1499 info->button_window[1] = NULL;
1500 info->button_window[0] = NULL;
1501 info->button_number[1] = -1;
1502 info->button_number[0] = -1;
1503 info->button_x[0] = info->button_x[1] = 0;
1504 info->button_y[0] = info->button_y[1] = 0;
1506 else if ((event->button.time < (info->button_click_time[0] + display->double_click_time)) &&
1507 (event->button.window == info->button_window[0]) &&
1508 (event->button.button == info->button_number[0]) &&
1509 (ABS (event->button.x - info->button_x[0]) <= display->double_click_distance) &&
1510 (ABS (event->button.y - info->button_y[0]) <= display->double_click_distance))
1512 gdk_synthesize_click (display, event, 2);
1514 info->button_click_time[1] = info->button_click_time[0];
1515 info->button_click_time[0] = event->button.time;
1516 info->button_window[1] = info->button_window[0];
1517 info->button_window[0] = event->button.window;
1518 info->button_number[1] = info->button_number[0];
1519 info->button_number[0] = event->button.button;
1520 info->button_x[1] = info->button_x[0];
1521 info->button_x[0] = event->button.x;
1522 info->button_y[1] = info->button_y[0];
1523 info->button_y[0] = event->button.y;
1527 info->button_click_time[1] = 0;
1528 info->button_click_time[0] = event->button.time;
1529 info->button_window[1] = NULL;
1530 info->button_window[0] = event->button.window;
1531 info->button_number[1] = -1;
1532 info->button_number[0] = event->button.button;
1533 info->button_x[1] = 0;
1534 info->button_x[0] = event->button.x;
1535 info->button_y[1] = 0;
1536 info->button_y[0] = event->button.y;
1541 gdk_synthesize_window_state (GdkWindow *window,
1542 GdkWindowState unset_flags,
1543 GdkWindowState set_flags)
1545 GdkEvent temp_event;
1548 g_return_if_fail (window != NULL);
1550 temp_event.window_state.window = window;
1551 temp_event.window_state.type = GDK_WINDOW_STATE;
1552 temp_event.window_state.send_event = FALSE;
1554 old = temp_event.window_state.window->state;
1556 temp_event.window_state.new_window_state = old;
1557 temp_event.window_state.new_window_state |= set_flags;
1558 temp_event.window_state.new_window_state &= ~unset_flags;
1559 temp_event.window_state.changed_mask = temp_event.window_state.new_window_state ^ old;
1561 if (temp_event.window_state.new_window_state == old)
1562 return; /* No actual work to do, nothing changed. */
1564 /* Actually update the field in GdkWindow, this is sort of an odd
1565 * place to do it, but seems like the safest since it ensures we expose no
1566 * inconsistent state to the user.
1569 window->state = temp_event.window_state.new_window_state;
1571 if (temp_event.window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1572 _gdk_window_update_viewable (window);
1574 /* We only really send the event to toplevels, since
1575 * all the window states don't apply to non-toplevels.
1576 * Non-toplevels do use the GDK_WINDOW_STATE_WITHDRAWN flag
1577 * internally so we needed to update window->state.
1579 switch (window->window_type)
1581 case GDK_WINDOW_TOPLEVEL:
1582 case GDK_WINDOW_TEMP: /* ? */
1583 gdk_display_put_event (gdk_window_get_display (window), &temp_event);
1586 case GDK_WINDOW_FOREIGN:
1587 case GDK_WINDOW_ROOT:
1588 case GDK_WINDOW_CHILD:
1594 * gdk_display_set_double_click_time:
1595 * @display: a #GdkDisplay
1596 * @msec: double click time in milliseconds (thousandths of a second)
1598 * Sets the double click time (two clicks within this time interval
1599 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1600 * Applications should <emphasis>not</emphasis> set this, it is a global
1601 * user-configured setting.
1606 gdk_display_set_double_click_time (GdkDisplay *display,
1609 display->double_click_time = msec;
1613 * gdk_set_double_click_time:
1614 * @msec: double click time in milliseconds (thousandths of a second)
1616 * Set the double click time for the default display. See
1617 * gdk_display_set_double_click_time().
1618 * See also gdk_display_set_double_click_distance().
1619 * Applications should <emphasis>not</emphasis> set this, it is a
1620 * global user-configured setting.
1623 gdk_set_double_click_time (guint msec)
1625 gdk_display_set_double_click_time (gdk_display_get_default (), msec);
1629 * gdk_display_set_double_click_distance:
1630 * @display: a #GdkDisplay
1631 * @distance: distance in pixels
1633 * Sets the double click distance (two clicks within this distance
1634 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1635 * See also gdk_display_set_double_click_time().
1636 * Applications should <emphasis>not</emphasis> set this, it is a global
1637 * user-configured setting.
1642 gdk_display_set_double_click_distance (GdkDisplay *display,
1645 display->double_click_distance = distance;
1648 G_DEFINE_BOXED_TYPE (GdkEvent, gdk_event,
1654 * @name: the name of the setting.
1655 * @value: location to store the value of the setting.
1657 * Obtains a desktop-wide setting, such as the double-click time,
1658 * for the default screen. See gdk_screen_get_setting().
1660 * Returns: %TRUE if the setting existed and a value was stored
1661 * in @value, %FALSE otherwise.
1664 gdk_setting_get (const gchar *name,
1667 return gdk_screen_get_setting (gdk_screen_get_default (), name, value);