From 3d04c0f4be797fdbcbda4a00e2dd6dd91b38eac1 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 20 Feb 2021 10:26:17 -0500 Subject: [PATCH] docs: Move GdkEvent docs inline This is not really worth a chapter of its own. --- docs/reference/gdk/events.md | 10 ---------- docs/reference/gdk/gdk4.toml.in | 1 - gdk/gdkevents.c | 8 ++++++-- 3 files changed, 6 insertions(+), 13 deletions(-) delete mode 100644 docs/reference/gdk/events.md diff --git a/docs/reference/gdk/events.md b/docs/reference/gdk/events.md deleted file mode 100644 index 9925c1dec7..0000000000 --- a/docs/reference/gdk/events.md +++ /dev/null @@ -1,10 +0,0 @@ -Title: Events - -## Handling events from the window system - -In GTK applications the events are handled automatically by toplevel -widgets and passed on to the event controllers of appropriate widgets, -so using [class@Gdk.Event] and its related API is rarely needed. - -[class@Gdk.Event] and its derived types are immutable data structures, -created by GTK itself to represent windowing system events. diff --git a/docs/reference/gdk/gdk4.toml.in b/docs/reference/gdk/gdk4.toml.in index bbb08ba0e9..887fac1160 100644 --- a/docs/reference/gdk/gdk4.toml.in +++ b/docs/reference/gdk/gdk4.toml.in @@ -34,7 +34,6 @@ base_url = "https://gitlab.gnome.org/GNOME/gtk/-/blob/master/" [extra] content_files = [ - "events.md", "keys.md", "cairo.md", "pango.md", diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c index 43692c4f95..c4548aa227 100644 --- a/gdk/gdkevents.c +++ b/gdk/gdkevents.c @@ -41,8 +41,12 @@ /** * GdkEvent: (ref-func gdk_event_ref) (unref-func gdk_event_unref) * - * The GdkEvent struct contains only private fields and - * should not be accessed directly. + * `GdkEvent` and its derived types are immutable data structures, + * created by GTK itself to represent windowing system events. + * + * In GTK applications the events are handled automatically by toplevel + * widgets and passed on to the event controllers of appropriate widgets, + * so using `GdkEvent` and its related API is rarely needed. */ /**