2 * Copyright (C) 2000 Red Hat, Inc., Jonathan Blandford <jrb@redhat.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
22 #include "gtktreeviewcolumn.h"
26 #include "gtktreeview.h"
27 #include "gtktreeprivate.h"
28 #include "gtkcelllayout.h"
29 #include "gtkbutton.h"
30 #include "gtkalignment.h"
33 #include "gtkmarshalers.h"
35 #include "gtkcellareacontext.h"
36 #include "gtkcellareabox.h"
37 #include "gtkprivate.h"
39 #include "gtktypebuiltins.h"
43 * SECTION:gtktreeviewcolumn
44 * @Short_description: A visible column in a GtkTreeView widget
45 * @Title: GtkTreeViewColumn
46 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
47 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
48 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
50 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
51 * It allows to set properties of the column header, and functions as a holding pen for
52 * the cell renderers which determine how the data in the column is displayed.
54 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
55 * for an overview of all the objects and data types related to the tree widget and how
61 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
64 static void gtk_tree_view_column_set_property (GObject *object,
68 static void gtk_tree_view_column_get_property (GObject *object,
72 static void gtk_tree_view_column_finalize (GObject *object);
73 static void gtk_tree_view_column_dispose (GObject *object);
74 static GObject *gtk_tree_view_column_constructor (GType type,
75 guint n_construct_properties,
76 GObjectConstructParam *construct_properties);
78 /* GtkCellLayout implementation */
79 static void gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
80 GtkCellArea *cell_area);
82 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
84 /* Button handling code */
85 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
86 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
88 /* Button signal handlers */
89 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
92 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
94 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
95 gboolean group_cycling,
98 /* Property handlers */
99 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
100 GtkTreeViewColumn *tree_column);
102 /* GtkCellArea/GtkCellAreaContext callbacks */
103 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
105 GtkTreeViewColumn *tree_column);
106 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
107 GtkCellRenderer *renderer,
108 GtkCellEditable *edit_widget,
109 GdkRectangle *cell_area,
110 const gchar *path_string,
112 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
113 GtkCellRenderer *renderer,
114 GtkCellEditable *edit_widget,
117 /* Internal functions */
118 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
120 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
121 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
122 GtkCellRenderer *cell_renderer,
125 /* GtkBuildable implementation */
126 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
129 struct _GtkTreeViewColumnPrivate
131 GtkWidget *tree_view;
135 GtkWidget *alignment;
138 gulong property_changed_signal;
141 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
142 GtkTreeViewColumnSizing column_type;
151 /* dragging columns */
158 gulong sort_clicked_signal;
159 gulong sort_column_changed_signal;
161 GtkSortType sort_order;
164 GtkCellArea *cell_area;
165 GtkCellAreaContext *cell_area_context;
166 gulong add_editable_signal;
167 gulong remove_editable_signal;
168 gulong context_changed_signal;
175 guint show_sort_indicator : 1;
176 guint maybe_reordered : 1;
177 guint reorderable : 1;
178 guint use_resized_width : 1;
212 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
214 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
215 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
216 gtk_tree_view_column_cell_layout_init)
217 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
218 gtk_tree_view_column_buildable_init))
222 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
224 GObjectClass *object_class;
226 object_class = (GObjectClass*) class;
228 class->clicked = NULL;
230 object_class->constructor = gtk_tree_view_column_constructor;
231 object_class->finalize = gtk_tree_view_column_finalize;
232 object_class->dispose = gtk_tree_view_column_dispose;
233 object_class->set_property = gtk_tree_view_column_set_property;
234 object_class->get_property = gtk_tree_view_column_get_property;
236 tree_column_signals[CLICKED] =
237 g_signal_new (I_("clicked"),
238 G_OBJECT_CLASS_TYPE (object_class),
240 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
242 _gtk_marshal_VOID__VOID,
245 g_object_class_install_property (object_class,
247 g_param_spec_boolean ("visible",
249 P_("Whether to display the column"),
251 GTK_PARAM_READWRITE));
253 g_object_class_install_property (object_class,
255 g_param_spec_boolean ("resizable",
257 P_("Column is user-resizable"),
259 GTK_PARAM_READWRITE));
261 g_object_class_install_property (object_class,
263 g_param_spec_int ("x-offset",
265 P_("Current X position of the column"),
269 GTK_PARAM_READABLE));
271 g_object_class_install_property (object_class,
273 g_param_spec_int ("width",
275 P_("Current width of the column"),
279 GTK_PARAM_READABLE));
280 g_object_class_install_property (object_class,
282 g_param_spec_int ("spacing",
284 P_("Space which is inserted between cells"),
288 GTK_PARAM_READWRITE));
289 g_object_class_install_property (object_class,
291 g_param_spec_enum ("sizing",
293 P_("Resize mode of the column"),
294 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
295 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
296 GTK_PARAM_READWRITE));
298 g_object_class_install_property (object_class,
300 g_param_spec_int ("fixed-width",
302 P_("Current fixed width of the column"),
306 GTK_PARAM_READWRITE));
308 g_object_class_install_property (object_class,
310 g_param_spec_int ("min-width",
312 P_("Minimum allowed width of the column"),
316 GTK_PARAM_READWRITE));
318 g_object_class_install_property (object_class,
320 g_param_spec_int ("max-width",
322 P_("Maximum allowed width of the column"),
326 GTK_PARAM_READWRITE));
328 g_object_class_install_property (object_class,
330 g_param_spec_string ("title",
332 P_("Title to appear in column header"),
334 GTK_PARAM_READWRITE));
336 g_object_class_install_property (object_class,
338 g_param_spec_boolean ("expand",
340 P_("Column gets share of extra width allocated to the widget"),
342 GTK_PARAM_READWRITE));
344 g_object_class_install_property (object_class,
346 g_param_spec_boolean ("clickable",
348 P_("Whether the header can be clicked"),
350 GTK_PARAM_READWRITE));
353 g_object_class_install_property (object_class,
355 g_param_spec_object ("widget",
357 P_("Widget to put in column header button instead of column title"),
359 GTK_PARAM_READWRITE));
361 g_object_class_install_property (object_class,
363 g_param_spec_float ("alignment",
365 P_("X Alignment of the column header text or widget"),
369 GTK_PARAM_READWRITE));
371 g_object_class_install_property (object_class,
373 g_param_spec_boolean ("reorderable",
375 P_("Whether the column can be reordered around the headers"),
377 GTK_PARAM_READWRITE));
379 g_object_class_install_property (object_class,
381 g_param_spec_boolean ("sort-indicator",
382 P_("Sort indicator"),
383 P_("Whether to show a sort indicator"),
385 GTK_PARAM_READWRITE));
387 g_object_class_install_property (object_class,
389 g_param_spec_enum ("sort-order",
391 P_("Sort direction the sort indicator should indicate"),
394 GTK_PARAM_READWRITE));
397 * GtkTreeViewColumn:sort-column-id:
399 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
400 * clickable. Set to %-1 to make the column unsortable.
404 g_object_class_install_property (object_class,
406 g_param_spec_int ("sort-column-id",
407 P_("Sort column ID"),
408 P_("Logical sort column ID this column sorts on when selected for sorting"),
412 GTK_PARAM_READWRITE));
415 * GtkTreeViewColumn:cell-area:
417 * The #GtkCellArea used to layout cell renderers for this column.
419 * If no area is specified when creating the tree view column with gtk_tree_view_column_new_with_area()
420 * a horizontally oriented #GtkCellAreaBox will be used.
424 g_object_class_install_property (object_class,
426 g_param_spec_object ("cell-area",
428 P_("The GtkCellArea used to layout cells"),
430 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
432 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
436 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
439 const gchar *tagname,
442 /* Just ignore the boolean return from here */
443 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
447 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
449 iface->add_child = _gtk_cell_layout_buildable_add_child;
450 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
451 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
455 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
457 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
461 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
463 GtkTreeViewColumnPrivate *priv;
465 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
466 GTK_TYPE_TREE_VIEW_COLUMN,
467 GtkTreeViewColumnPrivate);
468 priv = tree_column->priv;
474 priv->min_width = -1;
475 priv->max_width = -1;
476 priv->resized_width = 0;
477 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
478 priv->visible = TRUE;
479 priv->resizable = FALSE;
480 priv->expand = FALSE;
481 priv->clickable = FALSE;
483 priv->sort_order = GTK_SORT_ASCENDING;
484 priv->show_sort_indicator = FALSE;
485 priv->property_changed_signal = 0;
486 priv->sort_clicked_signal = 0;
487 priv->sort_column_changed_signal = 0;
488 priv->sort_column_id = -1;
489 priv->reorderable = FALSE;
490 priv->maybe_reordered = FALSE;
491 priv->fixed_width = 1;
492 priv->use_resized_width = FALSE;
493 priv->title = g_strdup ("");
497 gtk_tree_view_column_constructor (GType type,
498 guint n_construct_properties,
499 GObjectConstructParam *construct_properties)
501 GtkTreeViewColumn *tree_column;
504 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
505 (type, n_construct_properties, construct_properties);
507 tree_column = (GtkTreeViewColumn *) object;
509 gtk_tree_view_column_ensure_cell_area (tree_column, NULL);
515 gtk_tree_view_column_dispose (GObject *object)
517 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
518 GtkTreeViewColumnPrivate *priv = tree_column->priv;
520 /* Remove this column from its treeview,
521 * in case this column is destroyed before its treeview.
524 gtk_tree_view_remove_column (GTK_TREE_VIEW (priv->tree_view), tree_column);
526 if (priv->cell_area_context)
528 g_signal_handler_disconnect (priv->cell_area_context,
529 priv->context_changed_signal);
531 g_object_unref (priv->cell_area_context);
533 priv->cell_area_context = NULL;
534 priv->context_changed_signal = 0;
539 g_signal_handler_disconnect (priv->cell_area,
540 priv->add_editable_signal);
541 g_signal_handler_disconnect (priv->cell_area,
542 priv->remove_editable_signal);
544 g_object_unref (priv->cell_area);
545 priv->cell_area = NULL;
546 priv->add_editable_signal = 0;
547 priv->remove_editable_signal = 0;
552 g_object_unref (priv->child);
556 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
560 gtk_tree_view_column_finalize (GObject *object)
562 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
563 GtkTreeViewColumnPrivate *priv = tree_column->priv;
565 g_free (priv->title);
567 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
571 gtk_tree_view_column_set_property (GObject *object,
576 GtkTreeViewColumn *tree_column;
579 tree_column = GTK_TREE_VIEW_COLUMN (object);
584 gtk_tree_view_column_set_visible (tree_column,
585 g_value_get_boolean (value));
589 gtk_tree_view_column_set_resizable (tree_column,
590 g_value_get_boolean (value));
594 gtk_tree_view_column_set_sizing (tree_column,
595 g_value_get_enum (value));
598 case PROP_FIXED_WIDTH:
599 gtk_tree_view_column_set_fixed_width (tree_column,
600 g_value_get_int (value));
604 gtk_tree_view_column_set_min_width (tree_column,
605 g_value_get_int (value));
609 gtk_tree_view_column_set_max_width (tree_column,
610 g_value_get_int (value));
614 gtk_tree_view_column_set_spacing (tree_column,
615 g_value_get_int (value));
619 gtk_tree_view_column_set_title (tree_column,
620 g_value_get_string (value));
624 gtk_tree_view_column_set_expand (tree_column,
625 g_value_get_boolean (value));
629 gtk_tree_view_column_set_clickable (tree_column,
630 g_value_get_boolean (value));
634 gtk_tree_view_column_set_widget (tree_column,
635 (GtkWidget*) g_value_get_object (value));
639 gtk_tree_view_column_set_alignment (tree_column,
640 g_value_get_float (value));
643 case PROP_REORDERABLE:
644 gtk_tree_view_column_set_reorderable (tree_column,
645 g_value_get_boolean (value));
648 case PROP_SORT_INDICATOR:
649 gtk_tree_view_column_set_sort_indicator (tree_column,
650 g_value_get_boolean (value));
653 case PROP_SORT_ORDER:
654 gtk_tree_view_column_set_sort_order (tree_column,
655 g_value_get_enum (value));
658 case PROP_SORT_COLUMN_ID:
659 gtk_tree_view_column_set_sort_column_id (tree_column,
660 g_value_get_int (value));
664 /* Construct-only, can only be assigned once */
665 area = g_value_get_object (value);
669 if (tree_column->priv->cell_area != NULL)
671 g_warning ("cell-area has already been set, ignoring construct property");
672 g_object_ref_sink (area);
673 g_object_unref (area);
676 gtk_tree_view_column_ensure_cell_area (tree_column, area);
681 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
687 gtk_tree_view_column_get_property (GObject *object,
692 GtkTreeViewColumn *tree_column;
694 tree_column = GTK_TREE_VIEW_COLUMN (object);
699 g_value_set_boolean (value,
700 gtk_tree_view_column_get_visible (tree_column));
704 g_value_set_boolean (value,
705 gtk_tree_view_column_get_resizable (tree_column));
709 g_value_set_int (value,
710 gtk_tree_view_column_get_x_offset (tree_column));
714 g_value_set_int (value,
715 gtk_tree_view_column_get_width (tree_column));
719 g_value_set_int (value,
720 gtk_tree_view_column_get_spacing (tree_column));
724 g_value_set_enum (value,
725 gtk_tree_view_column_get_sizing (tree_column));
728 case PROP_FIXED_WIDTH:
729 g_value_set_int (value,
730 gtk_tree_view_column_get_fixed_width (tree_column));
734 g_value_set_int (value,
735 gtk_tree_view_column_get_min_width (tree_column));
739 g_value_set_int (value,
740 gtk_tree_view_column_get_max_width (tree_column));
744 g_value_set_string (value,
745 gtk_tree_view_column_get_title (tree_column));
749 g_value_set_boolean (value,
750 gtk_tree_view_column_get_expand (tree_column));
754 g_value_set_boolean (value,
755 gtk_tree_view_column_get_clickable (tree_column));
759 g_value_set_object (value,
760 (GObject*) gtk_tree_view_column_get_widget (tree_column));
764 g_value_set_float (value,
765 gtk_tree_view_column_get_alignment (tree_column));
768 case PROP_REORDERABLE:
769 g_value_set_boolean (value,
770 gtk_tree_view_column_get_reorderable (tree_column));
773 case PROP_SORT_INDICATOR:
774 g_value_set_boolean (value,
775 gtk_tree_view_column_get_sort_indicator (tree_column));
778 case PROP_SORT_ORDER:
779 g_value_set_enum (value,
780 gtk_tree_view_column_get_sort_order (tree_column));
783 case PROP_SORT_COLUMN_ID:
784 g_value_set_int (value,
785 gtk_tree_view_column_get_sort_column_id (tree_column));
789 g_value_set_object (value, tree_column->priv->cell_area);
793 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
798 /* Implementation of GtkCellLayout interface
802 gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
803 GtkCellArea *cell_area)
805 GtkTreeViewColumnPrivate *priv = column->priv;
811 priv->cell_area = cell_area;
813 priv->cell_area = gtk_cell_area_box_new ();
815 g_object_ref_sink (priv->cell_area);
817 priv->add_editable_signal =
818 g_signal_connect (priv->cell_area, "add-editable",
819 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
821 priv->remove_editable_signal =
822 g_signal_connect (priv->cell_area, "remove-editable",
823 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
826 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
828 priv->context_changed_signal =
829 g_signal_connect (priv->cell_area_context, "notify",
830 G_CALLBACK (gtk_tree_view_column_context_changed),
835 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
837 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
838 GtkTreeViewColumnPrivate *priv = column->priv;
840 if (G_UNLIKELY (!priv->cell_area))
841 gtk_tree_view_column_ensure_cell_area (column, NULL);
843 return priv->cell_area;
846 /* Button handling code
849 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
851 GtkTreeViewColumnPrivate *priv = tree_column->priv;
852 GtkTreeView *tree_view;
856 tree_view = (GtkTreeView *) priv->tree_view;
858 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
859 g_return_if_fail (priv->button == NULL);
861 gtk_widget_push_composite_child ();
862 priv->button = gtk_button_new ();
863 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
864 gtk_widget_pop_composite_child ();
866 /* make sure we own a reference to it as well. */
867 if (_gtk_tree_view_get_header_window (tree_view))
868 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
870 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
872 g_signal_connect (priv->button, "event",
873 G_CALLBACK (gtk_tree_view_column_button_event),
875 g_signal_connect (priv->button, "clicked",
876 G_CALLBACK (gtk_tree_view_column_button_clicked),
879 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
881 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
882 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
888 child = gtk_label_new (priv->title);
889 gtk_widget_show (child);
892 g_signal_connect (child, "mnemonic-activate",
893 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
896 if (priv->xalign <= 0.5)
897 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
899 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
901 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
903 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
904 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
906 gtk_widget_show (hbox);
907 gtk_widget_show (priv->alignment);
908 gtk_tree_view_column_update_button (tree_column);
912 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
914 GtkTreeViewColumnPrivate *priv = tree_column->priv;
915 gint sort_column_id = -1;
917 GtkWidget *alignment;
919 GtkWidget *current_child;
920 GtkArrowType arrow_type = GTK_ARROW_NONE;
924 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
928 /* Create a button if necessary */
930 priv->button == NULL &&
932 gtk_widget_get_realized (priv->tree_view))
933 gtk_tree_view_column_create_button (tree_column);
938 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
939 alignment = priv->alignment;
941 current_child = gtk_bin_get_child (GTK_BIN (alignment));
943 /* Set up the actual button */
944 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
949 if (current_child != priv->child)
951 gtk_container_remove (GTK_CONTAINER (alignment),
953 gtk_container_add (GTK_CONTAINER (alignment),
959 if (current_child == NULL)
961 current_child = gtk_label_new (NULL);
962 gtk_widget_show (current_child);
963 gtk_container_add (GTK_CONTAINER (alignment),
967 g_return_if_fail (GTK_IS_LABEL (current_child));
970 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
973 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
977 if (GTK_IS_TREE_SORTABLE (model))
978 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
982 if (priv->show_sort_indicator)
984 gboolean alternative;
986 g_object_get (gtk_widget_get_settings (priv->tree_view),
987 "gtk-alternative-sort-arrows", &alternative,
990 switch (priv->sort_order)
992 case GTK_SORT_ASCENDING:
993 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
996 case GTK_SORT_DESCENDING:
997 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
1001 g_warning (G_STRLOC": bad sort order");
1006 gtk_arrow_set (GTK_ARROW (arrow),
1010 /* Put arrow on the right if the text is left-or-center justified, and on the
1011 * left otherwise; do this by packing boxes, so flipping text direction will
1014 g_object_ref (arrow);
1015 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
1017 if (priv->xalign <= 0.5)
1019 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1023 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1024 /* move it to the front */
1025 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
1027 g_object_unref (arrow);
1029 if (priv->show_sort_indicator
1030 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
1031 gtk_widget_show (arrow);
1033 gtk_widget_hide (arrow);
1035 /* It's always safe to hide the button. It isn't always safe to show it, as
1036 * if you show it before it's realized, it'll get the wrong window. */
1038 priv->tree_view != NULL &&
1039 gtk_widget_get_realized (priv->tree_view))
1043 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
1044 gtk_widget_show_now (priv->button);
1048 if (priv->resizable)
1050 gdk_window_show (priv->window);
1051 gdk_window_raise (priv->window);
1055 gdk_window_hide (priv->window);
1061 gtk_widget_hide (priv->button);
1063 gdk_window_hide (priv->window);
1067 if (priv->reorderable || priv->clickable)
1069 gtk_widget_set_can_focus (priv->button, TRUE);
1073 gtk_widget_set_can_focus (priv->button, FALSE);
1074 if (gtk_widget_has_focus (priv->button))
1076 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1077 if (gtk_widget_is_toplevel (toplevel))
1079 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1083 /* Queue a resize on the assumption that we always want to catch all changes
1084 * and columns don't change all that often.
1086 if (gtk_widget_get_realized (priv->tree_view))
1087 gtk_widget_queue_resize (priv->tree_view);
1091 /* Button signal handlers
1095 gtk_tree_view_column_button_event (GtkWidget *widget,
1099 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1100 GtkTreeViewColumnPrivate *priv = column->priv;
1102 g_return_val_if_fail (event != NULL, FALSE);
1104 if (event->type == GDK_BUTTON_PRESS &&
1105 priv->reorderable &&
1106 ((GdkEventButton *)event)->button == 1)
1108 priv->maybe_reordered = TRUE;
1109 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1113 gtk_widget_grab_focus (widget);
1116 if (event->type == GDK_BUTTON_RELEASE ||
1117 event->type == GDK_LEAVE_NOTIFY)
1118 priv->maybe_reordered = FALSE;
1120 if (event->type == GDK_MOTION_NOTIFY &&
1121 priv->maybe_reordered &&
1122 (gtk_drag_check_threshold (widget,
1125 (gint) ((GdkEventMotion *)event)->x,
1126 (gint) ((GdkEventMotion *)event)->y)))
1128 priv->maybe_reordered = FALSE;
1129 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1130 event->motion.device);
1134 if (priv->clickable == FALSE)
1136 switch (event->type)
1138 case GDK_BUTTON_PRESS:
1139 case GDK_2BUTTON_PRESS:
1140 case GDK_3BUTTON_PRESS:
1141 case GDK_MOTION_NOTIFY:
1142 case GDK_BUTTON_RELEASE:
1143 case GDK_ENTER_NOTIFY:
1144 case GDK_LEAVE_NOTIFY:
1155 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1157 g_signal_emit_by_name (data, "clicked");
1161 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1162 gboolean group_cycling,
1165 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1166 GtkTreeViewColumnPrivate *priv = column->priv;
1168 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1170 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1172 if (priv->clickable)
1173 gtk_button_clicked (GTK_BUTTON (priv->button));
1174 else if (gtk_widget_get_can_focus (priv->button))
1175 gtk_widget_grab_focus (priv->button);
1177 gtk_widget_grab_focus (priv->tree_view);
1183 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1184 GtkTreeViewColumn *column)
1186 GtkTreeViewColumnPrivate *priv = column->priv;
1187 gint sort_column_id;
1190 if (gtk_tree_sortable_get_sort_column_id (sortable,
1194 if (sort_column_id == priv->sort_column_id)
1196 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1197 gtk_tree_view_column_set_sort_order (column, order);
1201 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1206 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1211 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1214 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1215 GtkTreeModel *model;
1216 GtkTreeSortable *sortable;
1217 gint sort_column_id;
1219 gboolean has_sort_column;
1220 gboolean has_default_sort_func;
1222 g_return_if_fail (priv->tree_view != NULL);
1224 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1225 sortable = GTK_TREE_SORTABLE (model);
1228 gtk_tree_sortable_get_sort_column_id (sortable,
1231 has_default_sort_func =
1232 gtk_tree_sortable_has_default_sort_func (sortable);
1234 if (has_sort_column &&
1235 sort_column_id == priv->sort_column_id)
1237 if (order == GTK_SORT_ASCENDING)
1238 gtk_tree_sortable_set_sort_column_id (sortable,
1239 priv->sort_column_id,
1240 GTK_SORT_DESCENDING);
1241 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1242 gtk_tree_sortable_set_sort_column_id (sortable,
1243 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1244 GTK_SORT_ASCENDING);
1246 gtk_tree_sortable_set_sort_column_id (sortable,
1247 priv->sort_column_id,
1248 GTK_SORT_ASCENDING);
1252 gtk_tree_sortable_set_sort_column_id (sortable,
1253 priv->sort_column_id,
1254 GTK_SORT_ASCENDING);
1259 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1261 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1262 GtkTreeModel *model;
1264 if (priv->tree_view == NULL)
1267 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1272 if (GTK_IS_TREE_SORTABLE (model) &&
1273 priv->sort_column_id != -1)
1275 gint real_sort_column_id;
1276 GtkSortType real_order;
1278 if (priv->sort_column_changed_signal == 0)
1279 priv->sort_column_changed_signal =
1280 g_signal_connect (model, "sort-column-changed",
1281 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1284 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1285 &real_sort_column_id,
1287 (real_sort_column_id == priv->sort_column_id))
1289 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1290 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1294 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1300 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1302 GtkTreeViewColumn *tree_column)
1304 /* Here we want the column re-requested if the underlying context was
1305 * actually reset for any reason, this can happen if the underlying
1306 * area/cell configuration changes (i.e. cell packing properties
1307 * or cell spacing and the like)
1309 * Note that we block this handler while requesting for sizes
1310 * so there is no need to check for the new context size being -1,
1311 * we also block the handler when explicitly resetting the context
1312 * so as to avoid some infinite stack recursion.
1314 if (!strcmp (pspec->name, "minimum-width") ||
1315 !strcmp (pspec->name, "natural-width") ||
1316 !strcmp (pspec->name, "minimum-height") ||
1317 !strcmp (pspec->name, "natural-height"))
1318 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1322 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1323 GtkCellRenderer *renderer,
1324 GtkCellEditable *edit_widget,
1325 GdkRectangle *cell_area,
1326 const gchar *path_string,
1329 GtkTreeViewColumn *column = user_data;
1330 GtkTreeViewColumnPrivate *priv = column->priv;
1333 if (priv->tree_view)
1335 path = gtk_tree_path_new_from_string (path_string);
1337 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1343 gtk_tree_path_free (path);
1348 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1349 GtkCellRenderer *renderer,
1350 GtkCellEditable *edit_widget,
1353 GtkTreeViewColumn *column = user_data;
1354 GtkTreeViewColumnPrivate *priv = column->priv;
1356 if (priv->tree_view)
1357 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1362 /* Exported Private Functions.
1363 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1366 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1368 GtkTreeViewColumnPrivate *priv = column->priv;
1369 GtkAllocation allocation;
1370 GtkTreeView *tree_view;
1372 guint attributes_mask;
1375 tree_view = (GtkTreeView *)priv->tree_view;
1376 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1378 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1379 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1380 g_return_if_fail (priv->button != NULL);
1382 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1383 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1385 attr.window_type = GDK_WINDOW_CHILD;
1386 attr.wclass = GDK_INPUT_ONLY;
1387 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1388 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1389 (GDK_BUTTON_PRESS_MASK |
1390 GDK_BUTTON_RELEASE_MASK |
1391 GDK_POINTER_MOTION_MASK |
1392 GDK_POINTER_MOTION_HINT_MASK |
1393 GDK_KEY_PRESS_MASK);
1394 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1395 attr.cursor = gdk_cursor_new_for_display
1396 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1398 attr.width = TREE_VIEW_DRAG_WIDTH;
1399 attr.height = _gtk_tree_view_get_header_height (tree_view);
1401 gtk_widget_get_allocation (priv->button, &allocation);
1402 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1403 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1404 &attr, attributes_mask);
1405 gdk_window_set_user_data (priv->window, tree_view);
1407 gtk_tree_view_column_update_button (column);
1409 g_object_unref (attr.cursor);
1413 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1415 GtkTreeViewColumnPrivate *priv;
1417 g_return_if_fail (column != NULL);
1419 priv = column->priv;
1420 g_return_if_fail (priv->window != NULL);
1422 gdk_window_set_user_data (priv->window, NULL);
1423 gdk_window_destroy (priv->window);
1424 priv->window = NULL;
1428 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1429 GtkTreeModel *old_model)
1431 GtkTreeViewColumnPrivate *priv = column->priv;
1433 if (priv->sort_column_changed_signal)
1435 g_signal_handler_disconnect (old_model,
1436 priv->sort_column_changed_signal);
1437 priv->sort_column_changed_signal = 0;
1439 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1443 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1444 GtkTreeView *tree_view)
1446 GtkTreeViewColumnPrivate *priv = column->priv;
1448 g_assert (priv->tree_view == NULL);
1450 priv->tree_view = GTK_WIDGET (tree_view);
1451 gtk_tree_view_column_create_button (column);
1453 priv->property_changed_signal =
1454 g_signal_connect_swapped (tree_view,
1456 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1459 gtk_tree_view_column_setup_sort_column_id_callback (column);
1463 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1465 GtkTreeViewColumnPrivate *priv = column->priv;
1467 if (priv->tree_view && priv->button)
1469 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1471 if (priv->property_changed_signal)
1473 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1474 priv->property_changed_signal = 0;
1477 if (priv->sort_column_changed_signal)
1479 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1480 priv->sort_column_changed_signal);
1481 priv->sort_column_changed_signal = 0;
1484 priv->tree_view = NULL;
1485 priv->button = NULL;
1489 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1491 GtkTreeViewColumnPrivate *priv = column->priv;
1492 gboolean ret = FALSE;
1493 GList *list, *cells;
1495 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1497 for (list = cells; list; list = list->next)
1499 GtkCellRenderer *cell = list->data;
1500 GtkCellRendererMode mode;
1502 g_object_get (cell, "mode", &mode, NULL);
1504 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1511 g_list_free (cells);
1516 /* gets cell being edited */
1518 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1520 GtkTreeViewColumnPrivate *priv = column->priv;
1522 return gtk_cell_area_get_edited_cell (priv->cell_area);
1526 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1527 GdkRectangle *cell_area,
1528 GdkRectangle *background_area,
1532 GtkCellRenderer *match = NULL;
1533 GtkTreeViewColumnPrivate *priv = column->priv;
1535 /* If (x, y) is outside of the background area, immediately return */
1536 if (x < background_area->x ||
1537 x > background_area->x + background_area->width ||
1538 y < background_area->y ||
1539 y > background_area->y + background_area->height)
1542 /* If (x, y) is inside the background area, clamp it to the cell_area
1543 * so that a cell is still returned. The main reason for doing this
1544 * (on the x axis) is for handling clicks in the indentation area
1545 * (either at the left or right depending on RTL setting). Another
1546 * reason is for handling clicks on the area where the focus rectangle
1547 * is drawn (this is outside of cell area), this manifests itself
1548 * mainly when a large setting is used for focus-line-width.
1550 if (x < cell_area->x)
1552 else if (x > cell_area->x + cell_area->width)
1553 x = cell_area->x + cell_area->width;
1555 if (y < cell_area->y)
1557 else if (y > cell_area->y + cell_area->height)
1558 y = cell_area->y + cell_area->height;
1560 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1561 priv->cell_area_context,
1571 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1572 GdkRectangle *cell_area,
1573 GdkRectangle *background_area,
1577 GtkCellRenderer *match;
1578 GdkRectangle cell_alloc, aligned_area, inner_area;
1579 GtkTreeViewColumnPrivate *priv = column->priv;
1581 match = _gtk_tree_view_column_get_cell_at_pos (column,
1588 gtk_cell_area_get_cell_allocation (priv->cell_area,
1589 priv->cell_area_context,
1595 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1596 &cell_alloc, &inner_area);
1597 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1598 &inner_area, &aligned_area);
1600 if (x < aligned_area.x ||
1601 x > aligned_area.x + aligned_area.width ||
1602 y < aligned_area.y ||
1603 y > aligned_area.y + aligned_area.height)
1609 /* Public Functions */
1613 * gtk_tree_view_column_new:
1615 * Creates a new #GtkTreeViewColumn.
1617 * Return value: A newly created #GtkTreeViewColumn.
1620 gtk_tree_view_column_new (void)
1622 GtkTreeViewColumn *tree_column;
1624 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1630 * gtk_tree_view_column_new_with_area:
1631 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1633 * Creates a new #GtkTreeViewColumn using @area to render its cells.
1635 * Return value: A newly created #GtkTreeViewColumn.
1640 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1642 GtkTreeViewColumn *tree_column;
1644 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1651 * gtk_tree_view_column_new_with_attributes:
1652 * @title: The title to set the header to
1653 * @cell: The #GtkCellRenderer
1654 * @...: A %NULL-terminated list of attributes
1656 * Creates a new #GtkTreeViewColumn with a number of default values.
1657 * This is equivalent to calling gtk_tree_view_column_set_title(),
1658 * gtk_tree_view_column_pack_start(), and
1659 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1661 * Here's a simple example:
1663 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1666 * GtkTreeViewColumn *column;
1667 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1669 * column = gtk_tree_view_column_new_with_attributes ("Title",
1671 * "text", TEXT_COLUMN,
1672 * "foreground", COLOR_COLUMN,
1677 * Return value: A newly created #GtkTreeViewColumn.
1680 gtk_tree_view_column_new_with_attributes (const gchar *title,
1681 GtkCellRenderer *cell,
1684 GtkTreeViewColumn *retval;
1687 retval = gtk_tree_view_column_new ();
1689 gtk_tree_view_column_set_title (retval, title);
1690 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1692 va_start (args, cell);
1693 gtk_tree_view_column_set_attributesv (retval, cell, args);
1700 * gtk_tree_view_column_pack_start:
1701 * @tree_column: A #GtkTreeViewColumn.
1702 * @cell: The #GtkCellRenderer.
1703 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1705 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1706 * the @cell is allocated no more space than it needs. Any unused space is divided
1707 * evenly between cells for which @expand is %TRUE.
1710 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1711 GtkCellRenderer *cell,
1714 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1718 * gtk_tree_view_column_pack_end:
1719 * @tree_column: A #GtkTreeViewColumn.
1720 * @cell: The #GtkCellRenderer.
1721 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1723 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1724 * is allocated no more space than it needs. Any unused space is divided
1725 * evenly between cells for which @expand is %TRUE.
1728 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1729 GtkCellRenderer *cell,
1732 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1736 * gtk_tree_view_column_clear:
1737 * @tree_column: A #GtkTreeViewColumn
1739 * Unsets all the mappings on all renderers on the @tree_column.
1742 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1744 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1748 * gtk_tree_view_column_add_attribute:
1749 * @tree_column: A #GtkTreeViewColumn.
1750 * @cell_renderer: the #GtkCellRenderer to set attributes on
1751 * @attribute: An attribute on the renderer
1752 * @column: The column position on the model to get the attribute from.
1754 * Adds an attribute mapping to the list in @tree_column. The @column is the
1755 * column of the model to get a value from, and the @attribute is the
1756 * parameter on @cell_renderer to be set from the value. So for example
1757 * if column 2 of the model contains strings, you could have the
1758 * "text" attribute of a #GtkCellRendererText get its values from
1762 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1763 GtkCellRenderer *cell_renderer,
1764 const gchar *attribute,
1767 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1768 cell_renderer, attribute, column);
1772 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1773 GtkCellRenderer *cell_renderer,
1776 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1780 attribute = va_arg (args, gchar *);
1782 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1785 while (attribute != NULL)
1787 column = va_arg (args, gint);
1788 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1789 cell_renderer, attribute, column);
1790 attribute = va_arg (args, gchar *);
1795 * gtk_tree_view_column_set_attributes:
1796 * @tree_column: A #GtkTreeViewColumn
1797 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1798 * @...: A %NULL-terminated list of attributes
1800 * Sets the attributes in the list as the attributes of @tree_column.
1801 * The attributes should be in attribute/column order, as in
1802 * gtk_tree_view_column_add_attribute(). All existing attributes
1803 * are removed, and replaced with the new attributes.
1806 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1807 GtkCellRenderer *cell_renderer,
1812 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1813 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1815 va_start (args, cell_renderer);
1816 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1822 * gtk_tree_view_column_set_cell_data_func:
1823 * @tree_column: A #GtkTreeViewColumn
1824 * @cell_renderer: A #GtkCellRenderer
1825 * @func: (allow-none): The #GtkTreeViewColumnFunc to use.
1826 * @func_data: The user data for @func.
1827 * @destroy: The destroy notification for @func_data
1829 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1830 * function is used instead of the standard attributes mapping for
1831 * setting the column value, and should set the value of @tree_column's
1832 * cell renderer as appropriate. @func may be %NULL to remove an
1836 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1837 GtkCellRenderer *cell_renderer,
1838 GtkTreeCellDataFunc func,
1840 GDestroyNotify destroy)
1842 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1844 (GtkCellLayoutDataFunc)func,
1845 func_data, destroy);
1850 * gtk_tree_view_column_clear_attributes:
1851 * @tree_column: a #GtkTreeViewColumn
1852 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1854 * Clears all existing attributes previously set with
1855 * gtk_tree_view_column_set_attributes().
1858 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1859 GtkCellRenderer *cell_renderer)
1861 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1866 * gtk_tree_view_column_set_spacing:
1867 * @tree_column: A #GtkTreeViewColumn.
1868 * @spacing: distance between cell renderers in pixels.
1870 * Sets the spacing field of @tree_column, which is the number of pixels to
1871 * place between cell renderers packed into it.
1874 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1877 GtkTreeViewColumnPrivate *priv;
1879 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1880 g_return_if_fail (spacing >= 0);
1882 priv = tree_column->priv;
1884 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1886 if (priv->tree_view)
1887 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1891 * gtk_tree_view_column_get_spacing:
1892 * @tree_column: A #GtkTreeViewColumn.
1894 * Returns the spacing of @tree_column.
1896 * Return value: the spacing of @tree_column.
1899 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1901 GtkTreeViewColumnPrivate *priv;
1903 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1905 priv = tree_column->priv;
1907 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1910 /* Options for manipulating the columns */
1913 * gtk_tree_view_column_set_visible:
1914 * @tree_column: A #GtkTreeViewColumn.
1915 * @visible: %TRUE if the @tree_column is visible.
1917 * Sets the visibility of @tree_column.
1920 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1923 GtkTreeViewColumnPrivate *priv;
1925 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1927 priv = tree_column->priv;
1928 visible = !! visible;
1930 if (priv->visible == visible)
1933 priv->visible = visible;
1936 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1938 if (priv->tree_view)
1939 _gtk_tree_view_reset_header_styles (GTK_TREE_VIEW (priv->tree_view));
1941 gtk_tree_view_column_update_button (tree_column);
1942 g_object_notify (G_OBJECT (tree_column), "visible");
1946 * gtk_tree_view_column_get_visible:
1947 * @tree_column: A #GtkTreeViewColumn.
1949 * Returns %TRUE if @tree_column is visible.
1951 * Return value: whether the column is visible or not. If it is visible, then
1952 * the tree will show the column.
1955 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1957 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1959 return tree_column->priv->visible;
1963 * gtk_tree_view_column_set_resizable:
1964 * @tree_column: A #GtkTreeViewColumn
1965 * @resizable: %TRUE, if the column can be resized
1967 * If @resizable is %TRUE, then the user can explicitly resize the column by
1968 * grabbing the outer edge of the column button. If resizable is %TRUE and
1969 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1970 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1973 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1976 GtkTreeViewColumnPrivate *priv;
1978 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1980 priv = tree_column->priv;
1981 resizable = !! resizable;
1983 if (priv->resizable == resizable)
1986 priv->resizable = resizable;
1988 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1989 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1991 gtk_tree_view_column_update_button (tree_column);
1993 g_object_notify (G_OBJECT (tree_column), "resizable");
1997 * gtk_tree_view_column_get_resizable:
1998 * @tree_column: A #GtkTreeViewColumn
2000 * Returns %TRUE if the @tree_column can be resized by the end user.
2002 * Return value: %TRUE, if the @tree_column can be resized.
2005 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
2007 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2009 return tree_column->priv->resizable;
2014 * gtk_tree_view_column_set_sizing:
2015 * @tree_column: A #GtkTreeViewColumn.
2016 * @type: The #GtkTreeViewColumnSizing.
2018 * Sets the growth behavior of @tree_column to @type.
2021 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
2022 GtkTreeViewColumnSizing type)
2024 GtkTreeViewColumnPrivate *priv;
2026 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2028 priv = tree_column->priv;
2030 if (type == priv->column_type)
2033 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2034 gtk_tree_view_column_set_resizable (tree_column, FALSE);
2036 priv->column_type = type;
2038 gtk_tree_view_column_update_button (tree_column);
2040 g_object_notify (G_OBJECT (tree_column), "sizing");
2044 * gtk_tree_view_column_get_sizing:
2045 * @tree_column: A #GtkTreeViewColumn.
2047 * Returns the current type of @tree_column.
2049 * Return value: The type of @tree_column.
2051 GtkTreeViewColumnSizing
2052 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
2054 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2056 return tree_column->priv->column_type;
2060 * gtk_tree_view_column_get_width:
2061 * @tree_column: A #GtkTreeViewColumn.
2063 * Returns the current size of @tree_column in pixels.
2065 * Return value: The current width of @tree_column.
2068 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2070 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2072 return tree_column->priv->width;
2076 * gtk_tree_view_column_get_x_offset:
2077 * @tree_column: A #GtkTreeViewColumn.
2079 * Returns the current X offset of @tree_column in pixels.
2081 * Return value: The current X offset of @tree_column.
2086 gtk_tree_view_column_get_x_offset (GtkTreeViewColumn *tree_column)
2088 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2090 return tree_column->priv->x_offset;
2094 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2096 GtkTreeViewColumnPrivate *priv;
2097 gint real_requested_width;
2099 priv = tree_column->priv;
2101 if (priv->use_resized_width)
2103 real_requested_width = priv->resized_width;
2105 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2107 real_requested_width = priv->fixed_width;
2109 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2111 gint button_request;
2112 gint requested_width;
2114 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2115 requested_width += priv->padding;
2117 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2118 real_requested_width = MAX (requested_width, button_request);
2122 gint requested_width;
2124 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2125 requested_width += priv->padding;
2127 real_requested_width = requested_width;
2128 if (real_requested_width < 0)
2129 real_requested_width = 0;
2132 if (priv->min_width != -1)
2133 real_requested_width = MAX (real_requested_width, priv->min_width);
2135 if (priv->max_width != -1)
2136 real_requested_width = MIN (real_requested_width, priv->max_width);
2138 return real_requested_width;
2142 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2146 GtkTreeViewColumnPrivate *priv;
2148 GtkAllocation allocation = { 0, 0, 0, 0 };
2150 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2152 priv = tree_column->priv;
2154 if (priv->width != width)
2155 gtk_widget_queue_draw (priv->tree_view);
2157 priv->x_offset = x_offset;
2158 priv->width = width;
2160 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2162 if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2164 allocation.x = x_offset;
2166 allocation.width = width;
2167 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2169 gtk_widget_size_allocate (priv->button, &allocation);
2174 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2175 gdk_window_move_resize (priv->window,
2176 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2178 TREE_VIEW_DRAG_WIDTH, allocation.height);
2181 g_object_notify (G_OBJECT (tree_column), "x-offset");
2182 g_object_notify (G_OBJECT (tree_column), "width");
2186 * gtk_tree_view_column_set_fixed_width:
2187 * @tree_column: A #GtkTreeViewColumn.
2188 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2190 * Sets the size of the column in pixels. This is meaningful only if the sizing
2191 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2192 * the min/max width for the column. Please note that the min/max width of the
2193 * column doesn't actually affect the "fixed_width" property of the widget, just
2194 * the actual size when displayed.
2197 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2200 GtkTreeViewColumnPrivate *priv;
2202 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2203 g_return_if_fail (fixed_width > 0);
2205 priv = tree_column->priv;
2207 priv->fixed_width = fixed_width;
2208 priv->use_resized_width = FALSE;
2210 if (priv->tree_view &&
2211 gtk_widget_get_realized (priv->tree_view) &&
2212 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2214 gtk_widget_queue_resize (priv->tree_view);
2217 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2221 * gtk_tree_view_column_get_fixed_width:
2222 * @tree_column: a #GtkTreeViewColumn
2224 * Gets the fixed width of the column. This value is only meaning may not be
2225 * the actual width of the column on the screen, just what is requested.
2227 * Return value: the fixed width of the column
2230 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2232 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2234 return tree_column->priv->fixed_width;
2238 * gtk_tree_view_column_set_min_width:
2239 * @tree_column: A #GtkTreeViewColumn.
2240 * @min_width: The minimum width of the column in pixels, or -1.
2242 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2243 * minimum width is unset.
2246 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2249 GtkTreeViewColumnPrivate *priv;
2251 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2252 g_return_if_fail (min_width >= -1);
2254 priv = tree_column->priv;
2256 if (min_width == priv->min_width)
2259 if (priv->visible &&
2260 priv->tree_view != NULL &&
2261 gtk_widget_get_realized (priv->tree_view))
2263 if (min_width > priv->width)
2264 gtk_widget_queue_resize (priv->tree_view);
2267 priv->min_width = min_width;
2268 g_object_freeze_notify (G_OBJECT (tree_column));
2269 if (priv->max_width != -1 && priv->max_width < min_width)
2271 priv->max_width = min_width;
2272 g_object_notify (G_OBJECT (tree_column), "max-width");
2274 g_object_notify (G_OBJECT (tree_column), "min-width");
2275 g_object_thaw_notify (G_OBJECT (tree_column));
2277 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2278 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2283 * gtk_tree_view_column_get_min_width:
2284 * @tree_column: A #GtkTreeViewColumn.
2286 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2289 * Return value: The minimum width of the @tree_column.
2292 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2294 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2296 return tree_column->priv->min_width;
2300 * gtk_tree_view_column_set_max_width:
2301 * @tree_column: A #GtkTreeViewColumn.
2302 * @max_width: The maximum width of the column in pixels, or -1.
2304 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2305 * maximum width is unset. Note, the column can actually be wider than max
2306 * width if it's the last column in a view. In this case, the column expands to
2307 * fill any extra space.
2310 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2313 GtkTreeViewColumnPrivate *priv;
2315 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2316 g_return_if_fail (max_width >= -1);
2318 priv = tree_column->priv;
2320 if (max_width == priv->max_width)
2323 if (priv->visible &&
2324 priv->tree_view != NULL &&
2325 gtk_widget_get_realized (priv->tree_view))
2327 if (max_width != -1 && max_width < priv->width)
2328 gtk_widget_queue_resize (priv->tree_view);
2331 priv->max_width = max_width;
2332 g_object_freeze_notify (G_OBJECT (tree_column));
2333 if (max_width != -1 && max_width < priv->min_width)
2335 priv->min_width = max_width;
2336 g_object_notify (G_OBJECT (tree_column), "min-width");
2338 g_object_notify (G_OBJECT (tree_column), "max-width");
2339 g_object_thaw_notify (G_OBJECT (tree_column));
2341 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2342 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2347 * gtk_tree_view_column_get_max_width:
2348 * @tree_column: A #GtkTreeViewColumn.
2350 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2353 * Return value: The maximum width of the @tree_column.
2356 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2358 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2360 return tree_column->priv->max_width;
2364 * gtk_tree_view_column_clicked:
2365 * @tree_column: a #GtkTreeViewColumn
2367 * Emits the "clicked" signal on the column. This function will only work if
2368 * @tree_column is clickable.
2371 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2373 GtkTreeViewColumnPrivate *priv;
2375 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2377 priv = tree_column->priv;
2379 if (priv->visible &&
2382 gtk_button_clicked (GTK_BUTTON (priv->button));
2386 * gtk_tree_view_column_set_title:
2387 * @tree_column: A #GtkTreeViewColumn.
2388 * @title: The title of the @tree_column.
2390 * Sets the title of the @tree_column. If a custom widget has been set, then
2391 * this value is ignored.
2394 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2397 GtkTreeViewColumnPrivate *priv;
2400 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2402 priv = tree_column->priv;
2404 new_title = g_strdup (title);
2405 g_free (priv->title);
2406 priv->title = new_title;
2408 gtk_tree_view_column_update_button (tree_column);
2409 g_object_notify (G_OBJECT (tree_column), "title");
2413 * gtk_tree_view_column_get_title:
2414 * @tree_column: A #GtkTreeViewColumn.
2416 * Returns the title of the widget.
2418 * Return value: the title of the column. This string should not be
2419 * modified or freed.
2422 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2424 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2426 return tree_column->priv->title;
2430 * gtk_tree_view_column_set_expand:
2431 * @tree_column: A #GtkTreeViewColumn
2432 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2434 * Sets the column to take available extra space. This space is shared equally
2435 * amongst all columns that have the expand set to %TRUE. If no column has this
2436 * option set, then the last column gets all extra space. By default, every
2437 * column is created with this %FALSE.
2442 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2445 GtkTreeViewColumnPrivate *priv;
2447 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2449 priv = tree_column->priv;
2451 expand = expand?TRUE:FALSE;
2452 if (priv->expand == expand)
2454 priv->expand = expand;
2456 if (priv->visible &&
2457 priv->tree_view != NULL &&
2458 gtk_widget_get_realized (priv->tree_view))
2460 /* We want to continue using the original width of the
2461 * column that includes additional space added by the user
2462 * resizing the columns and possibly extra (expanded) space, which
2463 * are not included in the resized width.
2465 priv->use_resized_width = FALSE;
2467 gtk_widget_queue_resize (priv->tree_view);
2470 g_object_notify (G_OBJECT (tree_column), "expand");
2474 * gtk_tree_view_column_get_expand:
2475 * @tree_column: a #GtkTreeViewColumn
2477 * Return %TRUE if the column expands to take any available space.
2479 * Return value: %TRUE, if the column expands
2484 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2486 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2488 return tree_column->priv->expand;
2492 * gtk_tree_view_column_set_clickable:
2493 * @tree_column: A #GtkTreeViewColumn.
2494 * @clickable: %TRUE if the header is active.
2496 * Sets the header to be active if @active is %TRUE. When the header is active,
2497 * then it can take keyboard focus, and can be clicked.
2500 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2503 GtkTreeViewColumnPrivate *priv;
2505 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2507 priv = tree_column->priv;
2509 clickable = !! clickable;
2510 if (priv->clickable == clickable)
2513 priv->clickable = clickable;
2514 gtk_tree_view_column_update_button (tree_column);
2515 g_object_notify (G_OBJECT (tree_column), "clickable");
2519 * gtk_tree_view_column_get_clickable:
2520 * @tree_column: a #GtkTreeViewColumn
2522 * Returns %TRUE if the user can click on the header for the column.
2524 * Return value: %TRUE if user can click the column header.
2527 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2529 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2531 return tree_column->priv->clickable;
2535 * gtk_tree_view_column_set_widget:
2536 * @tree_column: A #GtkTreeViewColumn.
2537 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2539 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2540 * header button is set with a #GtkLabel set to the title of @tree_column.
2543 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2546 GtkTreeViewColumnPrivate *priv;
2548 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2549 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2551 priv = tree_column->priv;
2554 g_object_ref_sink (widget);
2557 g_object_unref (priv->child);
2559 priv->child = widget;
2560 gtk_tree_view_column_update_button (tree_column);
2561 g_object_notify (G_OBJECT (tree_column), "widget");
2565 * gtk_tree_view_column_get_widget:
2566 * @tree_column: A #GtkTreeViewColumn.
2568 * Returns the #GtkWidget in the button on the column header.
2569 * If a custom widget has not been set then %NULL is returned.
2571 * Return value: (transfer none): The #GtkWidget in the column
2575 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2577 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2579 return tree_column->priv->child;
2583 * gtk_tree_view_column_set_alignment:
2584 * @tree_column: A #GtkTreeViewColumn.
2585 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2587 * Sets the alignment of the title or custom widget inside the column header.
2588 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2589 * for center, 1.0 for right.
2592 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2595 GtkTreeViewColumnPrivate *priv;
2597 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2599 priv = tree_column->priv;
2601 xalign = CLAMP (xalign, 0.0, 1.0);
2603 if (priv->xalign == xalign)
2606 priv->xalign = xalign;
2607 gtk_tree_view_column_update_button (tree_column);
2608 g_object_notify (G_OBJECT (tree_column), "alignment");
2612 * gtk_tree_view_column_get_alignment:
2613 * @tree_column: A #GtkTreeViewColumn.
2615 * Returns the current x alignment of @tree_column. This value can range
2616 * between 0.0 and 1.0.
2618 * Return value: The current alignent of @tree_column.
2621 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2623 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2625 return tree_column->priv->xalign;
2629 * gtk_tree_view_column_set_reorderable:
2630 * @tree_column: A #GtkTreeViewColumn
2631 * @reorderable: %TRUE, if the column can be reordered.
2633 * If @reorderable is %TRUE, then the column can be reordered by the end user
2634 * dragging the header.
2637 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2638 gboolean reorderable)
2640 GtkTreeViewColumnPrivate *priv;
2642 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2644 priv = tree_column->priv;
2647 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2649 if (priv->reorderable == (reorderable?TRUE:FALSE))
2652 priv->reorderable = (reorderable?TRUE:FALSE);
2653 gtk_tree_view_column_update_button (tree_column);
2654 g_object_notify (G_OBJECT (tree_column), "reorderable");
2658 * gtk_tree_view_column_get_reorderable:
2659 * @tree_column: A #GtkTreeViewColumn
2661 * Returns %TRUE if the @tree_column can be reordered by the user.
2663 * Return value: %TRUE if the @tree_column can be reordered by the user.
2666 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2668 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2670 return tree_column->priv->reorderable;
2675 * gtk_tree_view_column_set_sort_column_id:
2676 * @tree_column: a #GtkTreeViewColumn
2677 * @sort_column_id: The @sort_column_id of the model to sort on.
2679 * Sets the logical @sort_column_id that this column sorts on when this column
2680 * is selected for sorting. Doing so makes the column header clickable.
2683 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2684 gint sort_column_id)
2686 GtkTreeViewColumnPrivate *priv;
2688 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2689 g_return_if_fail (sort_column_id >= -1);
2691 priv = tree_column->priv;
2693 if (priv->sort_column_id == sort_column_id)
2696 priv->sort_column_id = sort_column_id;
2698 /* Handle unsetting the id */
2699 if (sort_column_id == -1)
2701 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2703 if (priv->sort_clicked_signal)
2705 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2706 priv->sort_clicked_signal = 0;
2709 if (priv->sort_column_changed_signal)
2711 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2712 priv->sort_column_changed_signal = 0;
2715 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2716 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2717 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2718 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2722 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2724 if (! priv->sort_clicked_signal)
2725 priv->sort_clicked_signal = g_signal_connect (tree_column,
2727 G_CALLBACK (gtk_tree_view_column_sort),
2730 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2731 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2735 * gtk_tree_view_column_get_sort_column_id:
2736 * @tree_column: a #GtkTreeViewColumn
2738 * Gets the logical @sort_column_id that the model sorts on when this
2739 * column is selected for sorting.
2740 * See gtk_tree_view_column_set_sort_column_id().
2742 * Return value: the current @sort_column_id for this column, or -1 if
2743 * this column can't be used for sorting.
2746 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2748 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2750 return tree_column->priv->sort_column_id;
2754 * gtk_tree_view_column_set_sort_indicator:
2755 * @tree_column: a #GtkTreeViewColumn
2756 * @setting: %TRUE to display an indicator that the column is sorted
2758 * Call this function with a @setting of %TRUE to display an arrow in
2759 * the header button indicating the column is sorted. Call
2760 * gtk_tree_view_column_set_sort_order() to change the direction of
2765 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2768 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2770 setting = setting != FALSE;
2772 if (setting == tree_column->priv->show_sort_indicator)
2775 tree_column->priv->show_sort_indicator = setting;
2776 gtk_tree_view_column_update_button (tree_column);
2777 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2781 * gtk_tree_view_column_get_sort_indicator:
2782 * @tree_column: a #GtkTreeViewColumn
2784 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2786 * Return value: whether the sort indicator arrow is displayed
2789 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2791 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2793 return tree_column->priv->show_sort_indicator;
2797 * gtk_tree_view_column_set_sort_order:
2798 * @tree_column: a #GtkTreeViewColumn
2799 * @order: sort order that the sort indicator should indicate
2801 * Changes the appearance of the sort indicator.
2803 * This <emphasis>does not</emphasis> actually sort the model. Use
2804 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2805 * support. This function is primarily for custom sorting behavior, and should
2806 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2807 * that. For custom models, the mechanism will vary.
2809 * The sort indicator changes direction to indicate normal sort or reverse sort.
2810 * Note that you must have the sort indicator enabled to see anything when
2811 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2814 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2817 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2819 if (order == tree_column->priv->sort_order)
2822 tree_column->priv->sort_order = order;
2823 gtk_tree_view_column_update_button (tree_column);
2824 g_object_notify (G_OBJECT (tree_column), "sort-order");
2828 * gtk_tree_view_column_get_sort_order:
2829 * @tree_column: a #GtkTreeViewColumn
2831 * Gets the value set by gtk_tree_view_column_set_sort_order().
2833 * Return value: the sort order the sort indicator is indicating
2836 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2838 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2840 return tree_column->priv->sort_order;
2844 * gtk_tree_view_column_cell_set_cell_data:
2845 * @tree_column: A #GtkTreeViewColumn.
2846 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2847 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2848 * @is_expander: %TRUE, if the row has children
2849 * @is_expanded: %TRUE, if the row has visible children
2851 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2852 * every attribute mapping in @tree_column, it will get a value from the set
2853 * column on the @iter, and use that value to set the attribute on the cell
2854 * renderer. This is used primarily by the #GtkTreeView.
2857 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2858 GtkTreeModel *tree_model,
2860 gboolean is_expander,
2861 gboolean is_expanded)
2863 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2865 if (tree_model == NULL)
2868 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2869 is_expander, is_expanded);
2873 * gtk_tree_view_column_cell_get_size:
2874 * @tree_column: A #GtkTreeViewColumn.
2875 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2876 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2877 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2878 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2879 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2881 * Obtains the width and height needed to render the column. This is used
2882 * primarily by the #GtkTreeView.
2885 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2886 const GdkRectangle *cell_area,
2892 GtkTreeViewColumnPrivate *priv;
2893 gint min_width = 0, min_height = 0;
2895 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2897 priv = tree_column->priv;
2899 g_signal_handler_block (priv->cell_area_context,
2900 priv->context_changed_signal);
2902 gtk_cell_area_get_preferred_width (priv->cell_area,
2903 priv->cell_area_context,
2907 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2909 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2910 priv->cell_area_context,
2916 g_signal_handler_unblock (priv->cell_area_context,
2917 priv->context_changed_signal);
2921 * height = min_height;
2923 * width = min_width;
2928 * gtk_tree_view_column_cell_render:
2929 * @tree_column: A #GtkTreeViewColumn.
2930 * @cr: cairo context to draw to
2931 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2932 * @cell_area: area normally rendered by a cell renderer
2933 * @flags: flags that affect rendering
2935 * Renders the cell contained by #tree_column. This is used primarily by the
2939 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2941 const GdkRectangle *background_area,
2942 const GdkRectangle *cell_area,
2944 gboolean draw_focus)
2946 GtkTreeViewColumnPrivate *priv;
2948 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2949 g_return_if_fail (cr != NULL);
2950 g_return_if_fail (background_area != NULL);
2951 g_return_if_fail (cell_area != NULL);
2953 priv = tree_column->priv;
2957 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2958 priv->tree_view, cr,
2959 background_area, cell_area, flags,
2966 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2968 const GdkRectangle *cell_area,
2971 GtkTreeViewColumnPrivate *priv;
2973 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2975 priv = tree_column->priv;
2977 return gtk_cell_area_event (priv->cell_area,
2978 priv->cell_area_context,
2986 * gtk_tree_view_column_cell_is_visible:
2987 * @tree_column: A #GtkTreeViewColumn
2989 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2990 * For this to be meaningful, you must first initialize the cells with
2991 * gtk_tree_view_column_cell_set_cell_data()
2993 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2996 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
3000 GtkTreeViewColumnPrivate *priv;
3002 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3004 priv = tree_column->priv;
3006 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
3007 for (list = cells; list; list = list->next)
3009 if (gtk_cell_renderer_get_visible (list->data))
3011 g_list_free (cells);
3016 g_list_free (cells);
3022 * gtk_tree_view_column_focus_cell:
3023 * @tree_column: A #GtkTreeViewColumn
3024 * @cell: A #GtkCellRenderer
3026 * Sets the current keyboard focus to be at @cell, if the column contains
3027 * 2 or more editable and activatable cells.
3032 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
3033 GtkCellRenderer *cell)
3035 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3036 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
3038 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
3042 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
3043 gboolean install_handler)
3045 GtkTreeViewColumnPrivate *priv = tree_column->priv;
3051 /* Issue a manual reset on the context to have all
3052 * sizes re-requested for the context.
3054 g_signal_handler_block (priv->cell_area_context,
3055 priv->context_changed_signal);
3056 gtk_cell_area_context_reset (priv->cell_area_context);
3057 g_signal_handler_unblock (priv->cell_area_context,
3058 priv->context_changed_signal);
3060 if (priv->tree_view &&
3061 gtk_widget_get_realized (priv->tree_view))
3063 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
3064 gtk_widget_queue_resize (priv->tree_view);
3069 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
3071 return tree_column->priv->dirty;
3075 * gtk_tree_view_column_cell_get_position:
3076 * @tree_column: a #GtkTreeViewColumn
3077 * @cell_renderer: a #GtkCellRenderer
3078 * @x_offset: (out) (allow-none): return location for the horizontal
3079 * position of @cell within @tree_column, may be %NULL
3080 * @width: (out) (allow-none): return location for the width of @cell,
3083 * Obtains the horizontal position and size of a cell in a column. If the
3084 * cell is not found in the column, @start_pos and @width are not changed and
3085 * %FALSE is returned.
3087 * Return value: %TRUE if @cell belongs to @tree_column.
3090 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3091 GtkCellRenderer *cell_renderer,
3095 GtkTreeViewColumnPrivate *priv;
3096 GdkRectangle cell_area;
3097 GdkRectangle allocation;
3099 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3100 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3102 priv = tree_column->priv;
3104 if (! gtk_cell_area_has_renderer (priv->cell_area, cell_renderer))
3107 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3108 NULL, tree_column, &cell_area);
3110 gtk_cell_area_get_cell_allocation (priv->cell_area,
3111 priv->cell_area_context,
3118 *x_offset = allocation.x - cell_area.x;
3121 *width = allocation.width;
3127 * gtk_tree_view_column_queue_resize:
3128 * @tree_column: A #GtkTreeViewColumn
3130 * Flags the column, and the cell renderers added to this column, to have
3131 * their sizes renegotiated.
3136 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3138 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3140 if (tree_column->priv->tree_view)
3141 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3145 * gtk_tree_view_column_get_tree_view:
3146 * @tree_column: A #GtkTreeViewColumn
3148 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3149 * If @column is currently not inserted in any tree view, %NULL is
3152 * Return value: (transfer none): The tree view wherein @column has
3153 * been inserted if any, %NULL otherwise.
3158 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3160 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3162 return tree_column->priv->tree_view;
3166 * gtk_tree_view_column_get_button:
3167 * @tree_column: A #GtkTreeViewColumn
3169 * Returns the button used in the treeview column header
3171 * Return value: (transfer none): The button for the column header.
3176 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3178 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3180 return tree_column->priv->button;
3184 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3186 return column->priv->window;
3190 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3193 column->priv->padding = MAX (column->priv->padding, padding);
3197 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3199 gint requested_width;
3201 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3203 return requested_width + column->priv->padding;
3208 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3211 column->priv->resized_width = width;
3215 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3217 return column->priv->resized_width;
3221 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3222 gboolean use_resized_width)
3224 column->priv->use_resized_width = use_resized_width;
3228 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3230 return column->priv->use_resized_width;
3234 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3236 return column->priv->drag_x;
3239 GtkCellAreaContext *
3240 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3242 return column->priv->cell_area_context;