AuroraMiddleware/gtk2
1
0
Fork 0
forked from AuroraMiddleware/gtk
Code Issues Pull Requests Projects Releases Wiki Activity

Fix some docs duplicated between templates and inline.

Browse Source 
Thu Apr 25 22:37:58 2002  Owen Taylor  <otaylor@redhat.com>

        * gdk/tmpl/{events,input_devices,region,x_interaction}.sgml:
        Fix some docs duplicated between templates and inline.
This commit is contained in:
Owen Taylor 2002-04-26 02:39:49 +00:00 committed by Owen Taylor
parent 425b9886c9
commit a7557dc8f9
5 changed files with 39 additions and 107 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@ -1,3 +1,8 @@
Thu Apr 25 22:37:58 2002 Owen Taylor <otaylor@redhat.com>
* gdk/tmpl/{events,input_devices,region,x_interaction}.sgml:
Fix some docs duplicated between templates and inline.
2002-04-24 Matthias Clasen <maclas@gmx.de>
* gtk/gtk-sections.txt: Remove GTK_OBJECT_CONNECTED.

104
docs/reference/gdk/tmpl/events.sgml
View File

@ -149,71 +149,49 @@ is given in the <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
<!-- ##### FUNCTION gdk_events_pending ##### -->
<para>
Checks if any events are waiting to be processed.
</para>
@Returns: %TRUE if any events are pending.
@Returns:
<!-- ##### FUNCTION gdk_event_peek ##### -->
<para>
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.)
</para>
@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:
<!-- ##### FUNCTION gdk_event_get ##### -->
<para>
Gets the next #GdkEvent to be processed, fetching events from the X server if
necessary.
</para>
@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:
<!-- ##### FUNCTION gdk_event_get_graphics_expose ##### -->
<para>
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.
</para>
@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:
<!-- ##### FUNCTION gdk_event_put ##### -->
<para>
Appends a copy of the given event onto the front of the event queue.
</para>
@event: a #GdkEvent.
@event:
<!-- ##### FUNCTION gdk_event_copy ##### -->
<para>
Copies a #GdkEvent, copying or incrementing the reference count of the
resources associated with it (e.g. #GdkWindow's and strings).
</para>
@event: a #GdkEvent.
@Returns: a copy of @event. The returned #GdkEvent should be freed with
gdk_event_free().
@event:
@Returns:
<!-- ##### FUNCTION gdk_event_free ##### -->
<para>
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().
</para>
@event: a #GdkEvent.
@ -221,12 +199,10 @@ gdk_event_copy().
<!-- ##### FUNCTION gdk_event_get_time ##### -->
<para>
Gets the timestamp from a #GdkEvent.
</para>
@event: a #GdkEvent.
@Returns: the timestamp from @event, or %GDK_CURRENT_TIME if the event has
no timestamp.
@event:
@Returns:
<!-- ##### FUNCTION gdk_event_get_state ##### -->
@ -274,17 +250,11 @@ no timestamp.
<!-- ##### FUNCTION gdk_event_handler_set ##### -->
<para>
Sets the function to call to handle all events from GDK.
</para>
<para>
Note that GTK+ uses this to install its own event handler, so it is probably
not useful for GTK+ applications.
</para>
@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:
<!-- ##### USER_FUNCTION GdkEventFunc ##### -->
@ -300,73 +270,49 @@ gdk_event_handler_set().
<!-- ##### FUNCTION gdk_event_send_client_message ##### -->
<para>
Sends an X ClientMessage event to a given window.
</para>
<para>
This could be used for communicating between different applications,
though the amount of data is limited to 20 bytes.
</para>
@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:
<!-- ##### FUNCTION gdk_event_send_clientmessage_toall ##### -->
<para>
Sends an X ClientMessage event to all toplevel windows.
</para>
<para>
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.
</para>
@event: the #GdkEvent to send, which should be a #GdkEventClient.
@event:
<!-- ##### FUNCTION gdk_add_client_message_filter ##### -->
<para>
Adds a filter to be called when X ClientMessage events are received.
</para>
@message_type: the type of ClientMessage events to receive. This will be
checked against the <structfield>message_type</structfield> 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:
<!-- ##### FUNCTION gdk_get_show_events ##### -->
<para>
Returns non-zero if event debugging output is enabled.
</para>
@Returns: non-zero if event debugging output is enabled.
@Returns:
<!-- ##### FUNCTION gdk_set_show_events ##### -->
<para>
Sets whether event debugging information is output.
Note that GTK+ must be compiled with debugging enabled, i.e. using the
<option>--enable-debug</option> configure option.
</para>
@show_events: %TRUE to output event debugging information.
@show_events:
<!-- ##### FUNCTION gdk_setting_get ##### -->
<para>
Obtains a desktop-wide setting, such as the double-click time.
</para>
<para>
FIXME needs a list of valid settings here, or a link to
more information.
</para>
@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:

4
docs/reference/gdk/tmpl/input_devices.sgml
View File

@ -174,11 +174,9 @@ types that GTK+ understands.
<!-- ##### FUNCTION gdk_devices_list ##### -->
<para>
Returns the list of available input devices. The list is statically
allocated and should not be freed.
</para>
@Returns: a list of #GdkDevice*.
@Returns:
<!-- ##### FUNCTION gdk_device_set_source ##### -->

24
docs/reference/gdk/tmpl/regions.sgml
View File

@ -233,44 +233,36 @@ Positive values shrink the region. Negative values expand it.
<!-- ##### FUNCTION gdk_region_union_with_rect ##### -->
<para>
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.
</para>
@region: a #GdkRegion.
@rect: a #GdkRectangle.
@region:
@rect:
<!-- ##### FUNCTION gdk_region_intersect ##### -->
<para>
</para>
@source1: a #GdkRegion
@source2: a #GdkRegion
@source1:
@source2:
<!-- ##### FUNCTION gdk_region_union ##### -->
<para>
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.
</para>
@source1: a #GdkRegion
@source2: a #GdkRegion
@source1:
@source2:
<!-- ##### FUNCTION gdk_region_subtract ##### -->
<para>
Subtracts the area of @source2 from the area @source1. The resulting
area is the set of pixels contained in @source1 but not in @source2.
</para>
@source1: a #GdkRegion
@source2: a #GdkRegion
@source1:
@source2:
<!-- ##### FUNCTION gdk_region_xor ##### -->

9
docs/reference/gdk/tmpl/x_interaction.sgml
View File

@ -262,26 +262,17 @@ a #GdkWindow or a #GdkFont.
<!-- ##### FUNCTION gdk_window_lookup ##### -->
<para>
Obtains the #GdkWindow for the given Xlib window ID, or %NULL if no #GdkWindow has
been created for @xid.
</para>
@anid:
@Returns:
<!-- # Unused Parameters # -->
@xid: Xlib window ID
<!-- ##### FUNCTION gdk_pixmap_lookup ##### -->
<para>
Obtains the #GdkPixmap for the given Xlib pixmap ID, or %NULL if no #GdkPixmap has
been created for @xid.
</para>
@anid:
@Returns:
<!-- # Unused Parameters # -->
@xid: Xlib pixmap ID
<!-- ##### MACRO gdk_font_lookup ##### -->