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>
35 #define GTK_TYPE_TREE_VIEW_COLUMN (gtk_tree_view_column_get_type ())
36 #define GTK_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumn))
37 #define GTK_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
38 #define GTK_IS_TREE_VIEW_COLUMN(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_TREE_VIEW_COLUMN))
39 #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN))
40 #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass))
44 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
45 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
46 GTK_TREE_VIEW_COLUMN_FIXED
47 } GtkTreeViewColumnSizing;
49 typedef struct _GtkTreeViewColumn GtkTreeViewColumn;
50 typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass;
52 typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,
53 GtkCellRenderer *cell,
54 GtkTreeModel *tree_model,
59 struct _GtkTreeViewColumn
61 GInitiallyUnowned parent_instance;
63 GtkWidget *GSEAL (tree_view);
64 GtkWidget *GSEAL (button);
65 GtkWidget *GSEAL (child);
66 GtkWidget *GSEAL (arrow);
67 GtkWidget *GSEAL (alignment);
68 GdkWindow *GSEAL (window);
69 GtkCellEditable *GSEAL (editable_widget);
70 gfloat GSEAL (xalign);
71 gulong GSEAL (property_changed_signal);
75 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
76 GtkTreeViewColumnSizing GSEAL (column_type);
77 gint GSEAL (requested_width);
78 gint GSEAL (button_request);
79 gint GSEAL (resized_width);
81 gint GSEAL (fixed_width);
82 gint GSEAL (min_width);
83 gint GSEAL (max_width);
85 /* dragging columns */
90 GList *GSEAL (cell_list);
93 gulong GSEAL (sort_clicked_signal);
94 gulong GSEAL (sort_column_changed_signal);
95 gint GSEAL (sort_column_id);
96 GtkSortType GSEAL (sort_order);
99 guint GSEAL (visible) : 1;
100 guint GSEAL (resizable) : 1;
101 guint GSEAL (clickable) : 1;
102 guint GSEAL (dirty) : 1;
103 guint GSEAL (show_sort_indicator) : 1;
104 guint GSEAL (maybe_reordered) : 1;
105 guint GSEAL (reorderable) : 1;
106 guint GSEAL (use_resized_width) : 1;
107 guint GSEAL (expand) : 1;
110 struct _GtkTreeViewColumnClass
112 GInitiallyUnownedClass parent_class;
114 void (*clicked) (GtkTreeViewColumn *tree_column);
116 /* Padding for future expansion */
117 void (*_gtk_reserved1) (void);
118 void (*_gtk_reserved2) (void);
119 void (*_gtk_reserved3) (void);
120 void (*_gtk_reserved4) (void);
123 GType gtk_tree_view_column_get_type (void) G_GNUC_CONST;
124 GtkTreeViewColumn *gtk_tree_view_column_new (void);
125 GtkTreeViewColumn *gtk_tree_view_column_new_with_attributes (const gchar *title,
126 GtkCellRenderer *cell,
127 ...) G_GNUC_NULL_TERMINATED;
128 void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
129 GtkCellRenderer *cell,
131 void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
132 GtkCellRenderer *cell,
134 void gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
135 void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
136 GtkCellRenderer *cell_renderer,
137 const gchar *attribute,
139 void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
140 GtkCellRenderer *cell_renderer,
141 ...) G_GNUC_NULL_TERMINATED;
142 void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
143 GtkCellRenderer *cell_renderer,
144 GtkTreeCellDataFunc func,
146 GDestroyNotify destroy);
147 void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
148 GtkCellRenderer *cell_renderer);
149 void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
151 gint gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
152 void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
154 gboolean gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
155 void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
157 gboolean gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column);
158 void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
159 GtkTreeViewColumnSizing type);
160 GtkTreeViewColumnSizing gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
161 gint gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
162 gint gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
163 void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
165 void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
167 gint gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
168 void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
170 gint gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
171 void gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
175 /* Options for manipulating the column headers
177 void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
179 G_CONST_RETURN gchar *gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
180 void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
182 gboolean gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
183 void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
185 gboolean gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
186 void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
188 GtkWidget *gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
189 void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
191 gfloat gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
192 void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
193 gboolean reorderable);
194 gboolean gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
198 /* You probably only want to use gtk_tree_view_column_set_sort_column_id. The
199 * other sorting functions exist primarily to let others do their own custom sorting.
201 void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
202 gint sort_column_id);
203 gint gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column);
204 void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
206 gboolean gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column);
207 void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
209 GtkSortType gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
212 /* These functions are meant primarily for interaction between the GtkTreeView and the column.
214 void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
215 GtkTreeModel *tree_model,
217 gboolean is_expander,
218 gboolean is_expanded);
219 void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
220 const GdkRectangle *cell_area,
225 gboolean gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
226 void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
227 GtkCellRenderer *cell);
228 gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
229 GtkCellRenderer *cell_renderer,
232 void gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
233 GtkWidget *gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
239 #endif /* __GTK_TREE_VIEW_COLUMN_H__ */