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))
699 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
704 gtk_tree_view_column_cell_set_dirty (tree_column);
707 /* Button signal handlers
711 gtk_tree_view_column_button_event (GtkWidget *widget,
715 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
717 g_return_val_if_fail (event != NULL, FALSE);
719 if (event->type == GDK_BUTTON_PRESS &&
722 column->maybe_reordered = TRUE;
723 gdk_window_get_pointer (widget->window,
727 gtk_widget_grab_focus (widget);
730 if (event->type == GDK_BUTTON_RELEASE &&
731 column->maybe_reordered)
732 column->maybe_reordered = FALSE;
734 if (event->type == GDK_MOTION_NOTIFY &&
735 (column->maybe_reordered) &&
736 (gtk_drag_check_threshold (widget,
739 (gint) ((GdkEventMotion *)event)->x,
740 (gint) ((GdkEventMotion *)event)->y)))
742 column->maybe_reordered = FALSE;
743 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column);
746 if (column->clickable == FALSE)
750 case GDK_BUTTON_PRESS:
751 case GDK_2BUTTON_PRESS:
752 case GDK_3BUTTON_PRESS:
753 case GDK_MOTION_NOTIFY:
754 case GDK_BUTTON_RELEASE:
755 case GDK_ENTER_NOTIFY:
756 case GDK_LEAVE_NOTIFY:
766 gtk_tree_view_column_button_realize (GtkWidget *widget, gpointer data)
768 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | GDK_POINTER_MOTION_MASK);
772 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
774 g_signal_emit_by_name (G_OBJECT (data), "clicked");
778 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
779 GtkTreeViewColumn *column)
784 if (gtk_tree_sortable_get_sort_column_id (sortable,
788 if (sort_column_id == column->sort_column_id)
790 gtk_tree_view_column_set_sort_indicator (column, TRUE);
791 gtk_tree_view_column_set_sort_order (column, order);
795 gtk_tree_view_column_set_sort_indicator (column, FALSE);
800 gtk_tree_view_column_set_sort_indicator (column, FALSE);
805 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
810 gboolean has_sort_column;
811 gboolean has_default_sort_func;
813 g_return_if_fail (tree_column->tree_view != NULL);
816 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
819 has_default_sort_func =
820 gtk_tree_sortable_has_default_sort_func (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model));
822 if (has_sort_column &&
823 sort_column_id == tree_column->sort_column_id)
825 if (order == GTK_SORT_ASCENDING)
826 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
827 tree_column->sort_column_id,
828 GTK_SORT_DESCENDING);
829 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
830 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
831 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
834 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
835 tree_column->sort_column_id,
840 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
841 tree_column->sort_column_id,
848 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
852 if (tree_column->tree_view == NULL)
855 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
860 if (GTK_IS_TREE_SORTABLE (model) &&
861 tree_column->sort_column_id != -1)
863 gint real_sort_column_id;
864 GtkSortType real_order;
866 if (tree_column->sort_column_changed_signal == 0)
867 tree_column->sort_column_changed_signal =
868 g_signal_connect (G_OBJECT (model), "sort_column_changed",
869 GTK_SIGNAL_FUNC (gtk_tree_view_model_sort_column_changed),
872 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
873 &real_sort_column_id,
875 (real_sort_column_id == tree_column->sort_column_id))
877 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
878 gtk_tree_view_column_set_sort_order (tree_column, real_order);
886 /* Exported Private Functions.
887 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
891 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
893 GtkTreeView *tree_view;
895 guint attributes_mask;
897 tree_view = (GtkTreeView *)column->tree_view;
899 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
900 g_return_if_fail (GTK_WIDGET_REALIZED (tree_view));
901 g_return_if_fail (tree_view->priv->header_window != NULL);
902 g_return_if_fail (column->button != NULL);
904 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
907 gtk_widget_show (column->button);
909 attr.window_type = GDK_WINDOW_CHILD;
910 attr.wclass = GDK_INPUT_ONLY;
911 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
912 attr.colormap = gtk_widget_get_colormap (GTK_WIDGET (tree_view));
913 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view));
914 attr.event_mask = (GDK_BUTTON_PRESS_MASK |
915 GDK_BUTTON_RELEASE_MASK |
916 GDK_POINTER_MOTION_MASK |
917 GDK_POINTER_MOTION_HINT_MASK |
919 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
920 attr.cursor = gdk_cursor_new (GDK_SB_H_DOUBLE_ARROW);
921 tree_view->priv->cursor_drag = attr.cursor;
924 attr.width = TREE_VIEW_DRAG_WIDTH;
925 attr.height = tree_view->priv->header_height;
927 attr.x = (column->button->allocation.x + column->button->allocation.width) - 3;
929 column->window = gdk_window_new (tree_view->priv->header_window,
930 &attr, attributes_mask);
931 gdk_window_set_user_data (column->window, tree_view);
933 gtk_tree_view_column_update_button (column);
937 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
939 g_return_if_fail (column != NULL);
940 g_return_if_fail (column->window != NULL);
942 gdk_window_set_user_data (column->window, NULL);
943 gdk_window_destroy (column->window);
944 column->window = NULL;
948 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
949 GtkTreeView *tree_view)
951 g_assert (column->tree_view == NULL);
953 column->tree_view = GTK_WIDGET (tree_view);
954 gtk_tree_view_column_create_button (column);
956 column->property_changed_signal =
957 g_signal_connect_swapped (GTK_OBJECT (tree_view),
959 GTK_SIGNAL_FUNC (gtk_tree_view_column_setup_sort_column_id_callback),
962 gtk_tree_view_column_setup_sort_column_id_callback (column);
966 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
968 if (column->tree_view && column->button)
970 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
972 if (column->property_changed_signal)
974 g_signal_handler_disconnect (G_OBJECT (column->tree_view), column->property_changed_signal);
975 column->property_changed_signal = 0;
978 if (column->sort_column_changed_signal)
980 g_signal_handler_disconnect (G_OBJECT (gtk_tree_view_get_model (GTK_TREE_VIEW (column->tree_view))),
981 column->sort_column_changed_signal);
982 column->sort_column_changed_signal = 0;
985 column->tree_view = NULL;
986 column->button = NULL;
990 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
993 if (tree_column->min_width != -1 &&
994 width <= tree_column->min_width)
995 width = tree_column->min_width;
996 else if (tree_column->max_width != -1 &&
997 width > tree_column->max_width)
998 width = tree_column->max_width;
1000 if (tree_column->width == width)
1003 tree_column->width = width;
1005 g_object_notify (G_OBJECT (tree_column), "width");
1007 if (tree_column->tree_view != NULL)
1008 gtk_widget_queue_resize (tree_column->tree_view);
1012 /* Public Functions */
1016 * gtk_tree_view_column_new:
1018 * Creates a new #GtkTreeViewColumn.
1020 * Return value: A newly created #GtkTreeViewColumn.
1023 gtk_tree_view_column_new (void)
1025 GtkTreeViewColumn *tree_column;
1027 tree_column = GTK_TREE_VIEW_COLUMN (gtk_type_new (GTK_TYPE_TREE_VIEW_COLUMN));
1033 * gtk_tree_view_column_new_with_attributes:
1034 * @title: The title to set the header to.
1035 * @cell: The #GtkCellRenderer.
1036 * @Varargs: A NULL terminated list of attributes.
1038 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1039 * equivalent to calling @gtk_tree_view_column_set_title,
1040 * @gtk_tree_view_column_pack_start, and
1041 * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn.
1043 * Return value: A newly created #GtkTreeViewColumn.
1046 gtk_tree_view_column_new_with_attributes (const gchar *title,
1047 GtkCellRenderer *cell,
1050 GtkTreeViewColumn *retval;
1053 retval = gtk_tree_view_column_new ();
1055 gtk_tree_view_column_set_title (retval, title);
1056 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1058 va_start (args, cell);
1059 gtk_tree_view_column_set_attributesv (retval, cell, args);
1065 static GtkTreeViewColumnCellInfo *
1066 gtk_tree_view_column_get_cell_info (GtkTreeViewColumn *tree_column,
1067 GtkCellRenderer *cell_renderer)
1070 for (list = tree_column->cell_list; list; list = list->next)
1071 if (((GtkTreeViewColumnCellInfo *)list->data)->cell == cell_renderer)
1072 return (GtkTreeViewColumnCellInfo *) list->data;
1078 * gtk_tree_view_column_pack_start:
1079 * @tree_column: A #GtkTreeViewColumn.
1080 * @cell: The #GtkCellRenderer,
1081 * @expand: TRUE if @cell is to be given extra space allocated to box.
1085 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1086 GtkCellRenderer *cell,
1089 GtkTreeViewColumnCellInfo *cell_info;
1091 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1092 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1093 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1095 g_object_ref (G_OBJECT (cell));
1096 gtk_object_sink (GTK_OBJECT (cell));
1098 cell_info = g_new0 (GtkTreeViewColumnCellInfo, 1);
1099 cell_info->cell = cell;
1100 cell_info->expand = expand ? TRUE : FALSE;
1101 cell_info->pack = GTK_PACK_START;
1102 cell_info->has_focus = 0;
1103 cell_info->attributes = NULL;
1105 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1109 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1110 GtkCellRenderer *cell,
1113 GtkTreeViewColumnCellInfo *cell_info;
1115 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1116 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1117 g_return_if_fail (! gtk_tree_view_column_get_cell_info (tree_column, cell));
1119 g_object_ref (G_OBJECT (cell));
1120 gtk_object_sink (GTK_OBJECT (cell));
1122 cell_info = g_new (GtkTreeViewColumnCellInfo, 1);
1123 cell_info->cell = cell;
1124 cell_info->expand = expand ? TRUE : FALSE;
1125 cell_info->pack = GTK_PACK_END;
1126 cell_info->has_focus = 0;
1127 cell_info->attributes = NULL;
1129 tree_column->cell_list = g_list_append (tree_column->cell_list, cell_info);
1134 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1137 g_return_if_fail (tree_column != NULL);
1139 for (list = tree_column->cell_list; list; list = list->next)
1141 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1143 g_object_unref (G_OBJECT (info->cell));
1144 gtk_tree_view_column_clear_attributes (tree_column, info->cell);
1148 g_list_free (tree_column->cell_list);
1149 tree_column->cell_list = NULL;
1153 gtk_tree_view_column_get_cell_renderers (GtkTreeViewColumn *tree_column)
1155 GList *retval = NULL, *list;
1157 g_return_val_if_fail (tree_column != NULL, NULL);
1159 for (list = tree_column->cell_list; list; list = list->next)
1161 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *)list->data;
1163 retval = g_list_append (retval, info->cell);
1170 * gtk_tree_view_column_add_attribute:
1171 * @tree_column: A #GtkTreeViewColumn.
1172 * @cell_renderer: the #GtkCellRenderer to set attributes on
1173 * @attribute: An attribute on the renderer
1174 * @column: The column position on the model to get the attribute from.
1176 * Adds an attribute mapping to the list in @tree_column. The @column is the
1177 * column of the model to get a value from, and the @attribute is the
1178 * parameter on @cell_renderer to be set from the value. So for example
1179 * if column 2 of the model contains strings, you could have the
1180 * "text" attribute of a #GtkCellRendererText get its values from
1184 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1185 GtkCellRenderer *cell_renderer,
1186 const gchar *attribute,
1189 GtkTreeViewColumnCellInfo *info;
1191 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1192 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1193 g_return_if_fail (info != NULL);
1195 info->attributes = g_slist_prepend (info->attributes, GINT_TO_POINTER (column));
1196 info->attributes = g_slist_prepend (info->attributes, g_strdup (attribute));
1198 if (tree_column->tree_view)
1199 gtk_tree_view_column_cell_set_dirty (tree_column);
1204 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1205 GtkCellRenderer *cell_renderer,
1211 attribute = va_arg (args, gchar *);
1213 gtk_tree_view_column_clear_attributes (tree_column, cell_renderer);
1215 while (attribute != NULL)
1217 column = va_arg (args, gint);
1218 gtk_tree_view_column_add_attribute (tree_column, cell_renderer, attribute, column);
1219 attribute = va_arg (args, gchar *);
1224 * gtk_tree_view_column_set_attributes:
1225 * @tree_column: A #GtkTreeViewColumn.
1226 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1227 * @Varargs: A NULL terminated listing of attributes.
1229 * Sets the attributes in the list as the attributes of @tree_column.
1230 * The attributes should be in attribute/column order, as in
1231 * @gtk_tree_view_column_add_attribute. All existing attributes
1232 * are removed, and replaced with the new attributes.
1235 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1236 GtkCellRenderer *cell_renderer,
1241 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1242 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1243 g_return_if_fail (gtk_tree_view_column_get_cell_info (tree_column, cell_renderer));
1245 va_start (args, cell_renderer);
1246 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1252 * gtk_tree_view_column_set_cell_data_func:
1253 * @tree_column: A #GtkTreeViewColumn
1254 * @cell_renderer: A #GtkCellRenderer
1255 * @func: The #GtkTreeViewColumnFunc to use.
1256 * @func_data: The user data for @func.
1257 * @destroy: The destroy notification for @func_data
1259 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1260 * function is used instead of the standard attributes mapping for
1261 * setting the column value, and should set the value of @tree_column's
1262 * cell renderer as appropriate. @func may be NULL to remove an
1266 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1267 GtkCellRenderer *cell_renderer,
1268 GtkTreeCellDataFunc func,
1270 GtkDestroyNotify destroy)
1272 GtkTreeViewColumnCellInfo *info;
1274 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1275 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1276 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1278 g_return_if_fail (info != NULL);
1280 if (func == info->func &&
1281 func_data == info->func_data &&
1282 destroy == info->destroy)
1285 if (info->func_data && info->destroy)
1286 (info->destroy) (info->func_data);
1289 info->func_data = func_data;
1290 info->destroy = destroy;
1292 if (tree_column->tree_view)
1293 gtk_tree_view_column_cell_set_dirty (tree_column);
1298 * gtk_tree_view_column_clear_attributes:
1299 * @tree_column: a #GtkTreeViewColumn
1300 *@cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1302 * Clears all existing attributes previously set with
1303 * gtk_tree_view_column_set_attributes().
1306 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1307 GtkCellRenderer *cell_renderer)
1309 GtkTreeViewColumnCellInfo *info;
1312 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1313 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1314 info = gtk_tree_view_column_get_cell_info (tree_column, cell_renderer);
1316 list = info->attributes;
1318 while (list && list->next)
1320 g_free (list->data);
1321 list = list->next->next;
1323 g_slist_free (info->attributes);
1324 info->attributes = NULL;
1326 if (tree_column->tree_view)
1327 gtk_tree_view_column_cell_set_dirty (tree_column);
1332 * gtk_tree_view_column_set_spacing:
1333 * @tree_column: A #GtkTreeViewColumn.
1334 * @spacing: distance between cell renderers in pixels.
1336 * Sets the spacing field of @tree_column, which is the number of pixels to
1337 * place between cell renderers packed into it.
1340 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1343 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1344 g_return_if_fail (spacing >= 0);
1346 if (tree_column->spacing == spacing)
1349 tree_column->spacing = spacing;
1350 if (tree_column->tree_view)
1351 gtk_tree_view_column_cell_set_dirty (tree_column);
1355 * gtk_tree_view_column_get_spacing:
1356 * @tree_column: A #GtkTreeViewColumn.
1358 * Returns the spacing of @tree_column.
1361 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1363 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1365 return tree_column->spacing;
1368 /* Options for manipulating the columns */
1371 * gtk_tree_view_column_set_visible:
1372 * @tree_column: A #GtkTreeViewColumn.
1373 * @visible: TRUE if the @tree_column is visible.
1375 * Sets the visibility of @tree_column.
1378 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1381 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1383 visible = !! visible;
1385 if (tree_column->visible == visible)
1388 tree_column->visible = visible;
1390 gtk_tree_view_column_update_button (tree_column);
1391 g_object_notify (G_OBJECT (tree_column), "visible");
1395 * gtk_tree_view_column_get_visible:
1396 * @tree_column: A #GtkTreeViewColumn.
1398 * Returns TRUE if @tree_column is visible.
1400 * Return value: whether the column is visible or not. If it is visible, then
1401 * the tree will show the column.
1404 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1406 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1408 return tree_column->visible;
1412 * gtk_tree_view_column_set_sizing:
1413 * @tree_column: A #GtkTreeViewColumn.
1414 * @type: The #GtkTreeViewColumnSizing.
1416 * Sets the growth behavior of @tree_column to @type.
1419 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1420 GtkTreeViewColumnSizing type)
1422 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1424 if (type == tree_column->column_type)
1427 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1428 tree_column->requested_width != -1)
1430 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1432 tree_column->column_type = type;
1434 gtk_tree_view_column_update_button (tree_column);
1436 if (type != GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1437 g_object_notify (G_OBJECT (tree_column), "sizing");
1441 * gtk_tree_view_column_get_sizing:
1442 * @tree_column: A #GtkTreeViewColumn.
1444 * Returns the current type of @tree_column.
1446 * Return value: The type of @tree_column.
1448 GtkTreeViewColumnSizing
1449 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1451 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1453 return tree_column->column_type;
1457 * gtk_tree_view_column_get_width:
1458 * @tree_column: A #GtkTreeViewColumn.
1460 * Returns the current size of the @tree_column in pixels.
1462 * Return value: The current width of the @tree_column.
1465 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1467 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1469 return tree_column->width;
1473 * gtk_tree_view_column_set_fixed_width:
1474 * @tree_column: A #GtkTreeViewColumn.
1475 * @fixed_width: The size to set the @tree_column to. Must be greater than 0.
1477 * Sets the size of the column in pixels. This is meaningful only if the sizing
1478 * type is #GTK_TREE_VIEW_COLUMN_FIXED. In this case, the value is discarded
1479 * as the size of the column is based on the calculated width of the column. The
1480 * width is clamped to the min/max width for the column.
1483 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
1486 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1487 g_return_if_fail (fixed_width > 0);
1489 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1492 tree_column->fixed_width = fixed_width;
1493 tree_column->requested_width = fixed_width;
1494 _gtk_tree_view_column_set_width (tree_column, fixed_width);
1498 * gtk_tree_view_column_get_fixed_width:
1499 * @tree_column: a #GtkTreeViewColumn
1501 * Gets the fixed width of the column. This value is only meaning may not be the
1502 * actual width of the column on the screen, just what is requested.
1504 * Return value: the fixed width of the column
1507 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
1509 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1511 return tree_column->fixed_width;
1515 * gtk_tree_view_column_set_min_width:
1516 * @tree_column: A #GtkTreeViewColumn.
1517 * @min_width: The minimum width of the column in pixels, or -1.
1519 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1520 * minimum width is unset.
1523 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1526 gint real_min_width;
1528 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1529 g_return_if_fail (min_width >= -1);
1531 if (min_width == tree_column->min_width)
1534 if (tree_column->tree_view == NULL)
1536 tree_column->min_width = min_width;
1540 real_min_width = (tree_column->min_width == -1) ?
1541 tree_column->button->requisition.width : tree_column->min_width;
1543 /* We want to queue a resize if the either the old min_size or the
1544 * new min_size determined the size of the column */
1545 if (GTK_WIDGET_REALIZED (tree_column->tree_view))
1547 if ((tree_column->min_width > tree_column->width) ||
1548 (tree_column->min_width == -1 &&
1549 tree_column->button->requisition.width > tree_column->width) ||
1550 (min_width > tree_column->width) ||
1552 tree_column->button->requisition.width > tree_column->width))
1553 gtk_widget_queue_resize (tree_column->tree_view);
1556 if (tree_column->max_width != -1 && tree_column->max_width < real_min_width)
1557 tree_column->max_width = real_min_width;
1559 tree_column->min_width = min_width;
1561 g_object_notify (G_OBJECT (tree_column), "min_width");
1565 * gtk_tree_view_column_get_min_width:
1566 * @tree_column: A #GtkTreeViewColumn.
1568 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1571 * Return value: The minimum width of the @tree_column.
1574 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1576 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1578 return tree_column->min_width;
1582 * gtk_tree_view_column_set_max_width:
1583 * @tree_column: A #GtkTreeViewColumn.
1584 * @max_width: The maximum width of the column in pixels, or -1.
1586 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1587 * maximum width is unset. Note, the column can actually be wider than max
1588 * width if it's the last column in a view. In this case, the column expands to
1592 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1595 gint real_max_width;
1597 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1598 g_return_if_fail (max_width >= -1);
1600 if (max_width == tree_column->max_width)
1603 if (tree_column->tree_view == NULL)
1605 tree_column->max_width = max_width;
1609 real_max_width = tree_column->max_width == -1 ?
1610 tree_column->button->requisition.width : tree_column->max_width;
1612 if (tree_column->tree_view &&
1613 GTK_WIDGET_REALIZED (tree_column->tree_view) &&
1614 ((tree_column->max_width < tree_column->width) ||
1615 (max_width != -1 && max_width < tree_column->width)))
1616 gtk_widget_queue_resize (tree_column->tree_view);
1618 tree_column->max_width = max_width;
1620 if (real_max_width > max_width)
1621 tree_column->max_width = max_width;
1623 g_object_notify (G_OBJECT (tree_column), "max_width");
1627 * gtk_tree_view_column_get_max_width:
1628 * @tree_column: A #GtkTreeViewColumn.
1630 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1633 * Return value: The maximum width of the @tree_column.
1636 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1638 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1640 return tree_column->max_width;
1644 * gtk_tree_view_column_clicked:
1645 * @tree_column: a #GtkTreeViewColumn
1647 * Emits the "clicked" signal on the column. This function will only work if
1648 * the user could have conceivably clicked on the button.
1651 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1653 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1655 if (tree_column->visible &&
1656 tree_column->button &&
1657 tree_column->clickable)
1658 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1662 * gtk_tree_view_column_set_title:
1663 * @tree_column: A #GtkTreeViewColumn.
1664 * @title: The title of the @tree_column.
1666 * Sets the title of the @tree_column. If a custom widget has been set, then
1667 * this value is ignored.
1670 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
1673 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1675 g_free (tree_column->title);
1677 tree_column->title = g_strdup (title);
1679 tree_column->title = NULL;
1681 gtk_tree_view_column_update_button (tree_column);
1682 g_object_notify (G_OBJECT (tree_column), "title");
1686 * gtk_tree_view_column_get_title:
1687 * @tree_column: A #GtkTreeViewColumn.
1689 * Returns the title of the widget. This value should not be modified.
1691 * Return value: the title of the column.
1693 G_CONST_RETURN gchar *
1694 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
1696 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1698 return tree_column->title;
1702 * gtk_tree_view_column_set_clickable:
1703 * @tree_column: A #GtkTreeViewColumn.
1704 * @clickable: TRUE if the header is active.
1706 * Sets the header to be active if @active is TRUE. When the header is active,
1707 * then it can take keyboard focus, and can be clicked.
1710 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
1713 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1715 if (tree_column->clickable == (clickable?TRUE:FALSE))
1718 tree_column->clickable = (clickable?TRUE:FALSE);
1719 gtk_tree_view_column_update_button (tree_column);
1720 g_object_notify (G_OBJECT (tree_column), "clickable");
1724 * gtk_tree_view_column_get_clickable:
1725 * @tree_column: a #GtkTreeViewColumn
1727 * Returns %TRUE if the user can click on the header for the column.
1729 * Return value: whether the user can click the column header
1732 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
1734 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1736 return tree_column->clickable;
1740 * gtk_tree_view_column_set_widget:
1741 * @tree_column: A #GtkTreeViewColumn.
1742 * @widget: A child #GtkWidget, or NULL.
1744 * Sets the widget in the header to be @widget. If widget is NULL, then the
1745 * header button is set with a #GtkLabel set to the title of @tree_column.
1748 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
1751 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1752 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1756 gtk_object_ref (GTK_OBJECT (widget));
1757 gtk_object_sink (GTK_OBJECT (widget));
1760 if (tree_column->child)
1761 gtk_object_unref (GTK_OBJECT (tree_column->child));
1763 tree_column->child = widget;
1764 gtk_tree_view_column_update_button (tree_column);
1765 g_object_notify (G_OBJECT (tree_column), "widget");
1769 * gtk_tree_view_column_get_widget:
1770 * @tree_column: A #GtkTreeViewColumn.
1772 * Returns the #GtkWidget in the button in the column header. If a custom
1773 * widget has not been set, then this will be a #GtkAlignment with a #GtkLabel
1776 * Return value: The #GtkWidget in the column header.
1779 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
1781 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1783 return tree_column->child;
1787 * gtk_tree_view_column_set_alignment:
1788 * @tree_column: A #GtkTreeViewColumn.
1789 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
1791 * Sets the alignment of the title or custom widget inside the column header.
1792 * The alignment determines its location inside the button -- 0.0 for left, 0.5
1793 * for center, 1.0 for right.
1796 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
1799 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1801 xalign = CLAMP (xalign, 0.0, 1.0);
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.
1973 * This <emphasis>does not</emphasis> actually sort the model. Use
1974 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
1975 * support. This function is primarily for custom sorting behavior, and should
1976 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
1977 * that. For custom models, the mechanism will vary.
1979 * The sort indicator changes direction to indicate normal sort or reverse sort.
1980 * Note that you must have the sort indicator enabled to see anything when
1981 * calling this function; see gtk_tree_view_column_set_sort_indicator().
1984 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
1987 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1989 if (order == tree_column->sort_order)
1992 tree_column->sort_order = order;
1993 gtk_tree_view_column_update_button (tree_column);
1994 g_object_notify (G_OBJECT (tree_column), "sort_order");
1998 * gtk_tree_view_column_get_sort_order:
1999 * @tree_column: a #GtkTreeViewColumn
2001 * Gets the value set by gtk_tree_view_column_set_sort_order().
2003 * Return value: the sort order the sort indicator is indicating
2006 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2008 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2010 return tree_column->sort_order;
2014 * gtk_tree_view_column_cell_set_cell_data:
2015 * @tree_column: A #GtkTreeViewColumn.
2016 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2017 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2018 * @is_expander: TRUE, if the row has children
2019 * @is_expanded: TRUE, if the row has visible children
2021 * Sets the cell renderer based on the @tree_model and @tree_node. That is, for
2022 * every attribute mapping in @tree_column, it will get a value from the set
2023 * column on the @tree_node, and use that value to set the attribute on the cell
2024 * renderer. This is used primarily by the GtkTreeView.
2027 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2028 GtkTreeModel *tree_model,
2030 gboolean is_expander,
2031 gboolean is_expanded)
2034 GValue value = { 0, };
2037 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2038 g_return_if_fail (tree_column->cell_list != NULL);
2040 if (tree_model == NULL)
2043 for (cell_list = tree_column->cell_list; cell_list; cell_list = cell_list->next)
2045 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) cell_list->data;
2046 GObject *cell = (GObject *) info->cell;
2048 list = info->attributes;
2050 g_object_freeze_notify (cell);
2051 g_object_set (cell, "is_expander", is_expander, "is_expanded", is_expanded, NULL);
2053 while (list && list->next)
2055 gtk_tree_model_get_value (tree_model, iter,
2056 GPOINTER_TO_INT (list->next->data),
2058 g_object_set_property (cell, (gchar *) list->data, &value);
2059 g_value_unset (&value);
2060 list = list->next->next;
2064 (* info->func) (tree_column, info->cell, tree_model, iter, info->func_data);
2065 g_object_thaw_notify (G_OBJECT (info->cell));
2071 * gtk_tree_view_column_cell_get_size:
2072 * @tree_column: A #GtkTreeViewColumn.
2073 * @cell_area: The area a the column will be allocated, or %NULL
2074 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
2075 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
2076 * @width: location to return width needed to render a cell, or %NULL
2077 * @height: location to return height needed to render a cell, or %NULL
2079 * Obtains the width and height needed to render the column. This is used
2080 * primarily by the GtkTreeView.
2083 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2084 GdkRectangle *cell_area,
2091 gboolean first_cell = TRUE;
2093 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2100 for (list = tree_column->cell_list; list; list = list->next)
2102 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2104 gint new_height = 0;
2106 g_object_get (info->cell, "visible", &visible, NULL);
2108 if (visible == FALSE)
2111 if (first_cell == FALSE && *width)
2112 *width += tree_column->spacing;
2114 gtk_cell_renderer_get_size (info->cell,
2115 tree_column->tree_view,
2123 * height = MAX (*height, new_height);
2124 info->requested_width = MAX (info->requested_width, new_width);
2126 * width += info->requested_width;
2131 /* both rendering and rendering focus are somewhat complicated, and a bit of
2132 * code. Rather than duplicate them, we put them together to keep the code in
2136 gtk_tree_view_column_cell_render_or_focus (GtkTreeViewColumn *tree_column,
2138 GdkRectangle *background_area,
2139 GdkRectangle *cell_area,
2140 GdkRectangle *expose_area,
2143 GdkRectangle *focus_rectangle)
2146 GdkRectangle real_cell_area;
2147 gint expand_cell_count = 0;
2148 gint full_requested_width = 0;
2150 gint min_x, min_y, max_x, max_y;
2157 real_cell_area = *cell_area;
2159 /* Find out how my extra space we have to allocate */
2160 for (list = tree_column->cell_list; list; list = list->next)
2162 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2165 g_object_get (info->cell, "visible", &visible, NULL);
2166 if (visible == FALSE)
2169 if (info->expand == TRUE)
2170 expand_cell_count ++;
2171 full_requested_width += info->requested_width;
2174 extra_space = cell_area->width - full_requested_width;
2175 if (extra_space < 0)
2178 for (list = tree_column->cell_list; list; list = list->next)
2180 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2183 if (info->pack == GTK_PACK_END)
2186 g_object_get (info->cell, "visible", &visible, NULL);
2187 if (visible == FALSE)
2190 real_cell_area.width = info->requested_width +
2191 (info->expand?extra_space:0);
2194 gtk_cell_renderer_render (info->cell,
2196 tree_column->tree_view,
2204 gint x_offset, y_offset, width, height;
2206 gtk_cell_renderer_get_size (info->cell,
2207 tree_column->tree_view,
2209 &x_offset, &y_offset,
2212 if (min_x > (real_cell_area.x + x_offset))
2213 min_x = real_cell_area.x + x_offset;
2214 if (max_x < real_cell_area.x + x_offset + width)
2215 max_x = real_cell_area.x + x_offset + width;
2216 if (min_y > (real_cell_area.y + y_offset))
2217 min_y = real_cell_area.y + y_offset;
2218 if (max_y < real_cell_area.y + y_offset + height)
2219 max_y = real_cell_area.y + y_offset + height;
2221 real_cell_area.x += (info->requested_width + tree_column->spacing);
2223 for (list = g_list_last (tree_column->cell_list); list; list = list->prev)
2225 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2228 if (info->pack == GTK_PACK_START)
2231 g_object_get (info->cell, "visible", &visible, NULL);
2232 if (visible == FALSE)
2235 real_cell_area.width = info->requested_width +
2236 (info->expand?extra_space:0);
2237 gtk_cell_renderer_render (info->cell,
2239 tree_column->tree_view,
2244 real_cell_area.x += (info->requested_width + tree_column->spacing);
2248 if (min_x >= max_x || min_y >= max_y)
2250 *focus_rectangle = *cell_area;
2251 focus_rectangle->x -= 1;
2252 focus_rectangle->y -= 1;
2253 focus_rectangle->width += 2;
2254 focus_rectangle->height += 2;
2258 focus_rectangle->x = min_x - 1;
2259 focus_rectangle->y = min_y - 1;
2260 focus_rectangle->width = (max_x - min_x) + 2;
2261 focus_rectangle->height = (max_y - min_y) + 2;
2267 * gtk_tree_view_column_cell_render:
2268 * @tree_column: A #GtkTreeViewColumn.
2269 * @window: a #GdkDrawable to draw to
2270 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2271 * @cell_area: area normally rendered by a cell renderer
2272 * @expose_area: area that actually needs updating
2273 * @flags: flags that affect rendering
2275 * Renders the cell contained by #tree_column. This is used primarily by the
2279 gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2281 GdkRectangle *background_area,
2282 GdkRectangle *cell_area,
2283 GdkRectangle *expose_area,
2286 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2287 g_return_if_fail (background_area != NULL);
2288 g_return_if_fail (cell_area != NULL);
2289 g_return_if_fail (expose_area != NULL);
2291 gtk_tree_view_column_cell_render_or_focus (tree_column,
2302 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2303 GtkCellEditable **editable_widget,
2306 GdkRectangle *background_area,
2307 GdkRectangle *cell_area,
2310 gboolean visible, mode;
2312 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2314 g_object_get (G_OBJECT (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell),
2315 "visible", &visible,
2318 if (visible && mode == GTK_CELL_RENDERER_MODE_ACTIVATABLE)
2320 if (gtk_cell_renderer_activate (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2322 tree_column->tree_view,
2329 else if (visible && mode == GTK_CELL_RENDERER_MODE_EDITABLE)
2331 *editable_widget = gtk_cell_renderer_start_editing (((GtkTreeViewColumnCellInfo *) tree_column->cell_list->data)->cell,
2333 tree_column->tree_view,
2339 if (*editable_widget != NULL)
2341 g_return_val_if_fail (GTK_IS_CELL_EDITABLE (*editable_widget), FALSE);
2351 gtk_tree_view_column_cell_focus (GtkTreeViewColumn *tree_column,
2354 if (GTK_TREE_VIEW (tree_column->tree_view)->priv->focus_column == tree_column)
2360 gtk_tree_view_column_cell_draw_focus (GtkTreeViewColumn *tree_column,
2362 GdkRectangle *background_area,
2363 GdkRectangle *cell_area,
2364 GdkRectangle *expose_area,
2367 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2368 if (tree_column->editable_widget)
2370 /* This function is only called on the editable row when editing.
2373 gtk_paint_focus (tree_column->tree_view->style,
2376 tree_column->tree_view,
2380 cell_area->width + 2 - 1,
2381 cell_area->height + 2 - 1);
2386 GdkRectangle focus_rectangle;
2387 gtk_tree_view_column_cell_render_or_focus (tree_column,
2396 gtk_paint_focus (tree_column->tree_view->style,
2399 tree_column->tree_view,
2403 focus_rectangle.width - 1,
2404 focus_rectangle.height - 1);
2409 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2413 for (list = tree_column->cell_list; list; list = list->next)
2415 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2418 g_object_get (G_OBJECT (info->cell), "visible", &visible, NULL);
2428 gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column)
2432 for (list = tree_column->cell_list; list; list = list->next)
2434 GtkTreeViewColumnCellInfo *info = (GtkTreeViewColumnCellInfo *) list->data;
2436 info->requested_width = 0;
2438 tree_column->dirty = TRUE;
2440 if (tree_column->tree_view)
2441 gtk_widget_queue_resize (tree_column->tree_view);
2445 _gtk_tree_view_column_start_editing (GtkTreeViewColumn *tree_column,
2446 GtkCellEditable *cell_editable)
2448 g_return_if_fail (tree_column->editable_widget == NULL);
2450 tree_column->editable_widget = cell_editable;
2454 _gtk_tree_view_column_stop_editing (GtkTreeViewColumn *tree_column)
2456 g_return_if_fail (tree_column->editable_widget != NULL);
2458 tree_column->editable_widget = NULL;