2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
20 #if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
21 #error "Only <gtk/gtk.h> can be included directly."
24 #ifndef __GTK_TREE_VIEW_COLUMN_H__
25 #define __GTK_TREE_VIEW_COLUMN_H__
27 #include <glib-object.h>
28 #include <gtk/gtkcellrenderer.h>
29 #include <gtk/gtktreemodel.h>
30 #include <gtk/gtktreesortable.h>
32 /* Not needed, retained for compatibility -Yosh */
33 #include <gtk/gtkobject.h>
39 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
40 #define GTK_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
41 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
42 #define GTK_IS_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
43 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
44 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
48 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
49 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
50 GTK_TREE_VIEW_COLUMN_FIXED
51 } GtkTreeViewColumnSizing;
53 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
54 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
56 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
57 GtkCellRenderer *cell,
58 GtkTreeModel *tree_model,
63 struct _GtkTreeViewColumn
73 GtkCellEditable *editable_widget;
75 guint property_changed_signal;
79 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
80 GtkTreeViewColumnSizing column_type;
89 /* dragging columns */
97 guint sort_clicked_signal;
98 guint sort_column_changed_signal;
100 GtkSortType sort_order;
107 guint show_sort_indicator : 1;
108 guint maybe_reordered : 1;
109 guint reorderable : 1;
110 guint use_resized_width : 1;
114 struct _GtkTreeViewColumnClass
116 GtkObjectClass parent_class;
118 void (*clicked) (GtkTreeViewColumn *tree_column);
120 /* Padding for future expansion */
121 void (*_gtk_reserved1) (void);
122 void (*_gtk_reserved2) (void);
123 void (*_gtk_reserved3) (void);
124 void (*_gtk_reserved4) (void);
127 GType gtk_tree_view_column_get_type (void) G_GNUC_CONST;
128 GtkTreeViewColumn *gtk_tree_view_column_new (void);
129 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar *title,
130 GtkCellRenderer *cell,
131 ...) G_GNUC_NULL_TERMINATED;
132 void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
133 GtkCellRenderer *cell,
135 void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
136 GtkCellRenderer *cell,
138 void gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
139 GList *gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column);
140 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
141 GtkCellRenderer *cell_renderer,
142 const gchar *attribute,
144 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
145 GtkCellRenderer *cell_renderer,
146 ...) G_GNUC_NULL_TERMINATED;
147 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
148 GtkCellRenderer *cell_renderer,
149 GtkTreeCellDataFunc func,
151 GDestroyNotify destroy);
152 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
153 GtkCellRenderer *cell_renderer);
154 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
156 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
157 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
159 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
160 void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
162 gboolean gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column);
163 void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
164 GtkTreeViewColumnSizing type);
165 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
166 gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
167 gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
168 void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
170 void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
172 gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
173 void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
175 gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
176 void gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
180 /* Options for manipulating the column headers
182 void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
184 G_CONST_RETURN gchar *gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
185 void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
187 gboolean gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
188 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
190 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
191 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
193 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
194 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
196 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
197 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
198 gboolean reorderable);
199 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
203 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
204 * other sorting functions exist primarily to let others do their own custom sorting.
206 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
207 gint sort_column_id);
208 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
209 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
211 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
212 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
214 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
217 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
219 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
220 GtkTreeModel *tree_model,
222 gboolean is_expander,
223 gboolean is_expanded);
224 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
225 const GdkRectangle *cell_area,
230 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
231 void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
232 GtkCellRenderer *cell);
233 gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
234 GtkCellRenderer *cell_renderer,
237 void gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
238 GtkWidget *gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
244 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */