brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ClutterEvent: Mention _get_source_device() in docs

Browse Source 
It's too easy getting bitten by the ->device red herring, thinking
that it's the original input device the event originated from.

https://bugzilla.gnome.org/show_bug.cgi?id=709620
This commit is contained in:
Bastien Nocera 2013-10-08 11:40:23 +02:00
parent d7814cf63e
commit 676a7cdc94
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
clutter/clutter-event.c
View File

@ -1079,6 +1079,8 @@ clutter_event_set_device (ClutterEvent *event,
* @event: a #ClutterEvent * @event: a #ClutterEvent
* *
* Retrieves the #ClutterInputDevice for the event. * Retrieves the #ClutterInputDevice for the event.
* If you want the physical device the event originated from, use
* clutter_event_get_source_device().
* *
* The #ClutterInputDevice structure is completely opaque and should * The #ClutterInputDevice structure is completely opaque and should
* be cast to the platform-specific implementation. * be cast to the platform-specific implementation.

18
clutter/clutter-event.h
View File

@ -146,7 +146,8 @@ struct _ClutterAnyEvent
* @keyval: raw key value * @keyval: raw key value
* @hardware_keycode: raw hardware key value * @hardware_keycode: raw hardware key value
* @unicode_value: Unicode representation * @unicode_value: Unicode representation
* @device: reserved for future use * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Key event * Key event
* *
@ -181,7 +182,8 @@ struct _ClutterKeyEvent
* @click_count: number of button presses within the default time * @click_count: number of button presses within the default time
* and radius * and radius
* @axes: reserved for future use * @axes: reserved for future use
* @device: reserved for future use * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Button event. * Button event.
* *
@ -218,7 +220,8 @@ struct _ClutterButtonEvent
* @x: event X coordinate * @x: event X coordinate
* @y: event Y coordinate * @y: event Y coordinate
* @related: actor related to the crossing * @related: actor related to the crossing
* @device: reserved for future use * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Event for the movement of the pointer across different actors * Event for the movement of the pointer across different actors
* *
@ -249,7 +252,8 @@ struct _ClutterCrossingEvent
* @y: event Y coordinate * @y: event Y coordinate
* @modifier_state: button modifiers * @modifier_state: button modifiers
* @axes: reserved for future use * @axes: reserved for future use
* @device: reserved for future use * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Event for the pointer motion * Event for the pointer motion
* *
@ -282,7 +286,8 @@ struct _ClutterMotionEvent
* @direction: direction of the scrolling * @direction: direction of the scrolling
* @modifier_state: button modifiers * @modifier_state: button modifiers
* @axes: reserved for future use * @axes: reserved for future use
* @device: reserved for future use * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Scroll wheel (or similar device) event * Scroll wheel (or similar device) event
* *
@ -344,7 +349,8 @@ struct _ClutterStageStateEvent
* of modifier keys (e.g. Control, Shift, and Alt) and the pointer * of modifier keys (e.g. Control, Shift, and Alt) and the pointer
* buttons. See #ClutterModifierType * buttons. See #ClutterModifierType
* @axes: reserved * @axes: reserved
* @device: the device that originated the event * @device: the device that originated the event. If you want the physical
* device the event originated from, use clutter_event_get_source_device()
* *
* Used for touch events. * Used for touch events.
* *