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;
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;
211 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
213 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
214 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
215 gtk_tree_view_column_cell_layout_init)
216 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
217 gtk_tree_view_column_buildable_init))
221 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
223 GObjectClass *object_class;
225 object_class = (GObjectClass*) class;
227 class->clicked = NULL;
229 object_class->constructor = gtk_tree_view_column_constructor;
230 object_class->finalize = gtk_tree_view_column_finalize;
231 object_class->dispose = gtk_tree_view_column_dispose;
232 object_class->set_property = gtk_tree_view_column_set_property;
233 object_class->get_property = gtk_tree_view_column_get_property;
235 tree_column_signals[CLICKED] =
236 g_signal_new (I_("clicked"),
237 G_OBJECT_CLASS_TYPE (object_class),
239 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
241 _gtk_marshal_VOID__VOID,
244 g_object_class_install_property (object_class,
246 g_param_spec_boolean ("visible",
248 P_("Whether to display the column"),
250 GTK_PARAM_READWRITE));
252 g_object_class_install_property (object_class,
254 g_param_spec_boolean ("resizable",
256 P_("Column is user-resizable"),
258 GTK_PARAM_READWRITE));
260 g_object_class_install_property (object_class,
262 g_param_spec_int ("x-offset",
264 P_("Current X position of the column"),
268 GTK_PARAM_READABLE));
270 g_object_class_install_property (object_class,
272 g_param_spec_int ("width",
274 P_("Current width of the column"),
278 GTK_PARAM_READABLE));
279 g_object_class_install_property (object_class,
281 g_param_spec_int ("spacing",
283 P_("Space which is inserted between cells"),
287 GTK_PARAM_READWRITE));
288 g_object_class_install_property (object_class,
290 g_param_spec_enum ("sizing",
292 P_("Resize mode of the column"),
293 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
294 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
295 GTK_PARAM_READWRITE));
297 g_object_class_install_property (object_class,
299 g_param_spec_int ("fixed-width",
301 P_("Current fixed width of the column"),
305 GTK_PARAM_READWRITE));
307 g_object_class_install_property (object_class,
309 g_param_spec_int ("min-width",
311 P_("Minimum allowed width of the column"),
315 GTK_PARAM_READWRITE));
317 g_object_class_install_property (object_class,
319 g_param_spec_int ("max-width",
321 P_("Maximum allowed width of the column"),
325 GTK_PARAM_READWRITE));
327 g_object_class_install_property (object_class,
329 g_param_spec_string ("title",
331 P_("Title to appear in column header"),
333 GTK_PARAM_READWRITE));
335 g_object_class_install_property (object_class,
337 g_param_spec_boolean ("expand",
339 P_("Column gets share of extra width allocated to the widget"),
341 GTK_PARAM_READWRITE));
343 g_object_class_install_property (object_class,
345 g_param_spec_boolean ("clickable",
347 P_("Whether the header can be clicked"),
349 GTK_PARAM_READWRITE));
352 g_object_class_install_property (object_class,
354 g_param_spec_object ("widget",
356 P_("Widget to put in column header button instead of column title"),
358 GTK_PARAM_READWRITE));
360 g_object_class_install_property (object_class,
362 g_param_spec_float ("alignment",
364 P_("X Alignment of the column header text or widget"),
368 GTK_PARAM_READWRITE));
370 g_object_class_install_property (object_class,
372 g_param_spec_boolean ("reorderable",
374 P_("Whether the column can be reordered around the headers"),
376 GTK_PARAM_READWRITE));
378 g_object_class_install_property (object_class,
380 g_param_spec_boolean ("sort-indicator",
381 P_("Sort indicator"),
382 P_("Whether to show a sort indicator"),
384 GTK_PARAM_READWRITE));
386 g_object_class_install_property (object_class,
388 g_param_spec_enum ("sort-order",
390 P_("Sort direction the sort indicator should indicate"),
393 GTK_PARAM_READWRITE));
396 * GtkTreeViewColumn:sort-column-id:
398 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
399 * clickable. Set to %-1 to make the column unsortable.
403 g_object_class_install_property (object_class,
405 g_param_spec_int ("sort-column-id",
406 P_("Sort column ID"),
407 P_("Logical sort column ID this column sorts on when selected for sorting"),
411 GTK_PARAM_READWRITE));
414 * GtkTreeViewColumn:cell-area:
416 * The #GtkCellArea used to layout cell renderers for this column.
418 * If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area()
419 * a horizontally oriented #GtkCellAreaBox will be used.
423 g_object_class_install_property (object_class,
425 g_param_spec_object ("cell-area",
427 P_("The GtkCellArea used to layout cells"),
429 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
431 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
435 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
438 const gchar *tagname,
441 /* Just ignore the boolean return from here */
442 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
446 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
448 iface->add_child = _gtk_cell_layout_buildable_add_child;
449 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
450 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
454 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
456 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
460 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
462 GtkTreeViewColumnPrivate *priv;
464 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
465 GTK_TYPE_TREE_VIEW_COLUMN,
466 GtkTreeViewColumnPrivate);
467 priv = tree_column->priv;
473 priv->min_width = -1;
474 priv->max_width = -1;
475 priv->resized_width = 0;
476 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
477 priv->visible = TRUE;
478 priv->resizable = FALSE;
479 priv->expand = FALSE;
480 priv->clickable = FALSE;
482 priv->sort_order = GTK_SORT_ASCENDING;
483 priv->show_sort_indicator = FALSE;
484 priv->property_changed_signal = 0;
485 priv->sort_clicked_signal = 0;
486 priv->sort_column_changed_signal = 0;
487 priv->sort_column_id = -1;
488 priv->reorderable = FALSE;
489 priv->maybe_reordered = FALSE;
490 priv->fixed_width = 1;
491 priv->use_resized_width = FALSE;
492 priv->title = g_strdup ("");
496 gtk_tree_view_column_constructor (GType type,
497 guint n_construct_properties,
498 GObjectConstructParam *construct_properties)
500 GtkTreeViewColumn *tree_column;
503 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
504 (type, n_construct_properties, construct_properties);
506 tree_column = (GtkTreeViewColumn *) object;
508 gtk_tree_view_column_ensure_cell_area (tree_column, NULL);
514 gtk_tree_view_column_dispose (GObject *object)
516 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
517 GtkTreeViewColumnPrivate *priv = tree_column->priv;
519 /* Remove this column from its treeview,
520 * in case this column is destroyed before its treeview.
523 gtk_tree_view_remove_column (GTK_TREE_VIEW (priv->tree_view), tree_column);
525 if (priv->cell_area_context)
527 g_signal_handler_disconnect (priv->cell_area_context,
528 priv->context_changed_signal);
530 g_object_unref (priv->cell_area_context);
532 priv->cell_area_context = NULL;
533 priv->context_changed_signal = 0;
538 g_signal_handler_disconnect (priv->cell_area,
539 priv->add_editable_signal);
540 g_signal_handler_disconnect (priv->cell_area,
541 priv->remove_editable_signal);
543 g_object_unref (priv->cell_area);
544 priv->cell_area = NULL;
545 priv->add_editable_signal = 0;
546 priv->remove_editable_signal = 0;
551 g_object_unref (priv->child);
555 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
559 gtk_tree_view_column_finalize (GObject *object)
561 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
562 GtkTreeViewColumnPrivate *priv = tree_column->priv;
564 g_free (priv->title);
566 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
570 gtk_tree_view_column_set_property (GObject *object,
575 GtkTreeViewColumn *tree_column;
578 tree_column = GTK_TREE_VIEW_COLUMN (object);
583 gtk_tree_view_column_set_visible (tree_column,
584 g_value_get_boolean (value));
588 gtk_tree_view_column_set_resizable (tree_column,
589 g_value_get_boolean (value));
593 gtk_tree_view_column_set_sizing (tree_column,
594 g_value_get_enum (value));
597 case PROP_FIXED_WIDTH:
598 gtk_tree_view_column_set_fixed_width (tree_column,
599 g_value_get_int (value));
603 gtk_tree_view_column_set_min_width (tree_column,
604 g_value_get_int (value));
608 gtk_tree_view_column_set_max_width (tree_column,
609 g_value_get_int (value));
613 gtk_tree_view_column_set_spacing (tree_column,
614 g_value_get_int (value));
618 gtk_tree_view_column_set_title (tree_column,
619 g_value_get_string (value));
623 gtk_tree_view_column_set_expand (tree_column,
624 g_value_get_boolean (value));
628 gtk_tree_view_column_set_clickable (tree_column,
629 g_value_get_boolean (value));
633 gtk_tree_view_column_set_widget (tree_column,
634 (GtkWidget*) g_value_get_object (value));
638 gtk_tree_view_column_set_alignment (tree_column,
639 g_value_get_float (value));
642 case PROP_REORDERABLE:
643 gtk_tree_view_column_set_reorderable (tree_column,
644 g_value_get_boolean (value));
647 case PROP_SORT_INDICATOR:
648 gtk_tree_view_column_set_sort_indicator (tree_column,
649 g_value_get_boolean (value));
652 case PROP_SORT_ORDER:
653 gtk_tree_view_column_set_sort_order (tree_column,
654 g_value_get_enum (value));
657 case PROP_SORT_COLUMN_ID:
658 gtk_tree_view_column_set_sort_column_id (tree_column,
659 g_value_get_int (value));
663 /* Construct-only, can only be assigned once */
664 area = g_value_get_object (value);
668 if (tree_column->priv->cell_area != NULL)
670 g_warning ("cell-area has already been set, ignoring construct property");
671 g_object_ref_sink (area);
672 g_object_unref (area);
675 gtk_tree_view_column_ensure_cell_area (tree_column, area);
680 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
686 gtk_tree_view_column_get_property (GObject *object,
691 GtkTreeViewColumn *tree_column;
693 tree_column = GTK_TREE_VIEW_COLUMN (object);
698 g_value_set_boolean (value,
699 gtk_tree_view_column_get_visible (tree_column));
703 g_value_set_boolean (value,
704 gtk_tree_view_column_get_resizable (tree_column));
708 g_value_set_int (value,
709 gtk_tree_view_column_get_x_offset (tree_column));
713 g_value_set_int (value,
714 gtk_tree_view_column_get_width (tree_column));
718 g_value_set_int (value,
719 gtk_tree_view_column_get_spacing (tree_column));
723 g_value_set_enum (value,
724 gtk_tree_view_column_get_sizing (tree_column));
727 case PROP_FIXED_WIDTH:
728 g_value_set_int (value,
729 gtk_tree_view_column_get_fixed_width (tree_column));
733 g_value_set_int (value,
734 gtk_tree_view_column_get_min_width (tree_column));
738 g_value_set_int (value,
739 gtk_tree_view_column_get_max_width (tree_column));
743 g_value_set_string (value,
744 gtk_tree_view_column_get_title (tree_column));
748 g_value_set_boolean (value,
749 gtk_tree_view_column_get_expand (tree_column));
753 g_value_set_boolean (value,
754 gtk_tree_view_column_get_clickable (tree_column));
758 g_value_set_object (value,
759 (GObject*) gtk_tree_view_column_get_widget (tree_column));
763 g_value_set_float (value,
764 gtk_tree_view_column_get_alignment (tree_column));
767 case PROP_REORDERABLE:
768 g_value_set_boolean (value,
769 gtk_tree_view_column_get_reorderable (tree_column));
772 case PROP_SORT_INDICATOR:
773 g_value_set_boolean (value,
774 gtk_tree_view_column_get_sort_indicator (tree_column));
777 case PROP_SORT_ORDER:
778 g_value_set_enum (value,
779 gtk_tree_view_column_get_sort_order (tree_column));
782 case PROP_SORT_COLUMN_ID:
783 g_value_set_int (value,
784 gtk_tree_view_column_get_sort_column_id (tree_column));
788 g_value_set_object (value, tree_column->priv->cell_area);
792 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
797 /* Implementation of GtkCellLayout interface
801 gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
802 GtkCellArea *cell_area)
804 GtkTreeViewColumnPrivate *priv = column->priv;
810 priv->cell_area = cell_area;
812 priv->cell_area = gtk_cell_area_box_new ();
814 g_object_ref_sink (priv->cell_area);
816 priv->add_editable_signal =
817 g_signal_connect (priv->cell_area, "add-editable",
818 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
820 priv->remove_editable_signal =
821 g_signal_connect (priv->cell_area, "remove-editable",
822 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
825 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
827 priv->context_changed_signal =
828 g_signal_connect (priv->cell_area_context, "notify",
829 G_CALLBACK (gtk_tree_view_column_context_changed),
834 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
836 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
837 GtkTreeViewColumnPrivate *priv = column->priv;
839 if (G_UNLIKELY (!priv->cell_area))
840 gtk_tree_view_column_ensure_cell_area (column, NULL);
842 return priv->cell_area;
845 /* Button handling code
848 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
850 GtkTreeViewColumnPrivate *priv = tree_column->priv;
851 GtkTreeView *tree_view;
855 tree_view = (GtkTreeView *) priv->tree_view;
857 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
858 g_return_if_fail (priv->button == NULL);
860 gtk_widget_push_composite_child ();
861 priv->button = gtk_button_new ();
863 gtk_widget_show (priv->button);
864 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
865 gtk_widget_pop_composite_child ();
867 /* make sure we own a reference to it as well. */
868 if (_gtk_tree_view_get_header_window (tree_view))
869 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
871 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
873 g_signal_connect (priv->button, "event",
874 G_CALLBACK (gtk_tree_view_column_button_event),
876 g_signal_connect (priv->button, "clicked",
877 G_CALLBACK (gtk_tree_view_column_button_clicked),
880 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
882 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
883 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
889 child = gtk_label_new (priv->title);
890 gtk_widget_show (child);
893 g_signal_connect (child, "mnemonic-activate",
894 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
897 if (priv->xalign <= 0.5)
898 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
900 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
902 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
904 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
905 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
907 gtk_widget_show (hbox);
908 gtk_widget_show (priv->alignment);
909 gtk_tree_view_column_update_button (tree_column);
913 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
915 GtkTreeViewColumnPrivate *priv = tree_column->priv;
916 gint sort_column_id = -1;
918 GtkWidget *alignment;
920 GtkWidget *current_child;
921 GtkArrowType arrow_type = GTK_ARROW_NONE;
925 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
929 /* Create a button if necessary */
931 priv->button == NULL &&
933 gtk_widget_get_realized (priv->tree_view))
934 gtk_tree_view_column_create_button (tree_column);
939 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
940 alignment = priv->alignment;
942 current_child = gtk_bin_get_child (GTK_BIN (alignment));
944 /* Set up the actual button */
945 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
950 if (current_child != priv->child)
952 gtk_container_remove (GTK_CONTAINER (alignment),
954 gtk_container_add (GTK_CONTAINER (alignment),
960 if (current_child == NULL)
962 current_child = gtk_label_new (NULL);
963 gtk_widget_show (current_child);
964 gtk_container_add (GTK_CONTAINER (alignment),
968 g_return_if_fail (GTK_IS_LABEL (current_child));
971 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
974 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
978 if (GTK_IS_TREE_SORTABLE (model))
979 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
983 if (priv->show_sort_indicator)
985 gboolean alternative;
987 g_object_get (gtk_widget_get_settings (priv->tree_view),
988 "gtk-alternative-sort-arrows", &alternative,
991 switch (priv->sort_order)
993 case GTK_SORT_ASCENDING:
994 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
997 case GTK_SORT_DESCENDING:
998 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
1002 g_warning (G_STRLOC": bad sort order");
1007 gtk_arrow_set (GTK_ARROW (arrow),
1011 /* Put arrow on the right if the text is left-or-center justified, and on the
1012 * left otherwise; do this by packing boxes, so flipping text direction will
1015 g_object_ref (arrow);
1016 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
1018 if (priv->xalign <= 0.5)
1020 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1024 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1025 /* move it to the front */
1026 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
1028 g_object_unref (arrow);
1030 if (priv->show_sort_indicator
1031 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
1032 gtk_widget_show (arrow);
1034 gtk_widget_hide (arrow);
1036 /* It's always safe to hide the button. It isn't always safe to show it, as
1037 * if you show it before it's realized, it'll get the wrong window. */
1039 priv->tree_view != NULL &&
1040 gtk_widget_get_realized (priv->tree_view))
1044 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
1045 gtk_widget_show_now (priv->button);
1049 if (priv->resizable)
1051 gdk_window_show (priv->window);
1052 gdk_window_raise (priv->window);
1056 gdk_window_hide (priv->window);
1062 gtk_widget_hide (priv->button);
1064 gdk_window_hide (priv->window);
1068 if (priv->reorderable || priv->clickable)
1070 gtk_widget_set_can_focus (priv->button, TRUE);
1074 gtk_widget_set_can_focus (priv->button, FALSE);
1075 if (gtk_widget_has_focus (priv->button))
1077 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1078 if (gtk_widget_is_toplevel (toplevel))
1080 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1084 /* Queue a resize on the assumption that we always want to catch all changes
1085 * and columns don't change all that often.
1087 if (gtk_widget_get_realized (priv->tree_view))
1088 gtk_widget_queue_resize (priv->tree_view);
1092 /* Button signal handlers
1096 gtk_tree_view_column_button_event (GtkWidget *widget,
1100 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1101 GtkTreeViewColumnPrivate *priv = column->priv;
1103 g_return_val_if_fail (event != NULL, FALSE);
1105 if (event->type == GDK_BUTTON_PRESS &&
1106 priv->reorderable &&
1107 ((GdkEventButton *)event)->button == GDK_BUTTON_PRIMARY)
1109 priv->maybe_reordered = TRUE;
1110 gdk_window_get_device_position (gtk_button_get_event_window (GTK_BUTTON (widget)),
1111 gdk_event_get_device (event),
1115 gtk_widget_grab_focus (widget);
1118 if (event->type == GDK_BUTTON_RELEASE ||
1119 event->type == GDK_LEAVE_NOTIFY)
1120 priv->maybe_reordered = FALSE;
1122 if (event->type == GDK_MOTION_NOTIFY &&
1123 priv->maybe_reordered &&
1124 (gtk_drag_check_threshold (widget,
1127 (gint) ((GdkEventMotion *)event)->x,
1128 (gint) ((GdkEventMotion *)event)->y)))
1130 priv->maybe_reordered = FALSE;
1131 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1132 event->motion.device);
1136 if (priv->clickable == FALSE)
1138 switch (event->type)
1140 case GDK_BUTTON_PRESS:
1141 case GDK_2BUTTON_PRESS:
1142 case GDK_3BUTTON_PRESS:
1143 case GDK_MOTION_NOTIFY:
1144 case GDK_BUTTON_RELEASE:
1145 case GDK_ENTER_NOTIFY:
1146 case GDK_LEAVE_NOTIFY:
1157 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1159 g_signal_emit_by_name (data, "clicked");
1163 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1164 gboolean group_cycling,
1167 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1168 GtkTreeViewColumnPrivate *priv = column->priv;
1170 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1172 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1174 if (priv->clickable)
1175 gtk_button_clicked (GTK_BUTTON (priv->button));
1176 else if (gtk_widget_get_can_focus (priv->button))
1177 gtk_widget_grab_focus (priv->button);
1179 gtk_widget_grab_focus (priv->tree_view);
1185 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1186 GtkTreeViewColumn *column)
1188 GtkTreeViewColumnPrivate *priv = column->priv;
1189 gint sort_column_id;
1192 if (gtk_tree_sortable_get_sort_column_id (sortable,
1196 if (sort_column_id == priv->sort_column_id)
1198 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1199 gtk_tree_view_column_set_sort_order (column, order);
1203 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1208 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1213 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1216 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1217 GtkTreeModel *model;
1218 GtkTreeSortable *sortable;
1219 gint sort_column_id;
1221 gboolean has_sort_column;
1222 gboolean has_default_sort_func;
1224 g_return_if_fail (priv->tree_view != NULL);
1226 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1227 sortable = GTK_TREE_SORTABLE (model);
1230 gtk_tree_sortable_get_sort_column_id (sortable,
1233 has_default_sort_func =
1234 gtk_tree_sortable_has_default_sort_func (sortable);
1236 if (has_sort_column &&
1237 sort_column_id == priv->sort_column_id)
1239 if (order == GTK_SORT_ASCENDING)
1240 gtk_tree_sortable_set_sort_column_id (sortable,
1241 priv->sort_column_id,
1242 GTK_SORT_DESCENDING);
1243 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1244 gtk_tree_sortable_set_sort_column_id (sortable,
1245 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1246 GTK_SORT_ASCENDING);
1248 gtk_tree_sortable_set_sort_column_id (sortable,
1249 priv->sort_column_id,
1250 GTK_SORT_ASCENDING);
1254 gtk_tree_sortable_set_sort_column_id (sortable,
1255 priv->sort_column_id,
1256 GTK_SORT_ASCENDING);
1261 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1263 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1264 GtkTreeModel *model;
1266 if (priv->tree_view == NULL)
1269 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1274 if (GTK_IS_TREE_SORTABLE (model) &&
1275 priv->sort_column_id != -1)
1277 gint real_sort_column_id;
1278 GtkSortType real_order;
1280 if (priv->sort_column_changed_signal == 0)
1281 priv->sort_column_changed_signal =
1282 g_signal_connect (model, "sort-column-changed",
1283 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1286 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1287 &real_sort_column_id,
1289 (real_sort_column_id == priv->sort_column_id))
1291 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1292 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1296 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1302 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1304 GtkTreeViewColumn *tree_column)
1306 /* Here we want the column re-requested if the underlying context was
1307 * actually reset for any reason, this can happen if the underlying
1308 * area/cell configuration changes (i.e. cell packing properties
1309 * or cell spacing and the like)
1311 * Note that we block this handler while requesting for sizes
1312 * so there is no need to check for the new context size being -1,
1313 * we also block the handler when explicitly resetting the context
1314 * so as to avoid some infinite stack recursion.
1316 if (!strcmp (pspec->name, "minimum-width") ||
1317 !strcmp (pspec->name, "natural-width") ||
1318 !strcmp (pspec->name, "minimum-height") ||
1319 !strcmp (pspec->name, "natural-height"))
1320 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1324 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1325 GtkCellRenderer *renderer,
1326 GtkCellEditable *edit_widget,
1327 GdkRectangle *cell_area,
1328 const gchar *path_string,
1331 GtkTreeViewColumn *column = user_data;
1332 GtkTreeViewColumnPrivate *priv = column->priv;
1335 if (priv->tree_view)
1337 path = gtk_tree_path_new_from_string (path_string);
1339 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1345 gtk_tree_path_free (path);
1350 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1351 GtkCellRenderer *renderer,
1352 GtkCellEditable *edit_widget,
1355 GtkTreeViewColumn *column = user_data;
1356 GtkTreeViewColumnPrivate *priv = column->priv;
1358 if (priv->tree_view)
1359 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1364 /* Exported Private Functions.
1365 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1368 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1370 GtkTreeViewColumnPrivate *priv = column->priv;
1371 GtkAllocation allocation;
1372 GtkTreeView *tree_view;
1374 guint attributes_mask;
1377 tree_view = (GtkTreeView *)priv->tree_view;
1378 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1380 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1381 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1382 g_return_if_fail (priv->button != NULL);
1384 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1385 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1387 attr.window_type = GDK_WINDOW_CHILD;
1388 attr.wclass = GDK_INPUT_ONLY;
1389 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1390 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1391 (GDK_BUTTON_PRESS_MASK |
1392 GDK_BUTTON_RELEASE_MASK |
1393 GDK_POINTER_MOTION_MASK |
1394 GDK_POINTER_MOTION_HINT_MASK |
1395 GDK_KEY_PRESS_MASK);
1396 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1397 attr.cursor = gdk_cursor_new_for_display
1398 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1400 attr.width = TREE_VIEW_DRAG_WIDTH;
1401 attr.height = _gtk_tree_view_get_header_height (tree_view);
1403 gtk_widget_get_allocation (priv->button, &allocation);
1404 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1405 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1406 &attr, attributes_mask);
1407 gdk_window_set_user_data (priv->window, tree_view);
1409 gtk_tree_view_column_update_button (column);
1411 g_object_unref (attr.cursor);
1415 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1417 GtkTreeViewColumnPrivate *priv;
1419 g_return_if_fail (column != NULL);
1421 priv = column->priv;
1422 g_return_if_fail (priv->window != NULL);
1424 gdk_window_set_user_data (priv->window, NULL);
1425 gdk_window_destroy (priv->window);
1426 priv->window = NULL;
1430 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1431 GtkTreeModel *old_model)
1433 GtkTreeViewColumnPrivate *priv = column->priv;
1435 if (priv->sort_column_changed_signal)
1437 g_signal_handler_disconnect (old_model,
1438 priv->sort_column_changed_signal);
1439 priv->sort_column_changed_signal = 0;
1441 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1445 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1446 GtkTreeView *tree_view)
1448 GtkTreeViewColumnPrivate *priv = column->priv;
1450 g_assert (priv->tree_view == NULL);
1452 priv->tree_view = GTK_WIDGET (tree_view);
1453 gtk_tree_view_column_create_button (column);
1455 priv->property_changed_signal =
1456 g_signal_connect_swapped (tree_view,
1458 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1461 gtk_tree_view_column_setup_sort_column_id_callback (column);
1465 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1467 GtkTreeViewColumnPrivate *priv = column->priv;
1469 if (priv->tree_view && priv->button)
1471 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1473 if (priv->property_changed_signal)
1475 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1476 priv->property_changed_signal = 0;
1479 if (priv->sort_column_changed_signal)
1481 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1482 priv->sort_column_changed_signal);
1483 priv->sort_column_changed_signal = 0;
1486 priv->tree_view = NULL;
1487 priv->button = NULL;
1491 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1493 GtkTreeViewColumnPrivate *priv = column->priv;
1494 gboolean ret = FALSE;
1495 GList *list, *cells;
1497 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1499 for (list = cells; list; list = list->next)
1501 GtkCellRenderer *cell = list->data;
1502 GtkCellRendererMode mode;
1504 g_object_get (cell, "mode", &mode, NULL);
1506 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1513 g_list_free (cells);
1518 /* gets cell being edited */
1520 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1522 GtkTreeViewColumnPrivate *priv = column->priv;
1524 return gtk_cell_area_get_edited_cell (priv->cell_area);
1528 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1529 GdkRectangle *cell_area,
1530 GdkRectangle *background_area,
1534 GtkCellRenderer *match = NULL;
1535 GtkTreeViewColumnPrivate *priv = column->priv;
1537 /* If (x, y) is outside of the background area, immediately return */
1538 if (x < background_area->x ||
1539 x > background_area->x + background_area->width ||
1540 y < background_area->y ||
1541 y > background_area->y + background_area->height)
1544 /* If (x, y) is inside the background area, clamp it to the cell_area
1545 * so that a cell is still returned. The main reason for doing this
1546 * (on the x axis) is for handling clicks in the indentation area
1547 * (either at the left or right depending on RTL setting). Another
1548 * reason is for handling clicks on the area where the focus rectangle
1549 * is drawn (this is outside of cell area), this manifests itself
1550 * mainly when a large setting is used for focus-line-width.
1552 if (x < cell_area->x)
1554 else if (x > cell_area->x + cell_area->width)
1555 x = cell_area->x + cell_area->width;
1557 if (y < cell_area->y)
1559 else if (y > cell_area->y + cell_area->height)
1560 y = cell_area->y + cell_area->height;
1562 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1563 priv->cell_area_context,
1573 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1574 GdkRectangle *cell_area,
1575 GdkRectangle *background_area,
1579 GtkCellRenderer *match;
1580 GdkRectangle cell_alloc, aligned_area, inner_area;
1581 GtkTreeViewColumnPrivate *priv = column->priv;
1583 match = _gtk_tree_view_column_get_cell_at_pos (column,
1590 gtk_cell_area_get_cell_allocation (priv->cell_area,
1591 priv->cell_area_context,
1597 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1598 &cell_alloc, &inner_area);
1599 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1600 &inner_area, &aligned_area);
1602 if (x < aligned_area.x ||
1603 x > aligned_area.x + aligned_area.width ||
1604 y < aligned_area.y ||
1605 y > aligned_area.y + aligned_area.height)
1611 /* Public Functions */
1615 * gtk_tree_view_column_new:
1617 * Creates a new #GtkTreeViewColumn.
1619 * Return value: A newly created #GtkTreeViewColumn.
1622 gtk_tree_view_column_new (void)
1624 GtkTreeViewColumn *tree_column;
1626 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1632 * gtk_tree_view_column_new_with_area:
1633 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1635 * Creates a new #GtkTreeViewColumn using @area to render its cells.
1637 * Return value: A newly created #GtkTreeViewColumn.
1642 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1644 GtkTreeViewColumn *tree_column;
1646 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1653 * gtk_tree_view_column_new_with_attributes:
1654 * @title: The title to set the header to
1655 * @cell: The #GtkCellRenderer
1656 * @...: A %NULL-terminated list of attributes
1658 * Creates a new #GtkTreeViewColumn with a number of default values.
1659 * This is equivalent to calling gtk_tree_view_column_set_title(),
1660 * gtk_tree_view_column_pack_start(), and
1661 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1663 * Here's a simple example:
1665 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1668 * GtkTreeViewColumn *column;
1669 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1671 * column = gtk_tree_view_column_new_with_attributes ("Title",
1673 * "text", TEXT_COLUMN,
1674 * "foreground", COLOR_COLUMN,
1679 * Return value: A newly created #GtkTreeViewColumn.
1682 gtk_tree_view_column_new_with_attributes (const gchar *title,
1683 GtkCellRenderer *cell,
1686 GtkTreeViewColumn *retval;
1689 retval = gtk_tree_view_column_new ();
1691 gtk_tree_view_column_set_title (retval, title);
1692 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1694 va_start (args, cell);
1695 gtk_tree_view_column_set_attributesv (retval, cell, args);
1702 * gtk_tree_view_column_pack_start:
1703 * @tree_column: A #GtkTreeViewColumn.
1704 * @cell: The #GtkCellRenderer.
1705 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1707 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1708 * the @cell is allocated no more space than it needs. Any unused space is divided
1709 * evenly between cells for which @expand is %TRUE.
1712 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1713 GtkCellRenderer *cell,
1716 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1720 * gtk_tree_view_column_pack_end:
1721 * @tree_column: A #GtkTreeViewColumn.
1722 * @cell: The #GtkCellRenderer.
1723 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1725 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1726 * is allocated no more space than it needs. Any unused space is divided
1727 * evenly between cells for which @expand is %TRUE.
1730 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1731 GtkCellRenderer *cell,
1734 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1738 * gtk_tree_view_column_clear:
1739 * @tree_column: A #GtkTreeViewColumn
1741 * Unsets all the mappings on all renderers on the @tree_column.
1744 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1746 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1750 * gtk_tree_view_column_add_attribute:
1751 * @tree_column: A #GtkTreeViewColumn.
1752 * @cell_renderer: the #GtkCellRenderer to set attributes on
1753 * @attribute: An attribute on the renderer
1754 * @column: The column position on the model to get the attribute from.
1756 * Adds an attribute mapping to the list in @tree_column. The @column is the
1757 * column of the model to get a value from, and the @attribute is the
1758 * parameter on @cell_renderer to be set from the value. So for example
1759 * if column 2 of the model contains strings, you could have the
1760 * "text" attribute of a #GtkCellRendererText get its values from
1764 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1765 GtkCellRenderer *cell_renderer,
1766 const gchar *attribute,
1769 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1770 cell_renderer, attribute, column);
1774 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1775 GtkCellRenderer *cell_renderer,
1778 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1782 attribute = va_arg (args, gchar *);
1784 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1787 while (attribute != NULL)
1789 column = va_arg (args, gint);
1790 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1791 cell_renderer, attribute, column);
1792 attribute = va_arg (args, gchar *);
1797 * gtk_tree_view_column_set_attributes:
1798 * @tree_column: A #GtkTreeViewColumn
1799 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1800 * @...: A %NULL-terminated list of attributes
1802 * Sets the attributes in the list as the attributes of @tree_column.
1803 * The attributes should be in attribute/column order, as in
1804 * gtk_tree_view_column_add_attribute(). All existing attributes
1805 * are removed, and replaced with the new attributes.
1808 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1809 GtkCellRenderer *cell_renderer,
1814 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1815 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1817 va_start (args, cell_renderer);
1818 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1824 * gtk_tree_view_column_set_cell_data_func:
1825 * @tree_column: A #GtkTreeViewColumn
1826 * @cell_renderer: A #GtkCellRenderer
1827 * @func: (allow-none): The #GtkTreeCellDataFunc to use.
1828 * @func_data: The user data for @func.
1829 * @destroy: The destroy notification for @func_data
1831 * Sets the #GtkTreeCellDataFunc to use for the column. This
1832 * function is used instead of the standard attributes mapping for
1833 * setting the column value, and should set the value of @tree_column's
1834 * cell renderer as appropriate. @func may be %NULL to remove an
1838 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1839 GtkCellRenderer *cell_renderer,
1840 GtkTreeCellDataFunc func,
1842 GDestroyNotify destroy)
1844 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1846 (GtkCellLayoutDataFunc)func,
1847 func_data, destroy);
1852 * gtk_tree_view_column_clear_attributes:
1853 * @tree_column: a #GtkTreeViewColumn
1854 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1856 * Clears all existing attributes previously set with
1857 * gtk_tree_view_column_set_attributes().
1860 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1861 GtkCellRenderer *cell_renderer)
1863 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1868 * gtk_tree_view_column_set_spacing:
1869 * @tree_column: A #GtkTreeViewColumn.
1870 * @spacing: distance between cell renderers in pixels.
1872 * Sets the spacing field of @tree_column, which is the number of pixels to
1873 * place between cell renderers packed into it.
1876 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1879 GtkTreeViewColumnPrivate *priv;
1881 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1882 g_return_if_fail (spacing >= 0);
1884 priv = tree_column->priv;
1886 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1888 if (priv->tree_view)
1889 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1893 * gtk_tree_view_column_get_spacing:
1894 * @tree_column: A #GtkTreeViewColumn.
1896 * Returns the spacing of @tree_column.
1898 * Return value: the spacing of @tree_column.
1901 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1903 GtkTreeViewColumnPrivate *priv;
1905 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1907 priv = tree_column->priv;
1909 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1912 /* Options for manipulating the columns */
1915 * gtk_tree_view_column_set_visible:
1916 * @tree_column: A #GtkTreeViewColumn.
1917 * @visible: %TRUE if the @tree_column is visible.
1919 * Sets the visibility of @tree_column.
1922 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1925 GtkTreeViewColumnPrivate *priv;
1927 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1929 priv = tree_column->priv;
1930 visible = !! visible;
1932 if (priv->visible == visible)
1935 priv->visible = visible;
1938 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1940 if (priv->tree_view)
1942 _gtk_tree_view_reset_header_styles (GTK_TREE_VIEW (priv->tree_view));
1943 _gtk_tree_view_accessible_toggle_visibility (GTK_TREE_VIEW (priv->tree_view),
1947 gtk_tree_view_column_update_button (tree_column);
1948 g_object_notify (G_OBJECT (tree_column), "visible");
1952 * gtk_tree_view_column_get_visible:
1953 * @tree_column: A #GtkTreeViewColumn.
1955 * Returns %TRUE if @tree_column is visible.
1957 * Return value: whether the column is visible or not. If it is visible, then
1958 * the tree will show the column.
1961 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1963 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1965 return tree_column->priv->visible;
1969 * gtk_tree_view_column_set_resizable:
1970 * @tree_column: A #GtkTreeViewColumn
1971 * @resizable: %TRUE, if the column can be resized
1973 * If @resizable is %TRUE, then the user can explicitly resize the column by
1974 * grabbing the outer edge of the column button. If resizable is %TRUE and
1975 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1976 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1979 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1982 GtkTreeViewColumnPrivate *priv;
1984 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1986 priv = tree_column->priv;
1987 resizable = !! resizable;
1989 if (priv->resizable == resizable)
1992 priv->resizable = resizable;
1994 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1995 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1997 gtk_tree_view_column_update_button (tree_column);
1999 g_object_notify (G_OBJECT (tree_column), "resizable");
2003 * gtk_tree_view_column_get_resizable:
2004 * @tree_column: A #GtkTreeViewColumn
2006 * Returns %TRUE if the @tree_column can be resized by the end user.
2008 * Return value: %TRUE, if the @tree_column can be resized.
2011 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
2013 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2015 return tree_column->priv->resizable;
2020 * gtk_tree_view_column_set_sizing:
2021 * @tree_column: A #GtkTreeViewColumn.
2022 * @type: The #GtkTreeViewColumnSizing.
2024 * Sets the growth behavior of @tree_column to @type.
2027 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
2028 GtkTreeViewColumnSizing type)
2030 GtkTreeViewColumnPrivate *priv;
2032 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2034 priv = tree_column->priv;
2036 if (type == priv->column_type)
2039 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2040 gtk_tree_view_column_set_resizable (tree_column, FALSE);
2042 priv->column_type = type;
2044 gtk_tree_view_column_update_button (tree_column);
2046 g_object_notify (G_OBJECT (tree_column), "sizing");
2050 * gtk_tree_view_column_get_sizing:
2051 * @tree_column: A #GtkTreeViewColumn.
2053 * Returns the current type of @tree_column.
2055 * Return value: The type of @tree_column.
2057 GtkTreeViewColumnSizing
2058 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
2060 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2062 return tree_column->priv->column_type;
2066 * gtk_tree_view_column_get_width:
2067 * @tree_column: A #GtkTreeViewColumn.
2069 * Returns the current size of @tree_column in pixels.
2071 * Return value: The current width of @tree_column.
2074 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2076 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2078 return tree_column->priv->width;
2082 * gtk_tree_view_column_get_x_offset:
2083 * @tree_column: A #GtkTreeViewColumn.
2085 * Returns the current X offset of @tree_column in pixels.
2087 * Return value: The current X offset of @tree_column.
2092 gtk_tree_view_column_get_x_offset (GtkTreeViewColumn *tree_column)
2094 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2096 return tree_column->priv->x_offset;
2100 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2102 GtkTreeViewColumnPrivate *priv;
2103 gint real_requested_width;
2105 priv = tree_column->priv;
2107 if (priv->use_resized_width)
2109 real_requested_width = priv->resized_width;
2111 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2113 real_requested_width = priv->fixed_width;
2115 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2117 gint button_request;
2118 gint requested_width;
2120 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2121 requested_width += priv->padding;
2123 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2124 real_requested_width = MAX (requested_width, button_request);
2128 gint requested_width;
2130 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2131 requested_width += priv->padding;
2133 real_requested_width = requested_width;
2134 if (real_requested_width < 0)
2135 real_requested_width = 0;
2138 if (priv->min_width != -1)
2139 real_requested_width = MAX (real_requested_width, priv->min_width);
2141 if (priv->max_width != -1)
2142 real_requested_width = MIN (real_requested_width, priv->max_width);
2144 return real_requested_width;
2148 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2152 GtkTreeViewColumnPrivate *priv;
2154 GtkAllocation allocation = { 0, 0, 0, 0 };
2156 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2158 priv = tree_column->priv;
2160 if (priv->width != width)
2161 gtk_widget_queue_draw (priv->tree_view);
2163 priv->x_offset = x_offset;
2164 priv->width = width;
2166 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2168 if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2170 allocation.x = x_offset;
2172 allocation.width = width;
2173 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2175 gtk_widget_size_allocate (priv->button, &allocation);
2180 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2181 gdk_window_move_resize (priv->window,
2182 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2184 TREE_VIEW_DRAG_WIDTH, allocation.height);
2187 g_object_notify (G_OBJECT (tree_column), "x-offset");
2188 g_object_notify (G_OBJECT (tree_column), "width");
2192 * gtk_tree_view_column_set_fixed_width:
2193 * @tree_column: A #GtkTreeViewColumn.
2194 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2196 * Sets the size of the column in pixels. This is meaningful only if the sizing
2197 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2198 * the min/max width for the column. Please note that the min/max width of the
2199 * column doesn't actually affect the "fixed_width" property of the widget, just
2200 * the actual size when displayed.
2203 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2206 GtkTreeViewColumnPrivate *priv;
2208 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2209 g_return_if_fail (fixed_width > 0);
2211 priv = tree_column->priv;
2213 priv->fixed_width = fixed_width;
2214 priv->use_resized_width = FALSE;
2216 if (priv->tree_view &&
2217 gtk_widget_get_realized (priv->tree_view) &&
2218 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2220 gtk_widget_queue_resize (priv->tree_view);
2223 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2227 * gtk_tree_view_column_get_fixed_width:
2228 * @tree_column: a #GtkTreeViewColumn
2230 * Gets the fixed width of the column. This value is only meaning may not be
2231 * the actual width of the column on the screen, just what is requested.
2233 * Return value: the fixed width of the column
2236 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2238 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2240 return tree_column->priv->fixed_width;
2244 * gtk_tree_view_column_set_min_width:
2245 * @tree_column: A #GtkTreeViewColumn.
2246 * @min_width: The minimum width of the column in pixels, or -1.
2248 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2249 * minimum width is unset.
2252 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2255 GtkTreeViewColumnPrivate *priv;
2257 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2258 g_return_if_fail (min_width >= -1);
2260 priv = tree_column->priv;
2262 if (min_width == priv->min_width)
2265 if (priv->visible &&
2266 priv->tree_view != NULL &&
2267 gtk_widget_get_realized (priv->tree_view))
2269 if (min_width > priv->width)
2270 gtk_widget_queue_resize (priv->tree_view);
2273 priv->min_width = min_width;
2274 g_object_freeze_notify (G_OBJECT (tree_column));
2275 if (priv->max_width != -1 && priv->max_width < min_width)
2277 priv->max_width = min_width;
2278 g_object_notify (G_OBJECT (tree_column), "max-width");
2280 g_object_notify (G_OBJECT (tree_column), "min-width");
2281 g_object_thaw_notify (G_OBJECT (tree_column));
2283 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2284 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2289 * gtk_tree_view_column_get_min_width:
2290 * @tree_column: A #GtkTreeViewColumn.
2292 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2295 * Return value: The minimum width of the @tree_column.
2298 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2300 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2302 return tree_column->priv->min_width;
2306 * gtk_tree_view_column_set_max_width:
2307 * @tree_column: A #GtkTreeViewColumn.
2308 * @max_width: The maximum width of the column in pixels, or -1.
2310 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2311 * maximum width is unset. Note, the column can actually be wider than max
2312 * width if it's the last column in a view. In this case, the column expands to
2313 * fill any extra space.
2316 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2319 GtkTreeViewColumnPrivate *priv;
2321 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2322 g_return_if_fail (max_width >= -1);
2324 priv = tree_column->priv;
2326 if (max_width == priv->max_width)
2329 if (priv->visible &&
2330 priv->tree_view != NULL &&
2331 gtk_widget_get_realized (priv->tree_view))
2333 if (max_width != -1 && max_width < priv->width)
2334 gtk_widget_queue_resize (priv->tree_view);
2337 priv->max_width = max_width;
2338 g_object_freeze_notify (G_OBJECT (tree_column));
2339 if (max_width != -1 && max_width < priv->min_width)
2341 priv->min_width = max_width;
2342 g_object_notify (G_OBJECT (tree_column), "min-width");
2344 g_object_notify (G_OBJECT (tree_column), "max-width");
2345 g_object_thaw_notify (G_OBJECT (tree_column));
2347 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2348 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2353 * gtk_tree_view_column_get_max_width:
2354 * @tree_column: A #GtkTreeViewColumn.
2356 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2359 * Return value: The maximum width of the @tree_column.
2362 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2364 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2366 return tree_column->priv->max_width;
2370 * gtk_tree_view_column_clicked:
2371 * @tree_column: a #GtkTreeViewColumn
2373 * Emits the "clicked" signal on the column. This function will only work if
2374 * @tree_column is clickable.
2377 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2379 GtkTreeViewColumnPrivate *priv;
2381 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2383 priv = tree_column->priv;
2385 if (priv->visible &&
2388 gtk_button_clicked (GTK_BUTTON (priv->button));
2392 * gtk_tree_view_column_set_title:
2393 * @tree_column: A #GtkTreeViewColumn.
2394 * @title: The title of the @tree_column.
2396 * Sets the title of the @tree_column. If a custom widget has been set, then
2397 * this value is ignored.
2400 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2403 GtkTreeViewColumnPrivate *priv;
2406 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2408 priv = tree_column->priv;
2410 new_title = g_strdup (title);
2411 g_free (priv->title);
2412 priv->title = new_title;
2414 gtk_tree_view_column_update_button (tree_column);
2415 g_object_notify (G_OBJECT (tree_column), "title");
2419 * gtk_tree_view_column_get_title:
2420 * @tree_column: A #GtkTreeViewColumn.
2422 * Returns the title of the widget.
2424 * Return value: the title of the column. This string should not be
2425 * modified or freed.
2428 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2430 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2432 return tree_column->priv->title;
2436 * gtk_tree_view_column_set_expand:
2437 * @tree_column: A #GtkTreeViewColumn
2438 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2440 * Sets the column to take available extra space. This space is shared equally
2441 * amongst all columns that have the expand set to %TRUE. If no column has this
2442 * option set, then the last column gets all extra space. By default, every
2443 * column is created with this %FALSE.
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 /* We want to continue using the original width of the
2467 * column that includes additional space added by the user
2468 * resizing the columns and possibly extra (expanded) space, which
2469 * are not included in the resized width.
2471 priv->use_resized_width = FALSE;
2473 gtk_widget_queue_resize (priv->tree_view);
2476 g_object_notify (G_OBJECT (tree_column), "expand");
2480 * gtk_tree_view_column_get_expand:
2481 * @tree_column: a #GtkTreeViewColumn
2483 * Return %TRUE if the column expands to take any available space.
2485 * Return value: %TRUE, if the column expands
2490 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2492 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2494 return tree_column->priv->expand;
2498 * gtk_tree_view_column_set_clickable:
2499 * @tree_column: A #GtkTreeViewColumn.
2500 * @clickable: %TRUE if the header is active.
2502 * Sets the header to be active if @clickable is %TRUE. When the header is
2503 * active, then it can take keyboard focus, and can be clicked.
2506 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2509 GtkTreeViewColumnPrivate *priv;
2511 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2513 priv = tree_column->priv;
2515 clickable = !! clickable;
2516 if (priv->clickable == clickable)
2519 priv->clickable = clickable;
2520 gtk_tree_view_column_update_button (tree_column);
2521 g_object_notify (G_OBJECT (tree_column), "clickable");
2525 * gtk_tree_view_column_get_clickable:
2526 * @tree_column: a #GtkTreeViewColumn
2528 * Returns %TRUE if the user can click on the header for the column.
2530 * Return value: %TRUE if user can click the column header.
2533 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2535 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2537 return tree_column->priv->clickable;
2541 * gtk_tree_view_column_set_widget:
2542 * @tree_column: A #GtkTreeViewColumn.
2543 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2545 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2546 * header button is set with a #GtkLabel set to the title of @tree_column.
2549 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2552 GtkTreeViewColumnPrivate *priv;
2554 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2555 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2557 priv = tree_column->priv;
2560 g_object_ref_sink (widget);
2563 g_object_unref (priv->child);
2565 priv->child = widget;
2566 gtk_tree_view_column_update_button (tree_column);
2567 g_object_notify (G_OBJECT (tree_column), "widget");
2571 * gtk_tree_view_column_get_widget:
2572 * @tree_column: A #GtkTreeViewColumn.
2574 * Returns the #GtkWidget in the button on the column header.
2575 * If a custom widget has not been set then %NULL is returned.
2577 * Return value: (transfer none): The #GtkWidget in the column
2581 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2583 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2585 return tree_column->priv->child;
2589 * gtk_tree_view_column_set_alignment:
2590 * @tree_column: A #GtkTreeViewColumn.
2591 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2593 * Sets the alignment of the title or custom widget inside the column header.
2594 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2595 * for center, 1.0 for right.
2598 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2601 GtkTreeViewColumnPrivate *priv;
2603 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2605 priv = tree_column->priv;
2607 xalign = CLAMP (xalign, 0.0, 1.0);
2609 if (priv->xalign == xalign)
2612 priv->xalign = xalign;
2613 gtk_tree_view_column_update_button (tree_column);
2614 g_object_notify (G_OBJECT (tree_column), "alignment");
2618 * gtk_tree_view_column_get_alignment:
2619 * @tree_column: A #GtkTreeViewColumn.
2621 * Returns the current x alignment of @tree_column. This value can range
2622 * between 0.0 and 1.0.
2624 * Return value: The current alignent of @tree_column.
2627 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2629 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2631 return tree_column->priv->xalign;
2635 * gtk_tree_view_column_set_reorderable:
2636 * @tree_column: A #GtkTreeViewColumn
2637 * @reorderable: %TRUE, if the column can be reordered.
2639 * If @reorderable is %TRUE, then the column can be reordered by the end user
2640 * dragging the header.
2643 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2644 gboolean reorderable)
2646 GtkTreeViewColumnPrivate *priv;
2648 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2650 priv = tree_column->priv;
2653 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2655 if (priv->reorderable == (reorderable?TRUE:FALSE))
2658 priv->reorderable = (reorderable?TRUE:FALSE);
2659 gtk_tree_view_column_update_button (tree_column);
2660 g_object_notify (G_OBJECT (tree_column), "reorderable");
2664 * gtk_tree_view_column_get_reorderable:
2665 * @tree_column: A #GtkTreeViewColumn
2667 * Returns %TRUE if the @tree_column can be reordered by the user.
2669 * Return value: %TRUE if the @tree_column can be reordered by the user.
2672 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2674 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2676 return tree_column->priv->reorderable;
2681 * gtk_tree_view_column_set_sort_column_id:
2682 * @tree_column: a #GtkTreeViewColumn
2683 * @sort_column_id: The @sort_column_id of the model to sort on.
2685 * Sets the logical @sort_column_id that this column sorts on when this column
2686 * is selected for sorting. Doing so makes the column header clickable.
2689 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2690 gint sort_column_id)
2692 GtkTreeViewColumnPrivate *priv;
2694 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2695 g_return_if_fail (sort_column_id >= -1);
2697 priv = tree_column->priv;
2699 if (priv->sort_column_id == sort_column_id)
2702 priv->sort_column_id = sort_column_id;
2704 /* Handle unsetting the id */
2705 if (sort_column_id == -1)
2707 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2709 if (priv->sort_clicked_signal)
2711 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2712 priv->sort_clicked_signal = 0;
2715 if (priv->sort_column_changed_signal)
2717 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2718 priv->sort_column_changed_signal = 0;
2721 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2722 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2723 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2724 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2728 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2730 if (! priv->sort_clicked_signal)
2731 priv->sort_clicked_signal = g_signal_connect (tree_column,
2733 G_CALLBACK (gtk_tree_view_column_sort),
2736 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2737 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2741 * gtk_tree_view_column_get_sort_column_id:
2742 * @tree_column: a #GtkTreeViewColumn
2744 * Gets the logical @sort_column_id that the model sorts on when this
2745 * column is selected for sorting.
2746 * See gtk_tree_view_column_set_sort_column_id().
2748 * Return value: the current @sort_column_id for this column, or -1 if
2749 * this column can't be used for sorting.
2752 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2754 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2756 return tree_column->priv->sort_column_id;
2760 * gtk_tree_view_column_set_sort_indicator:
2761 * @tree_column: a #GtkTreeViewColumn
2762 * @setting: %TRUE to display an indicator that the column is sorted
2764 * Call this function with a @setting of %TRUE to display an arrow in
2765 * the header button indicating the column is sorted. Call
2766 * gtk_tree_view_column_set_sort_order() to change the direction of
2771 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2774 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2776 setting = setting != FALSE;
2778 if (setting == tree_column->priv->show_sort_indicator)
2781 tree_column->priv->show_sort_indicator = setting;
2782 gtk_tree_view_column_update_button (tree_column);
2783 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2787 * gtk_tree_view_column_get_sort_indicator:
2788 * @tree_column: a #GtkTreeViewColumn
2790 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2792 * Return value: whether the sort indicator arrow is displayed
2795 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2797 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2799 return tree_column->priv->show_sort_indicator;
2803 * gtk_tree_view_column_set_sort_order:
2804 * @tree_column: a #GtkTreeViewColumn
2805 * @order: sort order that the sort indicator should indicate
2807 * Changes the appearance of the sort indicator.
2809 * This <emphasis>does not</emphasis> actually sort the model. Use
2810 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2811 * support. This function is primarily for custom sorting behavior, and should
2812 * be used in conjunction with gtk_tree_sortable_set_sort_column_id() to do
2813 * that. For custom models, the mechanism will vary.
2815 * The sort indicator changes direction to indicate normal sort or reverse sort.
2816 * Note that you must have the sort indicator enabled to see anything when
2817 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2820 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2823 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2825 if (order == tree_column->priv->sort_order)
2828 tree_column->priv->sort_order = order;
2829 gtk_tree_view_column_update_button (tree_column);
2830 g_object_notify (G_OBJECT (tree_column), "sort-order");
2834 * gtk_tree_view_column_get_sort_order:
2835 * @tree_column: a #GtkTreeViewColumn
2837 * Gets the value set by gtk_tree_view_column_set_sort_order().
2839 * Return value: the sort order the sort indicator is indicating
2842 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2844 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2846 return tree_column->priv->sort_order;
2850 * gtk_tree_view_column_cell_set_cell_data:
2851 * @tree_column: A #GtkTreeViewColumn.
2852 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2853 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2854 * @is_expander: %TRUE, if the row has children
2855 * @is_expanded: %TRUE, if the row has visible children
2857 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2858 * every attribute mapping in @tree_column, it will get a value from the set
2859 * column on the @iter, and use that value to set the attribute on the cell
2860 * renderer. This is used primarily by the #GtkTreeView.
2863 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2864 GtkTreeModel *tree_model,
2866 gboolean is_expander,
2867 gboolean is_expanded)
2869 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2871 if (tree_model == NULL)
2874 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2875 is_expander, is_expanded);
2879 * gtk_tree_view_column_cell_get_size:
2880 * @tree_column: A #GtkTreeViewColumn.
2881 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2882 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2883 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2884 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2885 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2887 * Obtains the width and height needed to render the column. This is used
2888 * primarily by the #GtkTreeView.
2891 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2892 const GdkRectangle *cell_area,
2898 GtkTreeViewColumnPrivate *priv;
2899 gint min_width = 0, min_height = 0;
2901 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2903 priv = tree_column->priv;
2905 g_signal_handler_block (priv->cell_area_context,
2906 priv->context_changed_signal);
2908 gtk_cell_area_get_preferred_width (priv->cell_area,
2909 priv->cell_area_context,
2913 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2915 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2916 priv->cell_area_context,
2922 g_signal_handler_unblock (priv->cell_area_context,
2923 priv->context_changed_signal);
2927 * height = min_height;
2929 * width = min_width;
2934 * gtk_tree_view_column_cell_render:
2935 * @tree_column: A #GtkTreeViewColumn.
2936 * @cr: cairo context to draw to
2937 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2938 * @cell_area: area normally rendered by a cell renderer
2939 * @flags: flags that affect rendering
2941 * Renders the cell contained by #tree_column. This is used primarily by the
2945 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2947 const GdkRectangle *background_area,
2948 const GdkRectangle *cell_area,
2950 gboolean draw_focus)
2952 GtkTreeViewColumnPrivate *priv;
2954 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2955 g_return_if_fail (cr != NULL);
2956 g_return_if_fail (background_area != NULL);
2957 g_return_if_fail (cell_area != NULL);
2959 priv = tree_column->priv;
2963 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2964 priv->tree_view, cr,
2965 background_area, cell_area, flags,
2972 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2974 const GdkRectangle *cell_area,
2977 GtkTreeViewColumnPrivate *priv;
2979 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2981 priv = tree_column->priv;
2983 return gtk_cell_area_event (priv->cell_area,
2984 priv->cell_area_context,
2992 * gtk_tree_view_column_cell_is_visible:
2993 * @tree_column: A #GtkTreeViewColumn
2995 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2996 * For this to be meaningful, you must first initialize the cells with
2997 * gtk_tree_view_column_cell_set_cell_data()
2999 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
3002 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
3006 GtkTreeViewColumnPrivate *priv;
3008 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3010 priv = tree_column->priv;
3012 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
3013 for (list = cells; list; list = list->next)
3015 if (gtk_cell_renderer_get_visible (list->data))
3017 g_list_free (cells);
3022 g_list_free (cells);
3028 * gtk_tree_view_column_focus_cell:
3029 * @tree_column: A #GtkTreeViewColumn
3030 * @cell: A #GtkCellRenderer
3032 * Sets the current keyboard focus to be at @cell, if the column contains
3033 * 2 or more editable and activatable cells.
3038 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
3039 GtkCellRenderer *cell)
3041 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3042 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
3044 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
3048 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
3049 gboolean install_handler)
3051 GtkTreeViewColumnPrivate *priv = tree_column->priv;
3057 /* Issue a manual reset on the context to have all
3058 * sizes re-requested for the context.
3060 g_signal_handler_block (priv->cell_area_context,
3061 priv->context_changed_signal);
3062 gtk_cell_area_context_reset (priv->cell_area_context);
3063 g_signal_handler_unblock (priv->cell_area_context,
3064 priv->context_changed_signal);
3066 if (priv->tree_view &&
3067 gtk_widget_get_realized (priv->tree_view))
3069 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
3070 gtk_widget_queue_resize (priv->tree_view);
3075 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
3077 return tree_column->priv->dirty;
3081 * gtk_tree_view_column_cell_get_position:
3082 * @tree_column: a #GtkTreeViewColumn
3083 * @cell_renderer: a #GtkCellRenderer
3084 * @x_offset: (out) (allow-none): return location for the horizontal
3085 * position of @cell within @tree_column, may be %NULL
3086 * @width: (out) (allow-none): return location for the width of @cell,
3089 * Obtains the horizontal position and size of a cell in a column. If the
3090 * cell is not found in the column, @start_pos and @width are not changed and
3091 * %FALSE is returned.
3093 * Return value: %TRUE if @cell belongs to @tree_column.
3096 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3097 GtkCellRenderer *cell_renderer,
3101 GtkTreeViewColumnPrivate *priv;
3102 GdkRectangle cell_area;
3103 GdkRectangle allocation;
3105 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3106 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3108 priv = tree_column->priv;
3110 if (! gtk_cell_area_has_renderer (priv->cell_area, cell_renderer))
3113 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3114 NULL, tree_column, &cell_area);
3116 gtk_cell_area_get_cell_allocation (priv->cell_area,
3117 priv->cell_area_context,
3124 *x_offset = allocation.x - cell_area.x;
3127 *width = allocation.width;
3133 * gtk_tree_view_column_queue_resize:
3134 * @tree_column: A #GtkTreeViewColumn
3136 * Flags the column, and the cell renderers added to this column, to have
3137 * their sizes renegotiated.
3142 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3144 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3146 if (tree_column->priv->tree_view)
3147 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3151 * gtk_tree_view_column_get_tree_view:
3152 * @tree_column: A #GtkTreeViewColumn
3154 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3155 * If @column is currently not inserted in any tree view, %NULL is
3158 * Return value: (transfer none): The tree view wherein @column has
3159 * been inserted if any, %NULL otherwise.
3164 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3166 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3168 return tree_column->priv->tree_view;
3172 * gtk_tree_view_column_get_button:
3173 * @tree_column: A #GtkTreeViewColumn
3175 * Returns the button used in the treeview column header
3177 * Return value: (transfer none): The button for the column header.
3182 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3184 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3186 return tree_column->priv->button;
3190 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3192 return column->priv->window;
3196 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3199 column->priv->padding = MAX (column->priv->padding, padding);
3203 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3205 gint requested_width;
3207 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3209 return requested_width + column->priv->padding;
3214 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3217 column->priv->resized_width = width;
3221 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3223 return column->priv->resized_width;
3227 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3228 gboolean use_resized_width)
3230 column->priv->use_resized_width = use_resized_width;
3234 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3236 return column->priv->use_resized_width;
3240 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3242 return column->priv->drag_x;
3245 GtkCellAreaContext *
3246 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3248 return column->priv->cell_area_context;