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, see <http://www.gnu.org/licenses/>.
20 #include "gtktreeviewcolumn.h"
24 #include "gtktreeview.h"
25 #include "gtktreeprivate.h"
26 #include "gtkcelllayout.h"
27 #include "gtkbutton.h"
28 #include "gtkalignment.h"
31 #include "gtkmarshalers.h"
33 #include "gtkcellareacontext.h"
34 #include "gtkcellareabox.h"
35 #include "gtkprivate.h"
37 #include "gtktypebuiltins.h"
38 #include "a11y/gtktreeviewaccessibleprivate.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 void gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
79 GtkCellArea *cell_area);
81 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
83 /* Button handling code */
84 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
85 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
87 /* Button signal handlers */
88 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
91 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
93 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
94 gboolean group_cycling,
97 /* Property handlers */
98 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
99 GtkTreeViewColumn *tree_column);
101 /* GtkCellArea/GtkCellAreaContext callbacks */
102 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
104 GtkTreeViewColumn *tree_column);
105 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
106 GtkCellRenderer *renderer,
107 GtkCellEditable *edit_widget,
108 GdkRectangle *cell_area,
109 const gchar *path_string,
111 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
112 GtkCellRenderer *renderer,
113 GtkCellEditable *edit_widget,
116 /* Internal functions */
117 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
119 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
120 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
121 GtkCellRenderer *cell_renderer,
124 /* GtkBuildable implementation */
125 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
128 struct _GtkTreeViewColumnPrivate
130 GtkWidget *tree_view;
134 GtkWidget *alignment;
137 gulong property_changed_signal;
140 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
141 GtkTreeViewColumnSizing column_type;
149 /* dragging columns */
156 gulong sort_clicked_signal;
157 gulong sort_column_changed_signal;
159 GtkSortType sort_order;
162 GtkCellArea *cell_area;
163 GtkCellAreaContext *cell_area_context;
164 gulong add_editable_signal;
165 gulong remove_editable_signal;
166 gulong context_changed_signal;
173 guint show_sort_indicator : 1;
174 guint maybe_reordered : 1;
175 guint reorderable : 1;
209 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
211 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
212 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
213 gtk_tree_view_column_cell_layout_init)
214 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
215 gtk_tree_view_column_buildable_init))
219 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
221 GObjectClass *object_class;
223 object_class = (GObjectClass*) class;
225 class->clicked = NULL;
227 object_class->constructor = gtk_tree_view_column_constructor;
228 object_class->finalize = gtk_tree_view_column_finalize;
229 object_class->dispose = gtk_tree_view_column_dispose;
230 object_class->set_property = gtk_tree_view_column_set_property;
231 object_class->get_property = gtk_tree_view_column_get_property;
233 tree_column_signals[CLICKED] =
234 g_signal_new (I_("clicked"),
235 G_OBJECT_CLASS_TYPE (object_class),
237 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
239 _gtk_marshal_VOID__VOID,
242 g_object_class_install_property (object_class,
244 g_param_spec_boolean ("visible",
246 P_("Whether to display the column"),
248 GTK_PARAM_READWRITE));
250 g_object_class_install_property (object_class,
252 g_param_spec_boolean ("resizable",
254 P_("Column is user-resizable"),
256 GTK_PARAM_READWRITE));
258 g_object_class_install_property (object_class,
260 g_param_spec_int ("x-offset",
262 P_("Current X position of the column"),
266 GTK_PARAM_READABLE));
268 g_object_class_install_property (object_class,
270 g_param_spec_int ("width",
272 P_("Current width of the column"),
276 GTK_PARAM_READABLE));
277 g_object_class_install_property (object_class,
279 g_param_spec_int ("spacing",
281 P_("Space which is inserted between cells"),
285 GTK_PARAM_READWRITE));
286 g_object_class_install_property (object_class,
288 g_param_spec_enum ("sizing",
290 P_("Resize mode of the column"),
291 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
292 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
293 GTK_PARAM_READWRITE));
295 g_object_class_install_property (object_class,
297 g_param_spec_int ("fixed-width",
299 P_("Current fixed width of the column"),
303 GTK_PARAM_READWRITE));
305 g_object_class_install_property (object_class,
307 g_param_spec_int ("min-width",
309 P_("Minimum allowed width of the column"),
313 GTK_PARAM_READWRITE));
315 g_object_class_install_property (object_class,
317 g_param_spec_int ("max-width",
319 P_("Maximum allowed width of the column"),
323 GTK_PARAM_READWRITE));
325 g_object_class_install_property (object_class,
327 g_param_spec_string ("title",
329 P_("Title to appear in column header"),
331 GTK_PARAM_READWRITE));
333 g_object_class_install_property (object_class,
335 g_param_spec_boolean ("expand",
337 P_("Column gets share of extra width allocated to the widget"),
339 GTK_PARAM_READWRITE));
341 g_object_class_install_property (object_class,
343 g_param_spec_boolean ("clickable",
345 P_("Whether the header can be clicked"),
347 GTK_PARAM_READWRITE));
350 g_object_class_install_property (object_class,
352 g_param_spec_object ("widget",
354 P_("Widget to put in column header button instead of column title"),
356 GTK_PARAM_READWRITE));
358 g_object_class_install_property (object_class,
360 g_param_spec_float ("alignment",
362 P_("X Alignment of the column header text or widget"),
366 GTK_PARAM_READWRITE));
368 g_object_class_install_property (object_class,
370 g_param_spec_boolean ("reorderable",
372 P_("Whether the column can be reordered around the headers"),
374 GTK_PARAM_READWRITE));
376 g_object_class_install_property (object_class,
378 g_param_spec_boolean ("sort-indicator",
379 P_("Sort indicator"),
380 P_("Whether to show a sort indicator"),
382 GTK_PARAM_READWRITE));
384 g_object_class_install_property (object_class,
386 g_param_spec_enum ("sort-order",
388 P_("Sort direction the sort indicator should indicate"),
391 GTK_PARAM_READWRITE));
394 * GtkTreeViewColumn:sort-column-id:
396 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
397 * clickable. Set to -1 to make the column unsortable.
401 g_object_class_install_property (object_class,
403 g_param_spec_int ("sort-column-id",
404 P_("Sort column ID"),
405 P_("Logical sort column ID this column sorts on when selected for sorting"),
409 GTK_PARAM_READWRITE));
412 * GtkTreeViewColumn:cell-area:
414 * The #GtkCellArea used to layout cell renderers for this column.
416 * If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area()
417 * a horizontally oriented #GtkCellAreaBox will be used.
421 g_object_class_install_property (object_class,
423 g_param_spec_object ("cell-area",
425 P_("The GtkCellArea used to layout cells"),
427 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
429 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
433 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
436 const gchar *tagname,
439 /* Just ignore the boolean return from here */
440 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
444 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
446 iface->add_child = _gtk_cell_layout_buildable_add_child;
447 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
448 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
452 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
454 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
458 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
460 GtkTreeViewColumnPrivate *priv;
462 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
463 GTK_TYPE_TREE_VIEW_COLUMN,
464 GtkTreeViewColumnPrivate);
465 priv = tree_column->priv;
471 priv->min_width = -1;
472 priv->max_width = -1;
473 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
474 priv->visible = TRUE;
475 priv->resizable = FALSE;
476 priv->expand = FALSE;
477 priv->clickable = FALSE;
479 priv->sort_order = GTK_SORT_ASCENDING;
480 priv->show_sort_indicator = FALSE;
481 priv->property_changed_signal = 0;
482 priv->sort_clicked_signal = 0;
483 priv->sort_column_changed_signal = 0;
484 priv->sort_column_id = -1;
485 priv->reorderable = FALSE;
486 priv->maybe_reordered = FALSE;
487 priv->fixed_width = -1;
488 priv->title = g_strdup ("");
492 gtk_tree_view_column_constructor (GType type,
493 guint n_construct_properties,
494 GObjectConstructParam *construct_properties)
496 GtkTreeViewColumn *tree_column;
499 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
500 (type, n_construct_properties, construct_properties);
502 tree_column = (GtkTreeViewColumn *) object;
504 gtk_tree_view_column_ensure_cell_area (tree_column, NULL);
510 gtk_tree_view_column_dispose (GObject *object)
512 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
513 GtkTreeViewColumnPrivate *priv = tree_column->priv;
515 /* Remove this column from its treeview,
516 * in case this column is destroyed before its treeview.
519 gtk_tree_view_remove_column (GTK_TREE_VIEW (priv->tree_view), tree_column);
521 if (priv->cell_area_context)
523 g_signal_handler_disconnect (priv->cell_area_context,
524 priv->context_changed_signal);
526 g_object_unref (priv->cell_area_context);
528 priv->cell_area_context = NULL;
529 priv->context_changed_signal = 0;
534 g_signal_handler_disconnect (priv->cell_area,
535 priv->add_editable_signal);
536 g_signal_handler_disconnect (priv->cell_area,
537 priv->remove_editable_signal);
539 g_object_unref (priv->cell_area);
540 priv->cell_area = NULL;
541 priv->add_editable_signal = 0;
542 priv->remove_editable_signal = 0;
547 g_object_unref (priv->child);
551 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
555 gtk_tree_view_column_finalize (GObject *object)
557 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
558 GtkTreeViewColumnPrivate *priv = tree_column->priv;
560 g_free (priv->title);
562 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
566 gtk_tree_view_column_set_property (GObject *object,
571 GtkTreeViewColumn *tree_column;
574 tree_column = GTK_TREE_VIEW_COLUMN (object);
579 gtk_tree_view_column_set_visible (tree_column,
580 g_value_get_boolean (value));
584 gtk_tree_view_column_set_resizable (tree_column,
585 g_value_get_boolean (value));
589 gtk_tree_view_column_set_sizing (tree_column,
590 g_value_get_enum (value));
593 case PROP_FIXED_WIDTH:
594 gtk_tree_view_column_set_fixed_width (tree_column,
595 g_value_get_int (value));
599 gtk_tree_view_column_set_min_width (tree_column,
600 g_value_get_int (value));
604 gtk_tree_view_column_set_max_width (tree_column,
605 g_value_get_int (value));
609 gtk_tree_view_column_set_spacing (tree_column,
610 g_value_get_int (value));
614 gtk_tree_view_column_set_title (tree_column,
615 g_value_get_string (value));
619 gtk_tree_view_column_set_expand (tree_column,
620 g_value_get_boolean (value));
624 gtk_tree_view_column_set_clickable (tree_column,
625 g_value_get_boolean (value));
629 gtk_tree_view_column_set_widget (tree_column,
630 (GtkWidget*) g_value_get_object (value));
634 gtk_tree_view_column_set_alignment (tree_column,
635 g_value_get_float (value));
638 case PROP_REORDERABLE:
639 gtk_tree_view_column_set_reorderable (tree_column,
640 g_value_get_boolean (value));
643 case PROP_SORT_INDICATOR:
644 gtk_tree_view_column_set_sort_indicator (tree_column,
645 g_value_get_boolean (value));
648 case PROP_SORT_ORDER:
649 gtk_tree_view_column_set_sort_order (tree_column,
650 g_value_get_enum (value));
653 case PROP_SORT_COLUMN_ID:
654 gtk_tree_view_column_set_sort_column_id (tree_column,
655 g_value_get_int (value));
659 /* Construct-only, can only be assigned once */
660 area = g_value_get_object (value);
664 if (tree_column->priv->cell_area != NULL)
666 g_warning ("cell-area has already been set, ignoring construct property");
667 g_object_ref_sink (area);
668 g_object_unref (area);
671 gtk_tree_view_column_ensure_cell_area (tree_column, area);
676 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
682 gtk_tree_view_column_get_property (GObject *object,
687 GtkTreeViewColumn *tree_column;
689 tree_column = GTK_TREE_VIEW_COLUMN (object);
694 g_value_set_boolean (value,
695 gtk_tree_view_column_get_visible (tree_column));
699 g_value_set_boolean (value,
700 gtk_tree_view_column_get_resizable (tree_column));
704 g_value_set_int (value,
705 gtk_tree_view_column_get_x_offset (tree_column));
709 g_value_set_int (value,
710 gtk_tree_view_column_get_width (tree_column));
714 g_value_set_int (value,
715 gtk_tree_view_column_get_spacing (tree_column));
719 g_value_set_enum (value,
720 gtk_tree_view_column_get_sizing (tree_column));
723 case PROP_FIXED_WIDTH:
724 g_value_set_int (value,
725 gtk_tree_view_column_get_fixed_width (tree_column));
729 g_value_set_int (value,
730 gtk_tree_view_column_get_min_width (tree_column));
734 g_value_set_int (value,
735 gtk_tree_view_column_get_max_width (tree_column));
739 g_value_set_string (value,
740 gtk_tree_view_column_get_title (tree_column));
744 g_value_set_boolean (value,
745 gtk_tree_view_column_get_expand (tree_column));
749 g_value_set_boolean (value,
750 gtk_tree_view_column_get_clickable (tree_column));
754 g_value_set_object (value,
755 (GObject*) gtk_tree_view_column_get_widget (tree_column));
759 g_value_set_float (value,
760 gtk_tree_view_column_get_alignment (tree_column));
763 case PROP_REORDERABLE:
764 g_value_set_boolean (value,
765 gtk_tree_view_column_get_reorderable (tree_column));
768 case PROP_SORT_INDICATOR:
769 g_value_set_boolean (value,
770 gtk_tree_view_column_get_sort_indicator (tree_column));
773 case PROP_SORT_ORDER:
774 g_value_set_enum (value,
775 gtk_tree_view_column_get_sort_order (tree_column));
778 case PROP_SORT_COLUMN_ID:
779 g_value_set_int (value,
780 gtk_tree_view_column_get_sort_column_id (tree_column));
784 g_value_set_object (value, tree_column->priv->cell_area);
788 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
793 /* Implementation of GtkCellLayout interface
797 gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
798 GtkCellArea *cell_area)
800 GtkTreeViewColumnPrivate *priv = column->priv;
806 priv->cell_area = cell_area;
808 priv->cell_area = gtk_cell_area_box_new ();
810 g_object_ref_sink (priv->cell_area);
812 priv->add_editable_signal =
813 g_signal_connect (priv->cell_area, "add-editable",
814 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
816 priv->remove_editable_signal =
817 g_signal_connect (priv->cell_area, "remove-editable",
818 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
821 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
823 priv->context_changed_signal =
824 g_signal_connect (priv->cell_area_context, "notify",
825 G_CALLBACK (gtk_tree_view_column_context_changed),
830 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
832 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
833 GtkTreeViewColumnPrivate *priv = column->priv;
835 if (G_UNLIKELY (!priv->cell_area))
836 gtk_tree_view_column_ensure_cell_area (column, NULL);
838 return priv->cell_area;
841 /* Button handling code
844 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
846 GtkTreeViewColumnPrivate *priv = tree_column->priv;
847 GtkTreeView *tree_view;
851 tree_view = (GtkTreeView *) priv->tree_view;
853 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
854 g_return_if_fail (priv->button == NULL);
856 gtk_widget_push_composite_child ();
857 priv->button = gtk_button_new ();
859 gtk_widget_show (priv->button);
860 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
861 gtk_widget_pop_composite_child ();
863 /* make sure we own a reference to it as well. */
864 if (_gtk_tree_view_get_header_window (tree_view))
865 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
867 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
869 g_signal_connect (priv->button, "event",
870 G_CALLBACK (gtk_tree_view_column_button_event),
872 g_signal_connect (priv->button, "clicked",
873 G_CALLBACK (gtk_tree_view_column_button_clicked),
876 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
878 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
879 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
885 child = gtk_label_new (priv->title);
886 gtk_widget_show (child);
889 g_signal_connect (child, "mnemonic-activate",
890 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
893 if (priv->xalign <= 0.5)
894 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
896 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
898 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
900 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
901 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
903 gtk_widget_show (hbox);
904 gtk_widget_show (priv->alignment);
905 gtk_tree_view_column_update_button (tree_column);
909 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
911 GtkTreeViewColumnPrivate *priv = tree_column->priv;
912 gint sort_column_id = -1;
914 GtkWidget *alignment;
916 GtkWidget *current_child;
917 GtkArrowType arrow_type = GTK_ARROW_NONE;
921 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
925 /* Create a button if necessary */
927 priv->button == NULL &&
929 gtk_widget_get_realized (priv->tree_view))
930 gtk_tree_view_column_create_button (tree_column);
935 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
936 alignment = priv->alignment;
938 current_child = gtk_bin_get_child (GTK_BIN (alignment));
940 /* Set up the actual button */
941 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
946 if (current_child != priv->child)
948 gtk_container_remove (GTK_CONTAINER (alignment),
950 gtk_container_add (GTK_CONTAINER (alignment),
956 if (current_child == NULL)
958 current_child = gtk_label_new (NULL);
959 gtk_widget_show (current_child);
960 gtk_container_add (GTK_CONTAINER (alignment),
964 g_return_if_fail (GTK_IS_LABEL (current_child));
967 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
970 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
974 if (GTK_IS_TREE_SORTABLE (model))
975 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
979 if (priv->show_sort_indicator)
981 gboolean alternative;
983 g_object_get (gtk_widget_get_settings (priv->tree_view),
984 "gtk-alternative-sort-arrows", &alternative,
987 switch (priv->sort_order)
989 case GTK_SORT_ASCENDING:
990 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
993 case GTK_SORT_DESCENDING:
994 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
998 g_warning (G_STRLOC": bad sort order");
1003 gtk_arrow_set (GTK_ARROW (arrow),
1007 /* Put arrow on the right if the text is left-or-center justified, and on the
1008 * left otherwise; do this by packing boxes, so flipping text direction will
1011 g_object_ref (arrow);
1012 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
1014 if (priv->xalign <= 0.5)
1016 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1020 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1021 /* move it to the front */
1022 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
1024 g_object_unref (arrow);
1026 if (priv->show_sort_indicator
1027 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
1028 gtk_widget_show (arrow);
1030 gtk_widget_hide (arrow);
1032 /* It's always safe to hide the button. It isn't always safe to show it, as
1033 * if you show it before it's realized, it'll get the wrong window. */
1035 priv->tree_view != NULL &&
1036 gtk_widget_get_realized (priv->tree_view))
1038 if (priv->visible &&
1039 gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
1041 gtk_widget_show (priv->button);
1045 if (priv->resizable)
1047 gdk_window_show (priv->window);
1048 gdk_window_raise (priv->window);
1052 gdk_window_hide (priv->window);
1058 gtk_widget_hide (priv->button);
1060 gdk_window_hide (priv->window);
1064 if (priv->reorderable || priv->clickable)
1066 gtk_widget_set_can_focus (priv->button, TRUE);
1070 gtk_widget_set_can_focus (priv->button, FALSE);
1071 if (gtk_widget_has_focus (priv->button))
1073 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1074 if (gtk_widget_is_toplevel (toplevel))
1076 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1080 /* Queue a resize on the assumption that we always want to catch all changes
1081 * and columns don't change all that often.
1083 if (gtk_widget_get_realized (priv->tree_view))
1084 gtk_widget_queue_resize (priv->tree_view);
1088 /* Button signal handlers
1092 gtk_tree_view_column_button_event (GtkWidget *widget,
1096 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1097 GtkTreeViewColumnPrivate *priv = column->priv;
1099 g_return_val_if_fail (event != NULL, FALSE);
1101 if (event->type == GDK_BUTTON_PRESS &&
1102 priv->reorderable &&
1103 ((GdkEventButton *)event)->button == GDK_BUTTON_PRIMARY)
1105 priv->maybe_reordered = TRUE;
1106 gdk_window_get_device_position (gtk_button_get_event_window (GTK_BUTTON (widget)),
1107 gdk_event_get_device (event),
1111 gtk_widget_grab_focus (widget);
1114 if (event->type == GDK_BUTTON_RELEASE ||
1115 event->type == GDK_LEAVE_NOTIFY)
1116 priv->maybe_reordered = FALSE;
1118 if (event->type == GDK_MOTION_NOTIFY &&
1119 priv->maybe_reordered &&
1120 (gtk_drag_check_threshold (widget,
1123 (gint) ((GdkEventMotion *)event)->x,
1124 (gint) ((GdkEventMotion *)event)->y)))
1126 priv->maybe_reordered = FALSE;
1127 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1128 event->motion.device);
1132 if (priv->clickable == FALSE)
1134 switch (event->type)
1136 case GDK_BUTTON_PRESS:
1137 case GDK_2BUTTON_PRESS:
1138 case GDK_3BUTTON_PRESS:
1139 case GDK_MOTION_NOTIFY:
1140 case GDK_BUTTON_RELEASE:
1141 case GDK_ENTER_NOTIFY:
1142 case GDK_LEAVE_NOTIFY:
1153 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1155 g_signal_emit_by_name (data, "clicked");
1159 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1160 gboolean group_cycling,
1163 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1164 GtkTreeViewColumnPrivate *priv = column->priv;
1166 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1168 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1170 if (priv->clickable)
1171 gtk_button_clicked (GTK_BUTTON (priv->button));
1172 else if (gtk_widget_get_can_focus (priv->button))
1173 gtk_widget_grab_focus (priv->button);
1175 gtk_widget_grab_focus (priv->tree_view);
1181 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1182 GtkTreeViewColumn *column)
1184 GtkTreeViewColumnPrivate *priv = column->priv;
1185 gint sort_column_id;
1188 if (gtk_tree_sortable_get_sort_column_id (sortable,
1192 if (sort_column_id == priv->sort_column_id)
1194 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1195 gtk_tree_view_column_set_sort_order (column, order);
1199 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1204 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1209 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1212 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1213 GtkTreeModel *model;
1214 GtkTreeSortable *sortable;
1215 gint sort_column_id;
1217 gboolean has_sort_column;
1218 gboolean has_default_sort_func;
1220 g_return_if_fail (priv->tree_view != NULL);
1222 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1223 sortable = GTK_TREE_SORTABLE (model);
1226 gtk_tree_sortable_get_sort_column_id (sortable,
1229 has_default_sort_func =
1230 gtk_tree_sortable_has_default_sort_func (sortable);
1232 if (has_sort_column &&
1233 sort_column_id == priv->sort_column_id)
1235 if (order == GTK_SORT_ASCENDING)
1236 gtk_tree_sortable_set_sort_column_id (sortable,
1237 priv->sort_column_id,
1238 GTK_SORT_DESCENDING);
1239 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1240 gtk_tree_sortable_set_sort_column_id (sortable,
1241 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1242 GTK_SORT_ASCENDING);
1244 gtk_tree_sortable_set_sort_column_id (sortable,
1245 priv->sort_column_id,
1246 GTK_SORT_ASCENDING);
1250 gtk_tree_sortable_set_sort_column_id (sortable,
1251 priv->sort_column_id,
1252 GTK_SORT_ASCENDING);
1257 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1259 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1260 GtkTreeModel *model;
1262 if (priv->tree_view == NULL)
1265 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1270 if (GTK_IS_TREE_SORTABLE (model) &&
1271 priv->sort_column_id != -1)
1273 gint real_sort_column_id;
1274 GtkSortType real_order;
1276 if (priv->sort_column_changed_signal == 0)
1277 priv->sort_column_changed_signal =
1278 g_signal_connect (model, "sort-column-changed",
1279 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1282 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1283 &real_sort_column_id,
1285 (real_sort_column_id == priv->sort_column_id))
1287 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1288 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1292 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1298 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1300 GtkTreeViewColumn *tree_column)
1302 /* Here we want the column re-requested if the underlying context was
1303 * actually reset for any reason, this can happen if the underlying
1304 * area/cell configuration changes (i.e. cell packing properties
1305 * or cell spacing and the like)
1307 * Note that we block this handler while requesting for sizes
1308 * so there is no need to check for the new context size being -1,
1309 * we also block the handler when explicitly resetting the context
1310 * so as to avoid some infinite stack recursion.
1312 if (!strcmp (pspec->name, "minimum-width") ||
1313 !strcmp (pspec->name, "natural-width") ||
1314 !strcmp (pspec->name, "minimum-height") ||
1315 !strcmp (pspec->name, "natural-height"))
1316 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1320 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1321 GtkCellRenderer *renderer,
1322 GtkCellEditable *edit_widget,
1323 GdkRectangle *cell_area,
1324 const gchar *path_string,
1327 GtkTreeViewColumn *column = user_data;
1328 GtkTreeViewColumnPrivate *priv = column->priv;
1331 if (priv->tree_view)
1333 path = gtk_tree_path_new_from_string (path_string);
1335 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1341 gtk_tree_path_free (path);
1346 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1347 GtkCellRenderer *renderer,
1348 GtkCellEditable *edit_widget,
1351 GtkTreeViewColumn *column = user_data;
1352 GtkTreeViewColumnPrivate *priv = column->priv;
1354 if (priv->tree_view)
1355 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1360 /* Exported Private Functions.
1361 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1364 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1366 GtkTreeViewColumnPrivate *priv = column->priv;
1367 GtkAllocation allocation;
1368 GtkTreeView *tree_view;
1370 guint attributes_mask;
1373 tree_view = (GtkTreeView *)priv->tree_view;
1374 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1376 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1377 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1378 g_return_if_fail (priv->button != NULL);
1380 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1381 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1383 attr.window_type = GDK_WINDOW_CHILD;
1384 attr.wclass = GDK_INPUT_ONLY;
1385 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1386 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1387 (GDK_BUTTON_PRESS_MASK |
1388 GDK_BUTTON_RELEASE_MASK |
1389 GDK_POINTER_MOTION_MASK |
1390 GDK_POINTER_MOTION_HINT_MASK |
1391 GDK_KEY_PRESS_MASK);
1392 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1393 attr.cursor = gdk_cursor_new_for_display
1394 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1396 attr.width = TREE_VIEW_DRAG_WIDTH;
1397 attr.height = _gtk_tree_view_get_header_height (tree_view);
1399 gtk_widget_get_allocation (priv->button, &allocation);
1400 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1401 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1402 &attr, attributes_mask);
1403 gtk_widget_register_window (GTK_WIDGET (tree_view), priv->window);
1405 gtk_tree_view_column_update_button (column);
1407 g_object_unref (attr.cursor);
1411 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1413 GtkTreeViewColumnPrivate *priv;
1415 g_return_if_fail (column != NULL);
1417 priv = column->priv;
1418 g_return_if_fail (priv->window != NULL);
1420 gtk_widget_unregister_window (GTK_WIDGET (priv->tree_view), priv->window);
1421 gdk_window_destroy (priv->window);
1422 priv->window = NULL;
1426 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1427 GtkTreeModel *old_model)
1429 GtkTreeViewColumnPrivate *priv = column->priv;
1431 if (priv->sort_column_changed_signal)
1433 g_signal_handler_disconnect (old_model,
1434 priv->sort_column_changed_signal);
1435 priv->sort_column_changed_signal = 0;
1437 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1441 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1442 GtkTreeView *tree_view)
1444 GtkTreeViewColumnPrivate *priv = column->priv;
1446 g_assert (priv->tree_view == NULL);
1448 priv->tree_view = GTK_WIDGET (tree_view);
1449 gtk_tree_view_column_create_button (column);
1451 priv->property_changed_signal =
1452 g_signal_connect_swapped (tree_view,
1454 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1457 gtk_tree_view_column_setup_sort_column_id_callback (column);
1461 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1463 GtkTreeViewColumnPrivate *priv = column->priv;
1465 if (priv->tree_view && priv->button)
1467 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1469 if (priv->property_changed_signal)
1471 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1472 priv->property_changed_signal = 0;
1475 if (priv->sort_column_changed_signal)
1477 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1478 priv->sort_column_changed_signal);
1479 priv->sort_column_changed_signal = 0;
1482 priv->tree_view = NULL;
1483 priv->button = NULL;
1487 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1489 GtkTreeViewColumnPrivate *priv = column->priv;
1490 gboolean ret = FALSE;
1491 GList *list, *cells;
1493 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1495 for (list = cells; list; list = list->next)
1497 GtkCellRenderer *cell = list->data;
1498 GtkCellRendererMode mode;
1500 g_object_get (cell, "mode", &mode, NULL);
1502 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1509 g_list_free (cells);
1514 /* gets cell being edited */
1516 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1518 GtkTreeViewColumnPrivate *priv = column->priv;
1520 return gtk_cell_area_get_edited_cell (priv->cell_area);
1524 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1525 GdkRectangle *cell_area,
1526 GdkRectangle *background_area,
1530 GtkCellRenderer *match = NULL;
1531 GtkTreeViewColumnPrivate *priv = column->priv;
1533 /* If (x, y) is outside of the background area, immediately return */
1534 if (x < background_area->x ||
1535 x > background_area->x + background_area->width ||
1536 y < background_area->y ||
1537 y > background_area->y + background_area->height)
1540 /* If (x, y) is inside the background area, clamp it to the cell_area
1541 * so that a cell is still returned. The main reason for doing this
1542 * (on the x axis) is for handling clicks in the indentation area
1543 * (either at the left or right depending on RTL setting). Another
1544 * reason is for handling clicks on the area where the focus rectangle
1545 * is drawn (this is outside of cell area), this manifests itself
1546 * mainly when a large setting is used for focus-line-width.
1548 if (x < cell_area->x)
1550 else if (x > cell_area->x + cell_area->width)
1551 x = cell_area->x + cell_area->width;
1553 if (y < cell_area->y)
1555 else if (y > cell_area->y + cell_area->height)
1556 y = cell_area->y + cell_area->height;
1558 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1559 priv->cell_area_context,
1569 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1570 GdkRectangle *cell_area,
1571 GdkRectangle *background_area,
1575 GtkCellRenderer *match;
1576 GdkRectangle cell_alloc, aligned_area, inner_area;
1577 GtkTreeViewColumnPrivate *priv = column->priv;
1579 match = _gtk_tree_view_column_get_cell_at_pos (column,
1586 gtk_cell_area_get_cell_allocation (priv->cell_area,
1587 priv->cell_area_context,
1593 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1594 &cell_alloc, &inner_area);
1595 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1596 &inner_area, &aligned_area);
1598 if (x < aligned_area.x ||
1599 x > aligned_area.x + aligned_area.width ||
1600 y < aligned_area.y ||
1601 y > aligned_area.y + aligned_area.height)
1607 /* Public Functions */
1611 * gtk_tree_view_column_new:
1613 * Creates a new #GtkTreeViewColumn.
1615 * Return value: A newly created #GtkTreeViewColumn.
1618 gtk_tree_view_column_new (void)
1620 GtkTreeViewColumn *tree_column;
1622 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1628 * gtk_tree_view_column_new_with_area:
1629 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1631 * Creates a new #GtkTreeViewColumn using @area to render its cells.
1633 * Return value: A newly created #GtkTreeViewColumn.
1638 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1640 GtkTreeViewColumn *tree_column;
1642 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1649 * gtk_tree_view_column_new_with_attributes:
1650 * @title: The title to set the header to
1651 * @cell: The #GtkCellRenderer
1652 * @...: A %NULL-terminated list of attributes
1654 * Creates a new #GtkTreeViewColumn with a number of default values.
1655 * This is equivalent to calling gtk_tree_view_column_set_title(),
1656 * gtk_tree_view_column_pack_start(), and
1657 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1659 * Here's a simple example:
1661 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1664 * GtkTreeViewColumn *column;
1665 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1667 * column = gtk_tree_view_column_new_with_attributes ("Title",
1669 * "text", TEXT_COLUMN,
1670 * "foreground", COLOR_COLUMN,
1675 * Return value: A newly created #GtkTreeViewColumn.
1678 gtk_tree_view_column_new_with_attributes (const gchar *title,
1679 GtkCellRenderer *cell,
1682 GtkTreeViewColumn *retval;
1685 retval = gtk_tree_view_column_new ();
1687 gtk_tree_view_column_set_title (retval, title);
1688 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1690 va_start (args, cell);
1691 gtk_tree_view_column_set_attributesv (retval, cell, args);
1698 * gtk_tree_view_column_pack_start:
1699 * @tree_column: A #GtkTreeViewColumn.
1700 * @cell: The #GtkCellRenderer.
1701 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1703 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1704 * the @cell is allocated no more space than it needs. Any unused space is divided
1705 * evenly between cells for which @expand is %TRUE.
1708 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1709 GtkCellRenderer *cell,
1712 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1716 * gtk_tree_view_column_pack_end:
1717 * @tree_column: A #GtkTreeViewColumn.
1718 * @cell: The #GtkCellRenderer.
1719 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1721 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1722 * is allocated no more space than it needs. Any unused space is divided
1723 * evenly between cells for which @expand is %TRUE.
1726 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1727 GtkCellRenderer *cell,
1730 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1734 * gtk_tree_view_column_clear:
1735 * @tree_column: A #GtkTreeViewColumn
1737 * Unsets all the mappings on all renderers on the @tree_column.
1740 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1742 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1746 * gtk_tree_view_column_add_attribute:
1747 * @tree_column: A #GtkTreeViewColumn.
1748 * @cell_renderer: the #GtkCellRenderer to set attributes on
1749 * @attribute: An attribute on the renderer
1750 * @column: The column position on the model to get the attribute from.
1752 * Adds an attribute mapping to the list in @tree_column. The @column is the
1753 * column of the model to get a value from, and the @attribute is the
1754 * parameter on @cell_renderer to be set from the value. So for example
1755 * if column 2 of the model contains strings, you could have the
1756 * "text" attribute of a #GtkCellRendererText get its values from
1760 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1761 GtkCellRenderer *cell_renderer,
1762 const gchar *attribute,
1765 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1766 cell_renderer, attribute, column);
1770 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1771 GtkCellRenderer *cell_renderer,
1774 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1778 attribute = va_arg (args, gchar *);
1780 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1783 while (attribute != NULL)
1785 column = va_arg (args, gint);
1786 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1787 cell_renderer, attribute, column);
1788 attribute = va_arg (args, gchar *);
1793 * gtk_tree_view_column_set_attributes:
1794 * @tree_column: A #GtkTreeViewColumn
1795 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1796 * @...: A %NULL-terminated list of attributes
1798 * Sets the attributes in the list as the attributes of @tree_column.
1799 * The attributes should be in attribute/column order, as in
1800 * gtk_tree_view_column_add_attribute(). All existing attributes
1801 * are removed, and replaced with the new attributes.
1804 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1805 GtkCellRenderer *cell_renderer,
1810 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1811 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1813 va_start (args, cell_renderer);
1814 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1820 * gtk_tree_view_column_set_cell_data_func:
1821 * @tree_column: A #GtkTreeViewColumn
1822 * @cell_renderer: A #GtkCellRenderer
1823 * @func: (allow-none): The #GtkTreeCellDataFunc to use.
1824 * @func_data: The user data for @func.
1825 * @destroy: The destroy notification for @func_data
1827 * Sets the #GtkTreeCellDataFunc to use for the column. This
1828 * function is used instead of the standard attributes mapping for
1829 * setting the column value, and should set the value of @tree_column's
1830 * cell renderer as appropriate. @func may be %NULL to remove an
1834 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1835 GtkCellRenderer *cell_renderer,
1836 GtkTreeCellDataFunc func,
1838 GDestroyNotify destroy)
1840 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1842 (GtkCellLayoutDataFunc)func,
1843 func_data, destroy);
1848 * gtk_tree_view_column_clear_attributes:
1849 * @tree_column: a #GtkTreeViewColumn
1850 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1852 * Clears all existing attributes previously set with
1853 * gtk_tree_view_column_set_attributes().
1856 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1857 GtkCellRenderer *cell_renderer)
1859 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1864 * gtk_tree_view_column_set_spacing:
1865 * @tree_column: A #GtkTreeViewColumn.
1866 * @spacing: distance between cell renderers in pixels.
1868 * Sets the spacing field of @tree_column, which is the number of pixels to
1869 * place between cell renderers packed into it.
1872 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1875 GtkTreeViewColumnPrivate *priv;
1877 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1878 g_return_if_fail (spacing >= 0);
1880 priv = tree_column->priv;
1882 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1884 if (priv->tree_view)
1885 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1889 * gtk_tree_view_column_get_spacing:
1890 * @tree_column: A #GtkTreeViewColumn.
1892 * Returns the spacing of @tree_column.
1894 * Return value: the spacing of @tree_column.
1897 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1899 GtkTreeViewColumnPrivate *priv;
1901 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1903 priv = tree_column->priv;
1905 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1908 /* Options for manipulating the columns */
1911 * gtk_tree_view_column_set_visible:
1912 * @tree_column: A #GtkTreeViewColumn.
1913 * @visible: %TRUE if the @tree_column is visible.
1915 * Sets the visibility of @tree_column.
1918 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1921 GtkTreeViewColumnPrivate *priv;
1923 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1925 priv = tree_column->priv;
1926 visible = !! visible;
1928 if (priv->visible == visible)
1931 priv->visible = visible;
1934 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1936 if (priv->tree_view)
1938 _gtk_tree_view_reset_header_styles (GTK_TREE_VIEW (priv->tree_view));
1939 _gtk_tree_view_accessible_toggle_visibility (GTK_TREE_VIEW (priv->tree_view),
1943 gtk_tree_view_column_update_button (tree_column);
1944 g_object_notify (G_OBJECT (tree_column), "visible");
1948 * gtk_tree_view_column_get_visible:
1949 * @tree_column: A #GtkTreeViewColumn.
1951 * Returns %TRUE if @tree_column is visible.
1953 * Return value: whether the column is visible or not. If it is visible, then
1954 * the tree will show the column.
1957 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1959 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1961 return tree_column->priv->visible;
1965 * gtk_tree_view_column_set_resizable:
1966 * @tree_column: A #GtkTreeViewColumn
1967 * @resizable: %TRUE, if the column can be resized
1969 * If @resizable is %TRUE, then the user can explicitly resize the column by
1970 * grabbing the outer edge of the column button. If resizable is %TRUE and
1971 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1972 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1975 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1978 GtkTreeViewColumnPrivate *priv;
1980 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1982 priv = tree_column->priv;
1983 resizable = !! resizable;
1985 if (priv->resizable == resizable)
1988 priv->resizable = resizable;
1990 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1991 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1993 gtk_tree_view_column_update_button (tree_column);
1995 g_object_notify (G_OBJECT (tree_column), "resizable");
1999 * gtk_tree_view_column_get_resizable:
2000 * @tree_column: A #GtkTreeViewColumn
2002 * Returns %TRUE if the @tree_column can be resized by the end user.
2004 * Return value: %TRUE, if the @tree_column can be resized.
2007 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
2009 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2011 return tree_column->priv->resizable;
2016 * gtk_tree_view_column_set_sizing:
2017 * @tree_column: A #GtkTreeViewColumn.
2018 * @type: The #GtkTreeViewColumnSizing.
2020 * Sets the growth behavior of @tree_column to @type.
2023 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
2024 GtkTreeViewColumnSizing type)
2026 GtkTreeViewColumnPrivate *priv;
2028 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2030 priv = tree_column->priv;
2032 if (type == priv->column_type)
2035 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2036 gtk_tree_view_column_set_resizable (tree_column, FALSE);
2038 priv->column_type = type;
2040 gtk_tree_view_column_update_button (tree_column);
2042 g_object_notify (G_OBJECT (tree_column), "sizing");
2046 * gtk_tree_view_column_get_sizing:
2047 * @tree_column: A #GtkTreeViewColumn.
2049 * Returns the current type of @tree_column.
2051 * Return value: The type of @tree_column.
2053 GtkTreeViewColumnSizing
2054 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
2056 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2058 return tree_column->priv->column_type;
2062 * gtk_tree_view_column_get_width:
2063 * @tree_column: A #GtkTreeViewColumn.
2065 * Returns the current size of @tree_column in pixels.
2067 * Return value: The current width of @tree_column.
2070 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2072 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2074 return tree_column->priv->width;
2078 * gtk_tree_view_column_get_x_offset:
2079 * @tree_column: A #GtkTreeViewColumn.
2081 * Returns the current X offset of @tree_column in pixels.
2083 * Return value: The current X offset of @tree_column.
2088 gtk_tree_view_column_get_x_offset (GtkTreeViewColumn *tree_column)
2090 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2092 return tree_column->priv->x_offset;
2096 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column,
2100 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2101 gint minimum_width = 1, natural_width = 1;
2102 gint button_minimum, button_natural;
2104 if (priv->column_type != GTK_TREE_VIEW_COLUMN_FIXED)
2106 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &minimum_width, &natural_width);
2107 minimum_width += priv->padding;
2108 natural_width += priv->padding;
2110 if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2112 gtk_widget_get_preferred_width (priv->button, &button_minimum, &button_natural);
2113 minimum_width = MAX (minimum_width, button_minimum);
2114 natural_width = MAX (natural_width, button_natural);
2118 if (priv->fixed_width != -1)
2119 natural_width = MAX (priv->fixed_width, minimum_width);
2121 if (priv->min_width != -1)
2123 minimum_width = MAX (minimum_width, priv->min_width);
2124 natural_width = MAX (natural_width, priv->min_width);
2127 if (priv->max_width != -1)
2129 minimum_width = MIN (minimum_width, priv->max_width);
2130 natural_width = MIN (natural_width, priv->max_width);
2133 if (minimum != NULL)
2134 *minimum = minimum_width;
2135 if (natural != NULL)
2136 *natural = natural_width;
2140 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2144 GtkTreeViewColumnPrivate *priv;
2146 GtkAllocation allocation = { 0, 0, 0, 0 };
2148 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2150 priv = tree_column->priv;
2152 if (priv->width != width)
2153 gtk_widget_queue_draw (priv->tree_view);
2155 priv->x_offset = x_offset;
2156 priv->width = width;
2158 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2160 if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2162 allocation.x = x_offset;
2164 allocation.width = width;
2165 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2167 gtk_widget_size_allocate (priv->button, &allocation);
2172 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2173 gdk_window_move_resize (priv->window,
2174 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2176 TREE_VIEW_DRAG_WIDTH, allocation.height);
2179 g_object_notify (G_OBJECT (tree_column), "x-offset");
2180 g_object_notify (G_OBJECT (tree_column), "width");
2184 * gtk_tree_view_column_set_fixed_width:
2185 * @tree_column: A #GtkTreeViewColumn.
2186 * @fixed_width: The new fixed width, in pixels, or -1.
2188 * If @fixed_width is not -1, sets the fixed width of @tree_column; otherwise
2189 * unsets it. The effective value of @fixed_width is clamped between the
2190 * minumum and maximum width of the column; however, the value stored in the
2191 * "fixed-width" property is not clamped. If the column sizing is
2192 * #GTK_TREE_VIEW_COLUMN_GROW_ONLY or #GTK_TREE_VIEW_COLUMN_AUTOSIZE, setting a
2193 * fixed width overrides the automatically calculated width. Note that
2194 * @fixed_width is only a hint to GTK+; the width actually allocated to the
2195 * column may be greater or less than requested.
2197 * Along with "expand", the "fixed-width" property changes when the column is
2198 * resized by the user.
2201 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2204 GtkTreeViewColumnPrivate *priv;
2206 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2207 g_return_if_fail (fixed_width >= -1);
2209 priv = tree_column->priv;
2211 priv->fixed_width = fixed_width;
2213 if (priv->visible &&
2214 priv->tree_view != NULL &&
2215 gtk_widget_get_realized (priv->tree_view))
2217 gtk_widget_queue_resize (priv->tree_view);
2220 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2224 * gtk_tree_view_column_get_fixed_width:
2225 * @tree_column: A #GtkTreeViewColumn.
2227 * Gets the fixed width of the column. This may not be the actual displayed
2228 * width of the column; for that, use gtk_tree_view_column_get_width().
2230 * Return value: The fixed width of the column.
2233 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2235 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2237 return tree_column->priv->fixed_width;
2241 * gtk_tree_view_column_set_min_width:
2242 * @tree_column: A #GtkTreeViewColumn.
2243 * @min_width: The minimum width of the column in pixels, or -1.
2245 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2246 * minimum width is unset.
2249 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2252 GtkTreeViewColumnPrivate *priv;
2254 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2255 g_return_if_fail (min_width >= -1);
2257 priv = tree_column->priv;
2259 if (min_width == priv->min_width)
2262 if (priv->visible &&
2263 priv->tree_view != NULL &&
2264 gtk_widget_get_realized (priv->tree_view))
2266 if (min_width > priv->width)
2267 gtk_widget_queue_resize (priv->tree_view);
2270 priv->min_width = min_width;
2271 g_object_freeze_notify (G_OBJECT (tree_column));
2272 if (priv->max_width != -1 && priv->max_width < min_width)
2274 priv->max_width = min_width;
2275 g_object_notify (G_OBJECT (tree_column), "max-width");
2277 g_object_notify (G_OBJECT (tree_column), "min-width");
2278 g_object_thaw_notify (G_OBJECT (tree_column));
2280 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2281 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2286 * gtk_tree_view_column_get_min_width:
2287 * @tree_column: A #GtkTreeViewColumn.
2289 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2292 * Return value: The minimum width of the @tree_column.
2295 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2297 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2299 return tree_column->priv->min_width;
2303 * gtk_tree_view_column_set_max_width:
2304 * @tree_column: A #GtkTreeViewColumn.
2305 * @max_width: The maximum width of the column in pixels, or -1.
2307 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2308 * maximum width is unset. Note, the column can actually be wider than max
2309 * width if it's the last column in a view. In this case, the column expands to
2310 * fill any extra space.
2313 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2316 GtkTreeViewColumnPrivate *priv;
2318 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2319 g_return_if_fail (max_width >= -1);
2321 priv = tree_column->priv;
2323 if (max_width == priv->max_width)
2326 if (priv->visible &&
2327 priv->tree_view != NULL &&
2328 gtk_widget_get_realized (priv->tree_view))
2330 if (max_width != -1 && max_width < priv->width)
2331 gtk_widget_queue_resize (priv->tree_view);
2334 priv->max_width = max_width;
2335 g_object_freeze_notify (G_OBJECT (tree_column));
2336 if (max_width != -1 && max_width < priv->min_width)
2338 priv->min_width = max_width;
2339 g_object_notify (G_OBJECT (tree_column), "min-width");
2341 g_object_notify (G_OBJECT (tree_column), "max-width");
2342 g_object_thaw_notify (G_OBJECT (tree_column));
2344 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2345 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2350 * gtk_tree_view_column_get_max_width:
2351 * @tree_column: A #GtkTreeViewColumn.
2353 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2356 * Return value: The maximum width of the @tree_column.
2359 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2361 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2363 return tree_column->priv->max_width;
2367 * gtk_tree_view_column_clicked:
2368 * @tree_column: a #GtkTreeViewColumn
2370 * Emits the "clicked" signal on the column. This function will only work if
2371 * @tree_column is clickable.
2374 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2376 GtkTreeViewColumnPrivate *priv;
2378 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2380 priv = tree_column->priv;
2382 if (priv->visible &&
2385 gtk_button_clicked (GTK_BUTTON (priv->button));
2389 * gtk_tree_view_column_set_title:
2390 * @tree_column: A #GtkTreeViewColumn.
2391 * @title: The title of the @tree_column.
2393 * Sets the title of the @tree_column. If a custom widget has been set, then
2394 * this value is ignored.
2397 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2400 GtkTreeViewColumnPrivate *priv;
2403 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2405 priv = tree_column->priv;
2407 new_title = g_strdup (title);
2408 g_free (priv->title);
2409 priv->title = new_title;
2411 gtk_tree_view_column_update_button (tree_column);
2412 g_object_notify (G_OBJECT (tree_column), "title");
2416 * gtk_tree_view_column_get_title:
2417 * @tree_column: A #GtkTreeViewColumn.
2419 * Returns the title of the widget.
2421 * Return value: the title of the column. This string should not be
2422 * modified or freed.
2425 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2427 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2429 return tree_column->priv->title;
2433 * gtk_tree_view_column_set_expand:
2434 * @tree_column: A #GtkTreeViewColumn.
2435 * @expand: %TRUE if the column should expand to fill available space.
2437 * Sets the column to take available extra space. This space is shared equally
2438 * amongst all columns that have the expand set to %TRUE. If no column has this
2439 * option set, then the last column gets all extra space. By default, every
2440 * column is created with this %FALSE.
2442 * Along with "fixed-width", the "expand" property changes when the column is
2443 * resized by the user.
2448 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2451 GtkTreeViewColumnPrivate *priv;
2453 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2455 priv = tree_column->priv;
2457 expand = expand?TRUE:FALSE;
2458 if (priv->expand == expand)
2460 priv->expand = expand;
2462 if (priv->visible &&
2463 priv->tree_view != NULL &&
2464 gtk_widget_get_realized (priv->tree_view))
2466 gtk_widget_queue_resize (priv->tree_view);
2469 g_object_notify (G_OBJECT (tree_column), "expand");
2473 * gtk_tree_view_column_get_expand:
2474 * @tree_column: A #GtkTreeViewColumn.
2476 * Returns %TRUE if the column expands to fill available space.
2478 * Return value: %TRUE if the column expands to fill available space.
2483 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2485 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2487 return tree_column->priv->expand;
2491 * gtk_tree_view_column_set_clickable:
2492 * @tree_column: A #GtkTreeViewColumn.
2493 * @clickable: %TRUE if the header is active.
2495 * Sets the header to be active if @clickable is %TRUE. When the header is
2496 * active, then it can take keyboard focus, and can be clicked.
2499 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2502 GtkTreeViewColumnPrivate *priv;
2504 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2506 priv = tree_column->priv;
2508 clickable = !! clickable;
2509 if (priv->clickable == clickable)
2512 priv->clickable = clickable;
2513 gtk_tree_view_column_update_button (tree_column);
2514 g_object_notify (G_OBJECT (tree_column), "clickable");
2518 * gtk_tree_view_column_get_clickable:
2519 * @tree_column: a #GtkTreeViewColumn
2521 * Returns %TRUE if the user can click on the header for the column.
2523 * Return value: %TRUE if user can click the column header.
2526 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2528 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2530 return tree_column->priv->clickable;
2534 * gtk_tree_view_column_set_widget:
2535 * @tree_column: A #GtkTreeViewColumn.
2536 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2538 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2539 * header button is set with a #GtkLabel set to the title of @tree_column.
2542 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2545 GtkTreeViewColumnPrivate *priv;
2547 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2548 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2550 priv = tree_column->priv;
2553 g_object_ref_sink (widget);
2556 g_object_unref (priv->child);
2558 priv->child = widget;
2559 gtk_tree_view_column_update_button (tree_column);
2560 g_object_notify (G_OBJECT (tree_column), "widget");
2564 * gtk_tree_view_column_get_widget:
2565 * @tree_column: A #GtkTreeViewColumn.
2567 * Returns the #GtkWidget in the button on the column header.
2568 * If a custom widget has not been set then %NULL is returned.
2570 * Return value: (transfer none): The #GtkWidget in the column
2574 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2576 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2578 return tree_column->priv->child;
2582 * gtk_tree_view_column_set_alignment:
2583 * @tree_column: A #GtkTreeViewColumn.
2584 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2586 * Sets the alignment of the title or custom widget inside the column header.
2587 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2588 * for center, 1.0 for right.
2591 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2594 GtkTreeViewColumnPrivate *priv;
2596 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2598 priv = tree_column->priv;
2600 xalign = CLAMP (xalign, 0.0, 1.0);
2602 if (priv->xalign == xalign)
2605 priv->xalign = xalign;
2606 gtk_tree_view_column_update_button (tree_column);
2607 g_object_notify (G_OBJECT (tree_column), "alignment");
2611 * gtk_tree_view_column_get_alignment:
2612 * @tree_column: A #GtkTreeViewColumn.
2614 * Returns the current x alignment of @tree_column. This value can range
2615 * between 0.0 and 1.0.
2617 * Return value: The current alignent of @tree_column.
2620 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2622 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2624 return tree_column->priv->xalign;
2628 * gtk_tree_view_column_set_reorderable:
2629 * @tree_column: A #GtkTreeViewColumn
2630 * @reorderable: %TRUE, if the column can be reordered.
2632 * If @reorderable is %TRUE, then the column can be reordered by the end user
2633 * dragging the header.
2636 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2637 gboolean reorderable)
2639 GtkTreeViewColumnPrivate *priv;
2641 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2643 priv = tree_column->priv;
2646 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2648 if (priv->reorderable == (reorderable?TRUE:FALSE))
2651 priv->reorderable = (reorderable?TRUE:FALSE);
2652 gtk_tree_view_column_update_button (tree_column);
2653 g_object_notify (G_OBJECT (tree_column), "reorderable");
2657 * gtk_tree_view_column_get_reorderable:
2658 * @tree_column: A #GtkTreeViewColumn
2660 * Returns %TRUE if the @tree_column can be reordered by the user.
2662 * Return value: %TRUE if the @tree_column can be reordered by the user.
2665 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2667 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2669 return tree_column->priv->reorderable;
2674 * gtk_tree_view_column_set_sort_column_id:
2675 * @tree_column: a #GtkTreeViewColumn
2676 * @sort_column_id: The @sort_column_id of the model to sort on.
2678 * Sets the logical @sort_column_id that this column sorts on when this column
2679 * is selected for sorting. Doing so makes the column header clickable.
2682 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2683 gint sort_column_id)
2685 GtkTreeViewColumnPrivate *priv;
2687 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2688 g_return_if_fail (sort_column_id >= -1);
2690 priv = tree_column->priv;
2692 if (priv->sort_column_id == sort_column_id)
2695 priv->sort_column_id = sort_column_id;
2697 /* Handle unsetting the id */
2698 if (sort_column_id == -1)
2700 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2702 if (priv->sort_clicked_signal)
2704 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2705 priv->sort_clicked_signal = 0;
2708 if (priv->sort_column_changed_signal)
2710 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2711 priv->sort_column_changed_signal = 0;
2714 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2715 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2716 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2717 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2721 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2723 if (! priv->sort_clicked_signal)
2724 priv->sort_clicked_signal = g_signal_connect (tree_column,
2726 G_CALLBACK (gtk_tree_view_column_sort),
2729 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2730 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2734 * gtk_tree_view_column_get_sort_column_id:
2735 * @tree_column: a #GtkTreeViewColumn
2737 * Gets the logical @sort_column_id that the model sorts on when this
2738 * column is selected for sorting.
2739 * See gtk_tree_view_column_set_sort_column_id().
2741 * Return value: the current @sort_column_id for this column, or -1 if
2742 * this column can't be used for sorting.
2745 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2747 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2749 return tree_column->priv->sort_column_id;
2753 * gtk_tree_view_column_set_sort_indicator:
2754 * @tree_column: a #GtkTreeViewColumn
2755 * @setting: %TRUE to display an indicator that the column is sorted
2757 * Call this function with a @setting of %TRUE to display an arrow in
2758 * the header button indicating the column is sorted. Call
2759 * gtk_tree_view_column_set_sort_order() to change the direction of
2764 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2767 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2769 setting = setting != FALSE;
2771 if (setting == tree_column->priv->show_sort_indicator)
2774 tree_column->priv->show_sort_indicator = setting;
2775 gtk_tree_view_column_update_button (tree_column);
2776 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2780 * gtk_tree_view_column_get_sort_indicator:
2781 * @tree_column: a #GtkTreeViewColumn
2783 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2785 * Return value: whether the sort indicator arrow is displayed
2788 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2790 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2792 return tree_column->priv->show_sort_indicator;
2796 * gtk_tree_view_column_set_sort_order:
2797 * @tree_column: a #GtkTreeViewColumn
2798 * @order: sort order that the sort indicator should indicate
2800 * Changes the appearance of the sort indicator.
2802 * This <emphasis>does not</emphasis> actually sort the model. Use
2803 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2804 * support. This function is primarily for custom sorting behavior, and should
2805 * be used in conjunction with gtk_tree_sortable_set_sort_column_id() to do
2806 * that. For custom models, the mechanism will vary.
2808 * The sort indicator changes direction to indicate normal sort or reverse sort.
2809 * Note that you must have the sort indicator enabled to see anything when
2810 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2813 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2816 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2818 if (order == tree_column->priv->sort_order)
2821 tree_column->priv->sort_order = order;
2822 gtk_tree_view_column_update_button (tree_column);
2823 g_object_notify (G_OBJECT (tree_column), "sort-order");
2827 * gtk_tree_view_column_get_sort_order:
2828 * @tree_column: a #GtkTreeViewColumn
2830 * Gets the value set by gtk_tree_view_column_set_sort_order().
2832 * Return value: the sort order the sort indicator is indicating
2835 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2837 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2839 return tree_column->priv->sort_order;
2843 * gtk_tree_view_column_cell_set_cell_data:
2844 * @tree_column: A #GtkTreeViewColumn.
2845 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2846 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2847 * @is_expander: %TRUE, if the row has children
2848 * @is_expanded: %TRUE, if the row has visible children
2850 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2851 * every attribute mapping in @tree_column, it will get a value from the set
2852 * column on the @iter, and use that value to set the attribute on the cell
2853 * renderer. This is used primarily by the #GtkTreeView.
2856 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2857 GtkTreeModel *tree_model,
2859 gboolean is_expander,
2860 gboolean is_expanded)
2862 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2864 if (tree_model == NULL)
2867 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2868 is_expander, is_expanded);
2872 * gtk_tree_view_column_cell_get_size:
2873 * @tree_column: A #GtkTreeViewColumn.
2874 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2875 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2876 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2877 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2878 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2880 * Obtains the width and height needed to render the column. This is used
2881 * primarily by the #GtkTreeView.
2884 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2885 const GdkRectangle *cell_area,
2891 GtkTreeViewColumnPrivate *priv;
2892 gint min_width = 0, min_height = 0;
2894 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2896 priv = tree_column->priv;
2898 g_signal_handler_block (priv->cell_area_context,
2899 priv->context_changed_signal);
2901 gtk_cell_area_get_preferred_width (priv->cell_area,
2902 priv->cell_area_context,
2906 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2908 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2909 priv->cell_area_context,
2915 g_signal_handler_unblock (priv->cell_area_context,
2916 priv->context_changed_signal);
2920 * height = min_height;
2922 * width = min_width;
2927 * gtk_tree_view_column_cell_render:
2928 * @tree_column: A #GtkTreeViewColumn.
2929 * @cr: cairo context to draw to
2930 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2931 * @cell_area: area normally rendered by a cell renderer
2932 * @flags: flags that affect rendering
2934 * Renders the cell contained by #tree_column. This is used primarily by the
2938 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2940 const GdkRectangle *background_area,
2941 const GdkRectangle *cell_area,
2943 gboolean draw_focus)
2945 GtkTreeViewColumnPrivate *priv;
2947 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2948 g_return_if_fail (cr != NULL);
2949 g_return_if_fail (background_area != NULL);
2950 g_return_if_fail (cell_area != NULL);
2952 priv = tree_column->priv;
2956 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2957 priv->tree_view, cr,
2958 background_area, cell_area, flags,
2965 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2967 const GdkRectangle *cell_area,
2970 GtkTreeViewColumnPrivate *priv;
2972 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2974 priv = tree_column->priv;
2976 return gtk_cell_area_event (priv->cell_area,
2977 priv->cell_area_context,
2985 * gtk_tree_view_column_cell_is_visible:
2986 * @tree_column: A #GtkTreeViewColumn
2988 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2989 * For this to be meaningful, you must first initialize the cells with
2990 * gtk_tree_view_column_cell_set_cell_data()
2992 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2995 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2999 GtkTreeViewColumnPrivate *priv;
3001 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3003 priv = tree_column->priv;
3005 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
3006 for (list = cells; list; list = list->next)
3008 if (gtk_cell_renderer_get_visible (list->data))
3010 g_list_free (cells);
3015 g_list_free (cells);
3021 * gtk_tree_view_column_focus_cell:
3022 * @tree_column: A #GtkTreeViewColumn
3023 * @cell: A #GtkCellRenderer
3025 * Sets the current keyboard focus to be at @cell, if the column contains
3026 * 2 or more editable and activatable cells.
3031 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
3032 GtkCellRenderer *cell)
3034 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3035 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
3037 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
3041 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
3042 gboolean install_handler)
3044 GtkTreeViewColumnPrivate *priv = tree_column->priv;
3050 /* Issue a manual reset on the context to have all
3051 * sizes re-requested for the context.
3053 g_signal_handler_block (priv->cell_area_context,
3054 priv->context_changed_signal);
3055 gtk_cell_area_context_reset (priv->cell_area_context);
3056 g_signal_handler_unblock (priv->cell_area_context,
3057 priv->context_changed_signal);
3059 if (priv->tree_view &&
3060 gtk_widget_get_realized (priv->tree_view))
3062 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
3063 gtk_widget_queue_resize (priv->tree_view);
3068 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
3070 return tree_column->priv->dirty;
3074 * gtk_tree_view_column_cell_get_position:
3075 * @tree_column: a #GtkTreeViewColumn
3076 * @cell_renderer: a #GtkCellRenderer
3077 * @x_offset: (out) (allow-none): return location for the horizontal
3078 * position of @cell within @tree_column, may be %NULL
3079 * @width: (out) (allow-none): return location for the width of @cell,
3082 * Obtains the horizontal position and size of a cell in a column. If the
3083 * cell is not found in the column, @start_pos and @width are not changed and
3084 * %FALSE is returned.
3086 * Return value: %TRUE if @cell belongs to @tree_column.
3089 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3090 GtkCellRenderer *cell_renderer,
3094 GtkTreeViewColumnPrivate *priv;
3095 GdkRectangle cell_area;
3096 GdkRectangle allocation;
3098 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3099 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3101 priv = tree_column->priv;
3103 if (! gtk_cell_area_has_renderer (priv->cell_area, cell_renderer))
3106 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3107 NULL, tree_column, &cell_area);
3109 gtk_cell_area_get_cell_allocation (priv->cell_area,
3110 priv->cell_area_context,
3117 *x_offset = allocation.x - cell_area.x;
3120 *width = allocation.width;
3126 * gtk_tree_view_column_queue_resize:
3127 * @tree_column: A #GtkTreeViewColumn
3129 * Flags the column, and the cell renderers added to this column, to have
3130 * their sizes renegotiated.
3135 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3137 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3139 if (tree_column->priv->tree_view)
3140 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3144 * gtk_tree_view_column_get_tree_view:
3145 * @tree_column: A #GtkTreeViewColumn
3147 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3148 * If @column is currently not inserted in any tree view, %NULL is
3151 * Return value: (transfer none): The tree view wherein @column has
3152 * been inserted if any, %NULL otherwise.
3157 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3159 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3161 return tree_column->priv->tree_view;
3165 * gtk_tree_view_column_get_button:
3166 * @tree_column: A #GtkTreeViewColumn
3168 * Returns the button used in the treeview column header
3170 * Return value: (transfer none): The button for the column header.
3175 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3177 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3179 return tree_column->priv->button;
3183 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3185 return column->priv->window;
3189 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3192 column->priv->padding = MAX (column->priv->padding, padding);
3196 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3198 gint requested_width;
3200 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3202 return requested_width + column->priv->padding;
3206 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3208 return column->priv->drag_x;
3211 GtkCellAreaContext *
3212 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3214 return column->priv->cell_area_context;