From a7557dc8f949c6d41d01a11483e6e6a5b1885b72 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Fri, 26 Apr 2002 02:39:49 +0000 Subject: [PATCH] Fix some docs duplicated between templates and inline. Thu Apr 25 22:37:58 2002 Owen Taylor * gdk/tmpl/{events,input_devices,region,x_interaction}.sgml: Fix some docs duplicated between templates and inline. --- docs/reference/ChangeLog | 5 + docs/reference/gdk/tmpl/events.sgml | 104 +++++---------------- docs/reference/gdk/tmpl/input_devices.sgml | 4 +- docs/reference/gdk/tmpl/regions.sgml | 24 ++--- docs/reference/gdk/tmpl/x_interaction.sgml | 9 -- 5 files changed, 39 insertions(+), 107 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 4484e8b90e..b35558764d 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +Thu Apr 25 22:37:58 2002 Owen Taylor + + * gdk/tmpl/{events,input_devices,region,x_interaction}.sgml: + Fix some docs duplicated between templates and inline. + 2002-04-24 Matthias Clasen * gtk/gtk-sections.txt: Remove GTK_OBJECT_CONNECTED. diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index b64fa22af8..64fdbbd713 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -149,71 +149,49 @@ is given in the GLib Main Loop. -Checks if any events are waiting to be processed. -@Returns: %TRUE if any events are pending. +@Returns: -Gets a copy of the first #GdkEvent in the event queue. -(Note that this function will not get more events from the X server. -It only checks the events that have already been moved to the GDK event queue.) -@Returns: a copy of the first #GdkEvent on the event queue, or %NULL if no -events are in the queue. The returned #GdkEvent should be freed with -gdk_event_free(). - +@Returns: -Gets the next #GdkEvent to be processed, fetching events from the X server if -necessary. -@Returns: the next #GdkEvent to be processed, or %NULL if no events are pending. -The returned #GdkEvent should be freed with gdk_event_free(). +@Returns: -Waits for a GraphicsExpose or NoExpose event from the X server. -This is used in the #GtkText and #GtkCList widgets in GTK+ to make sure any -GraphicsExpose events are handled before the widget is scrolled. -@window: the #GdkWindow to wait for the events for. -@Returns: a #GdkEventExpose if a GraphicsExpose was received, or %NULL if a -NoExpose event was received. +@window: +@Returns: -Appends a copy of the given event onto the front of the event queue. -@event: a #GdkEvent. +@event: -Copies a #GdkEvent, copying or incrementing the reference count of the -resources associated with it (e.g. #GdkWindow's and strings). -@event: a #GdkEvent. -@Returns: a copy of @event. The returned #GdkEvent should be freed with -gdk_event_free(). +@event: +@Returns: -Frees a #GdkEvent, freeing or decrementing any resources associated with it. -Note that this function should only be called with events returned from -gdk_event_peek(), gdk_event_get(), gdk_event_get_graphics_expose() and -gdk_event_copy(). @event: a #GdkEvent. @@ -221,12 +199,10 @@ gdk_event_copy(). -Gets the timestamp from a #GdkEvent. -@event: a #GdkEvent. -@Returns: the timestamp from @event, or %GDK_CURRENT_TIME if the event has -no timestamp. +@event: +@Returns: @@ -274,17 +250,11 @@ no timestamp. -Sets the function to call to handle all events from GDK. - - -Note that GTK+ uses this to install its own event handler, so it is probably -not useful for GTK+ applications. -@func: the function to call to handle events from GDK. -@data: user data to pass to the function. -@notify: the function to call when the handler function is removed, i.e. when -gdk_event_handler_set() is called with another event handler. +@func: +@data: +@notify: @@ -300,73 +270,49 @@ gdk_event_handler_set(). -Sends an X ClientMessage event to a given window. - - -This could be used for communicating between different applications, -though the amount of data is limited to 20 bytes. -@event: the #GdkEvent to send, which should be a #GdkEventClient. -@xid: the window to send the X ClientMessage event to. -@Returns: non-zero on success. +@event: +@xid: +@Returns: -Sends an X ClientMessage event to all toplevel windows. - - -Toplevel windows are determined by checking for the WM_STATE property, as -described in the Inter-Client Communication Conventions Manual (ICCCM). -If no windows are found with the WM_STATE property set, the message is sent -to all children of the root window. -@event: the #GdkEvent to send, which should be a #GdkEventClient. +@event: -Adds a filter to be called when X ClientMessage events are received. -@message_type: the type of ClientMessage events to receive. This will be -checked against the message_type field of the -XClientMessage event struct. -@func: the function to call to process the event. -@data: user data to pass to @func. +@message_type: +@func: +@data: -Returns non-zero if event debugging output is enabled. -@Returns: non-zero if event debugging output is enabled. +@Returns: -Sets whether event debugging information is output. -Note that GTK+ must be compiled with debugging enabled, i.e. using the - configure option. -@show_events: %TRUE to output event debugging information. +@show_events: -Obtains a desktop-wide setting, such as the double-click time. - - -FIXME needs a list of valid settings here, or a link to -more information. -@name: the name of the setting. -@value: location to store the value of the setting. -@Returns: %TRUE if the value has been successfully stored. +@name: +@value: +@Returns: diff --git a/docs/reference/gdk/tmpl/input_devices.sgml b/docs/reference/gdk/tmpl/input_devices.sgml index 6af41e9dae..bd84e6bd5e 100644 --- a/docs/reference/gdk/tmpl/input_devices.sgml +++ b/docs/reference/gdk/tmpl/input_devices.sgml @@ -174,11 +174,9 @@ types that GTK+ understands. -Returns the list of available input devices. The list is statically -allocated and should not be freed. -@Returns: a list of #GdkDevice*. +@Returns: diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml index 5612e26272..4aedc3d6ea 100644 --- a/docs/reference/gdk/tmpl/regions.sgml +++ b/docs/reference/gdk/tmpl/regions.sgml @@ -233,44 +233,36 @@ Positive values shrink the region. Negative values expand it. -Sets the area of @region to the union of the areas of @region and -@rect. The resulting area is the set of pixels contained in -either @region or @rect. -@region: a #GdkRegion. -@rect: a #GdkRectangle. +@region: +@rect: -@source1: a #GdkRegion -@source2: a #GdkRegion +@source1: +@source2: -Sets the area of @source1 to the union of the areas of @source1 and -@source2. The resulting area is the set of pixels contained in -either @source1 or @source2. -@source1: a #GdkRegion -@source2: a #GdkRegion +@source1: +@source2: -Subtracts the area of @source2 from the area @source1. The resulting -area is the set of pixels contained in @source1 but not in @source2. -@source1: a #GdkRegion -@source2: a #GdkRegion +@source1: +@source2: diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml index 7f964cc8d7..a41b673d51 100644 --- a/docs/reference/gdk/tmpl/x_interaction.sgml +++ b/docs/reference/gdk/tmpl/x_interaction.sgml @@ -262,26 +262,17 @@ a #GdkWindow or a #GdkFont. -Obtains the #GdkWindow for the given Xlib window ID, or %NULL if no #GdkWindow has -been created for @xid. @anid: @Returns: - -@xid: Xlib window ID - -Obtains the #GdkPixmap for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has -been created for @xid. @anid: @Returns: - -@xid: Xlib pixmap ID