[gtk+] gtktreestore: Move documentation to inline comments
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] gtktreestore: Move documentation to inline comments
- Date: Fri, 22 Oct 2010 22:32:09 +0000 (UTC)
commit 8f766d36f4bdf7c3fce8416390b6b0d68297499f
Author: Javier Jardón <jjardon gnome org>
Date: Fri Oct 22 21:47:46 2010 +0200
gtktreestore: Move documentation to inline comments
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtktreestore.sgml | 296 -----------------------------
gtk/gtktreestore.c | 35 ++++
3 files changed, 36 insertions(+), 296 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index ff18464..9d74162 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -50,5 +50,6 @@ gtktoolbar.sgml
gtktoolitem.sgml
gtktooltip.sgml
gtktreednd.sgml
+gtktreestore.sgml
gtktypeutils.sgml
gtkwindow.sgml
diff --git a/gtk/gtktreestore.c b/gtk/gtktreestore.c
index c7f0087..0556739 100644
--- a/gtk/gtktreestore.c
+++ b/gtk/gtktreestore.c
@@ -28,6 +28,41 @@
#include "gtkintl.h"
+/**
+ * SECTION:gtktreestore
+ * @Short_description: A tree-like data structure that can be used with the GtkTreeView
+ * @Title: GtkTreeStore
+ * @See_also: #GtkTreeModel
+ *
+ * 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.
+ *
+ * <refsect2 id="GtkTreeStore-BUILDER-UI">
+ * <title>GtkTreeStore as GtkBuildable</title>
+ * The GtkTreeStore implementation of the #GtkBuildable interface allows
+ * to specify the model columns with a <columns> element that may
+ * contain multiple <column> elements, each specifying one model
+ * column. The "type" attribute specifies the data type for the column.
+ * <example>
+ * <title>A UI Definition fragment for a tree store</title>
+ * <programlisting><![CDATA[
+ * <object class="GtkTreeStore">
+ * <columns>
+ * <column type="gchararray"/>
+ * <column type="gchararray"/>
+ * <column type="gint"/>
+ * </columns>
+ * </object>
+ * ]]></programlisting>
+ * </example>
+ * </refsect2>
+ */
+
+
#define G_NODE(node) ((GNode *)node)
#define GTK_TREE_STORE_IS_SORTED(tree) (((GtkTreeStore*)(tree))->sort_column_id != GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID)
#define VALID_ITER(iter, tree_store) ((iter)!= NULL && (iter)->user_data != NULL && ((GtkTreeStore*)(tree_store))->stamp == (iter)->stamp)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]