summaryrefslogtreecommitdiff
path: root/gdk
diff options
context:
space:
mode:
authorEmmanuele Bassi <ebassi@gnome.org>2017-12-21 19:07:02 +0000
committerEmmanuele Bassi <ebassi@gnome.org>2017-12-21 19:07:02 +0000
commit90a4e33415ee3b008c2873519e94f61a059b9475 (patch)
treed498db7b9ae086daa44cc2060a32a1e20527c0de /gdk
parentf27dd8834bb658b5c4088f33a1b9fd2e78b703f6 (diff)
downloadgtk+-90a4e33415ee3b008c2873519e94f61a059b9475.tar.gz
Update annotations for GdkEvent API
The GdkEvent API is missing some gtk-doc stanzas, as well as some introspection annotations.
Diffstat (limited to 'gdk')
-rw-r--r--gdk/gdkevents.c24
1 files changed, 21 insertions, 3 deletions
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index fb773f5592..9bd6cfe2e5 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -601,9 +601,9 @@ copy_time_coord (const GdkTimeCoord *coord)
* Copies a #GdkEvent, copying or incrementing the reference count of the
* resources associated with it (e.g. #GdkWindow’s and strings).
*
- * Returns: a copy of @event. The returned #GdkEvent should be freed with
- * gdk_event_free().
- **/
+ * Returns: (transfer full): a copy of @event. The returned #GdkEvent should
+ * be freed with gdk_event_free().
+ */
GdkEvent*
gdk_event_copy (const GdkEvent *event)
{
@@ -1848,6 +1848,14 @@ gdk_event_set_display (GdkEvent *event,
event->any.display = display;
}
+/**
+ * gdk_event_get_display:
+ * @event: a #GdkEvent
+ *
+ * Retrieves the #GdkDisplay associated to the @event.
+ *
+ * Returns: (transfer none) (nullable): a #GdkDisplay
+ */
GdkDisplay *
gdk_event_get_display (const GdkEvent *event)
{
@@ -2495,6 +2503,16 @@ gdk_event_get_axes (GdkEvent *event,
return FALSE;
}
+/**
+ * gdk_event_get_history:
+ * @event: a #GdkEvent of type %GDK_MOTION_NOTIFY
+ *
+ * Retrieves the history of the @event motion, as a list of time and
+ * coordinates.
+ *
+ * Returns: (transfer container) (element-type GdkTimeCoord) (nullable): a list
+ * of time and coordinates
+ */
GList *
gdk_event_get_history (const GdkEvent *event)
{