Commit 31df9723 authored by Matthias Clasen's avatar Matthias Clasen

Fix docs. (#66383)

        * gtk/gtklabel.c: Fix docs. (#66383)

        * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
        (#66278, #66280)

        * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
        gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)

        * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
        Don't emit a g_warning() about being deprecated. (#66208)

        * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.

        * gtk/gtkcontainer.c: Doc fixes.

        * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.

        * gtk/gtkstyle.c (gtk_style_attach): Add docs.

        * gdk-pixbuf.h (gdk_pixbuf_ref, gdk_pixbuf_unref,
        gdk_pixbuf_animation_ref, gdk_pixbuf_animation_unref):
        Deprecate. (#66208)

        * gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383)

        * gtk/tree_widget.sgml: Typo fix. (#66256)

        * gdk-pixbuf/Makefile.am (SCAN_OPTIONS): Add --deprecated-guards.

        * gtk/tmpl/gtktext.sgml, gtk/tmpl/gtktree.sgml,
        gtk/tmpl/gtktreeitem.sgml: Updates.
parent 83fbfac8
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/gtklabel.c: Fix docs. (#66383)
* gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
(#66278, #66280)
* gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
* gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
Don't emit a g_warning() about being deprecated. (#66208)
* gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
* gtk/gtkcontainer.c: Doc fixes.
* gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
* gtk/gtkstyle.c (gtk_style_attach): Add docs.
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
......
2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383)
* gtk/tree_widget.sgml: Typo fix. (#66256)
* gdk-pixbuf/Makefile.am (SCAN_OPTIONS): Add --deprecated-guards.
* gtk/tmpl/gtktext.sgml, gtk/tmpl/gtktree.sgml,
gtk/tmpl/gtktreeitem.sgml: Updates.
2001-12-04 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkwidget.sgml: Updates.
......
......@@ -10,7 +10,7 @@ DOC_MAIN_SGML_FILE=gdk-pixbuf.sgml
DOC_SOURCE_DIR=../../../gdk-pixbuf
# Extra options to supply to gtkdoc-scan
SCAN_OPTIONS=--source-dir=../../../contrib/gdk-pixbuf-xlib
SCAN_OPTIONS=--source-dir=../../../contrib/gdk-pixbuf-xlib --deprecated-guards="GDK_PIXBUF_ENABLE_BROKEN|GDK_PIXBUF_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --source-dir=../../../contrib/gdk-pixbuf-xlib
......
......@@ -5,45 +5,41 @@ GtkLabel
A widget that displays a small to medium amount of text.
<!-- ##### SECTION Long_Description ##### -->
<para>
The #GtkLabel widget is usually used directly by the programmer to display
word(s) describing an adjacent widget or its use. It is also used internally
by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
use text.
<para>
The #GtkLabel widget is usually used directly by the programmer to display
word(s) describing an adjacent widget or its use. It is also used internally
by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
use text.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<para>
</para>
<!-- ##### STRUCT GtkLabel ##### -->
<para>
This should not be accessed directly. Use the accessor functions as
described below.
<para>
This should not be accessed directly. Use the accessor functions as
described below.
</para>
<!-- ##### FUNCTION gtk_label_new ##### -->
<para>
Creates a new label with the given string of text inside it. You can
pass NULL to get an empty label widget.
<para>
</para>
@str: The string you want to display in the #GtkLabel
@Returns: The newly allocated #GtkLabel widget
@str:
@Returns:
<!-- ##### FUNCTION gtk_label_set_text ##### -->
<para>
Sets the text within the #GtkLabel widget. It overwrites any text that
was there before. Note that underlines that were there before do not
get overwritten. If you want to erase underlines just send NULL to
gtk_label_set_pattern().
<para>
</para>
@label: The #GtkLabel you want to set the text for.
@str: The text you want to add.
@label:
@str:
<!-- ##### FUNCTION gtk_label_set_attributes ##### -->
......@@ -74,11 +70,11 @@ gtk_label_set_pattern().
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
<para>
The pattern of underlines you want under the existing text within the
#GtkLabel widget. For example if the current text of the label says
&quot;FooBarBaz&quot; passing a pattern of &quot;___ ___&quot; will underline
&quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
<para>
The pattern of underlines you want under the existing text within the
#GtkLabel widget. For example if the current text of the label says
&quot;FooBarBaz&quot; passing a pattern of &quot;___ ___&quot; will underline
&quot;Foo&quot; and &quot;Baz&quot; but not &quot;Bar&quot;.
</para>
@label: The #GtkLabel you want to set the pattern to.
......@@ -86,22 +82,19 @@ The pattern of underlines you want under the existing text within the
<!-- ##### FUNCTION gtk_label_set_justify ##### -->
<para>
Set where the text within the #GtkLabel will align to. This can be one of
four values: GTK_JUSTIFY_LEFT, GTK_JUSTIFY_RIGHT, GTK_JUSTIFY_CENTER,
and GTK_JUSTIFY_FILL. GTK_JUSTIFY_CENTER is the default value when the
widget is first created with gtk_label_new().
<para>
</para>
@label: The #GtkLabel widget you want to set justification for.
@jtype: The #GtkJustification type as described above.
@label:
@jtype:
<!-- ##### FUNCTION gtk_label_get ##### -->
<para>
Gets the current string of text within the #GtkLabel and writes it to
the given str argument. It does not make a copy of this string so you
must not write to it.
<para>
Gets the current string of text within the #GtkLabel and writes it to
the given @str argument. It does not make a copy of this string so you
must not write to it.
</para>
@label: The #GtkLabel widget you want to get the text from.
......@@ -109,12 +102,12 @@ must not write to it.
<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
<para>
Parses the given string for underscores and converts the next
character to an underlined character. The last character that
was underlined will have its lower-cased accelerator keyval returned (i.e.
&quot;_File&quot; would return the keyval for &quot;f&quot;. This is
probably only used within the Gtk+ library itself for menu items and such.
<para>
Parses the given string for underscores and converts the next
character to an underlined character. The last character that
was underlined will have its lower-cased accelerator keyval returned (i.e.
&quot;_File&quot; would return the keyval for &quot;f&quot;. This is
probably only used within the Gtk+ library itself for menu items and such.
</para>
@label: The #GtkLabel you want to affect.
......@@ -123,20 +116,18 @@ probably only used within the Gtk+ library itself for menu items and such.
<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
<para>
Toggles line wrapping within the #GtkLabel widget. TRUE makes it break
lines if text exceeds the widget's size. FALSE lets the text get cut off
by the edge of the widget if it exceeds the widget size.
<para>
</para>
@label: The #GtkLabel you want to set line wrapping for.
@wrap: TRUE turns it on; FALSE turns it off.
@label:
@wrap:
<!-- ##### MACRO gtk_label_set ##### -->
<para>
Aliases gtk_label_set_text. Probably used for backward compatibility with
Gtk+ 1.0.x.
<para>
Aliases gtk_label_set_text(). Probably used for backward compatibility with
Gtk+ 1.0.x.
</para>
......@@ -222,8 +213,6 @@ Gtk+ 1.0.x.
@label:
@str:
<!-- # Unused Parameters # -->
@string:
<!-- ##### FUNCTION gtk_label_get_attributes ##### -->
......@@ -362,8 +351,8 @@ Gtk+ 1.0.x.
@arg1:
<!-- ##### ARG GtkLabel:label ##### -->
<para>
The actual label text. Do not write to this pointer, it is not copied.
<para>
The actual label text. Do not write to this pointer, it is not copied.
</para>
<!-- ##### ARG GtkLabel:attributes ##### -->
......@@ -382,14 +371,14 @@ The actual label text. Do not write to this pointer, it is not copied.
</para>
<!-- ##### ARG GtkLabel:justify ##### -->
<para>
The #GtkJustification setting. See gtk_label_set_justify() for more info.
<para>
The #GtkJustification setting. See gtk_label_set_justify() for more info.
</para>
<!-- ##### ARG GtkLabel:pattern ##### -->
<para>
The pattern of underlines under the existing text. Do not change the
pointer, it isn't copied.
<para>
The pattern of underlines under the existing text. Do not change the
pointer, it isn't copied.
</para>
<!-- ##### ARG GtkLabel:wrap ##### -->
......
......@@ -2,10 +2,10 @@
GtkText
<!-- ##### SECTION Short_Description ##### -->
deprecated text widget, use #GtkTextView instead
Deprecated text widget, use #GtkTextView instead.
<!-- ##### SECTION Long_Description ##### -->
<para>
<para>
<warning>
<para>
#GtkText is deprecated and unsupported. It is known to be
......@@ -13,54 +13,40 @@ buggy. To use it, you must define the symbol %GTK_ENABLE_BROKEN
prior to including the GTK+ header files. Use #GtkTextView instead.
</para>
</warning>
A #GtkText widget allows one to display any given text and manipulate it
by deleting from one point to another, selecting a region, and various
other functions as outlined below. It is inherited from #GtkEditable.
A #GtkText widget allows one to display any given text and manipulate it
by deleting from one point to another, selecting a region, and various
other functions as outlined below. It is inherited from #GtkEditable.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
<para>
</para>
<!-- ##### STRUCT GtkText ##### -->
<para>
Most of the #GtkText-struct struct members should not be accessed directly.
Listed below are a few exceptions and how to use them.
<informaltable pgwide=1 frame="none" role="struct">
<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">
<tbody>
<row>
<entry>GtkAdjustment *hadj;</entry>
<entry>Allows you to see the state of an attached horizontal #GtkScrollbar.
See #GtkAdjustment for more info. This allows easy access to the adjustments
of the #GtkText struct without having to keep track of ones that you initialize
at widget creation.</entry>
</row>
<row>
<entry>GtkAdjustment *vadj;</entry>
<entry>Same as hadj except it involves the vertical #GtkScrollbar.</entry>
</row>
</tbody></tgroup></informaltable>
<para>
Most of the #GtkText-struct struct members should not be accessed directly.
Listed below are a few exceptions and how to use them.
</para>
@hadj: Allows you to see the state of an attached horizontal #GtkScrollbar.
See #GtkAdjustment for more info. This allows easy access to the adjustments
of the #GtkText struct without having to keep track of ones that you
initialize at widget creation.
@vadj: Same as @hadj except it involves the vertical #GtkScrollbar.
<!-- ##### STRUCT GtkTextFont ##### -->
<para>
Internal #GtkText data type.
<!-- Pretty sure.. declared in gtktext.c -->
<para>
Internal #GtkText data type.
<!-- Pretty sure.. declared in gtktext.c -->
</para>
<!-- ##### STRUCT GtkPropertyMark ##### -->
<para>
Internal #GtkText data type. Should not be access directly.
<!-- FIXME: unsure about this -->
<para>
Internal #GtkText data type. Should not be accessed directly.
<!-- FIXME: unsure about this -->
</para>
@property:
......@@ -68,12 +54,12 @@ Internal #GtkText data type. Should not be access directly.
@index:
<!-- ##### FUNCTION gtk_text_new ##### -->
<para>
Creates a new #GtkText widget, initialized with the given pointers to
#GtkAdjustments. These pointers can be used to track the viewing position
of the #GtkText widget. Passing NULL to either or both of them will make
the #GtkText create it's own. You can set these later with the function
<function>gtk_text_set_adjustment()</function>
<para>
Creates a new #GtkText widget, initialized with the given pointers to
#GtkAdjustments. These pointers can be used to track the viewing position
of the #GtkText widget. Passing %NULL to either or both of them will make
the #GtkText create it's own. You can set these later with the function
gtk_text_set_adjustment().
</para>
@hadj: horizontal adjustment.
......@@ -82,10 +68,10 @@ the #GtkText create it's own. You can set these later with the function
<!-- ##### FUNCTION gtk_text_set_editable ##### -->
<para>
Set whether the #GtkText widget can be edited by the user or not. This
still allows you the programmer to make changes with the various #GtkText
functions.
<para>
Sets whether the #GtkText widget can be edited by the user or not. This
still allows you the programmer to make changes with the various #GtkText
functions.
</para>
@text: the #GtkText widget
......@@ -93,9 +79,9 @@ functions.
<!-- ##### FUNCTION gtk_text_set_word_wrap ##### -->
<para>
Sets whether the #GtkText widget wraps words down to the next line if it
can't be completed on the current line.
<para>
Sets whether the #GtkText widget wraps words down to the next line if it
can't be completed on the current line.
</para>
@text: the #GtkText widget
......@@ -103,12 +89,12 @@ can't be completed on the current line.
<!-- ##### FUNCTION gtk_text_set_line_wrap ##### -->
<para>
Controls how #GtkText handles long lines of continuous text. If line wrap
is on, the line is broken when it reaches the extent of the #GtkText widget
viewing area and the rest is displayed on the next line. If it is not set,
the line continues regardless size of current viewing area. Similar to word
wrap but it disregards word boundaries.
<para>
Controls how #GtkText handles long lines of continuous text. If line wrap
is on, the line is broken when it reaches the extent of the #GtkText widget
viewing area and the rest is displayed on the next line. If it is not set,
the line continues regardless size of current viewing area. Similar to word
wrap but it disregards word boundaries.
</para>
@text: the #GtkText widget
......@@ -116,9 +102,9 @@ wrap but it disregards word boundaries.
<!-- ##### FUNCTION gtk_text_set_adjustments ##### -->
<para>
Allows you to set #GtkAdjustment pointers which in turn allows you to
keep track of the viewing position of the #GtkText widget.
<para>
Allows you to set #GtkAdjustment pointers which in turn allows you to
keep track of the viewing position of the #GtkText widget.
</para>
@text: the #GtkText widget
......@@ -127,10 +113,10 @@ keep track of the viewing position of the #GtkText widget.
<!-- ##### FUNCTION gtk_text_set_point ##### -->
<para>
Sets the cursor at the given point. In this case a point constitutes
the number of characters from the extreme upper left corner of the #GtkText
widget.
<para>
Sets the cursor at the given point. In this case a point constitutes
the number of characters from the extreme upper left corner of the #GtkText
widget.
</para>
@text: the #GtkText widget
......@@ -138,9 +124,9 @@ widget.
<!-- ##### FUNCTION gtk_text_get_point ##### -->
<para>
Gets the current position of the cursor as the number of characters from
the upper left corner of the #GtkText widget.
<para>
Gets the current position of the cursor as the number of characters from
the upper left corner of the #GtkText widget.
</para>
@text: the #GtkText widget
......@@ -148,9 +134,9 @@ the upper left corner of the #GtkText widget.
<!-- ##### FUNCTION gtk_text_get_length ##### -->
<para>
Returns the length of the all the text contained within the #GtkText widget;
disregards current point position.
<para>
Returns the length of the all the text contained within the #GtkText widget;
disregards current point position.
</para>
@text: the #GtkText widget
......@@ -158,28 +144,28 @@ disregards current point position.
<!-- ##### FUNCTION gtk_text_freeze ##### -->
<para>
Freezes the #GtkText widget which disallows redrawing of the widget until
it is thawed. This is useful if a large number of changes are going to
made to the text within the widget, reducing the amount of flicker seen
by the user.
<para>
Freezes the #GtkText widget which disallows redrawing of the widget until
it is thawed. This is useful if a large number of changes are going to
made to the text within the widget, reducing the amount of flicker seen
by the user.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_thaw ##### -->
<para>
Allows the #GtkText widget to be redrawn again by GTK.
<para>
Allows the #GtkText widget to be redrawn again by GTK.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_insert ##### -->
<para>
Inserts given text into the #GtkText widget with the given properties as
outlined below.
<para>
Inserts given text into the #GtkText widget with the given properties as
outlined below.
</para>
@text: the #GtkText widget
......@@ -187,14 +173,14 @@ outlined below.
@fore: the foreground color to insert with
@back: the background color to insert with
@chars: the actual text to be inserted
@length: the length of the text to be inserted, passing -1 makes it insert
@length: the length of the text to be inserted, passing -1 makes it insert
all the text.
<!-- ##### FUNCTION gtk_text_backward_delete ##### -->
<para>
Deletes from the current point position backward the given number of
characters.
<para>
Deletes from the current point position backward the given number of
characters.
</para>
@text: the #GtkText widget
......@@ -203,9 +189,9 @@ characters.
<!-- ##### FUNCTION gtk_text_forward_delete ##### -->
<para>
Deletes from the current point position forward the given number of
characters.
<para>
Deletes from the current point position forward the given number of
characters.
</para>
@text: the #GtkText widget
......@@ -214,8 +200,8 @@ characters.
<!-- ##### MACRO GTK_TEXT_INDEX ##### -->
<para>