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);
114 static GtkObjectClass *parent_class = NULL;
115 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
119 gtk_tree_view_column_get_type (void)
121 static GtkType tree_column_type = 0;
123 if (!tree_column_type)
125 static const GTypeInfo tree_column_info =
127 sizeof (GtkTreeViewColumnClass),
128 NULL, /* base_init */
129 NULL, /* base_finalize */
130 (GClassInitFunc) gtk_tree_view_column_class_init,
131 NULL, /* class_finalize */
132 NULL, /* class_data */
133 sizeof (GtkTreeViewColumn),
135 (GInstanceInitFunc) gtk_tree_view_column_init,
138 tree_column_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTreeViewColumn", &tree_column_info, 0);
141 return tree_column_type;
145 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
147 GObjectClass *object_class;
149 object_class = (GObjectClass*) class;
151 parent_class = g_type_class_peek_parent (class);
153 class->clicked = NULL;
155 object_class->finalize = gtk_tree_view_column_finalize;
156 object_class->set_property = gtk_tree_view_column_set_property;
157 object_class->get_property = gtk_tree_view_column_get_property;
159 tree_column_signals[CLICKED] =
160 g_signal_new ("clicked",
161 GTK_CLASS_TYPE (object_class),
163 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
165 gtk_marshal_VOID__VOID,
168 g_object_class_install_property (object_class,
170 g_param_spec_boolean ("visible",
172 _("Whether to display the column"),
174 G_PARAM_READABLE | G_PARAM_WRITABLE));
176 g_object_class_install_property (object_class,
178 g_param_spec_int ("width",
180 _("Current width of the column"),
185 g_object_class_install_property (object_class,
187 g_param_spec_enum ("sizing",
189 _("Resize mode of the column"),
190 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
191 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
192 G_PARAM_READABLE | G_PARAM_WRITABLE));
194 g_object_class_install_property (object_class,
196 g_param_spec_int ("fixed_width",
198 _("Current fixed width of the column"),
202 G_PARAM_READABLE | G_PARAM_WRITABLE));
204 g_object_class_install_property (object_class,
206 g_param_spec_int ("min_width",
208 _("Minimum allowed width of the column"),
212 G_PARAM_READABLE | G_PARAM_WRITABLE));
214 g_object_class_install_property (object_class,
216 g_param_spec_int ("max_width",
218 _("Maximum allowed width of the column"),
222 G_PARAM_READABLE | G_PARAM_WRITABLE));
224 g_object_class_install_property (object_class,
226 g_param_spec_string ("title",
228 _("Title to appear in column header"),
230 G_PARAM_READABLE | G_PARAM_WRITABLE));
232 g_object_class_install_property (object_class,
234 g_param_spec_boolean ("clickable",
236 _("Whether the header can be clicked"),
238 G_PARAM_READABLE | G_PARAM_WRITABLE));
241 g_object_class_install_property (object_class,
243 g_param_spec_object ("widget",
245 _("Widget to put in column header button instead of column title"),
247 G_PARAM_READABLE | G_PARAM_WRITABLE));
249 g_object_class_install_property (object_class,
251 g_param_spec_float ("alignment",
253 _("X Alignment of the column header text or widget"),
257 G_PARAM_READABLE | G_PARAM_WRITABLE));
259 g_object_class_install_property (object_class,
261 g_param_spec_boolean ("reorderable",
263 _("Whether the column can be reordered around the headers"),
265 G_PARAM_READABLE | G_PARAM_WRITABLE));
267 g_object_class_install_property (object_class,
269 g_param_spec_boolean ("sort_indicator",
271 _("Whether to show a sort indicator"),
273 G_PARAM_READABLE | G_PARAM_WRITABLE));
275 g_object_class_install_property (object_class,
277 g_param_spec_enum ("sort_order",
279 _("Sort direction the sort indicator should indicate"),
282 G_PARAM_READABLE | G_PARAM_WRITABLE));
287 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
289 tree_column->button = NULL;
290 tree_column->xalign = 0.0;
291 tree_column->width = 0;
292 tree_column->requested_width = -1;
293 tree_column->min_width = -1;
294 tree_column->max_width = -1;
295 tree_column->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
296 tree_column->visible = TRUE;
297 tree_column->clickable = FALSE;
298 tree_column->dirty = TRUE;
299 tree_column->sort_order = GTK_SORT_ASCENDING;
300 tree_column->show_sort_indicator = FALSE;
301 tree_column->property_changed_signal = 0;
302 tree_column->sort_clicked_signal = 0;
303 tree_column->sort_column_changed_signal = 0;
304 tree_column->sort_column_id = -1;
305 tree_column->reorderable = FALSE;
306 tree_column->maybe_reordered = FALSE;
310 gtk_tree_view_column_finalize (GObject *object)
312 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
315 for (list = tree_column->cell_list; list; list = list->next)
317 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
318 if (info->func_data && info->destroy)
319 (info->destroy) (info->func_data);
320 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
321 g_object_unref (G_OBJECT (info->cell));
325 g_free (tree_column->title);
327 G_OBJECT_CLASS (parent_class)->finalize (object);
331 gtk_tree_view_column_set_property (GObject *object,
336 GtkTreeViewColumn *tree_column;
338 tree_column = GTK_TREE_VIEW_COLUMN (object);
343 gtk_tree_view_column_set_visible (tree_column,
344 g_value_get_boolean (value));
348 gtk_tree_view_column_set_sizing (tree_column,
349 g_value_get_enum (value));
352 case PROP_FIXED_WIDTH:
353 gtk_tree_view_column_set_fixed_width (tree_column,
354 g_value_get_int (value));
358 gtk_tree_view_column_set_min_width (tree_column,
359 g_value_get_int (value));
363 gtk_tree_view_column_set_max_width (tree_column,
364 g_value_get_int (value));
368 gtk_tree_view_column_set_title (tree_column,
369 g_value_get_string (value));
373 gtk_tree_view_column_set_clickable (tree_column,
374 g_value_get_boolean (value));
378 gtk_tree_view_column_set_widget (tree_column,
379 (GtkWidget*) g_value_get_object (value));
383 gtk_tree_view_column_set_alignment (tree_column,
384 g_value_get_float (value));
387 case PROP_REORDERABLE:
388 gtk_tree_view_column_set_reorderable (tree_column,
389 g_value_get_boolean (value));
392 case PROP_SORT_INDICATOR:
393 gtk_tree_view_column_set_sort_indicator (tree_column,
394 g_value_get_boolean (value));
397 case PROP_SORT_ORDER:
398 gtk_tree_view_column_set_sort_order (tree_column,
399 g_value_get_enum (value));
403 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
409 gtk_tree_view_column_get_property (GObject *object,
414 GtkTreeViewColumn *tree_column;
416 tree_column = GTK_TREE_VIEW_COLUMN (object);
421 g_value_set_boolean (value,
422 gtk_tree_view_column_get_visible (tree_column));
426 g_value_set_int (value,
427 gtk_tree_view_column_get_width (tree_column));
431 g_value_set_enum (value,
432 gtk_tree_view_column_get_sizing (tree_column));
435 case PROP_FIXED_WIDTH:
436 g_value_set_int (value,
437 gtk_tree_view_column_get_fixed_width (tree_column));
441 g_value_set_int (value,
442 gtk_tree_view_column_get_min_width (tree_column));
446 g_value_set_int (value,
447 gtk_tree_view_column_get_max_width (tree_column));
451 g_value_set_string (value,
452 gtk_tree_view_column_get_title (tree_column));
456 g_value_set_boolean (value,
457 gtk_tree_view_column_get_clickable (tree_column));
461 g_value_set_object (value,
462 (GObject*) gtk_tree_view_column_get_widget (tree_column));
466 g_value_set_float (value,
467 gtk_tree_view_column_get_alignment (tree_column));
470 case PROP_REORDERABLE:
471 g_value_set_boolean (value,
472 gtk_tree_view_column_get_reorderable (tree_column));
475 case PROP_SORT_INDICATOR:
476 g_value_set_boolean (value,
477 gtk_tree_view_column_get_sort_indicator (tree_column));
480 case PROP_SORT_ORDER:
481 g_value_set_enum (value,
482 gtk_tree_view_column_get_sort_order (tree_column));
486 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
494 /* Button handling code
497 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
499 GtkTreeView *tree_view;
503 tree_view = (GtkTreeView *) tree_column->tree_view;
505 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
506 g_return_if_fail (tree_column->button == NULL);
508 gtk_widget_push_composite_child ();
509 tree_column->button = gtk_button_new ();
510 gtk_widget_pop_composite_child ();
512 /* make sure we own a reference to it as well. */
513 if (tree_view->priv->header_window)
514 gtk_widget_set_parent_window (tree_column->button, tree_view->priv->header_window);
515 gtk_widget_set_parent (tree_column->button, GTK_WIDGET (tree_view));
517 gtk_signal_connect (GTK_OBJECT (tree_column->button), "realize",
518 (GtkSignalFunc) gtk_tree_view_column_button_realize,
521 gtk_signal_connect (GTK_OBJECT (tree_column->button), "event",
522 (GtkSignalFunc) gtk_tree_view_column_button_event,
523 (gpointer) tree_column);
525 gtk_signal_connect (GTK_OBJECT (tree_column->button), "clicked",
526 (GtkSignalFunc) gtk_tree_view_column_button_clicked,
527 (gpointer) tree_column);
529 tree_column->alignment = gtk_alignment_new (tree_column->xalign, 0.5, 0.0, 0.0);
531 hbox = gtk_hbox_new (FALSE, 2);
532 tree_column->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
534 if (tree_column->child)
535 child = tree_column->child;
538 child = gtk_label_new (tree_column->title);
539 gtk_widget_show (child);
542 if (tree_column->xalign <= 0.5)
543 gtk_box_pack_end (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
545 gtk_box_pack_start (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
547 gtk_box_pack_start (GTK_BOX (hbox), tree_column->alignment, TRUE, TRUE, 0);
549 gtk_container_add (GTK_CONTAINER (tree_column->alignment), child);
550 gtk_container_add (GTK_CONTAINER (tree_column->button), hbox);
552 gtk_widget_show (hbox);
553 gtk_widget_show (tree_column->alignment);
554 gtk_tree_view_column_update_button (tree_column);
558 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
561 GtkWidget *alignment;
563 GtkWidget *current_child;
565 /* Create a button if necessary */
566 if (tree_column->visible &&
567 tree_column->button == NULL &&
568 tree_column->tree_view &&
569 GTK_WIDGET_REALIZED (tree_column->tree_view))
570 gtk_tree_view_column_create_button (tree_column);
572 if (! tree_column->button)
575 hbox = GTK_BIN (tree_column->button)->child;
576 alignment = tree_column->alignment;
577 arrow = tree_column->arrow;
578 current_child = GTK_BIN (alignment)->child;
580 /* Set up the actual button */
581 gtk_alignment_set (GTK_ALIGNMENT (alignment), tree_column->xalign,
584 if (tree_column->child)
586 if (current_child != tree_column->child)
588 gtk_container_remove (GTK_CONTAINER (alignment),
590 gtk_container_add (GTK_CONTAINER (alignment),
596 if (current_child == NULL)
598 current_child = gtk_label_new (NULL);
599 gtk_widget_show (current_child);
600 gtk_container_add (GTK_CONTAINER (alignment),
604 g_return_if_fail (GTK_IS_LABEL (current_child));
606 if (tree_column->title)
607 gtk_label_set_text (GTK_LABEL (current_child),
610 gtk_label_set_text (GTK_LABEL (current_child),
614 switch (tree_column->sort_order)
616 case GTK_SORT_ASCENDING:
617 gtk_arrow_set (GTK_ARROW (arrow),
622 case GTK_SORT_DESCENDING:
623 gtk_arrow_set (GTK_ARROW (arrow),
629 g_warning (G_STRLOC": bad sort order");
633 /* Put arrow on the right if the text is left-or-center justified,
634 * and on the left otherwise; do this by packing boxes, so flipping
635 * text direction will reverse things
637 gtk_widget_ref (arrow);
638 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
640 if (tree_column->xalign <= 0.5)
642 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
646 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
647 /* move it to the front */
648 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
650 gtk_widget_unref (arrow);
652 if (tree_column->show_sort_indicator)
653 gtk_widget_show (arrow);
655 gtk_widget_hide (arrow);
657 /* It's always safe to hide the button. It isn't always safe to show it, as if you show it
658 * before it's realized, it'll get the wrong window. */
659 if (tree_column->button &&
660 tree_column->tree_view != NULL &&
661 GTK_WIDGET_REALIZED (tree_column->tree_view))
663 if (tree_column->visible)
665 gtk_widget_show_now (tree_column->button);
666 if (tree_column->window)
668 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_RESIZABLE)
670 gdk_window_show (tree_column->window);
671 gdk_window_raise (tree_column->window);
675 gdk_window_hide (tree_column->window);
681 gtk_widget_hide (tree_column->button);
682 if (tree_column->window)
683 gdk_window_hide (tree_column->window);
687 if (tree_column->reorderable || tree_column->clickable)
689 GTK_WIDGET_SET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
693 GTK_WIDGET_UNSET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
694 if (GTK_WIDGET_HAS_FOCUS (tree_column->button))
696 GtkWidget *toplevel = gtk_widget_get_toplevel (tree_column->tree_view);
697 if (GTK_WIDGET_TOPLEVEL (toplevel))
698 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
702 gtk_tree_view_column_cell_set_dirty (tree_column);
705 /* Button signal handlers
709 gtk_tree_view_column_button_event (GtkWidget *widget,
713 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
715 g_return_val_if_fail (event != NULL, FALSE);
717 if (event->type == GDK_BUTTON_PRESS &&
720 column->maybe_reordered = TRUE;
721 gdk_window_get_pointer (widget->window,
725 gtk_widget_grab_focus (widget);
728 if (event->type == GDK_BUTTON_RELEASE &&
729 column->maybe_reordered)
730 column->maybe_reordered = FALSE;
732 if (event->type == GDK_MOTION_NOTIFY &&
733 (column->maybe_reordered) &&
734 (gtk_drag_check_threshold (widget,
737 (gint) ((GdkEventMotion *)event)->x,
738 (gint) ((GdkEventMotion *)event)->y)))
740 column->maybe_reordered = FALSE;
741 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column);
744 if (column->clickable == FALSE)
748 case GDK_BUTTON_PRESS:
749 case GDK_2BUTTON_PRESS:
750 case GDK_3BUTTON_PRESS:
751 case GDK_MOTION_NOTIFY:
752 case GDK_BUTTON_RELEASE:
753 case GDK_ENTER_NOTIFY:
754 case GDK_LEAVE_NOTIFY:
764 gtk_tree_view_column_button_realize (GtkWidget *widget, gpointer data)
766 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | GDK_POINTER_MOTION_MASK);
770 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
772 g_signal_emit_by_name (G_OBJECT (data), "clicked");
776 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
777 GtkTreeViewColumn *column)
782 if (gtk_tree_sortable_get_sort_column_id (sortable,
786 if (sort_column_id == column->sort_column_id)
788 gtk_tree_view_column_set_sort_indicator (column, TRUE);
789 gtk_tree_view_column_set_sort_order (column, order);
793 gtk_tree_view_column_set_sort_indicator (column, FALSE);
798 gtk_tree_view_column_set_sort_indicator (column, FALSE);
803 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
808 gboolean has_sort_column;
809 gboolean has_default_sort_func;
811 g_return_if_fail (tree_column->tree_view != NULL);
814 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
817 has_default_sort_func =
818 gtk_tree_sortable_has_default_sort_func (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model));
820 if (has_sort_column &&
821 sort_column_id == tree_column->sort_column_id)
823 if (order == GTK_SORT_ASCENDING)
824 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
825 tree_column->sort_column_id,
826 GTK_SORT_DESCENDING);
827 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
828 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
829 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
832 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
833 tree_column->sort_column_id,
838 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
839 tree_column->sort_column_id,
846 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
850 if (tree_column->tree_view == NULL)
853 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
858 if (GTK_IS_TREE_SORTABLE (model) &&
859 tree_column->sort_column_id != -1)
861 gint real_sort_column_id;
862 GtkSortType real_order;
864 if (tree_column->sort_column_changed_signal == 0)
865 tree_column->sort_column_changed_signal =
866 g_signal_connect (G_OBJECT (model), "sort_column_changed",
867 GTK_SIGNAL_FUNC (gtk_tree_view_model_sort_column_changed),
870 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
871 &real_sort_column_id,
873 (real_sort_column_id == tree_column->sort_column_id))
875 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
876 gtk_tree_view_column_set_sort_order (tree_column, real_order);
884 /* Exported Private Functions.
885 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
889 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
891 GtkTreeView *tree_view;
893 guint attributes_mask;
895 tree_view = (GtkTreeView *)column->tree_view;
897 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
898 g_return_if_fail (GTK_WIDGET_REALIZED (tree_view));
899 g_return_if_fail (tree_view->priv->header_window != NULL);
900 g_return_if_fail (column->button != NULL);
902 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
905 gtk_widget_show (column->button);
907 attr.window_type = GDK_WINDOW_CHILD;
908 attr.wclass = GDK_INPUT_ONLY;
909 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
910 attr.colormap = gtk_widget_get_colormap (GTK_WIDGET (tree_view));
911 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view));
912 attr.event_mask = (GDK_BUTTON_PRESS_MASK |
913 GDK_BUTTON_RELEASE_MASK |
914 GDK_POINTER_MOTION_MASK |
915 GDK_POINTER_MOTION_HINT_MASK |
917 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
918 attr.cursor = gdk_cursor_new (GDK_SB_H_DOUBLE_ARROW);
919 tree_view->priv->cursor_drag = attr.cursor;
922 attr.width = TREE_VIEW_DRAG_WIDTH;
923 attr.height = tree_view->priv->header_height;
925 attr.x = (column->button->allocation.x + column->button->allocation.width) - 3;
927 column->window = gdk_window_new (tree_view->priv->header_window,
928 &attr, attributes_mask);
929 gdk_window_set_user_data (column->window, tree_view);
931 gtk_tree_view_column_update_button (column);
935 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
937 g_return_if_fail (column != NULL);
938 g_return_if_fail (column->window != NULL);
940 gdk_window_set_user_data (column->window, NULL);
941 gdk_window_destroy (column->window);
942 column->window = NULL;
946 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
947 GtkTreeView *tree_view)
949 g_assert (column->tree_view == NULL);
951 column->tree_view = GTK_WIDGET (tree_view);
952 gtk_tree_view_column_create_button (column);
954 column->property_changed_signal =
955 g_signal_connect_swapped (GTK_OBJECT (tree_view),
957 GTK_SIGNAL_FUNC (gtk_tree_view_column_setup_sort_column_id_callback),
960 gtk_tree_view_column_setup_sort_column_id_callback (column);
964 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
966 if (column->tree_view && column->button)
968 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
970 if (column->property_changed_signal)
972 g_signal_handler_disconnect (G_OBJECT (column->tree_view), column->property_changed_signal);
973 column->property_changed_signal = 0;
976 if (column->sort_column_changed_signal)
978 g_signal_handler_disconnect (G_OBJECT (gtk_tree_view_get_model (GTK_TREE_VIEW (column->tree_view))),
979 column->sort_column_changed_signal);
980 column->sort_column_changed_signal = 0;
983 column->tree_view = NULL;
984 column->button = NULL;
988 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
991 if (tree_column->min_width != -1 &&
992 width <= tree_column->min_width)
993 width = tree_column->min_width;
994 else if (tree_column->max_width != -1 &&
995 width > tree_column->max_width)
996 width = tree_column->max_width;
998 if (tree_column->width == width)
1001 tree_column->width = width;
1003 g_object_notify (G_OBJECT (tree_column), "width");
1005 if (tree_column->tree_view != NULL)
1006 gtk_widget_queue_resize (tree_column->tree_view);
1010 /* Public Functions */
1014 * gtk_tree_view_column_new:
1016 * Creates a new #GtkTreeViewColumn.
1018 * Return value: A newly created #GtkTreeViewColumn.
1021 gtk_tree_view_column_new (void)
1023 GtkTreeViewColumn *tree_column;
1025 tree_column = GTK_TREE_VIEW_COLUMN (gtk_type_new (GTK_TYPE_TREE_VIEW_COLUMN));
1031 * gtk_tree_view_column_new_with_attributes:
1032 * @title: The title to set the header to.
1033 * @cell: The #GtkCellRenderer.
1034 * @Varargs: A NULL terminated list of attributes.
1036 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1037 * equivalent to calling @gtk_tree_view_column_set_title,
1038 * @gtk_tree_view_column_pack_start, and
1039 * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn.
1041 * Return value: A newly created #GtkTreeViewColumn.
1044 gtk_tree_view_column_new_with_attributes (const gchar *title,
1045 GtkCellRenderer *cell,
1048 GtkTreeViewColumn *retval;
1051 retval = gtk_tree_view_column_new ();
1053 gtk_tree_view_column_set_title (retval, title);
1054 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1056 va_start (args, cell);
1057 gtk_tree_view_column_set_attributesv (retval, cell, args);
1063 static GtkTreeViewColumnCellInfo *
1064 gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
1065 GtkCellRenderer *cell_renderer)
1068 for (list = tree_column->cell_list; list; list = list->next)
1069 if (((GtkTreeViewColumnCellInfo *)list->data)->cell == cell_renderer)
1070 return (GtkTreeViewColumnCellInfo *) list->data;
1076 * gtk_tree_view_column_pack_start:
1077 * @tree_column: A #GtkTreeViewColumn.
1078 * @cell: The #GtkCellRenderer,
1079 * @expand: TRUE if @cell is to be given extra space allocated to box.
1083 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1084 GtkCellRenderer *cell,
1087 GtkTreeViewColumnCellInfo *cell_info;
1089 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1090 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1091 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1093 g_object_ref (G_OBJECT (cell));
1094 gtk_object_sink (GTK_OBJECT (cell));
1096 cell_info = g_new0 (GtkTreeViewColumnCellInfo, 1);
1097 cell_info->cell = cell;
1098 cell_info->expand = expand ? TRUE : FALSE;
1099 cell_info->pack = GTK_PACK_START;
1100 cell_info->has_focus = 0;
1101 cell_info->attributes = NULL;
1103 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1107 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1108 GtkCellRenderer *cell,
1111 GtkTreeViewColumnCellInfo *cell_info;
1113 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1114 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1115 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1117 g_object_ref (G_OBJECT (cell));
1118 gtk_object_sink (GTK_OBJECT (cell));
1120 cell_info = g_new (GtkTreeViewColumnCellInfo, 1);
1121 cell_info->cell = cell;
1122 cell_info->expand = expand ? TRUE : FALSE;
1123 cell_info->pack = GTK_PACK_END;
1124 cell_info->has_focus = 0;
1125 cell_info->attributes = NULL;
1127 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1132 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1135 g_return_if_fail (tree_column != NULL);
1137 for (list = tree_column->cell_list; list; list = list->next)
1139 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1141 g_object_unref (G_OBJECT (info->cell));
1142 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
1146 g_list_free (tree_column->cell_list);
1147 tree_column->cell_list = NULL;
1151 gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column)
1153 GList *retval = NULL, *list;
1155 g_return_val_if_fail (tree_column != NULL, NULL);
1157 for (list = tree_column->cell_list; list; list = list->next)
1159 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1161 retval = g_list_append (retval, info->cell);
1168 * gtk_tree_view_column_add_attribute:
1169 * @tree_column: A #GtkTreeViewColumn.
1170 * @cell_renderer: the #GtkCellRenderer to set attributes on
1171 * @attribute: An attribute on the renderer
1172 * @column: The column position on the model to get the attribute from.
1174 * Adds an attribute mapping to the list in @tree_column. The @column is the
1175 * column of the model to get a value from, and the @attribute is the
1176 * parameter on @cell_renderer to be set from the value. So for example
1177 * if column 2 of the model contains strings, you could have the
1178 * "text" attribute of a #GtkCellRendererText get its values from
1182 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1183 GtkCellRenderer *cell_renderer,
1184 const gchar *attribute,
1187 GtkTreeViewColumnCellInfo *info;
1189 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1190 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1191 g_return_if_fail (info != NULL);
1193 info->attributes = g_slist_prepend (info->attributes, GINT_TO_POINTER (column));
1194 info->attributes = g_slist_prepend (info->attributes, g_strdup (attribute));
1196 if (tree_column->tree_view)
1197 gtk_tree_view_column_cell_set_dirty (tree_column);
1202 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1203 GtkCellRenderer *cell_renderer,
1209 attribute = va_arg (args, gchar *);
1211 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1213 while (attribute != NULL)
1215 column = va_arg (args, gint);
1216 gtk_tree_view_column_add_attribute (tree_column, cell_renderer, attribute, column);
1217 attribute = va_arg (args, gchar *);
1222 * gtk_tree_view_column_set_attributes:
1223 * @tree_column: A #GtkTreeViewColumn.
1224 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1225 * @Varargs: A NULL terminated listing of attributes.
1227 * Sets the attributes in the list as the attributes of @tree_column.
1228 * The attributes should be in attribute/column order, as in
1229 * @gtk_tree_view_column_add_attribute. All existing attributes
1230 * are removed, and replaced with the new attributes.
1233 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1234 GtkCellRenderer *cell_renderer,
1239 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1240 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1241 g_return_if_fail (gtk_tree_view_column_get_cell_info (tree_column, cell_renderer));
1243 va_start (args, cell_renderer);
1244 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1250 * gtk_tree_view_column_set_cell_data_func:
1251 * @tree_column: A #GtkTreeViewColumn
1252 * @cell_renderer: A #GtkCellRenderer
1253 * @func: The #GtkTreeViewColumnFunc to use.
1254 * @func_data: The user data for @func.
1255 * @destroy: The destroy notification for @func_data
1257 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1258 * function is used instead of the standard attributes mapping for
1259 * setting the column value, and should set the value of @tree_column's
1260 * cell renderer as appropriate. @func may be NULL to remove an
1264 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1265 GtkCellRenderer *cell_renderer,
1266 GtkTreeCellDataFunc func,
1268 GtkDestroyNotify destroy)
1270 GtkTreeViewColumnCellInfo *info;
1272 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1273 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1274 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1276 g_return_if_fail (info != NULL);
1278 if (func == info->func &&
1279 func_data == info->func_data &&
1280 destroy == info->destroy)
1283 if (info->func_data && info->destroy)
1284 (info->destroy) (info->func_data);
1287 info->func_data = func_data;
1288 info->destroy = destroy;
1290 if (tree_column->tree_view)
1291 gtk_tree_view_column_cell_set_dirty (tree_column);
1296 * gtk_tree_view_column_clear_attributes:
1297 * @tree_column: a #GtkTreeViewColumn
1298 *@cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1300 * Clears all existing attributes previously set with
1301 * gtk_tree_view_column_set_attributes().
1304 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1305 GtkCellRenderer *cell_renderer)
1307 GtkTreeViewColumnCellInfo *info;
1310 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1311 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1312 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1314 list = info->attributes;
1316 while (list && list->next)
1318 g_free (list->data);
1319 list = list->next->next;
1321 g_slist_free (info->attributes);
1322 info->attributes = NULL;
1324 if (tree_column->tree_view)
1325 gtk_tree_view_column_cell_set_dirty (tree_column);
1330 * gtk_tree_view_column_set_spacing:
1331 * @tree_column: A #GtkTreeViewColumn.
1332 * @spacing: distance between cell renderers in pixels.
1334 * Sets the spacing field of @tree_column, which is the number of pixels to
1335 * place between cell renderers packed into it.
1338 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1341 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1342 g_return_if_fail (spacing >= 0);
1344 if (tree_column->spacing == spacing)
1347 tree_column->spacing = spacing;
1348 if (tree_column->tree_view)
1349 gtk_tree_view_column_cell_set_dirty (tree_column);
1353 * gtk_tree_view_column_get_spacing:
1354 * @tree_column: A #GtkTreeViewColumn.
1356 * Returns the spacing of @tree_column.
1359 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1361 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1363 return tree_column->spacing;
1366 /* Options for manipulating the columns */
1369 * gtk_tree_view_column_set_visible:
1370 * @tree_column: A #GtkTreeViewColumn.
1371 * @visible: TRUE if the @tree_column is visible.
1373 * Sets the visibility of @tree_column.
1376 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1379 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1381 visible = !! visible;
1383 if (tree_column->visible == visible)
1386 tree_column->visible = visible;
1388 gtk_tree_view_column_update_button (tree_column);
1389 g_object_notify (G_OBJECT (tree_column), "visible");
1393 * gtk_tree_view_column_get_visible:
1394 * @tree_column: A #GtkTreeViewColumn.
1396 * Returns TRUE if @tree_column is visible.
1398 * Return value: whether the column is visible or not. If it is visible, then
1399 * the tree will show the column.
1402 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1404 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1406 return tree_column->visible;
1410 * gtk_tree_view_column_set_sizing:
1411 * @tree_column: A #GtkTreeViewColumn.
1412 * @type: The #GtkTreeViewColumnSizing.
1414 * Sets the growth behavior of @tree_column to @type.
1417 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1418 GtkTreeViewColumnSizing type)
1420 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1422 if (type == tree_column->column_type)
1425 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1426 tree_column->requested_width != -1)
1428 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1430 tree_column->column_type = type;
1432 gtk_tree_view_column_update_button (tree_column);
1434 if (type != GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1435 g_object_notify (G_OBJECT (tree_column), "sizing");
1439 * gtk_tree_view_column_get_sizing:
1440 * @tree_column: A #GtkTreeViewColumn.
1442 * Returns the current type of @tree_column.
1444 * Return value: The type of @tree_column.
1446 GtkTreeViewColumnSizing
1447 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1449 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1451 return tree_column->column_type;
1455 * gtk_tree_view_column_get_width:
1456 * @tree_column: A #GtkTreeViewColumn.
1458 * Returns the current size of the @tree_column in pixels.
1460 * Return value: The current width of the @tree_column.
1463 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1465 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1467 return tree_column->width;
1471 * gtk_tree_view_column_set_fixed_width:
1472 * @tree_column: A #GtkTreeViewColumn.
1473 * @fixed_width: The size to set the @tree_column to. Must be greater than 0.
1475 * Sets the size of the column in pixels. This is meaningful only if the sizing
1476 * type is #GTK_TREE_VIEW_COLUMN_FIXED. In this case, the value is discarded
1477 * as the size of the column is based on the calculated width of the column. The
1478 * width is clamped to the min/max width for the column.
1481 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
1484 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1485 g_return_if_fail (fixed_width > 0);
1487 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1490 tree_column->fixed_width = fixed_width;
1491 tree_column->requested_width = fixed_width;
1492 _gtk_tree_view_column_set_width (tree_column, fixed_width);
1496 * gtk_tree_view_column_get_fixed_width:
1497 * @tree_column: a #GtkTreeViewColumn
1499 * Gets the fixed width of the column. This value is only meaning may not be the
1500 * actual width of the column on the screen, just what is requested.
1502 * Return value: the fixed width of the column
1505 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
1507 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1509 return tree_column->fixed_width;
1513 * gtk_tree_view_column_set_min_width:
1514 * @tree_column: A #GtkTreeViewColumn.
1515 * @min_width: The minimum width of the column in pixels, or -1.
1517 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1518 * minimum width is unset.
1521 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1524 gint real_min_width;
1526 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1527 g_return_if_fail (min_width >= -1);
1529 if (min_width == tree_column->min_width)
1532 if (tree_column->tree_view == NULL)
1534 tree_column->min_width = min_width;
1538 real_min_width = (tree_column->min_width == -1) ?
1539 tree_column->button->requisition.width : tree_column->min_width;
1541 /* We want to queue a resize if the either the old min_size or the
1542 * new min_size determined the size of the column */
1543 if (GTK_WIDGET_REALIZED (tree_column->tree_view))
1545 if ((tree_column->min_width > tree_column->width) ||
1546 (tree_column->min_width == -1 &&
1547 tree_column->button->requisition.width > tree_column->width) ||
1548 (min_width > tree_column->width) ||
1550 tree_column->button->requisition.width > tree_column->width))
1551 gtk_widget_queue_resize (tree_column->tree_view);
1554 if (tree_column->max_width != -1 && tree_column->max_width < real_min_width)
1555 tree_column->max_width = real_min_width;
1557 tree_column->min_width = min_width;
1559 g_object_notify (G_OBJECT (tree_column), "min_width");
1563 * gtk_tree_view_column_get_min_width:
1564 * @tree_column: A #GtkTreeViewColumn.
1566 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1569 * Return value: The minimum width of the @tree_column.
1572 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1574 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1576 return tree_column->min_width;
1580 * gtk_tree_view_column_set_max_width:
1581 * @tree_column: A #GtkTreeViewColumn.
1582 * @max_width: The maximum width of the column in pixels, or -1.
1584 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1585 * maximum width is unset. Note, the column can actually be wider than max
1586 * width if it's the last column in a view. In this case, the column expands to
1590 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1593 gint real_max_width;
1595 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1596 g_return_if_fail (max_width >= -1);
1598 if (max_width == tree_column->max_width)
1601 if (tree_column->tree_view == NULL)
1603 tree_column->max_width = max_width;
1607 real_max_width = tree_column->max_width == -1 ?
1608 tree_column->button->requisition.width : tree_column->max_width;
1610 if (tree_column->tree_view &&
1611 GTK_WIDGET_REALIZED (tree_column->tree_view) &&
1612 ((tree_column->max_width < tree_column->width) ||
1613 (max_width != -1 && max_width < tree_column->width)))
1614 gtk_widget_queue_resize (tree_column->tree_view);
1616 tree_column->max_width = max_width;
1618 if (real_max_width > max_width)
1619 tree_column->max_width = max_width;
1621 g_object_notify (G_OBJECT (tree_column), "max_width");
1625 * gtk_tree_view_column_get_max_width:
1626 * @tree_column: A #GtkTreeViewColumn.
1628 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1631 * Return value: The maximum width of the @tree_column.
1634 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1636 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1638 return tree_column->max_width;
1642 * gtk_tree_view_column_clicked:
1643 * @tree_column: a #GtkTreeViewColumn
1645 * Emits the "clicked" signal on the column. This function will only work if
1646 * the user could have conceivably clicked on the button.
1649 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1651 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1653 if (tree_column->visible &&
1654 tree_column->button &&
1655 tree_column->clickable)
1656 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1660 * gtk_tree_view_column_set_title:
1661 * @tree_column: A #GtkTreeViewColumn.
1662 * @title: The title of the @tree_column.
1664 * Sets the title of the @tree_column. If a custom widget has been set, then
1665 * this value is ignored.
1668 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
1671 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1673 g_free (tree_column->title);
1675 tree_column->title = g_strdup (title);
1677 tree_column->title = NULL;
1679 gtk_tree_view_column_update_button (tree_column);
1680 g_object_notify (G_OBJECT (tree_column), "title");
1684 * gtk_tree_view_column_get_title:
1685 * @tree_column: A #GtkTreeViewColumn.
1687 * Returns the title of the widget. This value should not be modified.
1689 * Return value: the title of the column.
1691 G_CONST_RETURN gchar *
1692 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
1694 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1696 return tree_column->title;
1700 * gtk_tree_view_column_set_clickable:
1701 * @tree_column: A #GtkTreeViewColumn.
1702 * @clickable: TRUE if the header is active.
1704 * Sets the header to be active if @active is TRUE. When the header is active,
1705 * then it can take keyboard focus, and can be clicked.
1708 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
1711 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1713 if (tree_column->clickable == (clickable?TRUE:FALSE))
1716 tree_column->clickable = (clickable?TRUE:FALSE);
1717 gtk_tree_view_column_update_button (tree_column);
1718 g_object_notify (G_OBJECT (tree_column), "clickable");
1722 * gtk_tree_view_column_get_clickable:
1723 * @tree_column: a #GtkTreeViewColumn
1725 * Returns %TRUE if the user can click on the header for the column.
1727 * Return value: whether the user can click the column header
1730 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
1732 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1734 return tree_column->clickable;
1738 * gtk_tree_view_column_set_widget:
1739 * @tree_column: A #GtkTreeViewColumn.
1740 * @widget: A child #GtkWidget, or NULL.
1742 * Sets the widget in the header to be @widget. If widget is NULL, then the
1743 * header button is set with a #GtkLabel set to the title of @tree_column.
1746 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
1749 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1750 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1754 gtk_object_ref (GTK_OBJECT (widget));
1755 gtk_object_sink (GTK_OBJECT (widget));
1758 if (tree_column->child)
1759 gtk_object_unref (GTK_OBJECT (tree_column->child));
1761 tree_column->child = widget;
1762 gtk_tree_view_column_update_button (tree_column);
1763 g_object_notify (G_OBJECT (tree_column), "widget");
1767 * gtk_tree_view_column_get_widget:
1768 * @tree_column: A #GtkTreeViewColumn.
1770 * Returns the #GtkWidget in the button in the column header. If a custom
1771 * widget has not been set, then this will be a #GtkAlignment with a #GtkLabel
1774 * Return value: The #GtkWidget in the column header.
1777 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
1779 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1781 return tree_column->child;
1785 * gtk_tree_view_column_set_alignment:
1786 * @tree_column: A #GtkTreeViewColumn.
1787 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
1789 * Sets the alignment of the title or custom widget inside the column header.
1790 * The alignment determines its location inside the button -- 0.0 for left, 0.5
1791 * for center, 1.0 for right.
1794 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
1797 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1799 xalign = CLAMP (xalign, 0.0, 1.0);
1801 if (tree_column->xalign == xalign)
1804 tree_column->xalign = xalign;
1805 gtk_tree_view_column_update_button (tree_column);
1806 g_object_notify (G_OBJECT (tree_column), "alignment");
1810 * gtk_tree_view_column_get_alignment:
1811 * @tree_column: A #GtkTreeViewColumn.
1813 * Returns the current x alignment of @tree_column. This value can range
1814 * between 0.0 and 1.0.
1816 * Return value: The current alignent of @tree_column.
1819 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
1821 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
1823 return tree_column->xalign;
1827 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
1828 gboolean reorderable)
1830 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1833 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
1835 if (tree_column->reorderable == (reorderable?TRUE:FALSE))
1838 tree_column->reorderable = (reorderable?TRUE:FALSE);
1839 gtk_tree_view_column_update_button (tree_column);
1840 g_object_notify (G_OBJECT (tree_column), "reorderable");
1844 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
1846 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1848 return tree_column->reorderable;
1853 * gtk_tree_view_column_set_sort_column_id:
1854 * @tree_column: a #GtkTreeViewColumn
1855 * @sort_column_id: The sort_column_id of the model to sort on.
1857 * Sets the logical sort_column_id that this column sorts on when this column is
1858 * selected for sorting. Doing so makes the column header clickable.
1861 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
1862 gint sort_column_id)
1864 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1865 g_return_if_fail (sort_column_id >= 0);
1867 if (tree_column->sort_column_id == sort_column_id)
1870 tree_column->sort_column_id = sort_column_id;
1872 /* Handle unsetting the id */
1873 if (sort_column_id == -1)
1875 if (tree_column->sort_clicked_signal)
1877 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_clicked_signal);
1878 tree_column->sort_clicked_signal = 0;
1881 if (tree_column->sort_column_changed_signal)
1883 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
1884 tree_column->sort_column_changed_signal = 0;
1887 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
1888 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1892 gtk_tree_view_column_set_clickable (tree_column, TRUE);
1894 if (! tree_column->sort_clicked_signal)
1895 tree_column->sort_clicked_signal = g_signal_connect (G_OBJECT (tree_column),
1897 G_CALLBACK (gtk_tree_view_column_sort),
1900 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
1904 * gtk_tree_view_column_get_sort_column_id:
1905 * @tree_column: a #GtkTreeViewColumn
1907 * Gets the logical sort_column_id that the model sorts on when this
1908 * coumn is selected for sorting. See gtk_tree_view_column_set_sort_column_id().
1910 * Return value: the current sort_column_id for this column, or -1 if
1911 * this column can't be used for sorting.
1914 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
1916 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1918 return tree_column->sort_column_id;
1922 * gtk_tree_view_column_set_sort_indicator:
1923 * @tree_column: a #GtkTreeViewColumn
1924 * @setting: %TRUE to display an indicator that the column is sorted
1926 * Call this function with a @setting of %TRUE to display an arrow in
1927 * the header button indicating the column is sorted. Call
1928 * gtk_tree_view_column_set_sort_order() to change the direction of
1933 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
1936 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1938 setting = setting != FALSE;
1940 if (setting == tree_column->show_sort_indicator)
1943 tree_column->show_sort_indicator = setting;
1944 gtk_tree_view_column_update_button (tree_column);
1945 g_object_notify (G_OBJECT (tree_column), "sort_indicator");
1949 * gtk_tree_view_column_get_sort_indicator:
1950 * @tree_column: a #GtkTreeViewColumn
1952 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
1954 * Return value: whether the sort indicator arrow is displayed
1957 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
1959 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1961 return tree_column->show_sort_indicator;
1965 * gtk_tree_view_column_set_sort_order:
1966 * @tree_column: a #GtkTreeViewColumn
1967 * @order: sort order that the sort indicator should indicate
1969 * Changes the appearance of the sort indicator. (This <emphasis>does
1970 * not</emphasis> actually sort the model. Use
1971 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
1972 * support. This function is primarily for custom sorting behavior, and should
1973 * be used in conjunction with #gtk_tree_sortable_set_sort_column() to do
1974 * that. For custom models, the mechanism will vary. The sort indicator changes
1975 * direction to indicate normal sort or reverse sort. Note that you must have
1976 * the sort indicator enabled to see anything when calling this function; see
1977 * gtk_tree_view_column_set_sort_indicator().
1981 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
1984 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1986 if (order == tree_column->sort_order)
1989 tree_column->sort_order = order;
1990 gtk_tree_view_column_update_button (tree_column);
1991 g_object_notify (G_OBJECT (tree_column), "sort_order");
1995 * gtk_tree_view_column_get_sort_order:
1996 * @tree_column: a #GtkTreeViewColumn
1998 * Gets the value set by gtk_tree_view_column_set_sort_order().
2000 * Return value: the sort order the sort indicator is indicating
2003 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2005 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2007 return tree_column->sort_order;
2011 * gtk_tree_view_column_cell_set_cell_data:
2012 * @tree_column: A #GtkTreeViewColumn.
2013 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2014 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2015 * @is_expander: TRUE, if the row has children
2016 * @is_expanded: TRUE, if the row has visible children
2018 * Sets the cell renderer based on the @tree_model and @tree_node. That is, for
2019 * every attribute mapping in @tree_column, it will get a value from the set
2020 * column on the @tree_node, and use that value to set the attribute on the cell
2021 * renderer. This is used primarily by the GtkTreeView.
2024 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2025 GtkTreeModel *tree_model,
2027 gboolean is_expander,
2028 gboolean is_expanded)
2031 GValue value = { 0, };
2034 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2035 g_return_if_fail (tree_column->cell_list != NULL);
2037 if (tree_model == NULL)
2040 for (cell_list = tree_column->cell_list; cell_list; cell_list = cell_list->next)
2042 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) cell_list->data;
2043 GObject *cell = (GObject *) info->cell;
2045 list = info->attributes;
2047 g_object_freeze_notify (cell);
2048 g_object_set (cell, "is_expander", is_expander, "is_expanded", is_expanded, NULL);
2050 while (list && list->next)
2052 gtk_tree_model_get_value (tree_model, iter,
2053 GPOINTER_TO_INT (list->next->data),
2055 g_object_set_property (cell, (gchar *) list->data, &value);
2056 g_value_unset (&value);
2057 list = list->next->next;
2061 (* info->func) (tree_column, info->cell, tree_model, iter, info->func_data);
2062 g_object_thaw_notify (G_OBJECT (info->cell));
2068 * gtk_tree_view_column_cell_get_size:
2069 * @tree_column: A #GtkTreeViewColumn.
2070 * @cell_area: The area a the column will be allocated, or %NULL
2071 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
2072 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
2073 * @width: location to return width needed to render a cell, or %NULL
2074 * @height: location to return height needed to render a cell, or %NULL
2076 * Obtains the width and height needed to render the column. This is used
2077 * primarily by the GtkTreeView.
2080 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2081 GdkRectangle *cell_area,
2088 gboolean first_cell = TRUE;
2090 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2097 for (list = tree_column->cell_list; list; list = list->next)
2099 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2101 gint new_height = 0;
2103 g_object_get (info->cell, "visible", &visible, NULL);
2105 if (visible == FALSE)
2108 if (first_cell == FALSE && *width)
2109 *width += tree_column->spacing;
2111 gtk_cell_renderer_get_size (info->cell,
2112 tree_column->tree_view,
2120 * height = MAX (*height, new_height);
2121 info->requested_width = MAX (info->requested_width, new_width);
2123 * width += info->requested_width;
2128 /* both rendering and rendering focus are somewhat complicated, and a bit of
2129 * code. Rather than duplicate them, we put them together to keep the code in
2133 gtk_tree_view_column_cell_render_or_focus (GtkTreeViewColumn *tree_column,
2135 GdkRectangle *background_area,
2136 GdkRectangle *cell_area,
2137 GdkRectangle *expose_area,
2140 GdkRectangle *focus_rectangle)
2143 GdkRectangle real_cell_area;
2144 gint expand_cell_count = 0;
2145 gint full_requested_width = 0;
2147 gint min_x, min_y, max_x, max_y;
2154 real_cell_area = *cell_area;
2156 /* Find out how my extra space we have to allocate */
2157 for (list = tree_column->cell_list; list; list = list->next)
2159 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2162 g_object_get (info->cell, "visible", &visible, NULL);
2163 if (visible == FALSE)
2166 if (info->expand == TRUE)
2167 expand_cell_count ++;
2168 full_requested_width += info->requested_width;
2171 extra_space = cell_area->width - full_requested_width;
2172 if (extra_space < 0)
2175 for (list = tree_column->cell_list; list; list = list->next)
2177 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2180 if (info->pack == GTK_PACK_END)
2183 g_object_get (info->cell, "visible", &visible, NULL);
2184 if (visible == FALSE)
2187 real_cell_area.width = info->requested_width +
2188 (info->expand?extra_space:0);
2191 gtk_cell_renderer_render (info->cell,
2193 tree_column->tree_view,
2201 gint x_offset, y_offset, width, height;
2203 gtk_cell_renderer_get_size (info->cell,
2204 tree_column->tree_view,
2206 &x_offset, &y_offset,
2209 if (min_x > (real_cell_area.x + x_offset))
2210 min_x = real_cell_area.x + x_offset;
2211 if (max_x < real_cell_area.x + x_offset + width)
2212 max_x = real_cell_area.x + x_offset + width;
2213 if (min_y > (real_cell_area.y + y_offset))
2214 min_y = real_cell_area.y + y_offset;
2215 if (max_y < real_cell_area.y + y_offset + height)
2216 max_y = real_cell_area.y + y_offset + height;
2218 real_cell_area.x += (info->requested_width + tree_column->spacing);
2220 for (list = g_list_last (tree_column->cell_list); list; list = list->prev)
2222 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2225 if (info->pack == GTK_PACK_START)
2228 g_object_get (info->cell, "visible", &visible, NULL);
2229 if (visible == FALSE)
2232 real_cell_area.width = info->requested_width +
2233 (info->expand?extra_space:0);
2234 gtk_cell_renderer_render (info->cell,
2236 tree_column->tree_view,
2241 real_cell_area.x += (info->requested_width + tree_column->spacing);
2245 if (min_x >= max_x || min_y >= max_y)
2247 *focus_rectangle = *cell_area;
2248 focus_rectangle->x -= 1;
2249 focus_rectangle->y -= 1;
2250 focus_rectangle->width += 2;
2251 focus_rectangle->height += 2;
2255 focus_rectangle->x = min_x - 1;
2256 focus_rectangle->y = min_y - 1;
2257 focus_rectangle->width = (max_x - min_x) + 2;
2258 focus_rectangle->height = (max_y - min_y) + 2;
2264 * gtk_tree_view_column_cell_render:
2265 * @tree_column: A #GtkTreeViewColumn.
2266 * @window: a #GdkDrawable to draw to
2267 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2268 * @cell_area: area normally rendered by a cell renderer
2269 * @expose_area: area that actually needs updating
2270 * @flags: flags that affect rendering
2272 * Renders the cell contained by #tree_column. This is used primarily by the
2276 gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2278 GdkRectangle *background_area,
2279 GdkRectangle *cell_area,
2280 GdkRectangle *expose_area,
2283 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2284 g_return_if_fail (background_area != NULL);
2285 g_return_if_fail (cell_area != NULL);
2286 g_return_if_fail (expose_area != NULL);
2288 gtk_tree_view_column_cell_render_or_focus (tree_column,
2299 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2300 GtkCellEditable **editable_widget,
2303 GdkRectangle *background_area,
2304 GdkRectangle *cell_area,
2307 gboolean visible, mode;
2309 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2311 g_object_get (G_OBJECT (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell),
2312 "visible", &visible,
2315 if (visible && mode == GTK_CELL_RENDERER_MODE_ACTIVATABLE)
2317 if (gtk_cell_renderer_activate (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2319 tree_column->tree_view,
2326 else if (visible && mode == GTK_CELL_RENDERER_MODE_EDITABLE)
2328 *editable_widget = gtk_cell_renderer_start_editing (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2330 tree_column->tree_view,
2336 if (*editable_widget != NULL)
2338 g_return_val_if_fail (GTK_IS_CELL_EDITABLE (*editable_widget), FALSE);
2348 gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
2351 if (GTK_TREE_VIEW (tree_column->tree_view)->priv->focus_column == tree_column)
2357 gtk_tree_view_column_cell_draw_focus (GtkTreeViewColumn *tree_column,
2359 GdkRectangle *background_area,
2360 GdkRectangle *cell_area,
2361 GdkRectangle *expose_area,
2364 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2365 if (tree_column->editable_widget)
2367 /* This function is only called on the editable row when editing.
2370 gtk_paint_focus (tree_column->tree_view->style,
2373 tree_column->tree_view,
2377 cell_area->width + 2 - 1,
2378 cell_area->height + 2 - 1);
2383 GdkRectangle focus_rectangle;
2384 gtk_tree_view_column_cell_render_or_focus (tree_column,
2393 gtk_paint_focus (tree_column->tree_view->style,
2396 tree_column->tree_view,
2400 focus_rectangle.width - 1,
2401 focus_rectangle.height - 1);
2406 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2410 for (list = tree_column->cell_list; list; list = list->next)
2412 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2415 g_object_get (G_OBJECT (info->cell), "visible", &visible, NULL);
2425 gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column)
2429 for (list = tree_column->cell_list; list; list = list->next)
2431 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2433 info->requested_width = 0;
2435 tree_column->dirty = TRUE;
2437 if (tree_column->tree_view)
2438 gtk_widget_queue_resize (tree_column->tree_view);
2442 _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
2443 GtkCellEditable *cell_editable)
2445 g_return_if_fail (tree_column->editable_widget == NULL);
2447 tree_column->editable_widget = cell_editable;
2451 _gtk_tree_view_column_stop_editing (GtkTreeViewColumn *tree_column)
2453 g_return_if_fail (tree_column->editable_widget != NULL);
2455 tree_column->editable_widget = NULL;