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"
39 #include "gtktypebuiltins.h"
43 * SECTION:gtktreeviewcolumn
44 * @Short_description: A visible column in a GtkTreeView widget
45 * @Title: GtkTreeViewColumn
46 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
47 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
48 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
50 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
51 * It allows to set properties of the column header, and functions as a holding pen for
52 * the cell renderers which determine how the data in the column is displayed.
54 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
55 * for an overview of all the objects and data types related to the tree widget and how
61 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
64 static void gtk_tree_view_column_set_property (GObject *object,
68 static void gtk_tree_view_column_get_property (GObject *object,
72 static void gtk_tree_view_column_finalize (GObject *object);
73 static void gtk_tree_view_column_dispose (GObject *object);
74 static GObject *gtk_tree_view_column_constructor (GType type,
75 guint n_construct_properties,
76 GObjectConstructParam *construct_properties);
78 /* GtkCellLayout implementation */
79 static void gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
80 GtkCellArea *cell_area);
82 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
84 /* Button handling code */
85 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
86 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
88 /* Button signal handlers */
89 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
92 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
94 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
95 gboolean group_cycling,
98 /* Property handlers */
99 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
100 GtkTreeViewColumn *tree_column);
102 /* GtkCellArea/GtkCellAreaContext callbacks */
103 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
105 GtkTreeViewColumn *tree_column);
106 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
107 GtkCellRenderer *renderer,
108 GtkCellEditable *edit_widget,
109 GdkRectangle *cell_area,
110 const gchar *path_string,
112 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
113 GtkCellRenderer *renderer,
114 GtkCellEditable *edit_widget,
117 /* Internal functions */
118 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
120 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
121 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
122 GtkCellRenderer *cell_renderer,
125 /* GtkBuildable implementation */
126 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
129 struct _GtkTreeViewColumnPrivate
131 GtkWidget *tree_view;
135 GtkWidget *alignment;
138 gulong property_changed_signal;
141 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
142 GtkTreeViewColumnSizing column_type;
150 /* dragging columns */
157 gulong sort_clicked_signal;
158 gulong sort_column_changed_signal;
160 GtkSortType sort_order;
163 GtkCellArea *cell_area;
164 GtkCellAreaContext *cell_area_context;
165 gulong add_editable_signal;
166 gulong remove_editable_signal;
167 gulong context_changed_signal;
174 guint show_sort_indicator : 1;
175 guint maybe_reordered : 1;
176 guint reorderable : 1;
177 guint use_resized_width : 1;
210 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
212 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
213 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
214 gtk_tree_view_column_cell_layout_init)
215 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
216 gtk_tree_view_column_buildable_init))
220 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
222 GObjectClass *object_class;
224 object_class = (GObjectClass*) class;
226 class->clicked = NULL;
228 object_class->constructor = gtk_tree_view_column_constructor;
229 object_class->finalize = gtk_tree_view_column_finalize;
230 object_class->dispose = gtk_tree_view_column_dispose;
231 object_class->set_property = gtk_tree_view_column_set_property;
232 object_class->get_property = gtk_tree_view_column_get_property;
234 tree_column_signals[CLICKED] =
235 g_signal_new (I_("clicked"),
236 G_OBJECT_CLASS_TYPE (object_class),
238 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
240 _gtk_marshal_VOID__VOID,
243 g_object_class_install_property (object_class,
245 g_param_spec_boolean ("visible",
247 P_("Whether to display the column"),
249 GTK_PARAM_READWRITE));
251 g_object_class_install_property (object_class,
253 g_param_spec_boolean ("resizable",
255 P_("Column is user-resizable"),
257 GTK_PARAM_READWRITE));
259 g_object_class_install_property (object_class,
261 g_param_spec_int ("width",
263 P_("Current width of the column"),
267 GTK_PARAM_READABLE));
268 g_object_class_install_property (object_class,
270 g_param_spec_int ("spacing",
272 P_("Space which is inserted between cells"),
276 GTK_PARAM_READWRITE));
277 g_object_class_install_property (object_class,
279 g_param_spec_enum ("sizing",
281 P_("Resize mode of the column"),
282 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
283 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
284 GTK_PARAM_READWRITE));
286 g_object_class_install_property (object_class,
288 g_param_spec_int ("fixed-width",
290 P_("Current fixed width of the column"),
294 GTK_PARAM_READWRITE));
296 g_object_class_install_property (object_class,
298 g_param_spec_int ("min-width",
300 P_("Minimum allowed width of the column"),
304 GTK_PARAM_READWRITE));
306 g_object_class_install_property (object_class,
308 g_param_spec_int ("max-width",
310 P_("Maximum allowed width of the column"),
314 GTK_PARAM_READWRITE));
316 g_object_class_install_property (object_class,
318 g_param_spec_string ("title",
320 P_("Title to appear in column header"),
322 GTK_PARAM_READWRITE));
324 g_object_class_install_property (object_class,
326 g_param_spec_boolean ("expand",
328 P_("Column gets share of extra width allocated to the widget"),
330 GTK_PARAM_READWRITE));
332 g_object_class_install_property (object_class,
334 g_param_spec_boolean ("clickable",
336 P_("Whether the header can be clicked"),
338 GTK_PARAM_READWRITE));
341 g_object_class_install_property (object_class,
343 g_param_spec_object ("widget",
345 P_("Widget to put in column header button instead of column title"),
347 GTK_PARAM_READWRITE));
349 g_object_class_install_property (object_class,
351 g_param_spec_float ("alignment",
353 P_("X Alignment of the column header text or widget"),
357 GTK_PARAM_READWRITE));
359 g_object_class_install_property (object_class,
361 g_param_spec_boolean ("reorderable",
363 P_("Whether the column can be reordered around the headers"),
365 GTK_PARAM_READWRITE));
367 g_object_class_install_property (object_class,
369 g_param_spec_boolean ("sort-indicator",
370 P_("Sort indicator"),
371 P_("Whether to show a sort indicator"),
373 GTK_PARAM_READWRITE));
375 g_object_class_install_property (object_class,
377 g_param_spec_enum ("sort-order",
379 P_("Sort direction the sort indicator should indicate"),
382 GTK_PARAM_READWRITE));
385 * GtkTreeViewColumn:sort-column-id:
387 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
388 * clickable. Set to %-1 to make the column unsortable.
392 g_object_class_install_property (object_class,
394 g_param_spec_int ("sort-column-id",
395 P_("Sort column ID"),
396 P_("Logical sort column ID this column sorts on when selected for sorting"),
400 GTK_PARAM_READWRITE));
403 * GtkTreeViewColumn:cell-area:
405 * The #GtkCellArea used to layout cell renderers for this column.
407 * If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area()
408 * a horizontally oriented #GtkCellAreaBox will be used.
412 g_object_class_install_property (object_class,
414 g_param_spec_object ("cell-area",
416 P_("The GtkCellArea used to layout cells"),
418 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
420 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
424 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
427 const gchar *tagname,
430 /* Just ignore the boolean return from here */
431 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
435 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
437 iface->add_child = _gtk_cell_layout_buildable_add_child;
438 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
439 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
443 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
445 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
449 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
451 GtkTreeViewColumnPrivate *priv;
453 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
454 GTK_TYPE_TREE_VIEW_COLUMN,
455 GtkTreeViewColumnPrivate);
456 priv = tree_column->priv;
462 priv->min_width = -1;
463 priv->max_width = -1;
464 priv->resized_width = 0;
465 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
466 priv->visible = TRUE;
467 priv->resizable = FALSE;
468 priv->expand = FALSE;
469 priv->clickable = FALSE;
471 priv->sort_order = GTK_SORT_ASCENDING;
472 priv->show_sort_indicator = FALSE;
473 priv->property_changed_signal = 0;
474 priv->sort_clicked_signal = 0;
475 priv->sort_column_changed_signal = 0;
476 priv->sort_column_id = -1;
477 priv->reorderable = FALSE;
478 priv->maybe_reordered = FALSE;
479 priv->fixed_width = 1;
480 priv->use_resized_width = FALSE;
481 priv->title = g_strdup ("");
485 gtk_tree_view_column_constructor (GType type,
486 guint n_construct_properties,
487 GObjectConstructParam *construct_properties)
489 GtkTreeViewColumn *tree_column;
492 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
493 (type, n_construct_properties, construct_properties);
495 tree_column = (GtkTreeViewColumn *) object;
497 gtk_tree_view_column_ensure_cell_area (tree_column, NULL);
503 gtk_tree_view_column_dispose (GObject *object)
505 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
506 GtkTreeViewColumnPrivate *priv = tree_column->priv;
508 if (priv->cell_area_context)
510 g_signal_handler_disconnect (priv->cell_area_context,
511 priv->context_changed_signal);
513 g_object_unref (priv->cell_area_context);
515 priv->cell_area_context = NULL;
516 priv->context_changed_signal = 0;
521 g_signal_handler_disconnect (priv->cell_area,
522 priv->add_editable_signal);
523 g_signal_handler_disconnect (priv->cell_area,
524 priv->remove_editable_signal);
526 g_object_unref (priv->cell_area);
527 priv->cell_area = NULL;
528 priv->add_editable_signal = 0;
529 priv->remove_editable_signal = 0;
534 g_object_unref (priv->child);
538 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
542 gtk_tree_view_column_finalize (GObject *object)
544 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
545 GtkTreeViewColumnPrivate *priv = tree_column->priv;
547 g_free (priv->title);
549 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
553 gtk_tree_view_column_set_property (GObject *object,
558 GtkTreeViewColumn *tree_column;
561 tree_column = GTK_TREE_VIEW_COLUMN (object);
566 gtk_tree_view_column_set_visible (tree_column,
567 g_value_get_boolean (value));
571 gtk_tree_view_column_set_resizable (tree_column,
572 g_value_get_boolean (value));
576 gtk_tree_view_column_set_sizing (tree_column,
577 g_value_get_enum (value));
580 case PROP_FIXED_WIDTH:
581 gtk_tree_view_column_set_fixed_width (tree_column,
582 g_value_get_int (value));
586 gtk_tree_view_column_set_min_width (tree_column,
587 g_value_get_int (value));
591 gtk_tree_view_column_set_max_width (tree_column,
592 g_value_get_int (value));
596 gtk_tree_view_column_set_spacing (tree_column,
597 g_value_get_int (value));
601 gtk_tree_view_column_set_title (tree_column,
602 g_value_get_string (value));
606 gtk_tree_view_column_set_expand (tree_column,
607 g_value_get_boolean (value));
611 gtk_tree_view_column_set_clickable (tree_column,
612 g_value_get_boolean (value));
616 gtk_tree_view_column_set_widget (tree_column,
617 (GtkWidget*) g_value_get_object (value));
621 gtk_tree_view_column_set_alignment (tree_column,
622 g_value_get_float (value));
625 case PROP_REORDERABLE:
626 gtk_tree_view_column_set_reorderable (tree_column,
627 g_value_get_boolean (value));
630 case PROP_SORT_INDICATOR:
631 gtk_tree_view_column_set_sort_indicator (tree_column,
632 g_value_get_boolean (value));
635 case PROP_SORT_ORDER:
636 gtk_tree_view_column_set_sort_order (tree_column,
637 g_value_get_enum (value));
640 case PROP_SORT_COLUMN_ID:
641 gtk_tree_view_column_set_sort_column_id (tree_column,
642 g_value_get_int (value));
646 /* Construct-only, can only be assigned once */
647 area = g_value_get_object (value);
651 if (tree_column->priv->cell_area != NULL)
653 g_warning ("cell-area has already been set, ignoring construct property");
654 g_object_ref_sink (area);
655 g_object_unref (area);
658 gtk_tree_view_column_ensure_cell_area (tree_column, area);
663 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
669 gtk_tree_view_column_get_property (GObject *object,
674 GtkTreeViewColumn *tree_column;
676 tree_column = GTK_TREE_VIEW_COLUMN (object);
681 g_value_set_boolean (value,
682 gtk_tree_view_column_get_visible (tree_column));
686 g_value_set_boolean (value,
687 gtk_tree_view_column_get_resizable (tree_column));
691 g_value_set_int (value,
692 gtk_tree_view_column_get_width (tree_column));
696 g_value_set_int (value,
697 gtk_tree_view_column_get_spacing (tree_column));
701 g_value_set_enum (value,
702 gtk_tree_view_column_get_sizing (tree_column));
705 case PROP_FIXED_WIDTH:
706 g_value_set_int (value,
707 gtk_tree_view_column_get_fixed_width (tree_column));
711 g_value_set_int (value,
712 gtk_tree_view_column_get_min_width (tree_column));
716 g_value_set_int (value,
717 gtk_tree_view_column_get_max_width (tree_column));
721 g_value_set_string (value,
722 gtk_tree_view_column_get_title (tree_column));
726 g_value_set_boolean (value,
727 gtk_tree_view_column_get_expand (tree_column));
731 g_value_set_boolean (value,
732 gtk_tree_view_column_get_clickable (tree_column));
736 g_value_set_object (value,
737 (GObject*) gtk_tree_view_column_get_widget (tree_column));
741 g_value_set_float (value,
742 gtk_tree_view_column_get_alignment (tree_column));
745 case PROP_REORDERABLE:
746 g_value_set_boolean (value,
747 gtk_tree_view_column_get_reorderable (tree_column));
750 case PROP_SORT_INDICATOR:
751 g_value_set_boolean (value,
752 gtk_tree_view_column_get_sort_indicator (tree_column));
755 case PROP_SORT_ORDER:
756 g_value_set_enum (value,
757 gtk_tree_view_column_get_sort_order (tree_column));
760 case PROP_SORT_COLUMN_ID:
761 g_value_set_int (value,
762 gtk_tree_view_column_get_sort_column_id (tree_column));
766 g_value_set_object (value, tree_column->priv->cell_area);
770 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
775 /* Implementation of GtkCellLayout interface
779 gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
780 GtkCellArea *cell_area)
782 GtkTreeViewColumnPrivate *priv = column->priv;
788 priv->cell_area = cell_area;
790 priv->cell_area = gtk_cell_area_box_new ();
792 g_object_ref_sink (priv->cell_area);
794 priv->add_editable_signal =
795 g_signal_connect (priv->cell_area, "add-editable",
796 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
798 priv->remove_editable_signal =
799 g_signal_connect (priv->cell_area, "remove-editable",
800 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
803 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
805 priv->context_changed_signal =
806 g_signal_connect (priv->cell_area_context, "notify",
807 G_CALLBACK (gtk_tree_view_column_context_changed),
812 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
814 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
815 GtkTreeViewColumnPrivate *priv = column->priv;
817 if (G_UNLIKELY (!priv->cell_area))
818 gtk_tree_view_column_ensure_cell_area (column, NULL);
820 return priv->cell_area;
823 /* Button handling code
826 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
828 GtkTreeViewColumnPrivate *priv = tree_column->priv;
829 GtkTreeView *tree_view;
833 tree_view = (GtkTreeView *) priv->tree_view;
835 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
836 g_return_if_fail (priv->button == NULL);
838 gtk_widget_push_composite_child ();
839 priv->button = gtk_button_new ();
840 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
841 gtk_widget_pop_composite_child ();
843 /* make sure we own a reference to it as well. */
844 if (_gtk_tree_view_get_header_window (tree_view))
845 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
847 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
849 g_signal_connect (priv->button, "event",
850 G_CALLBACK (gtk_tree_view_column_button_event),
852 g_signal_connect (priv->button, "clicked",
853 G_CALLBACK (gtk_tree_view_column_button_clicked),
856 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
858 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
859 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
865 child = gtk_label_new (priv->title);
866 gtk_widget_show (child);
869 g_signal_connect (child, "mnemonic-activate",
870 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
873 if (priv->xalign <= 0.5)
874 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
876 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
878 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
880 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
881 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
883 gtk_widget_show (hbox);
884 gtk_widget_show (priv->alignment);
885 gtk_tree_view_column_update_button (tree_column);
889 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
891 GtkTreeViewColumnPrivate *priv = tree_column->priv;
892 gint sort_column_id = -1;
894 GtkWidget *alignment;
896 GtkWidget *current_child;
897 GtkArrowType arrow_type = GTK_ARROW_NONE;
901 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
905 /* Create a button if necessary */
907 priv->button == NULL &&
909 gtk_widget_get_realized (priv->tree_view))
910 gtk_tree_view_column_create_button (tree_column);
915 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
916 alignment = priv->alignment;
918 current_child = gtk_bin_get_child (GTK_BIN (alignment));
920 /* Set up the actual button */
921 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
926 if (current_child != priv->child)
928 gtk_container_remove (GTK_CONTAINER (alignment),
930 gtk_container_add (GTK_CONTAINER (alignment),
936 if (current_child == NULL)
938 current_child = gtk_label_new (NULL);
939 gtk_widget_show (current_child);
940 gtk_container_add (GTK_CONTAINER (alignment),
944 g_return_if_fail (GTK_IS_LABEL (current_child));
947 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
950 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
954 if (GTK_IS_TREE_SORTABLE (model))
955 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
959 if (priv->show_sort_indicator)
961 gboolean alternative;
963 g_object_get (gtk_widget_get_settings (priv->tree_view),
964 "gtk-alternative-sort-arrows", &alternative,
967 switch (priv->sort_order)
969 case GTK_SORT_ASCENDING:
970 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
973 case GTK_SORT_DESCENDING:
974 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
978 g_warning (G_STRLOC": bad sort order");
983 gtk_arrow_set (GTK_ARROW (arrow),
987 /* Put arrow on the right if the text is left-or-center justified, and on the
988 * left otherwise; do this by packing boxes, so flipping text direction will
991 g_object_ref (arrow);
992 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
994 if (priv->xalign <= 0.5)
996 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1000 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1001 /* move it to the front */
1002 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
1004 g_object_unref (arrow);
1006 if (priv->show_sort_indicator
1007 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
1008 gtk_widget_show (arrow);
1010 gtk_widget_hide (arrow);
1012 /* It's always safe to hide the button. It isn't always safe to show it, as
1013 * if you show it before it's realized, it'll get the wrong window. */
1015 priv->tree_view != NULL &&
1016 gtk_widget_get_realized (priv->tree_view))
1020 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
1021 gtk_widget_show_now (priv->button);
1025 if (priv->resizable)
1027 gdk_window_show (priv->window);
1028 gdk_window_raise (priv->window);
1032 gdk_window_hide (priv->window);
1038 gtk_widget_hide (priv->button);
1040 gdk_window_hide (priv->window);
1044 if (priv->reorderable || priv->clickable)
1046 gtk_widget_set_can_focus (priv->button, TRUE);
1050 gtk_widget_set_can_focus (priv->button, FALSE);
1051 if (gtk_widget_has_focus (priv->button))
1053 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1054 if (gtk_widget_is_toplevel (toplevel))
1056 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1060 /* Queue a resize on the assumption that we always want to catch all changes
1061 * and columns don't change all that often.
1063 if (gtk_widget_get_realized (priv->tree_view))
1064 gtk_widget_queue_resize (priv->tree_view);
1068 /* Button signal handlers
1072 gtk_tree_view_column_button_event (GtkWidget *widget,
1076 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1077 GtkTreeViewColumnPrivate *priv = column->priv;
1079 g_return_val_if_fail (event != NULL, FALSE);
1081 if (event->type == GDK_BUTTON_PRESS &&
1082 priv->reorderable &&
1083 ((GdkEventButton *)event)->button == 1)
1085 priv->maybe_reordered = TRUE;
1086 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1090 gtk_widget_grab_focus (widget);
1093 if (event->type == GDK_BUTTON_RELEASE ||
1094 event->type == GDK_LEAVE_NOTIFY)
1095 priv->maybe_reordered = FALSE;
1097 if (event->type == GDK_MOTION_NOTIFY &&
1098 priv->maybe_reordered &&
1099 (gtk_drag_check_threshold (widget,
1102 (gint) ((GdkEventMotion *)event)->x,
1103 (gint) ((GdkEventMotion *)event)->y)))
1105 priv->maybe_reordered = FALSE;
1106 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1107 event->motion.device);
1111 if (priv->clickable == FALSE)
1113 switch (event->type)
1115 case GDK_BUTTON_PRESS:
1116 case GDK_2BUTTON_PRESS:
1117 case GDK_3BUTTON_PRESS:
1118 case GDK_MOTION_NOTIFY:
1119 case GDK_BUTTON_RELEASE:
1120 case GDK_ENTER_NOTIFY:
1121 case GDK_LEAVE_NOTIFY:
1132 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1134 g_signal_emit_by_name (data, "clicked");
1138 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1139 gboolean group_cycling,
1142 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1143 GtkTreeViewColumnPrivate *priv = column->priv;
1145 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1147 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1149 if (priv->clickable)
1150 gtk_button_clicked (GTK_BUTTON (priv->button));
1151 else if (gtk_widget_get_can_focus (priv->button))
1152 gtk_widget_grab_focus (priv->button);
1154 gtk_widget_grab_focus (priv->tree_view);
1160 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1161 GtkTreeViewColumn *column)
1163 GtkTreeViewColumnPrivate *priv = column->priv;
1164 gint sort_column_id;
1167 if (gtk_tree_sortable_get_sort_column_id (sortable,
1171 if (sort_column_id == priv->sort_column_id)
1173 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1174 gtk_tree_view_column_set_sort_order (column, order);
1178 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1183 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1188 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1191 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1192 GtkTreeModel *model;
1193 GtkTreeSortable *sortable;
1194 gint sort_column_id;
1196 gboolean has_sort_column;
1197 gboolean has_default_sort_func;
1199 g_return_if_fail (priv->tree_view != NULL);
1201 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1202 sortable = GTK_TREE_SORTABLE (model);
1205 gtk_tree_sortable_get_sort_column_id (sortable,
1208 has_default_sort_func =
1209 gtk_tree_sortable_has_default_sort_func (sortable);
1211 if (has_sort_column &&
1212 sort_column_id == priv->sort_column_id)
1214 if (order == GTK_SORT_ASCENDING)
1215 gtk_tree_sortable_set_sort_column_id (sortable,
1216 priv->sort_column_id,
1217 GTK_SORT_DESCENDING);
1218 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1219 gtk_tree_sortable_set_sort_column_id (sortable,
1220 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1221 GTK_SORT_ASCENDING);
1223 gtk_tree_sortable_set_sort_column_id (sortable,
1224 priv->sort_column_id,
1225 GTK_SORT_ASCENDING);
1229 gtk_tree_sortable_set_sort_column_id (sortable,
1230 priv->sort_column_id,
1231 GTK_SORT_ASCENDING);
1236 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1238 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1239 GtkTreeModel *model;
1241 if (priv->tree_view == NULL)
1244 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1249 if (GTK_IS_TREE_SORTABLE (model) &&
1250 priv->sort_column_id != -1)
1252 gint real_sort_column_id;
1253 GtkSortType real_order;
1255 if (priv->sort_column_changed_signal == 0)
1256 priv->sort_column_changed_signal =
1257 g_signal_connect (model, "sort-column-changed",
1258 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1261 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1262 &real_sort_column_id,
1264 (real_sort_column_id == priv->sort_column_id))
1266 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1267 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1271 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1277 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1279 GtkTreeViewColumn *tree_column)
1281 /* Here we want the column re-requested if the underlying context was
1282 * actually reset for any reason, this can happen if the underlying
1283 * area/cell configuration changes (i.e. cell packing properties
1284 * or cell spacing and the like)
1286 * Note that we block this handler while requesting for sizes
1287 * so there is no need to check for the new context size being -1,
1288 * we also block the handler when explicitly resetting the context
1289 * so as to avoid some infinite stack recursion.
1291 if (!strcmp (pspec->name, "minimum-width") ||
1292 !strcmp (pspec->name, "natural-width") ||
1293 !strcmp (pspec->name, "minimum-height") ||
1294 !strcmp (pspec->name, "natural-height"))
1295 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1299 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1300 GtkCellRenderer *renderer,
1301 GtkCellEditable *edit_widget,
1302 GdkRectangle *cell_area,
1303 const gchar *path_string,
1306 GtkTreeViewColumn *column = user_data;
1307 GtkTreeViewColumnPrivate *priv = column->priv;
1310 if (priv->tree_view)
1312 path = gtk_tree_path_new_from_string (path_string);
1314 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1320 gtk_tree_path_free (path);
1325 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1326 GtkCellRenderer *renderer,
1327 GtkCellEditable *edit_widget,
1330 GtkTreeViewColumn *column = user_data;
1331 GtkTreeViewColumnPrivate *priv = column->priv;
1333 if (priv->tree_view)
1334 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1339 /* Exported Private Functions.
1340 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1343 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1345 GtkTreeViewColumnPrivate *priv = column->priv;
1346 GtkAllocation allocation;
1347 GtkTreeView *tree_view;
1349 guint attributes_mask;
1352 tree_view = (GtkTreeView *)priv->tree_view;
1353 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1355 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1356 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1357 g_return_if_fail (priv->button != NULL);
1359 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1360 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1362 attr.window_type = GDK_WINDOW_CHILD;
1363 attr.wclass = GDK_INPUT_ONLY;
1364 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1365 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1366 (GDK_BUTTON_PRESS_MASK |
1367 GDK_BUTTON_RELEASE_MASK |
1368 GDK_POINTER_MOTION_MASK |
1369 GDK_POINTER_MOTION_HINT_MASK |
1370 GDK_KEY_PRESS_MASK);
1371 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1372 attr.cursor = gdk_cursor_new_for_display
1373 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1375 attr.width = TREE_VIEW_DRAG_WIDTH;
1376 attr.height = _gtk_tree_view_get_header_height (tree_view);
1378 gtk_widget_get_allocation (priv->button, &allocation);
1379 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1380 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1381 &attr, attributes_mask);
1382 gdk_window_set_user_data (priv->window, tree_view);
1384 gtk_tree_view_column_update_button (column);
1386 g_object_unref (attr.cursor);
1390 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1392 GtkTreeViewColumnPrivate *priv;
1394 g_return_if_fail (column != NULL);
1396 priv = column->priv;
1397 g_return_if_fail (priv->window != NULL);
1399 gdk_window_set_user_data (priv->window, NULL);
1400 gdk_window_destroy (priv->window);
1401 priv->window = NULL;
1405 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1406 GtkTreeModel *old_model)
1408 GtkTreeViewColumnPrivate *priv = column->priv;
1410 if (priv->sort_column_changed_signal)
1412 g_signal_handler_disconnect (old_model,
1413 priv->sort_column_changed_signal);
1414 priv->sort_column_changed_signal = 0;
1416 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1420 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1421 GtkTreeView *tree_view)
1423 GtkTreeViewColumnPrivate *priv = column->priv;
1425 g_assert (priv->tree_view == NULL);
1427 priv->tree_view = GTK_WIDGET (tree_view);
1428 gtk_tree_view_column_create_button (column);
1430 priv->property_changed_signal =
1431 g_signal_connect_swapped (tree_view,
1433 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1436 gtk_tree_view_column_setup_sort_column_id_callback (column);
1440 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1442 GtkTreeViewColumnPrivate *priv = column->priv;
1444 if (priv->tree_view && priv->button)
1446 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1448 if (priv->property_changed_signal)
1450 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1451 priv->property_changed_signal = 0;
1454 if (priv->sort_column_changed_signal)
1456 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1457 priv->sort_column_changed_signal);
1458 priv->sort_column_changed_signal = 0;
1461 priv->tree_view = NULL;
1462 priv->button = NULL;
1466 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1468 GtkTreeViewColumnPrivate *priv = column->priv;
1469 gboolean ret = FALSE;
1470 GList *list, *cells;
1472 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1474 for (list = cells; list; list = list->next)
1476 GtkCellRenderer *cell = list->data;
1477 GtkCellRendererMode mode;
1479 g_object_get (cell, "mode", &mode, NULL);
1481 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1488 g_list_free (cells);
1493 /* gets cell being edited */
1495 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1497 GtkTreeViewColumnPrivate *priv = column->priv;
1499 return gtk_cell_area_get_edited_cell (priv->cell_area);
1503 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1504 GdkRectangle *cell_area,
1505 GdkRectangle *background_area,
1509 GtkCellRenderer *match = NULL;
1510 GtkTreeViewColumnPrivate *priv = column->priv;
1512 /* If (x, y) is outside of the background area, immediately return */
1513 if (x < background_area->x ||
1514 x > background_area->x + background_area->width ||
1515 y < background_area->y ||
1516 y > background_area->y + background_area->height)
1519 /* If (x, y) is inside the background area, clamp it to the cell_area
1520 * so that a cell is still returned. The main reason for doing this
1521 * (on the x axis) is for handling clicks in the indentation area
1522 * (either at the left or right depending on RTL setting). Another
1523 * reason is for handling clicks on the area where the focus rectangle
1524 * is drawn (this is outside of cell area), this manifests itself
1525 * mainly when a large setting is used for focus-line-width.
1527 if (x < cell_area->x)
1529 else if (x > cell_area->x + cell_area->width)
1530 x = cell_area->x + cell_area->width;
1532 if (y < cell_area->y)
1534 else if (y > cell_area->y + cell_area->height)
1535 y = cell_area->y + cell_area->height;
1537 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1538 priv->cell_area_context,
1548 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1549 GdkRectangle *cell_area,
1550 GdkRectangle *background_area,
1554 GtkCellRenderer *match;
1555 GdkRectangle cell_alloc, aligned_area, inner_area;
1556 GtkTreeViewColumnPrivate *priv = column->priv;
1558 match = _gtk_tree_view_column_get_cell_at_pos (column,
1565 gtk_cell_area_get_cell_allocation (priv->cell_area,
1566 priv->cell_area_context,
1572 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1573 &cell_alloc, &inner_area);
1574 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1575 &inner_area, &aligned_area);
1577 if (x < aligned_area.x ||
1578 x > aligned_area.x + aligned_area.width ||
1579 y < aligned_area.y ||
1580 y > aligned_area.y + aligned_area.height)
1586 /* Public Functions */
1590 * gtk_tree_view_column_new:
1592 * Creates a new #GtkTreeViewColumn.
1594 * Return value: A newly created #GtkTreeViewColumn.
1597 gtk_tree_view_column_new (void)
1599 GtkTreeViewColumn *tree_column;
1601 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1607 * gtk_tree_view_column_new_with_area:
1608 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1610 * Creates a new #GtkTreeViewColumn using @area to render its cells.
1612 * Return value: A newly created #GtkTreeViewColumn.
1617 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1619 GtkTreeViewColumn *tree_column;
1621 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1628 * gtk_tree_view_column_new_with_attributes:
1629 * @title: The title to set the header to.
1630 * @cell: The #GtkCellRenderer.
1631 * @Varargs: A %NULL-terminated list of attributes.
1633 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1634 * equivalent to calling gtk_tree_view_column_set_title(),
1635 * gtk_tree_view_column_pack_start(), and
1636 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1638 * Here's a simple example:
1640 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1643 * GtkTreeViewColumn *column;
1644 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1646 * column = gtk_tree_view_column_new_with_attributes ("Title",
1648 * "text", TEXT_COLUMN,
1649 * "foreground", COLOR_COLUMN,
1654 * Return value: A newly created #GtkTreeViewColumn.
1657 gtk_tree_view_column_new_with_attributes (const gchar *title,
1658 GtkCellRenderer *cell,
1661 GtkTreeViewColumn *retval;
1664 retval = gtk_tree_view_column_new ();
1666 gtk_tree_view_column_set_title (retval, title);
1667 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1669 va_start (args, cell);
1670 gtk_tree_view_column_set_attributesv (retval, cell, args);
1677 * gtk_tree_view_column_pack_start:
1678 * @tree_column: A #GtkTreeViewColumn.
1679 * @cell: The #GtkCellRenderer.
1680 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1682 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1683 * the @cell is allocated no more space than it needs. Any unused space is divided
1684 * evenly between cells for which @expand is %TRUE.
1687 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1688 GtkCellRenderer *cell,
1691 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1695 * gtk_tree_view_column_pack_end:
1696 * @tree_column: A #GtkTreeViewColumn.
1697 * @cell: The #GtkCellRenderer.
1698 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1700 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1701 * is allocated no more space than it needs. Any unused space is divided
1702 * evenly between cells for which @expand is %TRUE.
1705 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1706 GtkCellRenderer *cell,
1709 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1713 * gtk_tree_view_column_clear:
1714 * @tree_column: A #GtkTreeViewColumn
1716 * Unsets all the mappings on all renderers on the @tree_column.
1719 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1721 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1725 * gtk_tree_view_column_add_attribute:
1726 * @tree_column: A #GtkTreeViewColumn.
1727 * @cell_renderer: the #GtkCellRenderer to set attributes on
1728 * @attribute: An attribute on the renderer
1729 * @column: The column position on the model to get the attribute from.
1731 * Adds an attribute mapping to the list in @tree_column. The @column is the
1732 * column of the model to get a value from, and the @attribute is the
1733 * parameter on @cell_renderer to be set from the value. So for example
1734 * if column 2 of the model contains strings, you could have the
1735 * "text" attribute of a #GtkCellRendererText get its values from
1739 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1740 GtkCellRenderer *cell_renderer,
1741 const gchar *attribute,
1744 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1745 cell_renderer, attribute, column);
1749 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1750 GtkCellRenderer *cell_renderer,
1753 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1757 attribute = va_arg (args, gchar *);
1759 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1762 while (attribute != NULL)
1764 column = va_arg (args, gint);
1765 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1766 cell_renderer, attribute, column);
1767 attribute = va_arg (args, gchar *);
1772 * gtk_tree_view_column_set_attributes:
1773 * @tree_column: A #GtkTreeViewColumn.
1774 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1775 * @Varargs: A %NULL-terminated list of attributes.
1777 * Sets the attributes in the list as the attributes of @tree_column.
1778 * The attributes should be in attribute/column order, as in
1779 * gtk_tree_view_column_add_attribute(). All existing attributes
1780 * are removed, and replaced with the new attributes.
1783 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1784 GtkCellRenderer *cell_renderer,
1789 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1790 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1792 va_start (args, cell_renderer);
1793 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1799 * gtk_tree_view_column_set_cell_data_func:
1800 * @tree_column: A #GtkTreeViewColumn
1801 * @cell_renderer: A #GtkCellRenderer
1802 * @func: (allow-none): The #GtkTreeViewColumnFunc to use.
1803 * @func_data: The user data for @func.
1804 * @destroy: The destroy notification for @func_data
1806 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1807 * function is used instead of the standard attributes mapping for
1808 * setting the column value, and should set the value of @tree_column's
1809 * cell renderer as appropriate. @func may be %NULL to remove an
1813 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1814 GtkCellRenderer *cell_renderer,
1815 GtkTreeCellDataFunc func,
1817 GDestroyNotify destroy)
1819 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1821 (GtkCellLayoutDataFunc)func,
1822 func_data, destroy);
1827 * gtk_tree_view_column_clear_attributes:
1828 * @tree_column: a #GtkTreeViewColumn
1829 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1831 * Clears all existing attributes previously set with
1832 * gtk_tree_view_column_set_attributes().
1835 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1836 GtkCellRenderer *cell_renderer)
1838 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1843 * gtk_tree_view_column_set_spacing:
1844 * @tree_column: A #GtkTreeViewColumn.
1845 * @spacing: distance between cell renderers in pixels.
1847 * Sets the spacing field of @tree_column, which is the number of pixels to
1848 * place between cell renderers packed into it.
1851 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1854 GtkTreeViewColumnPrivate *priv;
1856 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1857 g_return_if_fail (spacing >= 0);
1859 priv = tree_column->priv;
1861 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1863 if (priv->tree_view)
1864 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1868 * gtk_tree_view_column_get_spacing:
1869 * @tree_column: A #GtkTreeViewColumn.
1871 * Returns the spacing of @tree_column.
1873 * Return value: the spacing of @tree_column.
1876 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1878 GtkTreeViewColumnPrivate *priv;
1880 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1882 priv = tree_column->priv;
1884 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1887 /* Options for manipulating the columns */
1890 * gtk_tree_view_column_set_visible:
1891 * @tree_column: A #GtkTreeViewColumn.
1892 * @visible: %TRUE if the @tree_column is visible.
1894 * Sets the visibility of @tree_column.
1897 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1900 GtkTreeViewColumnPrivate *priv;
1902 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1904 priv = tree_column->priv;
1905 visible = !! visible;
1907 if (priv->visible == visible)
1910 priv->visible = visible;
1913 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1915 if (priv->tree_view)
1916 _gtk_tree_view_reset_header_styles (GTK_TREE_VIEW (priv->tree_view));
1918 gtk_tree_view_column_update_button (tree_column);
1919 g_object_notify (G_OBJECT (tree_column), "visible");
1923 * gtk_tree_view_column_get_visible:
1924 * @tree_column: A #GtkTreeViewColumn.
1926 * Returns %TRUE if @tree_column is visible.
1928 * Return value: whether the column is visible or not. If it is visible, then
1929 * the tree will show the column.
1932 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1934 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1936 return tree_column->priv->visible;
1940 * gtk_tree_view_column_set_resizable:
1941 * @tree_column: A #GtkTreeViewColumn
1942 * @resizable: %TRUE, if the column can be resized
1944 * If @resizable is %TRUE, then the user can explicitly resize the column by
1945 * grabbing the outer edge of the column button. If resizable is %TRUE and
1946 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1947 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1950 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1953 GtkTreeViewColumnPrivate *priv;
1955 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1957 priv = tree_column->priv;
1958 resizable = !! resizable;
1960 if (priv->resizable == resizable)
1963 priv->resizable = resizable;
1965 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1966 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1968 gtk_tree_view_column_update_button (tree_column);
1970 g_object_notify (G_OBJECT (tree_column), "resizable");
1974 * gtk_tree_view_column_get_resizable:
1975 * @tree_column: A #GtkTreeViewColumn
1977 * Returns %TRUE if the @tree_column can be resized by the end user.
1979 * Return value: %TRUE, if the @tree_column can be resized.
1982 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1984 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1986 return tree_column->priv->resizable;
1991 * gtk_tree_view_column_set_sizing:
1992 * @tree_column: A #GtkTreeViewColumn.
1993 * @type: The #GtkTreeViewColumnSizing.
1995 * Sets the growth behavior of @tree_column to @type.
1998 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1999 GtkTreeViewColumnSizing type)
2001 GtkTreeViewColumnPrivate *priv;
2003 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2005 priv = tree_column->priv;
2007 if (type == priv->column_type)
2010 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2011 gtk_tree_view_column_set_resizable (tree_column, FALSE);
2013 priv->column_type = type;
2015 gtk_tree_view_column_update_button (tree_column);
2017 g_object_notify (G_OBJECT (tree_column), "sizing");
2021 * gtk_tree_view_column_get_sizing:
2022 * @tree_column: A #GtkTreeViewColumn.
2024 * Returns the current type of @tree_column.
2026 * Return value: The type of @tree_column.
2028 GtkTreeViewColumnSizing
2029 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
2031 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2033 return tree_column->priv->column_type;
2037 * gtk_tree_view_column_get_width:
2038 * @tree_column: A #GtkTreeViewColumn.
2040 * Returns the current size of @tree_column in pixels.
2042 * Return value: The current width of @tree_column.
2045 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2047 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2049 return tree_column->priv->width;
2053 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2055 GtkTreeViewColumnPrivate *priv;
2056 gint real_requested_width;
2058 priv = tree_column->priv;
2060 if (priv->use_resized_width)
2062 real_requested_width = priv->resized_width;
2064 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2066 real_requested_width = priv->fixed_width;
2068 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2070 gint button_request;
2071 gint requested_width;
2073 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2074 requested_width += priv->padding;
2076 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2077 real_requested_width = MAX (requested_width, button_request);
2081 gint requested_width;
2083 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2084 requested_width += priv->padding;
2086 real_requested_width = requested_width;
2087 if (real_requested_width < 0)
2088 real_requested_width = 0;
2091 if (priv->min_width != -1)
2092 real_requested_width = MAX (real_requested_width, priv->min_width);
2094 if (priv->max_width != -1)
2095 real_requested_width = MIN (real_requested_width, priv->max_width);
2097 return real_requested_width;
2101 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2105 GtkTreeViewColumnPrivate *priv;
2106 GtkAllocation allocation;
2109 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2111 priv = tree_column->priv;
2113 priv->width = width;
2115 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2117 allocation.x = x_offset;
2119 allocation.width = width;
2120 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2122 gtk_widget_size_allocate (priv->button, &allocation);
2126 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2127 gdk_window_move_resize (priv->window,
2128 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2130 TREE_VIEW_DRAG_WIDTH, allocation.height);
2133 g_object_notify (G_OBJECT (tree_column), "width");
2137 * gtk_tree_view_column_set_fixed_width:
2138 * @tree_column: A #GtkTreeViewColumn.
2139 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2141 * Sets the size of the column in pixels. This is meaningful only if the sizing
2142 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2143 * the min/max width for the column. Please note that the min/max width of the
2144 * column doesn't actually affect the "fixed_width" property of the widget, just
2145 * the actual size when displayed.
2148 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2151 GtkTreeViewColumnPrivate *priv;
2153 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2154 g_return_if_fail (fixed_width > 0);
2156 priv = tree_column->priv;
2158 priv->fixed_width = fixed_width;
2159 priv->use_resized_width = FALSE;
2161 if (priv->tree_view &&
2162 gtk_widget_get_realized (priv->tree_view) &&
2163 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2165 gtk_widget_queue_resize (priv->tree_view);
2168 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2172 * gtk_tree_view_column_get_fixed_width:
2173 * @tree_column: a #GtkTreeViewColumn
2175 * Gets the fixed width of the column. This value is only meaning may not be
2176 * the actual width of the column on the screen, just what is requested.
2178 * Return value: the fixed width of the column
2181 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2183 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2185 return tree_column->priv->fixed_width;
2189 * gtk_tree_view_column_set_min_width:
2190 * @tree_column: A #GtkTreeViewColumn.
2191 * @min_width: The minimum width of the column in pixels, or -1.
2193 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2194 * minimum width is unset.
2197 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2200 GtkTreeViewColumnPrivate *priv;
2202 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2203 g_return_if_fail (min_width >= -1);
2205 priv = tree_column->priv;
2207 if (min_width == priv->min_width)
2210 if (priv->visible &&
2211 priv->tree_view != NULL &&
2212 gtk_widget_get_realized (priv->tree_view))
2214 if (min_width > priv->width)
2215 gtk_widget_queue_resize (priv->tree_view);
2218 priv->min_width = min_width;
2219 g_object_freeze_notify (G_OBJECT (tree_column));
2220 if (priv->max_width != -1 && priv->max_width < min_width)
2222 priv->max_width = min_width;
2223 g_object_notify (G_OBJECT (tree_column), "max-width");
2225 g_object_notify (G_OBJECT (tree_column), "min-width");
2226 g_object_thaw_notify (G_OBJECT (tree_column));
2228 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2229 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2234 * gtk_tree_view_column_get_min_width:
2235 * @tree_column: A #GtkTreeViewColumn.
2237 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2240 * Return value: The minimum width of the @tree_column.
2243 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2245 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2247 return tree_column->priv->min_width;
2251 * gtk_tree_view_column_set_max_width:
2252 * @tree_column: A #GtkTreeViewColumn.
2253 * @max_width: The maximum width of the column in pixels, or -1.
2255 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2256 * maximum width is unset. Note, the column can actually be wider than max
2257 * width if it's the last column in a view. In this case, the column expands to
2258 * fill any extra space.
2261 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2264 GtkTreeViewColumnPrivate *priv;
2266 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2267 g_return_if_fail (max_width >= -1);
2269 priv = tree_column->priv;
2271 if (max_width == priv->max_width)
2274 if (priv->visible &&
2275 priv->tree_view != NULL &&
2276 gtk_widget_get_realized (priv->tree_view))
2278 if (max_width != -1 && max_width < priv->width)
2279 gtk_widget_queue_resize (priv->tree_view);
2282 priv->max_width = max_width;
2283 g_object_freeze_notify (G_OBJECT (tree_column));
2284 if (max_width != -1 && max_width < priv->min_width)
2286 priv->min_width = max_width;
2287 g_object_notify (G_OBJECT (tree_column), "min-width");
2289 g_object_notify (G_OBJECT (tree_column), "max-width");
2290 g_object_thaw_notify (G_OBJECT (tree_column));
2292 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2293 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2298 * gtk_tree_view_column_get_max_width:
2299 * @tree_column: A #GtkTreeViewColumn.
2301 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2304 * Return value: The maximum width of the @tree_column.
2307 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2309 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2311 return tree_column->priv->max_width;
2315 * gtk_tree_view_column_clicked:
2316 * @tree_column: a #GtkTreeViewColumn
2318 * Emits the "clicked" signal on the column. This function will only work if
2319 * @tree_column is clickable.
2322 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2324 GtkTreeViewColumnPrivate *priv;
2326 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2328 priv = tree_column->priv;
2330 if (priv->visible &&
2333 gtk_button_clicked (GTK_BUTTON (priv->button));
2337 * gtk_tree_view_column_set_title:
2338 * @tree_column: A #GtkTreeViewColumn.
2339 * @title: The title of the @tree_column.
2341 * Sets the title of the @tree_column. If a custom widget has been set, then
2342 * this value is ignored.
2345 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2348 GtkTreeViewColumnPrivate *priv;
2351 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2353 priv = tree_column->priv;
2355 new_title = g_strdup (title);
2356 g_free (priv->title);
2357 priv->title = new_title;
2359 gtk_tree_view_column_update_button (tree_column);
2360 g_object_notify (G_OBJECT (tree_column), "title");
2364 * gtk_tree_view_column_get_title:
2365 * @tree_column: A #GtkTreeViewColumn.
2367 * Returns the title of the widget.
2369 * Return value: the title of the column. This string should not be
2370 * modified or freed.
2372 G_CONST_RETURN gchar *
2373 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2375 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2377 return tree_column->priv->title;
2381 * gtk_tree_view_column_set_expand:
2382 * @tree_column: A #GtkTreeViewColumn
2383 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2385 * Sets the column to take available extra space. This space is shared equally
2386 * amongst all columns that have the expand set to %TRUE. If no column has this
2387 * option set, then the last column gets all extra space. By default, every
2388 * column is created with this %FALSE.
2393 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2396 GtkTreeViewColumnPrivate *priv;
2398 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2400 priv = tree_column->priv;
2402 expand = expand?TRUE:FALSE;
2403 if (priv->expand == expand)
2405 priv->expand = expand;
2407 if (priv->visible &&
2408 priv->tree_view != NULL &&
2409 gtk_widget_get_realized (priv->tree_view))
2411 /* We want to continue using the original width of the
2412 * column that includes additional space added by the user
2413 * resizing the columns and possibly extra (expanded) space, which
2414 * are not included in the resized width.
2416 priv->use_resized_width = FALSE;
2418 gtk_widget_queue_resize (priv->tree_view);
2421 g_object_notify (G_OBJECT (tree_column), "expand");
2425 * gtk_tree_view_column_get_expand:
2426 * @tree_column: a #GtkTreeViewColumn
2428 * Return %TRUE if the column expands to take any available space.
2430 * Return value: %TRUE, if the column expands
2435 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2437 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2439 return tree_column->priv->expand;
2443 * gtk_tree_view_column_set_clickable:
2444 * @tree_column: A #GtkTreeViewColumn.
2445 * @clickable: %TRUE if the header is active.
2447 * Sets the header to be active if @active is %TRUE. When the header is active,
2448 * then it can take keyboard focus, and can be clicked.
2451 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2454 GtkTreeViewColumnPrivate *priv;
2456 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2458 priv = tree_column->priv;
2460 clickable = !! clickable;
2461 if (priv->clickable == clickable)
2464 priv->clickable = clickable;
2465 gtk_tree_view_column_update_button (tree_column);
2466 g_object_notify (G_OBJECT (tree_column), "clickable");
2470 * gtk_tree_view_column_get_clickable:
2471 * @tree_column: a #GtkTreeViewColumn
2473 * Returns %TRUE if the user can click on the header for the column.
2475 * Return value: %TRUE if user can click the column header.
2478 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2480 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2482 return tree_column->priv->clickable;
2486 * gtk_tree_view_column_set_widget:
2487 * @tree_column: A #GtkTreeViewColumn.
2488 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2490 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2491 * header button is set with a #GtkLabel set to the title of @tree_column.
2494 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2497 GtkTreeViewColumnPrivate *priv;
2499 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2500 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2502 priv = tree_column->priv;
2505 g_object_ref_sink (widget);
2508 g_object_unref (priv->child);
2510 priv->child = widget;
2511 gtk_tree_view_column_update_button (tree_column);
2512 g_object_notify (G_OBJECT (tree_column), "widget");
2516 * gtk_tree_view_column_get_widget:
2517 * @tree_column: A #GtkTreeViewColumn.
2519 * Returns the #GtkWidget in the button on the column header.
2520 * If a custom widget has not been set then %NULL is returned.
2522 * Return value: (transfer none): The #GtkWidget in the column
2526 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2528 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2530 return tree_column->priv->child;
2534 * gtk_tree_view_column_set_alignment:
2535 * @tree_column: A #GtkTreeViewColumn.
2536 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2538 * Sets the alignment of the title or custom widget inside the column header.
2539 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2540 * for center, 1.0 for right.
2543 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2546 GtkTreeViewColumnPrivate *priv;
2548 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2550 priv = tree_column->priv;
2552 xalign = CLAMP (xalign, 0.0, 1.0);
2554 if (priv->xalign == xalign)
2557 priv->xalign = xalign;
2558 gtk_tree_view_column_update_button (tree_column);
2559 g_object_notify (G_OBJECT (tree_column), "alignment");
2563 * gtk_tree_view_column_get_alignment:
2564 * @tree_column: A #GtkTreeViewColumn.
2566 * Returns the current x alignment of @tree_column. This value can range
2567 * between 0.0 and 1.0.
2569 * Return value: The current alignent of @tree_column.
2572 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2574 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2576 return tree_column->priv->xalign;
2580 * gtk_tree_view_column_set_reorderable:
2581 * @tree_column: A #GtkTreeViewColumn
2582 * @reorderable: %TRUE, if the column can be reordered.
2584 * If @reorderable is %TRUE, then the column can be reordered by the end user
2585 * dragging the header.
2588 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2589 gboolean reorderable)
2591 GtkTreeViewColumnPrivate *priv;
2593 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2595 priv = tree_column->priv;
2598 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2600 if (priv->reorderable == (reorderable?TRUE:FALSE))
2603 priv->reorderable = (reorderable?TRUE:FALSE);
2604 gtk_tree_view_column_update_button (tree_column);
2605 g_object_notify (G_OBJECT (tree_column), "reorderable");
2609 * gtk_tree_view_column_get_reorderable:
2610 * @tree_column: A #GtkTreeViewColumn
2612 * Returns %TRUE if the @tree_column can be reordered by the user.
2614 * Return value: %TRUE if the @tree_column can be reordered by the user.
2617 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2619 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2621 return tree_column->priv->reorderable;
2626 * gtk_tree_view_column_set_sort_column_id:
2627 * @tree_column: a #GtkTreeViewColumn
2628 * @sort_column_id: The @sort_column_id of the model to sort on.
2630 * Sets the logical @sort_column_id that this column sorts on when this column
2631 * is selected for sorting. Doing so makes the column header clickable.
2634 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2635 gint sort_column_id)
2637 GtkTreeViewColumnPrivate *priv;
2639 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2640 g_return_if_fail (sort_column_id >= -1);
2642 priv = tree_column->priv;
2644 if (priv->sort_column_id == sort_column_id)
2647 priv->sort_column_id = sort_column_id;
2649 /* Handle unsetting the id */
2650 if (sort_column_id == -1)
2652 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2654 if (priv->sort_clicked_signal)
2656 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2657 priv->sort_clicked_signal = 0;
2660 if (priv->sort_column_changed_signal)
2662 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2663 priv->sort_column_changed_signal = 0;
2666 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2667 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2668 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2669 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2673 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2675 if (! priv->sort_clicked_signal)
2676 priv->sort_clicked_signal = g_signal_connect (tree_column,
2678 G_CALLBACK (gtk_tree_view_column_sort),
2681 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2682 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2686 * gtk_tree_view_column_get_sort_column_id:
2687 * @tree_column: a #GtkTreeViewColumn
2689 * Gets the logical @sort_column_id that the model sorts on when this
2690 * column is selected for sorting.
2691 * See gtk_tree_view_column_set_sort_column_id().
2693 * Return value: the current @sort_column_id for this column, or -1 if
2694 * this column can't be used for sorting.
2697 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2699 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2701 return tree_column->priv->sort_column_id;
2705 * gtk_tree_view_column_set_sort_indicator:
2706 * @tree_column: a #GtkTreeViewColumn
2707 * @setting: %TRUE to display an indicator that the column is sorted
2709 * Call this function with a @setting of %TRUE to display an arrow in
2710 * the header button indicating the column is sorted. Call
2711 * gtk_tree_view_column_set_sort_order() to change the direction of
2716 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2719 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2721 setting = setting != FALSE;
2723 if (setting == tree_column->priv->show_sort_indicator)
2726 tree_column->priv->show_sort_indicator = setting;
2727 gtk_tree_view_column_update_button (tree_column);
2728 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2732 * gtk_tree_view_column_get_sort_indicator:
2733 * @tree_column: a #GtkTreeViewColumn
2735 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2737 * Return value: whether the sort indicator arrow is displayed
2740 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2742 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2744 return tree_column->priv->show_sort_indicator;
2748 * gtk_tree_view_column_set_sort_order:
2749 * @tree_column: a #GtkTreeViewColumn
2750 * @order: sort order that the sort indicator should indicate
2752 * Changes the appearance of the sort indicator.
2754 * This <emphasis>does not</emphasis> actually sort the model. Use
2755 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2756 * support. This function is primarily for custom sorting behavior, and should
2757 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2758 * that. For custom models, the mechanism will vary.
2760 * The sort indicator changes direction to indicate normal sort or reverse sort.
2761 * Note that you must have the sort indicator enabled to see anything when
2762 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2765 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2768 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2770 if (order == tree_column->priv->sort_order)
2773 tree_column->priv->sort_order = order;
2774 gtk_tree_view_column_update_button (tree_column);
2775 g_object_notify (G_OBJECT (tree_column), "sort-order");
2779 * gtk_tree_view_column_get_sort_order:
2780 * @tree_column: a #GtkTreeViewColumn
2782 * Gets the value set by gtk_tree_view_column_set_sort_order().
2784 * Return value: the sort order the sort indicator is indicating
2787 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2789 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2791 return tree_column->priv->sort_order;
2795 * gtk_tree_view_column_cell_set_cell_data:
2796 * @tree_column: A #GtkTreeViewColumn.
2797 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2798 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2799 * @is_expander: %TRUE, if the row has children
2800 * @is_expanded: %TRUE, if the row has visible children
2802 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2803 * every attribute mapping in @tree_column, it will get a value from the set
2804 * column on the @iter, and use that value to set the attribute on the cell
2805 * renderer. This is used primarily by the #GtkTreeView.
2808 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2809 GtkTreeModel *tree_model,
2811 gboolean is_expander,
2812 gboolean is_expanded)
2814 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2816 if (tree_model == NULL)
2819 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2820 is_expander, is_expanded);
2824 * gtk_tree_view_column_cell_get_size:
2825 * @tree_column: A #GtkTreeViewColumn.
2826 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2827 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2828 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2829 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2830 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2832 * Obtains the width and height needed to render the column. This is used
2833 * primarily by the #GtkTreeView.
2836 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2837 const GdkRectangle *cell_area,
2843 GtkTreeViewColumnPrivate *priv;
2844 gint min_width = 0, min_height = 0;
2846 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2848 priv = tree_column->priv;
2850 g_signal_handler_block (priv->cell_area_context,
2851 priv->context_changed_signal);
2853 gtk_cell_area_get_preferred_width (priv->cell_area,
2854 priv->cell_area_context,
2858 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2860 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2861 priv->cell_area_context,
2867 g_signal_handler_unblock (priv->cell_area_context,
2868 priv->context_changed_signal);
2872 * height = min_height;
2874 * width = min_width;
2879 * gtk_tree_view_column_cell_render:
2880 * @tree_column: A #GtkTreeViewColumn.
2881 * @cr: cairo context to draw to
2882 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2883 * @cell_area: area normally rendered by a cell renderer
2884 * @flags: flags that affect rendering
2886 * Renders the cell contained by #tree_column. This is used primarily by the
2890 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2892 const GdkRectangle *background_area,
2893 const GdkRectangle *cell_area,
2895 gboolean draw_focus)
2897 GtkTreeViewColumnPrivate *priv;
2899 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2900 g_return_if_fail (cr != NULL);
2901 g_return_if_fail (background_area != NULL);
2902 g_return_if_fail (cell_area != NULL);
2904 priv = tree_column->priv;
2908 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2909 priv->tree_view, cr,
2910 background_area, cell_area, flags,
2917 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2919 const GdkRectangle *cell_area,
2922 GtkTreeViewColumnPrivate *priv;
2924 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2926 priv = tree_column->priv;
2928 return gtk_cell_area_event (priv->cell_area,
2929 priv->cell_area_context,
2937 * gtk_tree_view_column_cell_is_visible:
2938 * @tree_column: A #GtkTreeViewColumn
2940 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2941 * For this to be meaningful, you must first initialize the cells with
2942 * gtk_tree_view_column_cell_set_cell_data()
2944 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2947 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2951 GtkTreeViewColumnPrivate *priv;
2953 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2955 priv = tree_column->priv;
2957 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2958 for (list = cells; list; list = list->next)
2960 if (gtk_cell_renderer_get_visible (list->data))
2962 g_list_free (cells);
2967 g_list_free (cells);
2973 * gtk_tree_view_column_focus_cell:
2974 * @tree_column: A #GtkTreeViewColumn
2975 * @cell: A #GtkCellRenderer
2977 * Sets the current keyboard focus to be at @cell, if the column contains
2978 * 2 or more editable and activatable cells.
2983 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2984 GtkCellRenderer *cell)
2986 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2987 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2989 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2993 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2994 gboolean install_handler)
2996 GtkTreeViewColumnPrivate *priv = tree_column->priv;
3002 /* Issue a manual reset on the context to have all
3003 * sizes re-requested for the context.
3005 g_signal_handler_block (priv->cell_area_context,
3006 priv->context_changed_signal);
3007 gtk_cell_area_context_reset (priv->cell_area_context);
3008 g_signal_handler_unblock (priv->cell_area_context,
3009 priv->context_changed_signal);
3011 if (priv->tree_view &&
3012 gtk_widget_get_realized (priv->tree_view))
3014 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
3015 gtk_widget_queue_resize (priv->tree_view);
3020 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
3022 return tree_column->priv->dirty;
3026 * gtk_tree_view_column_cell_get_position:
3027 * @tree_column: a #GtkTreeViewColumn
3028 * @cell_renderer: a #GtkCellRenderer
3029 * @x_offset: (out) (allow-none): return location for the horizontal
3030 * position of @cell within @tree_column, may be %NULL
3031 * @width: (out) (allow-none): return location for the width of @cell,
3034 * Obtains the horizontal position and size of a cell in a column. If the
3035 * cell is not found in the column, @start_pos and @width are not changed and
3036 * %FALSE is returned.
3038 * Return value: %TRUE if @cell belongs to @tree_column.
3041 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3042 GtkCellRenderer *cell_renderer,
3046 GtkTreeViewColumnPrivate *priv;
3047 GdkRectangle cell_area;
3048 GdkRectangle allocation;
3050 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3051 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3053 priv = tree_column->priv;
3055 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3056 NULL, tree_column, &cell_area);
3058 gtk_cell_area_get_cell_allocation (priv->cell_area,
3059 priv->cell_area_context,
3067 GdkRectangle button_allocation;
3069 /* Retrieve column offset */
3070 gtk_widget_get_allocation (priv->button, &button_allocation);
3071 *x_offset = allocation.x - button_allocation.x;
3074 *width = allocation.width;
3080 * gtk_tree_view_column_queue_resize:
3081 * @tree_column: A #GtkTreeViewColumn
3083 * Flags the column, and the cell renderers added to this column, to have
3084 * their sizes renegotiated.
3089 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3091 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3093 if (tree_column->priv->tree_view)
3094 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3098 * gtk_tree_view_column_get_tree_view:
3099 * @tree_column: A #GtkTreeViewColumn
3101 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3102 * If @column is currently not inserted in any tree view, %NULL is
3105 * Return value: (transfer none): The tree view wherein @column has
3106 * been inserted if any, %NULL otherwise.
3111 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3113 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3115 return tree_column->priv->tree_view;
3119 * gtk_tree_view_column_get_button:
3120 * @tree_column: A #GtkTreeViewColumn
3122 * Returns the button used in the treeview column header
3124 * Return value: (transfer none): The button for the column header.
3129 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3131 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3133 return tree_column->priv->button;
3137 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3139 return column->priv->window;
3143 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3146 column->priv->padding = MAX (column->priv->padding, padding);
3150 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3152 gint requested_width;
3154 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3156 return requested_width + column->priv->padding;
3161 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3164 column->priv->resized_width = width;
3168 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3170 return column->priv->resized_width;
3174 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3175 gboolean use_resized_width)
3177 column->priv->use_resized_width = use_resized_width;
3181 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3183 return column->priv->use_resized_width;
3187 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3189 return column->priv->drag_x;
3192 GtkCellAreaContext *
3193 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3195 return column->priv->cell_area_context;