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.
22 #include "gtktreeviewcolumn.h"
26 #include "gtktreeview.h"
27 #include "gtktreeprivate.h"
28 #include "gtkcelllayout.h"
29 #include "gtkbutton.h"
30 #include "gtkalignment.h"
33 #include "gtkmarshalers.h"
35 #include "gtkcellareacontext.h"
36 #include "gtkcellareabox.h"
37 #include "gtkprivate.h"
42 * SECTION:gtktreeviewcolumn
43 * @Short_description: A visible column in a GtkTreeView widget
44 * @Title: GtkTreeViewColumn
45 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
46 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
47 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
49 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
50 * It allows to set properties of the column header, and functions as a holding pen for
51 * the cell renderers which determine how the data in the column is displayed.
53 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
54 * for an overview of all the objects and data types related to the tree widget and how
60 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
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);
72 static void gtk_tree_view_column_dispose (GObject *object);
73 static GObject *gtk_tree_view_column_constructor (GType type,
74 guint n_construct_properties,
75 GObjectConstructParam *construct_properties);
77 /* GtkCellLayout implementation */
78 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
80 /* Button handling code */
81 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
82 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
84 /* Button signal handlers */
85 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
88 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
90 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
91 gboolean group_cycling,
94 /* Property handlers */
95 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
96 GtkTreeViewColumn *tree_column);
98 /* GtkCellArea/GtkCellAreaContext callbacks */
99 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
101 GtkTreeViewColumn *tree_column);
102 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
103 GtkCellRenderer *renderer,
104 GtkCellEditable *edit_widget,
105 GdkRectangle *cell_area,
106 const gchar *path_string,
108 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
109 GtkCellRenderer *renderer,
110 GtkCellEditable *edit_widget,
113 /* Internal functions */
114 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
116 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
117 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
118 GtkCellRenderer *cell_renderer,
121 /* GtkBuildable implementation */
122 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
125 struct _GtkTreeViewColumnPrivate
127 GtkWidget *tree_view;
131 GtkWidget *alignment;
134 gulong property_changed_signal;
137 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
138 GtkTreeViewColumnSizing column_type;
146 /* dragging columns */
153 gulong sort_clicked_signal;
154 gulong sort_column_changed_signal;
156 GtkSortType sort_order;
159 GtkCellArea *cell_area;
160 GtkCellAreaContext *cell_area_context;
161 gulong add_editable_signal;
162 gulong remove_editable_signal;
163 gulong context_changed_signal;
170 guint show_sort_indicator : 1;
171 guint maybe_reordered : 1;
172 guint reorderable : 1;
173 guint use_resized_width : 1;
206 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
208 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
209 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
210 gtk_tree_view_column_cell_layout_init)
211 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
212 gtk_tree_view_column_buildable_init))
216 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
218 GObjectClass *object_class;
220 object_class = (GObjectClass*) class;
222 class->clicked = NULL;
224 object_class->constructor = gtk_tree_view_column_constructor;
225 object_class->finalize = gtk_tree_view_column_finalize;
226 object_class->dispose = gtk_tree_view_column_dispose;
227 object_class->set_property = gtk_tree_view_column_set_property;
228 object_class->get_property = gtk_tree_view_column_get_property;
230 tree_column_signals[CLICKED] =
231 g_signal_new (I_("clicked"),
232 G_OBJECT_CLASS_TYPE (object_class),
234 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
236 _gtk_marshal_VOID__VOID,
239 g_object_class_install_property (object_class,
241 g_param_spec_boolean ("visible",
243 P_("Whether to display the column"),
245 GTK_PARAM_READWRITE));
247 g_object_class_install_property (object_class,
249 g_param_spec_boolean ("resizable",
251 P_("Column is user-resizable"),
253 GTK_PARAM_READWRITE));
255 g_object_class_install_property (object_class,
257 g_param_spec_int ("width",
259 P_("Current width of the column"),
263 GTK_PARAM_READABLE));
264 g_object_class_install_property (object_class,
266 g_param_spec_int ("spacing",
268 P_("Space which is inserted between cells"),
272 GTK_PARAM_READWRITE));
273 g_object_class_install_property (object_class,
275 g_param_spec_enum ("sizing",
277 P_("Resize mode of the column"),
278 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
279 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
280 GTK_PARAM_READWRITE));
282 g_object_class_install_property (object_class,
284 g_param_spec_int ("fixed-width",
286 P_("Current fixed width of the column"),
290 GTK_PARAM_READWRITE));
292 g_object_class_install_property (object_class,
294 g_param_spec_int ("min-width",
296 P_("Minimum allowed width of the column"),
300 GTK_PARAM_READWRITE));
302 g_object_class_install_property (object_class,
304 g_param_spec_int ("max-width",
306 P_("Maximum allowed width of the column"),
310 GTK_PARAM_READWRITE));
312 g_object_class_install_property (object_class,
314 g_param_spec_string ("title",
316 P_("Title to appear in column header"),
318 GTK_PARAM_READWRITE));
320 g_object_class_install_property (object_class,
322 g_param_spec_boolean ("expand",
324 P_("Column gets share of extra width allocated to the widget"),
326 GTK_PARAM_READWRITE));
328 g_object_class_install_property (object_class,
330 g_param_spec_boolean ("clickable",
332 P_("Whether the header can be clicked"),
334 GTK_PARAM_READWRITE));
337 g_object_class_install_property (object_class,
339 g_param_spec_object ("widget",
341 P_("Widget to put in column header button instead of column title"),
343 GTK_PARAM_READWRITE));
345 g_object_class_install_property (object_class,
347 g_param_spec_float ("alignment",
349 P_("X Alignment of the column header text or widget"),
353 GTK_PARAM_READWRITE));
355 g_object_class_install_property (object_class,
357 g_param_spec_boolean ("reorderable",
359 P_("Whether the column can be reordered around the headers"),
361 GTK_PARAM_READWRITE));
363 g_object_class_install_property (object_class,
365 g_param_spec_boolean ("sort-indicator",
366 P_("Sort indicator"),
367 P_("Whether to show a sort indicator"),
369 GTK_PARAM_READWRITE));
371 g_object_class_install_property (object_class,
373 g_param_spec_enum ("sort-order",
375 P_("Sort direction the sort indicator should indicate"),
378 GTK_PARAM_READWRITE));
381 * GtkTreeViewColumn:sort-column-id:
383 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
384 * clickable. Set to %-1 to make the column unsortable.
388 g_object_class_install_property (object_class,
390 g_param_spec_int ("sort-column-id",
391 P_("Sort column ID"),
392 P_("Logical sort column ID this column sorts on when selected for sorting"),
396 GTK_PARAM_READWRITE));
399 * GtkTreeViewColumn:cell-area:
401 * The #GtkCellArea used to layout cell renderers for this column.
405 g_object_class_install_property (object_class,
407 g_param_spec_object ("cell-area",
409 P_("The GtkCellArea used to layout cells"),
411 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
413 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
417 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
420 const gchar *tagname,
423 /* Just ignore the boolean return from here */
424 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
428 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
430 iface->add_child = _gtk_cell_layout_buildable_add_child;
431 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
432 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
436 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
438 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
442 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
444 GtkTreeViewColumnPrivate *priv;
446 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
447 GTK_TYPE_TREE_VIEW_COLUMN,
448 GtkTreeViewColumnPrivate);
449 priv = tree_column->priv;
455 priv->min_width = -1;
456 priv->max_width = -1;
457 priv->resized_width = 0;
458 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
459 priv->visible = TRUE;
460 priv->resizable = FALSE;
461 priv->expand = FALSE;
462 priv->clickable = FALSE;
464 priv->sort_order = GTK_SORT_ASCENDING;
465 priv->show_sort_indicator = FALSE;
466 priv->property_changed_signal = 0;
467 priv->sort_clicked_signal = 0;
468 priv->sort_column_changed_signal = 0;
469 priv->sort_column_id = -1;
470 priv->reorderable = FALSE;
471 priv->maybe_reordered = FALSE;
472 priv->fixed_width = 1;
473 priv->use_resized_width = FALSE;
474 priv->title = g_strdup ("");
478 gtk_tree_view_column_constructor (GType type,
479 guint n_construct_properties,
480 GObjectConstructParam *construct_properties)
482 GtkTreeViewColumn *tree_column;
483 GtkTreeViewColumnPrivate *priv;
486 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
487 (type, n_construct_properties, construct_properties);
489 tree_column = (GtkTreeViewColumn *) object;
490 priv = tree_column->priv;
492 if (!priv->cell_area)
494 priv->cell_area = gtk_cell_area_box_new ();
495 g_object_ref_sink (priv->cell_area);
498 gtk_cell_area_set_style_detail (priv->cell_area, "treeview");
500 priv->add_editable_signal =
501 g_signal_connect (priv->cell_area, "add-editable",
502 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
504 priv->remove_editable_signal =
505 g_signal_connect (priv->cell_area, "remove-editable",
506 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
509 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
511 priv->context_changed_signal =
512 g_signal_connect (priv->cell_area_context, "notify",
513 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
519 gtk_tree_view_column_dispose (GObject *object)
521 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
522 GtkTreeViewColumnPrivate *priv = tree_column->priv;
524 if (priv->cell_area_context)
526 g_signal_handler_disconnect (priv->cell_area_context,
527 priv->context_changed_signal);
529 g_object_unref (priv->cell_area_context);
531 priv->cell_area_context = NULL;
532 priv->context_changed_signal = 0;
537 g_signal_handler_disconnect (priv->cell_area,
538 priv->add_editable_signal);
539 g_signal_handler_disconnect (priv->cell_area,
540 priv->remove_editable_signal);
542 g_object_unref (priv->cell_area);
543 priv->cell_area = NULL;
544 priv->add_editable_signal = 0;
545 priv->remove_editable_signal = 0;
550 g_object_unref (priv->child);
554 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
558 gtk_tree_view_column_finalize (GObject *object)
560 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
561 GtkTreeViewColumnPrivate *priv = tree_column->priv;
563 g_free (priv->title);
565 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
569 gtk_tree_view_column_set_property (GObject *object,
574 GtkTreeViewColumn *tree_column;
577 tree_column = GTK_TREE_VIEW_COLUMN (object);
582 gtk_tree_view_column_set_visible (tree_column,
583 g_value_get_boolean (value));
587 gtk_tree_view_column_set_resizable (tree_column,
588 g_value_get_boolean (value));
592 gtk_tree_view_column_set_sizing (tree_column,
593 g_value_get_enum (value));
596 case PROP_FIXED_WIDTH:
597 gtk_tree_view_column_set_fixed_width (tree_column,
598 g_value_get_int (value));
602 gtk_tree_view_column_set_min_width (tree_column,
603 g_value_get_int (value));
607 gtk_tree_view_column_set_max_width (tree_column,
608 g_value_get_int (value));
612 gtk_tree_view_column_set_spacing (tree_column,
613 g_value_get_int (value));
617 gtk_tree_view_column_set_title (tree_column,
618 g_value_get_string (value));
622 gtk_tree_view_column_set_expand (tree_column,
623 g_value_get_boolean (value));
627 gtk_tree_view_column_set_clickable (tree_column,
628 g_value_get_boolean (value));
632 gtk_tree_view_column_set_widget (tree_column,
633 (GtkWidget*) g_value_get_object (value));
637 gtk_tree_view_column_set_alignment (tree_column,
638 g_value_get_float (value));
641 case PROP_REORDERABLE:
642 gtk_tree_view_column_set_reorderable (tree_column,
643 g_value_get_boolean (value));
646 case PROP_SORT_INDICATOR:
647 gtk_tree_view_column_set_sort_indicator (tree_column,
648 g_value_get_boolean (value));
651 case PROP_SORT_ORDER:
652 gtk_tree_view_column_set_sort_order (tree_column,
653 g_value_get_enum (value));
656 case PROP_SORT_COLUMN_ID:
657 gtk_tree_view_column_set_sort_column_id (tree_column,
658 g_value_get_int (value));
662 /* Construct-only, can only be assigned once */
663 area = g_value_get_object (value);
666 tree_column->priv->cell_area = g_object_ref_sink (area);
670 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
676 gtk_tree_view_column_get_property (GObject *object,
681 GtkTreeViewColumn *tree_column;
683 tree_column = GTK_TREE_VIEW_COLUMN (object);
688 g_value_set_boolean (value,
689 gtk_tree_view_column_get_visible (tree_column));
693 g_value_set_boolean (value,
694 gtk_tree_view_column_get_resizable (tree_column));
698 g_value_set_int (value,
699 gtk_tree_view_column_get_width (tree_column));
703 g_value_set_int (value,
704 gtk_tree_view_column_get_spacing (tree_column));
708 g_value_set_enum (value,
709 gtk_tree_view_column_get_sizing (tree_column));
712 case PROP_FIXED_WIDTH:
713 g_value_set_int (value,
714 gtk_tree_view_column_get_fixed_width (tree_column));
718 g_value_set_int (value,
719 gtk_tree_view_column_get_min_width (tree_column));
723 g_value_set_int (value,
724 gtk_tree_view_column_get_max_width (tree_column));
728 g_value_set_string (value,
729 gtk_tree_view_column_get_title (tree_column));
733 g_value_set_boolean (value,
734 gtk_tree_view_column_get_expand (tree_column));
738 g_value_set_boolean (value,
739 gtk_tree_view_column_get_clickable (tree_column));
743 g_value_set_object (value,
744 (GObject*) gtk_tree_view_column_get_widget (tree_column));
748 g_value_set_float (value,
749 gtk_tree_view_column_get_alignment (tree_column));
752 case PROP_REORDERABLE:
753 g_value_set_boolean (value,
754 gtk_tree_view_column_get_reorderable (tree_column));
757 case PROP_SORT_INDICATOR:
758 g_value_set_boolean (value,
759 gtk_tree_view_column_get_sort_indicator (tree_column));
762 case PROP_SORT_ORDER:
763 g_value_set_enum (value,
764 gtk_tree_view_column_get_sort_order (tree_column));
767 case PROP_SORT_COLUMN_ID:
768 g_value_set_int (value,
769 gtk_tree_view_column_get_sort_column_id (tree_column));
773 g_value_set_object (value, tree_column->priv->cell_area);
777 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
782 /* Implementation of GtkCellLayout interface
785 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
787 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
788 GtkTreeViewColumnPrivate *priv = column->priv;
790 return priv->cell_area;
793 /* Button handling code
796 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
798 GtkTreeViewColumnPrivate *priv = tree_column->priv;
799 GtkTreeView *tree_view;
803 tree_view = (GtkTreeView *) priv->tree_view;
805 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
806 g_return_if_fail (priv->button == NULL);
808 gtk_widget_push_composite_child ();
809 priv->button = gtk_button_new ();
810 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
811 gtk_widget_pop_composite_child ();
813 /* make sure we own a reference to it as well. */
814 if (_gtk_tree_view_get_header_window (tree_view))
815 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
817 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
819 g_signal_connect (priv->button, "event",
820 G_CALLBACK (gtk_tree_view_column_button_event),
822 g_signal_connect (priv->button, "clicked",
823 G_CALLBACK (gtk_tree_view_column_button_clicked),
826 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
828 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
829 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
835 child = gtk_label_new (priv->title);
836 gtk_widget_show (child);
839 g_signal_connect (child, "mnemonic-activate",
840 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
843 if (priv->xalign <= 0.5)
844 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
846 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
848 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
850 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
851 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
853 gtk_widget_show (hbox);
854 gtk_widget_show (priv->alignment);
855 gtk_tree_view_column_update_button (tree_column);
859 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
861 GtkTreeViewColumnPrivate *priv = tree_column->priv;
862 gint sort_column_id = -1;
864 GtkWidget *alignment;
866 GtkWidget *current_child;
867 GtkArrowType arrow_type = GTK_ARROW_NONE;
871 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
875 /* Create a button if necessary */
877 priv->button == NULL &&
879 gtk_widget_get_realized (priv->tree_view))
880 gtk_tree_view_column_create_button (tree_column);
885 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
886 alignment = priv->alignment;
888 current_child = gtk_bin_get_child (GTK_BIN (alignment));
890 /* Set up the actual button */
891 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
896 if (current_child != priv->child)
898 gtk_container_remove (GTK_CONTAINER (alignment),
900 gtk_container_add (GTK_CONTAINER (alignment),
906 if (current_child == NULL)
908 current_child = gtk_label_new (NULL);
909 gtk_widget_show (current_child);
910 gtk_container_add (GTK_CONTAINER (alignment),
914 g_return_if_fail (GTK_IS_LABEL (current_child));
917 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
920 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
924 if (GTK_IS_TREE_SORTABLE (model))
925 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
929 if (priv->show_sort_indicator)
931 gboolean alternative;
933 g_object_get (gtk_widget_get_settings (priv->tree_view),
934 "gtk-alternative-sort-arrows", &alternative,
937 switch (priv->sort_order)
939 case GTK_SORT_ASCENDING:
940 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
943 case GTK_SORT_DESCENDING:
944 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
948 g_warning (G_STRLOC": bad sort order");
953 gtk_arrow_set (GTK_ARROW (arrow),
957 /* Put arrow on the right if the text is left-or-center justified, and on the
958 * left otherwise; do this by packing boxes, so flipping text direction will
961 g_object_ref (arrow);
962 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
964 if (priv->xalign <= 0.5)
966 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
970 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
971 /* move it to the front */
972 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
974 g_object_unref (arrow);
976 if (priv->show_sort_indicator
977 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
978 gtk_widget_show (arrow);
980 gtk_widget_hide (arrow);
982 /* It's always safe to hide the button. It isn't always safe to show it, as
983 * if you show it before it's realized, it'll get the wrong window. */
985 priv->tree_view != NULL &&
986 gtk_widget_get_realized (priv->tree_view))
990 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
991 gtk_widget_show_now (priv->button);
997 gdk_window_show (priv->window);
998 gdk_window_raise (priv->window);
1002 gdk_window_hide (priv->window);
1008 gtk_widget_hide (priv->button);
1010 gdk_window_hide (priv->window);
1014 if (priv->reorderable || priv->clickable)
1016 gtk_widget_set_can_focus (priv->button, TRUE);
1020 gtk_widget_set_can_focus (priv->button, FALSE);
1021 if (gtk_widget_has_focus (priv->button))
1023 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1024 if (gtk_widget_is_toplevel (toplevel))
1026 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1030 /* Queue a resize on the assumption that we always want to catch all changes
1031 * and columns don't change all that often.
1033 if (gtk_widget_get_realized (priv->tree_view))
1034 gtk_widget_queue_resize (priv->tree_view);
1038 /* Button signal handlers
1042 gtk_tree_view_column_button_event (GtkWidget *widget,
1046 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1047 GtkTreeViewColumnPrivate *priv = column->priv;
1049 g_return_val_if_fail (event != NULL, FALSE);
1051 if (event->type == GDK_BUTTON_PRESS &&
1052 priv->reorderable &&
1053 ((GdkEventButton *)event)->button == 1)
1055 priv->maybe_reordered = TRUE;
1056 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1060 gtk_widget_grab_focus (widget);
1063 if (event->type == GDK_BUTTON_RELEASE ||
1064 event->type == GDK_LEAVE_NOTIFY)
1065 priv->maybe_reordered = FALSE;
1067 if (event->type == GDK_MOTION_NOTIFY &&
1068 priv->maybe_reordered &&
1069 (gtk_drag_check_threshold (widget,
1072 (gint) ((GdkEventMotion *)event)->x,
1073 (gint) ((GdkEventMotion *)event)->y)))
1075 priv->maybe_reordered = FALSE;
1076 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1077 event->motion.device);
1081 if (priv->clickable == FALSE)
1083 switch (event->type)
1085 case GDK_BUTTON_PRESS:
1086 case GDK_2BUTTON_PRESS:
1087 case GDK_3BUTTON_PRESS:
1088 case GDK_MOTION_NOTIFY:
1089 case GDK_BUTTON_RELEASE:
1090 case GDK_ENTER_NOTIFY:
1091 case GDK_LEAVE_NOTIFY:
1102 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1104 g_signal_emit_by_name (data, "clicked");
1108 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1109 gboolean group_cycling,
1112 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1113 GtkTreeViewColumnPrivate *priv = column->priv;
1115 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1117 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1119 if (priv->clickable)
1120 gtk_button_clicked (GTK_BUTTON (priv->button));
1121 else if (gtk_widget_get_can_focus (priv->button))
1122 gtk_widget_grab_focus (priv->button);
1124 gtk_widget_grab_focus (priv->tree_view);
1130 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1131 GtkTreeViewColumn *column)
1133 GtkTreeViewColumnPrivate *priv = column->priv;
1134 gint sort_column_id;
1137 if (gtk_tree_sortable_get_sort_column_id (sortable,
1141 if (sort_column_id == priv->sort_column_id)
1143 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1144 gtk_tree_view_column_set_sort_order (column, order);
1148 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1153 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1158 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1161 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1162 GtkTreeModel *model;
1163 GtkTreeSortable *sortable;
1164 gint sort_column_id;
1166 gboolean has_sort_column;
1167 gboolean has_default_sort_func;
1169 g_return_if_fail (priv->tree_view != NULL);
1171 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1172 sortable = GTK_TREE_SORTABLE (model);
1175 gtk_tree_sortable_get_sort_column_id (sortable,
1178 has_default_sort_func =
1179 gtk_tree_sortable_has_default_sort_func (sortable);
1181 if (has_sort_column &&
1182 sort_column_id == priv->sort_column_id)
1184 if (order == GTK_SORT_ASCENDING)
1185 gtk_tree_sortable_set_sort_column_id (sortable,
1186 priv->sort_column_id,
1187 GTK_SORT_DESCENDING);
1188 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1189 gtk_tree_sortable_set_sort_column_id (sortable,
1190 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1191 GTK_SORT_ASCENDING);
1193 gtk_tree_sortable_set_sort_column_id (sortable,
1194 priv->sort_column_id,
1195 GTK_SORT_ASCENDING);
1199 gtk_tree_sortable_set_sort_column_id (sortable,
1200 priv->sort_column_id,
1201 GTK_SORT_ASCENDING);
1206 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1208 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1209 GtkTreeModel *model;
1211 if (priv->tree_view == NULL)
1214 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1219 if (GTK_IS_TREE_SORTABLE (model) &&
1220 priv->sort_column_id != -1)
1222 gint real_sort_column_id;
1223 GtkSortType real_order;
1225 if (priv->sort_column_changed_signal == 0)
1226 priv->sort_column_changed_signal =
1227 g_signal_connect (model, "sort-column-changed",
1228 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1231 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1232 &real_sort_column_id,
1234 (real_sort_column_id == priv->sort_column_id))
1236 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1237 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1241 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1247 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1249 GtkTreeViewColumn *tree_column)
1251 /* Here we want the column re-requested if the underlying context was
1252 * actually reset for any reason, this can happen if the underlying
1253 * area/cell configuration changes (i.e. cell packing properties
1254 * or cell spacing and the like)
1256 * Note that we block this handler while requesting for sizes
1257 * so there is no need to check for the new context size being -1,
1258 * we also block the handler when explicitly resetting the context
1259 * so as to avoid some infinite stack recursion.
1261 if (!strcmp (pspec->name, "minimum-width") ||
1262 !strcmp (pspec->name, "natural-width") ||
1263 !strcmp (pspec->name, "minimum-height") ||
1264 !strcmp (pspec->name, "natural-height"))
1265 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1269 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1270 GtkCellRenderer *renderer,
1271 GtkCellEditable *edit_widget,
1272 GdkRectangle *cell_area,
1273 const gchar *path_string,
1276 GtkTreeViewColumn *column = user_data;
1277 GtkTreeViewColumnPrivate *priv = column->priv;
1280 if (priv->tree_view)
1282 path = gtk_tree_path_new_from_string (path_string);
1284 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1290 gtk_tree_path_free (path);
1295 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1296 GtkCellRenderer *renderer,
1297 GtkCellEditable *edit_widget,
1300 GtkTreeViewColumn *column = user_data;
1301 GtkTreeViewColumnPrivate *priv = column->priv;
1303 if (priv->tree_view)
1304 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1309 /* Exported Private Functions.
1310 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1313 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1315 GtkTreeViewColumnPrivate *priv = column->priv;
1316 GtkAllocation allocation;
1317 GtkTreeView *tree_view;
1319 guint attributes_mask;
1322 tree_view = (GtkTreeView *)priv->tree_view;
1323 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1325 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1326 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1327 g_return_if_fail (priv->button != NULL);
1329 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1330 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1332 attr.window_type = GDK_WINDOW_CHILD;
1333 attr.wclass = GDK_INPUT_ONLY;
1334 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1335 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1336 (GDK_BUTTON_PRESS_MASK |
1337 GDK_BUTTON_RELEASE_MASK |
1338 GDK_POINTER_MOTION_MASK |
1339 GDK_POINTER_MOTION_HINT_MASK |
1340 GDK_KEY_PRESS_MASK);
1341 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1342 attr.cursor = gdk_cursor_new_for_display
1343 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1345 attr.width = TREE_VIEW_DRAG_WIDTH;
1346 attr.height = _gtk_tree_view_get_header_height (tree_view);
1348 gtk_widget_get_allocation (priv->button, &allocation);
1349 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1350 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1351 &attr, attributes_mask);
1352 gdk_window_set_user_data (priv->window, tree_view);
1354 gtk_tree_view_column_update_button (column);
1356 g_object_unref (attr.cursor);
1360 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1362 GtkTreeViewColumnPrivate *priv;
1364 g_return_if_fail (column != NULL);
1366 priv = column->priv;
1367 g_return_if_fail (priv->window != NULL);
1369 gdk_window_set_user_data (priv->window, NULL);
1370 gdk_window_destroy (priv->window);
1371 priv->window = NULL;
1375 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1376 GtkTreeModel *old_model)
1378 GtkTreeViewColumnPrivate *priv = column->priv;
1380 if (priv->sort_column_changed_signal)
1382 g_signal_handler_disconnect (old_model,
1383 priv->sort_column_changed_signal);
1384 priv->sort_column_changed_signal = 0;
1386 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1390 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1391 GtkTreeView *tree_view)
1393 GtkTreeViewColumnPrivate *priv = column->priv;
1395 g_assert (priv->tree_view == NULL);
1397 priv->tree_view = GTK_WIDGET (tree_view);
1398 gtk_tree_view_column_create_button (column);
1400 priv->property_changed_signal =
1401 g_signal_connect_swapped (tree_view,
1403 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1406 gtk_tree_view_column_setup_sort_column_id_callback (column);
1410 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1412 GtkTreeViewColumnPrivate *priv = column->priv;
1414 if (priv->tree_view && priv->button)
1416 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1418 if (priv->property_changed_signal)
1420 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1421 priv->property_changed_signal = 0;
1424 if (priv->sort_column_changed_signal)
1426 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1427 priv->sort_column_changed_signal);
1428 priv->sort_column_changed_signal = 0;
1431 priv->tree_view = NULL;
1432 priv->button = NULL;
1436 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1438 GtkTreeViewColumnPrivate *priv = column->priv;
1439 gboolean ret = FALSE;
1440 GList *list, *cells;
1442 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1444 for (list = cells; list; list = list->next)
1446 GtkCellRenderer *cell = list->data;
1447 GtkCellRendererMode mode;
1449 g_object_get (cell, "mode", &mode, NULL);
1451 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1458 g_list_free (cells);
1463 /* gets cell being edited */
1465 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1467 GtkTreeViewColumnPrivate *priv = column->priv;
1469 return gtk_cell_area_get_edited_cell (priv->cell_area);
1473 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1474 GdkRectangle *cell_area,
1475 GdkRectangle *background_area,
1479 GtkCellRenderer *match = NULL;
1480 GtkTreeViewColumnPrivate *priv = column->priv;
1482 /* If (x, y) is outside of the background area, immediately return */
1483 if (x < background_area->x ||
1484 x > background_area->x + background_area->width ||
1485 y < background_area->y ||
1486 y > background_area->y + background_area->height)
1489 /* If (x, y) is inside the background area, clamp it to the cell_area
1490 * so that a cell is still returned. The main reason for doing this
1491 * (on the x axis) is for handling clicks in the indentation area
1492 * (either at the left or right depending on RTL setting). Another
1493 * reason is for handling clicks on the area where the focus rectangle
1494 * is drawn (this is outside of cell area), this manifests itself
1495 * mainly when a large setting is used for focus-line-width.
1497 if (x < cell_area->x)
1499 else if (x > cell_area->x + cell_area->width)
1500 x = cell_area->x + cell_area->width;
1502 if (y < cell_area->y)
1504 else if (y > cell_area->y + cell_area->height)
1505 y = cell_area->y + cell_area->height;
1507 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1508 priv->cell_area_context,
1517 /* Public Functions */
1521 * gtk_tree_view_column_new:
1523 * Creates a new #GtkTreeViewColumn.
1525 * Return value: A newly created #GtkTreeViewColumn.
1528 gtk_tree_view_column_new (void)
1530 GtkTreeViewColumn *tree_column;
1532 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1538 * gtk_tree_view_column_new_with_area:
1539 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1541 * Creates a new #GtkTreeViewColumn using @area to render it's cells.
1543 * Return value: A newly created #GtkTreeViewColumn.
1548 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1550 GtkTreeViewColumn *tree_column;
1552 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1559 * gtk_tree_view_column_new_with_attributes:
1560 * @title: The title to set the header to.
1561 * @cell: The #GtkCellRenderer.
1562 * @Varargs: A %NULL-terminated list of attributes.
1564 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1565 * equivalent to calling gtk_tree_view_column_set_title(),
1566 * gtk_tree_view_column_pack_start(), and
1567 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1569 * Here's a simple example:
1571 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1574 * GtkTreeViewColumn *column;
1575 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1577 * column = gtk_tree_view_column_new_with_attributes ("Title",
1579 * "text", TEXT_COLUMN,
1580 * "foreground", COLOR_COLUMN,
1585 * Return value: A newly created #GtkTreeViewColumn.
1588 gtk_tree_view_column_new_with_attributes (const gchar *title,
1589 GtkCellRenderer *cell,
1592 GtkTreeViewColumn *retval;
1595 retval = gtk_tree_view_column_new ();
1597 gtk_tree_view_column_set_title (retval, title);
1598 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1600 va_start (args, cell);
1601 gtk_tree_view_column_set_attributesv (retval, cell, args);
1608 * gtk_tree_view_column_pack_start:
1609 * @tree_column: A #GtkTreeViewColumn.
1610 * @cell: The #GtkCellRenderer.
1611 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1613 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1614 * the @cell is allocated no more space than it needs. Any unused space is divided
1615 * evenly between cells for which @expand is %TRUE.
1618 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1619 GtkCellRenderer *cell,
1622 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1626 * gtk_tree_view_column_pack_end:
1627 * @tree_column: A #GtkTreeViewColumn.
1628 * @cell: The #GtkCellRenderer.
1629 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1631 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1632 * is allocated no more space than it needs. Any unused space is divided
1633 * evenly between cells for which @expand is %TRUE.
1636 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1637 GtkCellRenderer *cell,
1640 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1644 * gtk_tree_view_column_clear:
1645 * @tree_column: A #GtkTreeViewColumn
1647 * Unsets all the mappings on all renderers on the @tree_column.
1650 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1652 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1656 * gtk_tree_view_column_add_attribute:
1657 * @tree_column: A #GtkTreeViewColumn.
1658 * @cell_renderer: the #GtkCellRenderer to set attributes on
1659 * @attribute: An attribute on the renderer
1660 * @column: The column position on the model to get the attribute from.
1662 * Adds an attribute mapping to the list in @tree_column. The @column is the
1663 * column of the model to get a value from, and the @attribute is the
1664 * parameter on @cell_renderer to be set from the value. So for example
1665 * if column 2 of the model contains strings, you could have the
1666 * "text" attribute of a #GtkCellRendererText get its values from
1670 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1671 GtkCellRenderer *cell_renderer,
1672 const gchar *attribute,
1675 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1676 cell_renderer, attribute, column);
1680 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1681 GtkCellRenderer *cell_renderer,
1684 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1688 attribute = va_arg (args, gchar *);
1690 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1693 while (attribute != NULL)
1695 column = va_arg (args, gint);
1696 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1697 cell_renderer, attribute, column);
1698 attribute = va_arg (args, gchar *);
1703 * gtk_tree_view_column_set_attributes:
1704 * @tree_column: A #GtkTreeViewColumn.
1705 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1706 * @Varargs: A %NULL-terminated list of attributes.
1708 * Sets the attributes in the list as the attributes of @tree_column.
1709 * The attributes should be in attribute/column order, as in
1710 * gtk_tree_view_column_add_attribute(). All existing attributes
1711 * are removed, and replaced with the new attributes.
1714 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1715 GtkCellRenderer *cell_renderer,
1720 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1721 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1723 va_start (args, cell_renderer);
1724 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1730 * gtk_tree_view_column_set_cell_data_func:
1731 * @tree_column: A #GtkTreeViewColumn
1732 * @cell_renderer: A #GtkCellRenderer
1733 * @func: The #GtkTreeViewColumnFunc to use.
1734 * @func_data: The user data for @func.
1735 * @destroy: The destroy notification for @func_data
1737 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1738 * function is used instead of the standard attributes mapping for
1739 * setting the column value, and should set the value of @tree_column's
1740 * cell renderer as appropriate. @func may be %NULL to remove an
1744 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1745 GtkCellRenderer *cell_renderer,
1746 GtkTreeCellDataFunc func,
1748 GDestroyNotify destroy)
1750 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1752 (GtkCellLayoutDataFunc)func,
1753 func_data, destroy);
1758 * gtk_tree_view_column_clear_attributes:
1759 * @tree_column: a #GtkTreeViewColumn
1760 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1762 * Clears all existing attributes previously set with
1763 * gtk_tree_view_column_set_attributes().
1766 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1767 GtkCellRenderer *cell_renderer)
1769 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1774 * gtk_tree_view_column_set_spacing:
1775 * @tree_column: A #GtkTreeViewColumn.
1776 * @spacing: distance between cell renderers in pixels.
1778 * Sets the spacing field of @tree_column, which is the number of pixels to
1779 * place between cell renderers packed into it.
1782 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1785 GtkTreeViewColumnPrivate *priv;
1787 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1788 g_return_if_fail (spacing >= 0);
1790 priv = tree_column->priv;
1792 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1794 if (priv->tree_view)
1795 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1799 * gtk_tree_view_column_get_spacing:
1800 * @tree_column: A #GtkTreeViewColumn.
1802 * Returns the spacing of @tree_column.
1804 * Return value: the spacing of @tree_column.
1807 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1809 GtkTreeViewColumnPrivate *priv;
1811 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1813 priv = tree_column->priv;
1815 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1818 /* Options for manipulating the columns */
1821 * gtk_tree_view_column_set_visible:
1822 * @tree_column: A #GtkTreeViewColumn.
1823 * @visible: %TRUE if the @tree_column is visible.
1825 * Sets the visibility of @tree_column.
1828 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1831 GtkTreeViewColumnPrivate *priv;
1833 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1835 priv = tree_column->priv;
1836 visible = !! visible;
1838 if (priv->visible == visible)
1841 priv->visible = visible;
1844 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1846 gtk_tree_view_column_update_button (tree_column);
1847 g_object_notify (G_OBJECT (tree_column), "visible");
1851 * gtk_tree_view_column_get_visible:
1852 * @tree_column: A #GtkTreeViewColumn.
1854 * Returns %TRUE if @tree_column is visible.
1856 * Return value: whether the column is visible or not. If it is visible, then
1857 * the tree will show the column.
1860 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1862 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1864 return tree_column->priv->visible;
1868 * gtk_tree_view_column_set_resizable:
1869 * @tree_column: A #GtkTreeViewColumn
1870 * @resizable: %TRUE, if the column can be resized
1872 * If @resizable is %TRUE, then the user can explicitly resize the column by
1873 * grabbing the outer edge of the column button. If resizable is %TRUE and
1874 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1875 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1878 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1881 GtkTreeViewColumnPrivate *priv;
1883 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1885 priv = tree_column->priv;
1886 resizable = !! resizable;
1888 if (priv->resizable == resizable)
1891 priv->resizable = resizable;
1893 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1894 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1896 gtk_tree_view_column_update_button (tree_column);
1898 g_object_notify (G_OBJECT (tree_column), "resizable");
1902 * gtk_tree_view_column_get_resizable:
1903 * @tree_column: A #GtkTreeViewColumn
1905 * Returns %TRUE if the @tree_column can be resized by the end user.
1907 * Return value: %TRUE, if the @tree_column can be resized.
1910 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1912 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1914 return tree_column->priv->resizable;
1919 * gtk_tree_view_column_set_sizing:
1920 * @tree_column: A #GtkTreeViewColumn.
1921 * @type: The #GtkTreeViewColumnSizing.
1923 * Sets the growth behavior of @tree_column to @type.
1926 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1927 GtkTreeViewColumnSizing type)
1929 GtkTreeViewColumnPrivate *priv;
1931 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1933 priv = tree_column->priv;
1935 if (type == priv->column_type)
1938 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1939 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1941 priv->column_type = type;
1943 gtk_tree_view_column_update_button (tree_column);
1945 g_object_notify (G_OBJECT (tree_column), "sizing");
1949 * gtk_tree_view_column_get_sizing:
1950 * @tree_column: A #GtkTreeViewColumn.
1952 * Returns the current type of @tree_column.
1954 * Return value: The type of @tree_column.
1956 GtkTreeViewColumnSizing
1957 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1959 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1961 return tree_column->priv->column_type;
1965 * gtk_tree_view_column_get_width:
1966 * @tree_column: A #GtkTreeViewColumn.
1968 * Returns the current size of @tree_column in pixels.
1970 * Return value: The current width of @tree_column.
1973 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1975 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1977 return tree_column->priv->width;
1981 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
1983 GtkTreeViewColumnPrivate *priv;
1984 gint real_requested_width;
1986 priv = tree_column->priv;
1988 if (priv->use_resized_width)
1990 real_requested_width = priv->resized_width;
1992 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1994 real_requested_width = priv->fixed_width;
1996 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
1998 gint button_request;
1999 gint requested_width;
2001 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2002 requested_width += priv->padding;
2004 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2005 real_requested_width = MAX (requested_width, button_request);
2009 gint requested_width;
2011 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2012 requested_width += priv->padding;
2014 real_requested_width = requested_width;
2015 if (real_requested_width < 0)
2016 real_requested_width = 0;
2019 if (priv->min_width != -1)
2020 real_requested_width = MAX (real_requested_width, priv->min_width);
2022 if (priv->max_width != -1)
2023 real_requested_width = MIN (real_requested_width, priv->max_width);
2025 return real_requested_width;
2029 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2033 GtkTreeViewColumnPrivate *priv;
2034 GtkAllocation allocation;
2037 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2039 priv = tree_column->priv;
2041 priv->width = width;
2043 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2045 allocation.x = x_offset;
2047 allocation.width = width;
2048 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2050 gtk_widget_size_allocate (priv->button, &allocation);
2054 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2055 gdk_window_move_resize (priv->window,
2056 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2058 TREE_VIEW_DRAG_WIDTH, allocation.height);
2061 g_object_notify (G_OBJECT (tree_column), "width");
2065 * gtk_tree_view_column_set_fixed_width:
2066 * @tree_column: A #GtkTreeViewColumn.
2067 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2069 * Sets the size of the column in pixels. This is meaningful only if the sizing
2070 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2071 * the min/max width for the column. Please note that the min/max width of the
2072 * column doesn't actually affect the "fixed_width" property of the widget, just
2073 * the actual size when displayed.
2076 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2079 GtkTreeViewColumnPrivate *priv;
2081 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2082 g_return_if_fail (fixed_width > 0);
2084 priv = tree_column->priv;
2086 priv->fixed_width = fixed_width;
2087 priv->use_resized_width = FALSE;
2089 if (priv->tree_view &&
2090 gtk_widget_get_realized (priv->tree_view) &&
2091 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2093 gtk_widget_queue_resize (priv->tree_view);
2096 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2100 * gtk_tree_view_column_get_fixed_width:
2101 * @tree_column: a #GtkTreeViewColumn
2103 * Gets the fixed width of the column. This value is only meaning may not be
2104 * the actual width of the column on the screen, just what is requested.
2106 * Return value: the fixed width of the column
2109 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2111 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2113 return tree_column->priv->fixed_width;
2117 * gtk_tree_view_column_set_min_width:
2118 * @tree_column: A #GtkTreeViewColumn.
2119 * @min_width: The minimum width of the column in pixels, or -1.
2121 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2122 * minimum width is unset.
2125 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2128 GtkTreeViewColumnPrivate *priv;
2130 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2131 g_return_if_fail (min_width >= -1);
2133 priv = tree_column->priv;
2135 if (min_width == priv->min_width)
2138 if (priv->visible &&
2139 priv->tree_view != NULL &&
2140 gtk_widget_get_realized (priv->tree_view))
2142 if (min_width > priv->width)
2143 gtk_widget_queue_resize (priv->tree_view);
2146 priv->min_width = min_width;
2147 g_object_freeze_notify (G_OBJECT (tree_column));
2148 if (priv->max_width != -1 && priv->max_width < min_width)
2150 priv->max_width = min_width;
2151 g_object_notify (G_OBJECT (tree_column), "max-width");
2153 g_object_notify (G_OBJECT (tree_column), "min-width");
2154 g_object_thaw_notify (G_OBJECT (tree_column));
2156 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2157 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2162 * gtk_tree_view_column_get_min_width:
2163 * @tree_column: A #GtkTreeViewColumn.
2165 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2168 * Return value: The minimum width of the @tree_column.
2171 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2173 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2175 return tree_column->priv->min_width;
2179 * gtk_tree_view_column_set_max_width:
2180 * @tree_column: A #GtkTreeViewColumn.
2181 * @max_width: The maximum width of the column in pixels, or -1.
2183 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2184 * maximum width is unset. Note, the column can actually be wider than max
2185 * width if it's the last column in a view. In this case, the column expands to
2186 * fill any extra space.
2189 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2192 GtkTreeViewColumnPrivate *priv;
2194 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2195 g_return_if_fail (max_width >= -1);
2197 priv = tree_column->priv;
2199 if (max_width == priv->max_width)
2202 if (priv->visible &&
2203 priv->tree_view != NULL &&
2204 gtk_widget_get_realized (priv->tree_view))
2206 if (max_width != -1 && max_width < priv->width)
2207 gtk_widget_queue_resize (priv->tree_view);
2210 priv->max_width = max_width;
2211 g_object_freeze_notify (G_OBJECT (tree_column));
2212 if (max_width != -1 && max_width < priv->min_width)
2214 priv->min_width = max_width;
2215 g_object_notify (G_OBJECT (tree_column), "min-width");
2217 g_object_notify (G_OBJECT (tree_column), "max-width");
2218 g_object_thaw_notify (G_OBJECT (tree_column));
2220 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2221 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2226 * gtk_tree_view_column_get_max_width:
2227 * @tree_column: A #GtkTreeViewColumn.
2229 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2232 * Return value: The maximum width of the @tree_column.
2235 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2237 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2239 return tree_column->priv->max_width;
2243 * gtk_tree_view_column_clicked:
2244 * @tree_column: a #GtkTreeViewColumn
2246 * Emits the "clicked" signal on the column. This function will only work if
2247 * @tree_column is clickable.
2250 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2252 GtkTreeViewColumnPrivate *priv;
2254 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2256 priv = tree_column->priv;
2258 if (priv->visible &&
2261 gtk_button_clicked (GTK_BUTTON (priv->button));
2265 * gtk_tree_view_column_set_title:
2266 * @tree_column: A #GtkTreeViewColumn.
2267 * @title: The title of the @tree_column.
2269 * Sets the title of the @tree_column. If a custom widget has been set, then
2270 * this value is ignored.
2273 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2276 GtkTreeViewColumnPrivate *priv;
2279 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2281 priv = tree_column->priv;
2283 new_title = g_strdup (title);
2284 g_free (priv->title);
2285 priv->title = new_title;
2287 gtk_tree_view_column_update_button (tree_column);
2288 g_object_notify (G_OBJECT (tree_column), "title");
2292 * gtk_tree_view_column_get_title:
2293 * @tree_column: A #GtkTreeViewColumn.
2295 * Returns the title of the widget.
2297 * Return value: the title of the column. This string should not be
2298 * modified or freed.
2300 G_CONST_RETURN gchar *
2301 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2303 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2305 return tree_column->priv->title;
2309 * gtk_tree_view_column_set_expand:
2310 * @tree_column: A #GtkTreeViewColumn
2311 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2313 * Sets the column to take available extra space. This space is shared equally
2314 * amongst all columns that have the expand set to %TRUE. If no column has this
2315 * option set, then the last column gets all extra space. By default, every
2316 * column is created with this %FALSE.
2321 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2324 GtkTreeViewColumnPrivate *priv;
2326 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2328 priv = tree_column->priv;
2330 expand = expand?TRUE:FALSE;
2331 if (priv->expand == expand)
2333 priv->expand = expand;
2335 if (priv->visible &&
2336 priv->tree_view != NULL &&
2337 gtk_widget_get_realized (priv->tree_view))
2339 /* We want to continue using the original width of the
2340 * column that includes additional space added by the user
2341 * resizing the columns and possibly extra (expanded) space, which
2342 * are not included in the resized width.
2344 priv->use_resized_width = FALSE;
2346 gtk_widget_queue_resize (priv->tree_view);
2349 g_object_notify (G_OBJECT (tree_column), "expand");
2353 * gtk_tree_view_column_get_expand:
2354 * @tree_column: a #GtkTreeViewColumn
2356 * Return %TRUE if the column expands to take any available space.
2358 * Return value: %TRUE, if the column expands
2363 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2365 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2367 return tree_column->priv->expand;
2371 * gtk_tree_view_column_set_clickable:
2372 * @tree_column: A #GtkTreeViewColumn.
2373 * @clickable: %TRUE if the header is active.
2375 * Sets the header to be active if @active is %TRUE. When the header is active,
2376 * then it can take keyboard focus, and can be clicked.
2379 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2382 GtkTreeViewColumnPrivate *priv;
2384 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2386 priv = tree_column->priv;
2388 clickable = !! clickable;
2389 if (priv->clickable == clickable)
2392 priv->clickable = clickable;
2393 gtk_tree_view_column_update_button (tree_column);
2394 g_object_notify (G_OBJECT (tree_column), "clickable");
2398 * gtk_tree_view_column_get_clickable:
2399 * @tree_column: a #GtkTreeViewColumn
2401 * Returns %TRUE if the user can click on the header for the column.
2403 * Return value: %TRUE if user can click the column header.
2406 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2408 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2410 return tree_column->priv->clickable;
2414 * gtk_tree_view_column_set_widget:
2415 * @tree_column: A #GtkTreeViewColumn.
2416 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2418 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2419 * header button is set with a #GtkLabel set to the title of @tree_column.
2422 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2425 GtkTreeViewColumnPrivate *priv;
2427 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2428 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2430 priv = tree_column->priv;
2433 g_object_ref_sink (widget);
2436 g_object_unref (priv->child);
2438 priv->child = widget;
2439 gtk_tree_view_column_update_button (tree_column);
2440 g_object_notify (G_OBJECT (tree_column), "widget");
2444 * gtk_tree_view_column_get_widget:
2445 * @tree_column: A #GtkTreeViewColumn.
2447 * Returns the #GtkWidget in the button on the column header.
2448 * If a custom widget has not been set then %NULL is returned.
2450 * Return value: (transfer none): The #GtkWidget in the column
2454 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2456 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2458 return tree_column->priv->child;
2462 * gtk_tree_view_column_set_alignment:
2463 * @tree_column: A #GtkTreeViewColumn.
2464 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2466 * Sets the alignment of the title or custom widget inside the column header.
2467 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2468 * for center, 1.0 for right.
2471 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2474 GtkTreeViewColumnPrivate *priv;
2476 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2478 priv = tree_column->priv;
2480 xalign = CLAMP (xalign, 0.0, 1.0);
2482 if (priv->xalign == xalign)
2485 priv->xalign = xalign;
2486 gtk_tree_view_column_update_button (tree_column);
2487 g_object_notify (G_OBJECT (tree_column), "alignment");
2491 * gtk_tree_view_column_get_alignment:
2492 * @tree_column: A #GtkTreeViewColumn.
2494 * Returns the current x alignment of @tree_column. This value can range
2495 * between 0.0 and 1.0.
2497 * Return value: The current alignent of @tree_column.
2500 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2502 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2504 return tree_column->priv->xalign;
2508 * gtk_tree_view_column_set_reorderable:
2509 * @tree_column: A #GtkTreeViewColumn
2510 * @reorderable: %TRUE, if the column can be reordered.
2512 * If @reorderable is %TRUE, then the column can be reordered by the end user
2513 * dragging the header.
2516 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2517 gboolean reorderable)
2519 GtkTreeViewColumnPrivate *priv;
2521 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2523 priv = tree_column->priv;
2526 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2528 if (priv->reorderable == (reorderable?TRUE:FALSE))
2531 priv->reorderable = (reorderable?TRUE:FALSE);
2532 gtk_tree_view_column_update_button (tree_column);
2533 g_object_notify (G_OBJECT (tree_column), "reorderable");
2537 * gtk_tree_view_column_get_reorderable:
2538 * @tree_column: A #GtkTreeViewColumn
2540 * Returns %TRUE if the @tree_column can be reordered by the user.
2542 * Return value: %TRUE if the @tree_column can be reordered by the user.
2545 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2547 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2549 return tree_column->priv->reorderable;
2554 * gtk_tree_view_column_set_sort_column_id:
2555 * @tree_column: a #GtkTreeViewColumn
2556 * @sort_column_id: The @sort_column_id of the model to sort on.
2558 * Sets the logical @sort_column_id that this column sorts on when this column
2559 * is selected for sorting. Doing so makes the column header clickable.
2562 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2563 gint sort_column_id)
2565 GtkTreeViewColumnPrivate *priv;
2567 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2568 g_return_if_fail (sort_column_id >= -1);
2570 priv = tree_column->priv;
2572 if (priv->sort_column_id == sort_column_id)
2575 priv->sort_column_id = sort_column_id;
2577 /* Handle unsetting the id */
2578 if (sort_column_id == -1)
2580 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2582 if (priv->sort_clicked_signal)
2584 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2585 priv->sort_clicked_signal = 0;
2588 if (priv->sort_column_changed_signal)
2590 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2591 priv->sort_column_changed_signal = 0;
2594 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2595 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2596 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2597 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2601 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2603 if (! priv->sort_clicked_signal)
2604 priv->sort_clicked_signal = g_signal_connect (tree_column,
2606 G_CALLBACK (gtk_tree_view_column_sort),
2609 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2610 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2614 * gtk_tree_view_column_get_sort_column_id:
2615 * @tree_column: a #GtkTreeViewColumn
2617 * Gets the logical @sort_column_id that the model sorts on when this
2618 * column is selected for sorting.
2619 * See gtk_tree_view_column_set_sort_column_id().
2621 * Return value: the current @sort_column_id for this column, or -1 if
2622 * this column can't be used for sorting.
2625 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2627 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2629 return tree_column->priv->sort_column_id;
2633 * gtk_tree_view_column_set_sort_indicator:
2634 * @tree_column: a #GtkTreeViewColumn
2635 * @setting: %TRUE to display an indicator that the column is sorted
2637 * Call this function with a @setting of %TRUE to display an arrow in
2638 * the header button indicating the column is sorted. Call
2639 * gtk_tree_view_column_set_sort_order() to change the direction of
2644 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2647 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2649 setting = setting != FALSE;
2651 if (setting == tree_column->priv->show_sort_indicator)
2654 tree_column->priv->show_sort_indicator = setting;
2655 gtk_tree_view_column_update_button (tree_column);
2656 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2660 * gtk_tree_view_column_get_sort_indicator:
2661 * @tree_column: a #GtkTreeViewColumn
2663 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2665 * Return value: whether the sort indicator arrow is displayed
2668 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2670 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2672 return tree_column->priv->show_sort_indicator;
2676 * gtk_tree_view_column_set_sort_order:
2677 * @tree_column: a #GtkTreeViewColumn
2678 * @order: sort order that the sort indicator should indicate
2680 * Changes the appearance of the sort indicator.
2682 * This <emphasis>does not</emphasis> actually sort the model. Use
2683 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2684 * support. This function is primarily for custom sorting behavior, and should
2685 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2686 * that. For custom models, the mechanism will vary.
2688 * The sort indicator changes direction to indicate normal sort or reverse sort.
2689 * Note that you must have the sort indicator enabled to see anything when
2690 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2693 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2696 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2698 if (order == tree_column->priv->sort_order)
2701 tree_column->priv->sort_order = order;
2702 gtk_tree_view_column_update_button (tree_column);
2703 g_object_notify (G_OBJECT (tree_column), "sort-order");
2707 * gtk_tree_view_column_get_sort_order:
2708 * @tree_column: a #GtkTreeViewColumn
2710 * Gets the value set by gtk_tree_view_column_set_sort_order().
2712 * Return value: the sort order the sort indicator is indicating
2715 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2717 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2719 return tree_column->priv->sort_order;
2723 * gtk_tree_view_column_cell_set_cell_data:
2724 * @tree_column: A #GtkTreeViewColumn.
2725 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2726 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2727 * @is_expander: %TRUE, if the row has children
2728 * @is_expanded: %TRUE, if the row has visible children
2730 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2731 * every attribute mapping in @tree_column, it will get a value from the set
2732 * column on the @iter, and use that value to set the attribute on the cell
2733 * renderer. This is used primarily by the #GtkTreeView.
2736 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2737 GtkTreeModel *tree_model,
2739 gboolean is_expander,
2740 gboolean is_expanded)
2742 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2744 if (tree_model == NULL)
2747 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2748 is_expander, is_expanded);
2752 * gtk_tree_view_column_cell_get_size:
2753 * @tree_column: A #GtkTreeViewColumn.
2754 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2755 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2756 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2757 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2758 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2760 * Obtains the width and height needed to render the column. This is used
2761 * primarily by the #GtkTreeView.
2764 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2765 const GdkRectangle *cell_area,
2771 GtkTreeViewColumnPrivate *priv;
2772 gint min_width = 0, min_height = 0;
2774 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2776 priv = tree_column->priv;
2778 g_signal_handler_block (priv->cell_area_context,
2779 priv->context_changed_signal);
2781 gtk_cell_area_get_preferred_width (priv->cell_area,
2782 priv->cell_area_context,
2786 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2788 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2789 priv->cell_area_context,
2795 g_signal_handler_unblock (priv->cell_area_context,
2796 priv->context_changed_signal);
2800 * height = min_height;
2802 * width = min_width;
2807 * gtk_tree_view_column_cell_render:
2808 * @tree_column: A #GtkTreeViewColumn.
2809 * @cr: cairo context to draw to
2810 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2811 * @cell_area: area normally rendered by a cell renderer
2812 * @flags: flags that affect rendering
2814 * Renders the cell contained by #tree_column. This is used primarily by the
2818 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2820 const GdkRectangle *background_area,
2821 const GdkRectangle *cell_area,
2823 gboolean draw_focus)
2825 GtkTreeViewColumnPrivate *priv;
2827 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2828 g_return_if_fail (cr != NULL);
2829 g_return_if_fail (background_area != NULL);
2830 g_return_if_fail (cell_area != NULL);
2832 priv = tree_column->priv;
2836 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2837 priv->tree_view, cr,
2838 background_area, cell_area, flags,
2845 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2847 const GdkRectangle *cell_area,
2850 GtkTreeViewColumnPrivate *priv;
2852 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2854 priv = tree_column->priv;
2856 return gtk_cell_area_event (priv->cell_area,
2857 priv->cell_area_context,
2865 * gtk_tree_view_column_cell_is_visible:
2866 * @tree_column: A #GtkTreeViewColumn
2868 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2869 * For this to be meaningful, you must first initialize the cells with
2870 * gtk_tree_view_column_cell_set_cell_data()
2872 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2875 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2879 GtkTreeViewColumnPrivate *priv;
2881 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2883 priv = tree_column->priv;
2885 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2886 for (list = cells; list; list = list->next)
2888 if (gtk_cell_renderer_get_visible (list->data))
2890 g_list_free (cells);
2895 g_list_free (cells);
2901 * gtk_tree_view_column_focus_cell:
2902 * @tree_column: A #GtkTreeViewColumn
2903 * @cell: A #GtkCellRenderer
2905 * Sets the current keyboard focus to be at @cell, if the column contains
2906 * 2 or more editable and activatable cells.
2911 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2912 GtkCellRenderer *cell)
2914 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2915 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2917 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2921 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2922 gboolean install_handler)
2924 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2930 /* Issue a manual reset on the context to have all
2931 * sizes re-requested for the context.
2933 g_signal_handler_block (priv->cell_area_context,
2934 priv->context_changed_signal);
2935 gtk_cell_area_context_reset (priv->cell_area_context);
2936 g_signal_handler_unblock (priv->cell_area_context,
2937 priv->context_changed_signal);
2939 if (priv->tree_view &&
2940 gtk_widget_get_realized (priv->tree_view))
2942 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2943 gtk_widget_queue_resize (priv->tree_view);
2948 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2950 return tree_column->priv->dirty;
2954 * gtk_tree_view_column_cell_get_position:
2955 * @tree_column: a #GtkTreeViewColumn
2956 * @cell_renderer: a #GtkCellRenderer
2957 * @x_offset: return location for the horizontal position of @cell within
2958 * @tree_column, may be %NULL
2959 * @width: return location for the width of @cell, may be %NULL
2961 * Obtains the horizontal position and size of a cell in a column. If the
2962 * cell is not found in the column, @start_pos and @width are not changed and
2963 * %FALSE is returned.
2965 * Return value: %TRUE if @cell belongs to @tree_column.
2968 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2969 GtkCellRenderer *cell_renderer,
2973 GtkTreeViewColumnPrivate *priv;
2974 GdkRectangle zero_cell_area = { 0, };
2975 GdkRectangle allocation;
2977 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2978 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
2980 priv = tree_column->priv;
2982 /* FIXME: Could use a boolean return value for invalid cells */
2983 gtk_cell_area_get_cell_allocation (priv->cell_area,
2984 priv->cell_area_context,
2991 *x_offset = allocation.x;
2993 *width = allocation.width;
2999 * gtk_tree_view_column_queue_resize:
3000 * @tree_column: A #GtkTreeViewColumn
3002 * Flags the column, and the cell renderers added to this column, to have
3003 * their sizes renegotiated.
3008 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3010 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3012 if (tree_column->priv->tree_view)
3013 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3017 * gtk_tree_view_column_get_tree_view:
3018 * @tree_column: A #GtkTreeViewColumn
3020 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3021 * If @column is currently not inserted in any tree view, %NULL is
3024 * Return value: (transfer none): The tree view wherein @column has
3025 * been inserted if any, %NULL otherwise.
3030 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3032 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3034 return tree_column->priv->tree_view;
3038 * gtk_tree_view_column_get_button:
3039 * @tree_column: A #GtkTreeViewColumn
3041 * Returns the button used in the treeview column header
3043 * Return value: (transfer none): The button for the column header.
3048 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3050 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3052 return tree_column->priv->button;
3056 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3058 return column->priv->window;
3062 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3065 column->priv->padding = MAX (column->priv->padding, padding);
3069 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3071 gint requested_width;
3073 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3075 return requested_width + column->priv->padding;
3080 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3083 column->priv->resized_width = width;
3087 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3089 return column->priv->resized_width;
3093 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3094 gboolean use_resized_width)
3096 column->priv->use_resized_width = use_resized_width;
3100 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3102 return column->priv->use_resized_width;
3106 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3108 return column->priv->drag_x;
3111 GtkCellAreaContext *
3112 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3114 return column->priv->cell_area_context;