summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthias Clasen <matthiasc@src.gnome.org>2002-04-23 22:22:44 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2002-04-23 22:22:44 +0000
commit7bb0ea6241114e96e15314b833fb4e907ece7351 (patch)
tree06a8d92b97a757d7c813a2ec882cbbd4bab1b0e3 /docs
parentad4715b157fda6285e9dea7aaba634f86f5d87ad (diff)
downloadgdk-pixbuf-7bb0ea6241114e96e15314b833fb4e907ece7351.tar.gz
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.
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog12
-rw-r--r--docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml28
-rw-r--r--docs/reference/gtk/text_widget.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtkdrawingarea.sgml2
-rw-r--r--docs/reference/gtk/tmpl/gtksocket.sgml14
5 files changed, 36 insertions, 22 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 6cead5e30..d67f9be36 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -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>
* gtk/tree_widget.sgml: Fix typo in "Simple Example". (#78661)
diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
index acdebe537..dbdfa95c2 100644
--- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
+++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml
@@ -10,7 +10,8 @@ Application-driven progressive image loading.
process of loading an image, by letting them send the image data
directly to the loader instead of having the loader read the data
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
image from a (potentially) slow network connection, or when
loading an extremely large file.
@@ -47,31 +48,18 @@ Application-driven progressive image loading.
<title>Loading an animation</title>
<para>
- Loading an animation is a little more complex then loading an
- image. In addition to the above signals, there is also a "<link
- linkend="GdkPixbufLoader-frame-done">frame_done</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
+ Loading an animation is almost as easy as loading an
+ image. Once the first "<link
+ linkend="GdkPixbufLoader-area-prepared">area_prepared</link>" signal
has been emitted, you can call gdk_pixbuf_loader_get_animation()
- to get the #GdkPixbufAnimation struct. Each subsequent frame
- goes through a similar lifecycle. For example "<link
- 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.
+ to get the #GdkPixbufAnimation struct and gdk_pixbuf_animation_get_iter()
+ to get an #GdkPixbufAnimationIter for displaying it.
</para>
</refsect2>
<!-- ##### SECTION See_Also ##### -->
<para>
- gdk_pixbuf_new_from_file()
+ gdk_pixbuf_new_from_file(), gdk_pixbuf_animation_new_from_file()
</para>
<!-- ##### FUNCTION gdk_pixbuf_loader_new ##### -->
diff --git a/docs/reference/gtk/text_widget.sgml b/docs/reference/gtk/text_widget.sgml
index d703456d1..ca015bcd5 100644
--- a/docs/reference/gtk/text_widget.sgml
+++ b/docs/reference/gtk/text_widget.sgml
@@ -162,7 +162,7 @@ font and foreground color &mdash use standard
functions such as
<link linkend="gtk-widget-modify-font">gtk_widget_modify_font()</link>
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
<link linkend="GtkTextView">GtkTextView</link> such as
<link linkend="gtk-text-view-set-tabs">gtk_text_view_set_tabs()</link>.
diff --git a/docs/reference/gtk/tmpl/gtkdrawingarea.sgml b/docs/reference/gtk/tmpl/gtkdrawingarea.sgml
index 9757c2a86..653c27ccf 100644
--- a/docs/reference/gtk/tmpl/gtkdrawingarea.sgml
+++ b/docs/reference/gtk/tmpl/gtkdrawingarea.sgml
@@ -53,7 +53,7 @@ that drawing is implicitly clipped to the exposed area.
<title>Simple <structname>GtkDrawingArea</structname> usage.</title>
<programlisting>
gboolean
-expose_event_callback (GdkWidget *widget, GdkEventExpose *event, gpointer data)
+expose_event_callback (GtkWidget *widget, GdkEventExpose *event, gpointer data)
{
gdk_draw_arc (widget->window,
widget->style->fg_gc[GTK_WIDGET_STATE (widget)],
diff --git a/docs/reference/gtk/tmpl/gtksocket.sgml b/docs/reference/gtk/tmpl/gtksocket.sgml
index 38e6fe9fd..be5e1b19f 100644
--- a/docs/reference/gtk/tmpl/gtksocket.sgml
+++ b/docs/reference/gtk/tmpl/gtksocket.sgml
@@ -63,11 +63,20 @@ is running.
</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>
A socket can also be used to swallow arbitrary
pre-existing top-level windows using gtk_socket_steal(),
though the integration when this is done will not be as close
as between a #GtkPlug and a #GtkSocket.</para>
+</para>
+
<!-- ##### SECTION See_Also ##### -->
<para>
<variablelist>
@@ -77,6 +86,11 @@ as between a #GtkPlug and a #GtkSocket.</para>
<listitem><para>the widget that plugs into a #GtkSocket.</para></listitem>
</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>
</para>