struct EphyNodeDb

struct EphyNodeDb;

ephy_node_db_get_by_name ()

EphyNodeDb* ephy_node_db_get_by_name        (const char *name);

Returns the EphyNodeDb named name, or NULL if no such database exists.

ephy_node_db_new ()

EphyNodeDb* ephy_node_db_new                (const char *name);

Creates and returns a new EphyNodeDb, named name.

ephy_node_db_load_from_file ()

gboolean    ephy_node_db_load_from_file     (EphyNodeDb *db,
                                             const char *xml_file,
                                             const xmlChar *xml_root,
                                             const xmlChar *xml_version);

Populates db with data from xml_file. The node database will be populated with everything inside of the xml_root tag from xml_file. If xml_version is different from the version attribute of the xml_root element, this function will fail.

The data will most probably have been stored using ephy_node_db_write_to_xml_safe().

ephy_node_db_write_to_xml_safe ()

int         ephy_node_db_write_to_xml_safe  (EphyNodeDb *db,
                                             const xmlChar *filename,
                                             const xmlChar *root,
                                             const xmlChar *version,
                                             const xmlChar *comment,
                                             EphyNode *node,
                                             ...);

Writes db's data to an XML file for storage. The data can be retrieved in the future using ephy_node_db_load_from_file().

The function arguments are straightforward until node, at which point some explanation is necessary.

The variable argument list starts at node, which is an EphyNode containing data to write to filename. The next argument is an integer specifying the number of “exception” nodes. After this integer, that number of EphyNode arguments should be given. Each of these “exception” nodes determines which data out of node will not be written to filename.

To insert all of an EphyNode's contents without exception, simply give the integer 0 after node.

The remainder of this function's arguments will be groups of such EphyNode - integer - (list of EphyNodes). Finally, the last argument must be NULL.

ephy_node_db_get_name ()

const char* ephy_node_db_get_name           (EphyNodeDb *db);

ephy_node_db_is_immutable ()

gboolean    ephy_node_db_is_immutable       (EphyNodeDb *db);

ephy_node_db_set_immutable ()

void        ephy_node_db_set_immutable      (EphyNodeDb *db,
                                             gboolean immutable);

If immutable is TRUE, sets db immutable (read-only). Otherwise, sets db to be read-write.

ephy_node_db_get_node_from_id ()

EphyNode*   ephy_node_db_get_node_from_id   (EphyNodeDb *db,
                                             guint id);

Returns the EphyNode with id id from db, or NULL if no such id exists.