From 5d347cad8ebe7dd76ec1ff4a618f87ad16e14ae6 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 17 Dec 2002 02:07:57 +0000 Subject: [PATCH] Fix a few doc comments. Link to style properties. 2002-12-17 Matthias Clasen * gtk/gtkcontainer.c: Fix a few doc comments. * gtk/tmpl/gtkrc.sgml: Link to style properties. * gtk/tmpl/gtkcontainer.sgml: Add bits about child properties. * gtk/tmpl/gtkwidget.sgml: Add bits about style properties. * gdk/tmpl/pixmaps.sgml: * gdk/tmpl/windows.sgml: * gdk/tmpl/drawing.sgml: * gdk/tmpl/gcs.sgml: * gtk/tmpl/gtktextview.sgml: * gtk/tmpl/gtkrc.sgml: * gtk/tmpl/gtkiconfactory.sgml: * gtk/tmpl/gtkaccelgroup.sgml: Remove ids which are now generated by gtk-doc. --- ChangeLog | 4 ++++ ChangeLog.pre-2-10 | 4 ++++ ChangeLog.pre-2-2 | 4 ++++ ChangeLog.pre-2-4 | 4 ++++ ChangeLog.pre-2-6 | 4 ++++ ChangeLog.pre-2-8 | 4 ++++ docs/reference/ChangeLog | 18 ++++++++++++++++++ docs/reference/gdk/tmpl/drawing.sgml | 2 +- docs/reference/gdk/tmpl/gcs.sgml | 2 +- docs/reference/gdk/tmpl/pixmaps.sgml | 2 +- docs/reference/gdk/tmpl/windows.sgml | 2 +- docs/reference/gtk/tmpl/gtkaccelgroup.sgml | 2 +- docs/reference/gtk/tmpl/gtkcontainer.sgml | 17 +++++++++++++++-- docs/reference/gtk/tmpl/gtkiconfactory.sgml | 2 +- docs/reference/gtk/tmpl/gtkrc.sgml | 4 ++-- docs/reference/gtk/tmpl/gtktextview.sgml | 2 +- docs/reference/gtk/tmpl/gtkwidget.sgml | 16 +++++++++++++++- gtk/gtkcontainer.c | 8 ++++---- 18 files changed, 85 insertions(+), 16 deletions(-) diff --git a/ChangeLog b/ChangeLog index 67ce50f45..41ecffef6 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 67ce50f45..41ecffef6 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 67ce50f45..41ecffef6 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 67ce50f45..41ecffef6 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 67ce50f45..41ecffef6 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 67ce50f45..41ecffef6 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,7 @@ +2002-12-17 Matthias Clasen + + * gtk/gtkcontainer.c: Fix a few doc comments. + 2002-12-17 Tor Lillqvist * gdk/win32/gdkglobals-win32.c: Minor cosmetics. diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 9ba3ee2f6..598864fe0 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,21 @@ +2002-12-17 Matthias Clasen + + * gtk/tmpl/gtkrc.sgml: Link to style properties. + + * gtk/tmpl/gtkcontainer.sgml: Add bits about child properties. + + * gtk/tmpl/gtkwidget.sgml: Add bits about style properties. + + * gdk/tmpl/pixmaps.sgml: + * gdk/tmpl/windows.sgml: + * gdk/tmpl/drawing.sgml: + * gdk/tmpl/gcs.sgml: + * gtk/tmpl/gtktextview.sgml: + * gtk/tmpl/gtkrc.sgml: + * gtk/tmpl/gtkiconfactory.sgml: + * gtk/tmpl/gtkaccelgroup.sgml: Remove ids which are now + generated by gtk-doc. + 2002-12-16 Matthias Clasen * gtk/tmpl/gtkradiomenuitem.sgml: diff --git a/docs/reference/gdk/tmpl/drawing.sgml b/docs/reference/gdk/tmpl/drawing.sgml index 45f1725b0..6599ce8de 100644 --- a/docs/reference/gdk/tmpl/drawing.sgml +++ b/docs/reference/gdk/tmpl/drawing.sgml @@ -26,7 +26,7 @@ more information. - + An opaque structure representing an object that can be drawn onto. This can be a #GdkPixmap, a #GdkBitmap, or a #GdkWindow. diff --git a/docs/reference/gdk/tmpl/gcs.sgml b/docs/reference/gdk/tmpl/gcs.sgml index 98726e385..8a60b5957 100644 --- a/docs/reference/gdk/tmpl/gcs.sgml +++ b/docs/reference/gdk/tmpl/gcs.sgml @@ -31,7 +31,7 @@ be set by the latter method. - + The #GdkGC structure represents a graphics context. It is an opaque structure with no user-visible elements. diff --git a/docs/reference/gdk/tmpl/pixmaps.sgml b/docs/reference/gdk/tmpl/pixmaps.sgml index 67a41cc21..83bde31d9 100644 --- a/docs/reference/gdk/tmpl/pixmaps.sgml +++ b/docs/reference/gdk/tmpl/pixmaps.sgml @@ -19,7 +19,7 @@ pixel can be either on or off). - + An opaque structure representing an offscreen drawable. Pointers to structures of type #GdkPixmap, #GdkBitmap, and #GdkWindow, can often be used interchangeably. diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml index 9120ec77e..389a116cd 100644 --- a/docs/reference/gdk/tmpl/windows.sgml +++ b/docs/reference/gdk/tmpl/windows.sgml @@ -19,7 +19,7 @@ For example, each #GtkButton has a #GdkWindow associated with it. - + An opaque structure representing an onscreen drawable. Pointers to structures of type #GdkPixmap, #GdkBitmap, and #GdkWindow, can often be used interchangeably. diff --git a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml b/docs/reference/gtk/tmpl/gtkaccelgroup.sgml index 4c928e05a..ecefb40f9 100644 --- a/docs/reference/gtk/tmpl/gtkaccelgroup.sgml +++ b/docs/reference/gtk/tmpl/gtkaccelgroup.sgml @@ -5,7 +5,7 @@ Accelerator Groups Groups of global keyboard accelerators for an entire GtkWindow - + A #GtkAccelGroup represents a group of keyboard accelerators, typically attached to a toplevel #GtkWindow (with gtk_window_add_accel_group()). Usually you won't need to create a diff --git a/docs/reference/gtk/tmpl/gtkcontainer.sgml b/docs/reference/gtk/tmpl/gtkcontainer.sgml index 2f078572a..ccf1d0a70 100644 --- a/docs/reference/gtk/tmpl/gtkcontainer.sgml +++ b/docs/reference/gtk/tmpl/gtkcontainer.sgml @@ -5,8 +5,21 @@ GtkContainer Base class for widgets which contain other widgets - - + +GtkContainer introduces child +properties - these are object properties that are not specific +to either the container or the contained widget, but rather to their relation. +Typical examples of child properties are the position or pack-type of a widget +which is contained in a #GtkBox. + +Use gtk_container_class_install_child_property() to install child properties +for a container class and gtk_container_class_find_child_property() or +gtk_container_class_list_child_properties() to get information about existing +child properties. To set the value of a child property, use +gtk_container_child_set_property(), gtk_container_child_set() or +gtk_container_child_set_valist(). To obtain the value of a child property, +use gtk_container_child_get_property(), gtk_container_child_get() or +gtk_container_child_get_valist(). diff --git a/docs/reference/gtk/tmpl/gtkiconfactory.sgml b/docs/reference/gtk/tmpl/gtkiconfactory.sgml index f36190f01..97557d8d2 100644 --- a/docs/reference/gtk/tmpl/gtkiconfactory.sgml +++ b/docs/reference/gtk/tmpl/gtkiconfactory.sgml @@ -8,7 +8,7 @@ Manipulating stock icons - + Browse the available stock icons in the list of stock IDs found here. You can also use the gtk-demo application for this purpose. diff --git a/docs/reference/gtk/tmpl/gtkrc.sgml b/docs/reference/gtk/tmpl/gtkrc.sgml index 2f237804f..3d2cb453c 100644 --- a/docs/reference/gtk/tmpl/gtkrc.sgml +++ b/docs/reference/gtk/tmpl/gtkrc.sgml @@ -5,7 +5,7 @@ Resource Files Routines for handling resource files - + GTK+ provides resource file mechanism for configuring various aspects of the operation of a GTK+ program at runtime. @@ -310,7 +310,7 @@ settings } class::property = value - Sets a style property for a widget class. + Sets a style property for a widget class. diff --git a/docs/reference/gtk/tmpl/gtktextview.sgml b/docs/reference/gtk/tmpl/gtktextview.sgml index 8875feae5..267e7192d 100644 --- a/docs/reference/gtk/tmpl/gtktextview.sgml +++ b/docs/reference/gtk/tmpl/gtktextview.sgml @@ -324,7 +324,7 @@ types related to the text widget and how they work together. - + A GtkTextChildAnchor is a spot in the buffer where child widgets can be "anchored" (inserted inline, as if they were characters). The anchor can have multiple widgets anchored, to allow for diff --git a/docs/reference/gtk/tmpl/gtkwidget.sgml b/docs/reference/gtk/tmpl/gtkwidget.sgml index f681f8c07..2ffc19a17 100644 --- a/docs/reference/gtk/tmpl/gtkwidget.sgml +++ b/docs/reference/gtk/tmpl/gtkwidget.sgml @@ -5,8 +5,21 @@ GtkWidget Base class for all widgets + +GtkWidget introduces style +properties - these are basically object properties that are stored +not on the object, but in the style object associated to the widget. Style +properties are set in resource files. +This mechanism is used for configuring such things as the location of the +scrollbar arrows through the theme, giving theme authors more control over the +look of applications without the need to write a theme engine in C. + - +Use gtk_widget_class_install_style_property() to install style properties for +a widget class, gtk_widget_class_find_style_property() or +gtk_widget_class_list_style_properties() to get information about existing +style properties and gtk_widget_style_get_property(), gtk_widget_style_get() or +gtk_widget_style_get_valist() to obtain the value of a style property. @@ -36,6 +49,7 @@ handles the emission. Implementation of this signal is optional. +@parent_class: @activate_signal: @set_scroll_adjustments_signal: diff --git a/gtk/gtkcontainer.c b/gtk/gtkcontainer.c index 60b1f2683..7010ac9fe 100644 --- a/gtk/gtkcontainer.c +++ b/gtk/gtkcontainer.c @@ -338,8 +338,8 @@ container_set_child_property (GtkContainer *container, * gtk_container_child_get_valist: * @container: a #GtkContainer * @child: a widget which is a child of @container - * @first_prop_name: the name of the first property to get - * @va_list: a %NULL-terminated list of property names and #GValue*, + * @first_property_name: the name of the first property to get + * @var_args: a %NULL-terminated list of property names and #GValue*, * starting with @first_prop_name. * * Gets the values of one or more child properties for @child and @container. @@ -482,8 +482,8 @@ gtk_container_child_get_property (GtkContainer *container, * gtk_container_child_set_valist: * @container: a #GtkContainer * @child: a widget which is a child of @container - * @first_prop_name: the name of the first property to set - * @va_list: a %NULL-terminated list of property names and values, starting + * @first_property_name: the name of the first property to set + * @var_args: a %NULL-terminated list of property names and values, starting * with @first_prop_name. * * Sets one or more child properties for @child and @container. -- 2.43.2