Commit 13e498ca authored by Matthias Clasen's avatar Matthias Clasen

Typo fixes.

        * gtk/gtkstyle.h: Typo fixes.

        * gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.

        * gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.

        * gtk/tmpl/gtktypeutils.sgml, gtk/tmpl/gtkobject.sgml,
        gtk/tmpl/gtkstyle.sgml: Add docs.
parent 9fd70c6b
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/gtkstyle.h: Typo fixes.
* gtk/gtkstyle.c, gtk/gtktoolbar.c: Add docs.
* gtk/gtkrc.c (gtk_rc_find_pixmap_in_path): Fix docs.
Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com> Fri Dec 7 16:05:22 2001 Owen Taylor <otaylor@redhat.com>
* modules/input/gtkimcontextxim.c: Display the XIM * modules/input/gtkimcontextxim.c: Display the XIM
......
2001-12-07 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtktypeutils.sgml, gtk/tmpl/gtkobject.sgml,
gtk/tmpl/gtkstyle.sgml: Add docs.
2001-12-06 Matthias Clasen <matthiasc@poet.de> 2001-12-06 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383) * gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383)
......
...@@ -20,7 +20,7 @@ owned by the creator of the #GObject. (The owner of a reference is the code ...@@ -20,7 +20,7 @@ owned by the creator of the #GObject. (The owner of a reference is the code
section that has the right to call g_object_unref() in order to remove that section that has the right to call g_object_unref() in order to remove that
reference.) A #GtkObject is created with a reference count of 1 also, but it reference.) A #GtkObject is created with a reference count of 1 also, but it
isn't owned by anyone; calling g_object_unref() on the newly-created #GtkObject isn't owned by anyone; calling g_object_unref() on the newly-created #GtkObject
is incorrect. Instead, the initial reference count of a #GtkObject is "floating." is incorrect. Instead, the initial reference count of a #GtkObject is "floating".
The floating reference can be removed by anyone at any time, by calling The floating reference can be removed by anyone at any time, by calling
gtk_object_sink(). gtk_object_sink() does nothing if an object is already gtk_object_sink(). gtk_object_sink() does nothing if an object is already
sunk (has no floating reference). sunk (has no floating reference).
...@@ -93,27 +93,25 @@ explicitly call g_object_ref() yourself. </para></listitem> ...@@ -93,27 +93,25 @@ explicitly call g_object_ref() yourself. </para></listitem>
<!-- ##### STRUCT GtkObject ##### --> <!-- ##### STRUCT GtkObject ##### -->
<para> <para>
The object itself. You should never use these members directly- The object itself. You should never use these members directly -
instead you the accessing macros. use the accessing macros instead.
</para> </para>
<!-- ##### MACRO GTK_OBJECT_TYPE ##### --> <!-- ##### MACRO GTK_OBJECT_TYPE ##### -->
<para> <para>
Get the type of an object. Gets the type of an object.
</para> </para>
@object: @object: a #GtkObject.
<!-- # Unused Parameters # -->
@obj: the object whose type we wish to get.
<!-- ##### MACRO GTK_OBJECT_TYPE_NAME ##### --> <!-- ##### MACRO GTK_OBJECT_TYPE_NAME ##### -->
<para> <para>
Gets the name of an objects type.
</para> </para>
@object: @object: a #GtkObject.
<!-- ##### ENUM GtkObjectFlags ##### --> <!-- ##### ENUM GtkObjectFlags ##### -->
...@@ -133,7 +131,7 @@ object. ...@@ -133,7 +131,7 @@ object.
<!-- ##### MACRO GTK_OBJECT_FLAGS ##### --> <!-- ##### MACRO GTK_OBJECT_FLAGS ##### -->
<para> <para>
Get the #GtkObjectFlags for an object without directly Gets the #GtkObjectFlags for an object without directly
accessing its members. accessing its members.
</para> </para>
...@@ -151,7 +149,7 @@ See the overview documentation for #GtkObject. ...@@ -151,7 +149,7 @@ See the overview documentation for #GtkObject.
<!-- ##### MACRO GTK_OBJECT_CONNECTED ##### --> <!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
<para> <para>
Test whether a GtkObject has had a signal connected to it. Tests whether a #GtkObject has had a signal connected to it.
</para> </para>
@obj: the object to examine. @obj: the object to examine.
...@@ -159,7 +157,7 @@ Test whether a GtkObject has had a signal connected to it. ...@@ -159,7 +157,7 @@ Test whether a GtkObject has had a signal connected to it.
<!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### --> <!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
<para> <para>
Turn on certain object flags. (Private) Turns on certain object flags. (Private)
</para> </para>
@obj: the object to affect. @obj: the object to affect.
...@@ -168,7 +166,7 @@ Turn on certain object flags. (Private) ...@@ -168,7 +166,7 @@ Turn on certain object flags. (Private)
<!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### --> <!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
<para> <para>
Turn off certain object flags. (Private) Turns off certain object flags. (Private)
</para> </para>
@obj: the object to affect. @obj: the object to affect.
...@@ -193,20 +191,18 @@ each child. Used by #GtkContainer. ...@@ -193,20 +191,18 @@ each child. Used by #GtkContainer.
<!-- ##### FUNCTION gtk_object_new ##### --> <!-- ##### FUNCTION gtk_object_new ##### -->
<para> <para>
Construct an object given its arguments, enumerated in the call to the Constructs an object given its arguments, enumerated in the call to the
function. Deprecated in favor of g_object_new(). function. Deprecated in favor of g_object_new().
</para> </para>
@type: the type identifying this object. Returned by gtk_type_unique() @type: the type identifying this object. Returned by gtk_type_unique()
although (for a properly-written object it should be accessible through (although for a properly-written object it should be accessible through
#GTK_TYPE_FOO.) a #GTK_TYPE_FOO macro.)
@first_property_name: @first_property_name: name of the first property to set when constructing
the object.
@Varargs: the first argument's value, followed by any number of @Varargs: the first argument's value, followed by any number of
name/argument-value pairs, terminated with NULL. name/argument-value pairs, terminated with %NULL.
@Returns: the new GtkObject. @Returns: the new #GtkObject.
<!-- # Unused Parameters # -->
@first_arg_name: name of the first argument to set when constructing
the object.
<!-- ##### FUNCTION gtk_object_sink ##### --> <!-- ##### FUNCTION gtk_object_sink ##### -->
...@@ -221,20 +217,19 @@ the top of the page. ...@@ -221,20 +217,19 @@ the top of the page.
<!-- ##### FUNCTION gtk_object_ref ##### --> <!-- ##### FUNCTION gtk_object_ref ##### -->
<para> <para>
Increase the reference count of the object, simply calls Increases the reference count of the object.
g_object_ref() internally.
Deprecated in favor of g_object_ref(). Deprecated in favor of g_object_ref().
</para> </para>
@object: the object to reference. @object: the object to reference.
@Returns: the object which was referenced @Returns: @object.
<!-- ##### FUNCTION gtk_object_unref ##### --> <!-- ##### FUNCTION gtk_object_unref ##### -->
<para> <para>
Decrease the reference count of an object. When its reference count drops to 0, Decreases the reference count of an object. When its reference count drops
the object is finalized (i.e. its memory is freed). Deprecated in favor of to 0, the object is finalized (i.e. its memory is freed). Deprecated in
g_object_unref(). Simply calls g_object_unref() internally. favor of g_object_unref().
</para> </para>
@object: the object to dereference. @object: the object to dereference.
...@@ -281,22 +276,17 @@ reference holders to release their references, it does not free the object. ...@@ -281,22 +276,17 @@ reference holders to release their references, it does not free the object.
<!-- ##### FUNCTION gtk_object_get ##### --> <!-- ##### FUNCTION gtk_object_get ##### -->
<para> <para>
Get properties of an object. Deprecated in favor of g_object_get(). It takes an Gets properties of an object. Deprecated in favor of g_object_get().
object, then a list of name/return location pairs in a list, followed by NULL.
</para> </para>
@object: a #GtkObject @object: a #GtkObject.
@first_property_name: name of first property to get the value for @first_property_name: name of first property to get the value for.
@Varargs: list of name-return location pairs. @Varargs: %NULL-terminated list of name-return location pairs.
<!-- ##### FUNCTION gtk_object_set ##### --> <!-- ##### FUNCTION gtk_object_set ##### -->
<para> <para>
Set properties on an object. Deprecated in favor of g_object_set(). Sets properties on an object. Deprecated in favor of g_object_set().
</para>
<para>
It takes an object, then a list of name/value pairs
in a list, followed by NULL.
</para> </para>
<para> <para>
<informalexample> <informalexample>
...@@ -311,10 +301,10 @@ void set_box_properties(GtkBox* box) ...@@ -311,10 +301,10 @@ void set_box_properties(GtkBox* box)
</informalexample> </informalexample>
</para> </para>
@object: the object whose arguments should be set. @object: a #GtkObject.
@first_property_name: name of the first property to set @first_property_name: name of the first property to set
@Varargs: the value of the first argument, followed optionally @Varargs: the value of the first argument, followed optionally
by more name/value pairs, followed by NULL. by more name/value pairs, followed by %NULL.
<!-- ##### FUNCTION gtk_object_set_data ##### --> <!-- ##### FUNCTION gtk_object_set_data ##### -->
...@@ -351,7 +341,7 @@ gtk_object_remove_data() or when the object is destroyed. ...@@ -351,7 +341,7 @@ gtk_object_remove_data() or when the object is destroyed.
<para> <para>
Deprecated in favor of setting object data to %NULL using g_object_set_data(). Deprecated in favor of setting object data to %NULL using g_object_set_data().
Removes a specified datum from the object's data associations (the object_data). Removes a specified datum from the object's data associations (the object_data).
Subsequent calls to gtk_object_get_data() will return NULL. Subsequent calls to gtk_object_get_data() will return %NULL.
</para> </para>
<para> <para>
If you specified a destroy handler with gtk_object_set_data_full(), If you specified a destroy handler with gtk_object_set_data_full(),
...@@ -370,7 +360,7 @@ Get a named field from the object's table of associations (the object_data). ...@@ -370,7 +360,7 @@ Get a named field from the object's table of associations (the object_data).
@object: the object maintaining the associations. @object: the object maintaining the associations.
@key: name of the key for that association. @key: name of the key for that association.
@Returns: the data if found, or NULL if no such data exists. @Returns: the data if found, or %NULL if no such data exists.
<!-- ##### FUNCTION gtk_object_remove_no_notify ##### --> <!-- ##### FUNCTION gtk_object_remove_no_notify ##### -->
...@@ -393,7 +383,7 @@ Therefore this only affects data set using gtk_object_set_data_full(). ...@@ -393,7 +383,7 @@ Therefore this only affects data set using gtk_object_set_data_full().
<para> <para>
Deprecated in favor of g_object_set_data(). Deprecated in favor of g_object_set_data().
For convenience, every object offers a generic user data For convenience, every object offers a generic user data
pointer. The function set it. pointer. This function sets it.
</para> </para>
<para> <para>
This function is equivalent to: This function is equivalent to:
...@@ -483,7 +473,7 @@ to get an id from a string. ...@@ -483,7 +473,7 @@ to get an id from a string.
@object: object containing the associations. @object: object containing the associations.
@data_id: quark of the key. @data_id: quark of the key.
@Returns: the data if found, or NULL if no such data exists. @Returns: the data if found, or %NULL if no such data exists.
<!-- ##### FUNCTION gtk_object_remove_data_by_id ##### --> <!-- ##### FUNCTION gtk_object_remove_data_by_id ##### -->
...@@ -494,7 +484,7 @@ a #GQuark instead of a string, so it is slightly faster. ...@@ -494,7 +484,7 @@ a #GQuark instead of a string, so it is slightly faster.
</para> </para>
<para> <para>
Remove a specified datum from the object's data associations. Remove a specified datum from the object's data associations.
Subsequent calls to gtk_object_get_data() will return NULL. Subsequent calls to gtk_object_get_data() will return %NULL.
</para> </para>
<para> <para>
Use gtk_object_data_try_key() and gtk_object_data_force_id() Use gtk_object_data_try_key() and gtk_object_data_force_id()
...@@ -517,9 +507,9 @@ to get an id from a string. ...@@ -517,9 +507,9 @@ to get an id from a string.
</para> </para>
@object: object containing the associations. @object: object containing the associations.
@key_id: @key_id: quark of the key.
<!-- # Unused Parameters # --> <!-- # Unused Parameters # -->
@data_id: quark of the key. @data_id:
<!-- ##### MACRO gtk_object_data_try_key ##### --> <!-- ##### MACRO gtk_object_data_try_key ##### -->
......
...@@ -16,17 +16,17 @@ Styles ...@@ -16,17 +16,17 @@ Styles
<!-- ##### MACRO GTK_STYLE_NUM_STYLECOLORS ##### --> <!-- ##### MACRO GTK_STYLE_NUM_STYLECOLORS ##### -->
<para> <para>
The number of colors used in a style.
</para> </para>
<!-- ##### MACRO GTK_STYLE_ATTACHED ##### --> <!-- ##### MACRO GTK_STYLE_ATTACHED ##### -->
<para> <para>
Returns whether the styleis attached to a window.
</para> </para>
@style: @style: a #GtkStyle.
<!-- ##### STRUCT GtkStyle ##### --> <!-- ##### STRUCT GtkStyle ##### -->
......
...@@ -19,14 +19,15 @@ managed at runtime. ...@@ -19,14 +19,15 @@ managed at runtime.
<para> <para>
@GtkType is unique integer identifying the type. The guts of the @GtkType is unique integer identifying the type. The guts of the
information about the type is held in a private struct named information about the type is held in a private struct named
GtkTypeNode. #GtkTypeNode.
</para> </para>
<!-- ##### ENUM GtkFundamentalType ##### --> <!-- ##### ENUM GtkFundamentalType ##### -->
<para> <para>
@GtkFundamentalType is an enumerated type which lists all the possible #GtkFundamentalType is an enumerated type which lists all the possible
fundamental types (e.g. char, uchar, int, long, float, etc). fundamental types (e.g. <type>char</type>, <type>uchar</type>, <type>int</type>,
<type>long</type>, <type>float</type>, etc).
</para> </para>
@GTK_TYPE_INVALID: @GTK_TYPE_INVALID:
...@@ -48,26 +49,26 @@ fundamental types (e.g. char, uchar, int, long, float, etc). ...@@ -48,26 +49,26 @@ fundamental types (e.g. char, uchar, int, long, float, etc).
<!-- ##### MACRO GTK_CLASS_NAME ##### --> <!-- ##### MACRO GTK_CLASS_NAME ##### -->
<para> <para>
Returns the type name of @class.
</para> </para>
@class: @class: a #GtkTypeClass.
<!-- ##### MACRO GTK_CLASS_TYPE ##### --> <!-- ##### MACRO GTK_CLASS_TYPE ##### -->
<para> <para>
Returns the type of @class.
</para> </para>
@class: @class: a #GtkTypeClass.
<!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### --> <!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### -->
<para> <para>
Returns %TRUE if @type is a %GTK_TYPE_OBJECT.
</para> </para>
@type: @type: a #GtkType.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### --> <!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### -->
...@@ -79,14 +80,14 @@ The highest-numbered structured or flat enumerated type value. ...@@ -79,14 +80,14 @@ The highest-numbered structured or flat enumerated type value.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### --> <!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### -->
<para> <para>
The highest maximum fundamental enumerated type value. The maximum fundamental enumerated type value.
</para> </para>
<!-- ##### MACRO GTK_STRUCT_OFFSET ##### --> <!-- ##### MACRO GTK_STRUCT_OFFSET ##### -->
<para> <para>
Use in place of offsetof(), which is used if it exists. Use in place of <function>offsetof()</function>, which is used if it exists.
</para> </para>
<!-- # Unused Parameters # --> <!-- # Unused Parameters # -->
...@@ -96,7 +97,7 @@ Use in place of offsetof(), which is used if it exists. ...@@ -96,7 +97,7 @@ Use in place of offsetof(), which is used if it exists.
<!-- ##### MACRO GTK_CHECK_CAST ##### --> <!-- ##### MACRO GTK_CHECK_CAST ##### -->
<para> <para>
Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is Casts the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
defined, just cast it. Otherwise, check to see if we can cast @tobj defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast. into a @cast.
</para> </para>
...@@ -109,7 +110,7 @@ into a @cast. ...@@ -109,7 +110,7 @@ into a @cast.
<!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### --> <!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
<para> <para>
Cast the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is Casts the object in @tobj into @cast. If GTK_NO_CHECK_CASTS is
defined, just cast it. Otherwise, check to see if we can cast @tobj defined, just cast it. Otherwise, check to see if we can cast @tobj
into a @cast. into a @cast.
</para> </para>
...@@ -149,7 +150,7 @@ Determines whether @type_class is a type of @otype. ...@@ -149,7 +150,7 @@ Determines whether @type_class is a type of @otype.
<!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### --> <!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
<para> <para>
Convert a gtk type into a fundamental type Converts a Gtk type into a fundamental type.
</para> </para>
<!-- # Unused Parameters # --> <!-- # Unused Parameters # -->
...@@ -158,7 +159,7 @@ Convert a gtk type into a fundamental type ...@@ -158,7 +159,7 @@ Convert a gtk type into a fundamental type
<!-- ##### MACRO GTK_SIGNAL_FUNC ##### --> <!-- ##### MACRO GTK_SIGNAL_FUNC ##### -->
<para> <para>
Just a macroized cast into a GtkSignalFunc Just a macroized cast into a #GtkSignalFunc.
</para> </para>
@f: @f:
...@@ -166,26 +167,26 @@ Just a macroized cast into a GtkSignalFunc ...@@ -166,26 +167,26 @@ Just a macroized cast into a GtkSignalFunc
<!-- ##### TYPEDEF GtkClassInitFunc ##### --> <!-- ##### TYPEDEF GtkClassInitFunc ##### -->
<para> <para>
Define a function pointer. Defines a function pointer.
</para> </para>
<!-- ##### TYPEDEF GtkObjectInitFunc ##### --> <!-- ##### TYPEDEF GtkObjectInitFunc ##### -->
<para> <para>
Define a function pointer. Defines a function pointer.
</para> </para>
<!-- ##### USER_FUNCTION GtkSignalFunc ##### --> <!-- ##### USER_FUNCTION GtkSignalFunc ##### -->
<para> <para>
Define a function pointer. Defines a function pointer.
</para> </para>
<!-- ##### USER_FUNCTION GtkFunction ##### --> <!-- ##### USER_FUNCTION GtkFunction ##### -->
<para> <para>
Define a function pointer. Defines a function pointer.
</para> </para>
@data: gpointer @data: gpointer
...@@ -194,7 +195,7 @@ Define a function pointer. ...@@ -194,7 +195,7 @@ Define a function pointer.
<!-- ##### USER_FUNCTION GtkDestroyNotify ##### --> <!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
<para>