diff options
author | Matthias Clasen <mclasen@redhat.com> | 2017-12-26 10:22:21 -0500 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2017-12-26 13:00:27 -0500 |
commit | 97dcf2461e64f78c4d4c875ae8f71d549fc421d9 (patch) | |
tree | 46fa6625554cc28ddd77a4a5936e0a5a83bc0e2d | |
parent | d3920d17fa6e564dde318c173afe99e14dd98234 (diff) | |
download | gtk+-97dcf2461e64f78c4d4c875ae8f71d549fc421d9.tar.gz |
gdk: Remove the event structs from the documentation
No longer public api.
-rw-r--r-- | docs/reference/gdk/gdk4-docs.xml | 1 | ||||
-rw-r--r-- | docs/reference/gdk/gdk4-sections.txt | 50 | ||||
-rw-r--r-- | gdk/gdkevents.c | 5 | ||||
-rw-r--r-- | gdk/gdkevents.h | 23 |
4 files changed, 14 insertions, 65 deletions
diff --git a/docs/reference/gdk/gdk4-docs.xml b/docs/reference/gdk/gdk4-docs.xml index 0241980248..1eb7606277 100644 --- a/docs/reference/gdk/gdk4-docs.xml +++ b/docs/reference/gdk/gdk4-docs.xml @@ -36,7 +36,6 @@ <xi:include href="xml/gdkglcontext.xml" /> <xi:include href="xml/gdkvulkancontext.xml" /> <xi:include href="xml/events.xml" /> - <xi:include href="xml/event_structs.xml" /> <xi:include href="xml/keys.xml" /> <xi:include href="xml/gdkcontentformats.xml" /> <xi:include href="xml/gdkcontentprovider.xml" /> diff --git a/docs/reference/gdk/gdk4-sections.txt b/docs/reference/gdk/gdk4-sections.txt index bec726191c..68070cdc5d 100644 --- a/docs/reference/gdk/gdk4-sections.txt +++ b/docs/reference/gdk/gdk4-sections.txt @@ -180,6 +180,7 @@ GdkGravity GdkAnchorHints GdkWindowEdge GdkWindowTypeHint +GdkWindowState gdk_window_new_toplevel gdk_window_new_popup gdk_window_new_temp @@ -346,6 +347,7 @@ GDK_TYPE_WINDOW_TYPE GDK_TYPE_WINDOW_TYPE_HINT GDK_TYPE_WM_DECORATION GDK_TYPE_WM_FUNCTION +GDK_TYPE_WINDOW_STATE <SUBSECTION Private> gdk_window_get_type @@ -640,8 +642,12 @@ gdk_seat_capabilities_get_type <SECTION> <TITLE>Events</TITLE> <FILE>events</FILE> +GdkEvent GdkEventType GdkEventMask +GdkScrollDirection +GdkCrossingMode +GdkNotifyType GDK_CURRENT_TIME GDK_PRIORITY_EVENTS GDK_PRIORITY_REDRAW @@ -714,53 +720,13 @@ gdk_event_get_device_tool gdk_event_set_device_tool <SUBSECTION Standard> +GDK_TYPE_EVENT GDK_TYPE_EVENT_MASK GDK_TYPE_EVENT_TYPE -</SECTION> - -<SECTION> -<TITLE>Event Structures</TITLE> -<FILE>event_structs</FILE> -GdkEvent - -<SUBSECTION> -GdkEventAny -GdkEventKey -GdkEventButton -GdkEventTouch -GdkEventScroll -GdkEventMotion -GdkEventExpose -GdkEventCrossing -GdkEventFocus -GdkEventConfigure -GdkEventDND -GdkEventProximity -GdkEventGrabBroken -GdkEventTouchpadSwipe -GdkEventTouchpadPinch -GdkEventPadButton -GdkEventPadAxis -GdkEventPadGroupMode - -<SUBSECTION> -GdkScrollDirection -GdkCrossingMode -GdkNotifyType -GdkWindowState - -<SUBSECTION Standard> GDK_TYPE_CROSSING_MODE -GDK_TYPE_EVENT -GDK_TYPE_NOTIFY_TYPE -GDK_TYPE_PROPERTY_STATE GDK_TYPE_SCROLL_DIRECTION -GDK_TYPE_WINDOW_STATE -GDK_TYPE_OWNER_CHANGE - -<SUBSECTION Private> +GDK_TYPE_NOTIFY_TYPE gdk_event_get_type -gdk_owner_change_get_type </SECTION> <SECTION> diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c index 9bd6cfe2e5..687ba3e227 100644 --- a/gdk/gdkevents.c +++ b/gdk/gdkevents.c @@ -45,9 +45,8 @@ * system. * * In GTK+ applications the events are handled automatically in - * gtk_main_do_event() and passed on to the appropriate widgets, so these - * functions are rarely needed. Though some of the fields in the - * [Event Structures][gdk3-Event-Structures] are useful. + * gtk_main_do_event() and passed on to the appropriate widgets, + * so these functions are rarely needed. */ diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h index 13e20454a6..efb7abada1 100644 --- a/gdk/gdkevents.h +++ b/gdk/gdkevents.h @@ -38,18 +38,6 @@ G_BEGIN_DECLS -/** - * SECTION:event_structs - * @Short_description: Data structures specific to each type of event - * @Title: Event Structures - * - * The event structures contain data specific to each type of event in GDK. - * - * > A common mistake is to forget to set the event mask of a widget so that - * > the required events are received. - */ - - #define GDK_TYPE_EVENT (gdk_event_get_type ()) #define GDK_TYPE_EVENT_SEQUENCE (gdk_event_sequence_get_type ()) @@ -337,9 +325,6 @@ typedef enum * %GDK_TOUCHPAD_GESTURE_PHASE_CANCEL, this should be used as a hint * to undo any visible/permanent changes that were done throughout the * progress of the gesture. - * - * See also #GdkEventTouchpadSwipe and #GdkEventTouchpadPinch. - * */ typedef enum { @@ -356,9 +341,9 @@ typedef enum * @GDK_SCROLL_LEFT: the window is scrolled to the left. * @GDK_SCROLL_RIGHT: the window is scrolled to the right. * @GDK_SCROLL_SMOOTH: the scrolling is determined by the delta values - * in #GdkEventScroll. See gdk_event_get_scroll_deltas(). Since: 3.4 + * in scroll events. See gdk_event_get_scroll_deltas(). Since: 3.4 * - * Specifies the direction for #GdkEventScroll. + * Specifies the direction for scroll events. */ typedef enum { @@ -385,7 +370,7 @@ typedef enum * common ancestor. * @GDK_NOTIFY_UNKNOWN: an unknown type of enter/leave event occurred. * - * Specifies the kind of crossing for #GdkEventCrossing. + * Specifies the kind of crossing for enter and leave events. * * See the X11 protocol specification of LeaveNotify for * full details of crossing event generation. @@ -417,7 +402,7 @@ typedef enum * a mouse taking control of the pointer after a touch device), this event * is synthetic as the pointer didn’t leave the window. * - * Specifies the crossing mode for #GdkEventCrossing. + * Specifies the crossing mode for enter and leave events. */ typedef enum { |