summaryrefslogtreecommitdiff
path: root/gtk/gtktreemodel.h
blob: e70034943ae629aa08c025b2562993c29e069e5b (plain)
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
/* gtktreemodel.h
 * Copyright (C) 2000  Red Hat, Inc.,  Jonathan Blandford <jrb@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GTK_TREE_MODEL_H__
#define __GTK_TREE_MODEL_H__

#include <gtk/gtkobject.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define GTK_TYPE_TREE_MODEL            (gtk_tree_model_get_type ())
#define GTK_TREE_MODEL(obj)            (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModel))
#define GTK_TREE_MODEL_CLASS(klass)    (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_MODEL, GtkTreeModelClass))
#define GTK_IS_TREE_MODEL(obj)	       (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_MODEL))
#define GTK_IS_TREE_MODEL_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_MODEL))
#define GTK_TREE_MODEL_GET_CLASS(obj)  (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_MODEL, GtkTreeModelClass))

typedef gpointer                  GtkTreeNode;
typedef struct _GtkTreePath       GtkTreePath;
typedef struct _GtkTreeModel      GtkTreeModel;
typedef struct _GtkTreeModelClass GtkTreeModelClass;

struct _GtkTreeModel
{
  GtkObject parent;
};

struct _GtkTreeModelClass
{
  GtkObjectClass parent_class;

  /* signals */
  void       (* node_changed)         (GtkTreeModel *tree_model,
				       GtkTreePath  *path,
				       GtkTreeNode  *node);
  void       (* node_inserted)        (GtkTreeModel *tree_model,
				       GtkTreePath  *path,
				       GtkTreeNode  *node);
  void       (* node_child_toggled)   (GtkTreeModel *tree_model,
				       GtkTreePath  *path,
				       GtkTreeNode  *node);
  void       (* node_deleted)         (GtkTreeModel *tree_model,
				       GtkTreePath  *path);

  /* VTable - not signals */
  gint         (* get_n_columns)   (GtkTreeModel *tree_model);
  GtkTreeNode  (* get_node)        (GtkTreeModel *tree_model,
				    GtkTreePath  *path);
  GtkTreePath *(* get_path)        (GtkTreeModel *tree_model,
				    GtkTreeNode   node);
  void         (* node_get_value)  (GtkTreeModel *tree_model,
				    GtkTreeNode   node,
				    gint          column,
				    GValue       *value);
  gboolean     (* node_next)       (GtkTreeModel *tree_model,
				    GtkTreeNode  *node);
  GtkTreeNode  (* node_children)   (GtkTreeModel *tree_model,
				    GtkTreeNode   node);
  gboolean     (* node_has_child)  (GtkTreeModel *tree_model,
				    GtkTreeNode   node);
  gint         (* node_n_children) (GtkTreeModel *tree_model,
				    GtkTreeNode   node);
  GtkTreeNode  (* node_nth_child)  (GtkTreeModel *tree_model,
				    GtkTreeNode   node,
				    gint          n);
  GtkTreeNode  (* node_parent)     (GtkTreeModel *tree_model,
				    GtkTreeNode   node);
};


/* Basic tree_model operations */
GtkType        gtk_tree_model_get_type        (void);

/* GtkTreePath Operations */
GtkTreePath   *gtk_tree_path_new              (void);
GtkTreePath   *gtk_tree_path_new_from_string  (gchar        *path);
gchar         *gtk_tree_path_to_string        (GtkTreePath  *path);
GtkTreePath   *gtk_tree_path_new_root         (void);
void           gtk_tree_path_append_index     (GtkTreePath  *path,
					       gint          index);
void           gtk_tree_path_prepend_index    (GtkTreePath  *path,
					       gint          index);
gint           gtk_tree_path_get_depth        (GtkTreePath  *path);
gint          *gtk_tree_path_get_indices      (GtkTreePath  *path);
void           gtk_tree_path_free             (GtkTreePath  *path);
GtkTreePath   *gtk_tree_path_copy             (GtkTreePath  *path);
gint           gtk_tree_path_compare          (GtkTreePath  *a,
					       GtkTreePath  *b);
void           gtk_tree_path_next             (GtkTreePath  *path);
gint           gtk_tree_path_prev             (GtkTreePath  *path);
gint           gtk_tree_path_up               (GtkTreePath  *path);
void           gtk_tree_path_down             (GtkTreePath  *path);

/* Header operations */
gint           gtk_tree_model_get_n_columns   (GtkTreeModel *tree_model);

/* Node operations */
GtkTreeNode    gtk_tree_model_get_node        (GtkTreeModel *tree_model,
					       GtkTreePath  *path);
GtkTreePath   *gtk_tree_model_get_path        (GtkTreeModel *tree_model,
					       GtkTreeNode   node);
void           gtk_tree_model_node_get_value  (GtkTreeModel *tree_model,
					       GtkTreeNode   node,
					       gint          column,
					       GValue       *value);
gboolean       gtk_tree_model_node_next       (GtkTreeModel *tree_model,
					       GtkTreeNode  *node);
GtkTreeNode    gtk_tree_model_node_children   (GtkTreeModel *tree_model,
					       GtkTreeNode   node);
gboolean       gtk_tree_model_node_has_child  (GtkTreeModel *tree_model,
					       GtkTreeNode   node);
gint           gtk_tree_model_node_n_children (GtkTreeModel *tree_model,
					       GtkTreeNode   node);
GtkTreeNode    gtk_tree_model_node_nth_child  (GtkTreeModel *tree_model,
					       GtkTreeNode   node,
					       gint          n);
GtkTreeNode    gtk_tree_model_node_parent     (GtkTreeModel *tree_model,
					       GtkTreeNode   node);


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* __GTK_TREE_MODEL_H__ */