Improve docs. (#62359)

* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
	(gtk_text_view_window_to_buffer_coords): Improve docs.  (#62359)

	* gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Updates.  (#79001)

	* gtk/tmpl/gtksocket.sgml: Add link to XEmbed draft.  (#67818)

	* gtk/tmpl/gtkdrawingarea.sgml: Fix a typo.

	* gtk/text_widget.sgml: Complete the fix for #79080.
This commit is contained in:
Matthias Clasen
2002-04-23 22:22:44 +00:00
parent ad4715b157
commit 7bb0ea6241
12 changed files with 75 additions and 25 deletions

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,8 @@
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/gtktextview.c (gtk_text_view_buffer_to_window_coords):
(gtk_text_view_window_to_buffer_coords): Improve docs. (#62359)
Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org> Tue Apr 23 18:35:34 2002 Kristian Rietveld <kris@gtk.org>
This commit adds a cell_background property for cell renderers. With This commit adds a cell_background property for cell renderers. With

View File

@ -1,3 +1,15 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
* gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml: Updates. (#79001)
2002-04-23 Matthias Clasen <maclas@gmx.de>
* gtk/tmpl/gtksocket.sgml: Add link to XEmbed draft. (#67818)
* gtk/tmpl/gtkdrawingarea.sgml: Fix a typo.
* gtk/text_widget.sgml: Complete the fix for #79080.
2002-04-22 Matthias Clasen <maclas@gmx.de> 2002-04-22 Matthias Clasen <maclas@gmx.de>
* gtk/tree_widget.sgml: Fix typo in "Simple Example". (#78661) * gtk/tree_widget.sgml: Fix typo in "Simple Example". (#78661)

View File

@ -10,7 +10,8 @@ Application-driven progressive image loading.
process of loading an image, by letting them send the image data process of loading an image, by letting them send the image data
directly to the loader instead of having the loader read the data directly to the loader instead of having the loader read the data
from a file. Applications can use this functionality instead of from a file. Applications can use this functionality instead of
gdk_pixbuf_new_from_file() when they need to parse image data in gdk_pixbuf_new_from_file() or gdk_pixbuf_animation_new_from_file()
when they need to parse image data in
small chunks. For example, it should be used when reading an small chunks. For example, it should be used when reading an
image from a (potentially) slow network connection, or when image from a (potentially) slow network connection, or when
loading an extremely large file. loading an extremely large file.
@ -47,31 +48,18 @@ Application-driven progressive image loading.
<title>Loading an animation</title> <title>Loading an animation</title>
<para> <para>
Loading an animation is a little more complex then loading an Loading an animation is almost as easy as loading an
image. In addition to the above signals, there is also a "<link image. Once the first "<link
linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal, linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal
as well as an "<link
linkend="GdkPixbufLoader-animation-done">animation_done</link>"
signal. The first lets the application know that it is dealing
with an animation, instead of a static image. It also passes a
#GdkPixbufFrame in the signal. As before, if you want to keep
the frame, you need to ref it. Once the first "<link
linkend="GdkPixbufLoader-frame-done">frame_done</link>" signal
has been emitted, you can call gdk_pixbuf_loader_get_animation() has been emitted, you can call gdk_pixbuf_loader_get_animation()
to get the #GdkPixbufAnimation struct. Each subsequent frame to get the #GdkPixbufAnimation struct and gdk_pixbuf_animation_get_iter()
goes through a similar lifecycle. For example "<link to get an #GdkPixbufAnimationIter for displaying it.
linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" is
re-emitted. Then "<link
linkend="GdkPixbufLoader-area-updated">area_updated</link>" is
emitted as many times as necessary. Finally, "<link
linkend="GdkPixbufLoader-animation-done">animation_done</link>"
is emitted as soon as all frames are done.
</para> </para>
</refsect2> </refsect2>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
gdk_pixbuf_new_from_file() gdk_pixbuf_new_from_file(), gdk_pixbuf_animation_new_from_file()
</para> </para>
<!-- ##### FUNCTION gdk_pixbuf_loader_new ##### --> <!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->

View File

@ -162,7 +162,7 @@ font and foreground color &mdash use standard
functions such as functions such as
<link linkend="gtk-widget-modify-font">gtk_widget_modify_font()</link> <link linkend="gtk-widget-modify-font">gtk_widget_modify_font()</link>
or or
<link linkend="gtk-widget-modify-fg">gtk_widget_modify_fg()</link>. <link linkend="gtk-widget-modify-fg">gtk_widget_modify_text()</link>.
For other attributes there are dedicated methods on For other attributes there are dedicated methods on
<link linkend="GtkTextView">GtkTextView</link> such as <link linkend="GtkTextView">GtkTextView</link> such as
<link linkend="gtk-text-view-set-tabs">gtk_text_view_set_tabs()</link>. <link linkend="gtk-text-view-set-tabs">gtk_text_view_set_tabs()</link>.

View File

@ -53,7 +53,7 @@ that drawing is implicitly clipped to the exposed area.
<title>Simple <structname>GtkDrawingArea</structname> usage.</title> <title>Simple <structname>GtkDrawingArea</structname> usage.</title>
<programlisting> <programlisting>
gboolean gboolean
expose_event_callback (GdkWidget *widget, GdkEventExpose *event, gpointer data) expose_event_callback (GtkWidget *widget, GdkEventExpose *event, gpointer data)
{ {
gdk_draw_arc (widget->window, gdk_draw_arc (widget->window,
widget->style->fg_gc[GTK_WIDGET_STATE (widget)], widget->style->fg_gc[GTK_WIDGET_STATE (widget)],

View File

@ -62,12 +62,21 @@ to be destroyed at any time when the main event loop
is running. is running.
</para> </para>
<para>
The communication between a #GtkSocket and a #GtkPlug follows the
<ulink url="http://www.freedesktop.org/standards/xembed.html">XEmbed</ulink>
protocol. This protocol has also been implemented in other toolkits, e.g.
<application>Qt</application>, allowing the same level of integration
when embedding a <application>Qt</application> widget in GTK or vice versa.</para>
<para> <para>
A socket can also be used to swallow arbitrary A socket can also be used to swallow arbitrary
pre-existing top-level windows using gtk_socket_steal(), pre-existing top-level windows using gtk_socket_steal(),
though the integration when this is done will not be as close though the integration when this is done will not be as close
as between a #GtkPlug and a #GtkSocket.</para> as between a #GtkPlug and a #GtkSocket.</para>
</para>
<!-- ##### SECTION See_Also ##### --> <!-- ##### SECTION See_Also ##### -->
<para> <para>
<variablelist> <variablelist>
@ -77,6 +86,11 @@ as between a #GtkPlug and a #GtkSocket.</para>
<listitem><para>the widget that plugs into a #GtkSocket.</para></listitem> <listitem><para>the widget that plugs into a #GtkSocket.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><ulink url="http://www.freedesktop.org/standards/xembed.html">XEmbed</ulink></term>
<listitem><para>the XEmbed Protocol Specification.</para></listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>

View File

@ -6845,14 +6845,17 @@ buffer_to_text_window (GtkTextView *text_view,
/** /**
* gtk_text_view_buffer_to_window_coords: * gtk_text_view_buffer_to_window_coords:
* @text_view: a #GtkTextView * @text_view: a #GtkTextView
* @win: a #GtkTextWindowType * @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
* @buffer_x: buffer x coordinate * @buffer_x: buffer x coordinate
* @buffer_y: buffer y coordinate * @buffer_y: buffer y coordinate
* @window_x: window x coordinate return location * @window_x: window x coordinate return location
* @window_y: window y coordinate return location * @window_y: window y coordinate return location
* *
* Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window * Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
* @win, and stores the result in (@window_x, @window_y). * @win, and stores the result in (@window_x, @window_y).
*
* Note that you can't convert coordinates for a nonexisting window (see
* gtk_text_view_set_border_window_size()).
**/ **/
void void
gtk_text_view_buffer_to_window_coords (GtkTextView *text_view, gtk_text_view_buffer_to_window_coords (GtkTextView *text_view,
@ -6982,7 +6985,7 @@ text_window_to_buffer (GtkTextView *text_view,
/** /**
* gtk_text_view_window_to_buffer_coords: * gtk_text_view_window_to_buffer_coords:
* @text_view: a #GtkTextView * @text_view: a #GtkTextView
* @win: a #GtkTextWindowType * @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
* @window_x: window x coordinate * @window_x: window x coordinate
* @window_y: window y coordinate * @window_y: window y coordinate
* @buffer_x: buffer x coordinate return location * @buffer_x: buffer x coordinate return location
@ -6990,6 +6993,9 @@ text_window_to_buffer (GtkTextView *text_view,
* *
* Converts coordinates on the window identified by @win to buffer * Converts coordinates on the window identified by @win to buffer
* coordinates, storing the result in (@buffer_x,@buffer_y). * coordinates, storing the result in (@buffer_x,@buffer_y).
*
* Note that you can't convert coordinates for a nonexisting window (see
* gtk_text_view_set_border_window_size()).
**/ **/
void void
gtk_text_view_window_to_buffer_coords (GtkTextView *text_view, gtk_text_view_window_to_buffer_coords (GtkTextView *text_view,