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, see <http://www.gnu.org/licenses/>.
18 #ifndef __GTK_TREE_VIEW_COLUMN_H__
19 #define __GTK_TREE_VIEW_COLUMN_H__
21 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
22 #error "Only <gtk/gtk.h> can be included directly."
25 #include <gtk/gtkcellrenderer.h>
26 #include <gtk/gtktreemodel.h>
27 #include <gtk/gtktreesortable.h>
28 #include <gtk/gtkcellarea.h>
34 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
35 #define GTK_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
36 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
37 #define GTK_IS_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
38 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
39 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
41 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
42 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
43 typedef struct _GtkTreeViewColumnPrivate GtkTreeViewColumnPrivate;
46 * GtkTreeViewColumnSizing:
47 * @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
48 * @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
49 * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
51 * The sizing method the column uses to determine its width. Please note
52 * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
53 * can make columns appear choppy.
57 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
58 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
59 GTK_TREE_VIEW_COLUMN_FIXED
60 } GtkTreeViewColumnSizing;
63 * GtkTreeCellDataFunc:
64 * @tree_column: A #GtkTreeViewColumn
65 * @cell: The #GtkCellRenderer that is being rendered by @tree_column
66 * @tree_model: The #GtkTreeModel being rendered
67 * @iter: A #GtkTreeIter of the current row rendered
70 * A function to set the properties of a cell instead of just using the
71 * straight mapping between the cell and the model. This is useful for
72 * customizing the cell renderer. For example, a function might get an
73 * integer from the @tree_model, and render it to the "text" attribute of
74 * "cell" by converting it to its written equivilent. This is set by
75 * calling gtk_tree_view_column_set_cell_data_func()
77 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
78 GtkCellRenderer *cell,
79 GtkTreeModel *tree_model,
84 struct _GtkTreeViewColumn
86 GInitiallyUnowned parent_instance;
88 GtkTreeViewColumnPrivate *priv;
91 struct _GtkTreeViewColumnClass
93 GInitiallyUnownedClass parent_class;
95 void (*clicked) (GtkTreeViewColumn *tree_column);
97 /* Padding for future expansion */
98 void (*_gtk_reserved1) (void);
99 void (*_gtk_reserved2) (void);
100 void (*_gtk_reserved3) (void);
101 void (*_gtk_reserved4) (void);
104 GType gtk_tree_view_column_get_type (void) G_GNUC_CONST;
105 GtkTreeViewColumn *gtk_tree_view_column_new (void);
106 GtkTreeViewColumn *gtk_tree_view_column_new_with_area (GtkCellArea *area);
107 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar *title,
108 GtkCellRenderer *cell,
109 ...) G_GNUC_NULL_TERMINATED;
110 void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
111 GtkCellRenderer *cell,
113 void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
114 GtkCellRenderer *cell,
116 void gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
117 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
118 GtkCellRenderer *cell_renderer,
119 const gchar *attribute,
121 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
122 GtkCellRenderer *cell_renderer,
123 ...) G_GNUC_NULL_TERMINATED;
124 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
125 GtkCellRenderer *cell_renderer,
126 GtkTreeCellDataFunc func,
128 GDestroyNotify destroy);
129 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
130 GtkCellRenderer *cell_renderer);
131 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
133 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
134 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
136 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
137 void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
139 gboolean gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column);
140 void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
141 GtkTreeViewColumnSizing type);
142 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
144 gint gtk_tree_view_column_get_x_offset (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 const gchar * gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
164 void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
166 gboolean gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
167 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
169 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
170 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
172 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
173 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
175 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
176 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
177 gboolean reorderable);
178 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
182 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
183 * other sorting functions exist primarily to let others do their own custom sorting.
185 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
186 gint sort_column_id);
187 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
188 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
190 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
191 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
193 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
196 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
198 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
199 GtkTreeModel *tree_model,
201 gboolean is_expander,
202 gboolean is_expanded);
203 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
204 const GdkRectangle *cell_area,
209 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
210 void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
211 GtkCellRenderer *cell);
212 gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
213 GtkCellRenderer *cell_renderer,
216 void gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
217 GtkWidget *gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
218 GtkWidget *gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column);
224 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */