From 13e498cae8da158547032920e0db2a30708c8011 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Fri, 7 Dec 2001 23:39:54 +0000 Subject: [PATCH] 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. --- ChangeLog | 8 + ChangeLog.pre-2-0 | 8 + ChangeLog.pre-2-10 | 8 + ChangeLog.pre-2-2 | 8 + ChangeLog.pre-2-4 | 8 + ChangeLog.pre-2-6 | 8 + ChangeLog.pre-2-8 | 8 + docs/reference/ChangeLog | 5 + docs/reference/gtk/tmpl/gtkobject.sgml | 84 ++++---- docs/reference/gtk/tmpl/gtkstyle.sgml | 6 +- docs/reference/gtk/tmpl/gtktypeutils.sgml | 252 +++++++++++----------- gtk/gtkrc.c | 2 +- gtk/gtkstyle.c | 32 +++ gtk/gtkstyle.h | 4 +- gtk/gtktoolbar.c | 57 +++++ 15 files changed, 320 insertions(+), 178 deletions(-) diff --git a/ChangeLog b/ChangeLog index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-0 b/ChangeLog.pre-2-0 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-0 +++ b/ChangeLog.pre-2-0 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 09bab640cb..8648c1ef33 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,11 @@ +2001-12-07 Matthias Clasen + + * 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 * modules/input/gtkimcontextxim.c: Display the XIM diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 62ed5c63d4..bef27ef1a1 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,8 @@ +2001-12-07 Matthias Clasen + + * gtk/tmpl/gtktypeutils.sgml, gtk/tmpl/gtkobject.sgml, + gtk/tmpl/gtkstyle.sgml: Add docs. + 2001-12-06 Matthias Clasen * gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383) diff --git a/docs/reference/gtk/tmpl/gtkobject.sgml b/docs/reference/gtk/tmpl/gtkobject.sgml index 3892f166af..c699e465e1 100644 --- a/docs/reference/gtk/tmpl/gtkobject.sgml +++ b/docs/reference/gtk/tmpl/gtkobject.sgml @@ -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. -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. -Get the type of an object. +Gets the type of an object. -@object: - -@obj: the object whose type we wish to get. +@object: a #GtkObject. - +Gets the name of an objects type. -@object: +@object: a #GtkObject. @@ -133,7 +131,7 @@ object. -Get the #GtkObjectFlags for an object without directly +Gets the #GtkObjectFlags for an object without directly accessing its members. @@ -151,7 +149,7 @@ See the overview documentation for #GtkObject. -Test whether a GtkObject has had a signal connected to it. +Tests whether a #GtkObject has had a signal connected to it. @obj: the object to examine. @@ -159,7 +157,7 @@ Test whether a GtkObject has had a signal connected to it. -Turn on certain object flags. (Private) +Turns on certain object flags. (Private) @obj: the object to affect. @@ -168,7 +166,7 @@ Turn on certain object flags. (Private) -Turn off certain object flags. (Private) +Turns off certain object flags. (Private) @obj: the object to affect. @@ -193,20 +191,18 @@ each child. Used by #GtkContainer. -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(). @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. - -@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. @@ -221,20 +217,19 @@ the top of the page. -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(). @object: the object to reference. -@Returns: the object which was referenced +@Returns: @object. -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(). @object: the object to dereference. @@ -281,22 +276,17 @@ reference holders to release their references, it does not free the object. -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(). -@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. -Set properties on an object. Deprecated in favor of g_object_set(). - - -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(). @@ -311,10 +301,10 @@ void set_box_properties(GtkBox* box) -@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. @@ -351,7 +341,7 @@ gtk_object_remove_data() or when the object is destroyed. 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. 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. @@ -393,7 +383,7 @@ Therefore this only affects data set using gtk_object_set_data_full(). 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. 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. @@ -494,7 +484,7 @@ a #GQuark instead of a string, so it is slightly faster. 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. Use gtk_object_data_try_key() and gtk_object_data_force_id() @@ -517,9 +507,9 @@ to get an id from a string. @object: object containing the associations. -@key_id: +@key_id: quark of the key. -@data_id: quark of the key. +@data_id: diff --git a/docs/reference/gtk/tmpl/gtkstyle.sgml b/docs/reference/gtk/tmpl/gtkstyle.sgml index 2413c6fa1d..957faa9ef3 100644 --- a/docs/reference/gtk/tmpl/gtkstyle.sgml +++ b/docs/reference/gtk/tmpl/gtkstyle.sgml @@ -16,17 +16,17 @@ Styles - +The number of colors used in a style. - +Returns whether the styleis attached to a window. -@style: +@style: a #GtkStyle. diff --git a/docs/reference/gtk/tmpl/gtktypeutils.sgml b/docs/reference/gtk/tmpl/gtktypeutils.sgml index 5b35e66bcf..70ba76d1e8 100644 --- a/docs/reference/gtk/tmpl/gtktypeutils.sgml +++ b/docs/reference/gtk/tmpl/gtktypeutils.sgml @@ -19,14 +19,15 @@ managed at runtime. @GtkType is unique integer identifying the type. The guts of the information about the type is held in a private struct named -GtkTypeNode. +#GtkTypeNode. -@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. char, uchar, int, +long, float, etc). @GTK_TYPE_INVALID: @@ -48,26 +49,26 @@ fundamental types (e.g. char, uchar, int, long, float, etc). - +Returns the type name of @class. -@class: +@class: a #GtkTypeClass. - +Returns the type of @class. -@class: +@class: a #GtkTypeClass. - +Returns %TRUE if @type is a %GTK_TYPE_OBJECT. -@type: +@type: a #GtkType. @@ -79,14 +80,14 @@ The highest-numbered structured or flat enumerated type value. -The highest maximum fundamental enumerated type value. +The maximum fundamental enumerated type value. -Use in place of offsetof(), which is used if it exists. +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. -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. @@ -109,7 +110,7 @@ into a @cast. -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. @@ -149,7 +150,7 @@ Determines whether @type_class is a type of @otype. -Convert a gtk type into a fundamental type +Converts a Gtk type into a fundamental type. @@ -158,7 +159,7 @@ Convert a gtk type into a fundamental type -Just a macroized cast into a GtkSignalFunc +Just a macroized cast into a #GtkSignalFunc. @f: @@ -166,26 +167,26 @@ Just a macroized cast into a GtkSignalFunc -Define a function pointer. +Defines a function pointer. -Define a function pointer. +Defines a function pointer. -Define a function pointer. +Defines a function pointer. -Define a function pointer. +Defines a function pointer. @data: gpointer @@ -194,7 +195,7 @@ Define a function pointer. -Define a function pointer. +Defines a function pointer. @data: gpointer @@ -202,7 +203,7 @@ Define a function pointer. -Define a function pointer. +Defines a function pointer. @object: GtkObject* @@ -213,15 +214,15 @@ Define a function pointer. -Define a function pointer. +Defines a function pointer. -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. @@ -236,260 +237,260 @@ This is a structure that we use to pass in typed values (and names). -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -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. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UCHAR +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UCHAR. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOOL +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOOL. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_INT +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_INT. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_UINT +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_UINT. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_LONG +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_LONG. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ULONG +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ULONG. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLOAT +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLOAT. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_DOUBLE +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_DOUBLE. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_STRING +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_STRING. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_ENUM +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_ENUM. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_FLAGS +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_FLAGS. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_BOXED +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_BOXED. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_POINTER +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_POINTER. -@a: +@a: a #GtkArg. -If the GtkArg contains a pointer to the value, this macro will be a pointer to a GTK_TYPE_OBJECT +If the #GtkArg contains a pointer to the value, this macro will be a pointer to a %GTK_TYPE_OBJECT. -@a: +@a: a #GtkArg. -Holds information about the type. @gtk_type_name returns the name. +Holds information about the type. gtk_type_name() returns the name. @object_size is somehow set to the number of bytes that an instance of the object will occupy. @class_init_func holds the type's initialization function. @object_init_func holds the initialization function for an instance of the object. @reserved_1 is used for -GtkEnumValue to hold the enumerated values. +#GtkEnumValue to hold the enumerated values. @type_name: @@ -503,7 +504,7 @@ GtkEnumValue to hold the enumerated values. -The base structure for a Gtk Type. Every type inherits this as a base structure. +The base structure for a Gtk type. Every type inherits this as a base structure. @@ -522,7 +523,7 @@ nickname. -Initialize the data structures associated with gtk types. +Initializes the data structures associated with Gtk types. @debug_flags: @@ -530,73 +531,74 @@ Initialize the data structures associated with gtk types. -Create a new, unique type. +Creates a new, unique type. @parent_type: if zero, a fundamental type is created. @gtkinfo: -@Returns: the new GtkType. +@Returns: the new #GtkType. -@type_info: must not be null, and @type_info->type_name must also not be null. +@type_info: must not be %NULL, and @type_info->type_name must also not be %NULL. +Returns a pointer to the name of a type, or %NULL if it has none. -@type: a GtkType -@Returns: a pointer to the name of a type, or NULL if it has none. +@type: a #GtkType. +@Returns: a pointer to the name of a type, or %NULL if it has none. -Get the internal representation of a type given its name. +Gets the internal representation of a type, given its name. -@name: the name of a gtk type -@Returns: a GtkType +@name: the name of a Gtk type +@Returns: a #GtkType. - +Returns the parent type of a #GtkType. -@type: a GtkType -@Returns: the GtkType of the parent +@type: a #GtkType. +@Returns: the #GtkType of the parent. -Return a gpointer pointing to the class of @type or NULL if there was -any trouble identifying @type. Initialize the class if necessary. +Returns a pointer pointing to the class of @type or %NULL if there was +any trouble identifying @type. Initializes the class if necessary. -@type: a GtkType -@Returns: gpointer to the klass. +@type: a #GtkType. +@Returns: pointer to the class. -Create a new object of a given type, and return a gpointer to it. -Returns NULL if you give it an invalid type. It allocates the object +Creates a new object of a given type, and return a pointer to it. +Returns %NULL if you give it an invalid type. It allocates the object out of the type's memory chunk if there is a memory chunk. The object has all the proper initializers called. -@type: GtkType -@Returns: gpointer to a GtkTypeObject +@type: a #GtkType. +@Returns: pointer to a #GtkTypeObject. -Look in the type hierarchy to see if @type has @is_a_type among its +Looks in the type hierarchy to see if @type has @is_a_type among its ancestors. Do so with a simple lookup, not a loop. -@type: GtkType -@is_a_type: GtkType -@Returns: +@type: a #GtkType. +@is_a_type: another #GtkType. +@Returns: %TRUE if @type is a @is_a_type. @@ -604,8 +606,8 @@ ancestors. Do so with a simple lookup, not a loop. If @enum_type has values, then return a pointer to all of them. -@enum_type: GtkType -@Returns: GtkEnumValue* +@enum_type: a #GtkType. +@Returns: #GtkEnumValue* @@ -613,28 +615,28 @@ If @enum_type has values, then return a pointer to all of them. If @flags_type has values, then return a pointer to all of them. -@flags_type: -@Returns: GtkFlagValue* +@flags_type: a #GtkType. +@Returns: #GtkFlagValue* -Return a pointer to one of @enum_type's GtkEnumValues's whose name (or nickname) matches @value_name. +Returns a pointer to one of @enum_type's #GtkEnumValues's whose name (or nickname) matches @value_name. -@enum_type: GtkType -@value_name: -@Returns: GtkEnumValue* +@enum_type: a #GtkType. +@value_name: the name to look for. +@Returns: #GtkEnumValue* -Return a pointer to one of @flag_type's GtkFlagValue's whose name (or nickname) matches @value_name. +Returns a pointer to one of @flag_type's #GtkFlagValue's whose name (or nickname) matches @value_name. -@flags_type: -@value_name: -@Returns: GtkFlagValue* +@flags_type: a #GtkType. +@value_name: the name to look for. +@Returns: #GtkFlagValue* @flag_type: GtkType diff --git a/gtk/gtkrc.c b/gtk/gtkrc.c index efe5ddeaed..33abe80afc 100644 --- a/gtk/gtkrc.c +++ b/gtk/gtkrc.c @@ -2679,7 +2679,7 @@ gtk_rc_check_pixmap_dir (const gchar *dir, const gchar *pixmap_file) } /** - * gtk_rc_context_find_pixmap_in_path: + * gtk_rc_find_pixmap_in_path: * @settings: a #GtkSettinsg * @scanner: Scanner used to get line number information for the * warning message, or %NULL diff --git a/gtk/gtkstyle.c b/gtk/gtkstyle.c index 9e9c40dd6e..1535c5e9f8 100644 --- a/gtk/gtkstyle.c +++ b/gtk/gtkstyle.c @@ -642,6 +642,12 @@ gtk_style_duplicate (GtkStyle *style) return new_style; } +/** + * gtk_style_new: + * @returns: a new #GtkStyle. + * + * Creates a new #GtkStyle. + **/ GtkStyle* gtk_style_new (void) { @@ -755,12 +761,25 @@ gtk_style_detach (GtkStyle *style) } } +/** + * gtk_style_ref: + * @style: a #GtkStyle. + * @returns: @style. + * + * Deprecated equivalent of g_object_ref(). + **/ GtkStyle* gtk_style_ref (GtkStyle *style) { return (GtkStyle *) g_object_ref (G_OBJECT (style)); } +/** + * gtk_style_unref: + * @style: a #GtkStyle. + * + * Deprecated equivalent of g_object_unref(). + **/ void gtk_style_unref (GtkStyle *style) { @@ -5041,12 +5060,25 @@ gtk_paint_resize_grip (GtkStyle *style, edge, x, y, width, height); } +/** + * gtk_border_copy: + * @border: a #GtkBorder. + * @returns: a copy of @border. + * + * Copies a #GtkBorder structure. + **/ GtkBorder * gtk_border_copy (const GtkBorder *border) { return (GtkBorder *)g_memdup (border, sizeof (GtkBorder)); } +/** + * gtk_border_free: + * @border: a #GtkBorder. + * + * Frees a #GtkBorder structure. + **/ void gtk_border_free (GtkBorder *border) { diff --git a/gtk/gtkstyle.h b/gtk/gtkstyle.h index 32d1c121a7..4304de01c2 100644 --- a/gtk/gtkstyle.h +++ b/gtk/gtkstyle.h @@ -59,7 +59,7 @@ typedef gboolean (*GtkRcPropertyParser) (const GParamSpec *pspec, GValue *property_value); /* We make this forward declaration here, since we pass - * GtkWidgt's to the draw functions. + * GtkWidget's to the draw functions. */ typedef struct _GtkWidget GtkWidget; @@ -851,7 +851,7 @@ const GValue* _gtk_style_peek_property_value (GtkStyle *style, GtkRcPropertyParser parser); -/* depprecated */ +/* deprecated */ #ifndef GTK_DISABLE_DEPRECATED #define gtk_style_apply_default_pixmap(s,gw,st,a,x,y,w,h) gtk_style_apply_default_background (s,gw,1,st,a,x,y,w,h) void gtk_draw_string (GtkStyle *style, diff --git a/gtk/gtktoolbar.c b/gtk/gtktoolbar.c index 9ee939a72d..cac2d3388a 100644 --- a/gtk/gtktoolbar.c +++ b/gtk/gtktoolbar.c @@ -1130,6 +1130,13 @@ gtk_toolbar_insert_space (GtkToolbar *toolbar, position); } +/** + * gtk_toolbar_remove_space: + * @toolbar: a #GtkToolbar. + * @position: the index of the space to remove. + * + * Removes a space from the specified position. + **/ void gtk_toolbar_remove_space (GtkToolbar *toolbar, gint position) @@ -1170,6 +1177,15 @@ gtk_toolbar_remove_space (GtkToolbar *toolbar, g_warning ("Toolbar position %d doesn't exist", position); } +/** + * gtk_toolbar_append_widget: + * @toolbar: a #GtkToolbar. + * @widget: a #GtkWidget to add to the toolbar. + * @tooltip_text: the element's tooltip. + * @tooltip_private_text: used for context-sensitive help about this toolbar element. + * + * Adds a widget to the end of the given toolbar. + **/ void gtk_toolbar_append_widget (GtkToolbar *toolbar, GtkWidget *widget, @@ -1183,6 +1199,15 @@ gtk_toolbar_append_widget (GtkToolbar *toolbar, toolbar->num_children); } +/** + * gtk_toolbar_prepend_widget: + * @toolbar: a #GtkToolbar. + * @widget: a #GtkWidget to add to the toolbar. + * @tooltip_text: the element's tooltip. + * @tooltip_private_text: used for context-sensitive help about this toolbar element. + * + * Adds a widget to the beginning of the given toolbar. + **/ void gtk_toolbar_prepend_widget (GtkToolbar *toolbar, GtkWidget *widget, @@ -1196,6 +1221,16 @@ gtk_toolbar_prepend_widget (GtkToolbar *toolbar, 0); } +/** + * gtk_toolbar_insert_widget: + * @toolbar: a #GtkToolbar. + * @widget: a #GtkWidget to add to the toolbar. + * @tooltip_text: the element's tooltip. + * @tooltip_private_text: used for context-sensitive help about this toolbar element. + * @position: the number of widgets to insert this widget after. + * + * Inserts a widget in the toolbar at the given position. + **/ void gtk_toolbar_insert_widget (GtkToolbar *toolbar, GtkWidget *widget, @@ -1243,6 +1278,28 @@ gtk_toolbar_prepend_element (GtkToolbar *toolbar, icon, callback, user_data, 0); } +/** + * gtk_toolbar_insert_element: + * @toolbar: a #GtkToolbar. + * @type: a value of type #GtkToolbarChildType that determines what @widget + * will be. + * @widget: a #GtkWidget, or %NULL. + * @text: the element's label. + * @tooltip_text: the element's tooltip. + * @tooltip_private_text: used for context-sensitive help about this toolbar element. + * @icon: a #GtkWidget that provides pictorial representation of the element's function. + * @callback: the function to be executed when the button is pressed. + * @user_data: any data you wish to pass to the callback. + * @position: the number of widgets to insert this element after. + * + * Inserts a new element in the toolbar at the given position. If + * @type == %GTK_TOOLBAR_CHILD_WIDGET, @widget is used as the new element. + * If @type == %GTK_TOOLBAR_CHILD_RADIOBUTTON, @widget is used to determine + * the radio group for the new element. In all other cases, @widget must + * be %NULL. + * + * Return value: the new toolbar element as a #GtkWidget. + GtkWidget * gtk_toolbar_insert_element (GtkToolbar *toolbar, GtkToolbarChildType type,