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 <gtk/gtkcellrenderer.h>
28 #include <gtk/gtktreemodel.h>
29 #include <gtk/gtktreesortable.h>
31 /* Not needed, retained for compatibility -Yosh */
32 #include <gtk/gtkobject.h>
38 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
39 #define GTK_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
40 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
41 #define GTK_IS_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
42 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
43 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
47 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
48 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
49 GTK_TREE_VIEW_COLUMN_FIXED
50 } GtkTreeViewColumnSizing;
52 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
53 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
54 typedef struct _GtkTreeViewColumnPrivate GtkTreeViewColumnPrivate;
56 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
57 GtkCellRenderer *cell,
58 GtkTreeModel *tree_model,
63 struct _GtkTreeViewColumn
67 GtkWidget *GSEAL (tree_view);
68 GtkWidget *GSEAL (button);
69 GtkWidget *GSEAL (child);
70 GtkWidget *GSEAL (arrow);
71 GtkWidget *GSEAL (alignment);
72 GdkWindow *GSEAL (window);
73 GtkCellEditable *GSEAL (editable_widget);
74 gfloat GSEAL (xalign);
75 guint GSEAL (property_changed_signal);
79 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
80 GtkTreeViewColumnSizing GSEAL (column_type);
81 gint GSEAL (requested_width);
82 gint GSEAL (button_request);
83 gint GSEAL (resized_width);
85 gint GSEAL (fixed_width);
86 gint GSEAL (min_width);
87 gint GSEAL (max_width);
89 /* dragging columns */
94 GList *GSEAL (cell_list);
97 guint GSEAL (sort_clicked_signal);
98 guint GSEAL (sort_column_changed_signal);
99 gint GSEAL (sort_column_id);
100 GtkSortType GSEAL (sort_order);
103 guint GSEAL (visible) : 1;
104 guint GSEAL (resizable) : 1;
105 guint GSEAL (clickable) : 1;
106 guint GSEAL (dirty) : 1;
107 guint GSEAL (show_sort_indicator) : 1;
108 guint GSEAL (maybe_reordered) : 1;
109 guint GSEAL (reorderable) : 1;
110 guint GSEAL (use_resized_width) : 1;
111 guint GSEAL (expand) : 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 #ifndef GTK_DISABLE_DEPRECATED
140 GList *gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column);
142 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
143 GtkCellRenderer *cell_renderer,
144 const gchar *attribute,
146 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
147 GtkCellRenderer *cell_renderer,
148 ...) G_GNUC_NULL_TERMINATED;
149 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
150 GtkCellRenderer *cell_renderer,
151 GtkTreeCellDataFunc func,
153 GDestroyNotify destroy);
154 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
155 GtkCellRenderer *cell_renderer);
156 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
158 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
159 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
161 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
162 void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
164 gboolean gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column);
165 void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
166 GtkTreeViewColumnSizing type);
167 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
168 gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
169 gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
170 void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
172 void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
174 gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
175 void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
177 gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
178 void gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
182 /* Options for manipulating the column headers
184 void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
186 G_CONST_RETURN gchar *gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
187 void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
189 gboolean gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
190 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
192 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
193 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
195 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
196 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
198 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
199 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
200 gboolean reorderable);
201 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
205 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
206 * other sorting functions exist primarily to let others do their own custom sorting.
208 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
209 gint sort_column_id);
210 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
211 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
213 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
214 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
216 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
219 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
221 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
222 GtkTreeModel *tree_model,
224 gboolean is_expander,
225 gboolean is_expanded);
226 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
227 const GdkRectangle *cell_area,
232 void gtk_tree_view_column_get_desired_size (GtkTreeViewColumn *column,
233 GtkRequisition *minimal_size,
234 GtkRequisition *desired_size);
235 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
236 void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
237 GtkCellRenderer *cell);
238 gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
239 GtkCellRenderer *cell_renderer,
242 void gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
243 GtkWidget *gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
249 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */