Merged documentation fixes from HEAD.

This commit is contained in:
Matthias Clasen
2002-04-24 22:09:24 +00:00
parent fab341df09
commit f6238492bc
21 changed files with 128 additions and 42 deletions

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,11 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/gtktextiter.c:
* gtk/gtktreemodelsort.c:
* gtk/gtktextview.c: Documentation fixes. (#62359, #68404, #57929)
2002-04-22 Anders Carlsson <andersca@gnu.org>
* gtk/gtkentry.c (gtk_entry_drag_data_get): Use

View File

@@ -1,3 +1,20 @@
2002-04-24 Matthias Clasen <maclas@gmx.de>
Merged from HEAD:
* gtk/tmpl/gtksocket.sgml:
* gtk/tmpl/gtkdrawingarea.sgml:
* gtk/tmpl/gtktreemodel.sgml:
* gtk/tmpl/gtkradiomenuitem.sgml:
* gtk/tmpl/gtkwidget.sgml:
* gtk/tmpl/gtkdialog.sgml:
* gdk-pixbuf/tmpl/gdk-pixbuf-loader.sgml:
* gtk/text_widget.sgml:
* gtk/tree_widget.sgml:
* gtk/gtk-sections.txt:
* gdk/tmpl/properties.sgml: Documentation fixes. (#79001, #67818,
#79080, #78661, #78392, #75588, #72312, #74439)
Tue Mar 26 15:41:49 2002 Owen Taylor <otaylor@redhat.com>
* gtk/building.sgml: Add a mention of running ldconfig.

View File

@@ -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 ##### -->

View File

@@ -244,10 +244,10 @@ Changes the contents of a property on a window.
@window: a #GdkWindow.
@property: the property to change.
@type: the new type for the property. If @mode is
%GDK_PROP_MODE_REPLACE or %GDK_PROP_MODE_APPEND, then this
%GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
must match the existing type or an error will occur.
@format: the new format for the property. If @mode is
%GDK_PROP_MODE_REPLACE or %GDK_PROP_MODE_APPEND, then this
%GDK_PROP_MODE_PREPEND or %GDK_PROP_MODE_APPEND, then this
must match the existing format or an error will occur.
@mode: a value describing how the new data is to be combined
with the current data.

View File

@@ -3447,6 +3447,7 @@ gtk_vseparator_get_type
<FILE>gtkwidget</FILE>
<TITLE>GtkWidget</TITLE>
GtkWidget
GtkWidgetClass
GtkWidgetFlags
GTK_WIDGET_TYPE
GTK_WIDGET_STATE

View File

@@ -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>.
@@ -170,6 +170,7 @@ For other attributes there are dedicated methods on
<informalexample><programlisting>
GtkWidget *view;
GtkTextBuffer *buffer;
GtkTextIter start, end;
PangoFontDescription *font_desc;
GdkColor color;
GtkTextTag *tag;
@@ -187,7 +188,7 @@ For other attributes there are dedicated methods on
/* Change default color throughout the widget */
gdk_color_parse ("green", &amp;color);
gtk_widget_modify_fg (view, GTK_STATE_NORMAL, &amp;color);
gtk_widget_modify_text (view, GTK_STATE_NORMAL, &amp;color);
/* Change left margin throughout the widget */
gtk_text_view_set_left_margin (GTK_TEXT_VIEW (view), 30);

View File

@@ -82,7 +82,7 @@ void quick_message (gchar *message) {
dialog = gtk_dialog_new_with_buttons ("Message",
main_application_window,
GTK_DIALOG_DESTROY_WITH_PARENT,
GTK_STOCK_BUTTON_OK,
GTK_STOCK_OK,
GTK_RESPONSE_NONE,
NULL);
label = gtk_label_new (message);

View File

@@ -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)],
@@ -64,7 +64,7 @@ expose_event_callback (GdkWidget *widget, GdkEventExpose *event, gpointer data)
return TRUE;
}
[...]
GtkWidget *drawing_area = gtk_drawing_area_new (<!>);
GtkWidget *drawing_area = gtk_drawing_area_new (<!-- -->);
gtk_widget_set_size_request (drawing_area, 100, 100);
g_signal_connect (G_OBJECT (drawing_area), "expose_event",
G_CALLBACK (expose_event_callback), NULL);

View File

@@ -38,7 +38,7 @@ for(i = 0; i < 5; i++)
<listitem><para>because a radio menu item is a menu item.</para></listitem>
</varlistentry>
<varlistentry>
<term>#GtkCheckItem</term>
<term>#GtkCheckMenuItem</term>
<listitem><para>to know how to handle the check.</para></listitem>
</varlistentry>
</variablelist>

View File

@@ -25,7 +25,7 @@ have been added to its parent.
<example>
<title>Obtaining the window ID of a socket.</title>
<programlisting>
GtkWidget *socket = gtk_socket_new (<!>);
GtkWidget *socket = gtk_socket_new (<!-- -->);
gtk_widget_show (socket);
gtk_container_add (GTK_CONTAINER (parent), socket);
@@ -62,6 +62,13 @@ to be destroyed at any time when the main event loop
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(),
@@ -77,6 +84,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>

