1
/* GTK - The GIMP Toolkit
2
* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball, Josh MacDonald
3
* Copyright (C) 1997-1998 Jay Painter <jpaint@serv.net><jpaint@gimp.org>
5
* GtkCTree widget for GTK+
6
* Copyright (C) 1998 Lars Hamann and Stefan Jeske
8
* This library is free software; you can redistribute it and/or
9
* modify it under the terms of the GNU Lesser General Public
10
* License as published by the Free Software Foundation; either
11
* version 2 of the License, or (at your option) any later version.
13
* This library is distributed in the hope that it will be useful,
14
* but WITHOUT ANY WARRANTY; without even the implied warranty of
15
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
* Lesser General Public License for more details.
18
* You should have received a copy of the GNU Lesser General Public
19
* License along with this library; if not, write to the
20
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21
* Boston, MA 02111-1307, USA.
25
* Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
26
* file for a list of people on the GTK+ Team. See the ChangeLog
27
* files for a list of changes. These files are distributed with
28
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31
#ifndef GTK_DISABLE_DEPRECATED
33
#ifndef __GTK_CTREE_H__
34
#define __GTK_CTREE_H__
36
#include <gtk/gtkclist.h>
40
#define GTK_TYPE_CTREE (gtk_ctree_get_type ())
41
#define GTK_CTREE(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_CTREE, GtkCTree))
42
#define GTK_CTREE_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_CTREE, GtkCTreeClass))
43
#define GTK_IS_CTREE(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_CTREE))
44
#define GTK_IS_CTREE_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_CTREE))
45
#define GTK_CTREE_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_CTREE, GtkCTreeClass))
47
#define GTK_CTREE_ROW(_node_) ((GtkCTreeRow *)(((GList *)(_node_))->data))
48
#define GTK_CTREE_NODE(_node_) ((GtkCTreeNode *)((_node_)))
49
#define GTK_CTREE_NODE_NEXT(_nnode_) ((GtkCTreeNode *)(((GList *)(_nnode_))->next))
50
#define GTK_CTREE_NODE_PREV(_pnode_) ((GtkCTreeNode *)(((GList *)(_pnode_))->prev))
51
#define GTK_CTREE_FUNC(_func_) ((GtkCTreeFunc)(_func_))
53
#define GTK_TYPE_CTREE_NODE (gtk_ctree_node_get_type ())
58
GTK_CTREE_POS_AS_CHILD,
65
GTK_CTREE_LINES_SOLID,
66
GTK_CTREE_LINES_DOTTED,
67
GTK_CTREE_LINES_TABBED
72
GTK_CTREE_EXPANDER_NONE,
73
GTK_CTREE_EXPANDER_SQUARE,
74
GTK_CTREE_EXPANDER_TRIANGLE,
75
GTK_CTREE_EXPANDER_CIRCULAR
76
} GtkCTreeExpanderStyle;
80
GTK_CTREE_EXPANSION_EXPAND,
81
GTK_CTREE_EXPANSION_EXPAND_RECURSIVE,
82
GTK_CTREE_EXPANSION_COLLAPSE,
83
GTK_CTREE_EXPANSION_COLLAPSE_RECURSIVE,
84
GTK_CTREE_EXPANSION_TOGGLE,
85
GTK_CTREE_EXPANSION_TOGGLE_RECURSIVE
86
} GtkCTreeExpansionType;
88
typedef struct _GtkCTree GtkCTree;
89
typedef struct _GtkCTreeClass GtkCTreeClass;
90
typedef struct _GtkCTreeRow GtkCTreeRow;
91
typedef struct _GtkCTreeNode GtkCTreeNode;
93
typedef void (*GtkCTreeFunc) (GtkCTree *ctree,
97
typedef gboolean (*GtkCTreeGNodeFunc) (GtkCTree *ctree,
103
typedef gboolean (*GtkCTreeCompareDragFunc) (GtkCTree *ctree,
104
GtkCTreeNode *source_node,
105
GtkCTreeNode *new_parent,
106
GtkCTreeNode *new_sibling);
118
guint line_style : 2;
119
guint expander_style : 2;
122
GtkCTreeCompareDragFunc drag_compare;
125
struct _GtkCTreeClass
127
GtkCListClass parent_class;
129
void (*tree_select_row) (GtkCTree *ctree,
132
void (*tree_unselect_row) (GtkCTree *ctree,
135
void (*tree_expand) (GtkCTree *ctree,
137
void (*tree_collapse) (GtkCTree *ctree,
139
void (*tree_move) (GtkCTree *ctree,
141
GtkCTreeNode *new_parent,
142
GtkCTreeNode *new_sibling);
143
void (*change_focus_row_expansion) (GtkCTree *ctree,
144
GtkCTreeExpansionType action);
151
GtkCTreeNode *parent;
152
GtkCTreeNode *sibling;
153
GtkCTreeNode *children;
155
GdkPixmap *pixmap_closed;
156
GdkBitmap *mask_closed;
157
GdkPixmap *pixmap_opened;
158
GdkBitmap *mask_opened;
166
struct _GtkCTreeNode {
171
/***********************************************************
172
* Creation, insertion, deletion *
173
***********************************************************/
175
GtkType gtk_ctree_get_type (void) G_GNUC_CONST;
176
GtkWidget * gtk_ctree_new_with_titles (gint columns,
179
GtkWidget * gtk_ctree_new (gint columns,
181
GtkCTreeNode * gtk_ctree_insert_node (GtkCTree *ctree,
182
GtkCTreeNode *parent,
183
GtkCTreeNode *sibling,
186
GdkPixmap *pixmap_closed,
187
GdkBitmap *mask_closed,
188
GdkPixmap *pixmap_opened,
189
GdkBitmap *mask_opened,
192
void gtk_ctree_remove_node (GtkCTree *ctree,
194
GtkCTreeNode * gtk_ctree_insert_gnode (GtkCTree *ctree,
195
GtkCTreeNode *parent,
196
GtkCTreeNode *sibling,
198
GtkCTreeGNodeFunc func,
200
GNode * gtk_ctree_export_to_gnode (GtkCTree *ctree,
204
GtkCTreeGNodeFunc func,
207
/***********************************************************
208
* Generic recursive functions, querying / finding tree *
210
***********************************************************/
212
void gtk_ctree_post_recursive (GtkCTree *ctree,
216
void gtk_ctree_post_recursive_to_depth (GtkCTree *ctree,
221
void gtk_ctree_pre_recursive (GtkCTree *ctree,
225
void gtk_ctree_pre_recursive_to_depth (GtkCTree *ctree,
230
gboolean gtk_ctree_is_viewable (GtkCTree *ctree,
232
GtkCTreeNode * gtk_ctree_last (GtkCTree *ctree,
234
GtkCTreeNode * gtk_ctree_find_node_ptr (GtkCTree *ctree,
235
GtkCTreeRow *ctree_row);
236
GtkCTreeNode * gtk_ctree_node_nth (GtkCTree *ctree,
238
gboolean gtk_ctree_find (GtkCTree *ctree,
240
GtkCTreeNode *child);
241
gboolean gtk_ctree_is_ancestor (GtkCTree *ctree,
243
GtkCTreeNode *child);
244
GtkCTreeNode * gtk_ctree_find_by_row_data (GtkCTree *ctree,
247
/* returns a GList of all GtkCTreeNodes with row->data == data. */
248
GList * gtk_ctree_find_all_by_row_data (GtkCTree *ctree,
251
GtkCTreeNode * gtk_ctree_find_by_row_data_custom (GtkCTree *ctree,
255
/* returns a GList of all GtkCTreeNodes with row->data == data. */
256
GList * gtk_ctree_find_all_by_row_data_custom (GtkCTree *ctree,
260
gboolean gtk_ctree_is_hot_spot (GtkCTree *ctree,
264
/***********************************************************
265
* Tree signals : move, expand, collapse, (un)select *
266
***********************************************************/
268
void gtk_ctree_move (GtkCTree *ctree,
270
GtkCTreeNode *new_parent,
271
GtkCTreeNode *new_sibling);
272
void gtk_ctree_expand (GtkCTree *ctree,
274
void gtk_ctree_expand_recursive (GtkCTree *ctree,
276
void gtk_ctree_expand_to_depth (GtkCTree *ctree,
279
void gtk_ctree_collapse (GtkCTree *ctree,
281
void gtk_ctree_collapse_recursive (GtkCTree *ctree,
283
void gtk_ctree_collapse_to_depth (GtkCTree *ctree,
286
void gtk_ctree_toggle_expansion (GtkCTree *ctree,
288
void gtk_ctree_toggle_expansion_recursive (GtkCTree *ctree,
290
void gtk_ctree_select (GtkCTree *ctree,
292
void gtk_ctree_select_recursive (GtkCTree *ctree,
294
void gtk_ctree_unselect (GtkCTree *ctree,
296
void gtk_ctree_unselect_recursive (GtkCTree *ctree,
298
void gtk_ctree_real_select_recursive (GtkCTree *ctree,
302
/***********************************************************
303
* Analogons of GtkCList functions *
304
***********************************************************/
306
void gtk_ctree_node_set_text (GtkCTree *ctree,
310
void gtk_ctree_node_set_pixmap (GtkCTree *ctree,
315
void gtk_ctree_node_set_pixtext (GtkCTree *ctree,
322
void gtk_ctree_set_node_info (GtkCTree *ctree,
326
GdkPixmap *pixmap_closed,
327
GdkBitmap *mask_closed,
328
GdkPixmap *pixmap_opened,
329
GdkBitmap *mask_opened,
332
void gtk_ctree_node_set_shift (GtkCTree *ctree,
337
void gtk_ctree_node_set_selectable (GtkCTree *ctree,
339
gboolean selectable);
340
gboolean gtk_ctree_node_get_selectable (GtkCTree *ctree,
342
GtkCellType gtk_ctree_node_get_cell_type (GtkCTree *ctree,
345
gboolean gtk_ctree_node_get_text (GtkCTree *ctree,
349
gboolean gtk_ctree_node_get_pixmap (GtkCTree *ctree,
354
gboolean gtk_ctree_node_get_pixtext (GtkCTree *ctree,
361
gboolean gtk_ctree_get_node_info (GtkCTree *ctree,
365
GdkPixmap **pixmap_closed,
366
GdkBitmap **mask_closed,
367
GdkPixmap **pixmap_opened,
368
GdkBitmap **mask_opened,
371
void gtk_ctree_node_set_row_style (GtkCTree *ctree,
374
GtkStyle * gtk_ctree_node_get_row_style (GtkCTree *ctree,
376
void gtk_ctree_node_set_cell_style (GtkCTree *ctree,
380
GtkStyle * gtk_ctree_node_get_cell_style (GtkCTree *ctree,
383
void gtk_ctree_node_set_foreground (GtkCTree *ctree,
385
const GdkColor *color);
386
void gtk_ctree_node_set_background (GtkCTree *ctree,
388
const GdkColor *color);
389
void gtk_ctree_node_set_row_data (GtkCTree *ctree,
392
void gtk_ctree_node_set_row_data_full (GtkCTree *ctree,
395
GtkDestroyNotify destroy);
396
gpointer gtk_ctree_node_get_row_data (GtkCTree *ctree,
398
void gtk_ctree_node_moveto (GtkCTree *ctree,
403
GtkVisibility gtk_ctree_node_is_visible (GtkCTree *ctree,
406
/***********************************************************
407
* GtkCTree specific functions *
408
***********************************************************/
410
void gtk_ctree_set_indent (GtkCTree *ctree,
412
void gtk_ctree_set_spacing (GtkCTree *ctree,
414
void gtk_ctree_set_show_stub (GtkCTree *ctree,
416
void gtk_ctree_set_line_style (GtkCTree *ctree,
417
GtkCTreeLineStyle line_style);
418
void gtk_ctree_set_expander_style (GtkCTree *ctree,
419
GtkCTreeExpanderStyle expander_style);
420
void gtk_ctree_set_drag_compare_func (GtkCTree *ctree,
421
GtkCTreeCompareDragFunc cmp_func);
423
/***********************************************************
424
* Tree sorting functions *
425
***********************************************************/
427
void gtk_ctree_sort_node (GtkCTree *ctree,
429
void gtk_ctree_sort_recursive (GtkCTree *ctree,
433
#define gtk_ctree_set_reorderable(t,r) gtk_clist_set_reorderable((GtkCList*) (t),(r))
435
/* GType for the GtkCTreeNode. This is a boxed type, although it uses
436
* no-op's for the copy and free routines. It is defined in order to
437
* provide type information for the signal arguments
439
GType gtk_ctree_node_get_type (void) G_GNUC_CONST;
443
#endif /* __GTK_CTREE_H__ */
445
#endif /* GTK_DISABLE_DEPRECATED */