Mercurial > pidgin.yaz
annotate finch/libgnt/gnttree.h @ 18419:e79da0369a6d
Docs for GntTree.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Tue, 03 Jul 2007 01:50:16 +0000 |
parents | 9a0f99ea664d |
children | e2b8b17fc62c |
rev | line source |
---|---|
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
1 /** |
18303
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18118
diff
changeset
|
2 * @file gnttree.h Tree API |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18118
diff
changeset
|
3 * @ingroup gnt |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18118
diff
changeset
|
4 */ |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18118
diff
changeset
|
5 /* |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
6 * GNT - The GLib Ncurses Toolkit |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
7 * |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
8 * GNT is the legal property of its developers, whose names are too numerous |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
10 * source distribution. |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
11 * |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
12 * This library is free software; you can redistribute it and/or modify |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
15 * (at your option) any later version. |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
16 * |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
20 * GNU General Public License for more details. |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
21 * |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
25 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
26 |
15818 | 27 #ifndef GNT_TREE_H |
28 #define GNT_TREE_H | |
29 | |
30 #include "gntwidget.h" | |
31 #include "gnt.h" | |
32 #include "gntcolors.h" | |
33 #include "gntkeys.h" | |
34 #include "gnttextview.h" | |
35 | |
36 #define GNT_TYPE_TREE (gnt_tree_get_gtype()) | |
37 #define GNT_TREE(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_TREE, GntTree)) | |
38 #define GNT_TREE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_TREE, GntTreeClass)) | |
39 #define GNT_IS_TREE(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_TREE)) | |
40 #define GNT_IS_TREE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_TREE)) | |
41 #define GNT_TREE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_TREE, GntTreeClass)) | |
42 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
43 typedef struct _GntTree GntTree; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
44 typedef struct _GntTreePriv GntTreePriv; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
45 typedef struct _GntTreeClass GntTreeClass; |
15818 | 46 |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
47 typedef struct _GntTreeRow GntTreeRow; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
48 typedef struct _GntTreeCol GntTreeCol; |
15818 | 49 |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
50 typedef enum { |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
51 GNT_TREE_COLUMN_INVISIBLE = 1 << 0, |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
52 GNT_TREE_COLUMN_FIXED_SIZE = 1 << 1, |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
53 } GntTreeColumnFlag; |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
54 |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
55 struct _GntTree |
15818 | 56 { |
57 GntWidget parent; | |
58 | |
59 GntTreeRow *current; /* current selection */ | |
60 | |
61 GntTreeRow *top; /* The topmost visible item */ | |
62 GntTreeRow *bottom; /* The bottommost visible item */ | |
63 | |
64 GntTreeRow *root; /* The root of all evil */ | |
65 | |
66 GList *list; /* List of GntTreeRow s */ | |
67 GHashTable *hash; /* We need this for quickly referencing the rows */ | |
68 guint (*hash_func)(gconstpointer); | |
69 gboolean (*hash_eq_func)(gconstpointer, gconstpointer); | |
70 GDestroyNotify key_destroy; | |
71 GDestroyNotify value_destroy; | |
72 | |
73 int ncol; /* No. of columns */ | |
74 struct _GntTreeColInfo | |
75 { | |
76 int width; | |
77 char *title; | |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
78 int width_ratio; |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
79 GntTreeColumnFlag flags; |
15818 | 80 } *columns; /* Would a GList be better? */ |
81 gboolean show_title; | |
82 gboolean show_separator; /* Whether to show column separators */ | |
83 | |
84 GString *search; | |
85 int search_timeout; | |
86 | |
87 GCompareFunc compare; | |
88 }; | |
89 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
90 struct _GntTreeClass |
15818 | 91 { |
92 GntWidgetClass parent; | |
93 | |
94 void (*selection_changed)(GntTreeRow *old, GntTreeRow * current); | |
95 void (*toggled)(GntTree *tree, gpointer key); | |
96 | |
97 void (*gnt_reserved1)(void); | |
98 void (*gnt_reserved2)(void); | |
99 void (*gnt_reserved3)(void); | |
100 void (*gnt_reserved4)(void); | |
101 }; | |
102 | |
103 G_BEGIN_DECLS | |
104 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
105 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
106 * @return The GType for GntTree |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
107 */ |
15818 | 108 GType gnt_tree_get_gtype(void); |
109 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
110 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
111 * Create a tree with one column. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
112 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
113 * @return The newly created tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
114 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
115 * @see gnt_tree_new_with_columns |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
116 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
117 GntWidget * gnt_tree_new(void); |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
118 |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
119 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
120 * Create a tree with a specified number of columns. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
121 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
122 * @param columns Number of columns |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
123 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
124 * @return The newly created tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
125 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
126 * @see gnt_tree_new |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
127 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
128 GntWidget * gnt_tree_new_with_columns(int columns); |
15818 | 129 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
130 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
131 * The number of rows the tree should display at a time. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
132 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
133 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
134 * @param rows The number of rows |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
135 */ |
15818 | 136 void gnt_tree_set_visible_rows(GntTree *tree, int rows); |
137 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
138 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
139 * Get the number visible rows. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
140 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
141 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
142 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
143 * @return The number of visible rows |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
144 */ |
15818 | 145 int gnt_tree_get_visible_rows(GntTree *tree); |
146 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
147 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
148 * Scroll the contents of the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
149 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
150 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
151 * @param count If positive, the tree will be scrolled down by count rows, |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
152 * otherwise, it will be scrolled up by count rows. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
153 */ |
15818 | 154 void gnt_tree_scroll(GntTree *tree, int count); |
155 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
156 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
157 * Insert a row in the tree. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
158 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
159 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
160 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
161 * @param row The row to insert |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
162 * @param parent The key for the parent row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
163 * @param bigbro The key for the row to insert the new row after. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
164 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
165 * @return The inserted row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
166 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
167 * @see gnt_tree_create_row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
168 * @see gnt_tree_add_row_last |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
169 * @see gnt_tree_add_choice |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
170 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
171 GntTreeRow * gnt_tree_add_row_after(GntTree *tree, void *key, GntTreeRow *row, void *parent, void *bigbro); |
15818 | 172 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
173 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
174 * Insert a row at the end of the tree. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
175 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
176 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
177 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
178 * @param row The row to insert |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
179 * @param parent The key for the parent row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
180 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
181 * @return The inserted row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
182 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
183 * @see gnt_tree_create_row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
184 * @see gnt_tree_add_row_after |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
185 * @see gnt_tree_add_choice |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
186 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
187 GntTreeRow * gnt_tree_add_row_last(GntTree *tree, void *key, GntTreeRow *row, void *parent); |
15818 | 188 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
189 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
190 * Get the key for the selected row. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
191 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
192 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
193 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
194 * @return The key for the selected row |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
195 */ |
15818 | 196 gpointer gnt_tree_get_selection_data(GntTree *tree); |
197 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
198 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
199 * Get the text displayed for the selected row. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
200 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
201 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
202 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
203 * @return The text, which needs to be freed by the caller |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
204 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
205 char * gnt_tree_get_selection_text(GntTree *tree); |
15818 | 206 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
207 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
208 * Get a list of text of the current row. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
209 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
210 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
211 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
212 * @return A list of texts of the currently selected row. The list |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
213 * and its data should be freed by the caller. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
214 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
215 GList * gnt_tree_get_selection_text_list(GntTree *tree); |
15818 | 216 |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18049
diff
changeset
|
217 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
218 * Returns the list of rows in the tree. |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18049
diff
changeset
|
219 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
220 * @param tree The tree |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18049
diff
changeset
|
221 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
222 * @return The list of the rows. The list should not be modified by the caller. |
18118
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18049
diff
changeset
|
223 */ |
ab6d2763b8d8
Re-fix the DBus list handling code by killing const GList* / const GSList*
Richard Laager <rlaager@wiktel.com>
parents:
18049
diff
changeset
|
224 GList *gnt_tree_get_rows(GntTree *tree); |
15818 | 225 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
226 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
227 * Remove a row from the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
228 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
229 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
230 * @param key The key for the row to remove |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
231 */ |
15818 | 232 void gnt_tree_remove(GntTree *tree, gpointer key); |
233 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
234 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
235 * Remove all the item from the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
236 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
237 * @param tree The tree |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
238 */ |
15818 | 239 void gnt_tree_remove_all(GntTree *tree); |
240 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
241 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
242 * Get the visible line number of the selected row. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
243 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
244 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
245 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
246 * @return The line number of the currently selected row |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
247 */ |
15818 | 248 int gnt_tree_get_selection_visible_line(GntTree *tree); |
249 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
250 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
251 * Change the text of a column in a row. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
252 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
253 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
254 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
255 * @param colno The index of the column |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
256 * @param text The new text |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
257 */ |
15818 | 258 void gnt_tree_change_text(GntTree *tree, gpointer key, int colno, const char *text); |
259 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
260 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
261 * Add a checkable item in the tree. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
262 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
263 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
264 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
265 * @param row The row to add |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
266 * @param parent The parent of the row, or @c NULL |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
267 * @param bigbro The row to insert after, or @c NULL |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
268 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
269 * @return The row inserted. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
270 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
271 * @see gnt_tree_create_row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
272 * @see gnt_tree_create_row_from_list |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
273 * @see gnt_tree_add_row_last |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
274 * @see gnt_tree_add_row_after |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
275 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
276 GntTreeRow * gnt_tree_add_choice(GntTree *tree, void *key, GntTreeRow *row, void *parent, void *bigbro); |
15818 | 277 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
278 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
279 * Set whether a checkable item is checked or not. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
280 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
281 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
282 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
283 * @param set @c TRUE if the item should be checked, @c FALSE if not |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
284 */ |
15818 | 285 void gnt_tree_set_choice(GntTree *tree, void *key, gboolean set); |
286 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
287 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
288 * Return whether a row is selected or not, where the row is a checkable item. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
289 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
290 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
291 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
292 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
293 * @return @c TRUE if the row is checked, @c FALSE otherwise. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
294 */ |
15818 | 295 gboolean gnt_tree_get_choice(GntTree *tree, void *key); |
296 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
297 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
298 * Set flags for the text in a row in the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
299 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
300 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
301 * @param key The key for the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
302 * @param flags The flags to set |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
303 */ |
15818 | 304 void gnt_tree_set_row_flags(GntTree *tree, void *key, GntTextFormatFlags flags); |
305 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
306 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
307 * Select a row. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
308 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
309 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
310 * @param key The key of the row to select |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
311 */ |
15818 | 312 void gnt_tree_set_selected(GntTree *tree , void *key); |
313 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
314 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
315 * Create a row to insert in the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
316 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
317 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
318 * @param ... A string for each column in the tree |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
319 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
320 * @return The row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
321 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
322 * @see gnt_tree_create_row_from_list |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
323 * @see gnt_tree_add_row_after |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
324 * @see gnt_tree_add_row_last |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
325 * @see gnt_tree_add_choice |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
326 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
327 GntTreeRow * gnt_tree_create_row(GntTree *tree, ...); |
15818 | 328 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
329 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
330 * Create a row from a list of text. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
331 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
332 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
333 * @param list The list containing the text for each column |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
334 * |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
335 * @return The row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
336 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
337 * @see gnt_tree_create_row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
338 * @see gnt_tree_add_row_after |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
339 * @see gnt_tree_add_row_last |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
340 * @see gnt_tree_add_choice |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
341 */ |
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
342 GntTreeRow * gnt_tree_create_row_from_list(GntTree *tree, GList *list); |
15818 | 343 |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
344 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
345 * Set the width of a column in the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
346 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
347 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
348 * @param col The index of the column |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
349 * @param width The width for the column |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
350 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
351 * @see gnt_tree_set_column_width_ratio |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
352 * @see gnt_tree_set_column_resizable |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
353 */ |
15818 | 354 void gnt_tree_set_col_width(GntTree *tree, int col, int width); |
355 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
356 /** |
18348
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
357 * Set the title for a column. |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
358 * |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
359 * @param tree The tree |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
360 * @param index The index of the column |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
361 * @param title The title for the column |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
362 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
363 * @see gnt_tree_set_column_titles |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
364 * @see gnt_tree_set_show_title |
18348
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
365 */ |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
366 void gnt_tree_set_column_title(GntTree *tree, int index, const char *title); |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
367 |
1f9db757efc2
Oops. I missed this. This allows setting tree-column titles one by one.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18303
diff
changeset
|
368 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
369 * Set the titles of the columns |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
370 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
371 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
372 * @param ... One title for each column in the tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
373 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
374 * @see gnt_tree_set_column_title |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
375 * @see gnt_tree_set_show_title |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
376 */ |
15818 | 377 void gnt_tree_set_column_titles(GntTree *tree, ...); |
378 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
379 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
380 * Set whether to display the title of the columns. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
381 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
382 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
383 * @param set If @c TRUE, the column titles are displayed |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
384 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
385 * @see gnt_tree_set_column_title |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
386 * @see gnt_tree_set_column_titles |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
387 */ |
15818 | 388 void gnt_tree_set_show_title(GntTree *tree, gboolean set); |
389 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
390 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
391 * Set the compare function for sorting the data. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
392 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
393 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
394 * @param func The comparison function, which is used to compare |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
395 * the keys |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
396 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
397 * @see gnt_tree_sort_row |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
398 */ |
15818 | 399 void gnt_tree_set_compare_func(GntTree *tree, GCompareFunc func); |
400 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
401 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
402 * Set whether a row, which has child rows, should be expanded. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
403 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
404 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
405 * @param key The key of the row |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
406 * @param expanded Whether to expand the child rows |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
407 */ |
15818 | 408 void gnt_tree_set_expanded(GntTree *tree, void *key, gboolean expanded); |
409 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
410 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
411 * Set whether to show column separators. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
412 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
413 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
414 * @param set If @c TRUE, the column separators are displayed |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
415 */ |
15818 | 416 void gnt_tree_set_show_separator(GntTree *tree, gboolean set); |
417 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
418 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
419 * Sort a row in the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
420 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
421 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
422 * @param row The row to sort |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
423 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
424 * @see gnt_tree_set_compare_func |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
425 */ |
15818 | 426 void gnt_tree_sort_row(GntTree *tree, void *row); |
427 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
428 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
429 * Automatically adjust the width of the columns in the tree. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
430 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
431 * @param tree The tree |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
432 */ |
15818 | 433 void gnt_tree_adjust_columns(GntTree *tree); |
434 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
435 /** |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
436 * Set the hash functions to use to hash, compare and free the keys. |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
437 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
438 * @param tree The tree |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
439 * @param hash The hashing function |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
440 * @param eq The function to compare keys |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
441 * @param kd The function to use to free the keys when a row is removed |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
442 * from the tree |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
443 */ |
15818 | 444 void gnt_tree_set_hash_fns(GntTree *tree, gpointer hash, gpointer eq, gpointer kd); |
445 | |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
446 /** |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
447 * Set whether a column is visible or not. |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
448 * This can be useful when, for example, we want to store some data |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
449 * which we don't want/need to display. |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
450 * |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
451 * @param tree The tree |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
452 * @param col The index of the column |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
453 * @param vis If @c FALSE, the column will not be displayed |
18049
1cedd520cd18
Doxygen skeleton and license info for gnt files.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15970
diff
changeset
|
454 */ |
15970
790d1d003825
Allow making some columns invisible.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15931
diff
changeset
|
455 void gnt_tree_set_column_visible(GntTree *tree, int col, gboolean vis); |
790d1d003825
Allow making some columns invisible.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15931
diff
changeset
|
456 |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
457 /** |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
458 * Set whether a column can be resized to keep the same ratio when the |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
459 * tree is resized. |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
460 * |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
461 * @param tree The tree |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
462 * @param col The index of the column |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
463 * @param res If @c FALSE, the column will not be resized when the |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
464 * tree is resized |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
465 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
466 * @see gnt_tree_set_col_width |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
467 * @see gnt_tree_set_column_width_ratio |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
468 */ |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
469 void gnt_tree_set_column_resizable(GntTree *tree, int col, gboolean res); |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
470 |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
471 /** |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
472 * Set column widths to use when calculating column widths after a tree |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
473 * is resized. |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
474 * |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
475 * @param tree The tree |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
476 * @param cols Array of widths. The width must have the same number |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
477 * of entries as the number of columns in the tree, or |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
478 * end with a negative value for a column-width. |
18419
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
479 * |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
480 * @see gnt_tree_set_col_width |
e79da0369a6d
Docs for GntTree.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18404
diff
changeset
|
481 * @see gnt_tree_set_column_resizable |
18404
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
482 */ |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
483 void gnt_tree_set_column_width_ratio(GntTree *tree, int cols[]); |
9a0f99ea664d
Resize tree-columns nicely when the tree is resized. We can tell it to
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18348
diff
changeset
|
484 |
15818 | 485 G_END_DECLS |
486 | |
487 /* The following functions should NOT be used by applications. */ | |
488 | |
489 /* This should be called by the subclasses of GntTree's in their _new function */ | |
490 void _gnt_tree_init_internals(GntTree *tree, int col); | |
491 | |
492 #endif /* GNT_TREE_H */ |