doc/reference/tmpl/.svn/text-base/ephy-node-db.sgml.svn-base

   1 <!-- ##### SECTION Title ##### -->
   2 EphyNodeDb
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Data tree
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 An #EphyNodeDb is a database for arbitrary data organized in a tree.
  10 </para>
  11 <para>
  12 Each database is stored along with its name in a global set of databases.
  13 Databases can be created using ephy_node_db_new() and retrieved using
  14 ephy_node_db_get_by_name().
  15 </para>
  16 <para>
  17 Each #EphyNode inside an #EphyNodeDb is identified by a unique node ID. By
  18 keeping a handle on the ID, one can use ephy_node_db_get_node_from_id() to
  19 retrieve its corresponding #EphyNode.
  20 </para>
  21 <para>
  22 #EphyNodeDb<!-- -->s can be saved to disk using ephy_node_db_write_to_xml_safe()
  23 and restored using ephy_node_db_load_from_file().
  24 </para>
  25
  26 <!-- ##### SECTION See_Also ##### -->
  27 <para>
  28
  29 </para>
  30
  31 <!-- ##### SECTION Stability_Level ##### -->
  32
  33
  34 <!-- ##### STRUCT EphyNodeDb ##### -->
  35 <para>
  36
  37 </para>
  38
  39
  40 <!-- ##### ARG EphyNodeDb:immutable ##### -->
  41 <para>
  42 %TRUE if no #EphyNode<!-- -->s can be added, removed or modified from this
  43 #EphyNodeDb
  44 </para>
  45
  46 <!-- ##### ARG EphyNodeDb:name ##### -->
  47 <para>
  48 A string identifier unique to this #EphyNodeDb
  49 </para>
  50
  51 <!-- ##### FUNCTION ephy_node_db_new ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @name:
  57 @Returns:
  58
  59
  60 <!-- ##### FUNCTION ephy_node_db_load_from_file ##### -->
  61 <para>
  62
  63 </para>
  64
  65 @db:
  66 @xml_file:
  67 @xml_root:
  68 @xml_version:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION ephy_node_db_write_to_xml_safe ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @db:
  78 @filename:
  79 @root:
  80 @version:
  81 @comment:
  82 @node:
  83 @Varargs:
  84 @Returns:
  85
  86
  87 <!-- ##### FUNCTION ephy_node_db_get_name ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @db:
  93 @Returns:
  94
  95
  96 <!-- ##### FUNCTION ephy_node_db_is_immutable ##### -->
  97 <para>
  98
  99 </para>
 100
 101 @db:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION ephy_node_db_set_immutable ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @db:
 111 @immutable:
 112
 113
 114 <!-- ##### FUNCTION ephy_node_db_get_node_from_id ##### -->
 115 <para>
 116
 117 </para>
 118
 119 @db:
 120 @id:
 121 @Returns:
 122
 123