summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2019-03-08 10:19:12 -0500
committerMatthias Clasen <mclasen@redhat.com>2019-03-16 21:24:45 -0400
commit4f06b669c5ab281984e0bc20aca1ecdee7f34341 (patch)
tree4b8e95c62219a9d597e76c84cc0ee567f857f38d
parentf3ed3e99c396a82b792dc30f7329ff806d559f3b (diff)
downloadgtk+-4f06b669c5ab281984e0bc20aca1ecdee7f34341.tar.gz
key controller: Improve the docs
Mention the limitations of the key forwarding api.
-rw-r--r--gtk/gtkeventcontrollerkey.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/gtk/gtkeventcontrollerkey.c b/gtk/gtkeventcontrollerkey.c
index b57e9df19e..2909095979 100644
--- a/gtk/gtkeventcontrollerkey.c
+++ b/gtk/gtkeventcontrollerkey.c
@@ -470,6 +470,13 @@ gtk_event_controller_key_get_im_context (GtkEventControllerKey *controller)
*
* Forwards the current event of this @controller to a @widget.
*
+ * This function can only be used in handlers for the
+ * #GtkEventControllerKey::key-pressed,
+ * #GtkEventControllerKey::key-released
+ * or
+ * #GtkEventControllerKey::modifiers
+ * signals.
+ *
* Returns: whether the @widget handled the event
**/
gboolean