]> Pileus Git - ~andy/gtk/commitdiff
Fix a few doc comments. Link to style properties.
authorMatthias Clasen <maclas@gmx.de>
Tue, 17 Dec 2002 02:07:57 +0000 (02:07 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 17 Dec 2002 02:07:57 +0000 (02:07 +0000)
2002-12-17  Matthias Clasen  <maclas@gmx.de>

* 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.

18 files changed:
ChangeLog
ChangeLog.pre-2-10
ChangeLog.pre-2-2
ChangeLog.pre-2-4
ChangeLog.pre-2-6
ChangeLog.pre-2-8
docs/reference/ChangeLog
docs/reference/gdk/tmpl/drawing.sgml
docs/reference/gdk/tmpl/gcs.sgml
docs/reference/gdk/tmpl/pixmaps.sgml
docs/reference/gdk/tmpl/windows.sgml
docs/reference/gtk/tmpl/gtkaccelgroup.sgml
docs/reference/gtk/tmpl/gtkcontainer.sgml
docs/reference/gtk/tmpl/gtkiconfactory.sgml
docs/reference/gtk/tmpl/gtkrc.sgml
docs/reference/gtk/tmpl/gtktextview.sgml
docs/reference/gtk/tmpl/gtkwidget.sgml
gtk/gtkcontainer.c

index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 67ce50f450384dae79af901a885004b15eb4a47f..41ecffef6cf5ff1089a67c0417de551ea765c755 100644 (file)
@@ -1,3 +1,7 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * gtk/gtkcontainer.c: Fix a few doc comments.
+
 2002-12-17  Tor Lillqvist  <tml@iki.fi>
 
        * gdk/win32/gdkglobals-win32.c: Minor cosmetics.
index 9ba3ee2f68d169230fea6e9b3678e2e895cb2c02..598864fe034956a0c5b55f94c63a6dda846546fa 100644 (file)
@@ -1,3 +1,21 @@
+2002-12-17  Matthias Clasen  <maclas@gmx.de>
+
+       * 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  <maclas@gmx.de>
 
        * gtk/tmpl/gtkradiomenuitem.sgml: 
index 45f1725b015c2716fb255ca8cbb196293a0ebb31..6599ce8de56d93367ddc21362626218fd9e6cbf4 100644 (file)
@@ -26,7 +26,7 @@ more information.
 </para>
 
 <!-- ##### STRUCT GdkDrawable ##### -->
-<para><anchor id="GdkDrawable"/>
+<para>
 An opaque structure representing an object that can be
 drawn onto. This can be a #GdkPixmap, a #GdkBitmap,
 or a #GdkWindow.
index 98726e385ab084cb3494a375ab4aa1865edc4e52..8a60b59578cf81aa34ddb923bdd30f89749be828 100644 (file)
@@ -31,7 +31,7 @@ be set by the latter method.
 </para>
 
 <!-- ##### STRUCT GdkGC ##### -->
-<para><anchor id="GdkGC"/>
+<para>
 The #GdkGC structure represents a graphics context.
 It is an opaque structure with no user-visible
 elements.
index 67a41cc21bc8e69412cd9c9032dcc939e93f2b1c..83bde31d9e90fde4b66f3ebf25776677e8f49cea 100644 (file)
@@ -19,7 +19,7 @@ pixel can be either on or off).
 </para>
 
 <!-- ##### STRUCT GdkPixmap ##### -->
-<para><anchor id="GdkPixmap"/>
+<para>
 An opaque structure representing an offscreen drawable.
 Pointers to structures of type #GdkPixmap, #GdkBitmap,
 and #GdkWindow, can often be used interchangeably. 
index 9120ec77e2d3ad69c47004c455481a61a01f48ca..389a116cda4416395817a8e625a91b92df2f93eb 100644 (file)
@@ -19,7 +19,7 @@ For example, each #GtkButton has a #GdkWindow associated with it.
 </para>
 
 <!-- ##### STRUCT GdkWindow ##### -->