View File

@@ -168,7 +168,7 @@ enum
gchar *str_data;
gint int_data;
/* Make sure you terminate calls to gtk_tree_model_get(<!>)
/* Make sure you terminate calls to gtk_tree_model_get(<!-- -->)
* with a '-1' value
*/
gtk_tree_model_get (list_store, &amp;iter,
@@ -190,7 +190,7 @@ enum
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkTreeView, #GtkTreeStore, #GtkListStore, #GtkTreeDnd, #GtkTreeSortable
#GtkTreeView, #GtkTreeStore, #GtkListStore, <link linkend="gtk-GtkTreeView-drag-and-drop">GtkTreeDnd</link>, #GtkTreeSortable
</para>
<!-- ##### STRUCT GtkTreeModel ##### -->

View File

@@ -20,14 +20,20 @@ GtkWidget
</para>
<!-- ##### STRUCT GtkWidgetClass ##### -->
<para>
</para>
<!-- ##### ENUM GtkWidgetFlags ##### -->
<para>
Tells about certain properties of the widget.
</para>
@GTK_TOPLEVEL:
widgets without a real parent, as there are #GtkWindow<!>s and
#GtkMenu<!>s have this flag set throughout their lifetime.
widgets without a real parent, as there are #GtkWindow<!-- -->s and
#GtkMenu<!-- -->s have this flag set throughout their lifetime.
Toplevel widgets always contain their own #GdkWindow.
@GTK_NO_WINDOW:
Indicative for a widget that does not provide its own #GdkWindow.
@@ -929,7 +935,12 @@ Equivalent to <literal>gtk_widget_set_style (widget, NULL)</literal>.
<!-- ##### FUNCTION gtk_widget_reset_rc_styles ##### -->
<para>
Calls gtk_widget_set_rc_style() recursively on all descendants.
Reset the styles of @widget and all descendents, so when
they are looked up again, they get the correct values
for the currently loaded RC file settings.
</para>
<para>
This function is not useful for applications.
</para>
@widget: a #GtkWidget.

View File

@@ -287,7 +287,7 @@ setup_tree (void)
populate_tree_model (store);
/* Create a view */
view = gtk_tree_view_new_with_model (GTK_TREE_MODEL (store));
tree = gtk_tree_view_new_with_model (GTK_TREE_MODEL (store));
/* The view now holds a reference. We can get rid of our own
* reference */

View File

@@ -4322,8 +4322,9 @@ strbreakup (const char *string,
* @match_end: return location for end of match, or %NULL
* @limit: bound for the search, or %NULL for the end of the buffer
*
* Searches forward for @str. Any match is returned as the range
* @match_start, @match_end. The search will not continue past
* Searches forward for @str. Any match is returned by setting
* @match_start to the first character of the match and @match_end to the
* first character after the match. The search will not continue past
* @limit. Note that a search is a linear or O(n) operation, so you
* may wish to use @limit to avoid locking up your UI on large
* buffers.

View File

@@ -6845,7 +6845,7 @@ buffer_to_text_window (GtkTextView *text_view,
/**
* gtk_text_view_buffer_to_window_coords:
* @text_view: a #GtkTextView
* @win: a #GtkTextWindowType
* @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
* @buffer_x: buffer x coordinate
* @buffer_y: buffer y coordinate
* @window_x: window x coordinate return location
@@ -6853,6 +6853,9 @@ buffer_to_text_window (GtkTextView *text_view,
*
* Converts coordinate (@buffer_x, @buffer_y) to coordinates for the window
* @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
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:
* @text_view: a #GtkTextView
* @win: a #GtkTextWindowType
* @win: a #GtkTextWindowType except #GTK_TEXT_WINDOW_PRIVATE
* @window_x: window x coordinate
* @window_y: window y coordinate
* @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
* 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
gtk_text_view_window_to_buffer_coords (GtkTextView *text_view,

View File

@@ -1937,9 +1937,10 @@ gtk_tree_model_sort_convert_child_iter_to_iter (GtkTreeModelSort *tree_model_sor
* @tree_model_sort: A #GtkTreeModelSort
* @sorted_path: A #GtkTreePath to convert
*
* Converts @sort_path to a path on the child model of @tree_model_sort. That
* is, @sort_path points ot a location in @tree_model_sort. The returned path
* will point to the same location in the model not being sorted. If @path does not point to a
* Converts @sorted_path to a path on the child model of @tree_model_sort. That
* is, @sorted_path points to a location in @tree_model_sort. The returned path
* will point to the same location in the model not being sorted. If @sorted_path
* does not point to a location in the child model, %NULL is returned.
*
* Return value: A newly allocated #GtkTreePath, or %NULL
**/