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 GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
81 /* Button handling code */
82 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
83 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
85 /* Button signal handlers */
86 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
89 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
91 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
92 gboolean group_cycling,
95 /* Property handlers */
96 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
97 GtkTreeViewColumn *tree_column);
99 /* GtkCellArea/GtkCellAreaContext callbacks */
100 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
102 GtkTreeViewColumn *tree_column);
103 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
104 GtkCellRenderer *renderer,
105 GtkCellEditable *edit_widget,
106 GdkRectangle *cell_area,
107 const gchar *path_string,
109 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
110 GtkCellRenderer *renderer,
111 GtkCellEditable *edit_widget,
114 /* Internal functions */
115 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
117 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
118 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
119 GtkCellRenderer *cell_renderer,
122 /* GtkBuildable implementation */
123 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
126 struct _GtkTreeViewColumnPrivate
128 GtkWidget *tree_view;
132 GtkWidget *alignment;
135 gulong property_changed_signal;
138 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
139 GtkTreeViewColumnSizing column_type;
147 /* dragging columns */
154 gulong sort_clicked_signal;
155 gulong sort_column_changed_signal;
157 GtkSortType sort_order;
160 GtkCellArea *cell_area;
161 GtkCellAreaContext *cell_area_context;
162 gulong add_editable_signal;
163 gulong remove_editable_signal;
164 gulong context_changed_signal;
171 guint show_sort_indicator : 1;
172 guint maybe_reordered : 1;
173 guint reorderable : 1;
174 guint use_resized_width : 1;
207 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
209 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
210 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
211 gtk_tree_view_column_cell_layout_init)
212 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
213 gtk_tree_view_column_buildable_init))
217 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
219 GObjectClass *object_class;
221 object_class = (GObjectClass*) class;
223 class->clicked = NULL;
225 object_class->constructor = gtk_tree_view_column_constructor;
226 object_class->finalize = gtk_tree_view_column_finalize;
227 object_class->dispose = gtk_tree_view_column_dispose;
228 object_class->set_property = gtk_tree_view_column_set_property;
229 object_class->get_property = gtk_tree_view_column_get_property;
231 tree_column_signals[CLICKED] =
232 g_signal_new (I_("clicked"),
233 G_OBJECT_CLASS_TYPE (object_class),
235 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
237 _gtk_marshal_VOID__VOID,
240 g_object_class_install_property (object_class,
242 g_param_spec_boolean ("visible",
244 P_("Whether to display the column"),
246 GTK_PARAM_READWRITE));
248 g_object_class_install_property (object_class,
250 g_param_spec_boolean ("resizable",
252 P_("Column is user-resizable"),
254 GTK_PARAM_READWRITE));
256 g_object_class_install_property (object_class,
258 g_param_spec_int ("width",
260 P_("Current width of the column"),
264 GTK_PARAM_READABLE));
265 g_object_class_install_property (object_class,
267 g_param_spec_int ("spacing",
269 P_("Space which is inserted between cells"),
273 GTK_PARAM_READWRITE));
274 g_object_class_install_property (object_class,
276 g_param_spec_enum ("sizing",
278 P_("Resize mode of the column"),
279 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
280 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
281 GTK_PARAM_READWRITE));
283 g_object_class_install_property (object_class,
285 g_param_spec_int ("fixed-width",
287 P_("Current fixed width of the column"),
291 GTK_PARAM_READWRITE));
293 g_object_class_install_property (object_class,
295 g_param_spec_int ("min-width",
297 P_("Minimum allowed width of the column"),
301 GTK_PARAM_READWRITE));
303 g_object_class_install_property (object_class,
305 g_param_spec_int ("max-width",
307 P_("Maximum allowed width of the column"),
311 GTK_PARAM_READWRITE));
313 g_object_class_install_property (object_class,
315 g_param_spec_string ("title",
317 P_("Title to appear in column header"),
319 GTK_PARAM_READWRITE));
321 g_object_class_install_property (object_class,
323 g_param_spec_boolean ("expand",
325 P_("Column gets share of extra width allocated to the widget"),
327 GTK_PARAM_READWRITE));
329 g_object_class_install_property (object_class,
331 g_param_spec_boolean ("clickable",
333 P_("Whether the header can be clicked"),
335 GTK_PARAM_READWRITE));
338 g_object_class_install_property (object_class,
340 g_param_spec_object ("widget",
342 P_("Widget to put in column header button instead of column title"),
344 GTK_PARAM_READWRITE));
346 g_object_class_install_property (object_class,
348 g_param_spec_float ("alignment",
350 P_("X Alignment of the column header text or widget"),
354 GTK_PARAM_READWRITE));
356 g_object_class_install_property (object_class,
358 g_param_spec_boolean ("reorderable",
360 P_("Whether the column can be reordered around the headers"),
362 GTK_PARAM_READWRITE));
364 g_object_class_install_property (object_class,
366 g_param_spec_boolean ("sort-indicator",
367 P_("Sort indicator"),
368 P_("Whether to show a sort indicator"),
370 GTK_PARAM_READWRITE));
372 g_object_class_install_property (object_class,
374 g_param_spec_enum ("sort-order",
376 P_("Sort direction the sort indicator should indicate"),
379 GTK_PARAM_READWRITE));
382 * GtkTreeViewColumn:sort-column-id:
384 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
385 * clickable. Set to %-1 to make the column unsortable.
389 g_object_class_install_property (object_class,
391 g_param_spec_int ("sort-column-id",
392 P_("Sort column ID"),
393 P_("Logical sort column ID this column sorts on when selected for sorting"),
397 GTK_PARAM_READWRITE));
400 * GtkTreeViewColumn:cell-area:
402 * The #GtkCellArea used to layout cell renderers for this column.
406 g_object_class_install_property (object_class,
408 g_param_spec_object ("cell-area",
410 P_("The GtkCellArea used to layout cells"),
412 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
414 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
418 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
421 const gchar *tagname,
424 /* Just ignore the boolean return from here */
425 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
429 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
431 iface->add_child = _gtk_cell_layout_buildable_add_child;
432 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
433 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
437 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
439 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
443 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
445 GtkTreeViewColumnPrivate *priv;
447 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
448 GTK_TYPE_TREE_VIEW_COLUMN,
449 GtkTreeViewColumnPrivate);
450 priv = tree_column->priv;
456 priv->min_width = -1;
457 priv->max_width = -1;
458 priv->resized_width = 0;
459 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
460 priv->visible = TRUE;
461 priv->resizable = FALSE;
462 priv->expand = FALSE;
463 priv->clickable = FALSE;
465 priv->sort_order = GTK_SORT_ASCENDING;
466 priv->show_sort_indicator = FALSE;
467 priv->property_changed_signal = 0;
468 priv->sort_clicked_signal = 0;
469 priv->sort_column_changed_signal = 0;
470 priv->sort_column_id = -1;
471 priv->reorderable = FALSE;
472 priv->maybe_reordered = FALSE;
473 priv->fixed_width = 1;
474 priv->use_resized_width = FALSE;
475 priv->title = g_strdup ("");
479 gtk_tree_view_column_constructor (GType type,
480 guint n_construct_properties,
481 GObjectConstructParam *construct_properties)
483 GtkTreeViewColumn *tree_column;
484 GtkTreeViewColumnPrivate *priv;
487 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
488 (type, n_construct_properties, construct_properties);
490 tree_column = (GtkTreeViewColumn *) object;
491 priv = tree_column->priv;
493 if (!priv->cell_area)
495 priv->cell_area = gtk_cell_area_box_new ();
496 g_object_ref_sink (priv->cell_area);
499 gtk_cell_area_set_style_detail (priv->cell_area, "treeview");
501 priv->add_editable_signal =
502 g_signal_connect (priv->cell_area, "add-editable",
503 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
505 priv->remove_editable_signal =
506 g_signal_connect (priv->cell_area, "remove-editable",
507 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
510 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
512 priv->context_changed_signal =
513 g_signal_connect (priv->cell_area_context, "notify",
514 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
520 gtk_tree_view_column_dispose (GObject *object)
522 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
523 GtkTreeViewColumnPrivate *priv = tree_column->priv;
525 if (priv->cell_area_context)
527 g_signal_handler_disconnect (priv->cell_area_context,
528 priv->context_changed_signal);
530 g_object_unref (priv->cell_area_context);
532 priv->cell_area_context = NULL;
533 priv->context_changed_signal = 0;
538 g_signal_handler_disconnect (priv->cell_area,
539 priv->add_editable_signal);
540 g_signal_handler_disconnect (priv->cell_area,
541 priv->remove_editable_signal);
543 g_object_unref (priv->cell_area);
544 priv->cell_area = NULL;
545 priv->add_editable_signal = 0;
546 priv->remove_editable_signal = 0;
551 g_object_unref (priv->child);
555 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
559 gtk_tree_view_column_finalize (GObject *object)
561 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
562 GtkTreeViewColumnPrivate *priv = tree_column->priv;
564 g_free (priv->title);
566 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
570 gtk_tree_view_column_set_property (GObject *object,
575 GtkTreeViewColumn *tree_column;
578 tree_column = GTK_TREE_VIEW_COLUMN (object);
583 gtk_tree_view_column_set_visible (tree_column,
584 g_value_get_boolean (value));
588 gtk_tree_view_column_set_resizable (tree_column,
589 g_value_get_boolean (value));
593 gtk_tree_view_column_set_sizing (tree_column,
594 g_value_get_enum (value));
597 case PROP_FIXED_WIDTH:
598 gtk_tree_view_column_set_fixed_width (tree_column,
599 g_value_get_int (value));
603 gtk_tree_view_column_set_min_width (tree_column,
604 g_value_get_int (value));
608 gtk_tree_view_column_set_max_width (tree_column,
609 g_value_get_int (value));
613 gtk_tree_view_column_set_spacing (tree_column,
614 g_value_get_int (value));
618 gtk_tree_view_column_set_title (tree_column,
619 g_value_get_string (value));
623 gtk_tree_view_column_set_expand (tree_column,
624 g_value_get_boolean (value));
628 gtk_tree_view_column_set_clickable (tree_column,
629 g_value_get_boolean (value));
633 gtk_tree_view_column_set_widget (tree_column,
634 (GtkWidget*) g_value_get_object (value));
638 gtk_tree_view_column_set_alignment (tree_column,
639 g_value_get_float (value));
642 case PROP_REORDERABLE:
643 gtk_tree_view_column_set_reorderable (tree_column,
644 g_value_get_boolean (value));
647 case PROP_SORT_INDICATOR:
648 gtk_tree_view_column_set_sort_indicator (tree_column,
649 g_value_get_boolean (value));
652 case PROP_SORT_ORDER:
653 gtk_tree_view_column_set_sort_order (tree_column,
654 g_value_get_enum (value));
657 case PROP_SORT_COLUMN_ID:
658 gtk_tree_view_column_set_sort_column_id (tree_column,
659 g_value_get_int (value));
663 /* Construct-only, can only be assigned once */
664 area = g_value_get_object (value);
667 tree_column->priv->cell_area = g_object_ref_sink (area);
671 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
677 gtk_tree_view_column_get_property (GObject *object,
682 GtkTreeViewColumn *tree_column;
684 tree_column = GTK_TREE_VIEW_COLUMN (object);
689 g_value_set_boolean (value,
690 gtk_tree_view_column_get_visible (tree_column));
694 g_value_set_boolean (value,
695 gtk_tree_view_column_get_resizable (tree_column));
699 g_value_set_int (value,
700 gtk_tree_view_column_get_width (tree_column));
704 g_value_set_int (value,
705 gtk_tree_view_column_get_spacing (tree_column));
709 g_value_set_enum (value,
710 gtk_tree_view_column_get_sizing (tree_column));
713 case PROP_FIXED_WIDTH:
714 g_value_set_int (value,
715 gtk_tree_view_column_get_fixed_width (tree_column));
719 g_value_set_int (value,
720 gtk_tree_view_column_get_min_width (tree_column));
724 g_value_set_int (value,
725 gtk_tree_view_column_get_max_width (tree_column));
729 g_value_set_string (value,
730 gtk_tree_view_column_get_title (tree_column));
734 g_value_set_boolean (value,
735 gtk_tree_view_column_get_expand (tree_column));
739 g_value_set_boolean (value,
740 gtk_tree_view_column_get_clickable (tree_column));
744 g_value_set_object (value,
745 (GObject*) gtk_tree_view_column_get_widget (tree_column));
749 g_value_set_float (value,
750 gtk_tree_view_column_get_alignment (tree_column));
753 case PROP_REORDERABLE:
754 g_value_set_boolean (value,
755 gtk_tree_view_column_get_reorderable (tree_column));
758 case PROP_SORT_INDICATOR:
759 g_value_set_boolean (value,
760 gtk_tree_view_column_get_sort_indicator (tree_column));
763 case PROP_SORT_ORDER:
764 g_value_set_enum (value,
765 gtk_tree_view_column_get_sort_order (tree_column));
768 case PROP_SORT_COLUMN_ID:
769 g_value_set_int (value,
770 gtk_tree_view_column_get_sort_column_id (tree_column));
774 g_value_set_object (value, tree_column->priv->cell_area);
778 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
783 /* Implementation of GtkCellLayout interface
786 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
788 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
789 GtkTreeViewColumnPrivate *priv = column->priv;
791 return priv->cell_area;
794 /* Button handling code
797 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
799 GtkTreeViewColumnPrivate *priv = tree_column->priv;
800 GtkTreeView *tree_view;
804 tree_view = (GtkTreeView *) priv->tree_view;
806 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
807 g_return_if_fail (priv->button == NULL);
809 gtk_widget_push_composite_child ();
810 priv->button = gtk_button_new ();
811 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
812 gtk_widget_pop_composite_child ();
814 /* make sure we own a reference to it as well. */
815 if (_gtk_tree_view_get_header_window (tree_view))
816 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
818 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
820 g_signal_connect (priv->button, "event",
821 G_CALLBACK (gtk_tree_view_column_button_event),
823 g_signal_connect (priv->button, "clicked",
824 G_CALLBACK (gtk_tree_view_column_button_clicked),
827 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
829 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
830 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
836 child = gtk_label_new (priv->title);
837 gtk_widget_show (child);
840 g_signal_connect (child, "mnemonic-activate",
841 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
844 if (priv->xalign <= 0.5)
845 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
847 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
849 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
851 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
852 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
854 gtk_widget_show (hbox);
855 gtk_widget_show (priv->alignment);
856 gtk_tree_view_column_update_button (tree_column);
860 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
862 GtkTreeViewColumnPrivate *priv = tree_column->priv;
863 gint sort_column_id = -1;
865 GtkWidget *alignment;
867 GtkWidget *current_child;
868 GtkArrowType arrow_type = GTK_ARROW_NONE;
872 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
876 /* Create a button if necessary */
878 priv->button == NULL &&
880 gtk_widget_get_realized (priv->tree_view))
881 gtk_tree_view_column_create_button (tree_column);
886 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
887 alignment = priv->alignment;
889 current_child = gtk_bin_get_child (GTK_BIN (alignment));
891 /* Set up the actual button */
892 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
897 if (current_child != priv->child)
899 gtk_container_remove (GTK_CONTAINER (alignment),
901 gtk_container_add (GTK_CONTAINER (alignment),
907 if (current_child == NULL)
909 current_child = gtk_label_new (NULL);
910 gtk_widget_show (current_child);
911 gtk_container_add (GTK_CONTAINER (alignment),
915 g_return_if_fail (GTK_IS_LABEL (current_child));
918 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
921 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
925 if (GTK_IS_TREE_SORTABLE (model))
926 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
930 if (priv->show_sort_indicator)
932 gboolean alternative;
934 g_object_get (gtk_widget_get_settings (priv->tree_view),
935 "gtk-alternative-sort-arrows", &alternative,
938 switch (priv->sort_order)
940 case GTK_SORT_ASCENDING:
941 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
944 case GTK_SORT_DESCENDING:
945 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
949 g_warning (G_STRLOC": bad sort order");
954 gtk_arrow_set (GTK_ARROW (arrow),
958 /* Put arrow on the right if the text is left-or-center justified, and on the
959 * left otherwise; do this by packing boxes, so flipping text direction will
962 g_object_ref (arrow);
963 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
965 if (priv->xalign <= 0.5)
967 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
971 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
972 /* move it to the front */
973 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
975 g_object_unref (arrow);
977 if (priv->show_sort_indicator
978 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
979 gtk_widget_show (arrow);
981 gtk_widget_hide (arrow);
983 /* It's always safe to hide the button. It isn't always safe to show it, as
984 * if you show it before it's realized, it'll get the wrong window. */
986 priv->tree_view != NULL &&
987 gtk_widget_get_realized (priv->tree_view))
991 if (gdk_window_is_visible (_gtk_tree_view_get_header_window (GTK_TREE_VIEW (priv->tree_view))))
992 gtk_widget_show_now (priv->button);
998 gdk_window_show (priv->window);
999 gdk_window_raise (priv->window);
1003 gdk_window_hide (priv->window);
1009 gtk_widget_hide (priv->button);
1011 gdk_window_hide (priv->window);
1015 if (priv->reorderable || priv->clickable)
1017 gtk_widget_set_can_focus (priv->button, TRUE);
1021 gtk_widget_set_can_focus (priv->button, FALSE);
1022 if (gtk_widget_has_focus (priv->button))
1024 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1025 if (gtk_widget_is_toplevel (toplevel))
1027 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1031 /* Queue a resize on the assumption that we always want to catch all changes
1032 * and columns don't change all that often.
1034 if (gtk_widget_get_realized (priv->tree_view))
1035 gtk_widget_queue_resize (priv->tree_view);
1039 /* Button signal handlers
1043 gtk_tree_view_column_button_event (GtkWidget *widget,
1047 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1048 GtkTreeViewColumnPrivate *priv = column->priv;
1050 g_return_val_if_fail (event != NULL, FALSE);
1052 if (event->type == GDK_BUTTON_PRESS &&
1053 priv->reorderable &&
1054 ((GdkEventButton *)event)->button == 1)
1056 priv->maybe_reordered = TRUE;
1057 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1061 gtk_widget_grab_focus (widget);
1064 if (event->type == GDK_BUTTON_RELEASE ||
1065 event->type == GDK_LEAVE_NOTIFY)
1066 priv->maybe_reordered = FALSE;
1068 if (event->type == GDK_MOTION_NOTIFY &&
1069 priv->maybe_reordered &&
1070 (gtk_drag_check_threshold (widget,
1073 (gint) ((GdkEventMotion *)event)->x,
1074 (gint) ((GdkEventMotion *)event)->y)))
1076 priv->maybe_reordered = FALSE;
1077 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1078 event->motion.device);
1082 if (priv->clickable == FALSE)
1084 switch (event->type)
1086 case GDK_BUTTON_PRESS:
1087 case GDK_2BUTTON_PRESS:
1088 case GDK_3BUTTON_PRESS:
1089 case GDK_MOTION_NOTIFY:
1090 case GDK_BUTTON_RELEASE:
1091 case GDK_ENTER_NOTIFY:
1092 case GDK_LEAVE_NOTIFY:
1103 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1105 g_signal_emit_by_name (data, "clicked");
1109 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1110 gboolean group_cycling,
1113 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1114 GtkTreeViewColumnPrivate *priv = column->priv;
1116 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1118 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1120 if (priv->clickable)
1121 gtk_button_clicked (GTK_BUTTON (priv->button));
1122 else if (gtk_widget_get_can_focus (priv->button))
1123 gtk_widget_grab_focus (priv->button);
1125 gtk_widget_grab_focus (priv->tree_view);
1131 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1132 GtkTreeViewColumn *column)
1134 GtkTreeViewColumnPrivate *priv = column->priv;
1135 gint sort_column_id;
1138 if (gtk_tree_sortable_get_sort_column_id (sortable,
1142 if (sort_column_id == priv->sort_column_id)
1144 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1145 gtk_tree_view_column_set_sort_order (column, order);
1149 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1154 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1159 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1162 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1163 GtkTreeModel *model;
1164 GtkTreeSortable *sortable;
1165 gint sort_column_id;
1167 gboolean has_sort_column;
1168 gboolean has_default_sort_func;
1170 g_return_if_fail (priv->tree_view != NULL);
1172 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1173 sortable = GTK_TREE_SORTABLE (model);
1176 gtk_tree_sortable_get_sort_column_id (sortable,
1179 has_default_sort_func =
1180 gtk_tree_sortable_has_default_sort_func (sortable);
1182 if (has_sort_column &&
1183 sort_column_id == priv->sort_column_id)
1185 if (order == GTK_SORT_ASCENDING)
1186 gtk_tree_sortable_set_sort_column_id (sortable,
1187 priv->sort_column_id,
1188 GTK_SORT_DESCENDING);
1189 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1190 gtk_tree_sortable_set_sort_column_id (sortable,
1191 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1192 GTK_SORT_ASCENDING);
1194 gtk_tree_sortable_set_sort_column_id (sortable,
1195 priv->sort_column_id,
1196 GTK_SORT_ASCENDING);
1200 gtk_tree_sortable_set_sort_column_id (sortable,
1201 priv->sort_column_id,
1202 GTK_SORT_ASCENDING);
1207 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1209 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1210 GtkTreeModel *model;
1212 if (priv->tree_view == NULL)
1215 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1220 if (GTK_IS_TREE_SORTABLE (model) &&
1221 priv->sort_column_id != -1)
1223 gint real_sort_column_id;
1224 GtkSortType real_order;
1226 if (priv->sort_column_changed_signal == 0)
1227 priv->sort_column_changed_signal =
1228 g_signal_connect (model, "sort-column-changed",
1229 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1232 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1233 &real_sort_column_id,
1235 (real_sort_column_id == priv->sort_column_id))
1237 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1238 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1242 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1248 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1250 GtkTreeViewColumn *tree_column)
1252 /* Here we want the column re-requested if the underlying context was
1253 * actually reset for any reason, this can happen if the underlying
1254 * area/cell configuration changes (i.e. cell packing properties
1255 * or cell spacing and the like)
1257 * Note that we block this handler while requesting for sizes
1258 * so there is no need to check for the new context size being -1,
1259 * we also block the handler when explicitly resetting the context
1260 * so as to avoid some infinite stack recursion.
1262 if (!strcmp (pspec->name, "minimum-width") ||
1263 !strcmp (pspec->name, "natural-width") ||
1264 !strcmp (pspec->name, "minimum-height") ||
1265 !strcmp (pspec->name, "natural-height"))
1266 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1270 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1271 GtkCellRenderer *renderer,
1272 GtkCellEditable *edit_widget,
1273 GdkRectangle *cell_area,
1274 const gchar *path_string,
1277 GtkTreeViewColumn *column = user_data;
1278 GtkTreeViewColumnPrivate *priv = column->priv;
1281 if (priv->tree_view)
1283 path = gtk_tree_path_new_from_string (path_string);
1285 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1291 gtk_tree_path_free (path);
1296 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1297 GtkCellRenderer *renderer,
1298 GtkCellEditable *edit_widget,
1301 GtkTreeViewColumn *column = user_data;
1302 GtkTreeViewColumnPrivate *priv = column->priv;
1304 if (priv->tree_view)
1305 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1310 /* Exported Private Functions.
1311 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1314 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1316 GtkTreeViewColumnPrivate *priv = column->priv;
1317 GtkAllocation allocation;
1318 GtkTreeView *tree_view;
1320 guint attributes_mask;
1323 tree_view = (GtkTreeView *)priv->tree_view;
1324 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1326 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1327 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1328 g_return_if_fail (priv->button != NULL);
1330 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1331 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1333 attr.window_type = GDK_WINDOW_CHILD;
1334 attr.wclass = GDK_INPUT_ONLY;
1335 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1336 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1337 (GDK_BUTTON_PRESS_MASK |
1338 GDK_BUTTON_RELEASE_MASK |
1339 GDK_POINTER_MOTION_MASK |
1340 GDK_POINTER_MOTION_HINT_MASK |
1341 GDK_KEY_PRESS_MASK);
1342 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1343 attr.cursor = gdk_cursor_new_for_display
1344 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1346 attr.width = TREE_VIEW_DRAG_WIDTH;
1347 attr.height = _gtk_tree_view_get_header_height (tree_view);
1349 gtk_widget_get_allocation (priv->button, &allocation);
1350 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1351 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1352 &attr, attributes_mask);
1353 gdk_window_set_user_data (priv->window, tree_view);
1355 gtk_tree_view_column_update_button (column);
1357 g_object_unref (attr.cursor);
1361 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1363 GtkTreeViewColumnPrivate *priv;
1365 g_return_if_fail (column != NULL);
1367 priv = column->priv;
1368 g_return_if_fail (priv->window != NULL);
1370 gdk_window_set_user_data (priv->window, NULL);
1371 gdk_window_destroy (priv->window);
1372 priv->window = NULL;
1376 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1377 GtkTreeModel *old_model)
1379 GtkTreeViewColumnPrivate *priv = column->priv;
1381 if (priv->sort_column_changed_signal)
1383 g_signal_handler_disconnect (old_model,
1384 priv->sort_column_changed_signal);
1385 priv->sort_column_changed_signal = 0;
1387 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1391 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1392 GtkTreeView *tree_view)
1394 GtkTreeViewColumnPrivate *priv = column->priv;
1396 g_assert (priv->tree_view == NULL);
1398 priv->tree_view = GTK_WIDGET (tree_view);
1399 gtk_tree_view_column_create_button (column);
1401 priv->property_changed_signal =
1402 g_signal_connect_swapped (tree_view,
1404 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1407 gtk_tree_view_column_setup_sort_column_id_callback (column);
1411 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1413 GtkTreeViewColumnPrivate *priv = column->priv;
1415 if (priv->tree_view && priv->button)
1417 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1419 if (priv->property_changed_signal)
1421 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1422 priv->property_changed_signal = 0;
1425 if (priv->sort_column_changed_signal)
1427 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1428 priv->sort_column_changed_signal);
1429 priv->sort_column_changed_signal = 0;
1432 priv->tree_view = NULL;
1433 priv->button = NULL;
1437 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1439 GtkTreeViewColumnPrivate *priv = column->priv;
1440 gboolean ret = FALSE;
1441 GList *list, *cells;
1443 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1445 for (list = cells; list; list = list->next)
1447 GtkCellRenderer *cell = list->data;
1448 GtkCellRendererMode mode;
1450 g_object_get (cell, "mode", &mode, NULL);
1452 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1459 g_list_free (cells);
1464 /* gets cell being edited */
1466 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1468 GtkTreeViewColumnPrivate *priv = column->priv;
1470 return gtk_cell_area_get_edited_cell (priv->cell_area);
1474 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1475 GdkRectangle *cell_area,
1476 GdkRectangle *background_area,
1480 GtkCellRenderer *match = NULL;
1481 GtkTreeViewColumnPrivate *priv = column->priv;
1483 /* If (x, y) is outside of the background area, immediately return */
1484 if (x < background_area->x ||
1485 x > background_area->x + background_area->width ||
1486 y < background_area->y ||
1487 y > background_area->y + background_area->height)
1490 /* If (x, y) is inside the background area, clamp it to the cell_area
1491 * so that a cell is still returned. The main reason for doing this
1492 * (on the x axis) is for handling clicks in the indentation area
1493 * (either at the left or right depending on RTL setting). Another
1494 * reason is for handling clicks on the area where the focus rectangle
1495 * is drawn (this is outside of cell area), this manifests itself
1496 * mainly when a large setting is used for focus-line-width.
1498 if (x < cell_area->x)
1500 else if (x > cell_area->x + cell_area->width)
1501 x = cell_area->x + cell_area->width;
1503 if (y < cell_area->y)
1505 else if (y > cell_area->y + cell_area->height)
1506 y = cell_area->y + cell_area->height;
1508 match = gtk_cell_area_get_cell_at_position (priv->cell_area,
1509 priv->cell_area_context,
1519 _gtk_tree_view_column_is_blank_at_pos (GtkTreeViewColumn *column,
1520 GdkRectangle *cell_area,
1521 GdkRectangle *background_area,
1525 GtkCellRenderer *match;
1526 GdkRectangle cell_alloc, aligned_area, inner_area;
1527 GtkTreeViewColumnPrivate *priv = column->priv;
1529 match = _gtk_tree_view_column_get_cell_at_pos (column,
1536 gtk_cell_area_get_cell_allocation (priv->cell_area,
1537 priv->cell_area_context,
1543 gtk_cell_area_inner_cell_area (priv->cell_area, priv->tree_view,
1544 &cell_alloc, &inner_area);
1545 gtk_cell_renderer_get_aligned_area (match, priv->tree_view, 0,
1546 &inner_area, &aligned_area);
1548 if (x < aligned_area.x ||
1549 x > aligned_area.x + aligned_area.width ||
1550 y < aligned_area.y ||
1551 y > aligned_area.y + aligned_area.height)
1557 /* Public Functions */
1561 * gtk_tree_view_column_new:
1563 * Creates a new #GtkTreeViewColumn.
1565 * Return value: A newly created #GtkTreeViewColumn.
1568 gtk_tree_view_column_new (void)
1570 GtkTreeViewColumn *tree_column;
1572 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1578 * gtk_tree_view_column_new_with_area:
1579 * @area: the #GtkCellArea that the newly created column should use to layout cells.
1581 * Creates a new #GtkTreeViewColumn using @area to render it's cells.
1583 * Return value: A newly created #GtkTreeViewColumn.
1588 gtk_tree_view_column_new_with_area (GtkCellArea *area)
1590 GtkTreeViewColumn *tree_column;
1592 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, "cell-area", area, NULL);
1599 * gtk_tree_view_column_new_with_attributes:
1600 * @title: The title to set the header to.
1601 * @cell: The #GtkCellRenderer.
1602 * @Varargs: A %NULL-terminated list of attributes.
1604 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1605 * equivalent to calling gtk_tree_view_column_set_title(),
1606 * gtk_tree_view_column_pack_start(), and
1607 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1609 * Here's a simple example:
1611 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1614 * GtkTreeViewColumn *column;
1615 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1617 * column = gtk_tree_view_column_new_with_attributes ("Title",
1619 * "text", TEXT_COLUMN,
1620 * "foreground", COLOR_COLUMN,
1625 * Return value: A newly created #GtkTreeViewColumn.
1628 gtk_tree_view_column_new_with_attributes (const gchar *title,
1629 GtkCellRenderer *cell,
1632 GtkTreeViewColumn *retval;
1635 retval = gtk_tree_view_column_new ();
1637 gtk_tree_view_column_set_title (retval, title);
1638 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1640 va_start (args, cell);
1641 gtk_tree_view_column_set_attributesv (retval, cell, args);
1648 * gtk_tree_view_column_pack_start:
1649 * @tree_column: A #GtkTreeViewColumn.
1650 * @cell: The #GtkCellRenderer.
1651 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1653 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1654 * the @cell is allocated no more space than it needs. Any unused space is divided
1655 * evenly between cells for which @expand is %TRUE.
1658 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1659 GtkCellRenderer *cell,
1662 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1666 * gtk_tree_view_column_pack_end:
1667 * @tree_column: A #GtkTreeViewColumn.
1668 * @cell: The #GtkCellRenderer.
1669 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1671 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1672 * is allocated no more space than it needs. Any unused space is divided
1673 * evenly between cells for which @expand is %TRUE.
1676 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1677 GtkCellRenderer *cell,
1680 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1684 * gtk_tree_view_column_clear:
1685 * @tree_column: A #GtkTreeViewColumn
1687 * Unsets all the mappings on all renderers on the @tree_column.
1690 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1692 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1696 * gtk_tree_view_column_add_attribute:
1697 * @tree_column: A #GtkTreeViewColumn.
1698 * @cell_renderer: the #GtkCellRenderer to set attributes on
1699 * @attribute: An attribute on the renderer
1700 * @column: The column position on the model to get the attribute from.
1702 * Adds an attribute mapping to the list in @tree_column. The @column is the
1703 * column of the model to get a value from, and the @attribute is the
1704 * parameter on @cell_renderer to be set from the value. So for example
1705 * if column 2 of the model contains strings, you could have the
1706 * "text" attribute of a #GtkCellRendererText get its values from
1710 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1711 GtkCellRenderer *cell_renderer,
1712 const gchar *attribute,
1715 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1716 cell_renderer, attribute, column);
1720 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1721 GtkCellRenderer *cell_renderer,
1724 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1728 attribute = va_arg (args, gchar *);
1730 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1733 while (attribute != NULL)
1735 column = va_arg (args, gint);
1736 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1737 cell_renderer, attribute, column);
1738 attribute = va_arg (args, gchar *);
1743 * gtk_tree_view_column_set_attributes:
1744 * @tree_column: A #GtkTreeViewColumn.
1745 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1746 * @Varargs: A %NULL-terminated list of attributes.
1748 * Sets the attributes in the list as the attributes of @tree_column.
1749 * The attributes should be in attribute/column order, as in
1750 * gtk_tree_view_column_add_attribute(). All existing attributes
1751 * are removed, and replaced with the new attributes.
1754 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1755 GtkCellRenderer *cell_renderer,
1760 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1761 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1763 va_start (args, cell_renderer);
1764 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1770 * gtk_tree_view_column_set_cell_data_func:
1771 * @tree_column: A #GtkTreeViewColumn
1772 * @cell_renderer: A #GtkCellRenderer
1773 * @func: (allow-none): The #GtkTreeViewColumnFunc to use.
1774 * @func_data: The user data for @func.
1775 * @destroy: The destroy notification for @func_data
1777 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1778 * function is used instead of the standard attributes mapping for
1779 * setting the column value, and should set the value of @tree_column's
1780 * cell renderer as appropriate. @func may be %NULL to remove an
1784 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1785 GtkCellRenderer *cell_renderer,
1786 GtkTreeCellDataFunc func,
1788 GDestroyNotify destroy)
1790 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1792 (GtkCellLayoutDataFunc)func,
1793 func_data, destroy);
1798 * gtk_tree_view_column_clear_attributes:
1799 * @tree_column: a #GtkTreeViewColumn
1800 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1802 * Clears all existing attributes previously set with
1803 * gtk_tree_view_column_set_attributes().
1806 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1807 GtkCellRenderer *cell_renderer)
1809 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1814 * gtk_tree_view_column_set_spacing:
1815 * @tree_column: A #GtkTreeViewColumn.
1816 * @spacing: distance between cell renderers in pixels.
1818 * Sets the spacing field of @tree_column, which is the number of pixels to
1819 * place between cell renderers packed into it.
1822 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1825 GtkTreeViewColumnPrivate *priv;
1827 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1828 g_return_if_fail (spacing >= 0);
1830 priv = tree_column->priv;
1832 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1834 if (priv->tree_view)
1835 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1839 * gtk_tree_view_column_get_spacing:
1840 * @tree_column: A #GtkTreeViewColumn.
1842 * Returns the spacing of @tree_column.
1844 * Return value: the spacing of @tree_column.
1847 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1849 GtkTreeViewColumnPrivate *priv;
1851 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1853 priv = tree_column->priv;
1855 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1858 /* Options for manipulating the columns */
1861 * gtk_tree_view_column_set_visible:
1862 * @tree_column: A #GtkTreeViewColumn.
1863 * @visible: %TRUE if the @tree_column is visible.
1865 * Sets the visibility of @tree_column.
1868 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1871 GtkTreeViewColumnPrivate *priv;
1873 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1875 priv = tree_column->priv;
1876 visible = !! visible;
1878 if (priv->visible == visible)
1881 priv->visible = visible;
1884 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1886 gtk_tree_view_column_update_button (tree_column);
1887 g_object_notify (G_OBJECT (tree_column), "visible");
1891 * gtk_tree_view_column_get_visible:
1892 * @tree_column: A #GtkTreeViewColumn.
1894 * Returns %TRUE if @tree_column is visible.
1896 * Return value: whether the column is visible or not. If it is visible, then
1897 * the tree will show the column.
1900 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1902 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1904 return tree_column->priv->visible;
1908 * gtk_tree_view_column_set_resizable:
1909 * @tree_column: A #GtkTreeViewColumn
1910 * @resizable: %TRUE, if the column can be resized
1912 * If @resizable is %TRUE, then the user can explicitly resize the column by
1913 * grabbing the outer edge of the column button. If resizable is %TRUE and
1914 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1915 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1918 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1921 GtkTreeViewColumnPrivate *priv;
1923 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1925 priv = tree_column->priv;
1926 resizable = !! resizable;
1928 if (priv->resizable == resizable)
1931 priv->resizable = resizable;
1933 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1934 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1936 gtk_tree_view_column_update_button (tree_column);
1938 g_object_notify (G_OBJECT (tree_column), "resizable");
1942 * gtk_tree_view_column_get_resizable:
1943 * @tree_column: A #GtkTreeViewColumn
1945 * Returns %TRUE if the @tree_column can be resized by the end user.
1947 * Return value: %TRUE, if the @tree_column can be resized.
1950 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1952 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1954 return tree_column->priv->resizable;
1959 * gtk_tree_view_column_set_sizing:
1960 * @tree_column: A #GtkTreeViewColumn.
1961 * @type: The #GtkTreeViewColumnSizing.
1963 * Sets the growth behavior of @tree_column to @type.
1966 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1967 GtkTreeViewColumnSizing type)
1969 GtkTreeViewColumnPrivate *priv;
1971 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1973 priv = tree_column->priv;
1975 if (type == priv->column_type)
1978 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1979 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1981 priv->column_type = type;
1983 gtk_tree_view_column_update_button (tree_column);
1985 g_object_notify (G_OBJECT (tree_column), "sizing");
1989 * gtk_tree_view_column_get_sizing:
1990 * @tree_column: A #GtkTreeViewColumn.
1992 * Returns the current type of @tree_column.
1994 * Return value: The type of @tree_column.
1996 GtkTreeViewColumnSizing
1997 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1999 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2001 return tree_column->priv->column_type;
2005 * gtk_tree_view_column_get_width:
2006 * @tree_column: A #GtkTreeViewColumn.
2008 * Returns the current size of @tree_column in pixels.
2010 * Return value: The current width of @tree_column.
2013 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
2015 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2017 return tree_column->priv->width;
2021 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
2023 GtkTreeViewColumnPrivate *priv;
2024 gint real_requested_width;
2026 priv = tree_column->priv;
2028 if (priv->use_resized_width)
2030 real_requested_width = priv->resized_width;
2032 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2034 real_requested_width = priv->fixed_width;
2036 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
2038 gint button_request;
2039 gint requested_width;
2041 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2042 requested_width += priv->padding;
2044 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
2045 real_requested_width = MAX (requested_width, button_request);
2049 gint requested_width;
2051 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &requested_width, NULL);
2052 requested_width += priv->padding;
2054 real_requested_width = requested_width;
2055 if (real_requested_width < 0)
2056 real_requested_width = 0;
2059 if (priv->min_width != -1)
2060 real_requested_width = MAX (real_requested_width, priv->min_width);
2062 if (priv->max_width != -1)
2063 real_requested_width = MIN (real_requested_width, priv->max_width);
2065 return real_requested_width;
2069 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2073 GtkTreeViewColumnPrivate *priv;
2074 GtkAllocation allocation;
2077 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2079 priv = tree_column->priv;
2081 priv->width = width;
2083 gtk_cell_area_context_allocate (priv->cell_area_context, priv->width - priv->padding, -1);
2085 allocation.x = x_offset;
2087 allocation.width = width;
2088 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2090 gtk_widget_size_allocate (priv->button, &allocation);
2094 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2095 gdk_window_move_resize (priv->window,
2096 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2098 TREE_VIEW_DRAG_WIDTH, allocation.height);
2101 g_object_notify (G_OBJECT (tree_column), "width");
2105 * gtk_tree_view_column_set_fixed_width:
2106 * @tree_column: A #GtkTreeViewColumn.
2107 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2109 * Sets the size of the column in pixels. This is meaningful only if the sizing
2110 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2111 * the min/max width for the column. Please note that the min/max width of the
2112 * column doesn't actually affect the "fixed_width" property of the widget, just
2113 * the actual size when displayed.
2116 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2119 GtkTreeViewColumnPrivate *priv;
2121 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2122 g_return_if_fail (fixed_width > 0);
2124 priv = tree_column->priv;
2126 priv->fixed_width = fixed_width;
2127 priv->use_resized_width = FALSE;
2129 if (priv->tree_view &&
2130 gtk_widget_get_realized (priv->tree_view) &&
2131 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2133 gtk_widget_queue_resize (priv->tree_view);
2136 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2140 * gtk_tree_view_column_get_fixed_width:
2141 * @tree_column: a #GtkTreeViewColumn
2143 * Gets the fixed width of the column. This value is only meaning may not be
2144 * the actual width of the column on the screen, just what is requested.
2146 * Return value: the fixed width of the column
2149 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2151 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2153 return tree_column->priv->fixed_width;
2157 * gtk_tree_view_column_set_min_width:
2158 * @tree_column: A #GtkTreeViewColumn.
2159 * @min_width: The minimum width of the column in pixels, or -1.
2161 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2162 * minimum width is unset.
2165 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2168 GtkTreeViewColumnPrivate *priv;
2170 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2171 g_return_if_fail (min_width >= -1);
2173 priv = tree_column->priv;
2175 if (min_width == priv->min_width)
2178 if (priv->visible &&
2179 priv->tree_view != NULL &&
2180 gtk_widget_get_realized (priv->tree_view))
2182 if (min_width > priv->width)
2183 gtk_widget_queue_resize (priv->tree_view);
2186 priv->min_width = min_width;
2187 g_object_freeze_notify (G_OBJECT (tree_column));
2188 if (priv->max_width != -1 && priv->max_width < min_width)
2190 priv->max_width = min_width;
2191 g_object_notify (G_OBJECT (tree_column), "max-width");
2193 g_object_notify (G_OBJECT (tree_column), "min-width");
2194 g_object_thaw_notify (G_OBJECT (tree_column));
2196 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2197 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2202 * gtk_tree_view_column_get_min_width:
2203 * @tree_column: A #GtkTreeViewColumn.
2205 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2208 * Return value: The minimum width of the @tree_column.
2211 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2213 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2215 return tree_column->priv->min_width;
2219 * gtk_tree_view_column_set_max_width:
2220 * @tree_column: A #GtkTreeViewColumn.
2221 * @max_width: The maximum width of the column in pixels, or -1.
2223 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2224 * maximum width is unset. Note, the column can actually be wider than max
2225 * width if it's the last column in a view. In this case, the column expands to
2226 * fill any extra space.
2229 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2232 GtkTreeViewColumnPrivate *priv;
2234 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2235 g_return_if_fail (max_width >= -1);
2237 priv = tree_column->priv;
2239 if (max_width == priv->max_width)
2242 if (priv->visible &&
2243 priv->tree_view != NULL &&
2244 gtk_widget_get_realized (priv->tree_view))
2246 if (max_width != -1 && max_width < priv->width)
2247 gtk_widget_queue_resize (priv->tree_view);
2250 priv->max_width = max_width;
2251 g_object_freeze_notify (G_OBJECT (tree_column));
2252 if (max_width != -1 && max_width < priv->min_width)
2254 priv->min_width = max_width;
2255 g_object_notify (G_OBJECT (tree_column), "min-width");
2257 g_object_notify (G_OBJECT (tree_column), "max-width");
2258 g_object_thaw_notify (G_OBJECT (tree_column));
2260 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2261 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2266 * gtk_tree_view_column_get_max_width:
2267 * @tree_column: A #GtkTreeViewColumn.
2269 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2272 * Return value: The maximum width of the @tree_column.
2275 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2277 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2279 return tree_column->priv->max_width;
2283 * gtk_tree_view_column_clicked:
2284 * @tree_column: a #GtkTreeViewColumn
2286 * Emits the "clicked" signal on the column. This function will only work if
2287 * @tree_column is clickable.
2290 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2292 GtkTreeViewColumnPrivate *priv;
2294 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2296 priv = tree_column->priv;
2298 if (priv->visible &&
2301 gtk_button_clicked (GTK_BUTTON (priv->button));
2305 * gtk_tree_view_column_set_title:
2306 * @tree_column: A #GtkTreeViewColumn.
2307 * @title: The title of the @tree_column.
2309 * Sets the title of the @tree_column. If a custom widget has been set, then
2310 * this value is ignored.
2313 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2316 GtkTreeViewColumnPrivate *priv;
2319 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2321 priv = tree_column->priv;
2323 new_title = g_strdup (title);
2324 g_free (priv->title);
2325 priv->title = new_title;
2327 gtk_tree_view_column_update_button (tree_column);
2328 g_object_notify (G_OBJECT (tree_column), "title");
2332 * gtk_tree_view_column_get_title:
2333 * @tree_column: A #GtkTreeViewColumn.
2335 * Returns the title of the widget.
2337 * Return value: the title of the column. This string should not be
2338 * modified or freed.
2340 G_CONST_RETURN gchar *
2341 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2343 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2345 return tree_column->priv->title;
2349 * gtk_tree_view_column_set_expand:
2350 * @tree_column: A #GtkTreeViewColumn
2351 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2353 * Sets the column to take available extra space. This space is shared equally
2354 * amongst all columns that have the expand set to %TRUE. If no column has this
2355 * option set, then the last column gets all extra space. By default, every
2356 * column is created with this %FALSE.
2361 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2364 GtkTreeViewColumnPrivate *priv;
2366 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2368 priv = tree_column->priv;
2370 expand = expand?TRUE:FALSE;
2371 if (priv->expand == expand)
2373 priv->expand = expand;
2375 if (priv->visible &&
2376 priv->tree_view != NULL &&
2377 gtk_widget_get_realized (priv->tree_view))
2379 /* We want to continue using the original width of the
2380 * column that includes additional space added by the user
2381 * resizing the columns and possibly extra (expanded) space, which
2382 * are not included in the resized width.
2384 priv->use_resized_width = FALSE;
2386 gtk_widget_queue_resize (priv->tree_view);
2389 g_object_notify (G_OBJECT (tree_column), "expand");
2393 * gtk_tree_view_column_get_expand:
2394 * @tree_column: a #GtkTreeViewColumn
2396 * Return %TRUE if the column expands to take any available space.
2398 * Return value: %TRUE, if the column expands
2403 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2405 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2407 return tree_column->priv->expand;
2411 * gtk_tree_view_column_set_clickable:
2412 * @tree_column: A #GtkTreeViewColumn.
2413 * @clickable: %TRUE if the header is active.
2415 * Sets the header to be active if @active is %TRUE. When the header is active,
2416 * then it can take keyboard focus, and can be clicked.
2419 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2422 GtkTreeViewColumnPrivate *priv;
2424 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2426 priv = tree_column->priv;
2428 clickable = !! clickable;
2429 if (priv->clickable == clickable)
2432 priv->clickable = clickable;
2433 gtk_tree_view_column_update_button (tree_column);
2434 g_object_notify (G_OBJECT (tree_column), "clickable");
2438 * gtk_tree_view_column_get_clickable:
2439 * @tree_column: a #GtkTreeViewColumn
2441 * Returns %TRUE if the user can click on the header for the column.
2443 * Return value: %TRUE if user can click the column header.
2446 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2448 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2450 return tree_column->priv->clickable;
2454 * gtk_tree_view_column_set_widget:
2455 * @tree_column: A #GtkTreeViewColumn.
2456 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2458 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2459 * header button is set with a #GtkLabel set to the title of @tree_column.
2462 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2465 GtkTreeViewColumnPrivate *priv;
2467 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2468 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2470 priv = tree_column->priv;
2473 g_object_ref_sink (widget);
2476 g_object_unref (priv->child);
2478 priv->child = widget;
2479 gtk_tree_view_column_update_button (tree_column);
2480 g_object_notify (G_OBJECT (tree_column), "widget");
2484 * gtk_tree_view_column_get_widget:
2485 * @tree_column: A #GtkTreeViewColumn.
2487 * Returns the #GtkWidget in the button on the column header.
2488 * If a custom widget has not been set then %NULL is returned.
2490 * Return value: (transfer none): The #GtkWidget in the column
2494 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2496 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2498 return tree_column->priv->child;
2502 * gtk_tree_view_column_set_alignment:
2503 * @tree_column: A #GtkTreeViewColumn.
2504 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2506 * Sets the alignment of the title or custom widget inside the column header.
2507 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2508 * for center, 1.0 for right.
2511 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2514 GtkTreeViewColumnPrivate *priv;
2516 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2518 priv = tree_column->priv;
2520 xalign = CLAMP (xalign, 0.0, 1.0);
2522 if (priv->xalign == xalign)
2525 priv->xalign = xalign;
2526 gtk_tree_view_column_update_button (tree_column);
2527 g_object_notify (G_OBJECT (tree_column), "alignment");
2531 * gtk_tree_view_column_get_alignment:
2532 * @tree_column: A #GtkTreeViewColumn.
2534 * Returns the current x alignment of @tree_column. This value can range
2535 * between 0.0 and 1.0.
2537 * Return value: The current alignent of @tree_column.
2540 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2542 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2544 return tree_column->priv->xalign;
2548 * gtk_tree_view_column_set_reorderable:
2549 * @tree_column: A #GtkTreeViewColumn
2550 * @reorderable: %TRUE, if the column can be reordered.
2552 * If @reorderable is %TRUE, then the column can be reordered by the end user
2553 * dragging the header.
2556 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2557 gboolean reorderable)
2559 GtkTreeViewColumnPrivate *priv;
2561 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2563 priv = tree_column->priv;
2566 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2568 if (priv->reorderable == (reorderable?TRUE:FALSE))
2571 priv->reorderable = (reorderable?TRUE:FALSE);
2572 gtk_tree_view_column_update_button (tree_column);
2573 g_object_notify (G_OBJECT (tree_column), "reorderable");
2577 * gtk_tree_view_column_get_reorderable:
2578 * @tree_column: A #GtkTreeViewColumn
2580 * Returns %TRUE if the @tree_column can be reordered by the user.
2582 * Return value: %TRUE if the @tree_column can be reordered by the user.
2585 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2587 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2589 return tree_column->priv->reorderable;
2594 * gtk_tree_view_column_set_sort_column_id:
2595 * @tree_column: a #GtkTreeViewColumn
2596 * @sort_column_id: The @sort_column_id of the model to sort on.
2598 * Sets the logical @sort_column_id that this column sorts on when this column
2599 * is selected for sorting. Doing so makes the column header clickable.
2602 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2603 gint sort_column_id)
2605 GtkTreeViewColumnPrivate *priv;
2607 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2608 g_return_if_fail (sort_column_id >= -1);
2610 priv = tree_column->priv;
2612 if (priv->sort_column_id == sort_column_id)
2615 priv->sort_column_id = sort_column_id;
2617 /* Handle unsetting the id */
2618 if (sort_column_id == -1)
2620 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2622 if (priv->sort_clicked_signal)
2624 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2625 priv->sort_clicked_signal = 0;
2628 if (priv->sort_column_changed_signal)
2630 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2631 priv->sort_column_changed_signal = 0;
2634 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2635 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2636 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2637 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2641 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2643 if (! priv->sort_clicked_signal)
2644 priv->sort_clicked_signal = g_signal_connect (tree_column,
2646 G_CALLBACK (gtk_tree_view_column_sort),
2649 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2650 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2654 * gtk_tree_view_column_get_sort_column_id:
2655 * @tree_column: a #GtkTreeViewColumn
2657 * Gets the logical @sort_column_id that the model sorts on when this
2658 * column is selected for sorting.
2659 * See gtk_tree_view_column_set_sort_column_id().
2661 * Return value: the current @sort_column_id for this column, or -1 if
2662 * this column can't be used for sorting.
2665 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2667 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2669 return tree_column->priv->sort_column_id;
2673 * gtk_tree_view_column_set_sort_indicator:
2674 * @tree_column: a #GtkTreeViewColumn
2675 * @setting: %TRUE to display an indicator that the column is sorted
2677 * Call this function with a @setting of %TRUE to display an arrow in
2678 * the header button indicating the column is sorted. Call
2679 * gtk_tree_view_column_set_sort_order() to change the direction of
2684 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2687 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2689 setting = setting != FALSE;
2691 if (setting == tree_column->priv->show_sort_indicator)
2694 tree_column->priv->show_sort_indicator = setting;
2695 gtk_tree_view_column_update_button (tree_column);
2696 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2700 * gtk_tree_view_column_get_sort_indicator:
2701 * @tree_column: a #GtkTreeViewColumn
2703 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2705 * Return value: whether the sort indicator arrow is displayed
2708 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2710 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2712 return tree_column->priv->show_sort_indicator;
2716 * gtk_tree_view_column_set_sort_order:
2717 * @tree_column: a #GtkTreeViewColumn
2718 * @order: sort order that the sort indicator should indicate
2720 * Changes the appearance of the sort indicator.
2722 * This <emphasis>does not</emphasis> actually sort the model. Use
2723 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2724 * support. This function is primarily for custom sorting behavior, and should
2725 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2726 * that. For custom models, the mechanism will vary.
2728 * The sort indicator changes direction to indicate normal sort or reverse sort.
2729 * Note that you must have the sort indicator enabled to see anything when
2730 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2733 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2736 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2738 if (order == tree_column->priv->sort_order)
2741 tree_column->priv->sort_order = order;
2742 gtk_tree_view_column_update_button (tree_column);
2743 g_object_notify (G_OBJECT (tree_column), "sort-order");
2747 * gtk_tree_view_column_get_sort_order:
2748 * @tree_column: a #GtkTreeViewColumn
2750 * Gets the value set by gtk_tree_view_column_set_sort_order().
2752 * Return value: the sort order the sort indicator is indicating
2755 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2757 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2759 return tree_column->priv->sort_order;
2763 * gtk_tree_view_column_cell_set_cell_data:
2764 * @tree_column: A #GtkTreeViewColumn.
2765 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2766 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2767 * @is_expander: %TRUE, if the row has children
2768 * @is_expanded: %TRUE, if the row has visible children
2770 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2771 * every attribute mapping in @tree_column, it will get a value from the set
2772 * column on the @iter, and use that value to set the attribute on the cell
2773 * renderer. This is used primarily by the #GtkTreeView.
2776 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2777 GtkTreeModel *tree_model,
2779 gboolean is_expander,
2780 gboolean is_expanded)
2782 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2784 if (tree_model == NULL)
2787 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2788 is_expander, is_expanded);
2792 * gtk_tree_view_column_cell_get_size:
2793 * @tree_column: A #GtkTreeViewColumn.
2794 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2795 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2796 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2797 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2798 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2800 * Obtains the width and height needed to render the column. This is used
2801 * primarily by the #GtkTreeView.
2804 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2805 const GdkRectangle *cell_area,
2811 GtkTreeViewColumnPrivate *priv;
2812 gint min_width = 0, min_height = 0;
2814 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2816 priv = tree_column->priv;
2818 g_signal_handler_block (priv->cell_area_context,
2819 priv->context_changed_signal);
2821 gtk_cell_area_get_preferred_width (priv->cell_area,
2822 priv->cell_area_context,
2826 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2828 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2829 priv->cell_area_context,
2835 g_signal_handler_unblock (priv->cell_area_context,
2836 priv->context_changed_signal);
2840 * height = min_height;
2842 * width = min_width;
2847 * gtk_tree_view_column_cell_render:
2848 * @tree_column: A #GtkTreeViewColumn.
2849 * @cr: cairo context to draw to
2850 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2851 * @cell_area: area normally rendered by a cell renderer
2852 * @flags: flags that affect rendering
2854 * Renders the cell contained by #tree_column. This is used primarily by the
2858 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2860 const GdkRectangle *background_area,
2861 const GdkRectangle *cell_area,
2863 gboolean draw_focus)
2865 GtkTreeViewColumnPrivate *priv;
2867 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2868 g_return_if_fail (cr != NULL);
2869 g_return_if_fail (background_area != NULL);
2870 g_return_if_fail (cell_area != NULL);
2872 priv = tree_column->priv;
2876 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2877 priv->tree_view, cr,
2878 background_area, cell_area, flags,
2885 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2887 const GdkRectangle *cell_area,
2890 GtkTreeViewColumnPrivate *priv;
2892 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2894 priv = tree_column->priv;
2896 return gtk_cell_area_event (priv->cell_area,
2897 priv->cell_area_context,
2905 * gtk_tree_view_column_cell_is_visible:
2906 * @tree_column: A #GtkTreeViewColumn
2908 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2909 * For this to be meaningful, you must first initialize the cells with
2910 * gtk_tree_view_column_cell_set_cell_data()
2912 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2915 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2919 GtkTreeViewColumnPrivate *priv;
2921 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2923 priv = tree_column->priv;
2925 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2926 for (list = cells; list; list = list->next)
2928 if (gtk_cell_renderer_get_visible (list->data))
2930 g_list_free (cells);
2935 g_list_free (cells);
2941 * gtk_tree_view_column_focus_cell:
2942 * @tree_column: A #GtkTreeViewColumn
2943 * @cell: A #GtkCellRenderer
2945 * Sets the current keyboard focus to be at @cell, if the column contains
2946 * 2 or more editable and activatable cells.
2951 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2952 GtkCellRenderer *cell)
2954 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2955 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2957 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2961 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2962 gboolean install_handler)
2964 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2970 /* Issue a manual reset on the context to have all
2971 * sizes re-requested for the context.
2973 g_signal_handler_block (priv->cell_area_context,
2974 priv->context_changed_signal);
2975 gtk_cell_area_context_reset (priv->cell_area_context);
2976 g_signal_handler_unblock (priv->cell_area_context,
2977 priv->context_changed_signal);
2979 if (priv->tree_view &&
2980 gtk_widget_get_realized (priv->tree_view))
2982 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2983 gtk_widget_queue_resize (priv->tree_view);
2988 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2990 return tree_column->priv->dirty;
2994 * gtk_tree_view_column_cell_get_position:
2995 * @tree_column: a #GtkTreeViewColumn
2996 * @cell_renderer: a #GtkCellRenderer
2997 * @x_offset: return location for the horizontal position of @cell within
2998 * @tree_column, may be %NULL
2999 * @width: return location for the width of @cell, may be %NULL
3001 * Obtains the horizontal position and size of a cell in a column. If the
3002 * cell is not found in the column, @start_pos and @width are not changed and
3003 * %FALSE is returned.
3005 * Return value: %TRUE if @cell belongs to @tree_column.
3008 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
3009 GtkCellRenderer *cell_renderer,
3013 GtkTreeViewColumnPrivate *priv;
3014 GdkRectangle cell_area;
3015 GdkRectangle allocation;
3017 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
3018 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
3020 priv = tree_column->priv;
3022 gtk_tree_view_get_background_area (GTK_TREE_VIEW (priv->tree_view),
3023 NULL, tree_column, &cell_area);
3025 gtk_cell_area_get_cell_allocation (priv->cell_area,
3026 priv->cell_area_context,
3034 GdkRectangle button_allocation;
3036 /* Retrieve column offset */
3037 gtk_widget_get_allocation (priv->button, &button_allocation);
3038 *x_offset = allocation.x - button_allocation.x;
3041 *width = allocation.width;
3047 * gtk_tree_view_column_queue_resize:
3048 * @tree_column: A #GtkTreeViewColumn
3050 * Flags the column, and the cell renderers added to this column, to have
3051 * their sizes renegotiated.
3056 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
3058 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
3060 if (tree_column->priv->tree_view)
3061 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
3065 * gtk_tree_view_column_get_tree_view:
3066 * @tree_column: A #GtkTreeViewColumn
3068 * Returns the #GtkTreeView wherein @tree_column has been inserted.
3069 * If @column is currently not inserted in any tree view, %NULL is
3072 * Return value: (transfer none): The tree view wherein @column has
3073 * been inserted if any, %NULL otherwise.
3078 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
3080 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3082 return tree_column->priv->tree_view;
3086 * gtk_tree_view_column_get_button:
3087 * @tree_column: A #GtkTreeViewColumn
3089 * Returns the button used in the treeview column header
3091 * Return value: (transfer none): The button for the column header.
3096 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3098 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3100 return tree_column->priv->button;
3104 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3106 return column->priv->window;
3110 _gtk_tree_view_column_push_padding (GtkTreeViewColumn *column,
3113 column->priv->padding = MAX (column->priv->padding, padding);
3117 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3119 gint requested_width;
3121 gtk_cell_area_context_get_preferred_width (column->priv->cell_area_context, &requested_width, NULL);
3123 return requested_width + column->priv->padding;
3128 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3131 column->priv->resized_width = width;
3135 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3137 return column->priv->resized_width;
3141 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3142 gboolean use_resized_width)
3144 column->priv->use_resized_width = use_resized_width;
3148 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3150 return column->priv->use_resized_width;
3154 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3156 return column->priv->drag_x;
3159 GtkCellAreaContext *
3160 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3162 return column->priv->cell_area_context;