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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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>
* 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
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
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
gtk_object_sink(). gtk_object_sink() does nothing if an object is already
sunk (has no floating reference).
......@@ -93,27 +93,25 @@ explicitly call g_object_ref() yourself. </para></listitem>
<!-- ##### STRUCT GtkObject ##### -->
<para>
The object itself. You should never use these members directly-
instead you the accessing macros.
The object itself. You should never use these members directly -
use the accessing macros instead.
</para>
<!-- ##### MACRO GTK_OBJECT_TYPE ##### -->
<para>
Get the type of an object.
Gets the type of an object.
</para>
@object:
<!-- # Unused Parameters # -->
@obj: the object whose type we wish to get.
@object: a #GtkObject.
<!-- ##### MACRO GTK_OBJECT_TYPE_NAME ##### -->
<para>
Gets the name of an objects type.
</para>
@object:
@object: a #GtkObject.
<!-- ##### ENUM GtkObjectFlags ##### -->
......@@ -133,7 +131,7 @@ object.
<!-- ##### MACRO GTK_OBJECT_FLAGS ##### -->
<para>
Get the #GtkObjectFlags for an object without directly
Gets the #GtkObjectFlags for an object without directly
accessing its members.
</para>
......@@ -151,7 +149,7 @@ See the overview documentation for #GtkObject.
<!-- ##### MACRO GTK_OBJECT_CONNECTED ##### -->
<para>
Test whether a GtkObject has had a signal connected to it.
Tests whether a #GtkObject has had a signal connected to it.
</para>
@obj: the object to examine.
......@@ -159,7 +157,7 @@ Test whether a GtkObject has had a signal connected to it.
<!-- ##### MACRO GTK_OBJECT_SET_FLAGS ##### -->
<para>
Turn on certain object flags. (Private)
Turns on certain object flags. (Private)
</para>
@obj: the object to affect.
......@@ -168,7 +166,7 @@ Turn on certain object flags. (Private)
<!-- ##### MACRO GTK_OBJECT_UNSET_FLAGS ##### -->
<para>
Turn off certain object flags. (Private)
Turns off certain object flags. (Private)
</para>
@obj: the object to affect.
......@@ -193,20 +191,18 @@ each child. Used by #GtkContainer.
<!-- ##### FUNCTION gtk_object_new ##### -->
<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().
</para>
@type: the type identifying this object. Returned by gtk_type_unique()
although (for a properly-written object it should be accessible through
#GTK_TYPE_FOO.)
@first_property_name:
(although for a properly-written object it should be accessible through
a #GTK_TYPE_FOO macro.)
@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
name/argument-value pairs, terminated with NULL.
@Returns: the new GtkObject.
<!-- # Unused Parameters # -->
@first_arg_name: name of the first argument to set when constructing
the object.
name/argument-value pairs, terminated with %NULL.
@Returns: the new #GtkObject.
<!-- ##### FUNCTION gtk_object_sink ##### -->
......@@ -221,20 +217,19 @@ the top of the page.
<!-- ##### FUNCTION gtk_object_ref ##### -->
<para>
Increase the reference count of the object, simply calls
g_object_ref() internally.
Increases the reference count of the object.
Deprecated in favor of g_object_ref().
</para>
@object: the object to reference.
@Returns: the object which was referenced
@Returns: @object.
<!-- ##### FUNCTION gtk_object_unref ##### -->
<para>
Decrease the reference count of an object. When its reference count drops to 0,
the object is finalized (i.e. its memory is freed). Deprecated in favor of
g_object_unref(). Simply calls g_object_unref() internally.
Decreases the reference count of an object. When its reference count drops
to 0, the object is finalized (i.e. its memory is freed). Deprecated in
favor of g_object_unref().
</para>
@object: the object to dereference.
......@@ -281,22 +276,17 @@ reference holders to release their references, it does not free the object.
<!-- ##### FUNCTION gtk_object_get ##### -->
<para>
Get properties of an object. Deprecated in favor of g_object_get(). It takes an
object, then a list of name/return location pairs in a list, followed by NULL.
Gets properties of an object. Deprecated in favor of g_object_get().
</para>
@object: a #GtkObject
@first_property_name: name of first property to get the value for
@Varargs: list of name-return location pairs.
@object: a #GtkObject.
@first_property_name: name of first property to get the value for.
@Varargs: %NULL-terminated list of name-return location pairs.
<!-- ##### FUNCTION gtk_object_set ##### -->
<para>
Set 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.
Sets properties on an object. Deprecated in favor of g_object_set().
</para>
<para>
<informalexample>
......@@ -311,10 +301,10 @@ void set_box_properties(GtkBox* box)
</informalexample>
</para>
@object: the object whose arguments should be set.
@object: a #GtkObject.
@first_property_name: name of the first property to set
@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 ##### -->
......@@ -351,7 +341,7 @@ gtk_object_remove_data() or when the object is destroyed.
<para>
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).
Subsequent calls to gtk_object_get_data() will return NULL.
Subsequent calls to gtk_object_get_data() will return %NULL.
</para>
<para>
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).
@object: the object maintaining the associations.
@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 ##### -->
......@@ -393,7 +383,7 @@ Therefore this only affects data set using gtk_object_set_data_full().
<para>
Deprecated in favor of g_object_set_data().
For convenience, every object offers a generic user data
pointer. The function set it.
pointer. This function sets it.
</para>
<para>
This function is equivalent to:
......@@ -483,7 +473,7 @@ to get an id from a string.
@object: object containing the associations.
@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 ##### -->
......@@ -494,7 +484,7 @@ a #GQuark instead of a string, so it is slightly faster.
</para>
<para>
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>
Use gtk_object_data_try_key() and gtk_object_data_force_id()
......@@ -517,9 +507,9 @@ to get an id from a string.
</para>
@object: object containing the associations.
@key_id:
@key_id: quark of the key.
<!-- # Unused Parameters # -->
@data_id: quark of the key.
@data_id:
<!-- ##### MACRO gtk_object_data_try_key ##### -->
......
......@@ -16,17 +16,17 @@ Styles
<!-- ##### MACRO GTK_STYLE_NUM_STYLECOLORS ##### -->
<para>
The number of colors used in a style.
</para>
<!-- ##### MACRO GTK_STYLE_ATTACHED ##### -->
<para>
Returns whether the styleis attached to a window.
</para>
@style:
@style: a #GtkStyle.
<!-- ##### STRUCT GtkStyle ##### -->
......
......@@ -19,14 +19,15 @@ managed at runtime.
<para>
@GtkType is unique integer identifying the type. The guts of the
information about the type is held in a private struct named
GtkTypeNode.
#GtkTypeNode.
</para>
<!-- ##### ENUM GtkFundamentalType ##### -->
<para>
@GtkFundamentalType is an enumerated type which lists all the possible
fundamental types (e.g. char, uchar, int, long, float, etc).
#GtkFundamentalType is an enumerated type which lists all the possible
fundamental types (e.g. <type>char</type>, <type>uchar</type>, <type>int</type>,
<type>long</type>, <type>float</type>, etc).
</para>
@GTK_TYPE_INVALID:
......@@ -48,26 +49,26 @@ fundamental types (e.g. char, uchar, int, long, float, etc).
<!-- ##### MACRO GTK_CLASS_NAME ##### -->
<para>
Returns the type name of @class.
</para>
@class:
@class: a #GtkTypeClass.
<!-- ##### MACRO GTK_CLASS_TYPE ##### -->
<para>
Returns the type of @class.
</para>
@class:
@class: a #GtkTypeClass.
<!-- ##### MACRO GTK_TYPE_IS_OBJECT ##### -->
<para>
Returns %TRUE if @type is a %GTK_TYPE_OBJECT.
</para>
@type:
@type: a #GtkType.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_LAST ##### -->
......@@ -79,14 +80,14 @@ The highest-numbered structured or flat enumerated type value.
<!-- ##### MACRO GTK_TYPE_FUNDAMENTAL_MAX ##### -->
<para>
The highest maximum fundamental enumerated type value.
The maximum fundamental enumerated type value.
</para>
<!-- ##### MACRO GTK_STRUCT_OFFSET ##### -->
<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>
<!-- # Unused Parameters # -->
......@@ -96,7 +97,7 @@ Use in place of offsetof(), which is used if it exists.
<!-- ##### MACRO GTK_CHECK_CAST ##### -->
<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
into a @cast.
</para>
......@@ -109,7 +110,7 @@ into a @cast.
<!-- ##### MACRO GTK_CHECK_CLASS_CAST ##### -->
<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
into a @cast.
</para>
......@@ -149,7 +150,7 @@ Determines whether @type_class is a type of @otype.
<!-- ##### MACRO GTK_FUNDAMENTAL_TYPE ##### -->
<para>
Convert a gtk type into a fundamental type
Converts a Gtk type into a fundamental type.
</para>
<!-- # Unused Parameters # -->
......@@ -158,7 +159,7 @@ Convert a gtk type into a fundamental type
<!-- ##### MACRO GTK_SIGNAL_FUNC ##### -->
<para>
Just a macroized cast into a GtkSignalFunc
Just a macroized cast into a #GtkSignalFunc.
</para>
@f:
......@@ -166,26 +167,26 @@ Just a macroized cast into a GtkSignalFunc
<!-- ##### TYPEDEF GtkClassInitFunc ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
<!-- ##### TYPEDEF GtkObjectInitFunc ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkSignalFunc ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
<!-- ##### USER_FUNCTION GtkFunction ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
@data: gpointer
......@@ -194,7 +195,7 @@ Define a function pointer.
<!-- ##### USER_FUNCTION GtkDestroyNotify ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
@data: gpointer
......@@ -202,7 +203,7 @@ Define a function pointer.
<!-- ##### USER_FUNCTION GtkCallbackMarshal ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
@object: GtkObject*
......@@ -213,15 +214,15 @@ Define a function pointer.
<!-- ##### TYPEDEF GtkSignalMarshaller ##### -->
<para>
Define a function pointer.
Defines a function pointer.
</para>
<!-- ##### TYPEDEF GtkTypeObject ##### -->
<para>
A GtkTypeObject defines the minimum structure requirements
A #GtkTypeObject defines the minimum structure requirements
for type instances. Type instances returned from gtk_type_new ()
and initialized through a GtkObjectInitFunc need to directly inherit
and initialized through a #GtkObjectInitFunc need to directly inherit
from this structure or at least copy its fields one by one.
</para>
......@@ -236,260 +237,260 @@ This is a structure that we use to pass in typed values (and names).
<!-- ##### MACRO GTK_VALUE_CHAR ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CHAR
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_CHAR.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UCHAR ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UCHAR
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UCHAR.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOOL ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOOL
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOOL.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_INT ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_INT
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_INT.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_UINT ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_UINT
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_UINT.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_LONG ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_LONG
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_LONG.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ULONG ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ULONG
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ULONG.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLOAT ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLOAT
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLOAT.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_DOUBLE ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_DOUBLE
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_DOUBLE.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_STRING ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_STRING
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_STRING.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_ENUM ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ENUM
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_ENUM.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_FLAGS ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_FLAGS
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_FLAGS.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_BOXED ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_BOXED
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_BOXED.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_POINTER ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_POINTER
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_POINTER.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_OBJECT ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_OBJECT
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_OBJECT.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_VALUE_SIGNAL ##### -->
<para>
Use to get the value of a GtkArg whose GtkType is GTK_TYPE_SIGNAL
Gets the value of a #GtkArg whose #GtkType is %GTK_TYPE_SIGNAL.
</para>
@a:
@a: a #GtkArg.
<!-- ##### MACRO GTK_RETLOC_CHAR ##### -->
<para>
If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_CHAR
If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_CHAR.
</para>
@a:
@a: a #GtkArg.