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 if (priv->cell_area_context)
522 g_signal_handler_disconnect (priv->cell_area_context,
523 priv->context_changed_signal);
525 g_object_unref (priv->cell_area_context);
527 priv->cell_area_context = NULL;
528 priv->context_changed_signal = 0;
533 g_signal_handler_disconnect (priv->cell_area,
534 priv->add_editable_signal);
535 g_signal_handler_disconnect (priv->cell_area,
536 priv->remove_editable_signal);
538 g_object_unref (priv->cell_area);
539 priv->cell_area = NULL;
540 priv->add_editable_signal = 0;
541 priv->remove_editable_signal = 0;
546 g_object_unref (priv->child);
550 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
554 gtk_tree_view_column_finalize (GObject *object)
556 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
557 GtkTreeViewColumnPrivate *priv = tree_column->priv;
559 g_free (priv->title);
561 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
565 gtk_tree_view_column_set_property (GObject *object,
570 GtkTreeViewColumn *tree_column;
573 tree_column = GTK_TREE_VIEW_COLUMN (object);
578 gtk_tree_view_column_set_visible (tree_column,
579 g_value_get_boolean (value));
583 gtk_tree_view_column_set_resizable (tree_column,
584 g_value_get_boolean (value));
588 gtk_tree_view_column_set_sizing (tree_column,
589 g_value_get_enum (value));
592 case PROP_FIXED_WIDTH:
593 gtk_tree_view_column_set_fixed_width (tree_column,
594 g_value_get_int (value));
598 gtk_tree_view_column_set_min_width (tree_column,
599 g_value_get_int (value));
603 gtk_tree_view_column_set_max_width (tree_column,
604 g_value_get_int (value));
608 gtk_tree_view_column_set_spacing (tree_column,
609 g_value_get_int (value));
613 gtk_tree_view_column_set_title (tree_column,
614 g_value_get_string (value));
618 gtk_tree_view_column_set_expand (tree_column,
619 g_value_get_boolean (value));
623 gtk_tree_view_column_set_clickable (tree_column,
624 g_value_get_boolean (value));
628 gtk_tree_view_column_set_widget (tree_column,
629 (GtkWidget*) g_value_get_object (value));
633 gtk_tree_view_column_set_alignment (tree_column,
634 g_value_get_float (value));
637 case PROP_REORDERABLE:
638 gtk_tree_view_column_set_reorderable (tree_column,
639 g_value_get_boolean (value));
642 case PROP_SORT_INDICATOR:
643 gtk_tree_view_column_set_sort_indicator (tree_column,
644 g_value_get_boolean (value));
647 case PROP_SORT_ORDER:
648 gtk_tree_view_column_set_sort_order (tree_column,
649 g_value_get_enum (value));
652 case PROP_SORT_COLUMN_ID:
653 gtk_tree_view_column_set_sort_column_id (tree_column,
654 g_value_get_int (value));
658 /* Construct-only, can only be assigned once */
659 area = g_value_get_object (value);
663 if (tree_column->priv->cell_area != NULL)
665 g_warning ("cell-area has already been set, ignoring construct property");
666 g_object_ref_sink (area);
667 g_object_unref (area);
670 gtk_tree_view_column_ensure_cell_area (tree_column, area);
675 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
681 gtk_tree_view_column_get_property (GObject *object,
686 GtkTreeViewColumn *tree_column;
688 tree_column = GTK_TREE_VIEW_COLUMN (object);
693 g_value_set_boolean (value,
694 gtk_tree_view_column_get_visible (tree_column));
698 g_value_set_boolean (value,
699 gtk_tree_view_column_get_resizable (tree_column));
703 g_value_set_int (value,
704 gtk_tree_view_column_get_x_offset (tree_column));
708 g_value_set_int (value,
709 gtk_tree_view_column_get_width (tree_column));
713 g_value_set_int (value,
714 gtk_tree_view_column_get_spacing (tree_column));
718 g_value_set_enum (value,
719 gtk_tree_view_column_get_sizing (tree_column));
722 case PROP_FIXED_WIDTH:
723 g_value_set_int (value,
724 gtk_tree_view_column_get_fixed_width (tree_column));
728 g_value_set_int (value,
729 gtk_tree_view_column_get_min_width (tree_column));
733 g_value_set_int (value,
734 gtk_tree_view_column_get_max_width (tree_column));
738 g_value_set_string (value,
739 gtk_tree_view_column_get_title (tree_column));
743 g_value_set_boolean (value,
744 gtk_tree_view_column_get_expand (tree_column));
748 g_value_set_boolean (value,
749 gtk_tree_view_column_get_clickable (tree_column));
753 g_value_set_object (value,
754 (GObject*) gtk_tree_view_column_get_widget (tree_column));
758 g_value_set_float (value,
759 gtk_tree_view_column_get_alignment (tree_column));
762 case PROP_REORDERABLE:
763 g_value_set_boolean (value,
764 gtk_tree_view_column_get_reorderable (tree_column));
767 case PROP_SORT_INDICATOR:
768 g_value_set_boolean (value,
769 gtk_tree_view_column_get_sort_indicator (tree_column));
772 case PROP_SORT_ORDER:
773 g_value_set_enum (value,
774 gtk_tree_view_column_get_sort_order (tree_column));
777 case PROP_SORT_COLUMN_ID:
778 g_value_set_int (value,
779 gtk_tree_view_column_get_sort_column_id (tree_column));
783 g_value_set_object (value, tree_column->priv->cell_area);
787 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
792 /* Implementation of GtkCellLayout interface
796 gtk_tree_view_column_ensure_cell_area (GtkTreeViewColumn *column,
797 GtkCellArea *cell_area)
799 GtkTreeViewColumnPrivate *priv = column->priv;
805 priv->cell_area = cell_area;
807 priv->cell_area = gtk_cell_area_box_new ();
809 g_object_ref_sink (priv->cell_area);
811 priv->add_editable_signal =
812 g_signal_connect (priv->cell_area, "add-editable",
813 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
815 priv->remove_editable_signal =
816 g_signal_connect (priv->cell_area, "remove-editable",
817 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
820 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
822 priv->context_changed_signal =
823 g_signal_connect (priv->cell_area_context, "notify",
824 G_CALLBACK (gtk_tree_view_column_context_changed),
829 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
831 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
832 GtkTreeViewColumnPrivate *priv = column->priv;
834 if (G_UNLIKELY (!priv->cell_area))
835 gtk_tree_view_column_ensure_cell_area (column, NULL);
837 return priv->cell_area;
840 /* Button handling code
843 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
845 GtkTreeViewColumnPrivate *priv = tree_column->priv;
846 GtkTreeView *tree_view;
850 tree_view = (GtkTreeView *) priv->tree_view;
852 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
853 g_return_if_fail (priv->button == NULL);
855 gtk_widget_push_composite_child ();
856 priv->button = gtk_button_new ();
857 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
858 gtk_widget_pop_composite_child ();
860 /* make sure we own a reference to it as well. */
861 if (_gtk_tree_view_get_header_window (tree_view))
862 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
864 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
866 g_signal_connect (priv->button, "event",
867 G_CALLBACK (gtk_tree_view_column_button_event),
869 g_signal_connect (priv->button, "clicked",
870 G_CALLBACK (gtk_tree_view_column_button_clicked),
873 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
875 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
876 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
882 child = gtk_label_new (priv->title);
883 gtk_widget_show (child);
886 g_signal_connect (child, "mnemonic-activate",
887 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
890 if (priv->xalign <= 0.5)
891 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
893 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
895 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
897 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
898 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
900 gtk_widget_show (hbox);
901 gtk_widget_show (priv->alignment);
902 gtk_tree_view_column_update_button (tree_column);
906 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
908 GtkTreeViewColumnPrivate *priv = tree_column->priv;
909 gint sort_column_id = -1;
911 GtkWidget *alignment;
913 GtkWidget *current_child;
914 GtkArrowType arrow_type = GTK_ARROW_NONE;
918 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
922 /* Create a button if necessary */
924 priv->button == NULL &&
926 gtk_widget_get_realized (priv->tree_view))
927 gtk_tree_view_column_create_button (tree_column);
932 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
933 alignment = priv->alignment;
935 current_child = gtk_bin_get_child (GTK_BIN (alignment));
937 /* Set up the actual button */
938 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
943 if (current_child != priv->child)
945 gtk_container_remove (GTK_CONTAINER (alignment),
947 gtk_container_add (GTK_CONTAINER (alignment),
953 if (current_child == NULL)
955 current_child = gtk_label_new (NULL);
956 gtk_widget_show (current_child);
957 gtk_container_add (GTK_CONTAINER (alignment),
961 g_return_if_fail (GTK_IS_LABEL (current_child));
964 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
967 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
971 if (GTK_IS_TREE_SORTABLE (model))
972 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
976 if (priv->show_sort_indicator)
978 gboolean alternative;
980 g_object_get (gtk_widget_get_settings (priv->tree_view),
981 "gtk-alternative-sort-arrows", &alternative,
984 switch (priv->sort_order)
986 case GTK_SORT_ASCENDING:
987 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
990 case GTK_SORT_DESCENDING:
991 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
995 g_warning (G_STRLOC": bad sort order");
1000 gtk_arrow_set (GTK_ARROW (arrow),
1004 /* Put arrow on the right if the text is left-or-center justified, and on the
1005 * left otherwise; do this by packing boxes, so flipping text direction will
1008 g_object_ref (arrow);
1009 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
1011 if (priv->xalign <= 0.5)
1013 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1017 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
1018 /* move it to the front */
1019 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
1021 g_object_unref (arrow);
1023 if (priv->show_sort_indicator
1024 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
1025 gtk_widget_show (arrow);
1027 gtk_widget_hide (arrow);
1029 /* It's always safe to hide the button. It isn't always safe to show it, as
1030 * if you show it before it's realized, it'll get the wrong window. */
1032 priv->tree_view != NULL &&
1033 gtk_widget_get_realized (priv->tree_view))
1037 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
1038 gtk_widget_show_now (priv->button);
1042 if (priv->resizable)
1044 gdk_window_show (priv->window);
1045 gdk_window_raise (priv->window);
1049 gdk_window_hide (priv->window);
1055 gtk_widget_hide (priv->button);
1057 gdk_window_hide (priv->window);
1061 if (priv->reorderable || priv->clickable)
1063 gtk_widget_set_can_focus (priv->button, TRUE);
1067 gtk_widget_set_can_focus (priv->button, FALSE);
1068 if (gtk_widget_has_focus (priv->button))
1070 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1071 if (gtk_widget_is_toplevel (toplevel))
1073 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1077 /* Queue a resize on the assumption that we always want to catch all changes
1078 * and columns don't change all that often.
1080 if (gtk_widget_get_realized (priv->tree_view))
1081 gtk_widget_queue_resize (priv->tree_view);
1085 /* Button signal handlers
1089 gtk_tree_view_column_button_event (GtkWidget *widget,
1093 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1094 GtkTreeViewColumnPrivate *priv = column->priv;
1096 g_return_val_if_fail (event != NULL, FALSE);
1098 if (event->type == GDK_BUTTON_PRESS &&
1099 priv->reorderable &&
1100 ((GdkEventButton *)event)->button == 1)
1102 priv->maybe_reordered = TRUE;
1103 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1107 gtk_widget_grab_focus (widget);
1110 if (event->type == GDK_BUTTON_RELEASE ||
1111 event->type == GDK_LEAVE_NOTIFY)
1112 priv->maybe_reordered = FALSE;
1114 if (event->type == GDK_MOTION_NOTIFY &&
1115 priv->maybe_reordered &&
1116 (gtk_drag_check_threshold (widget,
1119 (gint) ((GdkEventMotion *)event)->x,
1120 (gint) ((GdkEventMotion *)event)->y)))
1122 priv->maybe_reordered = FALSE;
1123 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1124 event->motion.device);
1128 if (priv->clickable == FALSE)
1130 switch (event->type)
1132 case GDK_BUTTON_PRESS:
1133 case GDK_2BUTTON_PRESS:
1134 case GDK_3BUTTON_PRESS:
1135 case GDK_MOTION_NOTIFY:
1136 case GDK_BUTTON_RELEASE:
1137 case GDK_ENTER_NOTIFY:
1138 case GDK_LEAVE_NOTIFY:
1149 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1151 g_signal_emit_by_name (data, "clicked");
1155 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1156 gboolean group_cycling,
1159 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1160 GtkTreeViewColumnPrivate *priv = column->priv;
1162 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1164 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1166 if (priv->clickable)
1167 gtk_button_clicked (GTK_BUTTON (priv->button));
1168 else if (gtk_widget_get_can_focus (priv->button))
1169 gtk_widget_grab_focus (priv->button);
1171 gtk_widget_grab_focus (priv->tree_view);
1177 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1178 GtkTreeViewColumn *column)
1180 GtkTreeViewColumnPrivate *priv = column->priv;
1181 gint sort_column_id;
1184 if (gtk_tree_sortable_get_sort_column_id (sortable,
1188 if (sort_column_id == priv->sort_column_id)
1190 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1191 gtk_tree_view_column_set_sort_order (column, order);
1195 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1200 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1205 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1208 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1209 GtkTreeModel *model;
1210 GtkTreeSortable *sortable;
1211 gint sort_column_id;
1213 gboolean has_sort_column;
1214 gboolean has_default_sort_func;
1216 g_return_if_fail (priv->tree_view != NULL);
1218 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1219 sortable = GTK_TREE_SORTABLE (model);
1222 gtk_tree_sortable_get_sort_column_id (sortable,
1225 has_default_sort_func =
1226 gtk_tree_sortable_has_default_sort_func (sortable);
1228 if (has_sort_column &&
1229 sort_column_id == priv->sort_column_id)
1231 if (order == GTK_SORT_ASCENDING)
1232 gtk_tree_sortable_set_sort_column_id (sortable,
1233 priv->sort_column_id,
1234 GTK_SORT_DESCENDING);
1235 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1236 gtk_tree_sortable_set_sort_column_id (sortable,
1237 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1238 GTK_SORT_ASCENDING);
1240 gtk_tree_sortable_set_sort_column_id (sortable,
1241 priv->sort_column_id,
1242 GTK_SORT_ASCENDING);
1246 gtk_tree_sortable_set_sort_column_id (sortable,
1247 priv->sort_column_id,
1248 GTK_SORT_ASCENDING);
1253 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1255 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1256 GtkTreeModel *model;
1258 if (priv->tree_view == NULL)
1261 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1266 if (GTK_IS_TREE_SORTABLE (model) &&
1267 priv->sort_column_id != -1)
1269 gint real_sort_column_id;
1270 GtkSortType real_order;
1272 if (priv->sort_column_changed_signal == 0)
1273 priv->sort_column_changed_signal =
1274 g_signal_connect (model, "sort-column-changed",
1275 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1278 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1279 &real_sort_column_id,
1281 (real_sort_column_id == priv->sort_column_id))
1283 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1284 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1288 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1294 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1296 GtkTreeViewColumn *tree_column)
1298 /* Here we want the column re-requested if the underlying context was
1299 * actually reset for any reason, this can happen if the underlying
1300 * area/cell configuration changes (i.e. cell packing properties
1301 * or cell spacing and the like)
1303 * Note that we block this handler while requesting for sizes
1304 * so there is no need to check for the new context size being -1,
1305 * we also block the handler when explicitly resetting the context
1306 * so as to avoid some infinite stack recursion.
1308 if (!strcmp (pspec->name, "minimum-width") ||
1309 !strcmp (pspec->name, "natural-width") ||
1310 !strcmp (pspec->name, "minimum-height") ||
1311 !strcmp (pspec->name, "natural-height"))
1312 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1316 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1317 GtkCellRenderer *renderer,
1318 GtkCellEditable *edit_widget,
1319 GdkRectangle *cell_area,
1320 const gchar *path_string,
1323 GtkTreeViewColumn *column = user_data;
1324 GtkTreeViewColumnPrivate *priv = column->priv;
1327 if (priv->tree_view)
1329 path = gtk_tree_path_new_from_string (path_string);
1331 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1337 gtk_tree_path_free (path);
1342 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1343 GtkCellRenderer *renderer,
1344 GtkCellEditable *edit_widget,
1347 GtkTreeViewColumn *column = user_data;
1348 GtkTreeViewColumnPrivate *priv = column->priv;
1350 if (priv->tree_view)
1351 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1356 /* Exported Private Functions.
1357 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1360 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1362 GtkTreeViewColumnPrivate *priv = column->priv;
1363 GtkAllocation allocation;
1364 GtkTreeView *tree_view;
1366 guint attributes_mask;
1369 tree_view = (GtkTreeView *)priv->tree_view;
1370 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1372 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1373 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1374 g_return_if_fail (priv->button != NULL);
1376 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1377 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1379 attr.window_type = GDK_WINDOW_CHILD;
1380 attr.wclass = GDK_INPUT_ONLY;
1381 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1382 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1383 (GDK_BUTTON_PRESS_MASK |
1384 GDK_BUTTON_RELEASE_MASK |
1385 GDK_POINTER_MOTION_MASK |
1386 GDK_POINTER_MOTION_HINT_MASK |
1387 GDK_KEY_PRESS_MASK);
1388 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1389 attr.cursor = gdk_cursor_new_for_display
1390 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1392 attr.width = TREE_VIEW_DRAG_WIDTH;
1393 attr.height = _gtk_tree_view_get_header_height (tree_view);
1395 gtk_widget_get_allocation (priv->button, &allocation);
1396 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1397 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1398 &attr, attributes_mask);
1399 gdk_window_set_user_data (priv->window, tree_view);
1401 gtk_tree_view_column_update_button (column);
1403 g_object_unref (attr.cursor);
1407 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1409 GtkTreeViewColumnPrivate *priv;
1411 g_return_if_fail (column != NULL);
1413 priv = column->priv;
1414 g_return_if_fail (priv->window != NULL);
1416 gdk_window_set_user_data (priv->window, NULL);
1417 gdk_window_destroy (priv->window);
1418 priv->window = NULL;
1422 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1423 GtkTreeModel *old_model)
1425 GtkTreeViewColumnPrivate *priv = column->priv;
1427 if (priv->sort_column_changed_signal)
1429 g_signal_handler_disconnect (old_model,
1430 priv->sort_column_changed_signal);
1431 priv->sort_column_changed_signal = 0;
1433 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1437 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1438 GtkTreeView *tree_view)
1440 GtkTreeViewColumnPrivate *priv = column->priv;
1442 g_assert (priv->tree_view == NULL);
1444 priv->tree_view = GTK_WIDGET (tree_view);
1445 gtk_tree_view_column_create_button (column);
1447 priv->property_changed_signal =
1448 g_signal_connect_swapped (tree_view,
1450 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1453 gtk_tree_view_column_setup_sort_column_id_callback (column);
1457 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1459 GtkTreeViewColumnPrivate *priv = column->priv;
1461 if (priv->tree_view && priv->button)
1463 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1465 if (priv->property_changed_signal)
1467 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1468 priv->property_changed_signal = 0;
1471 if (priv->sort_column_changed_signal)
1473 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1474 priv->sort_column_changed_signal);
1475 priv->sort_column_changed_signal = 0;
1478 priv->tree_view = NULL;
1479 priv->button = NULL;
1483 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1485 GtkTreeViewColumnPrivate *priv = column->priv;
1486 gboolean ret = FALSE;
1487 GList *list, *cells;
1489 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1491 for (list = cells; list; list = list->next)
1493 GtkCellRenderer *cell = list->data;
1494 GtkCellRendererMode mode;
1496 g_object_get (cell, "mode", &mode, NULL);
1498 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1505 g_list_free (cells);
1510 /* gets cell being edited */
1512 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1514 GtkTreeViewColumnPrivate *priv = column->priv;
1516 return gtk_cell_area_get_edited_cell (priv->cell_area);
1520 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1521 GdkRectangle *cell_area,
1522 GdkRectangle *background_area,
1526 GtkCellRenderer *match = NULL;
1527 GtkTreeViewColumnPrivate *priv = column->priv;
1529 /* If (x, y) is outside of the background area, immediately return */
1530 if (x < background_area->x ||
1531 x > background_area->x + background_area->width ||
1532 y < background_area->y ||
1533 y > background_area->y + background_area->height)
1536 /* If (x, y) is inside the background area, clamp it to the cell_area
1537 * so that a cell is still returned. The main reason for doing this
1538 * (on the x axis) is for handling clicks in the indentation area
1539 * (either at the left or right depending on RTL setting). Another
1540 * reason is for handling clicks on the area where the focus rectangle
1541 * is drawn (this is outside of cell area), this manifests itself
1542 * mainly when a large setting is used for focus-line-width.
1544 if (x < cell_area->x)
1546 else if (x > cell_area->x + cell_area->width)
1547 x = cell_area->x + cell_area->width;
1549 if (y < cell_area->y)
1551 else if (y > cell_area->y + cell_area->height)
1552 y = cell_area->y + cell_area->height;
1554 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1555 priv->cell_area_context,
1565 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1566 GdkRectangle *cell_area,
1567 GdkRectangle *background_area,
1571 GtkCellRenderer *match;
1572 GdkRectangle cell_alloc, aligned_area, inner_area;
1573 GtkTreeViewColumnPrivate *priv = column->priv;
1575 match = _gtk_tree_view_column_get_cell_at_pos (column,
1582 gtk_cell_area_get_cell_allocation (priv->cell_area,
1583 priv->cell_area_context,
1589 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1590 &cell_alloc, &inner_area);
1591 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1592 &inner_area, &aligned_area);
1594 if (x < aligned_area.x ||
1595 x > aligned_area.x + aligned_area.width ||
1596 y < aligned_area.y ||
1597 y > aligned_area.y + aligned_area.height)
1603 /* Public Functions */
1607 * gtk_tree_view_column_new:
1609 * Creates a new #GtkTreeViewColumn.
1611 * Return value: A newly created #GtkTreeViewColumn.
1614 gtk_tree_view_column_new (void)
1616 GtkTreeViewColumn *tree_column;
1618 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1624 * gtk_tree_view_column_new_with_area:
1625 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1627 * Creates a new #GtkTreeViewColumn using @area to render its cells.
1629 * Return value: A newly created #GtkTreeViewColumn.
1634 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1636 GtkTreeViewColumn *tree_column;
1638 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1645 * gtk_tree_view_column_new_with_attributes:
1646 * @title: The title to set the header to.
1647 * @cell: The #GtkCellRenderer.
1648 * @Varargs: A %NULL-terminated list of attributes.
1650 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1651 * equivalent to calling gtk_tree_view_column_set_title(),
1652 * gtk_tree_view_column_pack_start(), and
1653 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1655 * Here's a simple example:
1657 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1660 * GtkTreeViewColumn *column;
1661 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1663 * column = gtk_tree_view_column_new_with_attributes ("Title",
1665 * "text", TEXT_COLUMN,
1666 * "foreground", COLOR_COLUMN,
1671 * Return value: A newly created #GtkTreeViewColumn.
1674 gtk_tree_view_column_new_with_attributes (const gchar *title,
1675 GtkCellRenderer *cell,
1678 GtkTreeViewColumn *retval;
1681 retval = gtk_tree_view_column_new ();
1683 gtk_tree_view_column_set_title (retval, title);
1684 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1686 va_start (args, cell);
1687 gtk_tree_view_column_set_attributesv (retval, cell, args);
1694 * gtk_tree_view_column_pack_start:
1695 * @tree_column: A #GtkTreeViewColumn.
1696 * @cell: The #GtkCellRenderer.
1697 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1699 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1700 * the @cell is allocated no more space than it needs. Any unused space is divided
1701 * evenly between cells for which @expand is %TRUE.
1704 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1705 GtkCellRenderer *cell,
1708 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1712 * gtk_tree_view_column_pack_end:
1713 * @tree_column: A #GtkTreeViewColumn.
1714 * @cell: The #GtkCellRenderer.
1715 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1717 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1718 * is allocated no more space than it needs. Any unused space is divided
1719 * evenly between cells for which @expand is %TRUE.
1722 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1723 GtkCellRenderer *cell,
1726 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1730 * gtk_tree_view_column_clear:
1731 * @tree_column: A #GtkTreeViewColumn
1733 * Unsets all the mappings on all renderers on the @tree_column.
1736 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1738 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1742 * gtk_tree_view_column_add_attribute:
1743 * @tree_column: A #GtkTreeViewColumn.
1744 * @cell_renderer: the #GtkCellRenderer to set attributes on
1745 * @attribute: An attribute on the renderer
1746 * @column: The column position on the model to get the attribute from.
1748 * Adds an attribute mapping to the list in @tree_column. The @column is the
1749 * column of the model to get a value from, and the @attribute is the
1750 * parameter on @cell_renderer to be set from the value. So for example
1751 * if column 2 of the model contains strings, you could have the
1752 * "text" attribute of a #GtkCellRendererText get its values from
1756 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1757 GtkCellRenderer *cell_renderer,
1758 const gchar *attribute,
1761 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1762 cell_renderer, attribute, column);
1766 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1767 GtkCellRenderer *cell_renderer,
1770 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1774 attribute = va_arg (args, gchar *);
1776 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1779 while (attribute != NULL)
1781 column = va_arg (args, gint);
1782 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1783 cell_renderer, attribute, column);
1784 attribute = va_arg (args, gchar *);
1789 * gtk_tree_view_column_set_attributes:
1790 * @tree_column: A #GtkTreeViewColumn.
1791 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1792 * @Varargs: A %NULL-terminated list of attributes.
1794 * Sets the attributes in the list as the attributes of @tree_column.
1795 * The attributes should be in attribute/column order, as in
1796 * gtk_tree_view_column_add_attribute(). All existing attributes
1797 * are removed, and replaced with the new attributes.
1800 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1801 GtkCellRenderer *cell_renderer,
1806 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1807 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1809 va_start (args, cell_renderer);
1810 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1816 * gtk_tree_view_column_set_cell_data_func:
1817 * @tree_column: A #GtkTreeViewColumn
1818 * @cell_renderer: A #GtkCellRenderer
1819 * @func: (allow-none): The #GtkTreeViewColumnFunc to use.
1820 * @func_data: The user data for @func.
1821 * @destroy: The destroy notification for @func_data
1823 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1824 * function is used instead of the standard attributes mapping for
1825 * setting the column value, and should set the value of @tree_column's
1826 * cell renderer as appropriate. @func may be %NULL to remove an
1830 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1831 GtkCellRenderer *cell_renderer,
1832 GtkTreeCellDataFunc func,
1834 GDestroyNotify destroy)
1836 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1838 (GtkCellLayoutDataFunc)func,
1839 func_data, destroy);
1844 * gtk_tree_view_column_clear_attributes:
1845 * @tree_column: a #GtkTreeViewColumn
1846 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1848 * Clears all existing attributes previously set with
1849 * gtk_tree_view_column_set_attributes().
1852 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1853 GtkCellRenderer *cell_renderer)
1855 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1860 * gtk_tree_view_column_set_spacing:
1861 * @tree_column: A #GtkTreeViewColumn.
1862 * @spacing: distance between cell renderers in pixels.
1864 * Sets the spacing field of @tree_column, which is the number of pixels to
1865 * place between cell renderers packed into it.
1868 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1871 GtkTreeViewColumnPrivate *priv;
1873 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1874 g_return_if_fail (spacing >= 0);
1876 priv = tree_column->priv;
1878 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1880 if (priv->tree_view)
1881 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1885 * gtk_tree_view_column_get_spacing:
1886 * @tree_column: A #GtkTreeViewColumn.
1888 * Returns the spacing of @tree_column.
1890 * Return value: the spacing of @tree_column.
1893 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1895 GtkTreeViewColumnPrivate *priv;
1897 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1899 priv = tree_column->priv;
1901 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1904 /* Options for manipulating the columns */
1907 * gtk_tree_view_column_set_visible:
1908 * @tree_column: A #GtkTreeViewColumn.
1909 * @visible: %TRUE if the @tree_column is visible.
1911 * Sets the visibility of @tree_column.
1914 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1917 GtkTreeViewColumnPrivate *priv;
1919 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1921 priv = tree_column->priv;
1922 visible = !! visible;
1924 if (priv->visible == visible)
1927 priv->visible = visible;
1930 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1932 if (priv->tree_view)
1933 _gtk_tree_view_reset_header_styles (GTK_TREE_VIEW (priv->tree_view));
1935 gtk_tree_view_column_update_button (tree_column);
1936 g_object_notify (G_OBJECT (tree_column), "visible");
1940 * gtk_tree_view_column_get_visible:
1941 * @tree_column: A #GtkTreeViewColumn.
1943 * Returns %TRUE if @tree_column is visible.
1945 * Return value: whether the column is visible or not. If it is visible, then
1946 * the tree will show the column.
1949 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1951 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1953 return tree_column->priv->visible;
1957 * gtk_tree_view_column_set_resizable:
1958 * @tree_column: A #GtkTreeViewColumn
1959 * @resizable: %TRUE, if the column can be resized
1961 * If @resizable is %TRUE, then the user can explicitly resize the column by
1962 * grabbing the outer edge of the column button. If resizable is %TRUE and
1963 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1964 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1967 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1970 GtkTreeViewColumnPrivate *priv;
1972 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1974 priv = tree_column->priv;
1975 resizable = !! resizable;
1977 if (priv->resizable == resizable)
1980 priv->resizable = resizable;
1982 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1983 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1985 gtk_tree_view_column_update_button (tree_column);
1987 g_object_notify (G_OBJECT (tree_column), "resizable");
1991 * gtk_tree_view_column_get_resizable:
1992 * @tree_column: A #GtkTreeViewColumn
1994 * Returns %TRUE if the @tree_column can be resized by the end user.
1996 * Return value: %TRUE, if the @tree_column can be resized.
1999 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
2001 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2003 return tree_column->priv->resizable;
2008 * gtk_tree_view_column_set_sizing:
2009 * @tree_column: A #GtkTreeViewColumn.
2010 * @type: The #GtkTreeViewColumnSizing.
2012 * Sets the growth behavior of @tree_column to @type.
2015 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
2016 GtkTreeViewColumnSizing type)
2018 GtkTreeViewColumnPrivate *priv;
2020 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2022 priv = tree_column->priv;
2024 if (type == priv->column_type)
2027 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2028 gtk_tree_view_column_set_resizable (tree_column, FALSE);
2030 priv->column_type = type;
2032 gtk_tree_view_column_update_button (tree_column);
2034 g_object_notify (G_OBJECT (tree_column), "sizing");
2038 * gtk_tree_view_column_get_sizing:
2039 * @tree_column: A #GtkTreeViewColumn.
2041 * Returns the current type of @tree_column.
2043 * Return value: The type of @tree_column.
2045 GtkTreeViewColumnSizing
2046 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
2048 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2050 return tree_column->priv->column_type;
2054 * gtk_tree_view_column_get_width:
2055 * @tree_column: A #GtkTreeViewColumn.
2057 * Returns the current size of @tree_column in pixels.
2059 * Return value: The current width of @tree_column.
2062 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2064 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2066 return tree_column->priv->width;
2070 * gtk_tree_view_column_get_x_offset:
2071 * @tree_column: A #GtkTreeViewColumn.
2073 * Returns the current X offset of @tree_column in pixels.
2075 * Return value: The current X offset of @tree_column.
2080 gtk_tree_view_column_get_x_offset (GtkTreeViewColumn *tree_column)
2082 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2084 return tree_column->priv->x_offset;
2088 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2090 GtkTreeViewColumnPrivate *priv;
2091 gint real_requested_width;
2093 priv = tree_column->priv;
2095 if (priv->use_resized_width)
2097 real_requested_width = priv->resized_width;
2099 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2101 real_requested_width = priv->fixed_width;
2103 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2105 gint button_request;
2106 gint requested_width;
2108 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2109 requested_width += priv->padding;
2111 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2112 real_requested_width = MAX (requested_width, button_request);
2116 gint requested_width;
2118 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2119 requested_width += priv->padding;
2121 real_requested_width = requested_width;
2122 if (real_requested_width < 0)
2123 real_requested_width = 0;
2126 if (priv->min_width != -1)
2127 real_requested_width = MAX (real_requested_width, priv->min_width);
2129 if (priv->max_width != -1)
2130 real_requested_width = MIN (real_requested_width, priv->max_width);
2132 return real_requested_width;
2136 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2140 GtkTreeViewColumnPrivate *priv;
2141 GtkAllocation allocation;
2144 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2146 priv = tree_column->priv;
2148 if (priv->width != width)
2149 gtk_widget_queue_draw (priv->tree_view);
2151 priv->x_offset = x_offset;
2152 priv->width = width;
2154 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2156 if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2158 allocation.x = x_offset;
2160 allocation.width = width;
2161 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2163 gtk_widget_size_allocate (priv->button, &allocation);
2168 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2169 gdk_window_move_resize (priv->window,
2170 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2172 TREE_VIEW_DRAG_WIDTH, allocation.height);
2175 g_object_notify (G_OBJECT (tree_column), "x-offset");
2176 g_object_notify (G_OBJECT (tree_column), "width");
2180 * gtk_tree_view_column_set_fixed_width:
2181 * @tree_column: A #GtkTreeViewColumn.
2182 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2184 * Sets the size of the column in pixels. This is meaningful only if the sizing
2185 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2186 * the min/max width for the column. Please note that the min/max width of the
2187 * column doesn't actually affect the "fixed_width" property of the widget, just
2188 * the actual size when displayed.
2191 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2194 GtkTreeViewColumnPrivate *priv;
2196 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2197 g_return_if_fail (fixed_width > 0);
2199 priv = tree_column->priv;
2201 priv->fixed_width = fixed_width;
2202 priv->use_resized_width = FALSE;
2204 if (priv->tree_view &&
2205 gtk_widget_get_realized (priv->tree_view) &&
2206 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2208 gtk_widget_queue_resize (priv->tree_view);
2211 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2215 * gtk_tree_view_column_get_fixed_width:
2216 * @tree_column: a #GtkTreeViewColumn
2218 * Gets the fixed width of the column. This value is only meaning may not be
2219 * the actual width of the column on the screen, just what is requested.
2221 * Return value: the fixed width of the column
2224 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2226 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2228 return tree_column->priv->fixed_width;
2232 * gtk_tree_view_column_set_min_width:
2233 * @tree_column: A #GtkTreeViewColumn.
2234 * @min_width: The minimum width of the column in pixels, or -1.
2236 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2237 * minimum width is unset.
2240 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2243 GtkTreeViewColumnPrivate *priv;
2245 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2246 g_return_if_fail (min_width >= -1);
2248 priv = tree_column->priv;
2250 if (min_width == priv->min_width)
2253 if (priv->visible &&
2254 priv->tree_view != NULL &&
2255 gtk_widget_get_realized (priv->tree_view))
2257 if (min_width > priv->width)
2258 gtk_widget_queue_resize (priv->tree_view);
2261 priv->min_width = min_width;
2262 g_object_freeze_notify (G_OBJECT (tree_column));
2263 if (priv->max_width != -1 && priv->max_width < min_width)
2265 priv->max_width = min_width;
2266 g_object_notify (G_OBJECT (tree_column), "max-width");
2268 g_object_notify (G_OBJECT (tree_column), "min-width");
2269 g_object_thaw_notify (G_OBJECT (tree_column));
2271 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2272 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2277 * gtk_tree_view_column_get_min_width:
2278 * @tree_column: A #GtkTreeViewColumn.
2280 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2283 * Return value: The minimum width of the @tree_column.
2286 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2288 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2290 return tree_column->priv->min_width;
2294 * gtk_tree_view_column_set_max_width:
2295 * @tree_column: A #GtkTreeViewColumn.
2296 * @max_width: The maximum width of the column in pixels, or -1.
2298 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2299 * maximum width is unset. Note, the column can actually be wider than max
2300 * width if it's the last column in a view. In this case, the column expands to
2301 * fill any extra space.
2304 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2307 GtkTreeViewColumnPrivate *priv;
2309 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2310 g_return_if_fail (max_width >= -1);
2312 priv = tree_column->priv;
2314 if (max_width == priv->max_width)
2317 if (priv->visible &&
2318 priv->tree_view != NULL &&
2319 gtk_widget_get_realized (priv->tree_view))
2321 if (max_width != -1 && max_width < priv->width)
2322 gtk_widget_queue_resize (priv->tree_view);
2325 priv->max_width = max_width;
2326 g_object_freeze_notify (G_OBJECT (tree_column));
2327 if (max_width != -1 && max_width < priv->min_width)
2329 priv->min_width = max_width;
2330 g_object_notify (G_OBJECT (tree_column), "min-width");
2332 g_object_notify (G_OBJECT (tree_column), "max-width");
2333 g_object_thaw_notify (G_OBJECT (tree_column));
2335 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2336 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2341 * gtk_tree_view_column_get_max_width:
2342 * @tree_column: A #GtkTreeViewColumn.
2344 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2347 * Return value: The maximum width of the @tree_column.
2350 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2352 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2354 return tree_column->priv->max_width;
2358 * gtk_tree_view_column_clicked:
2359 * @tree_column: a #GtkTreeViewColumn
2361 * Emits the "clicked" signal on the column. This function will only work if
2362 * @tree_column is clickable.
2365 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2367 GtkTreeViewColumnPrivate *priv;
2369 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2371 priv = tree_column->priv;
2373 if (priv->visible &&
2376 gtk_button_clicked (GTK_BUTTON (priv->button));
2380 * gtk_tree_view_column_set_title:
2381 * @tree_column: A #GtkTreeViewColumn.
2382 * @title: The title of the @tree_column.
2384 * Sets the title of the @tree_column. If a custom widget has been set, then
2385 * this value is ignored.
2388 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2391 GtkTreeViewColumnPrivate *priv;
2394 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2396 priv = tree_column->priv;
2398 new_title = g_strdup (title);
2399 g_free (priv->title);
2400 priv->title = new_title;
2402 gtk_tree_view_column_update_button (tree_column);
2403 g_object_notify (G_OBJECT (tree_column), "title");
2407 * gtk_tree_view_column_get_title:
2408 * @tree_column: A #GtkTreeViewColumn.
2410 * Returns the title of the widget.
2412 * Return value: the title of the column. This string should not be
2413 * modified or freed.
2415 G_CONST_RETURN gchar *
2416 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2418 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2420 return tree_column->priv->title;
2424 * gtk_tree_view_column_set_expand:
2425 * @tree_column: A #GtkTreeViewColumn
2426 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2428 * Sets the column to take available extra space. This space is shared equally
2429 * amongst all columns that have the expand set to %TRUE. If no column has this
2430 * option set, then the last column gets all extra space. By default, every
2431 * column is created with this %FALSE.
2436 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2439 GtkTreeViewColumnPrivate *priv;
2441 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2443 priv = tree_column->priv;
2445 expand = expand?TRUE:FALSE;
2446 if (priv->expand == expand)
2448 priv->expand = expand;
2450 if (priv->visible &&
2451 priv->tree_view != NULL &&
2452 gtk_widget_get_realized (priv->tree_view))
2454 /* We want to continue using the original width of the
2455 * column that includes additional space added by the user
2456 * resizing the columns and possibly extra (expanded) space, which
2457 * are not included in the resized width.
2459 priv->use_resized_width = FALSE;
2461 gtk_widget_queue_resize (priv->tree_view);
2464 g_object_notify (G_OBJECT (tree_column), "expand");
2468 * gtk_tree_view_column_get_expand:
2469 * @tree_column: a #GtkTreeViewColumn
2471 * Return %TRUE if the column expands to take any available space.
2473 * Return value: %TRUE, if the column expands
2478 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2480 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2482 return tree_column->priv->expand;
2486 * gtk_tree_view_column_set_clickable:
2487 * @tree_column: A #GtkTreeViewColumn.
2488 * @clickable: %TRUE if the header is active.
2490 * Sets the header to be active if @active is %TRUE. When the header is active,
2491 * then it can take keyboard focus, and can be clicked.
2494 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2497 GtkTreeViewColumnPrivate *priv;
2499 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2501 priv = tree_column->priv;
2503 clickable = !! clickable;
2504 if (priv->clickable == clickable)
2507 priv->clickable = clickable;
2508 gtk_tree_view_column_update_button (tree_column);
2509 g_object_notify (G_OBJECT (tree_column), "clickable");
2513 * gtk_tree_view_column_get_clickable:
2514 * @tree_column: a #GtkTreeViewColumn
2516 * Returns %TRUE if the user can click on the header for the column.
2518 * Return value: %TRUE if user can click the column header.
2521 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2523 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2525 return tree_column->priv->clickable;
2529 * gtk_tree_view_column_set_widget:
2530 * @tree_column: A #GtkTreeViewColumn.
2531 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2533 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2534 * header button is set with a #GtkLabel set to the title of @tree_column.
2537 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2540 GtkTreeViewColumnPrivate *priv;
2542 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2543 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2545 priv = tree_column->priv;
2548 g_object_ref_sink (widget);
2551 g_object_unref (priv->child);
2553 priv->child = widget;
2554 gtk_tree_view_column_update_button (tree_column);
2555 g_object_notify (G_OBJECT (tree_column), "widget");
2559 * gtk_tree_view_column_get_widget:
2560 * @tree_column: A #GtkTreeViewColumn.
2562 * Returns the #GtkWidget in the button on the column header.
2563 * If a custom widget has not been set then %NULL is returned.
2565 * Return value: (transfer none): The #GtkWidget in the column
2569 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2571 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2573 return tree_column->priv->child;
2577 * gtk_tree_view_column_set_alignment:
2578 * @tree_column: A #GtkTreeViewColumn.
2579 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2581 * Sets the alignment of the title or custom widget inside the column header.
2582 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2583 * for center, 1.0 for right.
2586 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2589 GtkTreeViewColumnPrivate *priv;
2591 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2593 priv = tree_column->priv;
2595 xalign = CLAMP (xalign, 0.0, 1.0);
2597 if (priv->xalign == xalign)
2600 priv->xalign = xalign;
2601 gtk_tree_view_column_update_button (tree_column);
2602 g_object_notify (G_OBJECT (tree_column), "alignment");
2606 * gtk_tree_view_column_get_alignment:
2607 * @tree_column: A #GtkTreeViewColumn.
2609 * Returns the current x alignment of @tree_column. This value can range
2610 * between 0.0 and 1.0.
2612 * Return value: The current alignent of @tree_column.
2615 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2617 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2619 return tree_column->priv->xalign;
2623 * gtk_tree_view_column_set_reorderable:
2624 * @tree_column: A #GtkTreeViewColumn
2625 * @reorderable: %TRUE, if the column can be reordered.
2627 * If @reorderable is %TRUE, then the column can be reordered by the end user
2628 * dragging the header.
2631 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2632 gboolean reorderable)
2634 GtkTreeViewColumnPrivate *priv;
2636 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2638 priv = tree_column->priv;
2641 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2643 if (priv->reorderable == (reorderable?TRUE:FALSE))
2646 priv->reorderable = (reorderable?TRUE:FALSE);
2647 gtk_tree_view_column_update_button (tree_column);
2648 g_object_notify (G_OBJECT (tree_column), "reorderable");
2652 * gtk_tree_view_column_get_reorderable:
2653 * @tree_column: A #GtkTreeViewColumn
2655 * Returns %TRUE if the @tree_column can be reordered by the user.
2657 * Return value: %TRUE if the @tree_column can be reordered by the user.
2660 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2662 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2664 return tree_column->priv->reorderable;
2669 * gtk_tree_view_column_set_sort_column_id:
2670 * @tree_column: a #GtkTreeViewColumn
2671 * @sort_column_id: The @sort_column_id of the model to sort on.
2673 * Sets the logical @sort_column_id that this column sorts on when this column
2674 * is selected for sorting. Doing so makes the column header clickable.
2677 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2678 gint sort_column_id)
2680 GtkTreeViewColumnPrivate *priv;
2682 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2683 g_return_if_fail (sort_column_id >= -1);
2685 priv = tree_column->priv;
2687 if (priv->sort_column_id == sort_column_id)
2690 priv->sort_column_id = sort_column_id;
2692 /* Handle unsetting the id */
2693 if (sort_column_id == -1)
2695 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2697 if (priv->sort_clicked_signal)
2699 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2700 priv->sort_clicked_signal = 0;
2703 if (priv->sort_column_changed_signal)
2705 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2706 priv->sort_column_changed_signal = 0;
2709 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2710 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2711 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2712 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2716 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2718 if (! priv->sort_clicked_signal)
2719 priv->sort_clicked_signal = g_signal_connect (tree_column,
2721 G_CALLBACK (gtk_tree_view_column_sort),
2724 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2725 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2729 * gtk_tree_view_column_get_sort_column_id:
2730 * @tree_column: a #GtkTreeViewColumn
2732 * Gets the logical @sort_column_id that the model sorts on when this
2733 * column is selected for sorting.
2734 * See gtk_tree_view_column_set_sort_column_id().
2736 * Return value: the current @sort_column_id for this column, or -1 if
2737 * this column can't be used for sorting.
2740 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2742 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2744 return tree_column->priv->sort_column_id;
2748 * gtk_tree_view_column_set_sort_indicator:
2749 * @tree_column: a #GtkTreeViewColumn
2750 * @setting: %TRUE to display an indicator that the column is sorted
2752 * Call this function with a @setting of %TRUE to display an arrow in
2753 * the header button indicating the column is sorted. Call
2754 * gtk_tree_view_column_set_sort_order() to change the direction of
2759 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2762 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2764 setting = setting != FALSE;
2766 if (setting == tree_column->priv->show_sort_indicator)
2769 tree_column->priv->show_sort_indicator = setting;
2770 gtk_tree_view_column_update_button (tree_column);
2771 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2775 * gtk_tree_view_column_get_sort_indicator:
2776 * @tree_column: a #GtkTreeViewColumn
2778 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2780 * Return value: whether the sort indicator arrow is displayed
2783 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2785 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2787 return tree_column->priv->show_sort_indicator;
2791 * gtk_tree_view_column_set_sort_order:
2792 * @tree_column: a #GtkTreeViewColumn
2793 * @order: sort order that the sort indicator should indicate
2795 * Changes the appearance of the sort indicator.
2797 * This <emphasis>does not</emphasis> actually sort the model. Use
2798 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2799 * support. This function is primarily for custom sorting behavior, and should
2800 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2801 * that. For custom models, the mechanism will vary.
2803 * The sort indicator changes direction to indicate normal sort or reverse sort.
2804 * Note that you must have the sort indicator enabled to see anything when
2805 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2808 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2811 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2813 if (order == tree_column->priv->sort_order)
2816 tree_column->priv->sort_order = order;
2817 gtk_tree_view_column_update_button (tree_column);
2818 g_object_notify (G_OBJECT (tree_column), "sort-order");
2822 * gtk_tree_view_column_get_sort_order:
2823 * @tree_column: a #GtkTreeViewColumn
2825 * Gets the value set by gtk_tree_view_column_set_sort_order().
2827 * Return value: the sort order the sort indicator is indicating
2830 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2832 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2834 return tree_column->priv->sort_order;
2838 * gtk_tree_view_column_cell_set_cell_data:
2839 * @tree_column: A #GtkTreeViewColumn.
2840 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2841 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2842 * @is_expander: %TRUE, if the row has children
2843 * @is_expanded: %TRUE, if the row has visible children
2845 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2846 * every attribute mapping in @tree_column, it will get a value from the set
2847 * column on the @iter, and use that value to set the attribute on the cell
2848 * renderer. This is used primarily by the #GtkTreeView.
2851 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2852 GtkTreeModel *tree_model,
2854 gboolean is_expander,
2855 gboolean is_expanded)
2857 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2859 if (tree_model == NULL)
2862 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2863 is_expander, is_expanded);
2867 * gtk_tree_view_column_cell_get_size:
2868 * @tree_column: A #GtkTreeViewColumn.
2869 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2870 * @x_offset: (out) (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2871 * @y_offset: (out) (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2872 * @width: (out) (allow-none): location to return width needed to render a cell, or %NULL
2873 * @height: (out) (allow-none): location to return height needed to render a cell, or %NULL
2875 * Obtains the width and height needed to render the column. This is used
2876 * primarily by the #GtkTreeView.
2879 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2880 const GdkRectangle *cell_area,
2886 GtkTreeViewColumnPrivate *priv;
2887 gint min_width = 0, min_height = 0;
2889 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2891 priv = tree_column->priv;
2893 g_signal_handler_block (priv->cell_area_context,
2894 priv->context_changed_signal);
2896 gtk_cell_area_get_preferred_width (priv->cell_area,
2897 priv->cell_area_context,
2901 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2903 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2904 priv->cell_area_context,
2910 g_signal_handler_unblock (priv->cell_area_context,
2911 priv->context_changed_signal);
2915 * height = min_height;
2917 * width = min_width;
2922 * gtk_tree_view_column_cell_render:
2923 * @tree_column: A #GtkTreeViewColumn.
2924 * @cr: cairo context to draw to
2925 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2926 * @cell_area: area normally rendered by a cell renderer
2927 * @flags: flags that affect rendering
2929 * Renders the cell contained by #tree_column. This is used primarily by the
2933 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2935 const GdkRectangle *background_area,
2936 const GdkRectangle *cell_area,
2938 gboolean draw_focus)
2940 GtkTreeViewColumnPrivate *priv;
2942 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2943 g_return_if_fail (cr != NULL);
2944 g_return_if_fail (background_area != NULL);
2945 g_return_if_fail (cell_area != NULL);
2947 priv = tree_column->priv;
2951 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2952 priv->tree_view, cr,
2953 background_area, cell_area, flags,
2960 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2962 const GdkRectangle *cell_area,
2965 GtkTreeViewColumnPrivate *priv;
2967 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2969 priv = tree_column->priv;
2971 return gtk_cell_area_event (priv->cell_area,
2972 priv->cell_area_context,
2980 * gtk_tree_view_column_cell_is_visible:
2981 * @tree_column: A #GtkTreeViewColumn
2983 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2984 * For this to be meaningful, you must first initialize the cells with
2985 * gtk_tree_view_column_cell_set_cell_data()
2987 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2990 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2994 GtkTreeViewColumnPrivate *priv;
2996 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2998 priv = tree_column->priv;
3000 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
3001 for (list = cells; list; list = list->next)
3003 if (gtk_cell_renderer_get_visible (list->data))
3005 g_list_free (cells);
3010 g_list_free (cells);
3016 * gtk_tree_view_column_focus_cell:
3017 * @tree_column: A #GtkTreeViewColumn
3018 * @cell: A #GtkCellRenderer
3020 * Sets the current keyboard focus to be at @cell, if the column contains
3021 * 2 or more editable and activatable cells.
3026 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
3027 GtkCellRenderer *cell)
3029 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3030 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
3032 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
3036 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
3037 gboolean install_handler)
3039 GtkTreeViewColumnPrivate *priv = tree_column->priv;
3045 /* Issue a manual reset on the context to have all
3046 * sizes re-requested for the context.
3048 g_signal_handler_block (priv->cell_area_context,
3049 priv->context_changed_signal);
3050 gtk_cell_area_context_reset (priv->cell_area_context);
3051 g_signal_handler_unblock (priv->cell_area_context,
3052 priv->context_changed_signal);
3054 if (priv->tree_view &&
3055 gtk_widget_get_realized (priv->tree_view))
3057 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
3058 gtk_widget_queue_resize (priv->tree_view);
3063 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
3065 return tree_column->priv->dirty;
3069 * gtk_tree_view_column_cell_get_position:
3070 * @tree_column: a #GtkTreeViewColumn
3071 * @cell_renderer: a #GtkCellRenderer
3072 * @x_offset: (out) (allow-none): return location for the horizontal
3073 * position of @cell within @tree_column, may be %NULL
3074 * @width: (out) (allow-none): return location for the width of @cell,
3077 * Obtains the horizontal position and size of a cell in a column. If the
3078 * cell is not found in the column, @start_pos and @width are not changed and
3079 * %FALSE is returned.
3081 * Return value: %TRUE if @cell belongs to @tree_column.
3084 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3085 GtkCellRenderer *cell_renderer,
3089 GtkTreeViewColumnPrivate *priv;
3090 GdkRectangle cell_area;
3091 GdkRectangle allocation;
3093 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3094 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3096 priv = tree_column->priv;
3098 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3099 NULL, tree_column, &cell_area);
3101 gtk_cell_area_get_cell_allocation (priv->cell_area,
3102 priv->cell_area_context,
3110 GdkRectangle button_allocation;
3112 /* Retrieve column offset */
3113 gtk_widget_get_allocation (priv->button, &button_allocation);
3114 *x_offset = allocation.x - button_allocation.x;
3117 *width = allocation.width;
3123 * gtk_tree_view_column_queue_resize:
3124 * @tree_column: A #GtkTreeViewColumn
3126 * Flags the column, and the cell renderers added to this column, to have
3127 * their sizes renegotiated.
3132 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3134 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3136 if (tree_column->priv->tree_view)
3137 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3141 * gtk_tree_view_column_get_tree_view:
3142 * @tree_column: A #GtkTreeViewColumn
3144 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3145 * If @column is currently not inserted in any tree view, %NULL is
3148 * Return value: (transfer none): The tree view wherein @column has
3149 * been inserted if any, %NULL otherwise.
3154 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3156 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3158 return tree_column->priv->tree_view;
3162 * gtk_tree_view_column_get_button:
3163 * @tree_column: A #GtkTreeViewColumn
3165 * Returns the button used in the treeview column header
3167 * Return value: (transfer none): The button for the column header.
3172 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3174 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3176 return tree_column->priv->button;
3180 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3182 return column->priv->window;
3186 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3189 column->priv->padding = MAX (column->priv->padding, padding);
3193 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3195 gint requested_width;
3197 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3199 return requested_width + column->priv->padding;
3204 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3207 column->priv->resized_width = width;
3211 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3213 return column->priv->resized_width;
3217 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3218 gboolean use_resized_width)
3220 column->priv->use_resized_width = use_resized_width;
3224 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3226 return column->priv->use_resized_width;
3230 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3232 return column->priv->drag_x;
3235 GtkCellAreaContext *
3236 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3238 return column->priv->cell_area_context;