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 #ifndef __GTK_TREE_VIEW_COLUMN_H__
21 #define __GTK_TREE_VIEW_COLUMN_H__
23 #include <gtk/gtkobject.h>
24 #include <gtk/gtkcellrenderer.h>
25 #include <gtk/gtktreemodel.h>
26 #include <gtk/gtktreesortable.h>
30 #endif /* __cplusplus */
32 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
33 #define GTK_TREE_VIEW_COLUMN(obj) (GTK_CHECK_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
34 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
35 #define GTK_IS_TREE_VIEW_COLUMN(obj) (GTK_CHECK_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
36 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
37 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
41 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
42 GTK_TREE_VIEW_COLUMN_RESIZABLE,
43 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
44 GTK_TREE_VIEW_COLUMN_FIXED
45 } GtkTreeViewColumnSizing;
47 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
48 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
50 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
51 GtkCellRenderer *cell,
52 GtkTreeModel *tree_model,
57 struct _GtkTreeViewColumn
68 guint property_changed_signal;
77 /* dragging columns */
83 GtkTreeViewColumnSizing column_type;
86 guint sort_clicked_signal;
87 guint sort_column_changed_signal;
89 GtkSortType sort_order;
95 guint show_sort_indicator : 1;
96 guint maybe_reordered : 1;
97 guint reorderable : 1;
100 struct _GtkTreeViewColumnClass
102 GtkObjectClass parent_class;
104 void (*clicked) (GtkTreeViewColumn *tree_column);
107 GtkType gtk_tree_view_column_get_type (void);
108 GtkTreeViewColumn *gtk_tree_view_column_new (void);
109 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar *title,
110 GtkCellRenderer *cell,
112 void gtk_tree_view_column_set_cell_renderer (GtkTreeViewColumn *tree_column,
113 GtkCellRenderer *cell);
114 void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
115 GtkCellRenderer *cell,
117 void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
118 GtkCellRenderer *cell,
120 void gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
121 GList *gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column);
122 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
123 GtkCellRenderer *cell_renderer,
124 const gchar *attribute,
126 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
127 GtkCellRenderer *cell_renderer,
129 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
130 GtkCellRenderer *cell_renderer,
131 GtkTreeCellDataFunc func,
133 GtkDestroyNotify destroy);
134 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
135 GtkCellRenderer *cell_renderer);
136 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
138 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
139 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
141 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
142 void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
143 GtkTreeViewColumnSizing type);
144 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
145 gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
146 gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
147 void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
149 void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
151 gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
152 void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
154 gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
155 void gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
159 /* Options for manipulating the column headers
161 void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
163 G_CONST_RETURN gchar *gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
164 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
166 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
167 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
169 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
170 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
172 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
173 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
174 gboolean reorderable);
175 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
179 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
180 * other sorting functions exist primarily to let others do their own custom sorting.
182 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
183 gint sort_column_id);
184 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
185 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
187 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
188 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
190 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
193 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
195 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
196 GtkTreeModel *tree_model,
198 gboolean is_expander,
199 gboolean is_expanded);
200 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
201 GdkRectangle *cell_area,
206 void gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
208 GdkRectangle *background_area,
209 GdkRectangle *cell_area,
210 GdkRectangle *expose_area,
212 gboolean gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
215 GdkRectangle *background_area,
216 GdkRectangle *cell_area,
218 gboolean gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
221 gboolean gtk_tree_view_column_cell_can_focus (GtkTreeViewColumn *tree_column);
222 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
223 void gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column);
228 #endif /* __cplusplus */
230 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */