aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ephy-node.h
blob: 8c142d52899f0835739863c5c36604b974c45954 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 *  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 (*children_reordered) (EphyNode *node, int *new_order);
    void (*child_removed)   (EphyNode *node, EphyNode *child);
} EphyNodeClass;

GType       ephy_node_get_type              (void);

EphyNode   *ephy_node_new                   (void);

EphyNode   *ephy_node_new_with_id           (gulong reserved_id);

/* 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);

void        ephy_node_reorder_children      (EphyNode *node,
                         int *new_order);

/* 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           (gulong reserved_ids);
void        ephy_node_system_shutdown       (void);

long        ephy_node_new_id                (void);

G_END_DECLS

#endif /* __EPHY_NODE_H */