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"
42 * SECTION:gtktreeviewcolumn
43 * @Short_description: A visible column in a GtkTreeView widget
44 * @Title: GtkTreeViewColumn
45 * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable,
46 * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
47 * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle
49 * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
50 * It allows to set properties of the column header, and functions as a holding pen for
51 * the cell renderers which determine how the data in the column is displayed.
53 * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
54 * for an overview of all the objects and data types related to the tree widget and how
60 static void gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface);
63 static void gtk_tree_view_column_set_property (GObject *object,
67 static void gtk_tree_view_column_get_property (GObject *object,
71 static void gtk_tree_view_column_finalize (GObject *object);
72 static void gtk_tree_view_column_dispose (GObject *object);
73 static GObject *gtk_tree_view_column_constructor (GType type,
74 guint n_construct_properties,
75 GObjectConstructParam *construct_properties);
77 /* GtkCellLayout implementation */
78 static GtkCellArea *gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout);
80 /* Button handling code */
81 static void gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column);
82 static void gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column);
84 /* Button signal handlers */
85 static gint gtk_tree_view_column_button_event (GtkWidget *widget,
88 static void gtk_tree_view_column_button_clicked (GtkWidget *widget,
90 static gboolean gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
91 gboolean group_cycling,
94 /* Property handlers */
95 static void gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
96 GtkTreeViewColumn *tree_column);
98 /* GtkCellArea/GtkCellAreaContext callbacks */
99 static void gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
101 GtkTreeViewColumn *tree_column);
102 static void gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
103 GtkCellRenderer *renderer,
104 GtkCellEditable *edit_widget,
105 GdkRectangle *cell_area,
106 const gchar *path_string,
108 static void gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
109 GtkCellRenderer *renderer,
110 GtkCellEditable *edit_widget,
113 /* Internal functions */
114 static void gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
116 static void gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column);
117 static void gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
118 GtkCellRenderer *cell_renderer,
121 /* GtkBuildable implementation */
122 static void gtk_tree_view_column_buildable_init (GtkBuildableIface *iface);
125 struct _GtkTreeViewColumnPrivate
127 GtkWidget *tree_view;
131 GtkWidget *alignment;
134 gulong property_changed_signal;
137 /* see gtk+/doc/tree-column-sizing.txt for more information on them */
138 GtkTreeViewColumnSizing column_type;
139 gint requested_width;
146 /* dragging columns */
153 gulong sort_clicked_signal;
154 gulong sort_column_changed_signal;
156 GtkSortType sort_order;
159 GtkCellArea *cell_area;
160 GtkCellAreaContext *cell_area_context;
161 gulong add_editable_signal;
162 gulong remove_editable_signal;
163 gulong context_changed_signal;
170 guint show_sort_indicator : 1;
171 guint maybe_reordered : 1;
172 guint reorderable : 1;
173 guint use_resized_width : 1;
206 static guint tree_column_signals[LAST_SIGNAL] = { 0 };
208 G_DEFINE_TYPE_WITH_CODE (GtkTreeViewColumn, gtk_tree_view_column, G_TYPE_INITIALLY_UNOWNED,
209 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
210 gtk_tree_view_column_cell_layout_init)
211 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
212 gtk_tree_view_column_buildable_init))
216 gtk_tree_view_column_class_init (GtkTreeViewColumnClass *class)
218 GObjectClass *object_class;
220 object_class = (GObjectClass*) class;
222 class->clicked = NULL;
224 object_class->constructor = gtk_tree_view_column_constructor;
225 object_class->finalize = gtk_tree_view_column_finalize;
226 object_class->dispose = gtk_tree_view_column_dispose;
227 object_class->set_property = gtk_tree_view_column_set_property;
228 object_class->get_property = gtk_tree_view_column_get_property;
230 tree_column_signals[CLICKED] =
231 g_signal_new (I_("clicked"),
232 G_OBJECT_CLASS_TYPE (object_class),
234 G_STRUCT_OFFSET (GtkTreeViewColumnClass, clicked),
236 _gtk_marshal_VOID__VOID,
239 g_object_class_install_property (object_class,
241 g_param_spec_boolean ("visible",
243 P_("Whether to display the column"),
245 GTK_PARAM_READWRITE));
247 g_object_class_install_property (object_class,
249 g_param_spec_boolean ("resizable",
251 P_("Column is user-resizable"),
253 GTK_PARAM_READWRITE));
255 g_object_class_install_property (object_class,
257 g_param_spec_int ("width",
259 P_("Current width of the column"),
263 GTK_PARAM_READABLE));
264 g_object_class_install_property (object_class,
266 g_param_spec_int ("spacing",
268 P_("Space which is inserted between cells"),
272 GTK_PARAM_READWRITE));
273 g_object_class_install_property (object_class,
275 g_param_spec_enum ("sizing",
277 P_("Resize mode of the column"),
278 GTK_TYPE_TREE_VIEW_COLUMN_SIZING,
279 GTK_TREE_VIEW_COLUMN_GROW_ONLY,
280 GTK_PARAM_READWRITE));
282 g_object_class_install_property (object_class,
284 g_param_spec_int ("fixed-width",
286 P_("Current fixed width of the column"),
290 GTK_PARAM_READWRITE));
292 g_object_class_install_property (object_class,
294 g_param_spec_int ("min-width",
296 P_("Minimum allowed width of the column"),
300 GTK_PARAM_READWRITE));
302 g_object_class_install_property (object_class,
304 g_param_spec_int ("max-width",
306 P_("Maximum allowed width of the column"),
310 GTK_PARAM_READWRITE));
312 g_object_class_install_property (object_class,
314 g_param_spec_string ("title",
316 P_("Title to appear in column header"),
318 GTK_PARAM_READWRITE));
320 g_object_class_install_property (object_class,
322 g_param_spec_boolean ("expand",
324 P_("Column gets share of extra width allocated to the widget"),
326 GTK_PARAM_READWRITE));
328 g_object_class_install_property (object_class,
330 g_param_spec_boolean ("clickable",
332 P_("Whether the header can be clicked"),
334 GTK_PARAM_READWRITE));
337 g_object_class_install_property (object_class,
339 g_param_spec_object ("widget",
341 P_("Widget to put in column header button instead of column title"),
343 GTK_PARAM_READWRITE));
345 g_object_class_install_property (object_class,
347 g_param_spec_float ("alignment",
349 P_("X Alignment of the column header text or widget"),
353 GTK_PARAM_READWRITE));
355 g_object_class_install_property (object_class,
357 g_param_spec_boolean ("reorderable",
359 P_("Whether the column can be reordered around the headers"),
361 GTK_PARAM_READWRITE));
363 g_object_class_install_property (object_class,
365 g_param_spec_boolean ("sort-indicator",
366 P_("Sort indicator"),
367 P_("Whether to show a sort indicator"),
369 GTK_PARAM_READWRITE));
371 g_object_class_install_property (object_class,
373 g_param_spec_enum ("sort-order",
375 P_("Sort direction the sort indicator should indicate"),
378 GTK_PARAM_READWRITE));
381 * GtkTreeViewColumn:sort-column-id:
383 * Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
384 * clickable. Set to %-1 to make the column unsortable.
388 g_object_class_install_property (object_class,
390 g_param_spec_int ("sort-column-id",
391 P_("Sort column ID"),
392 P_("Logical sort column ID this column sorts on when selected for sorting"),
396 GTK_PARAM_READWRITE));
399 * GtkTreeViewColumn:cell-area:
401 * The #GtkCellArea used to layout cell renderers for this column.
405 g_object_class_install_property (object_class,
407 g_param_spec_object ("cell-area",
409 P_("The GtkCellArea used to layout cells"),
411 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
413 g_type_class_add_private (class, sizeof (GtkTreeViewColumnPrivate));
417 gtk_tree_view_column_custom_tag_end (GtkBuildable *buildable,
420 const gchar *tagname,
423 /* Just ignore the boolean return from here */
424 _gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data);
428 gtk_tree_view_column_buildable_init (GtkBuildableIface *iface)
430 iface->add_child = _gtk_cell_layout_buildable_add_child;
431 iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
432 iface->custom_tag_end = gtk_tree_view_column_custom_tag_end;
436 gtk_tree_view_column_cell_layout_init (GtkCellLayoutIface *iface)
438 iface->get_area = gtk_tree_view_column_cell_layout_get_area;
442 gtk_tree_view_column_init (GtkTreeViewColumn *tree_column)
444 GtkTreeViewColumnPrivate *priv;
446 tree_column->priv = G_TYPE_INSTANCE_GET_PRIVATE (tree_column,
447 GTK_TYPE_TREE_VIEW_COLUMN,
448 GtkTreeViewColumnPrivate);
449 priv = tree_column->priv;
454 priv->requested_width = -1;
455 priv->min_width = -1;
456 priv->max_width = -1;
457 priv->resized_width = 0;
458 priv->column_type = GTK_TREE_VIEW_COLUMN_GROW_ONLY;
459 priv->visible = TRUE;
460 priv->resizable = FALSE;
461 priv->expand = FALSE;
462 priv->clickable = FALSE;
464 priv->sort_order = GTK_SORT_ASCENDING;
465 priv->show_sort_indicator = FALSE;
466 priv->property_changed_signal = 0;
467 priv->sort_clicked_signal = 0;
468 priv->sort_column_changed_signal = 0;
469 priv->sort_column_id = -1;
470 priv->reorderable = FALSE;
471 priv->maybe_reordered = FALSE;
472 priv->fixed_width = 1;
473 priv->use_resized_width = FALSE;
474 priv->title = g_strdup ("");
478 gtk_tree_view_column_constructor (GType type,
479 guint n_construct_properties,
480 GObjectConstructParam *construct_properties)
482 GtkTreeViewColumn *tree_column;
483 GtkTreeViewColumnPrivate *priv;
486 object = G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->constructor
487 (type, n_construct_properties, construct_properties);
489 tree_column = (GtkTreeViewColumn *) object;
490 priv = tree_column->priv;
492 if (!priv->cell_area)
494 priv->cell_area = gtk_cell_area_box_new ();
495 g_object_ref_sink (priv->cell_area);
498 gtk_cell_area_set_style_detail (priv->cell_area, "treeview");
500 priv->add_editable_signal =
501 g_signal_connect (priv->cell_area, "add-editable",
502 G_CALLBACK (gtk_tree_view_column_add_editable_callback),
504 priv->remove_editable_signal =
505 g_signal_connect (priv->cell_area, "remove-editable",
506 G_CALLBACK (gtk_tree_view_column_remove_editable_callback),
509 priv->cell_area_context = gtk_cell_area_create_context (priv->cell_area);
511 priv->context_changed_signal =
512 g_signal_connect (priv->cell_area_context, "notify",
513 G_CALLBACK (gtk_tree_view_column_context_changed), tree_column);
519 gtk_tree_view_column_dispose (GObject *object)
521 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
522 GtkTreeViewColumnPrivate *priv = tree_column->priv;
524 if (priv->cell_area_context)
526 g_signal_handler_disconnect (priv->cell_area_context,
527 priv->context_changed_signal);
529 g_object_unref (priv->cell_area_context);
531 priv->cell_area_context = NULL;
532 priv->context_changed_signal = 0;
537 g_signal_handler_disconnect (priv->cell_area,
538 priv->add_editable_signal);
539 g_signal_handler_disconnect (priv->cell_area,
540 priv->remove_editable_signal);
542 g_object_unref (priv->cell_area);
543 priv->cell_area = NULL;
544 priv->add_editable_signal = 0;
545 priv->remove_editable_signal = 0;
550 g_object_unref (priv->child);
554 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->dispose (object);
558 gtk_tree_view_column_finalize (GObject *object)
560 GtkTreeViewColumn *tree_column = (GtkTreeViewColumn *) object;
561 GtkTreeViewColumnPrivate *priv = tree_column->priv;
563 g_free (priv->title);
565 G_OBJECT_CLASS (gtk_tree_view_column_parent_class)->finalize (object);
569 gtk_tree_view_column_set_property (GObject *object,
574 GtkTreeViewColumn *tree_column;
577 tree_column = GTK_TREE_VIEW_COLUMN (object);
582 gtk_tree_view_column_set_visible (tree_column,
583 g_value_get_boolean (value));
587 gtk_tree_view_column_set_resizable (tree_column,
588 g_value_get_boolean (value));
592 gtk_tree_view_column_set_sizing (tree_column,
593 g_value_get_enum (value));
596 case PROP_FIXED_WIDTH:
597 gtk_tree_view_column_set_fixed_width (tree_column,
598 g_value_get_int (value));
602 gtk_tree_view_column_set_min_width (tree_column,
603 g_value_get_int (value));
607 gtk_tree_view_column_set_max_width (tree_column,
608 g_value_get_int (value));
612 gtk_tree_view_column_set_spacing (tree_column,
613 g_value_get_int (value));
617 gtk_tree_view_column_set_title (tree_column,
618 g_value_get_string (value));
622 gtk_tree_view_column_set_expand (tree_column,
623 g_value_get_boolean (value));
627 gtk_tree_view_column_set_clickable (tree_column,
628 g_value_get_boolean (value));
632 gtk_tree_view_column_set_widget (tree_column,
633 (GtkWidget*) g_value_get_object (value));
637 gtk_tree_view_column_set_alignment (tree_column,
638 g_value_get_float (value));
641 case PROP_REORDERABLE:
642 gtk_tree_view_column_set_reorderable (tree_column,
643 g_value_get_boolean (value));
646 case PROP_SORT_INDICATOR:
647 gtk_tree_view_column_set_sort_indicator (tree_column,
648 g_value_get_boolean (value));
651 case PROP_SORT_ORDER:
652 gtk_tree_view_column_set_sort_order (tree_column,
653 g_value_get_enum (value));
656 case PROP_SORT_COLUMN_ID:
657 gtk_tree_view_column_set_sort_column_id (tree_column,
658 g_value_get_int (value));
662 /* Construct-only, can only be assigned once */
663 area = g_value_get_object (value);
666 tree_column->priv->cell_area = g_object_ref_sink (area);
670 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
676 gtk_tree_view_column_get_property (GObject *object,
681 GtkTreeViewColumn *tree_column;
683 tree_column = GTK_TREE_VIEW_COLUMN (object);
688 g_value_set_boolean (value,
689 gtk_tree_view_column_get_visible (tree_column));
693 g_value_set_boolean (value,
694 gtk_tree_view_column_get_resizable (tree_column));
698 g_value_set_int (value,
699 gtk_tree_view_column_get_width (tree_column));
703 g_value_set_int (value,
704 gtk_tree_view_column_get_spacing (tree_column));
708 g_value_set_enum (value,
709 gtk_tree_view_column_get_sizing (tree_column));
712 case PROP_FIXED_WIDTH:
713 g_value_set_int (value,
714 gtk_tree_view_column_get_fixed_width (tree_column));
718 g_value_set_int (value,
719 gtk_tree_view_column_get_min_width (tree_column));
723 g_value_set_int (value,
724 gtk_tree_view_column_get_max_width (tree_column));
728 g_value_set_string (value,
729 gtk_tree_view_column_get_title (tree_column));
733 g_value_set_boolean (value,
734 gtk_tree_view_column_get_expand (tree_column));
738 g_value_set_boolean (value,
739 gtk_tree_view_column_get_clickable (tree_column));
743 g_value_set_object (value,
744 (GObject*) gtk_tree_view_column_get_widget (tree_column));
748 g_value_set_float (value,
749 gtk_tree_view_column_get_alignment (tree_column));
752 case PROP_REORDERABLE:
753 g_value_set_boolean (value,
754 gtk_tree_view_column_get_reorderable (tree_column));
757 case PROP_SORT_INDICATOR:
758 g_value_set_boolean (value,
759 gtk_tree_view_column_get_sort_indicator (tree_column));
762 case PROP_SORT_ORDER:
763 g_value_set_enum (value,
764 gtk_tree_view_column_get_sort_order (tree_column));
767 case PROP_SORT_COLUMN_ID:
768 g_value_set_int (value,
769 gtk_tree_view_column_get_sort_column_id (tree_column));
773 g_value_set_object (value, tree_column->priv->cell_area);
777 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
782 /* Implementation of GtkCellLayout interface
785 gtk_tree_view_column_cell_layout_get_area (GtkCellLayout *cell_layout)
787 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (cell_layout);
788 GtkTreeViewColumnPrivate *priv = column->priv;
790 return priv->cell_area;
793 /* Button handling code
796 gtk_tree_view_column_create_button (GtkTreeViewColumn *tree_column)
798 GtkTreeViewColumnPrivate *priv = tree_column->priv;
799 GtkTreeView *tree_view;
803 tree_view = (GtkTreeView *) priv->tree_view;
805 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
806 g_return_if_fail (priv->button == NULL);
808 gtk_widget_push_composite_child ();
809 priv->button = gtk_button_new ();
810 gtk_widget_add_events (priv->button, GDK_POINTER_MOTION_MASK);
811 gtk_widget_pop_composite_child ();
813 /* make sure we own a reference to it as well. */
814 if (_gtk_tree_view_get_header_window (tree_view))
815 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
817 gtk_widget_set_parent (priv->button, GTK_WIDGET (tree_view));
819 g_signal_connect (priv->button, "event",
820 G_CALLBACK (gtk_tree_view_column_button_event),
822 g_signal_connect (priv->button, "clicked",
823 G_CALLBACK (gtk_tree_view_column_button_clicked),
826 priv->alignment = gtk_alignment_new (priv->xalign, 0.5, 0.0, 0.0);
828 hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 2);
829 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_IN);
835 child = gtk_label_new (priv->title);
836 gtk_widget_show (child);
839 g_signal_connect (child, "mnemonic-activate",
840 G_CALLBACK (gtk_tree_view_column_mnemonic_activate),
843 if (priv->xalign <= 0.5)
844 gtk_box_pack_end (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
846 gtk_box_pack_start (GTK_BOX (hbox), priv->arrow, FALSE, FALSE, 0);
848 gtk_box_pack_start (GTK_BOX (hbox), priv->alignment, TRUE, TRUE, 0);
850 gtk_container_add (GTK_CONTAINER (priv->alignment), child);
851 gtk_container_add (GTK_CONTAINER (priv->button), hbox);
853 gtk_widget_show (hbox);
854 gtk_widget_show (priv->alignment);
855 gtk_tree_view_column_update_button (tree_column);
859 gtk_tree_view_column_update_button (GtkTreeViewColumn *tree_column)
861 GtkTreeViewColumnPrivate *priv = tree_column->priv;
862 gint sort_column_id = -1;
864 GtkWidget *alignment;
866 GtkWidget *current_child;
867 GtkArrowType arrow_type = GTK_ARROW_NONE;
871 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
875 /* Create a button if necessary */
877 priv->button == NULL &&
879 gtk_widget_get_realized (priv->tree_view))
880 gtk_tree_view_column_create_button (tree_column);
885 hbox = gtk_bin_get_child (GTK_BIN (priv->button));
886 alignment = priv->alignment;
888 current_child = gtk_bin_get_child (GTK_BIN (alignment));
890 /* Set up the actual button */
891 gtk_alignment_set (GTK_ALIGNMENT (alignment), priv->xalign,
896 if (current_child != priv->child)
898 gtk_container_remove (GTK_CONTAINER (alignment),
900 gtk_container_add (GTK_CONTAINER (alignment),
906 if (current_child == NULL)
908 current_child = gtk_label_new (NULL);
909 gtk_widget_show (current_child);
910 gtk_container_add (GTK_CONTAINER (alignment),
914 g_return_if_fail (GTK_IS_LABEL (current_child));
917 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
920 gtk_label_set_text_with_mnemonic (GTK_LABEL (current_child),
924 if (GTK_IS_TREE_SORTABLE (model))
925 gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
929 if (priv->show_sort_indicator)
931 gboolean alternative;
933 g_object_get (gtk_widget_get_settings (priv->tree_view),
934 "gtk-alternative-sort-arrows", &alternative,
937 switch (priv->sort_order)
939 case GTK_SORT_ASCENDING:
940 arrow_type = alternative ? GTK_ARROW_UP : GTK_ARROW_DOWN;
943 case GTK_SORT_DESCENDING:
944 arrow_type = alternative ? GTK_ARROW_DOWN : GTK_ARROW_UP;
948 g_warning (G_STRLOC": bad sort order");
953 gtk_arrow_set (GTK_ARROW (arrow),
957 /* Put arrow on the right if the text is left-or-center justified, and on the
958 * left otherwise; do this by packing boxes, so flipping text direction will
961 g_object_ref (arrow);
962 gtk_container_remove (GTK_CONTAINER (hbox), arrow);
964 if (priv->xalign <= 0.5)
966 gtk_box_pack_end (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
970 gtk_box_pack_start (GTK_BOX (hbox), arrow, FALSE, FALSE, 0);
971 /* move it to the front */
972 gtk_box_reorder_child (GTK_BOX (hbox), arrow, 0);
974 g_object_unref (arrow);
976 if (priv->show_sort_indicator
977 || (GTK_IS_TREE_SORTABLE (model) && priv->sort_column_id >= 0))
978 gtk_widget_show (arrow);
980 gtk_widget_hide (arrow);
982 /* It's always safe to hide the button. It isn't always safe to show it, as
983 * if you show it before it's realized, it'll get the wrong window. */
985 priv->tree_view != NULL &&
986 gtk_widget_get_realized (priv->tree_view))
990 gtk_widget_show_now (priv->button);
995 gdk_window_show (priv->window);
996 gdk_window_raise (priv->window);
1000 gdk_window_hide (priv->window);
1006 gtk_widget_hide (priv->button);
1008 gdk_window_hide (priv->window);
1012 if (priv->reorderable || priv->clickable)
1014 gtk_widget_set_can_focus (priv->button, TRUE);
1018 gtk_widget_set_can_focus (priv->button, FALSE);
1019 if (gtk_widget_has_focus (priv->button))
1021 GtkWidget *toplevel = gtk_widget_get_toplevel (priv->tree_view);
1022 if (gtk_widget_is_toplevel (toplevel))
1024 gtk_window_set_focus (GTK_WINDOW (toplevel), NULL);
1028 /* Queue a resize on the assumption that we always want to catch all changes
1029 * and columns don't change all that often.
1031 if (gtk_widget_get_realized (priv->tree_view))
1032 gtk_widget_queue_resize (priv->tree_view);
1036 /* Button signal handlers
1040 gtk_tree_view_column_button_event (GtkWidget *widget,
1044 GtkTreeViewColumn *column = (GtkTreeViewColumn *) data;
1045 GtkTreeViewColumnPrivate *priv = column->priv;
1047 g_return_val_if_fail (event != NULL, FALSE);
1049 if (event->type == GDK_BUTTON_PRESS &&
1050 priv->reorderable &&
1051 ((GdkEventButton *)event)->button == 1)
1053 priv->maybe_reordered = TRUE;
1054 gdk_window_get_pointer (gtk_button_get_event_window (GTK_BUTTON (widget)),
1058 gtk_widget_grab_focus (widget);
1061 if (event->type == GDK_BUTTON_RELEASE ||
1062 event->type == GDK_LEAVE_NOTIFY)
1063 priv->maybe_reordered = FALSE;
1065 if (event->type == GDK_MOTION_NOTIFY &&
1066 priv->maybe_reordered &&
1067 (gtk_drag_check_threshold (widget,
1070 (gint) ((GdkEventMotion *)event)->x,
1071 (gint) ((GdkEventMotion *)event)->y)))
1073 priv->maybe_reordered = FALSE;
1074 _gtk_tree_view_column_start_drag (GTK_TREE_VIEW (priv->tree_view), column,
1075 event->motion.device);
1079 if (priv->clickable == FALSE)
1081 switch (event->type)
1083 case GDK_BUTTON_PRESS:
1084 case GDK_2BUTTON_PRESS:
1085 case GDK_3BUTTON_PRESS:
1086 case GDK_MOTION_NOTIFY:
1087 case GDK_BUTTON_RELEASE:
1088 case GDK_ENTER_NOTIFY:
1089 case GDK_LEAVE_NOTIFY:
1100 gtk_tree_view_column_button_clicked (GtkWidget *widget, gpointer data)
1102 g_signal_emit_by_name (data, "clicked");
1106 gtk_tree_view_column_mnemonic_activate (GtkWidget *widget,
1107 gboolean group_cycling,
1110 GtkTreeViewColumn *column = (GtkTreeViewColumn *)data;
1111 GtkTreeViewColumnPrivate *priv = column->priv;
1113 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (column), FALSE);
1115 _gtk_tree_view_set_focus_column (GTK_TREE_VIEW (priv->tree_view), column);
1117 if (priv->clickable)
1118 gtk_button_clicked (GTK_BUTTON (priv->button));
1119 else if (gtk_widget_get_can_focus (priv->button))
1120 gtk_widget_grab_focus (priv->button);
1122 gtk_widget_grab_focus (priv->tree_view);
1128 gtk_tree_view_model_sort_column_changed (GtkTreeSortable *sortable,
1129 GtkTreeViewColumn *column)
1131 GtkTreeViewColumnPrivate *priv = column->priv;
1132 gint sort_column_id;
1135 if (gtk_tree_sortable_get_sort_column_id (sortable,
1139 if (sort_column_id == priv->sort_column_id)
1141 gtk_tree_view_column_set_sort_indicator (column, TRUE);
1142 gtk_tree_view_column_set_sort_order (column, order);
1146 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1151 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1156 gtk_tree_view_column_sort (GtkTreeViewColumn *tree_column,
1159 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1160 GtkTreeModel *model;
1161 GtkTreeSortable *sortable;
1162 gint sort_column_id;
1164 gboolean has_sort_column;
1165 gboolean has_default_sort_func;
1167 g_return_if_fail (priv->tree_view != NULL);
1169 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1170 sortable = GTK_TREE_SORTABLE (model);
1173 gtk_tree_sortable_get_sort_column_id (sortable,
1176 has_default_sort_func =
1177 gtk_tree_sortable_has_default_sort_func (sortable);
1179 if (has_sort_column &&
1180 sort_column_id == priv->sort_column_id)
1182 if (order == GTK_SORT_ASCENDING)
1183 gtk_tree_sortable_set_sort_column_id (sortable,
1184 priv->sort_column_id,
1185 GTK_SORT_DESCENDING);
1186 else if (order == GTK_SORT_DESCENDING && has_default_sort_func)
1187 gtk_tree_sortable_set_sort_column_id (sortable,
1188 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID,
1189 GTK_SORT_ASCENDING);
1191 gtk_tree_sortable_set_sort_column_id (sortable,
1192 priv->sort_column_id,
1193 GTK_SORT_ASCENDING);
1197 gtk_tree_sortable_set_sort_column_id (sortable,
1198 priv->sort_column_id,
1199 GTK_SORT_ASCENDING);
1204 gtk_tree_view_column_setup_sort_column_id_callback (GtkTreeViewColumn *tree_column)
1206 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1207 GtkTreeModel *model;
1209 if (priv->tree_view == NULL)
1212 model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
1217 if (GTK_IS_TREE_SORTABLE (model) &&
1218 priv->sort_column_id != -1)
1220 gint real_sort_column_id;
1221 GtkSortType real_order;
1223 if (priv->sort_column_changed_signal == 0)
1224 priv->sort_column_changed_signal =
1225 g_signal_connect (model, "sort-column-changed",
1226 G_CALLBACK (gtk_tree_view_model_sort_column_changed),
1229 if (gtk_tree_sortable_get_sort_column_id (GTK_TREE_SORTABLE (model),
1230 &real_sort_column_id,
1232 (real_sort_column_id == priv->sort_column_id))
1234 gtk_tree_view_column_set_sort_indicator (tree_column, TRUE);
1235 gtk_tree_view_column_set_sort_order (tree_column, real_order);
1239 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
1245 gtk_tree_view_column_context_changed (GtkCellAreaContext *context,
1247 GtkTreeViewColumn *tree_column)
1249 if (!strcmp (pspec->name, "minimum-width") ||
1250 !strcmp (pspec->name, "natural-width") ||
1251 !strcmp (pspec->name, "minimum-height") ||
1252 !strcmp (pspec->name, "natural-height"))
1254 /* XXX We want to do something specific if the size actually got cleared
1255 * or if it just grew a little bit because of a data change and we
1256 * are in GROW_ONLY mode.
1258 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1263 gtk_tree_view_column_add_editable_callback (GtkCellArea *area,
1264 GtkCellRenderer *renderer,
1265 GtkCellEditable *edit_widget,
1266 GdkRectangle *cell_area,
1267 const gchar *path_string,
1270 GtkTreeViewColumn *column = user_data;
1271 GtkTreeViewColumnPrivate *priv = column->priv;
1274 if (priv->tree_view)
1276 path = gtk_tree_path_new_from_string (path_string);
1278 _gtk_tree_view_add_editable (GTK_TREE_VIEW (priv->tree_view),
1284 gtk_tree_path_free (path);
1289 gtk_tree_view_column_remove_editable_callback (GtkCellArea *area,
1290 GtkCellRenderer *renderer,
1291 GtkCellEditable *edit_widget,
1294 GtkTreeViewColumn *column = user_data;
1295 GtkTreeViewColumnPrivate *priv = column->priv;
1297 if (priv->tree_view)
1298 _gtk_tree_view_remove_editable (GTK_TREE_VIEW (priv->tree_view),
1303 /* Exported Private Functions.
1304 * These should only be called by gtktreeview.c or gtktreeviewcolumn.c
1307 _gtk_tree_view_column_realize_button (GtkTreeViewColumn *column)
1309 GtkTreeViewColumnPrivate *priv = column->priv;
1310 GtkAllocation allocation;
1311 GtkTreeView *tree_view;
1313 guint attributes_mask;
1316 tree_view = (GtkTreeView *)priv->tree_view;
1317 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
1319 g_return_if_fail (GTK_IS_TREE_VIEW (tree_view));
1320 g_return_if_fail (gtk_widget_get_realized (priv->tree_view));
1321 g_return_if_fail (priv->button != NULL);
1323 g_return_if_fail (_gtk_tree_view_get_header_window (tree_view) != NULL);
1324 gtk_widget_set_parent_window (priv->button, _gtk_tree_view_get_header_window (tree_view));
1327 gtk_widget_show (priv->button);
1329 attr.window_type = GDK_WINDOW_CHILD;
1330 attr.wclass = GDK_INPUT_ONLY;
1331 attr.visual = gtk_widget_get_visual (GTK_WIDGET (tree_view));
1332 attr.event_mask = gtk_widget_get_events (GTK_WIDGET (tree_view)) |
1333 (GDK_BUTTON_PRESS_MASK |
1334 GDK_BUTTON_RELEASE_MASK |
1335 GDK_POINTER_MOTION_MASK |
1336 GDK_POINTER_MOTION_HINT_MASK |
1337 GDK_KEY_PRESS_MASK);
1338 attributes_mask = GDK_WA_CURSOR | GDK_WA_X | GDK_WA_Y;
1339 attr.cursor = gdk_cursor_new_for_display
1340 (gdk_window_get_display (_gtk_tree_view_get_header_window (tree_view)), GDK_SB_H_DOUBLE_ARROW);
1342 attr.width = TREE_VIEW_DRAG_WIDTH;
1343 attr.height = _gtk_tree_view_get_header_height (tree_view);
1345 gtk_widget_get_allocation (priv->button, &allocation);
1346 attr.x = (allocation.x + (rtl ? 0 : allocation.width)) - TREE_VIEW_DRAG_WIDTH / 2;
1347 priv->window = gdk_window_new (_gtk_tree_view_get_header_window (tree_view),
1348 &attr, attributes_mask);
1349 gdk_window_set_user_data (priv->window, tree_view);
1351 gtk_tree_view_column_update_button (column);
1353 gdk_cursor_unref (attr.cursor);
1357 _gtk_tree_view_column_unrealize_button (GtkTreeViewColumn *column)
1359 GtkTreeViewColumnPrivate *priv;
1361 g_return_if_fail (column != NULL);
1363 priv = column->priv;
1364 g_return_if_fail (priv->window != NULL);
1366 gdk_window_set_user_data (priv->window, NULL);
1367 gdk_window_destroy (priv->window);
1368 priv->window = NULL;
1372 _gtk_tree_view_column_unset_model (GtkTreeViewColumn *column,
1373 GtkTreeModel *old_model)
1375 GtkTreeViewColumnPrivate *priv = column->priv;
1377 if (priv->sort_column_changed_signal)
1379 g_signal_handler_disconnect (old_model,
1380 priv->sort_column_changed_signal);
1381 priv->sort_column_changed_signal = 0;
1383 gtk_tree_view_column_set_sort_indicator (column, FALSE);
1387 _gtk_tree_view_column_set_tree_view (GtkTreeViewColumn *column,
1388 GtkTreeView *tree_view)
1390 GtkTreeViewColumnPrivate *priv = column->priv;
1392 g_assert (priv->tree_view == NULL);
1394 priv->tree_view = GTK_WIDGET (tree_view);
1395 gtk_tree_view_column_create_button (column);
1397 priv->property_changed_signal =
1398 g_signal_connect_swapped (tree_view,
1400 G_CALLBACK (gtk_tree_view_column_setup_sort_column_id_callback),
1403 gtk_tree_view_column_setup_sort_column_id_callback (column);
1407 _gtk_tree_view_column_unset_tree_view (GtkTreeViewColumn *column)
1409 GtkTreeViewColumnPrivate *priv = column->priv;
1411 if (priv->tree_view && priv->button)
1413 gtk_container_remove (GTK_CONTAINER (priv->tree_view), priv->button);
1415 if (priv->property_changed_signal)
1417 g_signal_handler_disconnect (priv->tree_view, priv->property_changed_signal);
1418 priv->property_changed_signal = 0;
1421 if (priv->sort_column_changed_signal)
1423 g_signal_handler_disconnect (gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view)),
1424 priv->sort_column_changed_signal);
1425 priv->sort_column_changed_signal = 0;
1428 priv->tree_view = NULL;
1429 priv->button = NULL;
1433 _gtk_tree_view_column_has_editable_cell (GtkTreeViewColumn *column)
1435 GtkTreeViewColumnPrivate *priv = column->priv;
1436 gboolean ret = FALSE;
1437 GList *list, *cells;
1439 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
1441 for (list = cells; list; list = list->next)
1443 GtkCellRenderer *cell = list->data;
1444 GtkCellRendererMode mode;
1446 g_object_get (cell, "mode", &mode, NULL);
1448 if (mode == GTK_CELL_RENDERER_MODE_EDITABLE)
1455 g_list_free (cells);
1460 /* gets cell being edited */
1462 _gtk_tree_view_column_get_edited_cell (GtkTreeViewColumn *column)
1464 GtkTreeViewColumnPrivate *priv = column->priv;
1466 return gtk_cell_area_get_edited_cell (priv->cell_area);
1470 _gtk_tree_view_column_get_cell_at_pos (GtkTreeViewColumn *column,
1475 GtkCellRenderer *match = NULL;
1476 GtkTreeViewColumnPrivate *priv = column->priv;
1478 list = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column));
1479 for (cell = list; cell; cell = cell->next)
1481 GdkRectangle zero_cell_area = { 0, };
1482 GdkRectangle allocation;
1484 gtk_cell_area_get_cell_allocation (priv->cell_area,
1485 priv->cell_area_context,
1491 if (allocation.x <= x && x <= allocation.x + allocation.width)
1503 /* Public Functions */
1507 * gtk_tree_view_column_new:
1509 * Creates a new #GtkTreeViewColumn.
1511 * Return value: A newly created #GtkTreeViewColumn.
1514 gtk_tree_view_column_new (void)
1516 GtkTreeViewColumn *tree_column;
1518 tree_column = g_object_new (GTK_TYPE_TREE_VIEW_COLUMN, NULL);
1524 * gtk_tree_view_column_new_with_attributes:
1525 * @title: The title to set the header to.
1526 * @cell: The #GtkCellRenderer.
1527 * @Varargs: A %NULL-terminated list of attributes.
1529 * Creates a new #GtkTreeViewColumn with a number of default values. This is
1530 * equivalent to calling gtk_tree_view_column_set_title(),
1531 * gtk_tree_view_column_pack_start(), and
1532 * gtk_tree_view_column_set_attributes() on the newly created #GtkTreeViewColumn.
1534 * Here's a simple example:
1536 * enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS };
1539 * GtkTreeViewColumn *column;
1540 * GtkCellRenderer *renderer = gtk_cell_renderer_text_new ();
1542 * column = gtk_tree_view_column_new_with_attributes ("Title",
1544 * "text", TEXT_COLUMN,
1545 * "foreground", COLOR_COLUMN,
1550 * Return value: A newly created #GtkTreeViewColumn.
1553 gtk_tree_view_column_new_with_attributes (const gchar *title,
1554 GtkCellRenderer *cell,
1557 GtkTreeViewColumn *retval;
1560 retval = gtk_tree_view_column_new ();
1562 gtk_tree_view_column_set_title (retval, title);
1563 gtk_tree_view_column_pack_start (retval, cell, TRUE);
1565 va_start (args, cell);
1566 gtk_tree_view_column_set_attributesv (retval, cell, args);
1573 * gtk_tree_view_column_pack_start:
1574 * @tree_column: A #GtkTreeViewColumn.
1575 * @cell: The #GtkCellRenderer.
1576 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1578 * Packs the @cell into the beginning of the column. If @expand is %FALSE, then
1579 * the @cell is allocated no more space than it needs. Any unused space is divided
1580 * evenly between cells for which @expand is %TRUE.
1583 gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,
1584 GtkCellRenderer *cell,
1587 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (tree_column), cell, expand);
1591 * gtk_tree_view_column_pack_end:
1592 * @tree_column: A #GtkTreeViewColumn.
1593 * @cell: The #GtkCellRenderer.
1594 * @expand: %TRUE if @cell is to be given extra space allocated to @tree_column.
1596 * Adds the @cell to end of the column. If @expand is %FALSE, then the @cell
1597 * is allocated no more space than it needs. Any unused space is divided
1598 * evenly between cells for which @expand is %TRUE.
1601 gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,
1602 GtkCellRenderer *cell,
1605 gtk_cell_layout_pack_end (GTK_CELL_LAYOUT (tree_column), cell, expand);
1609 * gtk_tree_view_column_clear:
1610 * @tree_column: A #GtkTreeViewColumn
1612 * Unsets all the mappings on all renderers on the @tree_column.
1615 gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column)
1617 gtk_cell_layout_clear (GTK_CELL_LAYOUT (tree_column));
1621 * gtk_tree_view_column_add_attribute:
1622 * @tree_column: A #GtkTreeViewColumn.
1623 * @cell_renderer: the #GtkCellRenderer to set attributes on
1624 * @attribute: An attribute on the renderer
1625 * @column: The column position on the model to get the attribute from.
1627 * Adds an attribute mapping to the list in @tree_column. The @column is the
1628 * column of the model to get a value from, and the @attribute is the
1629 * parameter on @cell_renderer to be set from the value. So for example
1630 * if column 2 of the model contains strings, you could have the
1631 * "text" attribute of a #GtkCellRendererText get its values from
1635 gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,
1636 GtkCellRenderer *cell_renderer,
1637 const gchar *attribute,
1640 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (tree_column),
1641 cell_renderer, attribute, column);
1645 gtk_tree_view_column_set_attributesv (GtkTreeViewColumn *tree_column,
1646 GtkCellRenderer *cell_renderer,
1649 GtkTreeViewColumnPrivate *priv = tree_column->priv;
1653 attribute = va_arg (args, gchar *);
1655 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (priv->cell_area),
1658 while (attribute != NULL)
1660 column = va_arg (args, gint);
1661 gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (priv->cell_area),
1662 cell_renderer, attribute, column);
1663 attribute = va_arg (args, gchar *);
1668 * gtk_tree_view_column_set_attributes:
1669 * @tree_column: A #GtkTreeViewColumn.
1670 * @cell_renderer: the #GtkCellRenderer we're setting the attributes of
1671 * @Varargs: A %NULL-terminated list of attributes.
1673 * Sets the attributes in the list as the attributes of @tree_column.
1674 * The attributes should be in attribute/column order, as in
1675 * gtk_tree_view_column_add_attribute(). All existing attributes
1676 * are removed, and replaced with the new attributes.
1679 gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,
1680 GtkCellRenderer *cell_renderer,
1685 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1686 g_return_if_fail (GTK_IS_CELL_RENDERER (cell_renderer));
1688 va_start (args, cell_renderer);
1689 gtk_tree_view_column_set_attributesv (tree_column, cell_renderer, args);
1695 * gtk_tree_view_column_set_cell_data_func:
1696 * @tree_column: A #GtkTreeViewColumn
1697 * @cell_renderer: A #GtkCellRenderer
1698 * @func: The #GtkTreeViewColumnFunc to use.
1699 * @func_data: The user data for @func.
1700 * @destroy: The destroy notification for @func_data
1702 * Sets the #GtkTreeViewColumnFunc to use for the column. This
1703 * function is used instead of the standard attributes mapping for
1704 * setting the column value, and should set the value of @tree_column's
1705 * cell renderer as appropriate. @func may be %NULL to remove an
1709 gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,
1710 GtkCellRenderer *cell_renderer,
1711 GtkTreeCellDataFunc func,
1713 GDestroyNotify destroy)
1715 gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (tree_column),
1717 (GtkCellLayoutDataFunc)func,
1718 func_data, destroy);
1723 * gtk_tree_view_column_clear_attributes:
1724 * @tree_column: a #GtkTreeViewColumn
1725 * @cell_renderer: a #GtkCellRenderer to clear the attribute mapping on.
1727 * Clears all existing attributes previously set with
1728 * gtk_tree_view_column_set_attributes().
1731 gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,
1732 GtkCellRenderer *cell_renderer)
1734 gtk_cell_layout_clear_attributes (GTK_CELL_LAYOUT (tree_column),
1739 * gtk_tree_view_column_set_spacing:
1740 * @tree_column: A #GtkTreeViewColumn.
1741 * @spacing: distance between cell renderers in pixels.
1743 * Sets the spacing field of @tree_column, which is the number of pixels to
1744 * place between cell renderers packed into it.
1747 gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,
1750 GtkTreeViewColumnPrivate *priv;
1752 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1753 g_return_if_fail (spacing >= 0);
1755 priv = tree_column->priv;
1757 gtk_cell_area_box_set_spacing (GTK_CELL_AREA_BOX (priv->cell_area),
1759 if (priv->tree_view)
1760 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1764 * gtk_tree_view_column_get_spacing:
1765 * @tree_column: A #GtkTreeViewColumn.
1767 * Returns the spacing of @tree_column.
1769 * Return value: the spacing of @tree_column.
1772 gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column)
1774 GtkTreeViewColumnPrivate *priv;
1776 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1778 priv = tree_column->priv;
1780 return gtk_cell_area_box_get_spacing (GTK_CELL_AREA_BOX (priv->cell_area));
1783 /* Options for manipulating the columns */
1786 * gtk_tree_view_column_set_visible:
1787 * @tree_column: A #GtkTreeViewColumn.
1788 * @visible: %TRUE if the @tree_column is visible.
1790 * Sets the visibility of @tree_column.
1793 gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,
1796 GtkTreeViewColumnPrivate *priv;
1798 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1800 priv = tree_column->priv;
1801 visible = !! visible;
1803 if (priv->visible == visible)
1806 priv->visible = visible;
1809 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
1811 gtk_tree_view_column_update_button (tree_column);
1812 g_object_notify (G_OBJECT (tree_column), "visible");
1816 * gtk_tree_view_column_get_visible:
1817 * @tree_column: A #GtkTreeViewColumn.
1819 * Returns %TRUE if @tree_column is visible.
1821 * Return value: whether the column is visible or not. If it is visible, then
1822 * the tree will show the column.
1825 gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column)
1827 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1829 return tree_column->priv->visible;
1833 * gtk_tree_view_column_set_resizable:
1834 * @tree_column: A #GtkTreeViewColumn
1835 * @resizable: %TRUE, if the column can be resized
1837 * If @resizable is %TRUE, then the user can explicitly resize the column by
1838 * grabbing the outer edge of the column button. If resizable is %TRUE and
1839 * sizing mode of the column is #GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
1840 * mode is changed to #GTK_TREE_VIEW_COLUMN_GROW_ONLY.
1843 gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
1846 GtkTreeViewColumnPrivate *priv;
1848 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1850 priv = tree_column->priv;
1851 resizable = !! resizable;
1853 if (priv->resizable == resizable)
1856 priv->resizable = resizable;
1858 if (resizable && priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1859 gtk_tree_view_column_set_sizing (tree_column, GTK_TREE_VIEW_COLUMN_GROW_ONLY);
1861 gtk_tree_view_column_update_button (tree_column);
1863 g_object_notify (G_OBJECT (tree_column), "resizable");
1867 * gtk_tree_view_column_get_resizable:
1868 * @tree_column: A #GtkTreeViewColumn
1870 * Returns %TRUE if the @tree_column can be resized by the end user.
1872 * Return value: %TRUE, if the @tree_column can be resized.
1875 gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
1877 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
1879 return tree_column->priv->resizable;
1884 * gtk_tree_view_column_set_sizing:
1885 * @tree_column: A #GtkTreeViewColumn.
1886 * @type: The #GtkTreeViewColumnSizing.
1888 * Sets the growth behavior of @tree_column to @type.
1891 gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,
1892 GtkTreeViewColumnSizing type)
1894 GtkTreeViewColumnPrivate *priv;
1896 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
1898 priv = tree_column->priv;
1900 if (type == priv->column_type)
1903 if (type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
1904 gtk_tree_view_column_set_resizable (tree_column, FALSE);
1907 /* I was clearly on crack when I wrote this. I'm not sure what's supposed to
1908 * be below so I'll leave it until I figure it out.
1910 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE &&
1911 priv->requested_width != -1)
1913 gtk_tree_view_column_set_sizing (tree_column, priv->requested_width);
1916 priv->column_type = type;
1918 gtk_tree_view_column_update_button (tree_column);
1920 g_object_notify (G_OBJECT (tree_column), "sizing");
1924 * gtk_tree_view_column_get_sizing:
1925 * @tree_column: A #GtkTreeViewColumn.
1927 * Returns the current type of @tree_column.
1929 * Return value: The type of @tree_column.
1931 GtkTreeViewColumnSizing
1932 gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column)
1934 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1936 return tree_column->priv->column_type;
1940 * gtk_tree_view_column_get_width:
1941 * @tree_column: A #GtkTreeViewColumn.
1943 * Returns the current size of @tree_column in pixels.
1945 * Return value: The current width of @tree_column.
1948 gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column)
1950 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
1952 return tree_column->priv->width;
1956 _gtk_tree_view_column_request_width (GtkTreeViewColumn *tree_column)
1958 GtkTreeViewColumnPrivate *priv;
1959 gint real_requested_width;
1961 priv = tree_column->priv;
1963 if (priv->use_resized_width)
1965 real_requested_width = priv->resized_width;
1967 else if (priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
1969 real_requested_width = priv->fixed_width;
1971 else if (gtk_tree_view_get_headers_visible (GTK_TREE_VIEW (priv->tree_view)))
1973 gint button_request;
1975 gtk_widget_get_preferred_width (priv->button, &button_request, NULL);
1976 real_requested_width = MAX (priv->requested_width, button_request);
1980 real_requested_width = priv->requested_width;
1981 if (real_requested_width < 0)
1982 real_requested_width = 0;
1985 if (priv->min_width != -1)
1986 real_requested_width = MAX (real_requested_width, priv->min_width);
1988 if (priv->max_width != -1)
1989 real_requested_width = MIN (real_requested_width, priv->max_width);
1991 return real_requested_width;
1995 _gtk_tree_view_column_allocate (GtkTreeViewColumn *tree_column,
2000 GtkTreeViewColumnPrivate *priv;
2001 GtkAllocation allocation;
2004 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2006 priv = tree_column->priv;
2008 priv->width = width;
2010 gtk_cell_area_context_allocate (priv->cell_area_context, cell_width, -1);
2012 allocation.x = x_offset;
2014 allocation.width = width;
2015 allocation.height = _gtk_tree_view_get_header_height (GTK_TREE_VIEW (priv->tree_view));
2017 gtk_widget_size_allocate (priv->button, &allocation);
2021 rtl = (gtk_widget_get_direction (priv->tree_view) == GTK_TEXT_DIR_RTL);
2022 gdk_window_move_resize (priv->window,
2023 allocation.x + (rtl ? 0 : allocation.width) - TREE_VIEW_DRAG_WIDTH/2,
2025 TREE_VIEW_DRAG_WIDTH, allocation.height);
2028 g_object_notify (G_OBJECT (tree_column), "width");
2032 * gtk_tree_view_column_set_fixed_width:
2033 * @tree_column: A #GtkTreeViewColumn.
2034 * @fixed_width: The size to set @tree_column to. Must be greater than 0.
2036 * Sets the size of the column in pixels. This is meaningful only if the sizing
2037 * type is #GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to
2038 * the min/max width for the column. Please note that the min/max width of the
2039 * column doesn't actually affect the "fixed_width" property of the widget, just
2040 * the actual size when displayed.
2043 gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,
2046 GtkTreeViewColumnPrivate *priv;
2048 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2049 g_return_if_fail (fixed_width > 0);
2051 priv = tree_column->priv;
2053 priv->fixed_width = fixed_width;
2054 priv->use_resized_width = FALSE;
2056 if (priv->tree_view &&
2057 gtk_widget_get_realized (priv->tree_view) &&
2058 priv->column_type == GTK_TREE_VIEW_COLUMN_FIXED)
2060 gtk_widget_queue_resize (priv->tree_view);
2063 g_object_notify (G_OBJECT (tree_column), "fixed-width");
2067 * gtk_tree_view_column_get_fixed_width:
2068 * @tree_column: a #GtkTreeViewColumn
2070 * Gets the fixed width of the column. This value is only meaning may not be
2071 * the actual width of the column on the screen, just what is requested.
2073 * Return value: the fixed width of the column
2076 gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column)
2078 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2080 return tree_column->priv->fixed_width;
2084 * gtk_tree_view_column_set_min_width:
2085 * @tree_column: A #GtkTreeViewColumn.
2086 * @min_width: The minimum width of the column in pixels, or -1.
2088 * Sets the minimum width of the @tree_column. If @min_width is -1, then the
2089 * minimum width is unset.
2092 gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,
2095 GtkTreeViewColumnPrivate *priv;
2097 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2098 g_return_if_fail (min_width >= -1);
2100 priv = tree_column->priv;
2102 if (min_width == priv->min_width)
2105 if (priv->visible &&
2106 priv->tree_view != NULL &&
2107 gtk_widget_get_realized (priv->tree_view))
2109 if (min_width > priv->width)
2110 gtk_widget_queue_resize (priv->tree_view);
2113 priv->min_width = min_width;
2114 g_object_freeze_notify (G_OBJECT (tree_column));
2115 if (priv->max_width != -1 && priv->max_width < min_width)
2117 priv->max_width = min_width;
2118 g_object_notify (G_OBJECT (tree_column), "max-width");
2120 g_object_notify (G_OBJECT (tree_column), "min-width");
2121 g_object_thaw_notify (G_OBJECT (tree_column));
2123 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2124 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2129 * gtk_tree_view_column_get_min_width:
2130 * @tree_column: A #GtkTreeViewColumn.
2132 * Returns the minimum width in pixels of the @tree_column, or -1 if no minimum
2135 * Return value: The minimum width of the @tree_column.
2138 gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column)
2140 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2142 return tree_column->priv->min_width;
2146 * gtk_tree_view_column_set_max_width:
2147 * @tree_column: A #GtkTreeViewColumn.
2148 * @max_width: The maximum width of the column in pixels, or -1.
2150 * Sets the maximum width of the @tree_column. If @max_width is -1, then the
2151 * maximum width is unset. Note, the column can actually be wider than max
2152 * width if it's the last column in a view. In this case, the column expands to
2153 * fill any extra space.
2156 gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,
2159 GtkTreeViewColumnPrivate *priv;
2161 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2162 g_return_if_fail (max_width >= -1);
2164 priv = tree_column->priv;
2166 if (max_width == priv->max_width)
2169 if (priv->visible &&
2170 priv->tree_view != NULL &&
2171 gtk_widget_get_realized (priv->tree_view))
2173 if (max_width != -1 && max_width < priv->width)
2174 gtk_widget_queue_resize (priv->tree_view);
2177 priv->max_width = max_width;
2178 g_object_freeze_notify (G_OBJECT (tree_column));
2179 if (max_width != -1 && max_width < priv->min_width)
2181 priv->min_width = max_width;
2182 g_object_notify (G_OBJECT (tree_column), "min-width");
2184 g_object_notify (G_OBJECT (tree_column), "max-width");
2185 g_object_thaw_notify (G_OBJECT (tree_column));
2187 if (priv->column_type == GTK_TREE_VIEW_COLUMN_AUTOSIZE)
2188 _gtk_tree_view_column_autosize (GTK_TREE_VIEW (priv->tree_view),
2193 * gtk_tree_view_column_get_max_width:
2194 * @tree_column: A #GtkTreeViewColumn.
2196 * Returns the maximum width in pixels of the @tree_column, or -1 if no maximum
2199 * Return value: The maximum width of the @tree_column.
2202 gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column)
2204 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), -1);
2206 return tree_column->priv->max_width;
2210 * gtk_tree_view_column_clicked:
2211 * @tree_column: a #GtkTreeViewColumn
2213 * Emits the "clicked" signal on the column. This function will only work if
2214 * @tree_column is clickable.
2217 gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column)
2219 GtkTreeViewColumnPrivate *priv;
2221 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2223 priv = tree_column->priv;
2225 if (priv->visible &&
2228 gtk_button_clicked (GTK_BUTTON (priv->button));
2232 * gtk_tree_view_column_set_title:
2233 * @tree_column: A #GtkTreeViewColumn.
2234 * @title: The title of the @tree_column.
2236 * Sets the title of the @tree_column. If a custom widget has been set, then
2237 * this value is ignored.
2240 gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,
2243 GtkTreeViewColumnPrivate *priv;
2246 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2248 priv = tree_column->priv;
2250 new_title = g_strdup (title);
2251 g_free (priv->title);
2252 priv->title = new_title;
2254 gtk_tree_view_column_update_button (tree_column);
2255 g_object_notify (G_OBJECT (tree_column), "title");
2259 * gtk_tree_view_column_get_title:
2260 * @tree_column: A #GtkTreeViewColumn.
2262 * Returns the title of the widget.
2264 * Return value: the title of the column. This string should not be
2265 * modified or freed.
2267 G_CONST_RETURN gchar *
2268 gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
2270 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2272 return tree_column->priv->title;
2276 * gtk_tree_view_column_set_expand:
2277 * @tree_column: A #GtkTreeViewColumn
2278 * @expand: %TRUE if the column should take available extra space, %FALSE if not
2280 * Sets the column to take available extra space. This space is shared equally
2281 * amongst all columns that have the expand set to %TRUE. If no column has this
2282 * option set, then the last column gets all extra space. By default, every
2283 * column is created with this %FALSE.
2288 gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
2291 GtkTreeViewColumnPrivate *priv;
2293 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2295 priv = tree_column->priv;
2297 expand = expand?TRUE:FALSE;
2298 if (priv->expand == expand)
2300 priv->expand = expand;
2302 if (priv->visible &&
2303 priv->tree_view != NULL &&
2304 gtk_widget_get_realized (priv->tree_view))
2306 /* We want to continue using the original width of the
2307 * column that includes additional space added by the user
2308 * resizing the columns and possibly extra (expanded) space, which
2309 * are not included in the resized width.
2311 priv->use_resized_width = FALSE;
2313 gtk_widget_queue_resize (priv->tree_view);
2316 g_object_notify (G_OBJECT (tree_column), "expand");
2320 * gtk_tree_view_column_get_expand:
2321 * @tree_column: a #GtkTreeViewColumn
2323 * Return %TRUE if the column expands to take any available space.
2325 * Return value: %TRUE, if the column expands
2330 gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
2332 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2334 return tree_column->priv->expand;
2338 * gtk_tree_view_column_set_clickable:
2339 * @tree_column: A #GtkTreeViewColumn.
2340 * @clickable: %TRUE if the header is active.
2342 * Sets the header to be active if @active is %TRUE. When the header is active,
2343 * then it can take keyboard focus, and can be clicked.
2346 gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,
2349 GtkTreeViewColumnPrivate *priv;
2351 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2353 priv = tree_column->priv;
2355 clickable = !! clickable;
2356 if (priv->clickable == clickable)
2359 priv->clickable = clickable;
2360 gtk_tree_view_column_update_button (tree_column);
2361 g_object_notify (G_OBJECT (tree_column), "clickable");
2365 * gtk_tree_view_column_get_clickable:
2366 * @tree_column: a #GtkTreeViewColumn
2368 * Returns %TRUE if the user can click on the header for the column.
2370 * Return value: %TRUE if user can click the column header.
2373 gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column)
2375 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2377 return tree_column->priv->clickable;
2381 * gtk_tree_view_column_set_widget:
2382 * @tree_column: A #GtkTreeViewColumn.
2383 * @widget: (allow-none): A child #GtkWidget, or %NULL.
2385 * Sets the widget in the header to be @widget. If widget is %NULL, then the
2386 * header button is set with a #GtkLabel set to the title of @tree_column.
2389 gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,
2392 GtkTreeViewColumnPrivate *priv;
2394 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2395 g_return_if_fail (widget == NULL || GTK_IS_WIDGET (widget));
2397 priv = tree_column->priv;
2400 g_object_ref_sink (widget);
2403 g_object_unref (priv->child);
2405 priv->child = widget;
2406 gtk_tree_view_column_update_button (tree_column);
2407 g_object_notify (G_OBJECT (tree_column), "widget");
2411 * gtk_tree_view_column_get_widget:
2412 * @tree_column: A #GtkTreeViewColumn.
2414 * Returns the #GtkWidget in the button on the column header.
2415 * If a custom widget has not been set then %NULL is returned.
2417 * Return value: (transfer none): The #GtkWidget in the column
2421 gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column)
2423 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2425 return tree_column->priv->child;
2429 * gtk_tree_view_column_set_alignment:
2430 * @tree_column: A #GtkTreeViewColumn.
2431 * @xalign: The alignment, which is between [0.0 and 1.0] inclusive.
2433 * Sets the alignment of the title or custom widget inside the column header.
2434 * The alignment determines its location inside the button -- 0.0 for left, 0.5
2435 * for center, 1.0 for right.
2438 gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,
2441 GtkTreeViewColumnPrivate *priv;
2443 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2445 priv = tree_column->priv;
2447 xalign = CLAMP (xalign, 0.0, 1.0);
2449 if (priv->xalign == xalign)
2452 priv->xalign = xalign;
2453 gtk_tree_view_column_update_button (tree_column);
2454 g_object_notify (G_OBJECT (tree_column), "alignment");
2458 * gtk_tree_view_column_get_alignment:
2459 * @tree_column: A #GtkTreeViewColumn.
2461 * Returns the current x alignment of @tree_column. This value can range
2462 * between 0.0 and 1.0.
2464 * Return value: The current alignent of @tree_column.
2467 gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
2469 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0.5);
2471 return tree_column->priv->xalign;
2475 * gtk_tree_view_column_set_reorderable:
2476 * @tree_column: A #GtkTreeViewColumn
2477 * @reorderable: %TRUE, if the column can be reordered.
2479 * If @reorderable is %TRUE, then the column can be reordered by the end user
2480 * dragging the header.
2483 gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
2484 gboolean reorderable)
2486 GtkTreeViewColumnPrivate *priv;
2488 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2490 priv = tree_column->priv;
2493 gtk_tree_view_column_set_clickable (tree_column, TRUE);*/
2495 if (priv->reorderable == (reorderable?TRUE:FALSE))
2498 priv->reorderable = (reorderable?TRUE:FALSE);
2499 gtk_tree_view_column_update_button (tree_column);
2500 g_object_notify (G_OBJECT (tree_column), "reorderable");
2504 * gtk_tree_view_column_get_reorderable:
2505 * @tree_column: A #GtkTreeViewColumn
2507 * Returns %TRUE if the @tree_column can be reordered by the user.
2509 * Return value: %TRUE if the @tree_column can be reordered by the user.
2512 gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
2514 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2516 return tree_column->priv->reorderable;
2521 * gtk_tree_view_column_set_sort_column_id:
2522 * @tree_column: a #GtkTreeViewColumn
2523 * @sort_column_id: The @sort_column_id of the model to sort on.
2525 * Sets the logical @sort_column_id that this column sorts on when this column
2526 * is selected for sorting. Doing so makes the column header clickable.
2529 gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,
2530 gint sort_column_id)
2532 GtkTreeViewColumnPrivate *priv;
2534 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2535 g_return_if_fail (sort_column_id >= -1);
2537 priv = tree_column->priv;
2539 if (priv->sort_column_id == sort_column_id)
2542 priv->sort_column_id = sort_column_id;
2544 /* Handle unsetting the id */
2545 if (sort_column_id == -1)
2547 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (priv->tree_view));
2549 if (priv->sort_clicked_signal)
2551 g_signal_handler_disconnect (tree_column, priv->sort_clicked_signal);
2552 priv->sort_clicked_signal = 0;
2555 if (priv->sort_column_changed_signal)
2557 g_signal_handler_disconnect (model, priv->sort_column_changed_signal);
2558 priv->sort_column_changed_signal = 0;
2561 gtk_tree_view_column_set_sort_order (tree_column, GTK_SORT_ASCENDING);
2562 gtk_tree_view_column_set_sort_indicator (tree_column, FALSE);
2563 gtk_tree_view_column_set_clickable (tree_column, FALSE);
2564 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2568 gtk_tree_view_column_set_clickable (tree_column, TRUE);
2570 if (! priv->sort_clicked_signal)
2571 priv->sort_clicked_signal = g_signal_connect (tree_column,
2573 G_CALLBACK (gtk_tree_view_column_sort),
2576 gtk_tree_view_column_setup_sort_column_id_callback (tree_column);
2577 g_object_notify (G_OBJECT (tree_column), "sort-column-id");
2581 * gtk_tree_view_column_get_sort_column_id:
2582 * @tree_column: a #GtkTreeViewColumn
2584 * Gets the logical @sort_column_id that the model sorts on when this
2585 * column is selected for sorting.
2586 * See gtk_tree_view_column_set_sort_column_id().
2588 * Return value: the current @sort_column_id for this column, or -1 if
2589 * this column can't be used for sorting.
2592 gtk_tree_view_column_get_sort_column_id (GtkTreeViewColumn *tree_column)
2594 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2596 return tree_column->priv->sort_column_id;
2600 * gtk_tree_view_column_set_sort_indicator:
2601 * @tree_column: a #GtkTreeViewColumn
2602 * @setting: %TRUE to display an indicator that the column is sorted
2604 * Call this function with a @setting of %TRUE to display an arrow in
2605 * the header button indicating the column is sorted. Call
2606 * gtk_tree_view_column_set_sort_order() to change the direction of
2611 gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,
2614 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2616 setting = setting != FALSE;
2618 if (setting == tree_column->priv->show_sort_indicator)
2621 tree_column->priv->show_sort_indicator = setting;
2622 gtk_tree_view_column_update_button (tree_column);
2623 g_object_notify (G_OBJECT (tree_column), "sort-indicator");
2627 * gtk_tree_view_column_get_sort_indicator:
2628 * @tree_column: a #GtkTreeViewColumn
2630 * Gets the value set by gtk_tree_view_column_set_sort_indicator().
2632 * Return value: whether the sort indicator arrow is displayed
2635 gtk_tree_view_column_get_sort_indicator (GtkTreeViewColumn *tree_column)
2637 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2639 return tree_column->priv->show_sort_indicator;
2643 * gtk_tree_view_column_set_sort_order:
2644 * @tree_column: a #GtkTreeViewColumn
2645 * @order: sort order that the sort indicator should indicate
2647 * Changes the appearance of the sort indicator.
2649 * This <emphasis>does not</emphasis> actually sort the model. Use
2650 * gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
2651 * support. This function is primarily for custom sorting behavior, and should
2652 * be used in conjunction with gtk_tree_sortable_set_sort_column() to do
2653 * that. For custom models, the mechanism will vary.
2655 * The sort indicator changes direction to indicate normal sort or reverse sort.
2656 * Note that you must have the sort indicator enabled to see anything when
2657 * calling this function; see gtk_tree_view_column_set_sort_indicator().
2660 gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,
2663 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2665 if (order == tree_column->priv->sort_order)
2668 tree_column->priv->sort_order = order;
2669 gtk_tree_view_column_update_button (tree_column);
2670 g_object_notify (G_OBJECT (tree_column), "sort-order");
2674 * gtk_tree_view_column_get_sort_order:
2675 * @tree_column: a #GtkTreeViewColumn
2677 * Gets the value set by gtk_tree_view_column_set_sort_order().
2679 * Return value: the sort order the sort indicator is indicating
2682 gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column)
2684 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), 0);
2686 return tree_column->priv->sort_order;
2690 * gtk_tree_view_column_cell_set_cell_data:
2691 * @tree_column: A #GtkTreeViewColumn.
2692 * @tree_model: The #GtkTreeModel to to get the cell renderers attributes from.
2693 * @iter: The #GtkTreeIter to to get the cell renderer's attributes from.
2694 * @is_expander: %TRUE, if the row has children
2695 * @is_expanded: %TRUE, if the row has visible children
2697 * Sets the cell renderer based on the @tree_model and @iter. That is, for
2698 * every attribute mapping in @tree_column, it will get a value from the set
2699 * column on the @iter, and use that value to set the attribute on the cell
2700 * renderer. This is used primarily by the #GtkTreeView.
2703 gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,
2704 GtkTreeModel *tree_model,
2706 gboolean is_expander,
2707 gboolean is_expanded)
2709 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2711 if (tree_model == NULL)
2714 gtk_cell_area_apply_attributes (tree_column->priv->cell_area, tree_model, iter,
2715 is_expander, is_expanded);
2719 * gtk_tree_view_column_cell_get_size:
2720 * @tree_column: A #GtkTreeViewColumn.
2721 * @cell_area: (allow-none): The area a cell in the column will be allocated, or %NULL
2722 * @x_offset: (allow-none): location to return x offset of a cell relative to @cell_area, or %NULL
2723 * @y_offset: (allow-none): location to return y offset of a cell relative to @cell_area, or %NULL
2724 * @width: (allow-none): location to return width needed to render a cell, or %NULL
2725 * @height: (allow-none): location to return height needed to render a cell, or %NULL
2727 * Obtains the width and height needed to render the column. This is used
2728 * primarily by the #GtkTreeView.
2731 gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,
2732 const GdkRectangle *cell_area,
2738 GtkTreeViewColumnPrivate *priv;
2739 gint min_width = 0, min_height = 0;
2741 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2743 priv = tree_column->priv;
2745 g_signal_handler_block (priv->cell_area_context,
2746 priv->context_changed_signal);
2748 gtk_cell_area_get_preferred_width (priv->cell_area,
2749 priv->cell_area_context,
2753 gtk_cell_area_context_get_preferred_width (priv->cell_area_context, &min_width, NULL);
2755 gtk_cell_area_get_preferred_height_for_width (priv->cell_area,
2756 priv->cell_area_context,
2762 g_signal_handler_unblock (priv->cell_area_context,
2763 priv->context_changed_signal);
2767 * height = min_height;
2769 * width = min_width;
2774 * gtk_tree_view_column_cell_render:
2775 * @tree_column: A #GtkTreeViewColumn.
2776 * @cr: cairo context to draw to
2777 * @background_area: entire cell area (including tree expanders and maybe padding on the sides)
2778 * @cell_area: area normally rendered by a cell renderer
2779 * @flags: flags that affect rendering
2781 * Renders the cell contained by #tree_column. This is used primarily by the
2785 _gtk_tree_view_column_cell_render (GtkTreeViewColumn *tree_column,
2787 const GdkRectangle *background_area,
2788 const GdkRectangle *cell_area,
2790 gboolean draw_focus)
2792 GtkTreeViewColumnPrivate *priv;
2794 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2795 g_return_if_fail (cr != NULL);
2796 g_return_if_fail (background_area != NULL);
2797 g_return_if_fail (cell_area != NULL);
2799 priv = tree_column->priv;
2803 gtk_cell_area_render (priv->cell_area, priv->cell_area_context,
2804 priv->tree_view, cr,
2805 background_area, cell_area, flags,
2812 _gtk_tree_view_column_cell_event (GtkTreeViewColumn *tree_column,
2814 const GdkRectangle *cell_area,
2817 GtkTreeViewColumnPrivate *priv;
2819 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2821 priv = tree_column->priv;
2823 return gtk_cell_area_event (priv->cell_area,
2824 priv->cell_area_context,
2832 * gtk_tree_view_column_cell_is_visible:
2833 * @tree_column: A #GtkTreeViewColumn
2835 * Returns %TRUE if any of the cells packed into the @tree_column are visible.
2836 * For this to be meaningful, you must first initialize the cells with
2837 * gtk_tree_view_column_cell_set_cell_data()
2839 * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
2842 gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
2846 GtkTreeViewColumnPrivate *priv;
2848 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2850 priv = tree_column->priv;
2852 cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->cell_area));
2853 for (list = cells; list; list = list->next)
2855 if (gtk_cell_renderer_get_visible (list->data))
2857 g_list_free (cells);
2862 g_list_free (cells);
2868 * gtk_tree_view_column_focus_cell:
2869 * @tree_column: A #GtkTreeViewColumn
2870 * @cell: A #GtkCellRenderer
2872 * Sets the current keyboard focus to be at @cell, if the column contains
2873 * 2 or more editable and activatable cells.
2878 gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,
2879 GtkCellRenderer *cell)
2881 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2882 g_return_if_fail (GTK_IS_CELL_RENDERER (cell));
2884 gtk_cell_area_set_focus_cell (tree_column->priv->cell_area, cell);
2888 _gtk_tree_view_column_cell_set_dirty (GtkTreeViewColumn *tree_column,
2889 gboolean install_handler)
2891 GtkTreeViewColumnPrivate *priv = tree_column->priv;
2894 priv->requested_width = -1;
2897 if (priv->tree_view &&
2898 gtk_widget_get_realized (priv->tree_view))
2900 _gtk_tree_view_install_mark_rows_col_dirty (GTK_TREE_VIEW (priv->tree_view), install_handler);
2901 gtk_widget_queue_resize (priv->tree_view);
2906 _gtk_tree_view_column_cell_get_dirty (GtkTreeViewColumn *tree_column)
2908 return tree_column->priv->dirty;
2912 * gtk_tree_view_column_cell_get_position:
2913 * @tree_column: a #GtkTreeViewColumn
2914 * @cell_renderer: a #GtkCellRenderer
2915 * @x_offset: return location for the horizontal position of @cell within
2916 * @tree_column, may be %NULL
2917 * @width: return location for the width of @cell, may be %NULL
2919 * Obtains the horizontal position and size of a cell in a column. If the
2920 * cell is not found in the column, @start_pos and @width are not changed and
2921 * %FALSE is returned.
2923 * Return value: %TRUE if @cell belongs to @tree_column.
2926 gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
2927 GtkCellRenderer *cell_renderer,
2931 GtkTreeViewColumnPrivate *priv;
2932 GdkRectangle zero_cell_area = { 0, };
2933 GdkRectangle allocation;
2935 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), FALSE);
2936 g_return_val_if_fail (GTK_IS_CELL_RENDERER (cell_renderer), FALSE);
2938 priv = tree_column->priv;
2940 /* FIXME: Could use a boolean return value for invalid cells */
2941 gtk_cell_area_get_cell_allocation (priv->cell_area,
2942 priv->cell_area_context,
2949 *x_offset = allocation.x;
2951 *width = allocation.width;
2957 * gtk_tree_view_column_queue_resize:
2958 * @tree_column: A #GtkTreeViewColumn
2960 * Flags the column, and the cell renderers added to this column, to have
2961 * their sizes renegotiated.
2966 gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column)
2968 g_return_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column));
2970 if (tree_column->priv->tree_view)
2971 _gtk_tree_view_column_cell_set_dirty (tree_column, TRUE);
2975 * gtk_tree_view_column_get_tree_view:
2976 * @tree_column: A #GtkTreeViewColumn
2978 * Returns the #GtkTreeView wherein @tree_column has been inserted.
2979 * If @column is currently not inserted in any tree view, %NULL is
2982 * Return value: (transfer none): The tree view wherein @column has
2983 * been inserted if any, %NULL otherwise.
2988 gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column)
2990 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
2992 return tree_column->priv->tree_view;
2996 * gtk_tree_view_column_get_button:
2997 * @tree_column: A #GtkTreeViewColumn
2999 * Returns the button used in the treeview column header
3001 * Return value: (transfer none): The button for the column header.
3006 gtk_tree_view_column_get_button (GtkTreeViewColumn *tree_column)
3008 g_return_val_if_fail (GTK_IS_TREE_VIEW_COLUMN (tree_column), NULL);
3010 return tree_column->priv->button;
3014 _gtk_tree_view_column_get_window (GtkTreeViewColumn *column)
3016 return column->priv->window;
3020 _gtk_tree_view_column_set_requested_width (GtkTreeViewColumn *column,
3023 column->priv->requested_width = width;
3027 _gtk_tree_view_column_get_requested_width (GtkTreeViewColumn *column)
3029 return column->priv->requested_width;
3033 _gtk_tree_view_column_set_resized_width (GtkTreeViewColumn *column,
3036 column->priv->resized_width = width;
3040 _gtk_tree_view_column_get_resized_width (GtkTreeViewColumn *column)
3042 return column->priv->resized_width;
3046 _gtk_tree_view_column_set_use_resized_width (GtkTreeViewColumn *column,
3047 gboolean use_resized_width)
3049 column->priv->use_resized_width = use_resized_width;
3053 _gtk_tree_view_column_get_use_resized_width (GtkTreeViewColumn *column)
3055 return column->priv->use_resized_width;
3059 _gtk_tree_view_column_get_drag_x (GtkTreeViewColumn *column)
3061 return column->priv->drag_x;
3064 GtkCellAreaContext *
3065 _gtk_tree_view_column_get_context (GtkTreeViewColumn *column)
3067 return column->priv->cell_area_context;