-<para><anchor id="GdkWindow"/>
+<para>
 An opaque structure representing an onscreen drawable.
 Pointers to structures of type #GdkPixmap, #GdkBitmap,
 and #GdkWindow, can often be used interchangeably.
index 4c928e05ad45ac188c173c8d955a293ef8948a9a..ecefb40f9703c4a504dd9461d5e4ec518686cdcb 100644 (file)
@@ -5,7 +5,7 @@ Accelerator Groups
 Groups of global keyboard accelerators for an entire GtkWindow
 
 <!-- ##### SECTION Long_Description ##### -->
-<para id="GtkAccelGroup">
+<para>
 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
index 2f078572afa48b76ffb986107b0ef2ccfce6d96a..ccf1d0a7051875adf94e5b6e9b084ee13ad2b14e 100644 (file)
@@ -5,8 +5,21 @@ GtkContainer
 Base class for widgets which contain other widgets
 
 <!-- ##### SECTION Long_Description ##### -->
-<para>
-
+<para id="child-properties">
+<structname>GtkContainer</structname> introduces <firstterm>child 
+properties</firstterm> - 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.</para>
+<para>
+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(). 
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
index f36190f0147978b048d56e9713a261c9393c074e..97557d8d261a9396703ee924a4f44aea21611763 100644 (file)
@@ -8,7 +8,7 @@ Manipulating stock icons
 <!-- ##### SECTION Long_Description ##### -->
 
 
-<para id="GtkIconFactory">
+<para>
 Browse the available stock icons in the list of stock IDs found <link
 linkend="gtk-Stock-Items">here</link>. You can also use 
 the <application>gtk-demo</application> application for this purpose.
index 2f237804f6f5fdfae5be8bf1287dab58bdeaef34..3d2cb453cc30747680e275639e7322228c09c5ae 100644 (file)
@@ -5,7 +5,7 @@ Resource Files
 Routines for handling resource files
 
 <!-- ##### SECTION Long_Description ##### -->
-<para id="GtkRcStyle">
+<para>
 GTK+ provides resource file mechanism for configuring
 various aspects of the operation of a GTK+ program
 at runtime.
@@ -310,7 +310,7 @@ settings</replaceable> }</literal></term>
     <term><literal><replaceable>class</replaceable>::<replaceable>property</replaceable> = <replaceable>value</replaceable></literal></term>
      <listitem>
        <para>
-        Sets a style property for a widget class.
+        Sets a <link linkend="style-property">style property</link> for a widget class.
        </para>
      </listitem>
   </varlistentry>
index 8875feae5ab4a21217af68e2da07ea986d504d36..267e7192d40f3b0700289fa3c28f8645d076de57 100644 (file)
@@ -324,7 +324,7 @@ types related to the text widget and how they work together.
 
 
 <!-- ##### STRUCT GtkTextChildAnchor ##### -->
-<para id="GtkTextChildAnchor">
+<para>
 A <structname>GtkTextChildAnchor</structname> 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 
index f681f8c07b032efa393e8009f8a7898ad34b322b..2ffc19a178b1e899d6d66d8674b5d5298604c4ca 100644 (file)
@@ -5,8 +5,21 @@ GtkWidget
 Base class for all widgets
 
 <!-- ##### SECTION Long_Description ##### -->
+<para id="style-properties">
+<structname>GtkWidget</structname> introduces <firstterm>style 
+properties</firstterm> - 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 <link linkend="gtk-Resource-Files">resource files</link>.
+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.
+</para>
 <para>
-
+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.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->
@@ -36,6 +49,7 @@ handles the emission.
 Implementation of this signal is optional.
 </para>
 
+@parent_class: 
 @activate_signal: 
 @set_scroll_adjustments_signal: 
 
index 60b1f2683f13332a45ba29808f68df641c02d8ca..7010ac9fed4b1a9d675843733e6b99362cd3cbea 100644 (file)
@@ -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.