blob: 97c321d8b4f1c817ede2c7490026cedd9532023d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<!-- ##### 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>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT EphyNodeDb ##### -->
<para>
</para>
<!-- ##### 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>
<!-- ##### 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:
|
