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"
59 static void gtk_tree_view_column_init (GtkTreeViewColumn *tree_column);
60 static void gtk_tree_view_column_class_init (GtkTreeViewColumnClass *klass);
63 static void gtk_tree_view_column_set_property (GObject *object,
67 static void gtk_tree_view_column_get_property (GObject *object,
71 static void gtk_tree_view_column_finalize (GObject *object);
73 /* Button handling code */
74 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
75 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
77 /* Button signal handlers */
78 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
81 static void gtk_tree_view_column_button_realize (GtkWidget *widget,
83 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
86 /* Property handlers */
87 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
88 GtkTreeViewColumn *tree_column);
90 /* Internal functions */
91 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
93 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
94 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
100 static GtkObjectClass *parent_class = NULL;
101 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
105 gtk_tree_view_column_get_type (void)
107 static GtkType tree_column_type = 0;
109 if (!tree_column_type)
111 static const GTypeInfo tree_column_info =
113 sizeof (GtkTreeViewColumnClass),
114 NULL, /* base_init */
115 NULL, /* base_finalize */
116 (GClassInitFunc) gtk_tree_view_column_class_init,
117 NULL, /* class_finalize */
118 NULL, /* class_data */
119 sizeof (GtkTreeViewColumn),
121 (GInstanceInitFunc) gtk_tree_view_column_init,
124 tree_column_type = g_type_register_static (GTK_TYPE_OBJECT, "GtkTreeViewColumn", &tree_column_info, 0);
127 return tree_column_type;
131 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
133 GObjectClass *object_class;
135 object_class = (GObjectClass*) class;
137 parent_class = g_type_class_peek_parent (class);
139 class->clicked = NULL;
141 object_class->finalize = gtk_tree_view_column_finalize;
142 object_class->set_property = gtk_tree_view_column_set_property;
143 object_class->get_property = gtk_tree_view_column_get_property;
145 tree_column_signals[CLICKED] =
146 g_signal_newc ("clicked",
147 GTK_CLASS_TYPE (object_class),
149 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
151 gtk_marshal_VOID__VOID,
154 g_object_class_install_property (object_class,
156 g_param_spec_object ("cell_renderer",
158 _("Cell renderer object to use for rendering the cell"),
159 GTK_TYPE_CELL_RENDERER,
160 G_PARAM_READABLE | G_PARAM_WRITABLE));
162 g_object_class_install_property (object_class,
164 g_param_spec_boolean ("visible",
166 _("Whether to display the colomn"),
168 G_PARAM_READABLE | G_PARAM_WRITABLE));
170 g_object_class_install_property (object_class,
172 g_param_spec_enum ("sizing",
174 _("Resize mode of the column"),
175 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
176 GTK_TREE_VIEW_COLUMN_AUTOSIZE,
177 G_PARAM_READABLE | G_PARAM_WRITABLE));
179 g_object_class_install_property (object_class,
181 g_param_spec_int ("width",
183 _("Current width of the column"),
187 G_PARAM_READABLE | G_PARAM_WRITABLE));
189 g_object_class_install_property (object_class,
191 g_param_spec_int ("min_width",
193 _("Minimum allowed width of the column"),
197 G_PARAM_READABLE | G_PARAM_WRITABLE));
199 g_object_class_install_property (object_class,
201 g_param_spec_int ("max_width",
203 _("Maximum allowed width of the column"),
207 G_PARAM_READABLE | G_PARAM_WRITABLE));
209 g_object_class_install_property (object_class,
211 g_param_spec_string ("title",
213 _("Title to appear in column header"),
215 G_PARAM_READABLE | G_PARAM_WRITABLE));
217 g_object_class_install_property (object_class,
219 g_param_spec_boolean ("clickable",
221 _("Whether the header can be clicked"),
223 G_PARAM_READABLE | G_PARAM_WRITABLE));
226 g_object_class_install_property (object_class,
228 g_param_spec_object ("widget",
230 _("Widget to put in column header button instead of column title"),
232 G_PARAM_READABLE | G_PARAM_WRITABLE));
234 g_object_class_install_property (object_class,
236 g_param_spec_float ("alignment",
238 _("X Alignment of the column header text or widget"),
242 G_PARAM_READABLE | G_PARAM_WRITABLE));
244 g_object_class_install_property (object_class,
246 g_param_spec_boolean ("reorderable",
248 _("Wether the column can be reordered around the headers"),
250 G_PARAM_READABLE | G_PARAM_WRITABLE));
252 g_object_class_install_property (object_class,
254 g_param_spec_boolean ("sort_indicator",
256 _("Whether to show a sort indicator"),
258 G_PARAM_READABLE | G_PARAM_WRITABLE));
260 g_object_class_install_property (object_class,
262 g_param_spec_enum ("sort_order",
264 _("Sort direction the sort indicator should indicate"),
265 GTK_TYPE_TREE_SORT_ORDER,
266 GTK_TREE_SORT_ASCENDING,
267 G_PARAM_READABLE | G_PARAM_WRITABLE));
272 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
274 /* FIXME remove on port to GtkObject */
275 gtk_object_ref (GTK_OBJECT (tree_column));
276 gtk_object_sink (GTK_OBJECT (tree_column));
278 tree_column->button = NULL;
279 tree_column->xalign = 0.0;
280 tree_column->width = 1;
281 tree_column->requested_width = -1;
282 tree_column->min_width = -1;
283 tree_column->max_width = -1;
284 tree_column->cell = NULL;
285 tree_column->attributes = NULL;
286 tree_column->column_type = GTK_TREE_VIEW_COLUMN_AUTOSIZE;
287 tree_column->visible = TRUE;
288 tree_column->clickable = FALSE;
289 tree_column->dirty = TRUE;
290 tree_column->sort_order = GTK_TREE_SORT_ASCENDING;
291 tree_column->show_sort_indicator = FALSE;
292 tree_column->property_changed_signal = 0;
293 tree_column->sort_clicked_signal = 0;
294 tree_column->sort_column_changed_signal = 0;
295 tree_column->sort_column_id = -1;
296 tree_column->reorderable = FALSE;
297 tree_column->maybe_reordered = FALSE;
301 gtk_tree_view_column_finalize (GObject *object)
303 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
305 if (tree_column->func_data && tree_column->destroy)
306 (tree_column->destroy) (tree_column->func_data);
308 g_slist_free (tree_column->attributes);
309 g_free (tree_column->title);
313 gtk_tree_view_column_set_property (GObject *object,
318 GtkTreeViewColumn *tree_column;
320 tree_column = GTK_TREE_VIEW_COLUMN (object);
324 case PROP_CELL_RENDERER:
325 gtk_tree_view_column_set_cell_renderer (tree_column,
327 g_value_get_object (value));
331 gtk_tree_view_column_set_visible (tree_column,
332 g_value_get_boolean (value));
336 gtk_tree_view_column_set_sizing (tree_column,
337 g_value_get_enum (value));
341 gtk_tree_view_column_set_width (tree_column,
342 g_value_get_int (value));
346 gtk_tree_view_column_set_min_width (tree_column,
347 g_value_get_int (value));
351 gtk_tree_view_column_set_max_width (tree_column,
352 g_value_get_int (value));
356 gtk_tree_view_column_set_title (tree_column,
357 g_value_get_string (value));
361 gtk_tree_view_column_set_clickable (tree_column,
362 g_value_get_boolean (value));
366 gtk_tree_view_column_set_widget (tree_column,
367 (GtkWidget*) g_value_get_object (value));
371 gtk_tree_view_column_set_alignment (tree_column,
372 g_value_get_float (value));
375 case PROP_REORDERABLE:
376 gtk_tree_view_column_set_reorderable (tree_column,
377 g_value_get_boolean (value));
380 case PROP_SORT_INDICATOR:
381 gtk_tree_view_column_set_sort_indicator (tree_column,
382 g_value_get_boolean (value));
385 case PROP_SORT_ORDER:
386 gtk_tree_view_column_set_sort_order (tree_column,
387 g_value_get_enum (value));
391 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
397 gtk_tree_view_column_get_property (GObject *object,
402 GtkTreeViewColumn *tree_column;
404 tree_column = GTK_TREE_VIEW_COLUMN (object);
408 case PROP_CELL_RENDERER:
409 g_value_set_object (value,
410 (GObject*) gtk_tree_view_column_get_cell_renderer (tree_column));
414 g_value_set_boolean (value,
415 gtk_tree_view_column_get_visible (tree_column));
419 g_value_set_enum (value,
420 gtk_tree_view_column_get_sizing (tree_column));
424 g_value_set_int (value,
425 gtk_tree_view_column_get_width (tree_column));
429 g_value_set_int (value,
430 gtk_tree_view_column_get_min_width (tree_column));
434 g_value_set_int (value,
435 gtk_tree_view_column_get_max_width (tree_column));
439 g_value_set_string (value,
440 gtk_tree_view_column_get_title (tree_column));
444 g_value_set_boolean (value,
445 gtk_tree_view_column_get_clickable (tree_column));
449 g_value_set_object (value,
450 (GObject*) gtk_tree_view_column_get_widget (tree_column));
454 g_value_set_float (value,
455 gtk_tree_view_column_get_alignment (tree_column));
458 case PROP_REORDERABLE:
459 g_value_set_boolean (value,
460 gtk_tree_view_column_get_reorderable (tree_column));
463 case PROP_SORT_INDICATOR:
464 g_value_set_boolean (value,
465 gtk_tree_view_column_get_sort_indicator (tree_column));
468 case PROP_SORT_ORDER:
469 g_value_set_enum (value,
470 gtk_tree_view_column_get_sort_order (tree_column));
474 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
482 /* Button handling code
485 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
487 GtkTreeView *tree_view;
491 tree_view = (GtkTreeView *) tree_column->tree_view;
493 g_return_if_fail (tree_view != NULL);
494 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
495 g_return_if_fail (tree_column->button == NULL);
497 gtk_widget_push_composite_child ();
498 tree_column->button = gtk_button_new ();
499 gtk_widget_pop_composite_child ();
501 /* make sure we own a reference to it as well. */
502 gtk_widget_set_parent (tree_column->button, GTK_WIDGET (tree_view));
503 if (tree_view->priv->header_window)
504 gtk_widget_set_parent_window (tree_column->button, tree_view->priv->header_window);
506 gtk_signal_connect (GTK_OBJECT (tree_column->button), "realize",
507 (GtkSignalFunc) gtk_tree_view_column_button_realize,
510 gtk_signal_connect (GTK_OBJECT (tree_column->button), "event",
511 (GtkSignalFunc) gtk_tree_view_column_button_event,
512 (gpointer) tree_column);
514 gtk_signal_connect (GTK_OBJECT (tree_column->button), "clicked",
515 (GtkSignalFunc) gtk_tree_view_column_button_clicked,
516 (gpointer) tree_column);
518 tree_column->alignment = gtk_alignment_new (tree_column->xalign, 0.5, 0.0, 0.0);
520 hbox = gtk_hbox_new (FALSE, 2);
521 tree_column->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
523 if (tree_column->child)
524 child = tree_column->child;
527 child = gtk_label_new (tree_column->title);
528 gtk_widget_show (child);
531 if (tree_column->xalign <= 0.5)
532 gtk_box_pack_end (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
534 gtk_box_pack_start (GTK_BOX (hbox), tree_column->arrow, FALSE, FALSE, 0);
536 gtk_box_pack_start (GTK_BOX (hbox), tree_column->alignment, TRUE, TRUE, 0);
538 gtk_container_add (GTK_CONTAINER (tree_column->alignment), child);
539 gtk_container_add (GTK_CONTAINER (tree_column->button), hbox);
541 gtk_widget_show (hbox);
542 gtk_widget_show (tree_column->alignment);
543 gtk_tree_view_column_update_button (tree_column);
547 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
550 GtkWidget *alignment;
552 GtkWidget *current_child;
554 /* Create a button if necessary */
555 if (tree_column->visible &&
556 tree_column->button == NULL &&
557 tree_column->tree_view &&
558 GTK_WIDGET_REALIZED (tree_column->tree_view))
559 gtk_tree_view_column_create_button (tree_column);
561 if (! tree_column->button)
564 hbox = GTK_BIN (tree_column->button)->child;
565 alignment = tree_column->alignment;
566 arrow = tree_column->arrow;
567 current_child = GTK_BIN (alignment)->child;
569 /* Set up the actual button */
570 gtk_alignment_set (GTK_ALIGNMENT (alignment), tree_column->xalign,
573 if (tree_column->child)
575 if (current_child != tree_column->child)
577 gtk_container_remove (GTK_CONTAINER (alignment),
579 gtk_container_add (GTK_CONTAINER (alignment),
585 if (current_child == NULL)
587 current_child = gtk_label_new (NULL);
588 gtk_widget_show (current_child);
589 gtk_container_add (GTK_CONTAINER (alignment),
593 g_return_if_fail (GTK_IS_LABEL (current_child));
595 if (tree_column->title)
596 gtk_label_set_text (GTK_LABEL (current_child),
599 gtk_label_set_text (GTK_LABEL (current_child),
603 switch (tree_column->sort_order)
605 case GTK_TREE_SORT_ASCENDING:
606 gtk_arrow_set (GTK_ARROW (arrow),
611 case GTK_TREE_SORT_DESCENDING:
612 gtk_arrow_set (GTK_ARROW (arrow),
618 g_warning (G_STRLOC": bad sort order");
622 /* Put arrow on the right if the text is left-or-center justified,
623 * and on the left otherwise; do this by packing boxes, so flipping
624 * text direction will reverse things
626 gtk_widget_ref (arrow);
627 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
629 if (tree_column->xalign <= 0.5)
631 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
635 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
636 /* move it to the front */
637 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
639 gtk_widget_unref (arrow);
641 if (tree_column->show_sort_indicator)
642 gtk_widget_show (arrow);
644 gtk_widget_hide (arrow);
646 /* It's always safe to hide the button. It isn't always safe to show it, as if you show it
647 * before it's realized, it'll get the wrong window. */
648 if (tree_column->button &&
649 tree_column->tree_view != NULL &&
650 GTK_WIDGET_REALIZED (tree_column->tree_view))
652 if (tree_column->visible)
654 gtk_widget_show_now (tree_column->button);
655 if (tree_column->window)
657 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_RESIZEABLE)
659 gdk_window_show (tree_column->window);
660 gdk_window_raise (tree_column->window);
664 gdk_window_hide (tree_column->window);
670 gtk_widget_hide (tree_column->button);
671 if (tree_column->window)
672 gdk_window_hide (tree_column->window);
676 if (tree_column->reorderable || tree_column->clickable)
678 GTK_WIDGET_SET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
682 GTK_WIDGET_UNSET_FLAGS (tree_column->button, GTK_CAN_FOCUS);
683 if (GTK_WIDGET_HAS_FOCUS (tree_column->button))
684 gtk_window_set_focus (GTK_WINDOW (gtk_widget_get_toplevel (tree_column->tree_view)), NULL);
687 tree_column->dirty = TRUE;
688 gtk_widget_queue_resize (tree_column->tree_view);
691 /* Button signal handlers
695 gtk_tree_view_column_button_event (GtkWidget *widget,
699 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
701 g_return_val_if_fail (event != NULL, FALSE);
703 if (event->type == GDK_BUTTON_PRESS &&
706 column->maybe_reordered = TRUE;
707 gdk_window_get_pointer (widget->window,
711 gtk_widget_grab_focus (widget);
714 if (event->type == GDK_BUTTON_RELEASE &&
715 column->maybe_reordered)
716 column->maybe_reordered = FALSE;
718 if (event->type == GDK_MOTION_NOTIFY &&
719 (column->maybe_reordered) &&
720 (gtk_drag_check_threshold (widget,
723 (gint) ((GdkEventMotion *)event)->x,
724 (gint) ((GdkEventMotion *)event)->y)))
726 column->maybe_reordered = FALSE;
727 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (column->tree_view), column);
730 if (column->clickable == FALSE)
734 case GDK_BUTTON_PRESS:
735 case GDK_2BUTTON_PRESS:
736 case GDK_3BUTTON_PRESS:
737 case GDK_MOTION_NOTIFY:
738 case GDK_BUTTON_RELEASE:
739 case GDK_ENTER_NOTIFY:
740 case GDK_LEAVE_NOTIFY:
750 gtk_tree_view_column_button_realize (GtkWidget *widget, gpointer data)
752 gdk_window_set_events (widget->window, gdk_window_get_events (widget->window) | GDK_POINTER_MOTION_MASK);
756 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
758 g_signal_emit_by_name (G_OBJECT (data), "clicked");
762 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
763 GtkTreeViewColumn *column)
766 GtkTreeSortOrder order;
768 if (gtk_tree_sortable_get_sort_column_id (sortable,
772 if (sort_column_id == column->sort_column_id)
774 gtk_tree_view_column_set_sort_indicator (column, TRUE);
775 gtk_tree_view_column_set_sort_order (column, order);
779 gtk_tree_view_column_set_sort_indicator (column, FALSE);
785 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
790 g_return_if_fail (tree_column->tree_view != NULL);
792 if (tree_column->show_sort_indicator)
794 if (tree_column->sort_order == GTK_TREE_SORT_ASCENDING)
795 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_DESCENDING);
797 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
801 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
802 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
805 list = (GTK_TREE_VIEW (tree_column->tree_view)->priv->columns);
809 GtkTreeViewColumn *tmp_column;
811 tmp_column = GTK_TREE_VIEW_COLUMN (list->data);
812 if (tmp_column->visible && tmp_column != tree_column)
813 gtk_tree_view_column_set_sort_indicator (tmp_column, FALSE);
818 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (GTK_TREE_VIEW (tree_column->tree_view)->priv->model),
819 tree_column->sort_column_id,
820 tree_column->sort_order);
825 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
829 if (tree_column->tree_view == NULL)
832 model = gtk_tree_view_get_model (GTK_TREE_VIEW (tree_column->tree_view));
836 if (tree_column->sort_column_changed_signal)
838 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
839 tree_column->sort_column_changed_signal = 0;
844 if (GTK_IS_TREE_SORTABLE (model) &&
845 tree_column->sort_column_id != -1)
847 gint real_sort_column_id;
848 GtkTreeSortOrder real_order;
850 if (tree_column->sort_column_changed_signal == 0)
851 tree_column->sort_column_changed_signal =
852 g_signal_connectc (G_OBJECT (model), "sort_column_changed",
853 GTK_SIGNAL_FUNC (gtk_tree_view_model_sort_column_changed),
856 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
857 &real_sort_column_id,
859 (real_sort_column_id == tree_column->sort_column_id))
861 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
862 gtk_tree_view_column_set_sort_order (tree_column, real_order);
870 /* Exported Private Functions.
871 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
875 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
877 GtkTreeView *tree_view;
879 guint attributes_mask;
881 tree_view = (GtkTreeView *)column->tree_view;
883 g_return_if_fail (tree_view != NULL);
884 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
885 g_return_if_fail (GTK_WIDGET_REALIZED (tree_view));
886 g_return_if_fail (tree_view->priv->header_window != NULL);
887 g_return_if_fail (column->button != NULL);
889 gtk_widget_set_parent_window (column->button, tree_view->priv->header_window);
892 gtk_widget_show (column->button);
894 attr.window_type = GDK_WINDOW_CHILD;
895 attr.wclass = GDK_INPUT_ONLY;
896 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
897 attr.colormap = gtk_widget_get_colormap (GTK_WIDGET (tree_view));
898 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view));
899 attr.event_mask = (GDK_BUTTON_PRESS_MASK |
900 GDK_BUTTON_RELEASE_MASK |
901 GDK_POINTER_MOTION_MASK |
902 GDK_POINTER_MOTION_HINT_MASK |
904 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
905 attr.cursor = gdk_cursor_new (GDK_SB_H_DOUBLE_ARROW);
906 tree_view->priv->cursor_drag = attr.cursor;
909 attr.width = TREE_VIEW_DRAG_WIDTH;
910 attr.height = tree_view->priv->header_height;
912 attr.x = (column->button->allocation.x + column->button->allocation.width) - 3;
914 column->window = gdk_window_new (tree_view->priv->header_window,
915 &attr, attributes_mask);
916 gdk_window_set_user_data (column->window, tree_view);
918 gtk_tree_view_column_update_button (column);
922 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
924 g_return_if_fail (column != NULL);
925 g_return_if_fail (column->window != NULL);
927 gdk_window_set_user_data (column->window, NULL);
928 gdk_window_destroy (column->window);
929 column->window = NULL;
933 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
934 GtkTreeView *tree_view)
936 g_assert (column->tree_view == NULL);
938 column->tree_view = GTK_WIDGET (tree_view);
939 gtk_tree_view_column_create_button (column);
941 column->property_changed_signal =
942 g_signal_connect_data (GTK_OBJECT (tree_view),
944 GTK_SIGNAL_FUNC (gtk_tree_view_column_setup_sort_column_id_callback),
945 column, NULL, TRUE, FALSE);
947 gtk_tree_view_column_setup_sort_column_id_callback (column);
951 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
953 if (column->tree_view && column->button)
955 gtk_container_remove (GTK_CONTAINER (column->tree_view), column->button);
957 if (column->property_changed_signal)
959 g_signal_handler_disconnect (G_OBJECT (column->tree_view), column->property_changed_signal);
960 column->property_changed_signal = 0;
963 if (column->sort_column_changed_signal)
965 g_signal_handler_disconnect (G_OBJECT (column), column->sort_column_changed_signal);
966 column->sort_column_changed_signal = 0;
969 column->tree_view = NULL;
970 column->button = NULL;
974 _gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
977 if (tree_column->min_width != -1 &&
978 width <= tree_column->min_width)
979 width = tree_column->min_width;
980 else if (tree_column->max_width != -1 &&
981 width > tree_column->max_width)
982 width = tree_column->max_width;
984 if (tree_column->width == width)
987 tree_column->width = width;
989 g_object_notify (G_OBJECT (tree_column), "width");
991 if (tree_column->tree_view != NULL)
992 gtk_widget_queue_resize (tree_column->tree_view);
996 /* Public Functions */
1000 * gtk_tree_view_column_new:
1002 * Creates a new #GtkTreeViewColumn.
1004 * Return value: A newly created #GtkTreeViewColumn.
1007 gtk_tree_view_column_new (void)
1009 GtkTreeViewColumn *tree_column;
1011 tree_column = GTK_TREE_VIEW_COLUMN (gtk_type_new (GTK_TYPE_TREE_VIEW_COLUMN));
1017 * gtk_tree_view_column_new_with_attributes:
1018 * @title: The title to set the header to.
1019 * @cell: The #GtkCellRenderer.
1020 * @Varargs: A NULL terminated list of attributes.
1022 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1023 * equivalent to calling @gtk_tree_view_column_set_title,
1024 * @gtk_tree_view_column_set_cell_renderer, and
1025 * @gtk_tree_view_column_set_attributes on the newly created #GtkTreeViewColumn.
1027 * Return value: A newly created #GtkTreeViewColumn.
1030 gtk_tree_view_column_new_with_attributes (const gchar *title,
1031 GtkCellRenderer *cell,
1034 GtkTreeViewColumn *retval;
1037 retval = gtk_tree_view_column_new ();
1039 gtk_tree_view_column_set_title (retval, title);
1040 gtk_tree_view_column_set_cell_renderer (retval, cell);
1042 va_start (args, cell);
1043 gtk_tree_view_column_set_attributesv (retval, args);
1050 * gtk_tree_view_column_set_cell_renderer:
1051 * @tree_column: A #GtkTreeViewColumn.
1052 * @cell: The #GtkCellRenderer, or NULL.
1054 * Sets the cell renderer of the @tree_column. If there is a cell
1055 * renderer already set, then it is removed. If @cell is NULL, then
1056 * the cell renderer is unset.
1059 gtk_tree_view_column_set_cell_renderer (GtkTreeViewColumn *tree_column,
1060 GtkCellRenderer *cell)
1062 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1065 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
1068 g_object_ref (G_OBJECT (cell));
1070 if (tree_column->cell)
1071 g_object_unref (G_OBJECT (tree_column->cell));
1073 tree_column->cell = cell;
1075 if (tree_column->tree_view)
1077 tree_column->dirty = TRUE;
1078 gtk_widget_queue_resize (tree_column->tree_view);
1081 g_object_notify (G_OBJECT (tree_column), "cell_renderer");
1085 * gtk_tree_view_column_get_cell_renderer:
1086 * @tree_column: a #GtkTreeViewColumn
1088 * Gets the value set with gtk_tree_view_column_set_cell_renderer().
1090 * Return value: cell renderer for the column, or %NULL if unset
1093 gtk_tree_view_column_get_cell_renderer (GtkTreeViewColumn *tree_column)
1095 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1097 return tree_column->cell;
1101 * gtk_tree_view_column_add_attribute:
1102 * @tree_column: A #GtkTreeViewColumn.
1103 * @attribute: An attribute on the columns cell
1104 * @column: The column position on the model to get the attribute from.
1106 * Adds an attribute mapping to the list in @tree_column. The @column is the
1107 * column position on the model to get a value from, and the @attribute is the
1108 * parameter on the @tree_column's cell renderer to set that value to.
1111 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1112 const gchar *attribute,
1115 g_return_if_fail (tree_column != NULL);
1116 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1118 tree_column->attributes = g_slist_prepend (tree_column->attributes,
1119 GINT_TO_POINTER (column));
1120 tree_column->attributes = g_slist_prepend (tree_column->attributes,
1121 g_strdup (attribute));
1123 if (tree_column->tree_view)
1125 tree_column->dirty = TRUE;
1126 gtk_widget_queue_resize (tree_column->tree_view);
1132 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1138 g_return_if_fail (tree_column != NULL);
1139 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1141 attribute = va_arg (args, gchar *);
1143 gtk_tree_view_column_clear_attributes (tree_column);
1145 while (attribute != NULL)
1147 column = va_arg (args, gint);
1148 gtk_tree_view_column_add_attribute (tree_column,
1151 attribute = va_arg (args, gchar *);
1156 * gtk_tree_view_column_set_attributes:
1157 * @tree_column: A #GtkTreeViewColumn.
1158 * @Varargs: A NULL terminated listing of attributes.
1160 * Sets the attributes in the list as the attributes of @tree_column.
1161 * The attributes should be in attribute/column order, as in
1162 * @gtk_tree_view_column_add_attribute. All existing attributes
1163 * are removed, and replaced with the new attributes.
1166 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1171 g_return_if_fail (tree_column != NULL);
1172 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1174 va_start (args, tree_column);
1176 gtk_tree_view_column_set_attributesv (tree_column, args);
1183 * gtk_tree_view_column_set_cell_data_func:
1184 * @tree_column: A #GtkTreeViewColumn
1185 * @func: The #GtkTreeViewColumnFunc to use.
1186 * @func_data: The user data for @func.
1187 * @destroy: The destroy notification for @func_data
1189 * Sets the #GtkTreeViewColumnFunc to use for the column. This function is used
1190 * instead of the standard attributes mapping for setting the column value, and
1191 * should set the value of @tree_column 's cell renderer as appropriate. @func
1192 * may be NULL to remove an older one.
1195 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1196 GtkTreeCellDataFunc func,
1198 GtkDestroyNotify destroy)
1200 g_return_if_fail (tree_column != NULL);
1201 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1203 if (func == tree_column->func &&
1204 func_data == tree_column->func_data &&
1205 destroy == tree_column->destroy)
1208 if (tree_column->func_data && tree_column->destroy)
1209 (tree_column->destroy) (tree_column->func_data);
1211 tree_column->func = func;
1212 tree_column->func_data = func_data;
1213 tree_column->destroy = destroy;
1215 if (tree_column->tree_view)
1217 tree_column->dirty = TRUE;
1218 gtk_widget_queue_resize (tree_column->tree_view);
1224 * gtk_tree_view_column_clear_attributes:
1225 * @tree_column: a #GtkTreeViewColumn
1227 * Clears all existing attributes previously set with
1228 * gtk_tree_view_column_set_attributes().
1231 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column)
1235 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1237 list = tree_column->attributes;
1239 while (list && list->next)
1241 g_free (list->data);
1242 list = list->next->next;
1244 g_slist_free (tree_column->attributes);
1245 tree_column->attributes = NULL;
1247 if (tree_column->tree_view)
1249 tree_column->dirty = TRUE;
1250 gtk_widget_queue_resize (tree_column->tree_view);
1254 /* Options for manipulating the columns */
1257 * gtk_tree_view_column_set_visible:
1258 * @tree_column: A #GtkTreeViewColumn.
1259 * @visible: TRUE if the @tree_column is visible.
1261 * Sets the visibility of @tree_column.
1264 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1267 g_return_if_fail (tree_column != NULL);
1268 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1270 visible = !! visible;
1272 if (tree_column->visible == visible)
1275 tree_column->visible = visible;
1277 gtk_tree_view_column_update_button (tree_column);
1278 g_object_notify (G_OBJECT (tree_column), "visible");
1282 * gtk_tree_view_column_get_visible:
1283 * @tree_column: A #GtkTreeViewColumn.
1285 * Returns TRUE if @tree_column is visible.
1287 * Return value: whether the column is visible or not. If it is visible, then
1288 * the tree will show the column.
1291 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1293 g_return_val_if_fail (tree_column != NULL, FALSE);
1294 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1296 return tree_column->visible;
1300 * gtk_tree_view_column_set_sizing:
1301 * @tree_column: A #GtkTreeViewColumn.
1302 * @type: The #GtkTreeViewColumnSizing.
1304 * Sets the growth behavior of @tree_column to @type.
1307 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1308 GtkTreeViewColumnSizing type)
1310 g_return_if_fail (tree_column != NULL);
1311 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1313 if (type == tree_column->column_type)
1316 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1317 tree_column->requested_width != -1)
1319 gtk_tree_view_column_set_sizing (tree_column, tree_column->requested_width);
1321 tree_column->column_type = type;
1323 gtk_tree_view_column_update_button (tree_column);
1325 if (type != GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1326 g_object_notify (G_OBJECT (tree_column), "sizing");
1330 * gtk_tree_view_column_get_sizing:
1331 * @tree_column: A #GtkTreeViewColumn.
1333 * Returns the current type of @tree_column.
1335 * Return value: The type of @tree_column.
1338 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1340 g_return_val_if_fail (tree_column != NULL, 0);
1341 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1343 return tree_column->column_type;
1347 * gtk_tree_view_column_get_size:
1348 * @tree_column: A #GtkTreeViewColumn.
1350 * Returns the current size of the @tree_column in pixels.
1352 * Return value: The current size of the @tree_column.
1355 gtk_tree_view_column_get_size (GtkTreeViewColumn *tree_column)
1357 g_return_val_if_fail (tree_column != NULL, 0);
1358 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1360 return tree_column->width;
1364 * gtk_tree_view_column_set_width:
1365 * @tree_column: A #GtkTreeViewColumn.
1366 * @width: The size to set the @tree_column to.
1368 * Sets the size of the column in pixels, unless the the column type is
1369 * #GTK_TREE_VIEW_COLUMN_AUTOSIZE. In this case, the value is discarded as the
1370 * size of the column is based on the calculated width of the column. The
1371 * width is clamped to the min/max width for the column.
1374 gtk_tree_view_column_set_width (GtkTreeViewColumn *tree_column,
1377 g_return_if_fail (tree_column != NULL);
1378 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1379 g_return_if_fail (width > 0);
1381 if (tree_column->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1384 tree_column->requested_width = width;
1385 _gtk_tree_view_column_set_width (tree_column, width);
1389 * gtk_tree_view_column_get_width:
1390 * @tree_column: a #GtkTreeViewColumn
1392 * Gets the value set by gtk_tree_view_column_set_width().
1394 * Return value: the width of the column
1397 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1399 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1401 return tree_column->width;
1405 * gtk_tree_view_column_set_min_width:
1406 * @tree_column: A #GtkTreeViewColumn.
1407 * @min_width: The minimum width of the column in pixels, or -1.
1409 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
1410 * minimum width is unset.
1413 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
1416 gint real_min_width;
1418 g_return_if_fail (tree_column != NULL);
1419 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1420 g_return_if_fail (min_width >= -1);
1422 if (min_width == tree_column->min_width)
1425 if (tree_column->tree_view == NULL)
1427 tree_column->min_width = min_width;
1431 real_min_width = (tree_column->min_width == -1) ?
1432 tree_column->button->requisition.width : tree_column->min_width;
1434 /* We want to queue a resize if the either the old min_size or the
1435 * new min_size determined the size of the column */
1436 if (GTK_WIDGET_REALIZED (tree_column->tree_view))
1438 if ((tree_column->min_width > tree_column->width) ||
1439 (tree_column->min_width == -1 &&
1440 tree_column->button->requisition.width > tree_column->width) ||
1441 (min_width > tree_column->width) ||
1443 tree_column->button->requisition.width > tree_column->width))
1444 gtk_widget_queue_resize (tree_column->tree_view);
1447 if (tree_column->max_width != -1 && tree_column->max_width < real_min_width)
1448 tree_column->max_width = real_min_width;
1450 tree_column->min_width = min_width;
1452 g_object_notify (G_OBJECT (tree_column), "min_width");
1456 * gtk_tree_view_column_get_min_width:
1457 * @tree_column: A #GtkTreeViewColumn.
1459 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
1462 * Return value: The minimum width of the @tree_column.
1465 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
1467 g_return_val_if_fail (tree_column != NULL, -1);
1468 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1470 return tree_column->min_width;
1474 * gtk_tree_view_column_set_max_width:
1475 * @tree_column: A #GtkTreeViewColumn.
1476 * @max_width: The maximum width of the column in pixels, or -1.
1478 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
1479 * maximum width is unset.
1482 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
1485 gint real_max_width;
1487 g_return_if_fail (tree_column != NULL);
1488 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1489 g_return_if_fail (max_width >= -1);
1491 if (max_width == tree_column->max_width)
1494 if (tree_column->tree_view == NULL)
1496 tree_column->max_width = max_width;
1500 real_max_width = tree_column->max_width == -1 ?
1501 tree_column->button->requisition.width : tree_column->max_width;
1503 if (tree_column->tree_view &&
1504 GTK_WIDGET_REALIZED (tree_column->tree_view) &&
1505 ((tree_column->max_width < tree_column->width) ||
1506 (max_width != -1 && max_width < tree_column->width)))
1507 gtk_widget_queue_resize (tree_column->tree_view);
1509 tree_column->max_width = max_width;
1511 if (real_max_width > max_width)
1512 tree_column->max_width = max_width;
1514 g_object_notify (G_OBJECT (tree_column), "max_width");
1518 * gtk_tree_view_column_get_max_width:
1519 * @tree_column: A #GtkTreeViewColumn.
1521 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
1524 * Return value: The maximum width of the @tree_column.
1527 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
1529 g_return_val_if_fail (tree_column != NULL, -1);
1530 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
1532 return tree_column->max_width;
1536 * gtk_tree_view_column_clicked:
1537 * @tree_column: a #GtkTreeViewColumn
1539 * Emits the "clicked" signal on the column. This function will only work if
1540 * the user could have conceivably clicked on the button.
1543 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
1545 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1547 if (tree_column->visible &&
1548 tree_column->button &&
1549 tree_column->clickable)
1550 gtk_button_clicked (GTK_BUTTON (tree_column->button));
1554 * gtk_tree_view_column_set_title:
1555 * @tree_column: A #GtkTreeViewColumn.
1556 * @title: The title of the @tree_column.
1558 * Sets the title of the @tree_column. If a custom widget has been set, then
1559 * this value is ignored.
1562 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
1565 g_return_if_fail (tree_column != NULL);
1566 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1568 g_free (tree_column->title);
1570 tree_column->title = g_strdup (title);
1572 tree_column->title = NULL;
1574 gtk_tree_view_column_update_button (tree_column);
1575 g_object_notify (G_OBJECT (tree_column), "title");
1579 * gtk_tree_view_column_get_title:
1580 * @tree_column: A #GtkTreeViewColumn.
1582 * Returns the title of the widget. This value should not be modified.
1584 * Return value: the title of the column.
1586 G_CONST_RETURN gchar *
1587 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
1589 g_return_val_if_fail (tree_column != NULL, NULL);
1590 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1592 return tree_column->title;
1596 * gtk_tree_view_column_set_clickable:
1597 * @tree_column: A #GtkTreeViewColumn.
1598 * @clickable: TRUE if the header is active.
1600 * Sets the header to be active if @active is TRUE. When the header is active,
1601 * then it can take keyboard focus, and can be clicked.
1604 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
1607 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1609 if (tree_column->clickable == (clickable?TRUE:FALSE))
1612 tree_column->clickable = (clickable?TRUE:FALSE);
1613 gtk_tree_view_column_update_button (tree_column);
1614 g_object_notify (G_OBJECT (tree_column), "clickable");
1618 * gtk_tree_view_column_get_clickable:
1619 * @tree_column: a #GtkTreeViewColumn
1621 * Returns %TRUE if the user can click on the header for the column.
1623 * Return value: whether the user can click the column header
1626 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
1628 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1630 return tree_column->clickable;
1634 * gtk_tree_view_column_set_widget:
1635 * @tree_column: A #GtkTreeViewColumn.
1636 * @widget: A child #GtkWidget, or NULL.
1638 * Sets the widget in the header to be @widget. If widget is NULL, then the
1639 * header button is set with a #GtkLabel set to the title of @tree_column.
1642 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
1645 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1646 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
1650 gtk_object_ref (GTK_OBJECT (widget));
1651 gtk_object_sink (GTK_OBJECT (widget));
1654 if (tree_column->child)
1655 gtk_object_unref (GTK_OBJECT (tree_column->child));
1657 tree_column->child = widget;
1658 gtk_tree_view_column_update_button (tree_column);
1659 g_object_notify (G_OBJECT (tree_column), "widget");
1663 * gtk_tree_view_column_get_widget:
1664 * @tree_column: A #GtkTreeViewColumn.
1666 * Returns the #GtkWidget in the button in the column header. If a custom
1667 * widget has not been set, then this will be a #GtkAlignment with a #GtkLabel
1670 * Return value: The #GtkWidget in the column header.
1673 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
1675 g_return_val_if_fail (tree_column != NULL, NULL);
1676 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
1678 return tree_column->child;
1682 * gtk_tree_view_column_set_alignment:
1683 * @tree_column: A #GtkTreeViewColumn.
1684 * @xalign: alignment (0.0 for left, 0.5 for center, 1.0 for right)
1686 * Sets the alignment of the title or custom widget inside the column header.
1689 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
1692 g_return_if_fail (tree_column != NULL);
1693 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1695 if (tree_column->xalign == xalign)
1698 tree_column->xalign = xalign;
1699 gtk_tree_view_column_update_button (tree_column);
1700 g_object_notify (G_OBJECT (tree_column), "alignment");
1704 * gtk_tree_view_column_get_alignment:
1705 * @tree_column: A #GtkTreeViewColumn.
1707 * Returns the current x alignment of @tree_column. This value can range
1708 * between 0.0 and 1.0.
1710 * Return value: The current alignent of @tree_column.
1713 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
1715 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
1717 return tree_column->xalign;
1721 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
1722 gboolean reorderable)
1724 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1727 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
1729 if (tree_column->reorderable == (reorderable?TRUE:FALSE))
1732 tree_column->reorderable = (reorderable?TRUE:FALSE);
1733 gtk_tree_view_column_update_button (tree_column);
1734 g_object_notify (G_OBJECT (tree_column), "reorderable");
1738 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
1740 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1742 return tree_column->reorderable;
1747 * gtk_tree_view_column_set_sort_column_id:
1748 * @tree_column: a #GtkTreeViewColumn
1749 * @sort_column_id: The sort_column_id of the model to sort on.
1751 * Sets the sort_column_id that the column sorts on. Doing so makes headers
1755 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
1756 gint sort_column_id)
1758 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1759 g_return_if_fail (sort_column_id >= 0);
1761 if (tree_column->sort_column_id == sort_column_id)
1764 tree_column->sort_column_id = sort_column_id;
1766 /* Handle unsetting the id */
1767 if (sort_column_id == -1)
1769 if (tree_column->sort_clicked_signal)
1771 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_clicked_signal);
1772 tree_column->sort_clicked_signal = 0;
1775 if (tree_column->sort_column_changed_signal)
1777 g_signal_handler_disconnect (G_OBJECT (tree_column), tree_column->sort_column_changed_signal);
1778 tree_column->sort_column_changed_signal = 0;
1781 gtk_tree_view_column_set_sort_order (tree_column, GTK_TREE_SORT_ASCENDING);
1782 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1786 gtk_tree_view_column_set_clickable (tree_column, TRUE);
1788 if (! tree_column->sort_clicked_signal)
1789 tree_column->sort_clicked_signal = g_signal_connectc (G_OBJECT (tree_column),
1791 G_CALLBACK (gtk_tree_view_column_sort),
1794 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
1798 * gtk_tree_view_column_set_sort_indicator:
1799 * @tree_column: a #GtkTreeViewColumn
1800 * @setting: %TRUE to display an indicator that the column is sorted
1802 * Call this function with a @setting of %TRUE to display an arrow in
1803 * the header button indicating the column is sorted. Call
1804 * gtk_tree_view_column_set_sort_order() to change the direction of
1809 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
1812 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1814 setting = setting != FALSE;
1816 if (setting == tree_column->show_sort_indicator)
1819 tree_column->show_sort_indicator = setting;
1820 gtk_tree_view_column_update_button (tree_column);
1821 g_object_notify (G_OBJECT (tree_column), "sort_indicator");
1825 * gtk_tree_view_column_get_sort_indicator:
1826 * @tree_column: a #GtkTreeViewColumn
1828 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
1830 * Return value: whether the sort indicator arrow is displayed
1833 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
1835 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1837 return tree_column->show_sort_indicator;
1841 * gtk_tree_view_column_set_sort_order:
1842 * @tree_column: a #GtkTreeViewColumn
1843 * @order: sort order that the sort indicator should indicate
1845 * Changes the appearance of the sort indicator. (This <emphasis>does
1846 * not</emphasis> actually sort the model. Use
1847 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
1848 * support. This function is primarily for custom sorting behavior, and should
1849 * be used in conjunction with #gtk_tree_sortable_set_sort_column() to do
1850 * that. For custom models, the mechanism will vary. The sort indicator changes
1851 * direction to indicate normal sort or reverse sort. Note that you must have
1852 * the sort indicator enabled to see anything when calling this function; see
1853 * gtk_tree_view_column_set_sort_indicator().
1857 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
1858 GtkTreeSortOrder order)
1860 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1862 if (order == tree_column->sort_order)
1865 tree_column->sort_order = order;
1866 gtk_tree_view_column_update_button (tree_column);
1867 g_object_notify (G_OBJECT (tree_column), "sort_order");
1871 * gtk_tree_view_column_get_sort_order:
1872 * @tree_column: a #GtkTreeViewColumn
1874 * Gets the value set by gtk_tree_view_column_set_sort_order().
1876 * Return value: the sort order the sort indicator is indicating
1879 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
1881 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1883 return tree_column->sort_order;
1890 * gtk_tree_view_column_cell_set_cell_data:
1891 * @tree_column: A #GtkTreeViewColumn.
1892 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
1893 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
1895 * Sets the cell renderer based on the @tree_model and @tree_node. That is, for
1896 * every attribute mapping in @tree_column, it will get a value from the set
1897 * column on the @tree_node, and use that value to set the attribute on the cell
1898 * renderer. This is used primarily by the GtkTreeView.
1901 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
1902 GtkTreeModel *tree_model,
1906 GValue value = { 0, };
1909 g_return_if_fail (tree_column != NULL);
1910 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1911 g_return_if_fail (tree_column->cell != NULL);
1913 if (tree_model == NULL)
1916 cell = (GObject *) tree_column->cell;
1917 list = tree_column->attributes;
1919 g_object_freeze_notify (cell);
1921 while (list && list->next)
1923 gtk_tree_model_get_value (tree_model, iter,
1924 GPOINTER_TO_INT (list->next->data),
1926 g_object_set_property (cell, (gchar *) list->data, &value);
1927 g_value_unset (&value);
1928 list = list->next->next;
1932 if (tree_column->func)
1933 (* tree_column->func) (tree_column, tree_column->cell, tree_model, iter, tree_column->func_data);
1935 g_object_thaw_notify (cell);
1939 * gtk_tree_view_column_cell_get_size:
1940 * @tree_column: A #GtkTreeViewColumn.
1941 * @cell_area: The area a the column will be allocated, or %NULL
1942 * @x_offset: location to return x offset of cell relative to @cell_area, or %NULL
1943 * @y_offset: location to return y offset of cell relative to @cell_area, or %NULL
1944 * @width: location to return width needed to render a cell, or %NULL
1945 * @height: location to return height needed to render a cell, or %NULL
1947 * Obtains the width and height needed to render the column. This is used
1948 * primarily by the GtkTreeView.
1951 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
1952 GdkRectangle *cell_area,
1958 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1960 gtk_cell_renderer_get_size (tree_column->cell,
1961 tree_column->tree_view,
1971 * gtk_tree_view_column_cell_render:
1972 * @tree_column: A #GtkTreeViewColumn.
1973 * @window: a #GdkDrawable to draw to
1974 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
1975 * @cell_area: area normally rendered by a cell renderer
1976 * @expose_area: area that actually needs updating
1977 * @flags: flags that affect rendering
1979 * Renders the cell contained by #tree_column. This is used primarily by the
1983 gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
1985 GdkRectangle *background_area,
1986 GdkRectangle *cell_area,
1987 GdkRectangle *expose_area,
1991 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1993 g_object_get (G_OBJECT (tree_column->cell), "visible", &visible, NULL);
1995 gtk_cell_renderer_render (tree_column->cell,
1997 tree_column->tree_view,
2005 * gtk_tree_view_column_cell_event:
2006 * @tree_column: A #GtkTreeViewColumn.
2007 * @event: a #GdkEvent
2008 * @path_string: widget-dependent string representation of the event location; e.g. for #GtkTreeView, a string representation of #GtkTreePath
2009 * @background_area: background area as passed to gtk_cell_renderer_render()
2010 * @cell_area: cell area as passed to gtk_cell_renderer_render()
2011 * @flags: render flags
2013 * Handles an event. This is used primarily by the GtkTreeView.
2015 * Return value: %TRUE if the event was consumed/handled
2018 gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2021 GdkRectangle *background_area,
2022 GdkRectangle *cell_area,
2025 gboolean visible, can_activate;
2027 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2029 g_object_get (G_OBJECT (tree_column->cell),
2030 "visible", &visible,
2031 "can_activate", &can_activate,
2033 if (visible && can_activate)
2035 if (gtk_cell_renderer_event (tree_column->cell,
2037 tree_column->tree_view,