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"
34 typedef struct _GdkIOClosure GdkIOClosure;
38 GDestroyNotify notify;
42 /* Private variable declarations
45 GdkEventFunc _gdk_event_func = NULL; /* Callback for events */
46 gpointer _gdk_event_data = NULL;
47 GDestroyNotify _gdk_event_notify = NULL;
49 /*********************************************
50 * Functions for maintaining the event queue *
51 *********************************************/
54 * _gdk_event_queue_find_first:
55 * @display: a #GdkDisplay
57 * Find the first event on the queue that is not still
60 * Return value: Pointer to the list node for that event, or NULL.
63 _gdk_event_queue_find_first (GdkDisplay *display)
65 GList *tmp_list = display->queued_events;
69 GdkEventPrivate *event = tmp_list->data;
70 if (!(event->flags & GDK_EVENT_PENDING))
73 tmp_list = g_list_next (tmp_list);
80 * _gdk_event_queue_prepend:
81 * @display: a #GdkDisplay
82 * @event: Event to prepend.
84 * Prepends an event before the head of the event queue.
86 * Returns: the newly prepended list node.
89 _gdk_event_queue_prepend (GdkDisplay *display,
92 display->queued_events = g_list_prepend (display->queued_events, event);
93 if (!display->queued_tail)
94 display->queued_tail = display->queued_events;
95 return display->queued_events;
99 * _gdk_event_queue_append:
100 * @display: a #GdkDisplay
101 * @event: Event to append.
103 * Appends an event onto the tail of the event queue.
105 * Returns: the newly appended list node.
108 _gdk_event_queue_append (GdkDisplay *display,
111 display->queued_tail = g_list_append (display->queued_tail, event);
113 if (!display->queued_events)
114 display->queued_events = display->queued_tail;
116 display->queued_tail = display->queued_tail->next;
118 return display->queued_tail;
122 * _gdk_event_queue_insert_after:
123 * @display: a #GdkDisplay
124 * @sibling: Append after this event.
125 * @event: Event to append.
127 * Appends an event after the specified event, or if it isn't in
128 * the queue, onto the tail of the event queue.
130 * Returns: the newly appended list node.
135 _gdk_event_queue_insert_after (GdkDisplay *display,
139 GList *prev = g_list_find (display->queued_events, sibling);
140 if (prev && prev->next)
142 display->queued_events = g_list_insert_before (display->queued_events, prev->next, event);
146 return _gdk_event_queue_append (display, event);
150 * _gdk_event_queue_insert_after:
151 * @display: a #GdkDisplay
152 * @sibling: Append after this event.
153 * @event: Event to append.
155 * Appends an event before the specified event, or if it isn't in
156 * the queue, onto the tail of the event queue.
158 * Returns: the newly appended list node.
163 _gdk_event_queue_insert_before (GdkDisplay *display,
167 GList *next = g_list_find (display->queued_events, sibling);
170 display->queued_events = g_list_insert_before (display->queued_events, next, event);
174 return _gdk_event_queue_append (display, event);
179 * _gdk_event_queue_remove_link:
180 * @display: a #GdkDisplay
181 * @node: node to remove
183 * Removes a specified list node from the event queue.
186 _gdk_event_queue_remove_link (GdkDisplay *display,
190 node->prev->next = node->next;
192 display->queued_events = node->next;
195 node->next->prev = node->prev;
197 display->queued_tail = node->prev;
201 * _gdk_event_unqueue:
202 * @display: a #GdkDisplay
204 * Removes and returns the first event from the event
205 * queue that is not still being filled in.
207 * Return value: the event, or %NULL. Ownership is transferred
211 _gdk_event_unqueue (GdkDisplay *display)
213 GdkEvent *event = NULL;
216 tmp_list = _gdk_event_queue_find_first (display);
220 event = tmp_list->data;
221 _gdk_event_queue_remove_link (display, tmp_list);
222 g_list_free_1 (tmp_list);
229 * gdk_event_handler_set:
230 * @func: the function to call to handle events from GDK.
231 * @data: user data to pass to the function.
232 * @notify: the function to call when the handler function is removed, i.e. when
233 * gdk_event_handler_set() is called with another event handler.
235 * Sets the function to call to handle all events from GDK.
237 * Note that GTK+ uses this to install its own event handler, so it is
238 * usually not useful for GTK+ applications. (Although an application
239 * can call this function then call gtk_main_do_event() to pass
243 gdk_event_handler_set (GdkEventFunc func,
245 GDestroyNotify notify)
247 if (_gdk_event_notify)
248 (*_gdk_event_notify) (_gdk_event_data);
250 _gdk_event_func = func;
251 _gdk_event_data = data;
252 _gdk_event_notify = notify;
258 * Checks all open displays for a #GdkEvent to process,to be processed
259 * on, fetching events from the windowing system if necessary.
260 * See gdk_display_get_event().
262 * Return value: the next #GdkEvent to be processed, or %NULL if no events
263 * are pending. The returned #GdkEvent should be freed with gdk_event_free().
270 for (tmp_list = _gdk_displays; tmp_list; tmp_list = tmp_list->next)
272 GdkEvent *event = gdk_display_get_event (tmp_list->data);
283 * If there is an event waiting in the event queue of some open
284 * display, returns a copy of it. See gdk_display_peek_event().
286 * Return value: a copy of the first #GdkEvent on some event queue, or %NULL if no
287 * events are in any queues. The returned #GdkEvent should be freed with
291 gdk_event_peek (void)
295 for (tmp_list = _gdk_displays; tmp_list; tmp_list = tmp_list->next)
297 GdkEvent *event = gdk_display_peek_event (tmp_list->data);
307 * @event: a #GdkEvent.
309 * Appends a copy of the given event onto the front of the event
310 * queue for event->any.window's display, or the default event
311 * queue if event->any.window is %NULL. See gdk_display_put_event().
314 gdk_event_put (const GdkEvent *event)
318 g_return_if_fail (event != NULL);
320 if (event->any.window)
321 display = gdk_window_get_display (event->any.window);
325 g_message ("Falling back to default display for gdk_event_put()"));
326 display = gdk_display_get_default ();
329 gdk_display_put_event (display, event);
332 static GHashTable *event_hash = NULL;
336 * @type: a #GdkEventType
338 * Creates a new event of the given type. All fields are set to 0.
340 * Return value: a newly-allocated #GdkEvent. The returned #GdkEvent
341 * should be freed with gdk_event_free().
346 gdk_event_new (GdkEventType type)
348 GdkEventPrivate *new_private;
352 event_hash = g_hash_table_new (g_direct_hash, NULL);
354 new_private = g_slice_new0 (GdkEventPrivate);
356 new_private->flags = 0;
357 new_private->screen = NULL;
359 g_hash_table_insert (event_hash, new_private, GUINT_TO_POINTER (1));
361 new_event = (GdkEvent *) new_private;
363 new_event->any.type = type;
366 * Bytewise 0 initialization is reasonable for most of the
367 * current event types. Explicitely initialize double fields
368 * since I trust bytewise 0 == 0. less than for integers
373 case GDK_MOTION_NOTIFY:
374 new_event->motion.x = 0.;
375 new_event->motion.y = 0.;
376 new_event->motion.x_root = 0.;
377 new_event->motion.y_root = 0.;
379 case GDK_BUTTON_PRESS:
380 case GDK_2BUTTON_PRESS:
381 case GDK_3BUTTON_PRESS:
382 case GDK_BUTTON_RELEASE:
383 new_event->button.x = 0.;
384 new_event->button.y = 0.;
385 new_event->button.x_root = 0.;
386 new_event->button.y_root = 0.;
389 new_event->scroll.x = 0.;
390 new_event->scroll.y = 0.;
391 new_event->scroll.x_root = 0.;
392 new_event->scroll.y_root = 0.;
394 case GDK_ENTER_NOTIFY:
395 case GDK_LEAVE_NOTIFY:
396 new_event->crossing.x = 0.;
397 new_event->crossing.y = 0.;
398 new_event->crossing.x_root = 0.;
399 new_event->crossing.y_root = 0.;
409 gdk_event_is_allocated (const GdkEvent *event)
412 return g_hash_table_lookup (event_hash, event) != NULL;
419 * @event: a #GdkEvent
421 * Copies a #GdkEvent, copying or incrementing the reference count of the
422 * resources associated with it (e.g. #GdkWindow's and strings).
424 * Return value: a copy of @event. The returned #GdkEvent should be freed with
428 gdk_event_copy (const GdkEvent *event)
430 GdkEventPrivate *new_private;
433 g_return_val_if_fail (event != NULL, NULL);
435 new_event = gdk_event_new (GDK_NOTHING);
436 new_private = (GdkEventPrivate *)new_event;
439 if (new_event->any.window)
440 g_object_ref (new_event->any.window);
442 if (gdk_event_is_allocated (event))
444 GdkEventPrivate *private = (GdkEventPrivate *)event;
446 new_private->screen = private->screen;
447 new_private->device = private->device;
450 switch (event->any.type)
453 case GDK_KEY_RELEASE:
454 new_event->key.string = g_strdup (event->key.string);
457 case GDK_ENTER_NOTIFY:
458 case GDK_LEAVE_NOTIFY:
459 if (event->crossing.subwindow != NULL)
460 g_object_ref (event->crossing.subwindow);
465 case GDK_DRAG_MOTION:
466 case GDK_DRAG_STATUS:
468 case GDK_DROP_FINISHED:
469 g_object_ref (event->dnd.context);
474 if (event->expose.region)
475 new_event->expose.region = cairo_region_copy (event->expose.region);
479 new_event->setting.name = g_strdup (new_event->setting.name);
482 case GDK_BUTTON_PRESS:
483 case GDK_BUTTON_RELEASE:
484 if (event->button.axes)
485 new_event->button.axes = g_memdup (event->button.axes,
486 sizeof (gdouble) * event->button.device->num_axes);
489 case GDK_MOTION_NOTIFY:
490 if (event->motion.axes)
491 new_event->motion.axes = g_memdup (event->motion.axes,
492 sizeof (gdouble) * event->motion.device->num_axes);
500 if (gdk_event_is_allocated (event))
501 _gdk_windowing_event_data_copy (event, new_event);
508 * @event: a #GdkEvent.
510 * Frees a #GdkEvent, freeing or decrementing any resources associated with it.
511 * Note that this function should only be called with events returned from
512 * functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
513 * and gdk_event_new().
516 gdk_event_free (GdkEvent *event)
518 g_return_if_fail (event != NULL);
520 if (event->any.window)
521 g_object_unref (event->any.window);
523 switch (event->any.type)
526 case GDK_KEY_RELEASE:
527 g_free (event->key.string);
530 case GDK_ENTER_NOTIFY:
531 case GDK_LEAVE_NOTIFY:
532 if (event->crossing.subwindow != NULL)
533 g_object_unref (event->crossing.subwindow);
538 case GDK_DRAG_MOTION:
539 case GDK_DRAG_STATUS:
541 case GDK_DROP_FINISHED:
542 if (event->dnd.context != NULL)
543 g_object_unref (event->dnd.context);
546 case GDK_BUTTON_PRESS:
547 case GDK_BUTTON_RELEASE:
548 g_free (event->button.axes);
553 if (event->expose.region)
554 cairo_region_destroy (event->expose.region);
557 case GDK_MOTION_NOTIFY:
558 g_free (event->motion.axes);
562 g_free (event->setting.name);
569 _gdk_windowing_event_data_free (event);
571 g_hash_table_remove (event_hash, event);
572 g_slice_free (GdkEventPrivate, (GdkEventPrivate*) event);
576 * gdk_event_get_time:
577 * @event: a #GdkEvent
579 * Returns the time stamp from @event, if there is one; otherwise
580 * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
582 * Return value: time stamp field from @event
585 gdk_event_get_time (const GdkEvent *event)
590 case GDK_MOTION_NOTIFY:
591 return event->motion.time;
592 case GDK_BUTTON_PRESS:
593 case GDK_2BUTTON_PRESS:
594 case GDK_3BUTTON_PRESS:
595 case GDK_BUTTON_RELEASE:
596 return event->button.time;
598 return event->scroll.time;
600 case GDK_KEY_RELEASE:
601 return event->key.time;
602 case GDK_ENTER_NOTIFY:
603 case GDK_LEAVE_NOTIFY:
604 return event->crossing.time;
605 case GDK_PROPERTY_NOTIFY:
606 return event->property.time;
607 case GDK_SELECTION_CLEAR:
608 case GDK_SELECTION_REQUEST:
609 case GDK_SELECTION_NOTIFY:
610 return event->selection.time;
611 case GDK_PROXIMITY_IN:
612 case GDK_PROXIMITY_OUT:
613 return event->proximity.time;
616 case GDK_DRAG_MOTION:
617 case GDK_DRAG_STATUS:
619 case GDK_DROP_FINISHED:
620 return event->dnd.time;
621 case GDK_CLIENT_EVENT:
622 case GDK_VISIBILITY_NOTIFY:
625 case GDK_FOCUS_CHANGE:
633 case GDK_WINDOW_STATE:
635 case GDK_OWNER_CHANGE:
636 case GDK_GRAB_BROKEN:
638 /* return current time */
642 return GDK_CURRENT_TIME;
646 * gdk_event_get_state:
647 * @event: a #GdkEvent or NULL
648 * @state: (out): return location for state
650 * If the event contains a "state" field, puts that field in @state. Otherwise
651 * stores an empty state (0). Returns %TRUE if there was a state field
652 * in the event. @event may be %NULL, in which case it's treated
653 * as if the event had no state field.
655 * Return value: %TRUE if there was a state field in the event
658 gdk_event_get_state (const GdkEvent *event,
659 GdkModifierType *state)
661 g_return_val_if_fail (state != NULL, FALSE);
666 case GDK_MOTION_NOTIFY:
667 *state = event->motion.state;
669 case GDK_BUTTON_PRESS:
670 case GDK_2BUTTON_PRESS:
671 case GDK_3BUTTON_PRESS:
672 case GDK_BUTTON_RELEASE:
673 *state = event->button.state;
676 *state = event->scroll.state;
679 case GDK_KEY_RELEASE:
680 *state = event->key.state;
682 case GDK_ENTER_NOTIFY:
683 case GDK_LEAVE_NOTIFY:
684 *state = event->crossing.state;
686 case GDK_PROPERTY_NOTIFY:
687 *state = event->property.state;
689 case GDK_VISIBILITY_NOTIFY:
690 case GDK_CLIENT_EVENT:
693 case GDK_FOCUS_CHANGE:
694 case GDK_SELECTION_CLEAR:
695 case GDK_SELECTION_REQUEST:
696 case GDK_SELECTION_NOTIFY:
697 case GDK_PROXIMITY_IN:
698 case GDK_PROXIMITY_OUT:
702 case GDK_DRAG_MOTION:
703 case GDK_DRAG_STATUS:
705 case GDK_DROP_FINISHED:
712 case GDK_WINDOW_STATE:
714 case GDK_OWNER_CHANGE:
715 case GDK_GRAB_BROKEN:
726 * gdk_event_get_coords:
727 * @event: a #GdkEvent
728 * @x_win: (out): location to put event window x coordinate
729 * @y_win: (out): location to put event window y coordinate
731 * Extract the event window relative x/y coordinates from an event.
733 * Return value: %TRUE if the event delivered event window coordinates
736 gdk_event_get_coords (const GdkEvent *event,
740 gdouble x = 0, y = 0;
741 gboolean fetched = TRUE;
743 g_return_val_if_fail (event != NULL, FALSE);
748 x = event->configure.x;
749 y = event->configure.y;
751 case GDK_ENTER_NOTIFY:
752 case GDK_LEAVE_NOTIFY:
753 x = event->crossing.x;
754 y = event->crossing.y;
760 case GDK_BUTTON_PRESS:
761 case GDK_2BUTTON_PRESS:
762 case GDK_3BUTTON_PRESS:
763 case GDK_BUTTON_RELEASE:
767 case GDK_MOTION_NOTIFY:
785 * gdk_event_get_root_coords:
786 * @event: a #GdkEvent
787 * @x_root: (out): location to put root window x coordinate
788 * @y_root: (out): location to put root window y coordinate
790 * Extract the root window relative x/y coordinates from an event.
792 * Return value: %TRUE if the event delivered root window coordinates
795 gdk_event_get_root_coords (const GdkEvent *event,
799 gdouble x = 0, y = 0;
800 gboolean fetched = TRUE;
802 g_return_val_if_fail (event != NULL, FALSE);
806 case GDK_MOTION_NOTIFY:
807 x = event->motion.x_root;
808 y = event->motion.y_root;
811 x = event->scroll.x_root;
812 y = event->scroll.y_root;
814 case GDK_BUTTON_PRESS:
815 case GDK_2BUTTON_PRESS:
816 case GDK_3BUTTON_PRESS:
817 case GDK_BUTTON_RELEASE:
818 x = event->button.x_root;
819 y = event->button.y_root;
821 case GDK_ENTER_NOTIFY:
822 case GDK_LEAVE_NOTIFY:
823 x = event->crossing.x_root;
824 y = event->crossing.y_root;
828 case GDK_DRAG_MOTION:
829 case GDK_DRAG_STATUS:
831 case GDK_DROP_FINISHED:
832 x = event->dnd.x_root;
833 y = event->dnd.y_root;
849 * gdk_event_get_axis:
850 * @event: a #GdkEvent
851 * @axis_use: (out): the axis use to look for
852 * @value: (out): location to store the value found
854 * Extract the axis value for a particular axis use from
855 * an event structure.
857 * Return value: %TRUE if the specified axis was found, otherwise %FALSE
860 gdk_event_get_axis (const GdkEvent *event,
867 g_return_val_if_fail (event != NULL, FALSE);
869 if (axis_use == GDK_AXIS_X || axis_use == GDK_AXIS_Y)
875 case GDK_MOTION_NOTIFY:
883 case GDK_BUTTON_PRESS:
884 case GDK_BUTTON_RELEASE:
888 case GDK_ENTER_NOTIFY:
889 case GDK_LEAVE_NOTIFY:
890 x = event->crossing.x;
891 y = event->crossing.y;
898 if (axis_use == GDK_AXIS_X && value)
900 if (axis_use == GDK_AXIS_Y && value)
905 else if (event->type == GDK_BUTTON_PRESS ||
906 event->type == GDK_BUTTON_RELEASE)
908 device = event->button.device;
909 axes = event->button.axes;
911 else if (event->type == GDK_MOTION_NOTIFY)
913 device = event->motion.device;
914 axes = event->motion.axes;
919 return gdk_device_get_axis (device, axes, axis_use, value);
923 * gdk_event_set_device:
924 * @event: a #GdkEvent
925 * @device: a #GdkDevice
927 * Sets the device for @event to @device. The event must
928 * have been allocated by GTK+, for instance, by
934 gdk_event_set_device (GdkEvent *event,
937 GdkEventPrivate *private;
939 g_return_if_fail (gdk_event_is_allocated (event));
941 private = (GdkEventPrivate *) event;
943 private->device = device;
947 case GDK_MOTION_NOTIFY:
948 event->motion.device = device;
950 case GDK_BUTTON_PRESS:
951 case GDK_2BUTTON_PRESS:
952 case GDK_3BUTTON_PRESS:
953 case GDK_BUTTON_RELEASE:
954 event->button.device = device;
957 event->scroll.device = device;
959 case GDK_PROXIMITY_IN:
960 case GDK_PROXIMITY_OUT:
961 event->proximity.device = device;
969 * gdk_event_get_device:
970 * @event: a #GdkEvent.
972 * If the event contains a "device" field, this function will return
973 * it, else it will return %NULL.
975 * Returns: (transfer none): a #GdkDevice, or %NULL.
980 gdk_event_get_device (const GdkEvent *event)
982 g_return_val_if_fail (event != NULL, NULL);
984 if (gdk_event_is_allocated (event))
986 GdkEventPrivate *private = (GdkEventPrivate *) event;
989 return private->device;
994 case GDK_MOTION_NOTIFY:
995 return event->motion.device;
996 case GDK_BUTTON_PRESS:
997 case GDK_2BUTTON_PRESS:
998 case GDK_3BUTTON_PRESS:
999 case GDK_BUTTON_RELEASE:
1000 return event->button.device;
1002 return event->scroll.device;
1003 case GDK_PROXIMITY_IN:
1004 case GDK_PROXIMITY_OUT:
1005 return event->proximity.device;
1010 /* Fallback if event has no device set */
1011 switch (event->type)
1013 case GDK_MOTION_NOTIFY:
1014 case GDK_BUTTON_PRESS:
1015 case GDK_2BUTTON_PRESS:
1016 case GDK_3BUTTON_PRESS:
1017 case GDK_BUTTON_RELEASE:
1018 case GDK_ENTER_NOTIFY:
1019 case GDK_LEAVE_NOTIFY:
1020 case GDK_FOCUS_CHANGE:
1021 case GDK_PROXIMITY_IN:
1022 case GDK_PROXIMITY_OUT:
1023 case GDK_DRAG_ENTER:
1024 case GDK_DRAG_LEAVE:
1025 case GDK_DRAG_MOTION:
1026 case GDK_DRAG_STATUS:
1027 case GDK_DROP_START:
1028 case GDK_DROP_FINISHED:
1030 case GDK_GRAB_BROKEN:
1032 case GDK_KEY_RELEASE:
1034 GdkDisplay *display;
1035 GdkDevice *core_pointer;
1036 GdkDeviceManager *device_manager;
1038 g_warning ("Event with type %d not holding a GdkDevice. "
1039 "It is most likely synthesized outside Gdk/GTK+\n",
1042 display = gdk_window_get_display (event->any.window);
1043 device_manager = gdk_display_get_device_manager (display);
1044 core_pointer = gdk_display_get_core_pointer (display);
1046 if (event->type == GDK_KEY_PRESS ||
1047 event->type == GDK_KEY_RELEASE)
1048 return gdk_device_get_associated_device (core_pointer);
1050 return core_pointer;
1059 * gdk_event_request_motions:
1060 * @event: a valid #GdkEvent
1062 * Request more motion notifies if @event is a motion notify hint event.
1063 * This function should be used instead of gdk_window_get_pointer() to
1064 * request further motion notifies, because it also works for extension
1065 * events where motion notifies are provided for devices other than the
1066 * core pointer. Coordinate extraction, processing and requesting more
1067 * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
1071 * /* motion_event handler */
1072 * x = motion_event->x;
1073 * y = motion_event->y;
1074 * /* handle (x,y) motion */
1075 * gdk_event_request_motions (motion_event); /* handles is_hint events */
1082 gdk_event_request_motions (const GdkEventMotion *event)
1084 GdkDisplay *display;
1086 g_return_if_fail (event != NULL);
1088 if (event->type == GDK_MOTION_NOTIFY && event->is_hint)
1090 gdk_device_get_state (event->device, event->window, NULL, NULL);
1092 display = gdk_window_get_display (event->window);
1093 _gdk_display_enable_motion_hints (display, event->device);
1098 gdk_events_get_axis_distances (GdkEvent *event1,
1100 gdouble *x_distance,
1101 gdouble *y_distance,
1104 gdouble x1, x2, y1, y2;
1107 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1108 !gdk_event_get_coords (event2, &x2, &y2))
1121 *distance = sqrt ((xd * xd) + (yd * yd));
1127 * gdk_events_get_distance:
1128 * @event1: first #GdkEvent
1129 * @event2: second #GdkEvent
1130 * @distance: return location for the distance
1132 * If both events have X/Y information, the distance between both coordinates
1133 * (as in a straight line going from @event1 to @event2) will be returned.
1135 * Returns: %TRUE if the distance could be calculated.
1140 gdk_events_get_distance (GdkEvent *event1,
1144 return gdk_events_get_axis_distances (event1, event2,
1150 * gdk_events_get_angle:
1151 * @event1: first #GdkEvent
1152 * @event2: second #GdkEvent
1153 * @angle: return location for the relative angle between both events
1155 * If both events contain X/Y information, this function will return %TRUE
1156 * and return in @angle the relative angle from @event1 to @event2. The rotation
1157 * direction for positive angles is from the positive X axis towards the positive
1160 * Returns: %TRUE if the angle could be calculated.
1165 gdk_events_get_angle (GdkEvent *event1,
1169 gdouble x_distance, y_distance, distance;
1171 if (!gdk_events_get_axis_distances (event1, event2,
1172 &x_distance, &y_distance,
1178 *angle = atan2 (x_distance, y_distance);
1181 *angle = (2 * G_PI) - *angle;
1186 /* And constraint it to 0°-360° */
1187 *angle = fmod (*angle, 2 * G_PI);
1194 * gdk_events_get_center:
1195 * @event1: first #GdkEvent
1196 * @event2: second #GdkEvent
1197 * @x: (out): return location for the X coordinate of the center
1198 * @y: (out): return location for the Y coordinate of the center
1200 * If both events contain X/Y information, the center of both coordinates
1201 * will be returned in @x and @y.
1203 * Returns: %TRUE if the center could be calculated.
1208 gdk_events_get_center (GdkEvent *event1,
1213 gdouble x1, x2, y1, y2;
1215 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1216 !gdk_event_get_coords (event2, &x2, &y2))
1229 * gdk_event_set_screen:
1230 * @event: a #GdkEvent
1231 * @screen: a #GdkScreen
1233 * Sets the screen for @event to @screen. The event must
1234 * have been allocated by GTK+, for instance, by
1240 gdk_event_set_screen (GdkEvent *event,
1243 GdkEventPrivate *private;
1245 g_return_if_fail (gdk_event_is_allocated (event));
1247 private = (GdkEventPrivate *)event;
1249 private->screen = screen;
1253 * gdk_event_get_screen:
1254 * @event: a #GdkEvent
1256 * Returns the screen for the event. The screen is
1257 * typically the screen for <literal>event->any.window</literal>, but
1258 * for events such as mouse events, it is the screen
1259 * where the pointer was when the event occurs -
1260 * that is, the screen which has the root window
1261 * to which <literal>event->motion.x_root</literal> and
1262 * <literal>event->motion.y_root</literal> are relative.
1264 * Return value: the screen for the event
1269 gdk_event_get_screen (const GdkEvent *event)
1271 if (gdk_event_is_allocated (event))
1273 GdkEventPrivate *private = (GdkEventPrivate *)event;
1275 if (private->screen)
1276 return private->screen;
1279 if (event->any.window)
1280 return gdk_window_get_screen (event->any.window);
1286 * gdk_set_show_events:
1287 * @show_events: %TRUE to output event debugging information.
1289 * Sets whether a trace of received events is output.
1290 * Note that GTK+ must be compiled with debugging (that is,
1291 * configured using the <option>--enable-debug</option> option)
1292 * to use this option.
1295 gdk_set_show_events (gboolean show_events)
1298 _gdk_debug_flags |= GDK_DEBUG_EVENTS;
1300 _gdk_debug_flags &= ~GDK_DEBUG_EVENTS;
1304 * gdk_get_show_events:
1306 * Gets whether event debugging output is enabled.
1308 * Return value: %TRUE if event debugging output is enabled.
1311 gdk_get_show_events (void)
1313 return (_gdk_debug_flags & GDK_DEBUG_EVENTS) != 0;
1316 /* What do we do with G_IO_NVAL?
1318 #define READ_CONDITION (G_IO_IN | G_IO_HUP | G_IO_ERR)
1319 #define WRITE_CONDITION (G_IO_OUT | G_IO_ERR)
1320 #define EXCEPTION_CONDITION (G_IO_PRI)
1323 gdk_synthesize_click (GdkDisplay *display,
1327 GdkEvent temp_event;
1328 GdkEvent *event_copy;
1331 g_return_if_fail (event != NULL);
1333 temp_event = *event;
1334 temp_event.type = (nclicks == 2) ? GDK_2BUTTON_PRESS : GDK_3BUTTON_PRESS;
1336 event_copy = gdk_event_copy (&temp_event);
1337 link = _gdk_event_queue_append (display, event_copy);
1341 _gdk_event_button_generate (GdkDisplay *display,
1344 GdkMultipleClickInfo *info;
1346 info = g_hash_table_lookup (display->multiple_click_info, event->button.device);
1348 if (G_UNLIKELY (!info))
1350 info = g_new0 (GdkMultipleClickInfo, 1);
1351 info->button_number[0] = info->button_number[1] = -1;
1353 g_hash_table_insert (display->multiple_click_info,
1354 event->button.device, info);
1357 if ((event->button.time < (info->button_click_time[1] + 2 * display->double_click_time)) &&
1358 (event->button.window == info->button_window[1]) &&
1359 (event->button.button == info->button_number[1]) &&
1360 (ABS (event->button.x - info->button_x[1]) <= display->double_click_distance) &&
1361 (ABS (event->button.y - info->button_y[1]) <= display->double_click_distance))
1363 gdk_synthesize_click (display, event, 3);
1365 info->button_click_time[1] = 0;
1366 info->button_click_time[0] = 0;
1367 info->button_window[1] = NULL;
1368 info->button_window[0] = NULL;
1369 info->button_number[1] = -1;
1370 info->button_number[0] = -1;
1371 info->button_x[0] = info->button_x[1] = 0;
1372 info->button_y[0] = info->button_y[1] = 0;
1374 else if ((event->button.time < (info->button_click_time[0] + display->double_click_time)) &&
1375 (event->button.window == info->button_window[0]) &&
1376 (event->button.button == info->button_number[0]) &&
1377 (ABS (event->button.x - info->button_x[0]) <= display->double_click_distance) &&
1378 (ABS (event->button.y - info->button_y[0]) <= display->double_click_distance))
1380 gdk_synthesize_click (display, event, 2);
1382 info->button_click_time[1] = info->button_click_time[0];
1383 info->button_click_time[0] = event->button.time;
1384 info->button_window[1] = info->button_window[0];
1385 info->button_window[0] = event->button.window;
1386 info->button_number[1] = info->button_number[0];
1387 info->button_number[0] = event->button.button;
1388 info->button_x[1] = info->button_x[0];
1389 info->button_x[0] = event->button.x;
1390 info->button_y[1] = info->button_y[0];
1391 info->button_y[0] = event->button.y;
1395 info->button_click_time[1] = 0;
1396 info->button_click_time[0] = event->button.time;
1397 info->button_window[1] = NULL;
1398 info->button_window[0] = event->button.window;
1399 info->button_number[1] = -1;
1400 info->button_number[0] = event->button.button;
1401 info->button_x[1] = 0;
1402 info->button_x[0] = event->button.x;
1403 info->button_y[1] = 0;
1404 info->button_y[0] = event->button.y;
1409 gdk_synthesize_window_state (GdkWindow *window,
1410 GdkWindowState unset_flags,
1411 GdkWindowState set_flags)
1413 GdkEvent temp_event;
1416 g_return_if_fail (window != NULL);
1418 temp_event.window_state.window = window;
1419 temp_event.window_state.type = GDK_WINDOW_STATE;
1420 temp_event.window_state.send_event = FALSE;
1422 old = ((GdkWindowObject*) temp_event.window_state.window)->state;
1424 temp_event.window_state.new_window_state = old;
1425 temp_event.window_state.new_window_state |= set_flags;
1426 temp_event.window_state.new_window_state &= ~unset_flags;
1427 temp_event.window_state.changed_mask = temp_event.window_state.new_window_state ^ old;
1429 if (temp_event.window_state.new_window_state == old)
1430 return; /* No actual work to do, nothing changed. */
1432 /* Actually update the field in GdkWindow, this is sort of an odd
1433 * place to do it, but seems like the safest since it ensures we expose no
1434 * inconsistent state to the user.
1437 ((GdkWindowObject*) window)->state = temp_event.window_state.new_window_state;
1439 if (temp_event.window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1440 _gdk_window_update_viewable (window);
1442 /* We only really send the event to toplevels, since
1443 * all the window states don't apply to non-toplevels.
1444 * Non-toplevels do use the GDK_WINDOW_STATE_WITHDRAWN flag
1445 * internally so we needed to update window->state.
1447 switch (((GdkWindowObject*) window)->window_type)
1449 case GDK_WINDOW_TOPLEVEL:
1450 case GDK_WINDOW_TEMP: /* ? */
1451 gdk_display_put_event (gdk_window_get_display (window), &temp_event);
1454 case GDK_WINDOW_FOREIGN:
1455 case GDK_WINDOW_ROOT:
1456 case GDK_WINDOW_CHILD:
1462 * gdk_display_set_double_click_time:
1463 * @display: a #GdkDisplay
1464 * @msec: double click time in milliseconds (thousandths of a second)
1466 * Sets the double click time (two clicks within this time interval
1467 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1468 * Applications should <emphasis>not</emphasis> set this, it is a global
1469 * user-configured setting.
1474 gdk_display_set_double_click_time (GdkDisplay *display,
1477 display->double_click_time = msec;
1481 * gdk_set_double_click_time:
1482 * @msec: double click time in milliseconds (thousandths of a second)
1484 * Set the double click time for the default display. See
1485 * gdk_display_set_double_click_time().
1486 * See also gdk_display_set_double_click_distance().
1487 * Applications should <emphasis>not</emphasis> set this, it is a
1488 * global user-configured setting.
1491 gdk_set_double_click_time (guint msec)
1493 gdk_display_set_double_click_time (gdk_display_get_default (), msec);
1497 * gdk_display_set_double_click_distance:
1498 * @display: a #GdkDisplay
1499 * @distance: distance in pixels
1501 * Sets the double click distance (two clicks within this distance
1502 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1503 * See also gdk_display_set_double_click_time().
1504 * Applications should <emphasis>not</emphasis> set this, it is a global
1505 * user-configured setting.
1510 gdk_display_set_double_click_distance (GdkDisplay *display,
1513 display->double_click_distance = distance;
1516 G_DEFINE_BOXED_TYPE (GdkEvent, gdk_event,
1522 * @name: the name of the setting.
1523 * @value: location to store the value of the setting.
1525 * Obtains a desktop-wide setting, such as the double-click time,
1526 * for the default screen. See gdk_screen_get_setting().
1528 * Returns: %TRUE if the setting existed and a value was stored
1529 * in @value, %FALSE otherwise.
1532 gdk_setting_get (const gchar *name,
1535 return gdk_screen_get_setting (gdk_screen_get_default (), name, value);