aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ephy-node.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/ephy-node.h')
-rw-r--r--lib/ephy-node.h144
1 files changed, 144 insertions, 0 deletions
diff --git a/lib/ephy-node.h b/lib/ephy-node.h
new file mode 100644
index 000000000..2e5f92210
--- /dev/null
+++ b/lib/ephy-node.h
@@ -0,0 +1,144 @@
+/*
+ * Copyright (C) 2002 Jorn Baayen <jorn@nl.linux.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * $Id$
+ */
+
+#ifndef EPHY_NODE_H
+#define EPHY_NODE_H
+
+#include <glib-object.h>
+
+#include <libxml/tree.h>
+
+G_BEGIN_DECLS
+
+#define EPHY_TYPE_NODE (ephy_node_get_type ())
+#define EPHY_NODE(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), EPHY_TYPE_NODE, EphyNode))
+#define EPHY_NODE_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), EPHY_TYPE_NODE, EphyNodeClass))
+#define EPHY_IS_NODE(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), EPHY_TYPE_NODE))
+#define EPHY_IS_NODE_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), EPHY_TYPE_NODE))
+#define EPHY_NODE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EPHY_TYPE_NODE, EphyNodeClass))
+
+typedef struct EphyNodePrivate EphyNodePrivate;
+
+typedef struct
+{
+ GObject parent;
+
+ EphyNodePrivate *priv;
+} EphyNode;
+
+typedef struct
+{
+ GObjectClass parent;
+
+ /* signals */
+ void (*destroyed) (EphyNode *node);
+ void (*restored) (EphyNode *node);
+
+ void (*child_added) (EphyNode *node, EphyNode *child);
+ void (*child_changed) (EphyNode *node, EphyNode *child);
+ void (*child_reordered) (EphyNode *node, EphyNode *child,
+ int old_index, int new_index);
+ void (*child_removed) (EphyNode *node, EphyNode *child);
+} EphyNodeClass;
+
+GType ephy_node_get_type (void);
+
+EphyNode *ephy_node_new (void);
+
+/* unique node ID */
+long ephy_node_get_id (EphyNode *node);
+
+EphyNode *ephy_node_get_from_id (gulong id);
+
+/* refcounting */
+void ephy_node_ref (EphyNode *node);
+void ephy_node_unref (EphyNode *node);
+
+/* locking */
+void ephy_node_freeze (EphyNode *node);
+void ephy_node_thaw (EphyNode *node);
+
+/* property interface */
+enum
+{
+ EPHY_NODE_PROP_NAME = 0,
+ EPHY_NODE_PROP_NAME_SORT_KEY = 1
+};
+
+void ephy_node_set_property (EphyNode *node,
+ guint property_id,
+ const GValue *value);
+gboolean ephy_node_get_property (EphyNode *node,
+ guint property_id,
+ GValue *value);
+
+const char *ephy_node_get_property_string (EphyNode *node,
+ guint property_id);
+gboolean ephy_node_get_property_boolean (EphyNode *node,
+ guint property_id);
+long ephy_node_get_property_long (EphyNode *node,
+ guint property_id);
+int ephy_node_get_property_int (EphyNode *node,
+ guint property_id);
+double ephy_node_get_property_double (EphyNode *node,
+ guint property_id);
+float ephy_node_get_property_float (EphyNode *node,
+ guint property_id);
+EphyNode *ephy_node_get_property_node (EphyNode *node,
+ guint property_id);
+/* free return value */
+char *ephy_node_get_property_time (EphyNode *node,
+ guint property_id);
+
+/* xml storage */
+void ephy_node_save_to_xml (EphyNode *node,
+ xmlNodePtr parent_xml_node);
+EphyNode *ephy_node_new_from_xml (xmlNodePtr xml_node);
+
+/* DAG structure */
+void ephy_node_add_child (EphyNode *node,
+ EphyNode *child);
+void ephy_node_remove_child (EphyNode *node,
+ EphyNode *child);
+gboolean ephy_node_has_child (EphyNode *node,
+ EphyNode *child);
+
+/* Note that ephy_node_get_children freezes the node; you'll have to thaw it when done.
+ * This is to prevent the data getting changed from another thread. */
+GPtrArray *ephy_node_get_children (EphyNode *node);
+int ephy_node_get_n_children (EphyNode *node);
+EphyNode *ephy_node_get_nth_child (EphyNode *node,
+ guint n);
+int ephy_node_get_child_index (EphyNode *node,
+ EphyNode *child);
+EphyNode *ephy_node_get_next_child (EphyNode *node,
+ EphyNode *child);
+EphyNode *ephy_node_get_previous_child (EphyNode *node,
+ EphyNode *child);
+
+/* node id services */
+void ephy_node_system_init (void);
+void ephy_node_system_shutdown (void);
+
+long ephy_node_new_id (void);
+
+G_END_DECLS
+
+#endif /* __EPHY_NODE_H */