]> Pileus Git - ~andy/gtk/commitdiff
clean up the wording.
authorJonathan Blandford <jrb@gnome.org>
Sat, 2 Nov 2002 13:43:01 +0000 (13:43 +0000)
committerJonathan Blandford <jrb@src.gnome.org>
Sat, 2 Nov 2002 13:43:01 +0000 (13:43 +0000)
Sat Nov  2 08:41:47 2002  Jonathan Blandford  <jrb@gnome.org>

* gtk/tmpl/gtktreestore.sgml: clean up the wording.

* gtk/tmpl/gtkliststore.sgml: Add an example and clean up the
wording.

docs/reference/ChangeLog
docs/reference/gtk/tmpl/gtkliststore.sgml
docs/reference/gtk/tmpl/gtktreestore.sgml

index 14144b9b1bf15e7754ce0ac969172cefeb6622af..a14f6acd2775724d23da45cba61f6aa5ff055537 100644 (file)
@@ -1,3 +1,10 @@
+Sat Nov  2 08:41:47 2002  Jonathan Blandford  <jrb@gnome.org>
+
+       * gtk/tmpl/gtktreestore.sgml: clean up the wording.
+
+       * gtk/tmpl/gtkliststore.sgml: Add an example and clean up the
+       wording.
+
 2002-11-01  Matthias Clasen  <maclas@gmx.de>
 
        * gdk/tmpl/fonts.sgml: 
index 149c3891494e22290abe499dfabae5a7aa912c15..819fccbe0cf3b16e570a4bea8e0c37f8ed0d268b 100644 (file)
@@ -2,20 +2,68 @@
 GtkListStore
 
 <!-- ##### SECTION Short_Description ##### -->
-
+A list-like data structure that can be used with the #GtkTreeView
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
 The #GtkListStore object is a list model for use with a #GtkTreeView
 widget.  It implements the #GtkTreeModel interface, and consequentialy,
 can use all of the methods available there.  It also implements the
-#GtkTreeSortable interface so you can sort the list using the view.
+#GtkTreeSortable interface so it can be sorted by the view.
 Finally, it also implements the tree <link linkend="gtktreednd">drag and
 drop</link> interfaces.
 </para>
 
-<para>
-</para>
+<example>
+<title>Creating a simple list store.</title>
+<programlisting>
+enum {
+  COLUMN_STRING,
+  COLUMN_INT,
+  COLUMN_BOOLEAN,
+  N_COLUMNS
+}
+
+{
+  GtkListStore *list_store;
+  GtkTreePath *path;
+  GtkTreeIter iter;
+  gint i;
+
+  list_store = gtk_list_store_new (N_COLUMNS,
+                                   G_TYPE_STRING,
+                                   G_TYPE_INT,
+                                   G_TYPE_BOOLEAN);
+
+  for (i = 0; i < 10; i++)
+    {
+      gchar *some_data;
+
+      some_data = get_some_data (i);
+
+      /* Add a new row to the model */
+      gtk_list_store_append (list_store, &iter);
+      gtk_list_store_set (list_store, &iter,
+                          COLUMN_STRING, some_data,
+                          COLUMN_INT, i,
+                          COLUMN_BOOLEAN,  FALSE,
+                          -1);
+
+      g_free (some_data);
+    }
+
+  /* Modify a particular row */
+  path = gtk_tree_path_new_from_string ("4");
+  gtk_tree_model_get_iter (GTK_TREE_MODEL (list_store),
+                           &iter,
+                           path);
+  gtk_tree_path_free (path);
+  gtk_list_store_set (list_store, &iter,
+                      COLUMN_BOOLEAN, TRUE,
+                      -1);
+}
+</programlisting>
+</example>
 
 <!-- ##### SECTION See_Also ##### -->
 <para>
index 8ce862f456065a47b97a6256c1099237ea47571d..3661f84590918bdb2d3b9d834234a0d51770cbe6 100644 (file)
@@ -2,10 +2,17 @@
 GtkTreeStore
 
 <!-- ##### SECTION Short_Description ##### -->
+A tree-like data structure that can be used with the #GtkTreeView
 
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+The #GtkTreeStore object is a list model for use with a #GtkTreeView
+widget.  It implements the #GtkTreeModel interface, and consequentialy,
+can use all of the methods available there.  It also implements the
+#GtkTreeSortable interface so it can be sorted by the view.  Finally,
+it also implements the tree <link linkend="gtktreednd">drag and
+drop</link> interfaces.
 
 </para>