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 #include "gtktreeviewcolumn.h"
21 #include "gtktreeview.h"
22 #include "gtktreeprivate.h"
23 #include "gtksignal.h"
24 #include "gtkbutton.h"
25 #include "gtkalignment.h"
56 typedef struct _GtkTreeViewColumnCellInfo GtkTreeViewColumnCellInfo;
57 struct _GtkTreeViewColumnCellInfo
59 GtkCellRenderer *cell;
61 GtkTreeCellDataFunc func;
63 GtkDestroyNotify destroy;
71 static void gtk_tree_view_column_init (GtkTreeViewColumn *tree_column);
72 static void gtk_tree_view_column_class_init (GtkTreeViewColumnClass *klass);
75 static void gtk_tree_view_column_set_property (GObject *object,
79 static void gtk_tree_view_column_get_property (GObject *object,
83 static void gtk_tree_view_column_finalize (GObject *object);
85 /* Button handling code */
86 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
87 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
89 /* Button signal handlers */
90 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
93 static void gtk_tree_view_column_button_realize (GtkWidget *widget,
95 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
98 /* Property handlers */
99 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
100 GtkTreeViewColumn *tree_column);
102 /* Internal functions */
103 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
105 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
106 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
107 GtkCellRenderer *cell_renderer,
109 static GtkTreeViewColumnCellInfo *gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
110 GtkCellRenderer *cell_renderer);
111 static void gtk_tree_view_column_cell_foreach (GtkTreeViewColumn *tree_column,
118 static GtkObjectClass *parent_class = NULL;
119 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
123 gtk_tree_view_column_get_type (void)
125 static GtkType tree_column_type = 0;
127 if (!tree_column_type)
129 static const GTypeInfo tree_column_info =
131 sizeof (GtkTreeViewColumnClass),
132 NULL, /* base_init */
133 NULL, /* base_finalize */
134 (GClassInitFunc) gtk_tree_view_column_class_init,
135 NULL, /* class_finalize */
136 NULL, /* class_data */
137 sizeof (GtkTreeViewColumn),
139 (GInstanceInitFunc) gtk_tree_view_column_init,
142 tree_column_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTreeViewColumn", &tree_column_info, 0);
145 return tree_column_type;
149 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
151 GObjectClass *object_class;
153 object_class = (GObjectClass*) class;
155 parent_class = g_type_class_peek_parent (class);
157 class->clicked = NULL;
159 object_class->finalize = gtk_tree_view_column_finalize;
160 object_class->set_property = gtk_tree_view_column_set_property;
161 object_class->get_property = gtk_tree_view_column_get_property;
163 tree_column_signals[CLICKED] =
164 g_signal_new ("clicked",
165 GTK_CLASS_TYPE (object_class),
167 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
169 gtk_marshal_VOID__VOID,
172 g_object_class_install_property (object_class,
174 g_param_spec_boolean ("visible",
176 _("Whether to display the column"),
178 G_PARAM_READABLE | G_PARAM_WRITABLE));
180 g_object_class_install_property (object_class,
182 g_param_spec_int ("width",
184 _("Current width of the column"),
189 g_object_class_install_property (object_class,
191 g_param_spec_enum ("sizing",
193 _("Resize mode of the column"),
194 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
195 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
196 G_PARAM_READABLE | G_PARAM_WRITABLE));
198 g_object_class_install_property (object_class,
200 g_param_spec_int ("fixed_width",
202 _("Current fixed width of the column"),
206 G_PARAM_READABLE | G_PARAM_WRITABLE));
208 g_object_class_install_property (object_class,
210 g_param_spec_int ("min_width",
212 _("Minimum allowed width of the column"),
216 G_PARAM_READABLE | G_PARAM_WRITABLE));
218 g_object_class_install_property (object_class,
220 g_param_spec_int ("max_width",
222 _("Maximum allowed width of the column"),
226 G_PARAM_READABLE | G_PARAM_WRITABLE));
228 g_object_class_install_property (object_class,
230 g_param_spec_string ("title",
232 _("Title to appear in column header"),
234 G_PARAM_READABLE | G_PARAM_WRITABLE));
236 g_object_class_install_property (object_class,
238 g_param_spec_boolean ("clickable",
240 _("Whether the header can be clicked"),
242 G_PARAM_READABLE | G_PARAM_WRITABLE));
245 g_object_class_install_property (object_class,
247 g_param_spec_object ("widget",
249 _("Widget to put in column header button instead of column title"),
251 G_PARAM_READABLE | G_PARAM_WRITABLE));
253 g_object_class_install_property (object_class,
255 g_param_spec_float ("alignment",
257 _("X Alignment of the column header text or widget"),
261 G_PARAM_READABLE | G_PARAM_WRITABLE));
263 g_object_class_install_property (object_class,
265 g_param_spec_boolean ("reorderable",
267 _("Wether the column can be reordered around the headers"),
269 G_PARAM_READABLE | G_PARAM_WRITABLE));
271 g_object_class_install_property (object_class,
273 g_param_spec_boolean ("sort_indicator",
275 _("Whether to show a sort indicator"),
277 G_PARAM_READABLE | G_PARAM_WRITABLE));
279 g_object_class_install_property (object_class,
281 g_param_spec_enum ("sort_order",
283 _("Sort direction the sort indicator should indicate"),
286 G_PARAM_READABLE | G_PARAM_WRITABLE));
291 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
293 tree_column->button = NULL;
294 tree_column->xalign = 0.0;
295 tree_column->width = 0;
296 tree_column->requested_width = -1;
297 tree_column->min_width = -1;
298 tree_column->max_width = -1;
299 tree_column->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
300 tree_column->visible = TRUE;
301 tree_column->clickable = FALSE;
302 tree_column->dirty = TRUE;
303 tree_column->sort_order = GTK_SORT_ASCENDING;
304 tree_column->show_sort_indicator = FALSE;
305 tree_column->property_changed_signal = 0;
306 tree_column->sort_clicked_signal = 0;
307 tree_column->sort_column_changed_signal = 0;
308 tree_column->sort_column_id = -1;
309 tree_column->reorderable = FALSE;
310 tree_column->maybe_reordered = FALSE;
314 gtk_tree_view_column_finalize (GObject *object)
316 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
319 for (list = tree_column->cell_list; list; list = list->next)
321 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
322 if (info->func_data && info->destroy)
323 (info->destroy) (info->func_data);
324 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
325 g_object_unref (G_OBJECT (info->cell));
329 g_free (tree_column->title);
331 G_OBJECT_CLASS (parent_class)->finalize (object);
335 gtk_tree_view_column_set_property (GObject *object,
340 GtkTreeViewColumn *tree_column;
342 tree_column = GTK_TREE_VIEW_COLUMN (object);
347 gtk_tree_view_column_set_visible (tree_column,
348 g_value_get_boolean (value));
352 gtk_tree_view_column_set_sizing (tree_column,
353 g_value_get_enum (value));
356 case PROP_FIXED_WIDTH:
357 gtk_tree_view_column_set_fixed_width (tree_column,
358 g_value_get_int (value));
362 gtk_tree_view_column_set_min_width (tree_column,
363 g_value_get_int (value));
367 gtk_tree_view_column_set_max_width (tree_column,
368 g_value_get_int (value));
372 gtk_tree_view_column_set_title (tree_column,
373 g_value_get_string (value));
377 gtk_tree_view_column_set_clickable (tree_column,
378 g_value_get_boolean (value));
382 gtk_tree_view_column_set_widget (tree_column,
383 (GtkWidget*) g_value_get_object (value));
387 gtk_tree_view_column_set_alignment (tree_column,
388 g_value_get_float (value));
391 case PROP_REORDERABLE:
392 gtk_tree_view_column_set_reorderable (tree_column,
393 g_value_get_boolean (value));
396 case PROP_SORT_INDICATOR:
397 gtk_tree_view_column_set_sort_indicator (tree_column,
398 g_value_get_boolean (value));
401 case PROP_SORT_ORDER:
402 gtk_tree_view_column_set_sort_order (tree_column,
403 g_value_get_enum (value));
407 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
413 gtk_tree_view_column_get_property (GObject *object,
418 GtkTreeViewColumn *tree_column;
420 tree_column = GTK_TREE_VIEW_COLUMN (object);
425 g_value_set_boolean (value,
426 gtk_tree_view_column_get_visible (tree_column));
430 g_value_set_int (value,
431 gtk_tree_view_column_get_width (tree_column));
435 g_value_set_enum (value,
436 gtk_tree_view_column_get_sizing (tree_column));
439 case PROP_FIXED_WIDTH:
440 g_value_set_int (value,
441 gtk_tree_view_column_get_fixed_width (tree_column));
445 g_value_set_int (value,
446 gtk_tree_view_column_get_min_width (tree_column));
450 g_value_set_int (value,
451 gtk_tree_view_column_get_max_width (tree_column));
455 g_value_set_string (value,
456 gtk_tree_view_column_get_title (tree_column));
460 g_value_set_boolean (value,
461 gtk_tree_view_column_get_clickable (tree_column));
465 g_value_set_object (value,
466 (GObject*) gtk_tree_view_column_get_widget (tree_column));
470 g_value_set_float (value,
471 gtk_tree_view_column_get_alignment (tree_column));
474 case PROP_REORDERABLE:
475 g_value_set_boolean (value,
476 gtk_tree_view_column_get_reorderable (tree_column));
479 case PROP_SORT_INDICATOR:
480 g_value_set_boolean (value,
481 gtk_tree_view_column_get_sort_indicator (tree_column));
484 case PROP_SORT_ORDER:
485 g_value_set_enum (value,
486 gtk_tree_view_column_get_sort_order (tree_column));
490 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
498 /* Button handling code
501 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
503 GtkTreeView *tree_view;
507 tree_view = (GtkTreeView *) tree_column->tree_view;
509 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
510 g_return_if_fail (tree_column->button == NULL);
512 gtk_widget_push_composite_child ();
513 tree_column->button = gtk_button_new ();
514 gtk_widget_pop_composite_child ();
516 /* make sure we own a reference to it as well. */
517 if (tree_view->priv->header_window)
518 gtk_widget_set_parent_window (tree_column->button, tree_view->priv->header_window);
519 gtk_widget_set_parent (tree_column->button, GTK_WIDGET (tree_view));
521 gtk_signal_connect (GTK_OBJECT (tree_column->button), "realize",
522 (GtkSignalFunc) gtk_tree_view_column_button_realize,
525 gtk_signal_connect (GTK_OBJECT (tree_column->button), "event",
526 (GtkSignalFunc) gtk_tree_view_column_button_event,
527 (gpointer) tree_column);
529 gtk_signal_connect (GTK_OBJECT (tree_column->button), "clicked",
530 (GtkSignalFunc) gtk_tree_view_column_button_clicked,
531 (gpointer) tree_column);
533 tree_column->alignment = gtk_alignment_new (tree_column->xalign, 0.5, 0.0, 0.0);
535 hbox = gtk_hbox_new (FALSE, 2);
536 tree_column->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
538 if (tree_column->child)
539 child = tree_column->child;
542 child = gtk_label_new (tree_column->title);
543 gtk_widget_show (child);
546 if (tree_column->xalign <= 0.5)
547 gtk_box_pack_end (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
549 gtk_box_pack_start (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
551 gtk_box_pack_start (GTK_BOX (hbox), tree_column->alignment, TRUE, TRUE, 0);
553 gtk_container_add (GTK_CONTAINER (tree_column->alignment), child);
554 gtk_container_add (GTK_CONTAINER (tree_column->button), hbox);
556 gtk_widget_show (hbox);
557 gtk_widget_show (tree_column->alignment);
558 gtk_tree_view_column_update_button (tree_column);
562 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
565 GtkWidget *alignment;
567 GtkWidget *current_child;
569 /* Create a button if necessary */
570 if (tree_column->visible &&
571 tree_column->button == NULL &&
572 tree_column->tree_view &&
573 GTK_WIDGET_REALIZED (tree_column->tree_view))
574 gtk_tree_view_column_create_button (tree_column);
576 if (! tree_column->button)
579 hbox = GTK_BIN (tree_column->button)->child;
580 alignment = tree_column->alignment;
581 arrow = tree_column->arrow;
582 current_child = GTK_BIN (alignment)->child;
584 /* Set up the actual button */
585 gtk_alignment_set (GTK_ALIGNMENT (alignment), tree_column->xalign,
588 if (tree_column->child)
590 if (current_child != tree_column->child)
592 gtk_container_remove (GTK_CONTAINER (alignment),
594 gtk_container_add (GTK_CONTAINER (alignment),
600 if (current_child == NULL)
602 current_child = gtk_label_new (NULL);
603 gtk_widget_show (current_child);
604 gtk_container_add (GTK_CONTAINER (alignment),
608 g_return_if_fail (GTK_IS_LABEL (current_child));
610 if (tree_column->title)
611 gtk_label_set_text (GTK_LABEL (current_child),
614 gtk_label_set_text (GTK_LABEL (current_child),
618 switch (tree_column->sort_order)
620 case GTK_SORT_ASCENDING:
621 gtk_arrow_set (GTK_ARROW (arrow),
626 case GTK_SORT_DESCENDING:
627 gtk_arrow_set (GTK_ARROW (arrow),
633 g_warning (G_STRLOC": bad sort order");
637 /* Put arrow on the right if the text is left-or-center justified,
638 * and on the left otherwise; do this by packing boxes, so flipping
639 * text direction will reverse things
641 gtk_widget_ref (arrow);
642 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
644 if (tree_column->xalign <= 0.5)
646 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
650 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
651 /* move it to the front */
652 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
654 gtk_widget_unref (arrow);
656 if (tree_column->show_sort_indicator)
657 gtk_widget_show (arrow);
659 gtk_widget_hide (arrow);
661 /* It's always safe to hide the button. It isn't always safe to show it, as if you show it
662 * before it's realized, it'll get the wrong window. */
663 if (tree_column->button &&
664 tree_column->tree_view != NULL &&
665 GTK_WIDGET_REALIZED (tree_column->tree_view))
667 if (tree_column->visible)
669 gtk_widget_show_now (tree_column->button);
670 if (tree_column->window)
672 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_RESIZABLE)
674 gdk_window_show (tree_column->window);
675 gdk_window_raise (tree_column->window);
679 gdk_window_hide (tree_column->window);
685 gtk_widget_hide (tree_column->button);
686 if (tree_column->window)
687 gdk_window_hide (tree_column->window);
691 if (tree_column->reorderable || tree_column->clickable)
693 GTK_WIDGET_SET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
697 GTK_WIDGET_UNSET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
698 if (GTK_WIDGET_HAS_FOCUS (tree_column->button))
700 GtkWidget *toplevel = gtk_widget_get_toplevel (tree_column->tree_view);
701 if (GTK_WIDGET_TOPLEVEL (toplevel))
702 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
706 gtk_tree_view_column_cell_set_dirty (tree_column);
709 /* Button signal handlers
713 gtk_tree_view_column_button_event (GtkWidget *widget,
717 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
719 g_return_val_if_fail (event != NULL, FALSE);
721 if (event->type == GDK_BUTTON_PRESS &&
724 column->maybe_reordered = TRUE;
725 gdk_window_get_pointer (widget->window,
729 gtk_widget_grab_focus (widget);
732 if (event->type == GDK_BUTTON_RELEASE &&
733 column->maybe_reordered)
734 column->maybe_reordered = FALSE;
736 if (event->type == GDK_MOTION_NOTIFY &&
737 (column->maybe_reordered) &&
738 (gtk_drag_check_threshold (widget,
741 (gint) ((GdkEventMotion *)event)->x,
742 (gint) ((GdkEventMotion *)event)->y)))
744 column->maybe_reordered = FALSE;
745 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column);
748 if (column->clickable == FALSE)
752 case GDK_BUTTON_PRESS:
753 case GDK_2BUTTON_PRESS:
754 case GDK_3BUTTON_PRESS:
755 case GDK_MOTION_NOTIFY:
756 case GDK_BUTTON_RELEASE:
757 case GDK_ENTER_NOTIFY:
758 case GDK_LEAVE_NOTIFY:
768 gtk_tree_view_column_button_realize (GtkWidget *widget, gpointer data)
770 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | GDK_POINTER_MOTION_MASK);
774 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
776 g_signal_emit_by_name (G_OBJECT (data), "clicked");
780 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
781 GtkTreeViewColumn *column)
786 if (gtk_tree_sortable_get_sort_column_id (sortable,
790 if (sort_column_id == column->sort_column_id)
792 gtk_tree_view_column_set_sort_indicator (column, TRUE);
793 gtk_tree_view_column_set_sort_order (column, order);
797 gtk_tree_view_column_set_sort_indicator (column, FALSE);
803 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
808 g_return_if_fail (tree_column->tree_view != NULL);
810 if (tree_column->show_sort_indicator)
812 if (tree_column->sort_order == GTK_SORT_ASCENDING)
813 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_DESCENDING);
815 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
819 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
820 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
823 list = (GTK_TREE_VIEW (tree_column->tree_view)->priv->columns);
827 GtkTreeViewColumn *tmp_column;
829 tmp_column = GTK_TREE_VIEW_COLUMN (list->data);
830 if (tmp_column->visible && tmp_column != tree_column)
831 gtk_tree_view_column_set_sort_indicator (tmp_column, FALSE);
836 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
837 tree_column->sort_column_id,
838 tree_column->sort_order);
843 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
847 if (tree_column->tree_view == NULL)
850 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
855 if (GTK_IS_TREE_SORTABLE (model) &&
856 tree_column->sort_column_id != -1)
858 gint real_sort_column_id;
859 GtkSortType real_order;
861 if (tree_column->sort_column_changed_signal == 0)
862 tree_column->sort_column_changed_signal =
863 g_signal_connect (G_OBJECT (model), "sort_column_changed",
864 GTK_SIGNAL_FUNC (gtk_tree_view_model_sort_column_changed),
867 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
868 &real_sort_column_id,
870 (real_sort_column_id == tree_column->sort_column_id))
872 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
873 gtk_tree_view_column_set_sort_order (tree_column, real_order);
881 /* Exported Private Functions.
882 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
886 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
888 GtkTreeView *tree_view;
890 guint attributes_mask;
892 tree_view = (GtkTreeView *)column->tree_view;
894 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
895 g_return_if_fail (GTK_WIDGET_REALIZED (tree_view));
896 g_return_if_fail (tree_view->priv->header_window != NULL);
897 g_return_if_fail (column->button != NULL);
899 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
902 gtk_widget_show (column->button);
904 attr.window_type = GDK_WINDOW_CHILD;
905 attr.wclass = GDK_INPUT_ONLY;
906 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
907 attr.colormap = gtk_widget_get_colormap (GTK_WIDGET (tree_view));
908 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view));
909 attr.event_mask = (GDK_BUTTON_PRESS_MASK |
910 GDK_BUTTON_RELEASE_MASK |
911 GDK_POINTER_MOTION_MASK |
912 GDK_POINTER_MOTION_HINT_MASK |
914 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
915 attr.cursor = gdk_cursor_new (GDK_SB_H_DOUBLE_ARROW);
916 tree_view->priv->cursor_drag = attr.cursor;
919 attr.width = TREE_VIEW_DRAG_WIDTH;
920 attr.height = tree_view->priv->header_height;
922 attr.x = (column->button->allocation.x + column->button->allocation.width) - 3;
924 column->window = gdk_window_new (tree_view->priv->header_window,
925 &attr, attributes_mask);
926 gdk_window_set_user_data (column->window, tree_view);
928 gtk_tree_view_column_update_button (column);
932 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
934 g_return_if_fail (column != NULL);
935 g_return_if_fail (column->window != NULL);
937 gdk_window_set_user_data (column->window, NULL);
938 gdk_window_destroy (column->window);
939 column->window = NULL;
943 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
944 GtkTreeView *tree_view)
946 g_assert (column->tree_view == NULL);
948 column->tree_view = GTK_WIDGET (tree_view);
949 gtk_tree_view_column_create_button (column);
951 column->property_changed_signal =
952 g_signal_connect_swapped (GTK_OBJECT (tree_view),
954 GTK_SIGNAL_FUNC (gtk_tree_view_column_setup_sort_column_id_callback),
957 gtk_tree_view_column_setup_sort_column_id_callback (column);
961 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
963 if (column->tree_view && column->button)
965 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
967 if (column->property_changed_signal)
969 g_signal_handler_disconnect (G_OBJECT (column->tree_view), column->property_changed_signal);
970 column->property_changed_signal = 0;
973 if (column->sort_column_changed_signal)
975 g_signal_handler_disconnect (G_OBJECT (gtk_tree_view_get_model (GTK_TREE_VIEW (column->tree_view))),
976 column->sort_column_changed_signal);
977 column->sort_column_changed_signal = 0;
980 column->tree_view = NULL;
981 column->button = NULL;
985 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
988 if (tree_column->min_width != -1 &&
989 width <= tree_column->min_width)
990 width = tree_column->min_width;
991 else if (tree_column->max_width != -1 &&
992 width > tree_column->max_width)
993 width = tree_column->max_width;
995 if (tree_column->width == width)
998 tree_column->width = width;
1000 g_object_notify (G_OBJECT (tree_column), "width");
1002 if (tree_column->tree_view != NULL)
1003 gtk_widget_queue_resize (tree_column->tree_view);
1007 /* Public Functions */
1011 * gtk_tree_view_column_new:
1013 * Creates a new #GtkTreeViewColumn.
1015 * Return value: A newly created #GtkTreeViewColumn.
1018 gtk_tree_view_column_new (void)
1020 GtkTreeViewColumn *tree_column;
1022 tree_column = GTK_TREE_VIEW_COLUMN (gtk_type_new (GTK_TYPE_TREE_VIEW_COLUMN));
1028 * gtk_tree_view_column_new_with_attributes:
1029 * @title: The title to set the header to.
1030 * @cell: The #GtkCellRenderer.
1031 * @Varargs: A NULL terminated list of attributes.
1033 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1034 * equivalent to calling @gtk_tree_view_column_set_title,
1035 * @gtk_tree_view_column_set_cell_renderer, and
1036 * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn.
1038 * Return value: A newly created #GtkTreeViewColumn.
1041 gtk_tree_view_column_new_with_attributes (const gchar *title,
1042 GtkCellRenderer *cell,
1045 GtkTreeViewColumn *retval;
1048 retval = gtk_tree_view_column_new ();
1050 gtk_tree_view_column_set_title (retval, title);
1051 gtk_tree_view_column_set_cell_renderer (retval, cell);
1053 va_start (args, cell);
1054 gtk_tree_view_column_set_attributesv (retval, cell, args);
1061 * gtk_tree_view_column_set_cell_renderer:
1062 * @tree_column: A #GtkTreeViewColumn.
1063 * @cell: The #GtkCellRenderer, or NULL.
1065 * Sets the cell renderer of the @tree_column. If there is a cell
1066 * renderer already set, then it is removed. If @cell is NULL, then
1067 * the cell renderer is unset.
1070 gtk_tree_view_column_set_cell_renderer (GtkTreeViewColumn *tree_column,
1071 GtkCellRenderer *cell)
1073 gtk_tree_view_column_pack_start (tree_column, cell, TRUE);
1076 static GtkTreeViewColumnCellInfo *
1077 gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
1078 GtkCellRenderer *cell_renderer)
1081 for (list = tree_column->cell_list; list; list = list->next)
1082 if (((GtkTreeViewColumnCellInfo *)list->data)->cell == cell_renderer)
1083 return (GtkTreeViewColumnCellInfo *) list->data;
1089 * gtk_tree_view_column_pack_start:
1090 * @tree_column: A #GtkTreeViewColumn.
1091 * @cell: The #GtkCellRenderer,
1092 * @expand: TRUE if @cell is to be given extra space allocated to box.
1096 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1097 GtkCellRenderer *cell,
1100 GtkTreeViewColumnCellInfo *cell_info;
1102 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1103 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1104 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1106 g_object_ref (G_OBJECT (cell));
1107 gtk_object_sink (GTK_OBJECT (cell));
1109 cell_info = g_new0 (GtkTreeViewColumnCellInfo, 1);
1110 cell_info->cell = cell;
1111 cell_info->expand = expand ? TRUE : FALSE;
1112 cell_info->pack = GTK_PACK_START;
1113 cell_info->has_focus = 0;
1114 cell_info->attributes = NULL;
1116 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1120 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1121 GtkCellRenderer *cell,
1124 GtkTreeViewColumnCellInfo *cell_info;
1126 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1127 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1128 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1130 g_object_ref (G_OBJECT (cell));
1131 gtk_object_sink (GTK_OBJECT (cell));
1133 cell_info = g_new (GtkTreeViewColumnCellInfo, 1);
1134 cell_info->cell = cell;
1135 cell_info->expand = expand ? TRUE : FALSE;
1136 cell_info->pack = GTK_PACK_END;
1137 cell_info->has_focus = 0;
1138 cell_info->attributes = NULL;
1140 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1145 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1148 g_return_if_fail (tree_column != NULL);
1150 for (list = tree_column->cell_list; list; list = list->next)
1152 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1154 g_object_unref (G_OBJECT (info->cell));
1155 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
1159 g_list_free (tree_column->cell_list);
1160 tree_column->cell_list = NULL;
1164 gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column)
1166 GList *retval = NULL, *list;
1168 g_return_val_if_fail (tree_column != NULL, NULL);
1170 for (list = tree_column->cell_list; list; list = list->next)
1172 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1174 retval = g_list_append (retval, info->cell);
1181 * gtk_tree_view_column_add_attribute:
1182 * @tree_column: A #GtkTreeViewColumn.
1183 * @attribute: An attribute on the columns cell
1184 * @column: The column position on the model to get the attribute from.
1186 * Adds an attribute mapping to the list in @tree_column. The @column is the
1187 * column position on the model to get a value from, and the @attribute is the
1188 * parameter on the @tree_column's cell renderer to set that value to.
1191 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1192 GtkCellRenderer *cell_renderer,
1193 const gchar *attribute,
1196 GtkTreeViewColumnCellInfo *info;
1198 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1199 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1200 g_return_if_fail (info != NULL);
1202 info->attributes = g_slist_prepend (info->attributes, GINT_TO_POINTER (column));
1203 info->attributes = g_slist_prepend (info->attributes, g_strdup (attribute));
1205 if (tree_column->tree_view)
1206 gtk_tree_view_column_cell_set_dirty (tree_column);
1211 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1212 GtkCellRenderer *cell_renderer,
1218 attribute = va_arg (args, gchar *);
1220 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1222 while (attribute != NULL)
1224 column = va_arg (args, gint);
1225 gtk_tree_view_column_add_attribute (tree_column, cell_renderer, attribute, column);
1226 attribute = va_arg (args, gchar *);
1231 * gtk_tree_view_column_set_attributes:
1232 * @tree_column: A #GtkTreeViewColumn.
1233 * @Varargs: A NULL terminated listing of attributes.
1235 * Sets the attributes in the list as the attributes of @tree_column.
1236 * The attributes should be in attribute/column order, as in
1237 * @gtk_tree_view_column_add_attribute. All existing attributes
1238 * are removed, and replaced with the new attributes.
1241 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1242 GtkCellRenderer *cell_renderer,
1247 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1248 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1249 g_return_if_fail (gtk_tree_view_column_get_cell_info (tree_column, cell_renderer));
1251 va_start (args, cell_renderer);
1252 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1258 * gtk_tree_view_column_set_cell_data_func:
1259 * @tree_column: A #GtkTreeViewColumn
1260 * @func: The #GtkTreeViewColumnFunc to use.
1261 * @func_data: The user data for @func.
1262 * @destroy: The destroy notification for @func_data
1264 * Sets the #GtkTreeViewColumnFunc to use for the column. This function is used
1265 * instead of the standard attributes mapping for setting the column value, and
1266 * should set the value of @tree_column 's cell renderer as appropriate. @func
1267 * may be NULL to remove an older one.
1270 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1271 GtkCellRenderer *cell_renderer,
1272 GtkTreeCellDataFunc func,
1274 GtkDestroyNotify destroy)
1276 GtkTreeViewColumnCellInfo *info;
1278 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1279 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1280 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1282 g_return_if_fail (info != NULL);
1284 if (func == info->func &&
1285 func_data == info->func_data &&
1286 destroy == info->destroy)
1289 if (info->func_data && info->destroy)
1290 (info->destroy) (info->func_data);
1293 info->func_data = func_data;
1294 info->destroy = destroy;
1296 if (tree_column->tree_view)
1297 gtk_tree_view_column_cell_set_dirty (tree_column);
1302 * gtk_tree_view_column_clear_attributes:
1303 * @tree_column: a #GtkTreeViewColumn
1304 *@cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1306 * Clears all existing attributes previously set with
1307 * gtk_tree_view_column_set_attributes().
1310 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1311 GtkCellRenderer *cell_renderer)
1313 GtkTreeViewColumnCellInfo *info;
1316 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1317 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1318 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1320 list = info->attributes;
1322 while (list && list->next)
1324 g_free (list->data);
1325 list = list->next->next;
1327 g_slist_free (info->attributes);
1328 info->attributes = NULL;
1330 if (tree_column->tree_view)
1331 gtk_tree_view_column_cell_set_dirty (tree_column);
1336 * gtk_tree_view_column_set_spacing:
1337 * @tree_column: A #GtkTreeViewColumn.
1338 * @spacing: distance between cell renderers in pixels.
1340 * Sets the spacing field of @tree_column, which is the number of pixels to
1341 * place between cell renderers packed into it.
1344 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1347 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1348 g_return_if_fail (spacing >= 0);
1350 if (tree_column->spacing == spacing)
1353 tree_column->spacing = spacing;
1354 if (tree_column->tree_view)
1355 gtk_tree_view_column_cell_set_dirty (tree_column);
1359 * gtk_tree_view_column_get_spacing:
1360 * @tree_column: A #GtkTreeViewColumn.
1362 * Returns the spacing of @tree_column.
1365 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1367 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1369 return tree_column->spacing;
1372 /* Options for manipulating the columns */
1375 * gtk_tree_view_column_set_visible:
1376 * @tree_column: A #GtkTreeViewColumn.
1377 * @visible: TRUE if the @tree_column is visible.
1379 * Sets the visibility of @tree_column.
1382 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1385 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1387 visible = !! visible;
1389 if (tree_column->visible == visible)
1392 tree_column->visible = visible;
1394 gtk_tree_view_column_update_button (tree_column);
1395 g_object_notify (G_OBJECT (tree_column), "visible");
1399 * gtk_tree_view_column_get_visible:
1400 * @tree_column: A #GtkTreeViewColumn.
1402 * Returns TRUE if @tree_column is visible.
1404 * Return value: whether the column is visible or not. If it is visible, then
1405 * the tree will show the column.
1408 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1410 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1412 return tree_column->visible;
1416 * gtk_tree_view_column_set_sizing:
1417 * @tree_column: A #GtkTreeViewColumn.
1418 * @type: The #GtkTreeViewColumnSizing.
1420 * Sets the growth behavior of @tree_column to @type.
1423 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1424 GtkTreeViewColumnSizing type)
1426 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1428 if (type == tree_column->column_type)
1431 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1432 tree_column->requested_width != -1)
1434 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1436 tree_column->column_type = type;
1438 gtk_tree_view_column_update_button (tree_column);
1440 if (type != GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1441 g_object_notify (G_OBJECT (tree_column), "sizing");
1445 * gtk_tree_view_column_get_sizing:
1446 * @tree_column: A #GtkTreeViewColumn.
1448 * Returns the current type of @tree_column.
1450 * Return value: The type of @tree_column.
1452 GtkTreeViewColumnSizing
1453 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1455 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1457 return tree_column->column_type;
1461 * gtk_tree_view_column_get_width:
1462 * @tree_column: A #GtkTreeViewColumn.
1464 * Returns the current size of the @tree_column in pixels.
1466 * Return value: The current width of the @tree_column.
1469 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1471 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1473 return tree_column->width;
1477 * gtk_tree_view_column_set_fixed_width:
1478 * @tree_column: A #GtkTreeViewColumn.
1479 * @width: The size to set the @tree_column to.
1481 * Sets the size of the column in pixels. This is meaningful only if the sizing
1482 * type is #GTK_TREE_VIEW_COLUMN_FIXED. In this case, the value is discarded
1483 * as the size of the column is based on the calculated width of the column. The
1484 * width is clamped to the min/max width for the column.
1487 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
1490 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1491 g_return_if_fail (width > 0);
1493 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1496 tree_column->fixed_width = width;
1497 tree_column->requested_width = width;
1498 _gtk_tree_view_column_set_width (tree_column, width);
1502 * gtk_tree_view_column_get_fixed_width:
1503 * @tree_column: a #GtkTreeViewColumn
1505 * Gets the fixed width of the column. This value is only meaning may not be the
1506 * actual width of the column on the screen, just what is requested.
1508 * Return value: the fixed width of the column
1511 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
1513 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1515 return tree_column->fixed_width;
1519 * gtk_tree_view_column_set_min_width:
1520 * @tree_column: A #GtkTreeViewColumn.
1521 * @min_width: The minimum width of the column in pixels, or -1.
1523 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1524 * minimum width is unset.
1527 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1530 gint real_min_width;
1532 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1533 g_return_if_fail (min_width >= -1);
1535 if (min_width == tree_column->min_width)
1538 if (tree_column->tree_view == NULL)
1540 tree_column->min_width = min_width;
1544 real_min_width = (tree_column->min_width == -1) ?
1545 tree_column->button->requisition.width : tree_column->min_width;
1547 /* We want to queue a resize if the either the old min_size or the
1548 * new min_size determined the size of the column */
1549 if (GTK_WIDGET_REALIZED (tree_column->tree_view))
1551 if ((tree_column->min_width > tree_column->width) ||
1552 (tree_column->min_width == -1 &&
1553 tree_column->button->requisition.width > tree_column->width) ||
1554 (min_width > tree_column->width) ||
1556 tree_column->button->requisition.width > tree_column->width))
1557 gtk_widget_queue_resize (tree_column->tree_view);
1560 if (tree_column->max_width != -1 && tree_column->max_width < real_min_width)
1561 tree_column->max_width = real_min_width;
1563 tree_column->min_width = min_width;
1565 g_object_notify (G_OBJECT (tree_column), "min_width");
1569 * gtk_tree_view_column_get_min_width:
1570 * @tree_column: A #GtkTreeViewColumn.
1572 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1575 * Return value: The minimum width of the @tree_column.
1578 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1580 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1582 return tree_column->min_width;
1586 * gtk_tree_view_column_set_max_width:
1587 * @tree_column: A #GtkTreeViewColumn.
1588 * @max_width: The maximum width of the column in pixels, or -1.
1590 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1591 * maximum width is unset. Note, the column can actually be wider than max
1592 * width if it's the last column in a view. In this case, the column expands to
1596 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1599 gint real_max_width;
1601 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1602 g_return_if_fail (max_width >= -1);
1604 if (max_width == tree_column->max_width)
1607 if (tree_column->tree_view == NULL)
1609 tree_column->max_width = max_width;
1613 real_max_width = tree_column->max_width == -1 ?
1614 tree_column->button->requisition.width : tree_column->max_width;
1616 if (tree_column->tree_view &&
1617 GTK_WIDGET_REALIZED (tree_column->tree_view) &&
1618 ((tree_column->max_width < tree_column->width) ||
1619 (max_width != -1 && max_width < tree_column->width)))
1620 gtk_widget_queue_resize (tree_column->tree_view);
1622 tree_column->max_width = max_width;
1624 if (real_max_width > max_width)
1625 tree_column->max_width = max_width;
1627 g_object_notify (G_OBJECT (tree_column), "max_width");
1631 * gtk_tree_view_column_get_max_width:
1632 * @tree_column: A #GtkTreeViewColumn.
1634 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1637 * Return value: The maximum width of the @tree_column.
1640 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1642 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1644 return tree_column->max_width;
1648 * gtk_tree_view_column_clicked:
1649 * @tree_column: a #GtkTreeViewColumn
1651 * Emits the "clicked" signal on the column. This function will only work if
1652 * the user could have conceivably clicked on the button.
1655 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1657 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1659 if (tree_column->visible &&
1660 tree_column->button &&
1661 tree_column->clickable)
1662 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1666 * gtk_tree_view_column_set_title:
1667 * @tree_column: A #GtkTreeViewColumn.
1668 * @title: The title of the @tree_column.
1670 * Sets the title of the @tree_column. If a custom widget has been set, then
1671 * this value is ignored.
1674 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
1677 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1679 g_free (tree_column->title);
1681 tree_column->title = g_strdup (title);
1683 tree_column->title = NULL;
1685 gtk_tree_view_column_update_button (tree_column);
1686 g_object_notify (G_OBJECT (tree_column), "title");
1690 * gtk_tree_view_column_get_title:
1691 * @tree_column: A #GtkTreeViewColumn.
1693 * Returns the title of the widget. This value should not be modified.
1695 * Return value: the title of the column.
1697 G_CONST_RETURN gchar *
1698 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
1700 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1702 return tree_column->title;
1706 * gtk_tree_view_column_set_clickable:
1707 * @tree_column: A #GtkTreeViewColumn.
1708 * @clickable: TRUE if the header is active.
1710 * Sets the header to be active if @active is TRUE. When the header is active,
1711 * then it can take keyboard focus, and can be clicked.
1714 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
1717 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1719 if (tree_column->clickable == (clickable?TRUE:FALSE))
1722 tree_column->clickable = (clickable?TRUE:FALSE);
1723 gtk_tree_view_column_update_button (tree_column);
1724 g_object_notify (G_OBJECT (tree_column), "clickable");
1728 * gtk_tree_view_column_get_clickable:
1729 * @tree_column: a #GtkTreeViewColumn
1731 * Returns %TRUE if the user can click on the header for the column.
1733 * Return value: whether the user can click the column header
1736 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
1738 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1740 return tree_column->clickable;
1744 * gtk_tree_view_column_set_widget:
1745 * @tree_column: A #GtkTreeViewColumn.
1746 * @widget: A child #GtkWidget, or NULL.
1748 * Sets the widget in the header to be @widget. If widget is NULL, then the
1749 * header button is set with a #GtkLabel set to the title of @tree_column.
1752 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
1755 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1756 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1760 gtk_object_ref (GTK_OBJECT (widget));
1761 gtk_object_sink (GTK_OBJECT (widget));
1764 if (tree_column->child)
1765 gtk_object_unref (GTK_OBJECT (tree_column->child));
1767 tree_column->child = widget;
1768 gtk_tree_view_column_update_button (tree_column);
1769 g_object_notify (G_OBJECT (tree_column), "widget");
1773 * gtk_tree_view_column_get_widget:
1774 * @tree_column: A #GtkTreeViewColumn.
1776 * Returns the #GtkWidget in the button in the column header. If a custom
1777 * widget has not been set, then this will be a #GtkAlignment with a #GtkLabel
1780 * Return value: The #GtkWidget in the column header.
1783 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
1785 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1787 return tree_column->child;
1791 * gtk_tree_view_column_set_alignment:
1792 * @tree_column: A #GtkTreeViewColumn.
1793 * @xalign: alignment (0.0 for left, 0.5 for center, 1.0 for right)
1795 * Sets the alignment of the title or custom widget inside the column header.
1798 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
1801 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1803 if (tree_column->xalign == xalign)
1806 tree_column->xalign = xalign;
1807 gtk_tree_view_column_update_button (tree_column);
1808 g_object_notify (G_OBJECT (tree_column), "alignment");
1812 * gtk_tree_view_column_get_alignment:
1813 * @tree_column: A #GtkTreeViewColumn.
1815 * Returns the current x alignment of @tree_column. This value can range
1816 * between 0.0 and 1.0.
1818 * Return value: The current alignent of @tree_column.
1821 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
1823 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
1825 return tree_column->xalign;
1829 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
1830 gboolean reorderable)
1832 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1835 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
1837 if (tree_column->reorderable == (reorderable?TRUE:FALSE))
1840 tree_column->reorderable = (reorderable?TRUE:FALSE);
1841 gtk_tree_view_column_update_button (tree_column);
1842 g_object_notify (G_OBJECT (tree_column), "reorderable");
1846 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
1848 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1850 return tree_column->reorderable;
1855 * gtk_tree_view_column_set_sort_column_id:
1856 * @tree_column: a #GtkTreeViewColumn
1857 * @sort_column_id: The sort_column_id of the model to sort on.
1859 * Sets the logical sort_column_id that this column sorts on when this column is
1860 * selected for sorting. Doing so makes the column header clickable.
1863 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
1864 gint sort_column_id)
1866 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1867 g_return_if_fail (sort_column_id >= 0);
1869 if (tree_column->sort_column_id == sort_column_id)
1872 tree_column->sort_column_id = sort_column_id;
1874 /* Handle unsetting the id */
1875 if (sort_column_id == -1)
1877 if (tree_column->sort_clicked_signal)
1879 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_clicked_signal);
1880 tree_column->sort_clicked_signal = 0;
1883 if (tree_column->sort_column_changed_signal)
1885 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
1886 tree_column->sort_column_changed_signal = 0;
1889 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
1890 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1894 gtk_tree_view_column_set_clickable (tree_column, TRUE);
1896 if (! tree_column->sort_clicked_signal)
1897 tree_column->sort_clicked_signal = g_signal_connect (G_OBJECT (tree_column),
1899 G_CALLBACK (gtk_tree_view_column_sort),
1902 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
1906 * gtk_tree_view_column_get_sort_column_id:
1907 * @tree_column: a #GtkTreeViewColumn
1909 * Gets the logical sort_column_id that the model sorts on when this
1910 * coumn is selected for sorting. See gtk_tree_view_column_set_sort_column_id().
1912 * Return value: the current sort_column_id for this column, or -1 if
1913 * this column can't be used for sorting.
1916 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
1918 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1920 return tree_column->sort_column_id;
1924 * gtk_tree_view_column_set_sort_indicator:
1925 * @tree_column: a #GtkTreeViewColumn
1926 * @setting: %TRUE to display an indicator that the column is sorted
1928 * Call this function with a @setting of %TRUE to display an arrow in
1929 * the header button indicating the column is sorted. Call
1930 * gtk_tree_view_column_set_sort_order() to change the direction of
1935 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
1938 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1940 setting = setting != FALSE;
1942 if (setting == tree_column->show_sort_indicator)
1945 tree_column->show_sort_indicator = setting;
1946 gtk_tree_view_column_update_button (tree_column);
1947 g_object_notify (G_OBJECT (tree_column), "sort_indicator");
1951 * gtk_tree_view_column_get_sort_indicator:
1952 * @tree_column: a #GtkTreeViewColumn
1954 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
1956 * Return value: whether the sort indicator arrow is displayed
1959 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
1961 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1963 return tree_column->show_sort_indicator;
1967 * gtk_tree_view_column_set_sort_order:
1968 * @tree_column: a #GtkTreeViewColumn
1969 * @order: sort order that the sort indicator should indicate
1971 * Changes the appearance of the sort indicator. (This <emphasis>does
1972 * not</emphasis> actually sort the model. Use
1973 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
1974 * support. This function is primarily for custom sorting behavior, and should
1975 * be used in conjunction with #gtk_tree_sortable_set_sort_column() to do
1976 * that. For custom models, the mechanism will vary. The sort indicator changes
1977 * direction to indicate normal sort or reverse sort. Note that you must have
1978 * the sort indicator enabled to see anything when calling this function; see
1979 * gtk_tree_view_column_set_sort_indicator().
1983 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
1986 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1988 if (order == tree_column->sort_order)
1991 tree_column->sort_order = order;
1992 gtk_tree_view_column_update_button (tree_column);
1993 g_object_notify (G_OBJECT (tree_column), "sort_order");
1997 * gtk_tree_view_column_get_sort_order:
1998 * @tree_column: a #GtkTreeViewColumn
2000 * Gets the value set by gtk_tree_view_column_set_sort_order().
2002 * Return value: the sort order the sort indicator is indicating
2005 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2007 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2009 return tree_column->sort_order;
2013 * gtk_tree_view_column_cell_set_cell_data:
2014 * @tree_column: A #GtkTreeViewColumn.
2015 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2016 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2017 * @is_expander: TRUE, if the row has children
2018 * @is_expanded: TRUE, if the row has visible children
2020 * Sets the cell renderer based on the @tree_model and @tree_node. That is, for
2021 * every attribute mapping in @tree_column, it will get a value from the set
2022 * column on the @tree_node, and use that value to set the attribute on the cell
2023 * renderer. This is used primarily by the GtkTreeView.
2026 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2027 GtkTreeModel *tree_model,
2029 gboolean is_expander,
2030 gboolean is_expanded)
2033 GValue value = { 0, };
2036 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2037 g_return_if_fail (tree_column->cell_list != NULL);
2039 if (tree_model == NULL)
2042 for (cell_list = tree_column->cell_list; cell_list; cell_list = cell_list->next)
2044 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) cell_list->data;
2045 GObject *cell = (GObject *) info->cell;
2047 list = info->attributes;
2049 g_object_freeze_notify (cell);
2050 g_object_set (cell, "is_expander", is_expander, "is_expanded", is_expanded, NULL);
2052 while (list && list->next)
2054 gtk_tree_model_get_value (tree_model, iter,
2055 GPOINTER_TO_INT (list->next->data),
2057 g_object_set_property (cell, (gchar *) list->data, &value);
2058 g_value_unset (&value);
2059 list = list->next->next;
2063 (* info->func) (tree_column, info->cell, tree_model, iter, info->func_data);
2064 g_object_thaw_notify (G_OBJECT (info->cell));
2070 * gtk_tree_view_column_cell_get_size:
2071 * @tree_column: A #GtkTreeViewColumn.
2072 * @cell_area: The area a the column will be allocated, or %NULL
2073 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
2074 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
2075 * @width: location to return width needed to render a cell, or %NULL
2076 * @height: location to return height needed to render a cell, or %NULL
2078 * Obtains the width and height needed to render the column. This is used
2079 * primarily by the GtkTreeView.
2082 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2083 GdkRectangle *cell_area,
2089 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2091 gtk_cell_renderer_get_size (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2092 tree_column->tree_view,
2102 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2103 GdkRectangle *cell_area,
2110 gboolean first_cell = TRUE;
2112 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2119 for (list = tree_column->cell_list; list; list = list->next)
2121 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2123 gint new_height = 0;
2125 g_object_get (info->cell, "visible", &visible, NULL);
2127 if (visible == FALSE)
2130 if (first_cell == FALSE && *width)
2131 *width += tree_column->spacing;
2133 gtk_cell_renderer_get_size (info->cell,
2134 tree_column->tree_view,
2142 * height = MAX (*height, new_height);
2143 info->requested_width = MAX (info->requested_width, new_width);
2145 * width += info->requested_width;
2151 * gtk_tree_view_column_cell_render:
2152 * @tree_column: A #GtkTreeViewColumn.
2153 * @window: a #GdkDrawable to draw to
2154 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2155 * @cell_area: area normally rendered by a cell renderer
2156 * @expose_area: area that actually needs updating
2157 * @flags: flags that affect rendering
2159 * Renders the cell contained by #tree_column. This is used primarily by the
2163 gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2165 GdkRectangle *background_area,
2166 GdkRectangle *cell_area,
2167 GdkRectangle *expose_area,
2171 GdkRectangle real_cell_area;
2172 gint expand_cell_count = 0;
2173 gint full_requested_width = 0;
2176 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2177 g_return_if_fail (background_area != NULL);
2178 g_return_if_fail (cell_area != NULL);
2179 g_return_if_fail (expose_area != NULL);
2181 real_cell_area = *cell_area;
2183 /* Find out how my extra space we have to allocate */
2184 for (list = tree_column->cell_list; list; list = list->next)
2186 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2189 g_object_get (info->cell, "visible", &visible, NULL);
2190 if (visible == FALSE)
2193 if (info->expand == TRUE)
2194 expand_cell_count ++;
2195 full_requested_width += info->requested_width;
2198 extra_space = cell_area->width - full_requested_width;
2199 if (extra_space < 0)
2202 for (list = tree_column->cell_list; list; list = list->next)
2204 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2207 if (info->pack == GTK_PACK_END)
2210 g_object_get (info->cell, "visible", &visible, NULL);
2211 if (visible == FALSE)
2214 real_cell_area.width = info->requested_width +
2215 (info->expand?extra_space:0);
2216 gtk_cell_renderer_render (info->cell,
2218 tree_column->tree_view,
2223 real_cell_area.x += (info->requested_width + tree_column->spacing);
2225 for (list = g_list_last (tree_column->cell_list); list; list = list->prev)
2227 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2230 if (info->pack == GTK_PACK_START)
2233 g_object_get (info->cell, "visible", &visible, NULL);
2234 if (visible == FALSE)
2237 real_cell_area.width = info->requested_width +
2238 (info->expand?extra_space:0);
2239 gtk_cell_renderer_render (info->cell,
2241 tree_column->tree_view,
2246 real_cell_area.x += (info->requested_width + tree_column->spacing);
2251 * gtk_tree_view_column_cell_event:
2252 * @tree_column: A #GtkTreeViewColumn.
2253 * @event: a #GdkEvent
2254 * @path_string: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
2255 * @background_area: background area as passed to gtk_cell_renderer_render()
2256 * @cell_area: cell area as passed to gtk_cell_renderer_render()
2257 * @flags: render flags
2259 * Handles an event. This is used primarily by the GtkTreeView.
2261 * Return value: %TRUE if the event was consumed/handled
2264 gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2267 GdkRectangle *background_area,
2268 GdkRectangle *cell_area,
2271 gboolean visible, can_activate;
2273 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2275 g_object_get (G_OBJECT (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell),
2276 "visible", &visible,
2277 "can_activate", &can_activate,
2279 if (visible && can_activate)
2281 if (gtk_cell_renderer_event (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2283 tree_column->tree_view,
2296 gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
2302 gboolean can_activate;
2307 gtk_tree_view_column_cell_can_focus (GtkTreeViewColumn *tree_column)
2311 gboolean can_activate;
2313 for (list = tree_column->cell_list; list; list = list->next)
2315 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2316 g_object_get (G_OBJECT (info->cell),
2317 "can_activate", &can_activate,
2318 "visible", &visible,
2320 if (can_activate && visible)
2329 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2333 for (list = tree_column->cell_list; list; list = list->next)
2335 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2338 g_object_get (G_OBJECT (info->cell), "visible", &visible, NULL);
2348 gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column)
2352 for (list = tree_column->cell_list; list; list = list->next)
2354 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2356 info->requested_width = 0;
2358 tree_column->dirty = TRUE;
2360 if (tree_column->tree_view)
2361 gtk_widget_queue_resize (tree_column->tree_view);