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_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 <gtk/gtkcellrenderer.h>
28 #include <gtk/gtktreemodel.h>
29 #include <gtk/gtktreesortable.h>
30 #include <gtk/gtkcellarea.h>
36 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
37 #define GTK_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
38 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
39 #define GTK_IS_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
40 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
41 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
43 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
44 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
45 typedef struct _GtkTreeViewColumnPrivate GtkTreeViewColumnPrivate;
48 * GtkTreeViewColumnSizing:
49 * @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model
50 * @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes.
51 * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide.
53 * The sizing method the column uses to determine its width. Please note
54 * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and
55 * can make columns appear choppy.
59 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
60 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
61 GTK_TREE_VIEW_COLUMN_FIXED
62 } GtkTreeViewColumnSizing;
65 * GtkTreeCellDataFunc:
66 * @tree_column: A #GtkTreeColumn
67 * @cell: The #GtkCellRenderer that is being rendered by @tree_column
68 * @tree_model: The #GtkTreeModel being rendered
69 * @iter: A #GtkTreeIter of the current row rendered
72 * A function to set the properties of a cell instead of just using the
73 * straight mapping between the cell and the model. This is useful for
74 * customizing the cell renderer. For example, a function might get an
75 * integer from the @tree_model, and render it to the "text" attribute of
76 * "cell" by converting it to its written equivilent. This is set by
77 * calling gtk_tree_view_column_set_cell_data_func()
79 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
80 GtkCellRenderer *cell,
81 GtkTreeModel *tree_model,
86 struct _GtkTreeViewColumn
88 GInitiallyUnowned parent_instance;
90 GtkTreeViewColumnPrivate *priv;
93 struct _GtkTreeViewColumnClass
95 GInitiallyUnownedClass parent_class;
97 void (*clicked) (GtkTreeViewColumn *tree_column);
99 /* Padding for future expansion */
100 void (*_gtk_reserved1) (void);
101 void (*_gtk_reserved2) (void);
102 void (*_gtk_reserved3) (void);
103 void (*_gtk_reserved4) (void);
106 GType gtk_tree_view_column_get_type (void) G_GNUC_CONST;
107 GtkTreeViewColumn *gtk_tree_view_column_new (void);
108 GtkTreeViewColumn *gtk_tree_view_column_new_with_area (GtkCellArea *area);
109 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar *title,
110 GtkCellRenderer *cell,
111 ...) G_GNUC_NULL_TERMINATED;
112 void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
113 GtkCellRenderer *cell,
115 void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
116 GtkCellRenderer *cell,
118 void gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
119 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
120 GtkCellRenderer *cell_renderer,
121 const gchar *attribute,
123 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
124 GtkCellRenderer *cell_renderer,
125 ...) G_GNUC_NULL_TERMINATED;
126 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
127 GtkCellRenderer *cell_renderer,
128 GtkTreeCellDataFunc func,
130 GDestroyNotify destroy);
131 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
132 GtkCellRenderer *cell_renderer);
133 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
135 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
136 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
138 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
139 void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
141 gboolean gtk_tree_view_column_get_resizable (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_x_offset (GtkTreeViewColumn *tree_column);
146 gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
147 gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
148 void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
150 void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
152 gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
153 void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
155 gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
156 void gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
160 /* Options for manipulating the column headers
162 void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
164 const gchar * gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
165 void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
167 gboolean gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
168 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
170 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
171 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
173 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
174 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
176 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
177 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
178 gboolean reorderable);
179 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
183 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
184 * other sorting functions exist primarily to let others do their own custom sorting.
186 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
187 gint sort_column_id);
188 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
189 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
191 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
192 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
194 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
197 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
199 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
200 GtkTreeModel *tree_model,
202 gboolean is_expander,
203 gboolean is_expanded);
204 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
205 const GdkRectangle *cell_area,
210 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
211 void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
212 GtkCellRenderer *cell);
213 gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
214 GtkCellRenderer *cell_renderer,
217 void gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
218 GtkWidget *gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
219 GtkWidget *gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column);
225 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */