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_2BUTTON_PRESS:
559 case GDK_3BUTTON_PRESS:
560 case GDK_BUTTON_RELEASE:
561 if (event->button.axes)
562 new_event->button.axes = g_memdup (event->button.axes,
563 sizeof (gdouble) * gdk_device_get_n_axes (event->button.device));
566 case GDK_MOTION_NOTIFY:
567 if (event->motion.axes)
568 new_event->motion.axes = g_memdup (event->motion.axes,
569 sizeof (gdouble) * gdk_device_get_n_axes (event->motion.device));
572 case GDK_OWNER_CHANGE:
573 new_event->owner_change.owner = event->owner_change.owner;
574 if (new_event->owner_change.owner)
575 g_object_ref (new_event->owner_change.owner);
578 case GDK_SELECTION_CLEAR:
579 case GDK_SELECTION_NOTIFY:
580 case GDK_SELECTION_REQUEST:
581 new_event->selection.requestor = event->selection.requestor;
582 if (new_event->selection.requestor)
583 g_object_ref (new_event->selection.requestor);
590 if (gdk_event_is_allocated (event))
591 _gdk_display_event_data_copy (gdk_display_get_default (), event, new_event);
598 * @event: a #GdkEvent.
600 * Frees a #GdkEvent, freeing or decrementing any resources associated with it.
601 * Note that this function should only be called with events returned from
602 * functions such as gdk_event_peek(), gdk_event_get(), gdk_event_copy()
603 * and gdk_event_new().
606 gdk_event_free (GdkEvent *event)
610 g_return_if_fail (event != NULL);
612 if (event->any.window)
613 g_object_unref (event->any.window);
615 switch (event->any.type)
618 case GDK_KEY_RELEASE:
619 g_free (event->key.string);
622 case GDK_ENTER_NOTIFY:
623 case GDK_LEAVE_NOTIFY:
624 if (event->crossing.subwindow != NULL)
625 g_object_unref (event->crossing.subwindow);
630 case GDK_DRAG_MOTION:
631 case GDK_DRAG_STATUS:
633 case GDK_DROP_FINISHED:
634 if (event->dnd.context != NULL)
635 g_object_unref (event->dnd.context);
638 case GDK_BUTTON_PRESS:
639 case GDK_2BUTTON_PRESS:
640 case GDK_3BUTTON_PRESS:
641 case GDK_BUTTON_RELEASE:
642 g_free (event->button.axes);
647 if (event->expose.region)
648 cairo_region_destroy (event->expose.region);
651 case GDK_MOTION_NOTIFY:
652 g_free (event->motion.axes);
656 g_free (event->setting.name);
659 case GDK_OWNER_CHANGE:
660 if (event->owner_change.owner)
661 g_object_unref (event->owner_change.owner);
664 case GDK_SELECTION_CLEAR:
665 case GDK_SELECTION_NOTIFY:
666 case GDK_SELECTION_REQUEST:
667 if (event->selection.requestor)
668 g_object_unref (event->selection.requestor);
675 display = gdk_display_get_default ();
677 _gdk_display_event_data_free (display, event);
679 g_hash_table_remove (event_hash, event);
680 g_slice_free (GdkEventPrivate, (GdkEventPrivate*) event);
684 * gdk_event_get_time:
685 * @event: a #GdkEvent
687 * Returns the time stamp from @event, if there is one; otherwise
688 * returns #GDK_CURRENT_TIME. If @event is %NULL, returns #GDK_CURRENT_TIME.
690 * Return value: time stamp field from @event
693 gdk_event_get_time (const GdkEvent *event)
698 case GDK_MOTION_NOTIFY:
699 return event->motion.time;
700 case GDK_BUTTON_PRESS:
701 case GDK_2BUTTON_PRESS:
702 case GDK_3BUTTON_PRESS:
703 case GDK_BUTTON_RELEASE:
704 return event->button.time;
706 return event->scroll.time;
708 case GDK_KEY_RELEASE:
709 return event->key.time;
710 case GDK_ENTER_NOTIFY:
711 case GDK_LEAVE_NOTIFY:
712 return event->crossing.time;
713 case GDK_PROPERTY_NOTIFY:
714 return event->property.time;
715 case GDK_SELECTION_CLEAR:
716 case GDK_SELECTION_REQUEST:
717 case GDK_SELECTION_NOTIFY:
718 return event->selection.time;
719 case GDK_PROXIMITY_IN:
720 case GDK_PROXIMITY_OUT:
721 return event->proximity.time;
724 case GDK_DRAG_MOTION:
725 case GDK_DRAG_STATUS:
727 case GDK_DROP_FINISHED:
728 return event->dnd.time;
729 case GDK_CLIENT_EVENT:
730 case GDK_VISIBILITY_NOTIFY:
732 case GDK_FOCUS_CHANGE:
740 case GDK_WINDOW_STATE:
742 case GDK_OWNER_CHANGE:
743 case GDK_GRAB_BROKEN:
745 /* return current time */
749 return GDK_CURRENT_TIME;
753 * gdk_event_get_state:
754 * @event: a #GdkEvent or NULL
755 * @state: (out): return location for state
757 * If the event contains a "state" field, puts that field in @state. Otherwise
758 * stores an empty state (0). Returns %TRUE if there was a state field
759 * in the event. @event may be %NULL, in which case it's treated
760 * as if the event had no state field.
762 * Return value: %TRUE if there was a state field in the event
765 gdk_event_get_state (const GdkEvent *event,
766 GdkModifierType *state)
768 g_return_val_if_fail (state != NULL, FALSE);
773 case GDK_MOTION_NOTIFY:
774 *state = event->motion.state;
776 case GDK_BUTTON_PRESS:
777 case GDK_2BUTTON_PRESS:
778 case GDK_3BUTTON_PRESS:
779 case GDK_BUTTON_RELEASE:
780 *state = event->button.state;
783 *state = event->scroll.state;
786 case GDK_KEY_RELEASE:
787 *state = event->key.state;
789 case GDK_ENTER_NOTIFY:
790 case GDK_LEAVE_NOTIFY:
791 *state = event->crossing.state;
793 case GDK_PROPERTY_NOTIFY:
794 case GDK_VISIBILITY_NOTIFY:
795 case GDK_CLIENT_EVENT:
797 case GDK_FOCUS_CHANGE:
798 case GDK_SELECTION_CLEAR:
799 case GDK_SELECTION_REQUEST:
800 case GDK_SELECTION_NOTIFY:
801 case GDK_PROXIMITY_IN:
802 case GDK_PROXIMITY_OUT:
806 case GDK_DRAG_MOTION:
807 case GDK_DRAG_STATUS:
809 case GDK_DROP_FINISHED:
816 case GDK_WINDOW_STATE:
818 case GDK_OWNER_CHANGE:
819 case GDK_GRAB_BROKEN:
830 * gdk_event_get_coords:
831 * @event: a #GdkEvent
832 * @x_win: (out): location to put event window x coordinate
833 * @y_win: (out): location to put event window y coordinate
835 * Extract the event window relative x/y coordinates from an event.
837 * Return value: %TRUE if the event delivered event window coordinates
840 gdk_event_get_coords (const GdkEvent *event,
844 gdouble x = 0, y = 0;
845 gboolean fetched = TRUE;
847 g_return_val_if_fail (event != NULL, FALSE);
852 x = event->configure.x;
853 y = event->configure.y;
855 case GDK_ENTER_NOTIFY:
856 case GDK_LEAVE_NOTIFY:
857 x = event->crossing.x;
858 y = event->crossing.y;
864 case GDK_BUTTON_PRESS:
865 case GDK_2BUTTON_PRESS:
866 case GDK_3BUTTON_PRESS:
867 case GDK_BUTTON_RELEASE:
871 case GDK_MOTION_NOTIFY:
889 * gdk_event_get_root_coords:
890 * @event: a #GdkEvent
891 * @x_root: (out): location to put root window x coordinate
892 * @y_root: (out): location to put root window y coordinate
894 * Extract the root window relative x/y coordinates from an event.
896 * Return value: %TRUE if the event delivered root window coordinates
899 gdk_event_get_root_coords (const GdkEvent *event,
903 gdouble x = 0, y = 0;
904 gboolean fetched = TRUE;
906 g_return_val_if_fail (event != NULL, FALSE);
910 case GDK_MOTION_NOTIFY:
911 x = event->motion.x_root;
912 y = event->motion.y_root;
915 x = event->scroll.x_root;
916 y = event->scroll.y_root;
918 case GDK_BUTTON_PRESS:
919 case GDK_2BUTTON_PRESS:
920 case GDK_3BUTTON_PRESS:
921 case GDK_BUTTON_RELEASE:
922 x = event->button.x_root;
923 y = event->button.y_root;
925 case GDK_ENTER_NOTIFY:
926 case GDK_LEAVE_NOTIFY:
927 x = event->crossing.x_root;
928 y = event->crossing.y_root;
932 case GDK_DRAG_MOTION:
933 case GDK_DRAG_STATUS:
935 case GDK_DROP_FINISHED:
936 x = event->dnd.x_root;
937 y = event->dnd.y_root;
953 * gdk_event_get_button:
954 * @event: a #GdkEvent
955 * @button: (out): location to store mouse button number
957 * Extract the button number from an event.
959 * Return value: %TRUE if the event delivered a button number
964 gdk_event_get_button (const GdkEvent *event,
967 gboolean fetched = TRUE;
970 g_return_val_if_fail (event != NULL, FALSE);
974 case GDK_BUTTON_PRESS:
975 case GDK_2BUTTON_PRESS:
976 case GDK_3BUTTON_PRESS:
977 case GDK_BUTTON_RELEASE:
978 number = event->button.button;
992 * gdk_event_get_click_count:
993 * @event: a #GdkEvent
994 * @click_count: (out): location to store click count
996 * Extracts the click count from an event.
998 * Return value: %TRUE if the event delivered a click count
1003 gdk_event_get_click_count (const GdkEvent *event,
1006 gboolean fetched = TRUE;
1009 g_return_val_if_fail (event != NULL, FALSE);
1011 switch (event->type)
1013 case GDK_BUTTON_PRESS:
1014 case GDK_BUTTON_RELEASE:
1017 case GDK_2BUTTON_PRESS:
1020 case GDK_3BUTTON_PRESS:
1029 *click_count = number;
1035 * gdk_event_get_keyval:
1036 * @event: a #GdkEvent
1037 * @keyval: (out): location to store the keyval
1039 * Extracts the keyval from an event.
1041 * Return value: %TRUE if the event delivered a key symbol
1046 gdk_event_get_keyval (const GdkEvent *event,
1049 gboolean fetched = TRUE;
1052 switch (event->type)
1055 case GDK_KEY_RELEASE:
1056 number = event->key.keyval;
1070 * gdk_event_get_keycode:
1071 * @event: a #GdkEvent
1072 * @keycode: (out): location to store the keycode
1074 * Extracts the hardware keycode from an event.
1076 * Return value: %TRUE if the event delivered a hardware keycode
1081 gdk_event_get_keycode (const GdkEvent *event,
1084 gboolean fetched = TRUE;
1087 switch (event->type)
1090 case GDK_KEY_RELEASE:
1091 number = event->key.hardware_keycode;
1105 * gdk_event_get_scroll_direction:
1106 * @event: a #GdkEvent
1107 * @direction: (out): location to store the scroll direction
1109 * Extracts the scroll direction from an event.
1111 * Return value: %TRUE if the event delivered a scroll direction
1116 gdk_event_get_scroll_direction (const GdkEvent *event,
1117 GdkScrollDirection *direction)
1119 gboolean fetched = TRUE;
1120 GdkScrollDirection dir = 0;
1122 switch (event->type)
1125 dir = event->scroll.direction;
1139 * gdk_event_get_axis:
1140 * @event: a #GdkEvent
1141 * @axis_use: the axis use to look for
1142 * @value: (out): location to store the value found
1144 * Extract the axis value for a particular axis use from
1145 * an event structure.
1147 * Return value: %TRUE if the specified axis was found, otherwise %FALSE
1150 gdk_event_get_axis (const GdkEvent *event,
1151 GdkAxisUse axis_use,
1157 g_return_val_if_fail (event != NULL, FALSE);
1159 if (axis_use == GDK_AXIS_X || axis_use == GDK_AXIS_Y)
1163 switch (event->type)
1165 case GDK_MOTION_NOTIFY:
1166 x = event->motion.x;
1167 y = event->motion.y;
1170 x = event->scroll.x;
1171 y = event->scroll.y;
1173 case GDK_BUTTON_PRESS:
1174 case GDK_BUTTON_RELEASE:
1175 x = event->button.x;
1176 y = event->button.y;
1178 case GDK_ENTER_NOTIFY:
1179 case GDK_LEAVE_NOTIFY:
1180 x = event->crossing.x;
1181 y = event->crossing.y;
1188 if (axis_use == GDK_AXIS_X && value)
1190 if (axis_use == GDK_AXIS_Y && value)
1195 else if (event->type == GDK_BUTTON_PRESS ||
1196 event->type == GDK_BUTTON_RELEASE)
1198 device = event->button.device;
1199 axes = event->button.axes;
1201 else if (event->type == GDK_MOTION_NOTIFY)
1203 device = event->motion.device;
1204 axes = event->motion.axes;
1209 return gdk_device_get_axis (device, axes, axis_use, value);
1213 * gdk_event_set_device:
1214 * @event: a #GdkEvent
1215 * @device: a #GdkDevice
1217 * Sets the device for @event to @device. The event must
1218 * have been allocated by GTK+, for instance, by
1224 gdk_event_set_device (GdkEvent *event,
1227 GdkEventPrivate *private;
1229 g_return_if_fail (gdk_event_is_allocated (event));
1231 private = (GdkEventPrivate *) event;
1233 private->device = device;
1235 switch (event->type)
1237 case GDK_MOTION_NOTIFY:
1238 event->motion.device = device;
1240 case GDK_BUTTON_PRESS:
1241 case GDK_2BUTTON_PRESS:
1242 case GDK_3BUTTON_PRESS:
1243 case GDK_BUTTON_RELEASE:
1244 event->button.device = device;
1247 event->scroll.device = device;
1249 case GDK_PROXIMITY_IN:
1250 case GDK_PROXIMITY_OUT:
1251 event->proximity.device = device;
1259 * gdk_event_get_device:
1260 * @event: a #GdkEvent.
1262 * If the event contains a "device" field, this function will return
1263 * it, else it will return %NULL.
1265 * Returns: (transfer none): a #GdkDevice, or %NULL.
1270 gdk_event_get_device (const GdkEvent *event)
1272 g_return_val_if_fail (event != NULL, NULL);
1274 if (gdk_event_is_allocated (event))
1276 GdkEventPrivate *private = (GdkEventPrivate *) event;
1278 if (private->device)
1279 return private->device;
1282 switch (event->type)
1284 case GDK_MOTION_NOTIFY:
1285 return event->motion.device;
1286 case GDK_BUTTON_PRESS:
1287 case GDK_2BUTTON_PRESS:
1288 case GDK_3BUTTON_PRESS:
1289 case GDK_BUTTON_RELEASE:
1290 return event->button.device;
1292 return event->scroll.device;
1293 case GDK_PROXIMITY_IN:
1294 case GDK_PROXIMITY_OUT:
1295 return event->proximity.device;
1300 /* Fallback if event has no device set */
1301 switch (event->type)
1303 case GDK_MOTION_NOTIFY:
1304 case GDK_BUTTON_PRESS:
1305 case GDK_2BUTTON_PRESS:
1306 case GDK_3BUTTON_PRESS:
1307 case GDK_BUTTON_RELEASE:
1308 case GDK_ENTER_NOTIFY:
1309 case GDK_LEAVE_NOTIFY:
1310 case GDK_FOCUS_CHANGE:
1311 case GDK_PROXIMITY_IN:
1312 case GDK_PROXIMITY_OUT:
1313 case GDK_DRAG_ENTER:
1314 case GDK_DRAG_LEAVE:
1315 case GDK_DRAG_MOTION:
1316 case GDK_DRAG_STATUS:
1317 case GDK_DROP_START:
1318 case GDK_DROP_FINISHED:
1320 case GDK_GRAB_BROKEN:
1322 case GDK_KEY_RELEASE:
1324 GdkDisplay *display;
1325 GdkDeviceManager *device_manager;
1326 GdkDevice *client_pointer;
1328 g_warning ("Event with type %d not holding a GdkDevice. "
1329 "It is most likely synthesized outside Gdk/GTK+\n",
1332 display = gdk_window_get_display (event->any.window);
1333 device_manager = gdk_display_get_device_manager (display);
1334 client_pointer = gdk_device_manager_get_client_pointer (device_manager);
1336 if (event->type == GDK_KEY_PRESS ||
1337 event->type == GDK_KEY_RELEASE)
1338 return gdk_device_get_associated_device (client_pointer);
1340 return client_pointer;
1349 * gdk_event_set_source_device:
1350 * @event: a #GdkEvent
1351 * @device: a #GdkDevice
1353 * Sets the slave device for @event to @device.
1355 * The event must have been allocated by GTK+,
1356 * for instance by gdk_event_copy().
1361 gdk_event_set_source_device (GdkEvent *event,
1364 GdkEventPrivate *private;
1366 g_return_if_fail (gdk_event_is_allocated (event));
1367 g_return_if_fail (GDK_IS_DEVICE (device));
1369 private = (GdkEventPrivate *) event;
1371 private->source_device = device;
1375 * gdk_event_get_source_device:
1376 * @event: a #GdkEvent
1378 * This function returns the hardware (slave) #GdkDevice that has
1379 * triggered the event, falling back to the virtual (master) device
1380 * (as in gdk_event_get_device()) if the event wasn't caused by
1381 * interaction with a hardware device. This may happen for example
1382 * in synthesized crossing events after a #GdkWindow updates its
1383 * geometry or a grab is acquired/released.
1385 * If the event does not contain a device field, this function will
1388 * Returns: (transfer none): a #GdkDevice, or %NULL.
1393 gdk_event_get_source_device (const GdkEvent *event)
1395 GdkEventPrivate *private;
1397 g_return_val_if_fail (event != NULL, NULL);
1399 if (!gdk_event_is_allocated (event))
1402 private = (GdkEventPrivate *) event;
1404 if (private->source_device)
1405 return private->source_device;
1407 /* Fallback to event device */
1408 return gdk_event_get_device (event);
1412 * gdk_event_request_motions:
1413 * @event: a valid #GdkEvent
1415 * Request more motion notifies if @event is a motion notify hint event.
1417 * This function should be used instead of gdk_window_get_pointer() to
1418 * request further motion notifies, because it also works for extension
1419 * events where motion notifies are provided for devices other than the
1420 * core pointer. Coordinate extraction, processing and requesting more
1421 * motion events from a %GDK_MOTION_NOTIFY event usually works like this:
1425 * /* motion_event handler */
1426 * x = motion_event->x;
1427 * y = motion_event->y;
1428 * /* handle (x,y) motion */
1429 * gdk_event_request_motions (motion_event); /* handles is_hint events */
1436 gdk_event_request_motions (const GdkEventMotion *event)
1438 GdkDisplay *display;
1440 g_return_if_fail (event != NULL);
1442 if (event->type == GDK_MOTION_NOTIFY && event->is_hint)
1444 gdk_device_get_state (event->device, event->window, NULL, NULL);
1446 display = gdk_window_get_display (event->window);
1447 _gdk_display_enable_motion_hints (display, event->device);
1452 * gdk_event_triggers_context_menu:
1453 * @event: a #GdkEvent, currently only button events are meaningful values
1455 * This function returns whether a #GdkEventButton should trigger a
1456 * context menu, according to platform conventions. The right mouse
1457 * button always triggers context menus. Additionally, if
1458 * gdk_keymap_get_modifier_mask() returns a non-0 mask for
1459 * %GDK_MODIFIER_INTENT_CONTEXT_MENU, then the left mouse button will
1460 * also trigger a context menu if this modifier is pressed.
1462 * This function should always be used instead of simply checking for
1463 * event->button == 3.
1465 * Returns: %TRUE if the event should trigger a context menu.
1470 gdk_event_triggers_context_menu (const GdkEvent *event)
1472 g_return_val_if_fail (event != NULL, FALSE);
1474 if (event->type == GDK_BUTTON_PRESS)
1476 const GdkEventButton *bevent = (const GdkEventButton *) event;
1477 GdkDisplay *display;
1478 GdkModifierType modifier;
1480 g_return_val_if_fail (GDK_IS_WINDOW (bevent->window), FALSE);
1482 if (bevent->button == 3 &&
1483 ! (bevent->state & (GDK_BUTTON1_MASK | GDK_BUTTON2_MASK)))
1486 display = gdk_window_get_display (bevent->window);
1488 modifier = gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
1489 GDK_MODIFIER_INTENT_CONTEXT_MENU);
1491 if (modifier != 0 &&
1492 bevent->button == 1 &&
1493 ! (bevent->state & (GDK_BUTTON2_MASK | GDK_BUTTON3_MASK)) &&
1494 (bevent->state & modifier))
1502 gdk_events_get_axis_distances (GdkEvent *event1,
1504 gdouble *x_distance,
1505 gdouble *y_distance,
1508 gdouble x1, x2, y1, y2;
1511 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1512 !gdk_event_get_coords (event2, &x2, &y2))
1525 *distance = sqrt ((xd * xd) + (yd * yd));
1531 * gdk_events_get_distance:
1532 * @event1: first #GdkEvent
1533 * @event2: second #GdkEvent
1534 * @distance: (out): return location for the distance
1536 * If both events have X/Y information, the distance between both coordinates
1537 * (as in a straight line going from @event1 to @event2) will be returned.
1539 * Returns: %TRUE if the distance could be calculated.
1544 gdk_events_get_distance (GdkEvent *event1,
1548 return gdk_events_get_axis_distances (event1, event2,
1554 * gdk_events_get_angle:
1555 * @event1: first #GdkEvent
1556 * @event2: second #GdkEvent
1557 * @angle: (out): return location for the relative angle between both events
1559 * If both events contain X/Y information, this function will return %TRUE
1560 * and return in @angle the relative angle from @event1 to @event2. The rotation
1561 * direction for positive angles is from the positive X axis towards the positive
1564 * Returns: %TRUE if the angle could be calculated.
1569 gdk_events_get_angle (GdkEvent *event1,
1573 gdouble x_distance, y_distance, distance;
1575 if (!gdk_events_get_axis_distances (event1, event2,
1576 &x_distance, &y_distance,
1582 *angle = atan2 (x_distance, y_distance);
1585 *angle = (2 * G_PI) - *angle;
1590 /* And constraint it to 0°-360° */
1591 *angle = fmod (*angle, 2 * G_PI);
1598 * gdk_events_get_center:
1599 * @event1: first #GdkEvent
1600 * @event2: second #GdkEvent
1601 * @x: (out): return location for the X coordinate of the center
1602 * @y: (out): return location for the Y coordinate of the center
1604 * If both events contain X/Y information, the center of both coordinates
1605 * will be returned in @x and @y.
1607 * Returns: %TRUE if the center could be calculated.
1612 gdk_events_get_center (GdkEvent *event1,
1617 gdouble x1, x2, y1, y2;
1619 if (!gdk_event_get_coords (event1, &x1, &y1) ||
1620 !gdk_event_get_coords (event2, &x2, &y2))
1633 * gdk_event_set_screen:
1634 * @event: a #GdkEvent
1635 * @screen: a #GdkScreen
1637 * Sets the screen for @event to @screen. The event must
1638 * have been allocated by GTK+, for instance, by
1644 gdk_event_set_screen (GdkEvent *event,
1647 GdkEventPrivate *private;
1649 g_return_if_fail (gdk_event_is_allocated (event));
1651 private = (GdkEventPrivate *)event;
1653 private->screen = screen;
1657 * gdk_event_get_screen:
1658 * @event: a #GdkEvent
1660 * Returns the screen for the event. The screen is
1661 * typically the screen for <literal>event->any.window</literal>, but
1662 * for events such as mouse events, it is the screen
1663 * where the pointer was when the event occurs -
1664 * that is, the screen which has the root window
1665 * to which <literal>event->motion.x_root</literal> and
1666 * <literal>event->motion.y_root</literal> are relative.
1668 * Return value: (transfer none): the screen for the event
1673 gdk_event_get_screen (const GdkEvent *event)
1675 if (gdk_event_is_allocated (event))
1677 GdkEventPrivate *private = (GdkEventPrivate *)event;
1679 if (private->screen)
1680 return private->screen;
1683 if (event->any.window)
1684 return gdk_window_get_screen (event->any.window);
1690 * gdk_set_show_events:
1691 * @show_events: %TRUE to output event debugging information.
1693 * Sets whether a trace of received events is output.
1694 * Note that GTK+ must be compiled with debugging (that is,
1695 * configured using the <option>--enable-debug</option> option)
1696 * to use this option.
1699 gdk_set_show_events (gboolean show_events)
1702 _gdk_debug_flags |= GDK_DEBUG_EVENTS;
1704 _gdk_debug_flags &= ~GDK_DEBUG_EVENTS;
1708 * gdk_get_show_events:
1710 * Gets whether event debugging output is enabled.
1712 * Return value: %TRUE if event debugging output is enabled.
1715 gdk_get_show_events (void)
1717 return (_gdk_debug_flags & GDK_DEBUG_EVENTS) != 0;
1720 /* What do we do with G_IO_NVAL?
1722 #define READ_CONDITION (G_IO_IN | G_IO_HUP | G_IO_ERR)
1723 #define WRITE_CONDITION (G_IO_OUT | G_IO_ERR)
1724 #define EXCEPTION_CONDITION (G_IO_PRI)
1727 gdk_synthesize_click (GdkDisplay *display,
1731 GdkEvent *event_copy;
1733 event_copy = gdk_event_copy (event);
1734 event_copy->type = (nclicks == 2) ? GDK_2BUTTON_PRESS : GDK_3BUTTON_PRESS;
1736 _gdk_event_queue_append (display, event_copy);
1740 _gdk_event_button_generate (GdkDisplay *display,
1743 GdkMultipleClickInfo *info;
1745 g_return_if_fail (event->type == GDK_BUTTON_PRESS);
1747 info = g_hash_table_lookup (display->multiple_click_info, event->button.device);
1749 if (G_UNLIKELY (!info))
1751 info = g_new0 (GdkMultipleClickInfo, 1);
1752 info->button_number[0] = info->button_number[1] = -1;
1754 g_hash_table_insert (display->multiple_click_info,
1755 event->button.device, info);
1758 if ((event->button.time < (info->button_click_time[1] + 2 * display->double_click_time)) &&
1759 (event->button.window == info->button_window[1]) &&
1760 (event->button.button == info->button_number[1]) &&
1761 (ABS (event->button.x - info->button_x[1]) <= display->double_click_distance) &&
1762 (ABS (event->button.y - info->button_y[1]) <= display->double_click_distance))
1764 gdk_synthesize_click (display, event, 3);
1766 info->button_click_time[1] = 0;
1767 info->button_click_time[0] = 0;
1768 info->button_window[1] = NULL;
1769 info->button_window[0] = NULL;
1770 info->button_number[1] = -1;
1771 info->button_number[0] = -1;
1772 info->button_x[0] = info->button_x[1] = 0;
1773 info->button_y[0] = info->button_y[1] = 0;
1775 else if ((event->button.time < (info->button_click_time[0] + display->double_click_time)) &&
1776 (event->button.window == info->button_window[0]) &&
1777 (event->button.button == info->button_number[0]) &&
1778 (ABS (event->button.x - info->button_x[0]) <= display->double_click_distance) &&
1779 (ABS (event->button.y - info->button_y[0]) <= display->double_click_distance))
1781 gdk_synthesize_click (display, event, 2);
1783 info->button_click_time[1] = info->button_click_time[0];
1784 info->button_click_time[0] = event->button.time;
1785 info->button_window[1] = info->button_window[0];
1786 info->button_window[0] = event->button.window;
1787 info->button_number[1] = info->button_number[0];
1788 info->button_number[0] = event->button.button;
1789 info->button_x[1] = info->button_x[0];
1790 info->button_x[0] = event->button.x;
1791 info->button_y[1] = info->button_y[0];
1792 info->button_y[0] = event->button.y;
1796 info->button_click_time[1] = 0;
1797 info->button_click_time[0] = event->button.time;
1798 info->button_window[1] = NULL;
1799 info->button_window[0] = event->button.window;
1800 info->button_number[1] = -1;
1801 info->button_number[0] = event->button.button;
1802 info->button_x[1] = 0;
1803 info->button_x[0] = event->button.x;
1804 info->button_y[1] = 0;
1805 info->button_y[0] = event->button.y;
1810 gdk_synthesize_window_state (GdkWindow *window,
1811 GdkWindowState unset_flags,
1812 GdkWindowState set_flags)
1814 GdkEvent temp_event;
1817 g_return_if_fail (window != NULL);
1819 temp_event.window_state.window = window;
1820 temp_event.window_state.type = GDK_WINDOW_STATE;
1821 temp_event.window_state.send_event = FALSE;
1823 old = temp_event.window_state.window->state;
1825 temp_event.window_state.new_window_state = old;
1826 temp_event.window_state.new_window_state |= set_flags;
1827 temp_event.window_state.new_window_state &= ~unset_flags;
1828 temp_event.window_state.changed_mask = temp_event.window_state.new_window_state ^ old;
1830 if (temp_event.window_state.new_window_state == old)
1831 return; /* No actual work to do, nothing changed. */
1833 /* Actually update the field in GdkWindow, this is sort of an odd
1834 * place to do it, but seems like the safest since it ensures we expose no
1835 * inconsistent state to the user.
1838 window->state = temp_event.window_state.new_window_state;
1840 if (temp_event.window_state.changed_mask & GDK_WINDOW_STATE_WITHDRAWN)
1841 _gdk_window_update_viewable (window);
1843 /* We only really send the event to toplevels, since
1844 * all the window states don't apply to non-toplevels.
1845 * Non-toplevels do use the GDK_WINDOW_STATE_WITHDRAWN flag
1846 * internally so we needed to update window->state.
1848 switch (window->window_type)
1850 case GDK_WINDOW_TOPLEVEL:
1851 case GDK_WINDOW_TEMP: /* ? */
1852 gdk_display_put_event (gdk_window_get_display (window), &temp_event);
1855 case GDK_WINDOW_FOREIGN:
1856 case GDK_WINDOW_ROOT:
1857 case GDK_WINDOW_CHILD:
1863 * gdk_display_set_double_click_time:
1864 * @display: a #GdkDisplay
1865 * @msec: double click time in milliseconds (thousandths of a second)
1867 * Sets the double click time (two clicks within this time interval
1868 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1869 * Applications should <emphasis>not</emphasis> set this, it is a global
1870 * user-configured setting.
1875 gdk_display_set_double_click_time (GdkDisplay *display,
1878 display->double_click_time = msec;
1882 * gdk_set_double_click_time:
1883 * @msec: double click time in milliseconds (thousandths of a second)
1885 * Set the double click time for the default display. See
1886 * gdk_display_set_double_click_time().
1887 * See also gdk_display_set_double_click_distance().
1888 * Applications should <emphasis>not</emphasis> set this, it is a
1889 * global user-configured setting.
1892 gdk_set_double_click_time (guint msec)
1894 gdk_display_set_double_click_time (gdk_display_get_default (), msec);
1898 * gdk_display_set_double_click_distance:
1899 * @display: a #GdkDisplay
1900 * @distance: distance in pixels
1902 * Sets the double click distance (two clicks within this distance
1903 * count as a double click and result in a #GDK_2BUTTON_PRESS event).
1904 * See also gdk_display_set_double_click_time().
1905 * Applications should <emphasis>not</emphasis> set this, it is a global
1906 * user-configured setting.
1911 gdk_display_set_double_click_distance (GdkDisplay *display,
1914 display->double_click_distance = distance;
1917 G_DEFINE_BOXED_TYPE (GdkEvent, gdk_event,
1923 * @name: the name of the setting.
1924 * @value: location to store the value of the setting.
1926 * Obtains a desktop-wide setting, such as the double-click time,
1927 * for the default screen. See gdk_screen_get_setting().
1929 * Returns: %TRUE if the setting existed and a value was stored
1930 * in @value, %FALSE otherwise.
1933 gdk_setting_get (const gchar *name,
1936 return gdk_screen_get_setting (gdk_screen_get_default (), name, value);