aboutsummaryrefslogtreecommitdiffstats
path: root/doc/reference/tmpl/ephy-node-db.sgml
diff options
context:
space:
mode:
authorAdam Hooper <adamh@src.gnome.org>2004-04-08 04:14:20 +0800
committerAdam Hooper <adamh@src.gnome.org>2004-04-08 04:14:20 +0800
commit96644ef5c68b652b59c90caf246645d70a75fc3b (patch)
tree5c728e14526f4332c58ab126c3521fc28f1b5bf8 /doc/reference/tmpl/ephy-node-db.sgml
parent32e7f698ede6d453c563743198ddca5a270a03fd (diff)
downloadgsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar.gz
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar.bz2
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar.lz
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar.xz
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.tar.zst
gsoc2013-epiphany-96644ef5c68b652b59c90caf246645d70a75fc3b.zip
Added forgotten EphyNodeDb documentation
Diffstat (limited to 'doc/reference/tmpl/ephy-node-db.sgml')
-rw-r--r--doc/reference/tmpl/ephy-node-db.sgml131
1 files changed, 131 insertions, 0 deletions
diff --git a/doc/reference/tmpl/ephy-node-db.sgml b/doc/reference/tmpl/ephy-node-db.sgml
new file mode 100644
index 000000000..ff753f80f
--- /dev/null
+++ b/doc/reference/tmpl/ephy-node-db.sgml
@@ -0,0 +1,131 @@
+<!-- ##### SECTION Title ##### -->
+EphyNodeDb
+
+<!-- ##### SECTION Short_Description ##### -->
+Data tree
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+An #EphyNodeDb is a database for arbitrary data organized in a tree.
+</para>
+<para>
+Each database is stored along with its name in a global set of databases.
+Databases can be created using ephy_node_db_new() and retrieved using
+ephy_node_db_get_by_name().
+</para>
+<para>
+Each #EphyNode inside an #EphyNodeDb is identified by a unique node ID. By
+keeping a handle on the ID, one can use ephy_node_db_get_node_from_id() to
+retrieve its corresponding #EphyNode.
+</para>
+<para>
+#EphyNodeDb<!-- -->s can be saved to disk using ephy_node_db_write_to_xml_safe()
+and restored using ephy_node_db_load_from_file().
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT EphyNodeDb ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION ephy_node_db_get_by_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_new ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_load_from_file ##### -->
+<para>
+
+</para>
+
+@db:
+@xml_file:
+@xml_root:
+@xml_version:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_write_to_xml_safe ##### -->
+<para>
+
+</para>
+
+@db:
+@filename:
+@root:
+@version:
+@comment:
+@node:
+@Varargs:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_get_name ##### -->
+<para>
+
+</para>
+
+@db:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_is_immutable ##### -->
+<para>
+
+</para>
+
+@db:
+@Returns:
+
+
+<!-- ##### FUNCTION ephy_node_db_set_immutable ##### -->
+<para>
+
+</para>
+
+@db:
+@immutable:
+
+
+<!-- ##### FUNCTION ephy_node_db_get_node_from_id ##### -->
+<para>
+
+</para>
+
+@db:
+@id:
+@Returns:
+<!-- # Unused Parameters # -->
+@Param2:
+
+
+<!-- ##### ARG EphyNodeDb:immutable ##### -->
+<para>
+%TRUE if no #EphyNode<!-- -->s can be added, removed or modified from this
+#EphyNodeDb
+</para>
+
+<!-- ##### ARG EphyNodeDb:name ##### -->
+<para>
+A string identifier unique to this #EphyNodeDb
+</para>
+