2 * Copyright (C) 2002, 2003 Kristian Rietveld <kris@gtk.org>
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.
21 #include "gtkcombobox.h"
22 #include "gtkcellareabox.h"
23 #include "gtktreemenu.h"
25 #include "gtkbindings.h"
26 #include "gtkcelllayout.h"
27 #include "gtkcellrenderertext.h"
28 #include "gtkcellview.h"
29 #include "gtkeventbox.h"
32 #include "gtkliststore.h"
34 #include "gtkmenuprivate.h"
35 #include "gtkmenushellprivate.h"
36 #include "gtkscrolledwindow.h"
37 #include "gtkseparatormenuitem.h"
38 #include "deprecated/gtktearoffmenuitem.h"
39 #include "gtktogglebutton.h"
40 #include "gtktreeselection.h"
41 #include "gtkseparator.h"
42 #include "gtkwindow.h"
43 #include "gtktypebuiltins.h"
44 #include "gtkprivate.h"
46 #include <gobject/gvaluecollector.h>
51 #include "gtkmarshalers.h"
54 #include "gtkentryprivate.h"
55 #include "gtktreeprivate.h"
56 #include "a11y/gtkcomboboxaccessible.h"
61 * @Short_description: A widget used to choose from a list of items
63 * @See_also: #GtkComboBoxText, #GtkTreeModel, #GtkCellRenderer
65 * A GtkComboBox is a widget that allows the user to choose from a list of
66 * valid choices. The GtkComboBox displays the selected choice. When
67 * activated, the GtkComboBox displays a popup which allows the user to
68 * make a new choice. The style in which the selected value is displayed,
69 * and the style of the popup is determined by the current theme. It may
70 * be similar to a Windows-style combo box.
72 * The GtkComboBox uses the model-view pattern; the list of valid choices
73 * is specified in the form of a tree model, and the display of the choices
74 * can be adapted to the data in the model by using cell renderers, as you
75 * would in a tree view. This is possible since GtkComboBox implements the
76 * #GtkCellLayout interface. The tree model holding the valid choices is
77 * not restricted to a flat list, it can be a real tree, and the popup will
78 * reflect the tree structure.
80 * To allow the user to enter values not in the model, the 'has-entry'
81 * property allows the GtkComboBox to contain a #GtkEntry. This entry
82 * can be accessed by calling gtk_bin_get_child() on the combo box.
84 * For a simple list of textual choices, the model-view API of GtkComboBox
85 * can be a bit overwhelming. In this case, #GtkComboBoxText offers a
86 * simple alternative. Both GtkComboBox and #GtkComboBoxText can contain
91 /* WELCOME, to THE house of evil code */
92 struct _GtkComboBoxPrivate
102 GtkShadowType shadow_type;
104 gint active; /* Only temporary */
105 GtkTreeRowReference *active_row;
107 GtkWidget *tree_view;
109 GtkWidget *cell_view;
110 GtkWidget *cell_view_frame;
115 GtkWidget *separator;
117 GtkWidget *popup_widget;
118 GtkWidget *popup_window;
119 GtkWidget *scrolled_window;
126 guint activate_button;
127 guint32 activate_time;
129 guint resize_idle_id;
131 /* For "has-entry" specific behavior we track
132 * an automated cell renderer and text column
135 GtkCellRenderer *text_renderer;
139 guint popup_in_progress : 1;
140 guint popup_shown : 1;
141 guint add_tearoffs : 1;
143 guint is_cell_renderer : 1;
144 guint editing_canceled : 1;
145 guint auto_scroll : 1;
146 guint focus_on_click : 1;
147 guint button_sensitivity : 2;
149 guint popup_fixed_width : 1;
151 GtkTreeViewRowSeparatorFunc row_separator_func;
152 gpointer row_separator_data;
153 GDestroyNotify row_separator_destroy;
155 GdkDevice *grab_pointer;
156 GdkDevice *grab_keyboard;
158 gchar *tearoff_title;
161 /* While debugging this evil code, I have learned that
162 * there are actually 4 modes to this widget, which can
163 * be characterized as follows
165 * 1) menu mode, no child added
168 * cell_view -> GtkCellView, regular child
169 * cell_view_frame -> NULL
170 * button -> GtkToggleButton set_parent to combo
171 * arrow -> GtkArrow set_parent to button
172 * separator -> GtkVSepator set_parent to button
173 * popup_widget -> GtkMenu
174 * popup_window -> NULL
175 * scrolled_window -> NULL
177 * 2) menu mode, child added
181 * cell_view_frame -> NULL
182 * button -> GtkToggleButton set_parent to combo
183 * arrow -> GtkArrow, child of button
185 * popup_widget -> GtkMenu
186 * popup_window -> NULL
187 * scrolled_window -> NULL
189 * 3) list mode, no child added
191 * tree_view -> GtkTreeView, child of scrolled_window
192 * cell_view -> GtkCellView, regular child
193 * cell_view_frame -> GtkFrame, set parent to combo
194 * button -> GtkToggleButton, set_parent to combo
195 * arrow -> GtkArrow, child of button
197 * popup_widget -> tree_view
198 * popup_window -> GtkWindow
199 * scrolled_window -> GtkScrolledWindow, child of popup_window
201 * 4) list mode, child added
203 * tree_view -> GtkTreeView, child of scrolled_window
205 * cell_view_frame -> NULL
206 * button -> GtkToggleButton, set_parent to combo
207 * arrow -> GtkArrow, child of button
209 * popup_widget -> tree_view
210 * popup_window -> GtkWindow
211 * scrolled_window -> GtkScrolledWindow, child of popup_window
228 PROP_ROW_SPAN_COLUMN,
229 PROP_COLUMN_SPAN_COLUMN,
236 PROP_BUTTON_SENSITIVITY,
237 PROP_EDITING_CANCELED,
239 PROP_ENTRY_TEXT_COLUMN,
240 PROP_POPUP_FIXED_WIDTH,
246 static guint combo_box_signals[LAST_SIGNAL] = {0,};
248 #define SCROLL_TIME 100
252 static void gtk_combo_box_cell_layout_init (GtkCellLayoutIface *iface);
253 static void gtk_combo_box_cell_editable_init (GtkCellEditableIface *iface);
254 static GObject *gtk_combo_box_constructor (GType type,
255 guint n_construct_properties,
256 GObjectConstructParam *construct_properties);
257 static void gtk_combo_box_dispose (GObject *object);
258 static void gtk_combo_box_finalize (GObject *object);
259 static void gtk_combo_box_destroy (GtkWidget *widget);
261 static void gtk_combo_box_set_property (GObject *object,
265 static void gtk_combo_box_get_property (GObject *object,
270 static void gtk_combo_box_state_flags_changed (GtkWidget *widget,
271 GtkStateFlags previous);
272 static void gtk_combo_box_grab_focus (GtkWidget *widget);
273 static void gtk_combo_box_style_updated (GtkWidget *widget);
274 static void gtk_combo_box_button_toggled (GtkWidget *widget,
276 static void gtk_combo_box_button_state_flags_changed (GtkWidget *widget,
277 GtkStateFlags previous,
279 static void gtk_combo_box_add (GtkContainer *container,
281 static void gtk_combo_box_remove (GtkContainer *container,
284 static void gtk_combo_box_menu_show (GtkWidget *menu,
286 static void gtk_combo_box_menu_hide (GtkWidget *menu,
289 static void gtk_combo_box_set_popup_widget (GtkComboBox *combo_box,
291 static void gtk_combo_box_menu_position_below (GtkMenu *menu,
296 static void gtk_combo_box_menu_position_over (GtkMenu *menu,
301 static void gtk_combo_box_menu_position (GtkMenu *menu,
307 static void gtk_combo_box_unset_model (GtkComboBox *combo_box);
309 static void gtk_combo_box_size_allocate (GtkWidget *widget,
310 GtkAllocation *allocation);
311 static void gtk_combo_box_forall (GtkContainer *container,
312 gboolean include_internals,
313 GtkCallback callback,
314 gpointer callback_data);
315 static gboolean gtk_combo_box_draw (GtkWidget *widget,
317 static gboolean gtk_combo_box_scroll_event (GtkWidget *widget,
318 GdkEventScroll *event);
319 static void gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
322 static void gtk_combo_box_check_appearance (GtkComboBox *combo_box);
323 static void gtk_combo_box_real_move_active (GtkComboBox *combo_box,
324 GtkScrollType scroll);
325 static void gtk_combo_box_real_popup (GtkComboBox *combo_box);
326 static gboolean gtk_combo_box_real_popdown (GtkComboBox *combo_box);
328 /* listening to the model */
329 static void gtk_combo_box_model_row_inserted (GtkTreeModel *model,
333 static void gtk_combo_box_model_row_deleted (GtkTreeModel *model,
336 static void gtk_combo_box_model_rows_reordered (GtkTreeModel *model,
341 static void gtk_combo_box_model_row_changed (GtkTreeModel *model,
345 static void gtk_combo_box_model_row_expanded (GtkTreeModel *model,
351 static void gtk_combo_box_list_position (GtkComboBox *combo_box,
356 static void gtk_combo_box_list_setup (GtkComboBox *combo_box);
357 static void gtk_combo_box_list_destroy (GtkComboBox *combo_box);
359 static gboolean gtk_combo_box_list_button_released (GtkWidget *widget,
360 GdkEventButton *event,
362 static gboolean gtk_combo_box_list_key_press (GtkWidget *widget,
365 static gboolean gtk_combo_box_list_enter_notify (GtkWidget *widget,
366 GdkEventCrossing *event,
368 static void gtk_combo_box_list_auto_scroll (GtkComboBox *combo,
371 static gboolean gtk_combo_box_list_scroll_timeout (GtkComboBox *combo);
372 static gboolean gtk_combo_box_list_button_pressed (GtkWidget *widget,
373 GdkEventButton *event,
376 static gboolean gtk_combo_box_list_select_func (GtkTreeSelection *selection,
379 gboolean path_currently_selected,
382 static void gtk_combo_box_list_row_changed (GtkTreeModel *model,
386 static void gtk_combo_box_list_popup_resize (GtkComboBox *combo_box);
389 static void gtk_combo_box_menu_setup (GtkComboBox *combo_box,
390 gboolean add_children);
391 static void gtk_combo_box_update_title (GtkComboBox *combo_box);
392 static void gtk_combo_box_menu_destroy (GtkComboBox *combo_box);
395 static gboolean gtk_combo_box_menu_button_press (GtkWidget *widget,
396 GdkEventButton *event,
398 static void gtk_combo_box_menu_activate (GtkWidget *menu,
400 GtkComboBox *combo_box);
401 static void gtk_combo_box_update_sensitivity (GtkComboBox *combo_box);
402 static gboolean gtk_combo_box_menu_key_press (GtkWidget *widget,
405 static void gtk_combo_box_menu_popup (GtkComboBox *combo_box,
407 guint32 activate_time);
410 static GtkCellArea *gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout);
412 static gboolean gtk_combo_box_mnemonic_activate (GtkWidget *widget,
413 gboolean group_cycling);
415 static void gtk_combo_box_child_show (GtkWidget *widget,
416 GtkComboBox *combo_box);
417 static void gtk_combo_box_child_hide (GtkWidget *widget,
418 GtkComboBox *combo_box);
420 /* GtkComboBox:has-entry callbacks */
421 static void gtk_combo_box_entry_contents_changed (GtkEntry *entry,
423 static void gtk_combo_box_entry_active_changed (GtkComboBox *combo_box,
425 static gchar *gtk_combo_box_format_entry_text (GtkComboBox *combo_box,
428 /* GtkBuildable method implementation */
429 static GtkBuildableIface *parent_buildable_iface;
431 static void gtk_combo_box_buildable_init (GtkBuildableIface *iface);
432 static gboolean gtk_combo_box_buildable_custom_tag_start (GtkBuildable *buildable,
435 const gchar *tagname,
436 GMarkupParser *parser,
438 static void gtk_combo_box_buildable_custom_tag_end (GtkBuildable *buildable,
441 const gchar *tagname,
443 static GObject *gtk_combo_box_buildable_get_internal_child (GtkBuildable *buildable,
445 const gchar *childname);
448 /* GtkCellEditable method implementations */
449 static void gtk_combo_box_start_editing (GtkCellEditable *cell_editable,
452 static void gtk_combo_box_get_preferred_width (GtkWidget *widget,
455 static void gtk_combo_box_get_preferred_height (GtkWidget *widget,
458 static void gtk_combo_box_get_preferred_width_for_height (GtkWidget *widget,
462 static void gtk_combo_box_get_preferred_height_for_width (GtkWidget *widget,
466 static GtkWidgetPath *gtk_combo_box_get_path_for_child (GtkContainer *container,
468 static void gtk_combo_box_direction_changed (GtkWidget *widget,
469 GtkTextDirection previous_direction);
471 G_DEFINE_TYPE_WITH_CODE (GtkComboBox, gtk_combo_box, GTK_TYPE_BIN,
472 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
473 gtk_combo_box_cell_layout_init)
474 G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_EDITABLE,
475 gtk_combo_box_cell_editable_init)
476 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
477 gtk_combo_box_buildable_init))
482 gtk_combo_box_class_init (GtkComboBoxClass *klass)
484 GObjectClass *object_class;
485 GtkContainerClass *container_class;
486 GtkWidgetClass *widget_class;
487 GtkBindingSet *binding_set;
489 container_class = (GtkContainerClass *)klass;
490 container_class->forall = gtk_combo_box_forall;
491 container_class->add = gtk_combo_box_add;
492 container_class->remove = gtk_combo_box_remove;
493 container_class->get_path_for_child = gtk_combo_box_get_path_for_child;
495 widget_class = (GtkWidgetClass *)klass;
496 widget_class->size_allocate = gtk_combo_box_size_allocate;
497 widget_class->draw = gtk_combo_box_draw;
498 widget_class->scroll_event = gtk_combo_box_scroll_event;
499 widget_class->mnemonic_activate = gtk_combo_box_mnemonic_activate;
500 widget_class->grab_focus = gtk_combo_box_grab_focus;
501 widget_class->style_updated = gtk_combo_box_style_updated;
502 widget_class->state_flags_changed = gtk_combo_box_state_flags_changed;
503 widget_class->get_preferred_width = gtk_combo_box_get_preferred_width;
504 widget_class->get_preferred_height = gtk_combo_box_get_preferred_height;
505 widget_class->get_preferred_height_for_width = gtk_combo_box_get_preferred_height_for_width;
506 widget_class->get_preferred_width_for_height = gtk_combo_box_get_preferred_width_for_height;
507 widget_class->destroy = gtk_combo_box_destroy;
508 widget_class->direction_changed = gtk_combo_box_direction_changed;
510 object_class = (GObjectClass *)klass;
511 object_class->constructor = gtk_combo_box_constructor;
512 object_class->dispose = gtk_combo_box_dispose;
513 object_class->finalize = gtk_combo_box_finalize;
514 object_class->set_property = gtk_combo_box_set_property;
515 object_class->get_property = gtk_combo_box_get_property;
517 klass->format_entry_text = gtk_combo_box_format_entry_text;
521 * GtkComboBox::changed:
522 * @widget: the object which received the signal
524 * The changed signal is emitted when the active
525 * item is changed. The can be due to the user selecting
526 * a different item from the list, or due to a
527 * call to gtk_combo_box_set_active_iter().
528 * It will also be emitted while typing into the entry of a combo box
533 combo_box_signals[CHANGED] =
534 g_signal_new (I_("changed"),
535 G_OBJECT_CLASS_TYPE (klass),
537 G_STRUCT_OFFSET (GtkComboBoxClass, changed),
539 g_cclosure_marshal_VOID__VOID,
542 * GtkComboBox::move-active:
543 * @widget: the object that received the signal
544 * @scroll_type: a #GtkScrollType
546 * The ::move-active signal is a
547 * <link linkend="keybinding-signals">keybinding signal</link>
548 * which gets emitted to move the active selection.
552 combo_box_signals[MOVE_ACTIVE] =
553 g_signal_new_class_handler (I_("move-active"),
554 G_OBJECT_CLASS_TYPE (klass),
555 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
556 G_CALLBACK (gtk_combo_box_real_move_active),
558 g_cclosure_marshal_VOID__ENUM,
560 GTK_TYPE_SCROLL_TYPE);
563 * GtkComboBox::popup:
564 * @widget: the object that received the signal
566 * The ::popup signal is a
567 * <link linkend="keybinding-signals">keybinding signal</link>
568 * which gets emitted to popup the combo box list.
570 * The default binding for this signal is Alt+Down.
574 combo_box_signals[POPUP] =
575 g_signal_new_class_handler (I_("popup"),
576 G_OBJECT_CLASS_TYPE (klass),
577 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
578 G_CALLBACK (gtk_combo_box_real_popup),
580 g_cclosure_marshal_VOID__VOID,
583 * GtkComboBox::popdown:
584 * @button: the object which received the signal
586 * The ::popdown signal is a
587 * <link linkend="keybinding-signals">keybinding signal</link>
588 * which gets emitted to popdown the combo box list.
590 * The default bindings for this signal are Alt+Up and Escape.
594 combo_box_signals[POPDOWN] =
595 g_signal_new_class_handler (I_("popdown"),
596 G_OBJECT_CLASS_TYPE (klass),
597 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
598 G_CALLBACK (gtk_combo_box_real_popdown),
600 _gtk_marshal_BOOLEAN__VOID,
604 * GtkComboBox::format-entry-text:
605 * @combo: the object which received the signal
606 * @path: the GtkTreePath string from the combo box's current model to format text for
608 * For combo boxes that are created with an entry (See GtkComboBox:has-entry).
610 * A signal which allows you to change how the text displayed in a combo box's
611 * entry is displayed.
613 * Connect a signal handler which returns an allocated string representing
614 * @path. That string will then be used to set the text in the combo box's entry.
615 * The default signal handler uses the text from the GtkComboBox::entry-text-column
618 * Here's an example signal handler which fetches data from the model and
619 * displays it in the entry.
622 * format_entry_text_callback (GtkComboBox *combo,
624 * gpointer user_data)
627 * GtkTreeModel model;
630 * model = gtk_combo_box_get_model (combo);
632 * gtk_tree_model_get_iter_from_string (model, &iter, path);
633 * gtk_tree_model_get (model, &iter,
634 * THE_DOUBLE_VALUE_COLUMN, &value,
637 * return g_strdup_printf ("%g", value);
641 * Return value: (transfer full): a newly allocated string representing @path
642 * for the current GtkComboBox model.
646 combo_box_signals[FORMAT_ENTRY_TEXT] =
647 g_signal_new (I_("format-entry-text"),
648 G_TYPE_FROM_CLASS (klass),
650 G_STRUCT_OFFSET (GtkComboBoxClass, format_entry_text),
651 _gtk_single_string_accumulator, NULL,
652 _gtk_marshal_STRING__STRING,
653 G_TYPE_STRING, 1, G_TYPE_STRING);
656 binding_set = gtk_binding_set_by_class (widget_class);
658 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Down, GDK_MOD1_MASK,
660 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Down, GDK_MOD1_MASK,
663 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Up, GDK_MOD1_MASK,
665 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Up, GDK_MOD1_MASK,
667 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0,
670 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Up, 0,
672 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_UP);
673 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Up, 0,
675 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_UP);
676 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Page_Up, 0,
678 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_UP);
679 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Page_Up, 0,
681 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_UP);
682 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Home, 0,
684 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_START);
685 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Home, 0,
687 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_START);
689 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Down, 0,
691 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_DOWN);
692 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Down, 0,
694 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_STEP_DOWN);
695 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Page_Down, 0,
697 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_DOWN);
698 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_Page_Down, 0,
700 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_PAGE_DOWN);
701 gtk_binding_entry_add_signal (binding_set, GDK_KEY_End, 0,
703 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_END);
704 gtk_binding_entry_add_signal (binding_set, GDK_KEY_KP_End, 0,
706 GTK_TYPE_SCROLL_TYPE, GTK_SCROLL_END);
709 g_object_class_override_property (object_class,
710 PROP_EDITING_CANCELED,
716 * The model from which the combo box takes the values shown
721 g_object_class_install_property (object_class,
723 g_param_spec_object ("model",
724 P_("ComboBox model"),
725 P_("The model for the combo box"),
727 GTK_PARAM_READWRITE));
730 * GtkComboBox:wrap-width:
732 * If wrap-width is set to a positive value, the list will be
733 * displayed in multiple columns, the number of columns is
734 * determined by wrap-width.
738 g_object_class_install_property (object_class,
740 g_param_spec_int ("wrap-width",
742 P_("Wrap width for laying out the items in a grid"),
746 GTK_PARAM_READWRITE));
750 * GtkComboBox:row-span-column:
752 * If this is set to a non-negative value, it must be the index of a column
753 * of type %G_TYPE_INT in the model.
755 * The values of that column are used to determine how many rows a value in
756 * the list will span. Therefore, the values in the model column pointed to
757 * by this property must be greater than zero and not larger than wrap-width.
761 g_object_class_install_property (object_class,
762 PROP_ROW_SPAN_COLUMN,
763 g_param_spec_int ("row-span-column",
764 P_("Row span column"),
765 P_("TreeModel column containing the row span values"),
769 GTK_PARAM_READWRITE));
773 * GtkComboBox:column-span-column:
775 * If this is set to a non-negative value, it must be the index of a column
776 * of type %G_TYPE_INT in the model.
778 * The values of that column are used to determine how many columns a value
779 * in the list will span.
783 g_object_class_install_property (object_class,
784 PROP_COLUMN_SPAN_COLUMN,
785 g_param_spec_int ("column-span-column",
786 P_("Column span column"),
787 P_("TreeModel column containing the column span values"),
791 GTK_PARAM_READWRITE));
795 * GtkComboBox:active:
797 * The item which is currently active. If the model is a non-flat treemodel,
798 * and the active item is not an immediate child of the root of the tree,
799 * this property has the value
800 * <literal>gtk_tree_path_get_indices (path)[0]</literal>,
801 * where <literal>path</literal> is the #GtkTreePath of the active item.
805 g_object_class_install_property (object_class,
807 g_param_spec_int ("active",
809 P_("The item which is currently active"),
813 GTK_PARAM_READWRITE));
816 * GtkComboBox:add-tearoffs:
818 * The add-tearoffs property controls whether generated menus
819 * have tearoff menu items.
821 * Note that this only affects menu style combo boxes.
825 g_object_class_install_property (object_class,
827 g_param_spec_boolean ("add-tearoffs",
828 P_("Add tearoffs to menus"),
829 P_("Whether dropdowns should have a tearoff menu item"),
831 GTK_PARAM_READWRITE));
834 * GtkComboBox:has-frame:
836 * The has-frame property controls whether a frame
837 * is drawn around the entry.
841 g_object_class_install_property (object_class,
843 g_param_spec_boolean ("has-frame",
845 P_("Whether the combo box draws a frame around the child"),
847 GTK_PARAM_READWRITE));
849 g_object_class_install_property (object_class,
851 g_param_spec_boolean ("focus-on-click",
852 P_("Focus on click"),
853 P_("Whether the combo box grabs focus when it is clicked with the mouse"),
855 GTK_PARAM_READWRITE));
858 * GtkComboBox:tearoff-title:
860 * A title that may be displayed by the window manager
861 * when the popup is torn-off.
865 g_object_class_install_property (object_class,
867 g_param_spec_string ("tearoff-title",
869 P_("A title that may be displayed by the window manager when the popup is torn-off"),
871 GTK_PARAM_READWRITE));
875 * GtkComboBox:popup-shown:
877 * Whether the combo boxes dropdown is popped up.
878 * Note that this property is mainly useful, because
879 * it allows you to connect to notify::popup-shown.
883 g_object_class_install_property (object_class,
885 g_param_spec_boolean ("popup-shown",
887 P_("Whether the combo's dropdown is shown"),
889 GTK_PARAM_READABLE));
893 * GtkComboBox:button-sensitivity:
895 * Whether the dropdown button is sensitive when
896 * the model is empty.
900 g_object_class_install_property (object_class,
901 PROP_BUTTON_SENSITIVITY,
902 g_param_spec_enum ("button-sensitivity",
903 P_("Button Sensitivity"),
904 P_("Whether the dropdown button is sensitive when the model is empty"),
905 GTK_TYPE_SENSITIVITY_TYPE,
906 GTK_SENSITIVITY_AUTO,
907 GTK_PARAM_READWRITE));
910 * GtkComboBox:has-entry:
912 * Whether the combo box has an entry.
916 g_object_class_install_property (object_class,
918 g_param_spec_boolean ("has-entry",
920 P_("Whether combo box has an entry"),
922 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
925 * GtkComboBox:entry-text-column:
927 * The column in the combo box's model to associate with strings from the entry
928 * if the combo was created with #GtkComboBox:has-entry = %TRUE.
932 g_object_class_install_property (object_class,
933 PROP_ENTRY_TEXT_COLUMN,
934 g_param_spec_int ("entry-text-column",
935 P_("Entry Text Column"),
936 P_("The column in the combo box's model to associate "
937 "with strings from the entry if the combo was "
938 "created with #GtkComboBox:has-entry = %TRUE"),
940 GTK_PARAM_READWRITE));
943 * GtkComboBox:id-column:
945 * The column in the combo box's model that provides string
946 * IDs for the values in the model, if != -1.
950 g_object_class_install_property (object_class,
952 g_param_spec_int ("id-column",
954 P_("The column in the combo box's model that provides "
955 "string IDs for the values in the model"),
957 GTK_PARAM_READWRITE));
960 * GtkComboBox:active-id:
962 * The value of the ID column of the active row.
966 g_object_class_install_property (object_class,
968 g_param_spec_string ("active-id",
970 P_("The value of the id column "
971 "for the active row"),
972 NULL, GTK_PARAM_READWRITE));
975 * GtkComboBox:popup-fixed-width:
977 * Whether the popup's width should be a fixed width matching the
978 * allocated width of the combo box.
982 g_object_class_install_property (object_class,
983 PROP_POPUP_FIXED_WIDTH,
984 g_param_spec_boolean ("popup-fixed-width",
985 P_("Popup Fixed Width"),
986 P_("Whether the popup's width should be a "
987 "fixed width matching the allocated width "
990 GTK_PARAM_READWRITE));
993 * GtkComboBox:cell-area:
995 * The #GtkCellArea used to layout cell renderers for this combo box.
997 * If no area is specified when creating the combo box with gtk_combo_box_new_with_area()
998 * a horizontally oriented #GtkCellAreaBox will be used.
1002 g_object_class_install_property (object_class,
1004 g_param_spec_object ("cell-area",
1006 P_("The GtkCellArea used to layout cells"),
1008 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
1010 gtk_widget_class_install_style_property (widget_class,
1011 g_param_spec_boolean ("appears-as-list",
1012 P_("Appears as list"),
1013 P_("Whether dropdowns should look like lists rather than menus"),
1015 GTK_PARAM_READABLE));
1018 * GtkComboBox:arrow-size:
1020 * Sets the minimum size of the arrow in the combo box. Note
1021 * that the arrow size is coupled to the font size, so in case
1022 * a larger font is used, the arrow will be larger than set
1027 gtk_widget_class_install_style_property (widget_class,
1028 g_param_spec_int ("arrow-size",
1030 P_("The minimum size of the arrow in the combo box"),
1034 GTK_PARAM_READABLE));
1037 * GtkComboBox:arrow-scaling:
1039 * Sets the amount of space used up by the combobox arrow,
1040 * proportional to the font size.
1044 gtk_widget_class_install_style_property (widget_class,
1045 g_param_spec_float ("arrow-scaling",
1046 P_("Arrow Scaling"),
1047 P_("The amount of space used by the arrow"),
1051 GTK_PARAM_READABLE));
1054 * GtkComboBox:shadow-type:
1056 * Which kind of shadow to draw around the combo box.
1060 gtk_widget_class_install_style_property (widget_class,
1061 g_param_spec_enum ("shadow-type",
1063 P_("Which kind of shadow to draw around the combo box"),
1064 GTK_TYPE_SHADOW_TYPE,
1066 GTK_PARAM_READABLE));
1068 g_type_class_add_private (object_class, sizeof (GtkComboBoxPrivate));
1070 gtk_widget_class_set_accessible_type (widget_class, GTK_TYPE_COMBO_BOX_ACCESSIBLE);
1074 gtk_combo_box_buildable_init (GtkBuildableIface *iface)
1076 parent_buildable_iface = g_type_interface_peek_parent (iface);
1077 iface->add_child = _gtk_cell_layout_buildable_add_child;
1078 iface->custom_tag_start = gtk_combo_box_buildable_custom_tag_start;
1079 iface->custom_tag_end = gtk_combo_box_buildable_custom_tag_end;
1080 iface->get_internal_child = gtk_combo_box_buildable_get_internal_child;
1084 gtk_combo_box_cell_layout_init (GtkCellLayoutIface *iface)
1086 iface->get_area = gtk_combo_box_cell_layout_get_area;
1090 gtk_combo_box_cell_editable_init (GtkCellEditableIface *iface)
1092 iface->start_editing = gtk_combo_box_start_editing;
1096 gtk_combo_box_init (GtkComboBox *combo_box)
1098 GtkComboBoxPrivate *priv;
1100 combo_box->priv = G_TYPE_INSTANCE_GET_PRIVATE (combo_box,
1102 GtkComboBoxPrivate);
1103 priv = combo_box->priv;
1105 priv->wrap_width = 0;
1108 priv->active_row = NULL;
1109 priv->col_column = -1;
1110 priv->row_column = -1;
1112 priv->popup_shown = FALSE;
1113 priv->add_tearoffs = FALSE;
1114 priv->has_frame = TRUE;
1115 priv->is_cell_renderer = FALSE;
1116 priv->editing_canceled = FALSE;
1117 priv->auto_scroll = FALSE;
1118 priv->focus_on_click = TRUE;
1119 priv->button_sensitivity = GTK_SENSITIVITY_AUTO;
1120 priv->has_entry = FALSE;
1121 priv->popup_fixed_width = TRUE;
1123 priv->text_column = -1;
1124 priv->text_renderer = NULL;
1125 priv->id_column = -1;
1129 gtk_combo_box_set_property (GObject *object,
1131 const GValue *value,
1134 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
1135 GtkComboBoxPrivate *priv = combo_box->priv;
1141 gtk_combo_box_set_model (combo_box, g_value_get_object (value));
1144 case PROP_WRAP_WIDTH:
1145 gtk_combo_box_set_wrap_width (combo_box, g_value_get_int (value));
1148 case PROP_ROW_SPAN_COLUMN:
1149 gtk_combo_box_set_row_span_column (combo_box, g_value_get_int (value));
1152 case PROP_COLUMN_SPAN_COLUMN:
1153 gtk_combo_box_set_column_span_column (combo_box, g_value_get_int (value));
1157 gtk_combo_box_set_active (combo_box, g_value_get_int (value));
1160 case PROP_ADD_TEAROFFS:
1161 gtk_combo_box_set_add_tearoffs (combo_box, g_value_get_boolean (value));
1164 case PROP_HAS_FRAME:
1165 priv->has_frame = g_value_get_boolean (value);
1167 if (priv->has_entry)
1171 child = gtk_bin_get_child (GTK_BIN (combo_box));
1173 gtk_entry_set_has_frame (GTK_ENTRY (child), priv->has_frame);
1178 case PROP_FOCUS_ON_CLICK:
1179 gtk_combo_box_set_focus_on_click (combo_box,
1180 g_value_get_boolean (value));
1183 case PROP_TEAROFF_TITLE:
1184 gtk_combo_box_set_title (combo_box, g_value_get_string (value));
1187 case PROP_POPUP_SHOWN:
1188 if (g_value_get_boolean (value))
1189 gtk_combo_box_popup (combo_box);
1191 gtk_combo_box_popdown (combo_box);
1194 case PROP_BUTTON_SENSITIVITY:
1195 gtk_combo_box_set_button_sensitivity (combo_box,
1196 g_value_get_enum (value));
1199 case PROP_POPUP_FIXED_WIDTH:
1200 gtk_combo_box_set_popup_fixed_width (combo_box,
1201 g_value_get_boolean (value));
1204 case PROP_EDITING_CANCELED:
1205 priv->editing_canceled = g_value_get_boolean (value);
1208 case PROP_HAS_ENTRY:
1209 priv->has_entry = g_value_get_boolean (value);
1212 case PROP_ENTRY_TEXT_COLUMN:
1213 gtk_combo_box_set_entry_text_column (combo_box, g_value_get_int (value));
1216 case PROP_ID_COLUMN:
1217 gtk_combo_box_set_id_column (combo_box, g_value_get_int (value));
1220 case PROP_ACTIVE_ID:
1221 gtk_combo_box_set_active_id (combo_box, g_value_get_string (value));
1224 case PROP_CELL_AREA:
1225 /* Construct-only, can only be assigned once */
1226 area = g_value_get_object (value);
1229 if (priv->area != NULL)
1231 g_warning ("cell-area has already been set, ignoring construct property");
1232 g_object_ref_sink (area);
1233 g_object_unref (area);
1236 priv->area = g_object_ref_sink (area);
1241 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1247 gtk_combo_box_get_property (GObject *object,
1252 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
1253 GtkComboBoxPrivate *priv = combo_box->priv;
1258 g_value_set_object (value, combo_box->priv->model);
1261 case PROP_WRAP_WIDTH:
1262 g_value_set_int (value, combo_box->priv->wrap_width);
1265 case PROP_ROW_SPAN_COLUMN:
1266 g_value_set_int (value, combo_box->priv->row_column);
1269 case PROP_COLUMN_SPAN_COLUMN:
1270 g_value_set_int (value, combo_box->priv->col_column);
1274 g_value_set_int (value, gtk_combo_box_get_active (combo_box));
1277 case PROP_ADD_TEAROFFS:
1278 g_value_set_boolean (value, gtk_combo_box_get_add_tearoffs (combo_box));
1281 case PROP_HAS_FRAME:
1282 g_value_set_boolean (value, combo_box->priv->has_frame);
1285 case PROP_FOCUS_ON_CLICK:
1286 g_value_set_boolean (value, combo_box->priv->focus_on_click);
1289 case PROP_TEAROFF_TITLE:
1290 g_value_set_string (value, gtk_combo_box_get_title (combo_box));
1293 case PROP_POPUP_SHOWN:
1294 g_value_set_boolean (value, combo_box->priv->popup_shown);
1297 case PROP_BUTTON_SENSITIVITY:
1298 g_value_set_enum (value, combo_box->priv->button_sensitivity);
1301 case PROP_POPUP_FIXED_WIDTH:
1302 g_value_set_boolean (value, combo_box->priv->popup_fixed_width);
1305 case PROP_EDITING_CANCELED:
1306 g_value_set_boolean (value, priv->editing_canceled);
1309 case PROP_HAS_ENTRY:
1310 g_value_set_boolean (value, priv->has_entry);
1313 case PROP_ENTRY_TEXT_COLUMN:
1314 g_value_set_int (value, priv->text_column);
1317 case PROP_ID_COLUMN:
1318 g_value_set_int (value, priv->id_column);
1321 case PROP_ACTIVE_ID:
1322 g_value_set_string (value, gtk_combo_box_get_active_id (combo_box));
1325 case PROP_CELL_AREA:
1326 g_value_set_object (value, priv->area);
1330 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
1336 gtk_combo_box_state_flags_changed (GtkWidget *widget,
1337 GtkStateFlags previous)
1339 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1340 GtkComboBoxPrivate *priv = combo_box->priv;
1342 if (gtk_widget_get_realized (widget))
1344 if (priv->tree_view && priv->cell_view)
1346 GtkStyleContext *context;
1347 GtkStateFlags state;
1350 context = gtk_widget_get_style_context (widget);
1351 state = gtk_widget_get_state_flags (widget);
1352 gtk_style_context_get_background_color (context, state, &color);
1354 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
1358 gtk_widget_queue_draw (widget);
1362 gtk_combo_box_button_state_flags_changed (GtkWidget *widget,
1363 GtkStateFlags previous,
1366 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
1367 GtkComboBoxPrivate *priv = combo_box->priv;
1369 if (gtk_widget_get_realized (widget))
1371 if (!priv->tree_view && priv->cell_view)
1372 gtk_widget_set_state_flags (priv->cell_view,
1373 gtk_widget_get_state_flags (widget),
1377 gtk_widget_queue_draw (widget);
1381 gtk_combo_box_invalidate_order (GtkComboBox *combo_box)
1383 gtk_container_forall (GTK_CONTAINER (combo_box),
1384 (GtkCallback) gtk_widget_reset_style,
1389 gtk_combo_box_direction_changed (GtkWidget *widget,
1390 GtkTextDirection previous_direction)
1392 gtk_combo_box_invalidate_order (GTK_COMBO_BOX (widget));
1395 static GtkWidgetPath *
1396 gtk_combo_box_get_path_for_child (GtkContainer *container,
1399 GtkComboBoxPrivate *priv = GTK_COMBO_BOX (container)->priv;
1400 GtkWidgetPath *path;
1402 gboolean found = FALSE;
1403 GList *visible_children, *l;
1404 GtkWidgetPath *sibling_path;
1407 path = gtk_widget_path_copy (gtk_widget_get_path (GTK_WIDGET (container)));
1409 if (gtk_widget_get_visible (child))
1411 visible_children = NULL;
1413 if (priv->button && gtk_widget_get_visible (priv->button))
1414 visible_children = g_list_prepend (visible_children, priv->button);
1416 if (priv->cell_view_frame && gtk_widget_get_visible (priv->cell_view_frame))
1417 visible_children = g_list_prepend (visible_children, priv->cell_view_frame);
1419 widget = gtk_bin_get_child (GTK_BIN (container));
1420 if (widget && gtk_widget_get_visible (widget))
1421 visible_children = g_list_prepend (visible_children, widget);
1423 if (gtk_widget_get_direction (GTK_WIDGET (container)) == GTK_TEXT_DIR_RTL)
1424 visible_children = g_list_reverse (visible_children);
1428 for (l = visible_children; l; l = l->next)
1432 if (widget == child)
1444 sibling_path = gtk_widget_path_new ();
1446 for (l = visible_children; l; l = l->next)
1447 gtk_widget_path_append_for_widget (sibling_path, l->data);
1449 gtk_widget_path_append_with_siblings (path, sibling_path, pos);
1451 g_list_free (visible_children);
1452 gtk_widget_path_unref (sibling_path);
1456 gtk_widget_path_append_for_widget (path, child);
1463 gtk_combo_box_check_appearance (GtkComboBox *combo_box)
1465 GtkComboBoxPrivate *priv = combo_box->priv;
1466 gboolean appears_as_list;
1468 /* if wrap_width > 0, then we are in grid-mode and forced to use
1471 if (priv->wrap_width)
1472 appears_as_list = FALSE;
1474 gtk_widget_style_get (GTK_WIDGET (combo_box),
1475 "appears-as-list", &appears_as_list,
1478 if (appears_as_list)
1480 /* Destroy all the menu mode widgets, if they exist. */
1481 if (GTK_IS_MENU (priv->popup_widget))
1482 gtk_combo_box_menu_destroy (combo_box);
1484 /* Create the list mode widgets, if they don't already exist. */
1485 if (!GTK_IS_TREE_VIEW (priv->tree_view))
1486 gtk_combo_box_list_setup (combo_box);
1490 /* Destroy all the list mode widgets, if they exist. */
1491 if (GTK_IS_TREE_VIEW (priv->tree_view))
1492 gtk_combo_box_list_destroy (combo_box);
1494 /* Create the menu mode widgets, if they don't already exist. */
1495 if (!GTK_IS_MENU (priv->popup_widget))
1496 gtk_combo_box_menu_setup (combo_box, TRUE);
1499 gtk_widget_style_get (GTK_WIDGET (combo_box),
1500 "shadow-type", &priv->shadow_type,
1505 gtk_combo_box_style_updated (GtkWidget *widget)
1507 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1508 GtkComboBoxPrivate *priv = combo_box->priv;
1511 GTK_WIDGET_CLASS (gtk_combo_box_parent_class)->style_updated (widget);
1513 gtk_combo_box_check_appearance (combo_box);
1515 if (priv->tree_view && priv->cell_view)
1517 GtkStyleContext *context;
1518 GtkStateFlags state;
1521 context = gtk_widget_get_style_context (widget);
1522 state = gtk_widget_get_state_flags (widget);
1523 gtk_style_context_get_background_color (context, state, &color);
1525 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
1528 child = gtk_bin_get_child (GTK_BIN (combo_box));
1529 if (GTK_IS_ENTRY (child))
1530 g_object_set (child, "shadow-type",
1531 GTK_SHADOW_NONE == priv->shadow_type ?
1532 GTK_SHADOW_IN : GTK_SHADOW_NONE, NULL);
1536 gtk_combo_box_button_toggled (GtkWidget *widget,
1539 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
1541 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (widget)))
1543 if (!combo_box->priv->popup_in_progress)
1544 gtk_combo_box_popup (combo_box);
1547 gtk_combo_box_popdown (combo_box);
1551 gtk_combo_box_add (GtkContainer *container,
1554 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
1555 GtkComboBoxPrivate *priv = combo_box->priv;
1557 if (priv->has_entry && !GTK_IS_ENTRY (widget))
1559 g_warning ("Attempting to add a widget with type %s to a GtkComboBox that needs an entry "
1560 "(need an instance of GtkEntry or of a subclass)",
1561 G_OBJECT_TYPE_NAME (widget));
1565 if (priv->cell_view &&
1566 gtk_widget_get_parent (priv->cell_view))
1568 gtk_widget_unparent (priv->cell_view);
1569 _gtk_bin_set_child (GTK_BIN (container), NULL);
1570 gtk_widget_queue_resize (GTK_WIDGET (container));
1573 gtk_widget_set_parent (widget, GTK_WIDGET (container));
1574 _gtk_bin_set_child (GTK_BIN (container), widget);
1576 if (priv->cell_view &&
1577 widget != priv->cell_view)
1579 /* since the cell_view was unparented, it's gone now */
1580 priv->cell_view = NULL;
1582 if (!priv->tree_view && priv->separator)
1584 gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (priv->separator)),
1586 priv->separator = NULL;
1588 gtk_widget_queue_resize (GTK_WIDGET (container));
1590 else if (priv->cell_view_frame)
1592 gtk_widget_unparent (priv->cell_view_frame);
1593 priv->cell_view_frame = NULL;
1598 if (priv->has_entry)
1600 /* this flag is a hack to tell the entry to fill its allocation.
1602 _gtk_entry_set_is_cell_renderer (GTK_ENTRY (widget), TRUE);
1604 g_signal_connect (widget, "changed",
1605 G_CALLBACK (gtk_combo_box_entry_contents_changed),
1608 gtk_entry_set_has_frame (GTK_ENTRY (widget), priv->has_frame);
1613 gtk_combo_box_remove (GtkContainer *container,
1616 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
1617 GtkComboBoxPrivate *priv = combo_box->priv;
1619 gboolean appears_as_list;
1621 if (priv->has_entry)
1623 GtkWidget *child_widget;
1625 child_widget = gtk_bin_get_child (GTK_BIN (container));
1626 if (widget && widget == child_widget)
1628 g_signal_handlers_disconnect_by_func (widget,
1629 gtk_combo_box_entry_contents_changed,
1631 _gtk_entry_set_is_cell_renderer (GTK_ENTRY (widget), FALSE);
1635 if (widget == priv->cell_view)
1636 priv->cell_view = NULL;
1638 gtk_widget_unparent (widget);
1639 _gtk_bin_set_child (GTK_BIN (container), NULL);
1641 if (gtk_widget_in_destruction (GTK_WIDGET (combo_box)))
1644 gtk_widget_queue_resize (GTK_WIDGET (container));
1646 if (!priv->tree_view)
1647 appears_as_list = FALSE;
1649 appears_as_list = TRUE;
1651 if (appears_as_list)
1652 gtk_combo_box_list_destroy (combo_box);
1653 else if (GTK_IS_MENU (priv->popup_widget))
1655 gtk_combo_box_menu_destroy (combo_box);
1656 gtk_menu_detach (GTK_MENU (priv->popup_widget));
1657 priv->popup_widget = NULL;
1660 if (!priv->cell_view)
1662 priv->cell_view = gtk_cell_view_new ();
1663 gtk_widget_set_parent (priv->cell_view, GTK_WIDGET (container));
1664 _gtk_bin_set_child (GTK_BIN (container), priv->cell_view);
1666 gtk_widget_show (priv->cell_view);
1667 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view),
1672 if (appears_as_list)
1673 gtk_combo_box_list_setup (combo_box);
1675 gtk_combo_box_menu_setup (combo_box, TRUE);
1677 if (gtk_tree_row_reference_valid (priv->active_row))
1679 path = gtk_tree_row_reference_get_path (priv->active_row);
1680 gtk_combo_box_set_active_internal (combo_box, path);
1681 gtk_tree_path_free (path);
1684 gtk_combo_box_set_active_internal (combo_box, NULL);
1688 gtk_combo_box_menu_show (GtkWidget *menu,
1691 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1692 GtkComboBoxPrivate *priv = combo_box->priv;
1694 gtk_combo_box_child_show (menu, user_data);
1696 priv->popup_in_progress = TRUE;
1697 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
1699 priv->popup_in_progress = FALSE;
1703 gtk_combo_box_menu_hide (GtkWidget *menu,
1706 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1708 gtk_combo_box_child_hide (menu,user_data);
1710 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (combo_box->priv->button),
1715 gtk_combo_box_detacher (GtkWidget *widget,
1718 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
1719 GtkComboBoxPrivate *priv = combo_box->priv;
1721 g_return_if_fail (priv->popup_widget == (GtkWidget *) menu);
1723 g_signal_handlers_disconnect_by_func (menu->priv->toplevel,
1724 gtk_combo_box_menu_show,
1726 g_signal_handlers_disconnect_by_func (menu->priv->toplevel,
1727 gtk_combo_box_menu_hide,
1730 priv->popup_widget = NULL;
1734 gtk_combo_box_set_popup_widget (GtkComboBox *combo_box,
1737 GtkComboBoxPrivate *priv = combo_box->priv;
1739 if (GTK_IS_MENU (priv->popup_widget))
1741 gtk_menu_detach (GTK_MENU (priv->popup_widget));
1742 priv->popup_widget = NULL;
1744 else if (priv->popup_widget)
1746 gtk_container_remove (GTK_CONTAINER (priv->scrolled_window),
1747 priv->popup_widget);
1748 g_object_unref (priv->popup_widget);
1749 priv->popup_widget = NULL;
1752 if (GTK_IS_MENU (popup))
1754 if (priv->popup_window)
1756 gtk_widget_destroy (priv->popup_window);
1757 priv->popup_window = NULL;
1760 priv->popup_widget = popup;
1763 * Note that we connect to show/hide on the toplevel, not the
1764 * menu itself, since the menu is not shown/hidden when it is
1765 * popped up while torn-off.
1767 g_signal_connect (GTK_MENU (popup)->priv->toplevel, "show",
1768 G_CALLBACK (gtk_combo_box_menu_show), combo_box);
1769 g_signal_connect (GTK_MENU (popup)->priv->toplevel, "hide",
1770 G_CALLBACK (gtk_combo_box_menu_hide), combo_box);
1772 gtk_menu_attach_to_widget (GTK_MENU (popup),
1773 GTK_WIDGET (combo_box),
1774 gtk_combo_box_detacher);
1778 if (!priv->popup_window)
1780 GtkWidget *toplevel;
1782 priv->popup_window = gtk_window_new (GTK_WINDOW_POPUP);
1783 gtk_widget_set_name (priv->popup_window, "gtk-combobox-popup-window");
1785 gtk_window_set_type_hint (GTK_WINDOW (priv->popup_window),
1786 GDK_WINDOW_TYPE_HINT_COMBO);
1788 g_signal_connect (GTK_WINDOW (priv->popup_window),"show",
1789 G_CALLBACK (gtk_combo_box_child_show),
1791 g_signal_connect (GTK_WINDOW (priv->popup_window),"hide",
1792 G_CALLBACK (gtk_combo_box_child_hide),
1795 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (combo_box));
1796 if (GTK_IS_WINDOW (toplevel))
1798 gtk_window_group_add_window (gtk_window_get_group (GTK_WINDOW (toplevel)),
1799 GTK_WINDOW (priv->popup_window));
1800 gtk_window_set_transient_for (GTK_WINDOW (priv->popup_window),
1801 GTK_WINDOW (toplevel));
1804 gtk_window_set_resizable (GTK_WINDOW (priv->popup_window), FALSE);
1805 gtk_window_set_screen (GTK_WINDOW (priv->popup_window),
1806 gtk_widget_get_screen (GTK_WIDGET (combo_box)));
1808 priv->scrolled_window = gtk_scrolled_window_new (NULL, NULL);
1810 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
1813 gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (priv->scrolled_window),
1816 gtk_widget_show (priv->scrolled_window);
1818 gtk_container_add (GTK_CONTAINER (priv->popup_window),
1819 priv->scrolled_window);
1822 gtk_container_add (GTK_CONTAINER (priv->scrolled_window),
1825 gtk_widget_show (popup);
1826 g_object_ref (popup);
1827 priv->popup_widget = popup;
1832 get_widget_padding (GtkWidget *widget,
1835 GtkStyleContext *context;
1836 GtkStateFlags state;
1838 context = gtk_widget_get_style_context (widget);
1839 state = gtk_style_context_get_state (context);
1841 gtk_style_context_get_padding (context, state, padding);
1845 gtk_combo_box_menu_position_below (GtkMenu *menu,
1851 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1852 GtkAllocation child_allocation;
1858 GdkRectangle monitor;
1861 /* FIXME: is using the size request here broken? */
1862 child = gtk_bin_get_child (GTK_BIN (combo_box));
1866 gtk_widget_get_allocation (child, &child_allocation);
1868 if (!gtk_widget_get_has_window (child))
1870 sx += child_allocation.x;
1871 sy += child_allocation.y;
1874 gdk_window_get_root_coords (gtk_widget_get_window (child),
1876 get_widget_padding (GTK_WIDGET (combo_box), &padding);
1879 if (combo_box->priv->popup_fixed_width)
1880 gtk_widget_get_preferred_size (GTK_WIDGET (menu), &req, NULL);
1882 gtk_widget_get_preferred_size (GTK_WIDGET (menu), NULL, &req);
1884 if (gtk_widget_get_direction (GTK_WIDGET (combo_box)) == GTK_TEXT_DIR_LTR)
1887 *x = sx + child_allocation.width - req.width;
1890 screen = gtk_widget_get_screen (GTK_WIDGET (combo_box));
1891 monitor_num = gdk_screen_get_monitor_at_window (screen,
1892 gtk_widget_get_window (GTK_WIDGET (combo_box)));
1893 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
1897 else if (*x + req.width > monitor.x + monitor.width)
1898 *x = monitor.x + monitor.width - req.width;
1900 if (monitor.y + monitor.height - *y - child_allocation.height >= req.height)
1901 *y += child_allocation.height;
1902 else if (*y - monitor.y >= req.height)
1904 else if (monitor.y + monitor.height - *y - child_allocation.height > *y - monitor.y)
1905 *y += child_allocation.height;
1913 gtk_combo_box_menu_position_over (GtkMenu *menu,
1919 GtkComboBox *combo_box;
1923 GtkAllocation allocation;
1924 GtkAllocation child_allocation;
1931 combo_box = GTK_COMBO_BOX (user_data);
1932 widget = GTK_WIDGET (combo_box);
1934 active = gtk_menu_get_active (GTK_MENU (combo_box->priv->popup_widget));
1936 gtk_widget_get_allocation (widget, &allocation);
1938 menu_xpos = allocation.x;
1939 menu_ypos = allocation.y + allocation.height / 2 - 2;
1941 if (combo_box->priv->popup_fixed_width)
1942 gtk_widget_get_preferred_width (GTK_WIDGET (menu), &menu_width, NULL);
1944 gtk_widget_get_preferred_width (GTK_WIDGET (menu), NULL, &menu_width);
1948 gtk_widget_get_allocation (active, &child_allocation);
1949 menu_ypos -= child_allocation.height / 2;
1952 children = GTK_MENU_SHELL (combo_box->priv->popup_widget)->priv->children;
1955 child = children->data;
1957 if (active == child)
1960 if (gtk_widget_get_visible (child))
1962 gtk_widget_get_allocation (child, &child_allocation);
1964 menu_ypos -= child_allocation.height;
1967 children = children->next;
1970 if (gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL)
1971 menu_xpos = menu_xpos + allocation.width - menu_width;
1973 gdk_window_get_root_coords (gtk_widget_get_window (widget),
1974 menu_xpos, menu_ypos,
1975 &menu_xpos, &menu_ypos);
1977 /* Clamp the position on screen */
1978 screen_width = gdk_screen_get_width (gtk_widget_get_screen (widget));
1982 else if ((menu_xpos + menu_width) > screen_width)
1983 menu_xpos -= ((menu_xpos + menu_width) - screen_width);
1992 gtk_combo_box_menu_position (GtkMenu *menu,
1998 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
1999 GtkComboBoxPrivate *priv = combo_box->priv;
2000 GtkWidget *menu_item;
2002 if (priv->wrap_width > 0 || priv->cell_view == NULL)
2003 gtk_combo_box_menu_position_below (menu, x, y, push_in, user_data);
2006 /* FIXME handle nested menus better */
2007 menu_item = gtk_menu_get_active (GTK_MENU (priv->popup_widget));
2009 gtk_menu_shell_select_item (GTK_MENU_SHELL (priv->popup_widget),
2012 gtk_combo_box_menu_position_over (menu, x, y, push_in, user_data);
2015 if (!gtk_widget_get_visible (GTK_MENU (priv->popup_widget)->priv->toplevel))
2016 gtk_window_set_type_hint (GTK_WINDOW (GTK_MENU (priv->popup_widget)->priv->toplevel),
2017 GDK_WINDOW_TYPE_HINT_COMBO);
2021 gtk_combo_box_list_position (GtkComboBox *combo_box,
2027 GtkComboBoxPrivate *priv = combo_box->priv;
2028 GtkAllocation allocation;
2031 GdkRectangle monitor;
2032 GtkRequisition popup_req;
2033 GtkPolicyType hpolicy, vpolicy;
2036 /* under windows, the drop down list is as wide as the combo box itself.
2038 GtkWidget *widget = GTK_WIDGET (combo_box);
2042 gtk_widget_get_allocation (widget, &allocation);
2044 if (!gtk_widget_get_has_window (widget))
2050 window = gtk_widget_get_window (widget);
2052 gdk_window_get_root_coords (gtk_widget_get_window (widget),
2055 *width = allocation.width;
2057 hpolicy = vpolicy = GTK_POLICY_NEVER;
2058 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2061 if (combo_box->priv->popup_fixed_width)
2063 gtk_widget_get_preferred_size (priv->scrolled_window, &popup_req, NULL);
2065 if (popup_req.width > *width)
2067 hpolicy = GTK_POLICY_ALWAYS;
2068 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2074 /* XXX This code depends on treeviews properly reporting their natural width
2075 * list-mode menus won't fill up to their natural width until then */
2076 gtk_widget_get_preferred_size (priv->scrolled_window, NULL, &popup_req);
2078 if (popup_req.width > *width)
2080 hpolicy = GTK_POLICY_NEVER;
2081 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2084 *width = popup_req.width;
2088 *height = popup_req.height;
2090 screen = gtk_widget_get_screen (GTK_WIDGET (combo_box));
2091 monitor_num = gdk_screen_get_monitor_at_window (screen, window);
2092 gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
2094 if (gtk_widget_get_direction (GTK_WIDGET (combo_box)) == GTK_TEXT_DIR_RTL)
2095 *x = *x + allocation.width - *width;
2099 else if (*x + *width > monitor.x + monitor.width)
2100 *x = monitor.x + monitor.width - *width;
2102 if (*y + allocation.height + *height <= monitor.y + monitor.height)
2103 *y += allocation.height;
2104 else if (*y - *height >= monitor.y)
2106 else if (monitor.y + monitor.height - (*y + allocation.height) > *y - monitor.y)
2108 *y += allocation.height;
2109 *height = monitor.y + monitor.height - *y;
2113 *height = *y - monitor.y;
2117 if (popup_req.height > *height)
2119 vpolicy = GTK_POLICY_ALWAYS;
2121 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
2127 cell_layout_is_sensitive (GtkCellLayout *layout)
2129 GList *cells, *list;
2132 cells = gtk_cell_layout_get_cells (layout);
2135 for (list = cells; list; list = list->next)
2137 g_object_get (list->data, "sensitive", &sensitive, NULL);
2142 g_list_free (cells);
2148 cell_is_sensitive (GtkCellRenderer *cell,
2151 gboolean *sensitive = data;
2153 g_object_get (cell, "sensitive", sensitive, NULL);
2159 tree_column_row_is_sensitive (GtkComboBox *combo_box,
2162 GtkComboBoxPrivate *priv = combo_box->priv;
2164 if (priv->row_separator_func)
2166 if (priv->row_separator_func (priv->model, iter,
2167 priv->row_separator_data))
2175 gtk_cell_area_apply_attributes (priv->area, priv->model, iter, FALSE, FALSE);
2179 gtk_cell_area_foreach (priv->area, cell_is_sensitive, &sensitive);
2188 update_menu_sensitivity (GtkComboBox *combo_box,
2191 GtkComboBoxPrivate *priv = combo_box->priv;
2192 GList *children, *child;
2193 GtkWidget *item, *submenu, *separator;
2194 GtkWidget *cell_view;
2200 children = gtk_container_get_children (GTK_CONTAINER (menu));
2202 for (child = children; child; child = child->next)
2204 item = GTK_WIDGET (child->data);
2205 cell_view = gtk_bin_get_child (GTK_BIN (item));
2207 if (!GTK_IS_CELL_VIEW (cell_view))
2210 submenu = gtk_menu_item_get_submenu (GTK_MENU_ITEM (item));
2211 if (submenu != NULL)
2213 gtk_widget_set_sensitive (item, TRUE);
2214 update_menu_sensitivity (combo_box, submenu);
2218 sensitive = cell_layout_is_sensitive (GTK_CELL_LAYOUT (cell_view));
2220 if (menu != priv->popup_widget && child == children)
2222 separator = GTK_WIDGET (child->next->data);
2223 g_object_set (item, "visible", sensitive, NULL);
2224 g_object_set (separator, "visible", sensitive, NULL);
2227 gtk_widget_set_sensitive (item, sensitive);
2231 g_list_free (children);
2235 gtk_combo_box_menu_popup (GtkComboBox *combo_box,
2237 guint32 activate_time)
2239 GtkComboBoxPrivate *priv = combo_box->priv;
2242 gint width, min_width, nat_width;
2244 update_menu_sensitivity (combo_box, priv->popup_widget);
2247 if (gtk_tree_row_reference_valid (priv->active_row))
2249 path = gtk_tree_row_reference_get_path (priv->active_row);
2250 active_item = gtk_tree_path_get_indices (path)[0];
2251 gtk_tree_path_free (path);
2253 if (priv->add_tearoffs)
2257 /* FIXME handle nested menus better */
2258 gtk_menu_set_active (GTK_MENU (priv->popup_widget), active_item);
2260 if (priv->wrap_width == 0)
2262 GtkAllocation allocation;
2264 gtk_widget_get_allocation (GTK_WIDGET (combo_box), &allocation);
2265 width = allocation.width;
2266 gtk_widget_set_size_request (priv->popup_widget, -1, -1);
2267 gtk_widget_get_preferred_width (priv->popup_widget, &min_width, &nat_width);
2269 if (combo_box->priv->popup_fixed_width)
2270 width = MAX (width, min_width);
2272 width = MAX (width, nat_width);
2274 gtk_widget_set_size_request (priv->popup_widget, width, -1);
2277 gtk_menu_popup (GTK_MENU (priv->popup_widget),
2279 gtk_combo_box_menu_position, combo_box,
2280 button, activate_time);
2284 popup_grab_on_window (GdkWindow *window,
2285 GdkDevice *keyboard,
2287 guint32 activate_time)
2290 gdk_device_grab (keyboard, window,
2291 GDK_OWNERSHIP_WINDOW, TRUE,
2292 GDK_KEY_PRESS_MASK | GDK_KEY_RELEASE_MASK,
2293 NULL, activate_time) != GDK_GRAB_SUCCESS)
2297 gdk_device_grab (pointer, window,
2298 GDK_OWNERSHIP_WINDOW, TRUE,
2299 GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK |
2300 GDK_POINTER_MOTION_MASK,
2301 NULL, activate_time) != GDK_GRAB_SUCCESS)
2304 gdk_device_ungrab (keyboard, activate_time);
2313 * gtk_combo_box_popup:
2314 * @combo_box: a #GtkComboBox
2316 * Pops up the menu or dropdown list of @combo_box.
2318 * This function is mostly intended for use by accessibility technologies;
2319 * applications should have little use for it.
2324 gtk_combo_box_popup (GtkComboBox *combo_box)
2326 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2328 g_signal_emit (combo_box, combo_box_signals[POPUP], 0);
2332 * gtk_combo_box_popup_for_device:
2333 * @combo_box: a #GtkComboBox
2334 * @device: a #GdkDevice
2336 * Pops up the menu or dropdown list of @combo_box, the popup window
2337 * will be grabbed so only @device and its associated pointer/keyboard
2338 * are the only #GdkDevice<!-- -->s able to send events to it.
2343 gtk_combo_box_popup_for_device (GtkComboBox *combo_box,
2346 GtkComboBoxPrivate *priv = combo_box->priv;
2347 gint x, y, width, height;
2348 GtkTreePath *path = NULL, *ppath;
2349 GtkWidget *toplevel;
2350 GdkDevice *keyboard, *pointer;
2353 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2354 g_return_if_fail (GDK_IS_DEVICE (device));
2356 if (!gtk_widget_get_realized (GTK_WIDGET (combo_box)))
2359 if (gtk_widget_get_mapped (priv->popup_widget))
2362 if (priv->grab_pointer && priv->grab_keyboard)
2365 time = gtk_get_current_event_time ();
2367 if (gdk_device_get_source (device) == GDK_SOURCE_KEYBOARD)
2370 pointer = gdk_device_get_associated_device (device);
2375 keyboard = gdk_device_get_associated_device (device);
2378 if (GTK_IS_MENU (priv->popup_widget))
2380 gtk_combo_box_menu_popup (combo_box,
2381 priv->activate_button,
2382 priv->activate_time);
2386 toplevel = gtk_widget_get_toplevel (GTK_WIDGET (combo_box));
2387 if (GTK_IS_WINDOW (toplevel))
2388 gtk_window_group_add_window (gtk_window_get_group (GTK_WINDOW (toplevel)),
2389 GTK_WINDOW (priv->popup_window));
2391 gtk_widget_show_all (priv->scrolled_window);
2392 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
2394 gtk_widget_set_size_request (priv->popup_window, width, height);
2395 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
2397 if (gtk_tree_row_reference_valid (priv->active_row))
2399 path = gtk_tree_row_reference_get_path (priv->active_row);
2400 ppath = gtk_tree_path_copy (path);
2401 if (gtk_tree_path_up (ppath))
2402 gtk_tree_view_expand_to_path (GTK_TREE_VIEW (priv->tree_view),
2404 gtk_tree_path_free (ppath);
2406 gtk_tree_view_set_hover_expand (GTK_TREE_VIEW (priv->tree_view),
2410 gtk_widget_show (priv->popup_window);
2414 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
2416 gtk_tree_path_free (path);
2419 gtk_widget_grab_focus (priv->popup_window);
2420 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
2423 if (!gtk_widget_has_focus (priv->tree_view))
2424 gtk_widget_grab_focus (priv->tree_view);
2426 if (!popup_grab_on_window (gtk_widget_get_window (priv->popup_window),
2427 keyboard, pointer, time))
2429 gtk_widget_hide (priv->popup_window);
2433 gtk_device_grab_add (priv->popup_window, pointer, TRUE);
2434 priv->grab_pointer = pointer;
2435 priv->grab_keyboard = keyboard;
2439 gtk_combo_box_real_popup (GtkComboBox *combo_box)
2443 device = gtk_get_current_event_device ();
2447 GdkDeviceManager *device_manager;
2448 GdkDisplay *display;
2451 display = gtk_widget_get_display (GTK_WIDGET (combo_box));
2452 device_manager = gdk_display_get_device_manager (display);
2454 /* No device was set, pick the first master device */
2455 devices = gdk_device_manager_list_devices (device_manager, GDK_DEVICE_TYPE_MASTER);
2456 device = devices->data;
2457 g_list_free (devices);
2460 gtk_combo_box_popup_for_device (combo_box, device);
2464 gtk_combo_box_real_popdown (GtkComboBox *combo_box)
2466 if (combo_box->priv->popup_shown)
2468 gtk_combo_box_popdown (combo_box);
2476 * gtk_combo_box_popdown:
2477 * @combo_box: a #GtkComboBox
2479 * Hides the menu or dropdown list of @combo_box.
2481 * This function is mostly intended for use by accessibility technologies;
2482 * applications should have little use for it.
2487 gtk_combo_box_popdown (GtkComboBox *combo_box)
2489 GtkComboBoxPrivate *priv = combo_box->priv;
2491 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
2493 if (GTK_IS_MENU (priv->popup_widget))
2495 gtk_menu_popdown (GTK_MENU (priv->popup_widget));
2499 if (!gtk_widget_get_realized (GTK_WIDGET (combo_box)))
2502 gtk_device_grab_remove (priv->popup_window, priv->grab_pointer);
2503 gtk_widget_hide (priv->popup_window);
2504 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button),
2507 priv->grab_pointer = NULL;
2508 priv->grab_keyboard = NULL;
2511 #define GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON \
2512 gtk_widget_get_preferred_size (combo_box->priv->button, \
2516 child.x = allocation->x + padding.right; \
2518 child.x = allocation->x + allocation->width - req.width - padding.left; \
2520 child.y = allocation->y + padding.top; \
2521 child.width = req.width; \
2522 child.height = allocation->height - (padding.top + padding.bottom); \
2523 child.width = MAX (1, child.width); \
2524 child.height = MAX (1, child.height); \
2526 gtk_widget_size_allocate (combo_box->priv->button, &child);
2530 gtk_combo_box_size_allocate (GtkWidget *widget,
2531 GtkAllocation *allocation)
2533 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
2534 GtkComboBoxPrivate *priv = combo_box->priv;
2535 GtkWidget *child_widget;
2536 gint focus_width, focus_pad;
2537 GtkAllocation child;
2539 gboolean is_rtl = gtk_widget_get_direction (widget) == GTK_TEXT_DIR_RTL;
2542 gtk_widget_set_allocation (widget, allocation);
2543 child_widget = gtk_bin_get_child (GTK_BIN (widget));
2544 get_widget_padding (widget, &padding);
2546 gtk_widget_style_get (widget,
2547 "focus-line-width", &focus_width,
2548 "focus-padding", &focus_pad,
2551 if (!priv->tree_view)
2553 if (priv->cell_view)
2555 GtkBorder button_padding;
2559 gtk_widget_size_allocate (priv->button, allocation);
2562 allocation->x += padding.left;
2563 allocation->y += padding.top;
2564 allocation->width -= padding.left + padding.right;
2565 allocation->height -= padding.top + padding.bottom;
2567 /* set some things ready */
2568 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->button));
2569 get_widget_padding (priv->button, &button_padding);
2571 child.x = allocation->x;
2572 child.y = allocation->y;
2573 width = allocation->width;
2574 child.height = allocation->height;
2576 if (!priv->is_cell_renderer)
2578 child.x += border_width + button_padding.left + focus_width + focus_pad;
2579 child.y += border_width + button_padding.top + focus_width + focus_pad;
2580 width -= (2 * (border_width + focus_width + focus_pad)) +
2581 button_padding.left + button_padding.right;
2582 child.height -= (2 * (border_width + focus_width + focus_pad)) +
2583 button_padding.top + button_padding.bottom;
2586 /* handle the children */
2587 gtk_widget_get_preferred_size (priv->arrow, &req, NULL);
2588 child.width = req.width;
2590 child.x += width - req.width - button_padding.right;
2591 child.width = MAX (1, child.width);
2592 child.height = MAX (1, child.height);
2593 gtk_widget_size_allocate (priv->arrow, &child);
2595 child.x += req.width;
2596 gtk_widget_get_preferred_size (priv->separator, &req, NULL);
2597 child.width = req.width;
2599 child.x -= req.width;
2600 child.width = MAX (1, child.width);
2601 child.height = MAX (1, child.height);
2602 gtk_widget_size_allocate (priv->separator, &child);
2606 child.x += req.width;
2607 child.width = allocation->x + allocation->width
2608 - (border_width + focus_width + focus_pad)
2613 child.width = child.x;
2614 child.x = allocation->x
2615 + border_width + button_padding.left + focus_width + focus_pad;
2616 child.width -= child.x;
2619 if (gtk_widget_get_visible (priv->popup_widget))
2621 gint width, menu_width;
2623 if (priv->wrap_width == 0)
2625 GtkAllocation combo_box_allocation;
2627 gtk_widget_get_allocation (GTK_WIDGET (combo_box), &combo_box_allocation);
2628 width = combo_box_allocation.width;
2629 gtk_widget_set_size_request (priv->popup_widget, -1, -1);
2631 if (combo_box->priv->popup_fixed_width)
2632 gtk_widget_get_preferred_width (priv->popup_widget, &menu_width, NULL);
2634 gtk_widget_get_preferred_width (priv->popup_widget, NULL, &menu_width);
2636 gtk_widget_set_size_request (priv->popup_widget,
2637 MAX (width, menu_width), -1);
2640 /* reposition the menu after giving it a new width */
2641 gtk_menu_reposition (GTK_MENU (priv->popup_widget));
2644 child.width = MAX (1, child.width);
2645 child.height = MAX (1, child.height);
2646 gtk_widget_size_allocate (child_widget, &child);
2650 GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON
2653 child.x = allocation->x + req.width + padding.right;
2655 child.x = allocation->x + padding.left;
2656 child.y = allocation->y + padding.top;
2657 child.width = allocation->width - req.width - (padding.left + padding.right);
2658 child.width = MAX (1, child.width);
2659 child.height = MAX (1, child.height);
2660 gtk_widget_size_allocate (child_widget, &child);
2666 guint border_width = gtk_container_get_border_width (GTK_CONTAINER (widget));
2669 GTK_COMBO_BOX_SIZE_ALLOCATE_BUTTON
2673 child.x = allocation->x + req.width;
2675 child.x = allocation->x;
2677 child.y = allocation->y;
2678 child.width = allocation->width - req.width;
2679 child.height = allocation->height;
2681 if (priv->cell_view_frame)
2683 child.x += padding.left + border_width;
2684 child.y += padding.top + border_width;
2685 child.width = MAX (1, child.width - (2 * border_width) - (padding.left + padding.right));
2686 child.height = MAX (1, child.height - (2 * border_width) - (padding.top + padding.bottom));
2687 gtk_widget_size_allocate (priv->cell_view_frame, &child);
2690 if (priv->has_frame)
2692 GtkBorder frame_padding;
2694 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
2695 get_widget_padding (priv->cell_view_frame, &frame_padding);
2697 child.x += border_width + frame_padding.left;
2698 child.y += border_width + frame_padding.right;
2699 child.width -= (2 * border_width) + frame_padding.left + frame_padding.right;
2700 child.height -= (2 * border_width) + frame_padding.top + frame_padding.bottom;
2705 child.x += padding.left + border_width;
2706 child.y += padding.top + border_width;
2707 child.width -= (2 * border_width) - (padding.left + padding.right);
2708 child.height -= (2 * border_width) - (padding.top + padding.bottom);
2711 if (gtk_widget_get_visible (priv->popup_window))
2713 gint x, y, width, height;
2714 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
2715 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
2716 gtk_widget_set_size_request (priv->popup_window, width, height);
2719 child.width = MAX (1, child.width);
2720 child.height = MAX (1, child.height);
2721 gtk_widget_size_allocate (child_widget, &child);
2725 #undef GTK_COMBO_BOX_ALLOCATE_BUTTON
2728 gtk_combo_box_unset_model (GtkComboBox *combo_box)
2730 GtkComboBoxPrivate *priv = combo_box->priv;
2734 g_signal_handler_disconnect (priv->model,
2736 g_signal_handler_disconnect (priv->model,
2738 g_signal_handler_disconnect (priv->model,
2739 priv->reordered_id);
2740 g_signal_handler_disconnect (priv->model,
2746 g_object_unref (priv->model);
2750 if (priv->active_row)
2752 gtk_tree_row_reference_free (priv->active_row);
2753 priv->active_row = NULL;
2756 if (priv->cell_view)
2757 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view), NULL);
2761 gtk_combo_box_forall (GtkContainer *container,
2762 gboolean include_internals,
2763 GtkCallback callback,
2764 gpointer callback_data)
2766 GtkComboBox *combo_box = GTK_COMBO_BOX (container);
2767 GtkComboBoxPrivate *priv = combo_box->priv;
2770 if (include_internals)
2773 (* callback) (priv->button, callback_data);
2774 if (priv->cell_view_frame)
2775 (* callback) (priv->cell_view_frame, callback_data);
2778 child = gtk_bin_get_child (GTK_BIN (container));
2780 (* callback) (child, callback_data);
2784 gtk_combo_box_child_show (GtkWidget *widget,
2785 GtkComboBox *combo_box)
2787 GtkComboBoxPrivate *priv = combo_box->priv;
2789 priv->popup_shown = TRUE;
2790 g_object_notify (G_OBJECT (combo_box), "popup-shown");
2794 gtk_combo_box_child_hide (GtkWidget *widget,
2795 GtkComboBox *combo_box)
2797 GtkComboBoxPrivate *priv = combo_box->priv;
2799 priv->popup_shown = FALSE;
2800 g_object_notify (G_OBJECT (combo_box), "popup-shown");
2804 gtk_combo_box_draw (GtkWidget *widget,
2807 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
2808 GtkComboBoxPrivate *priv = combo_box->priv;
2810 if (priv->shadow_type != GTK_SHADOW_NONE)
2812 GtkStyleContext *context;
2813 GtkStateFlags state;
2815 context = gtk_widget_get_style_context (widget);
2816 state = gtk_widget_get_state_flags (widget);
2817 gtk_style_context_set_state (context, state);
2819 gtk_render_background (context, cr, 0, 0,
2820 gtk_widget_get_allocated_width (widget),
2821 gtk_widget_get_allocated_height (widget));
2822 gtk_render_frame (context, cr, 0, 0,
2823 gtk_widget_get_allocated_width (widget),
2824 gtk_widget_get_allocated_height (widget));
2827 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2830 if (priv->tree_view && priv->cell_view_frame)
2832 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2833 priv->cell_view_frame, cr);
2836 gtk_container_propagate_draw (GTK_CONTAINER (widget),
2837 gtk_bin_get_child (GTK_BIN (widget)),
2853 path_visible (GtkTreeView *view,
2859 /* Note that we rely on the fact that collapsed rows don't have nodes
2861 return _gtk_tree_view_find_node (view, path, &tree, &node);
2865 tree_next_func (GtkTreeModel *model,
2870 SearchData *search_data = (SearchData *)data;
2872 if (search_data->found)
2874 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2877 if (search_data->visible &&
2878 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2881 search_data->set = TRUE;
2882 search_data->iter = *iter;
2887 if (gtk_tree_path_compare (path, search_data->path) == 0)
2888 search_data->found = TRUE;
2894 tree_next (GtkComboBox *combo,
2895 GtkTreeModel *model,
2900 SearchData search_data;
2902 search_data.combo = combo;
2903 search_data.path = gtk_tree_model_get_path (model, iter);
2904 search_data.visible = visible;
2905 search_data.found = FALSE;
2906 search_data.set = FALSE;
2908 gtk_tree_model_foreach (model, tree_next_func, &search_data);
2910 *next = search_data.iter;
2912 gtk_tree_path_free (search_data.path);
2914 return search_data.set;
2918 tree_prev_func (GtkTreeModel *model,
2923 SearchData *search_data = (SearchData *)data;
2925 if (gtk_tree_path_compare (path, search_data->path) == 0)
2927 search_data->found = TRUE;
2931 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2934 if (search_data->visible &&
2935 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2938 search_data->set = TRUE;
2939 search_data->iter = *iter;
2945 tree_prev (GtkComboBox *combo,
2946 GtkTreeModel *model,
2951 SearchData search_data;
2953 search_data.combo = combo;
2954 search_data.path = gtk_tree_model_get_path (model, iter);
2955 search_data.visible = visible;
2956 search_data.found = FALSE;
2957 search_data.set = FALSE;
2959 gtk_tree_model_foreach (model, tree_prev_func, &search_data);
2961 *prev = search_data.iter;
2963 gtk_tree_path_free (search_data.path);
2965 return search_data.set;
2969 tree_last_func (GtkTreeModel *model,
2974 SearchData *search_data = (SearchData *)data;
2976 if (!tree_column_row_is_sensitive (search_data->combo, iter))
2979 /* Note that we rely on the fact that collapsed rows don't have nodes
2981 if (search_data->visible &&
2982 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
2985 search_data->set = TRUE;
2986 search_data->iter = *iter;
2992 tree_last (GtkComboBox *combo,
2993 GtkTreeModel *model,
2997 SearchData search_data;
2999 search_data.combo = combo;
3000 search_data.visible = visible;
3001 search_data.set = FALSE;
3003 gtk_tree_model_foreach (model, tree_last_func, &search_data);
3005 *last = search_data.iter;
3007 return search_data.set;
3012 tree_first_func (GtkTreeModel *model,
3017 SearchData *search_data = (SearchData *)data;
3019 if (!tree_column_row_is_sensitive (search_data->combo, iter))
3022 if (search_data->visible &&
3023 !path_visible (GTK_TREE_VIEW (search_data->combo->priv->tree_view), path))
3026 search_data->set = TRUE;
3027 search_data->iter = *iter;
3033 tree_first (GtkComboBox *combo,
3034 GtkTreeModel *model,
3038 SearchData search_data;
3040 search_data.combo = combo;
3041 search_data.visible = visible;
3042 search_data.set = FALSE;
3044 gtk_tree_model_foreach (model, tree_first_func, &search_data);
3046 *first = search_data.iter;
3048 return search_data.set;
3052 gtk_combo_box_scroll_event (GtkWidget *widget,
3053 GdkEventScroll *event)
3055 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
3058 GtkTreeIter new_iter;
3060 if (!gtk_combo_box_get_active_iter (combo_box, &iter))
3063 if (event->direction == GDK_SCROLL_UP)
3064 found = tree_prev (combo_box, combo_box->priv->model,
3065 &iter, &new_iter, FALSE);
3067 found = tree_next (combo_box, combo_box->priv->model,
3068 &iter, &new_iter, FALSE);
3071 gtk_combo_box_set_active_iter (combo_box, &new_iter);
3080 gtk_combo_box_row_separator_func (GtkTreeModel *model,
3084 GtkComboBoxPrivate *priv = combo->priv;
3086 if (priv->row_separator_func)
3087 return priv->row_separator_func (model, iter, priv->row_separator_data);
3093 gtk_combo_box_header_func (GtkTreeModel *model,
3097 /* Every submenu has a selectable header, however we
3098 * can expose a method to make that configurable by
3099 * the user (like row_separator_func is done) */
3104 gtk_combo_box_menu_setup (GtkComboBox *combo_box,
3105 gboolean add_children)
3107 GtkComboBoxPrivate *priv = combo_box->priv;
3111 child = gtk_bin_get_child (GTK_BIN (combo_box));
3113 if (priv->cell_view)
3115 priv->button = gtk_toggle_button_new ();
3116 gtk_button_set_focus_on_click (GTK_BUTTON (priv->button),
3117 priv->focus_on_click);
3119 g_signal_connect (priv->button, "toggled",
3120 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3121 gtk_widget_set_parent (priv->button,
3122 gtk_widget_get_parent (child));
3124 priv->box = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 0);
3125 gtk_container_add (GTK_CONTAINER (priv->button), priv->box);
3127 priv->separator = gtk_separator_new (GTK_ORIENTATION_VERTICAL);
3128 gtk_container_add (GTK_CONTAINER (priv->box), priv->separator);
3130 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3131 gtk_container_add (GTK_CONTAINER (priv->box), priv->arrow);
3133 gtk_widget_show_all (priv->button);
3137 priv->button = gtk_toggle_button_new ();
3138 gtk_button_set_focus_on_click (GTK_BUTTON (priv->button),
3139 priv->focus_on_click);
3141 g_signal_connect (priv->button, "toggled",
3142 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3143 gtk_widget_set_parent (priv->button,
3144 gtk_widget_get_parent (child));
3146 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3147 gtk_container_add (GTK_CONTAINER (priv->button), priv->arrow);
3148 gtk_widget_show_all (priv->button);
3151 g_signal_connect (priv->button, "button-press-event",
3152 G_CALLBACK (gtk_combo_box_menu_button_press),
3154 g_signal_connect (priv->button, "state-flags-changed",
3155 G_CALLBACK (gtk_combo_box_button_state_flags_changed),
3158 /* create our funky menu */
3159 menu = _gtk_tree_menu_new_with_area (priv->area);
3160 gtk_widget_set_name (menu, "gtk-combobox-popup-menu");
3162 _gtk_tree_menu_set_model (GTK_TREE_MENU (menu), priv->model);
3164 _gtk_tree_menu_set_wrap_width (GTK_TREE_MENU (menu), priv->wrap_width);
3165 _gtk_tree_menu_set_row_span_column (GTK_TREE_MENU (menu), priv->row_column);
3166 _gtk_tree_menu_set_column_span_column (GTK_TREE_MENU (menu), priv->col_column);
3167 _gtk_tree_menu_set_tearoff (GTK_TREE_MENU (menu),
3168 combo_box->priv->add_tearoffs);
3170 g_signal_connect (menu, "menu-activate",
3171 G_CALLBACK (gtk_combo_box_menu_activate), combo_box);
3173 /* Chain our row_separator_func through */
3174 _gtk_tree_menu_set_row_separator_func (GTK_TREE_MENU (menu),
3175 (GtkTreeViewRowSeparatorFunc)gtk_combo_box_row_separator_func,
3178 _gtk_tree_menu_set_header_func (GTK_TREE_MENU (menu),
3179 (GtkTreeMenuHeaderFunc)gtk_combo_box_header_func,
3182 g_signal_connect (menu, "key-press-event",
3183 G_CALLBACK (gtk_combo_box_menu_key_press), combo_box);
3184 gtk_combo_box_set_popup_widget (combo_box, menu);
3186 gtk_combo_box_update_title (combo_box);
3190 gtk_combo_box_menu_destroy (GtkComboBox *combo_box)
3192 GtkComboBoxPrivate *priv = combo_box->priv;
3194 g_signal_handlers_disconnect_matched (priv->button,
3195 G_SIGNAL_MATCH_DATA,
3197 gtk_combo_box_menu_button_press, NULL);
3198 g_signal_handlers_disconnect_matched (priv->button,
3199 G_SIGNAL_MATCH_DATA,
3201 gtk_combo_box_button_state_flags_changed, combo_box);
3202 g_signal_handlers_disconnect_matched (priv->popup_widget,
3203 G_SIGNAL_MATCH_DATA,
3205 gtk_combo_box_menu_activate, combo_box);
3207 /* unparent will remove our latest ref */
3208 gtk_widget_unparent (priv->button);
3211 priv->button = NULL;
3213 priv->separator = NULL;
3215 /* changing the popup window will unref the menu and the children */
3220 gtk_combo_box_menu_button_press (GtkWidget *widget,
3221 GdkEventButton *event,
3224 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3225 GtkComboBoxPrivate *priv = combo_box->priv;
3227 if (GTK_IS_MENU (priv->popup_widget) &&
3228 event->type == GDK_BUTTON_PRESS && event->button == 1)
3230 if (priv->focus_on_click &&
3231 !gtk_widget_has_focus (priv->button))
3232 gtk_widget_grab_focus (priv->button);
3234 gtk_combo_box_menu_popup (combo_box, event->button, event->time);
3243 gtk_combo_box_menu_activate (GtkWidget *menu,
3245 GtkComboBox *combo_box)
3249 if (gtk_tree_model_get_iter_from_string (combo_box->priv->model, &iter, path))
3250 gtk_combo_box_set_active_iter (combo_box, &iter);
3252 g_object_set (combo_box,
3253 "editing-canceled", FALSE,
3259 gtk_combo_box_update_sensitivity (GtkComboBox *combo_box)
3262 gboolean sensitive = TRUE; /* fool code checkers */
3264 if (!combo_box->priv->button)
3267 switch (combo_box->priv->button_sensitivity)
3269 case GTK_SENSITIVITY_ON:
3272 case GTK_SENSITIVITY_OFF:
3275 case GTK_SENSITIVITY_AUTO:
3276 sensitive = combo_box->priv->model &&
3277 gtk_tree_model_get_iter_first (combo_box->priv->model, &iter);
3280 g_assert_not_reached ();
3284 gtk_widget_set_sensitive (combo_box->priv->button, sensitive);
3286 /* In list-mode, we also need to update sensitivity of the event box */
3287 if (GTK_IS_TREE_VIEW (combo_box->priv->tree_view)
3288 && combo_box->priv->cell_view)
3289 gtk_widget_set_sensitive (combo_box->priv->box, sensitive);
3293 gtk_combo_box_model_row_inserted (GtkTreeModel *model,
3298 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3300 if (combo_box->priv->tree_view)
3301 gtk_combo_box_list_popup_resize (combo_box);
3303 gtk_combo_box_update_sensitivity (combo_box);
3307 gtk_combo_box_model_row_deleted (GtkTreeModel *model,
3311 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3312 GtkComboBoxPrivate *priv = combo_box->priv;
3314 if (!gtk_tree_row_reference_valid (priv->active_row))
3316 if (priv->cell_view)
3317 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view), NULL);
3318 g_signal_emit (combo_box, combo_box_signals[CHANGED], 0);
3321 if (priv->tree_view)
3322 gtk_combo_box_list_popup_resize (combo_box);
3324 gtk_combo_box_update_sensitivity (combo_box);
3328 gtk_combo_box_model_rows_reordered (GtkTreeModel *model,
3334 gtk_tree_row_reference_reordered (G_OBJECT (user_data), path, iter, new_order);
3338 gtk_combo_box_model_row_changed (GtkTreeModel *model,
3343 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3344 GtkComboBoxPrivate *priv = combo_box->priv;
3345 GtkTreePath *active_path;
3347 /* FIXME this belongs to GtkCellView */
3348 if (gtk_tree_row_reference_valid (priv->active_row))
3350 active_path = gtk_tree_row_reference_get_path (priv->active_row);
3351 if (gtk_tree_path_compare (path, active_path) == 0 &&
3353 gtk_widget_queue_resize (GTK_WIDGET (priv->cell_view));
3354 gtk_tree_path_free (active_path);
3357 if (priv->tree_view)
3358 gtk_combo_box_list_row_changed (model, path, iter, user_data);
3362 list_popup_resize_idle (gpointer user_data)
3364 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3365 GtkComboBoxPrivate *priv = combo_box->priv;
3366 gint x, y, width, height;
3368 if (priv->tree_view && gtk_widget_get_mapped (priv->popup_window))
3370 gtk_combo_box_list_position (combo_box, &x, &y, &width, &height);
3372 gtk_widget_set_size_request (priv->popup_window, width, height);
3373 gtk_window_move (GTK_WINDOW (priv->popup_window), x, y);
3376 priv->resize_idle_id = 0;
3382 gtk_combo_box_list_popup_resize (GtkComboBox *combo_box)
3384 GtkComboBoxPrivate *priv = combo_box->priv;
3386 if (!priv->resize_idle_id)
3387 priv->resize_idle_id =
3388 gdk_threads_add_idle (list_popup_resize_idle, combo_box);
3392 gtk_combo_box_model_row_expanded (GtkTreeModel *model,
3397 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
3399 gtk_combo_box_list_popup_resize (combo_box);
3408 gtk_combo_box_list_setup (GtkComboBox *combo_box)
3410 GtkComboBoxPrivate *priv = combo_box->priv;
3411 GtkTreeSelection *sel;
3413 GtkWidget *widget = GTK_WIDGET (combo_box);
3415 priv->button = gtk_toggle_button_new ();
3416 child = gtk_bin_get_child (GTK_BIN (combo_box));
3417 gtk_widget_set_parent (priv->button,
3418 gtk_widget_get_parent (child));
3419 g_signal_connect (priv->button, "button-press-event",
3420 G_CALLBACK (gtk_combo_box_list_button_pressed), combo_box);
3421 g_signal_connect (priv->button, "toggled",
3422 G_CALLBACK (gtk_combo_box_button_toggled), combo_box);
3424 priv->arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_NONE);
3425 gtk_container_add (GTK_CONTAINER (priv->button), priv->arrow);
3426 priv->separator = NULL;
3427 gtk_widget_show_all (priv->button);
3429 if (priv->cell_view)
3431 GtkStyleContext *context;
3432 GtkStateFlags state;
3435 context = gtk_widget_get_style_context (widget);
3436 state = gtk_widget_get_state_flags (widget);
3437 gtk_style_context_get_background_color (context, state, &color);
3439 gtk_cell_view_set_background_rgba (GTK_CELL_VIEW (priv->cell_view), &color);
3441 priv->box = gtk_event_box_new ();
3442 gtk_event_box_set_visible_window (GTK_EVENT_BOX (priv->box),
3445 if (priv->has_frame)
3447 priv->cell_view_frame = gtk_frame_new (NULL);
3448 gtk_frame_set_shadow_type (GTK_FRAME (priv->cell_view_frame),
3453 combo_box->priv->cell_view_frame = gtk_event_box_new ();
3454 gtk_event_box_set_visible_window (GTK_EVENT_BOX (combo_box->priv->cell_view_frame),
3458 gtk_widget_set_parent (priv->cell_view_frame,
3459 gtk_widget_get_parent (child));
3460 gtk_container_add (GTK_CONTAINER (priv->cell_view_frame), priv->box);
3461 gtk_widget_show_all (priv->cell_view_frame);
3463 g_signal_connect (priv->box, "button-press-event",
3464 G_CALLBACK (gtk_combo_box_list_button_pressed),
3468 priv->tree_view = gtk_tree_view_new ();
3469 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
3470 gtk_tree_selection_set_mode (sel, GTK_SELECTION_BROWSE);
3471 gtk_tree_selection_set_select_function (sel,
3472 gtk_combo_box_list_select_func,
3474 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view),
3476 gtk_tree_view_set_hover_selection (GTK_TREE_VIEW (priv->tree_view),
3479 gtk_tree_view_set_row_separator_func (GTK_TREE_VIEW (priv->tree_view),
3480 (GtkTreeViewRowSeparatorFunc)gtk_combo_box_row_separator_func,
3484 gtk_tree_view_set_model (GTK_TREE_VIEW (priv->tree_view), priv->model);
3486 gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view),
3487 gtk_tree_view_column_new_with_area (priv->area));
3489 if (gtk_tree_row_reference_valid (priv->active_row))
3493 path = gtk_tree_row_reference_get_path (priv->active_row);
3494 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
3496 gtk_tree_path_free (path);
3499 /* set sample/popup widgets */
3500 gtk_combo_box_set_popup_widget (combo_box, priv->tree_view);
3502 g_signal_connect (priv->tree_view, "key-press-event",
3503 G_CALLBACK (gtk_combo_box_list_key_press),
3505 g_signal_connect (priv->tree_view, "enter-notify-event",
3506 G_CALLBACK (gtk_combo_box_list_enter_notify),
3508 g_signal_connect (priv->tree_view, "row-expanded",
3509 G_CALLBACK (gtk_combo_box_model_row_expanded),
3511 g_signal_connect (priv->tree_view, "row-collapsed",
3512 G_CALLBACK (gtk_combo_box_model_row_expanded),
3514 g_signal_connect (priv->popup_window, "button-press-event",
3515 G_CALLBACK (gtk_combo_box_list_button_pressed),
3517 g_signal_connect (priv->popup_window, "button-release-event",
3518 G_CALLBACK (gtk_combo_box_list_button_released),
3521 gtk_widget_show (priv->tree_view);
3523 gtk_combo_box_update_sensitivity (combo_box);
3527 gtk_combo_box_list_destroy (GtkComboBox *combo_box)
3529 GtkComboBoxPrivate *priv = combo_box->priv;
3531 /* disconnect signals */
3532 g_signal_handlers_disconnect_matched (priv->tree_view,
3533 G_SIGNAL_MATCH_DATA,
3534 0, 0, NULL, NULL, combo_box);
3535 g_signal_handlers_disconnect_matched (priv->button,
3536 G_SIGNAL_MATCH_DATA,
3538 gtk_combo_box_list_button_pressed,
3540 g_signal_handlers_disconnect_matched (priv->popup_window,
3541 G_SIGNAL_MATCH_DATA,
3543 gtk_combo_box_list_button_pressed,
3545 g_signal_handlers_disconnect_matched (priv->popup_window,
3546 G_SIGNAL_MATCH_DATA,
3548 gtk_combo_box_list_button_released,
3551 g_signal_handlers_disconnect_matched (priv->popup_window,
3552 G_SIGNAL_MATCH_DATA,
3554 gtk_combo_box_child_show,
3557 g_signal_handlers_disconnect_matched (priv->popup_window,
3558 G_SIGNAL_MATCH_DATA,
3560 gtk_combo_box_child_hide,
3564 g_signal_handlers_disconnect_matched (priv->box,
3565 G_SIGNAL_MATCH_DATA,
3567 gtk_combo_box_list_button_pressed,
3570 /* destroy things (unparent will kill the latest ref from us)
3571 * last unref on button will destroy the arrow
3573 gtk_widget_unparent (priv->button);
3574 priv->button = NULL;
3577 if (priv->cell_view)
3579 g_object_set (priv->cell_view,
3580 "background-set", FALSE,
3584 if (priv->cell_view_frame)
3586 gtk_widget_unparent (priv->cell_view_frame);
3587 priv->cell_view_frame = NULL;
3591 if (priv->scroll_timer)
3593 g_source_remove (priv->scroll_timer);
3594 priv->scroll_timer = 0;
3597 if (priv->resize_idle_id)
3599 g_source_remove (priv->resize_idle_id);
3600 priv->resize_idle_id = 0;
3603 gtk_widget_destroy (priv->tree_view);
3605 priv->tree_view = NULL;
3606 if (priv->popup_widget)
3608 g_object_unref (priv->popup_widget);
3609 priv->popup_widget = NULL;
3616 gtk_combo_box_list_button_pressed (GtkWidget *widget,
3617 GdkEventButton *event,
3620 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3621 GtkComboBoxPrivate *priv = combo_box->priv;
3623 GtkWidget *ewidget = gtk_get_event_widget ((GdkEvent *)event);
3625 if (ewidget == priv->popup_window)
3628 if ((ewidget != priv->button && ewidget != priv->box) ||
3629 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->button)))
3632 if (priv->focus_on_click &&
3633 !gtk_widget_has_focus (priv->button))
3634 gtk_widget_grab_focus (priv->button);
3636 gtk_combo_box_popup_for_device (combo_box, event->device);
3638 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->button), TRUE);
3640 priv->auto_scroll = FALSE;
3641 if (priv->scroll_timer == 0)
3642 priv->scroll_timer = gdk_threads_add_timeout (SCROLL_TIME,
3643 (GSourceFunc) gtk_combo_box_list_scroll_timeout,
3646 priv->popup_in_progress = TRUE;
3652 gtk_combo_box_list_button_released (GtkWidget *widget,
3653 GdkEventButton *event,
3657 GtkTreePath *path = NULL;
3660 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3661 GtkComboBoxPrivate *priv = combo_box->priv;
3663 gboolean popup_in_progress = FALSE;
3665 GtkWidget *ewidget = gtk_get_event_widget ((GdkEvent *)event);
3667 if (priv->popup_in_progress)
3669 popup_in_progress = TRUE;
3670 priv->popup_in_progress = FALSE;
3673 gtk_tree_view_set_hover_expand (GTK_TREE_VIEW (priv->tree_view),
3675 if (priv->scroll_timer)
3677 g_source_remove (priv->scroll_timer);
3678 priv->scroll_timer = 0;
3681 if (ewidget != priv->tree_view)
3683 if ((ewidget == priv->button ||
3684 ewidget == priv->box) &&
3685 !popup_in_progress &&
3686 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->button)))
3688 gtk_combo_box_popdown (combo_box);
3692 /* released outside treeview */
3693 if (ewidget != priv->button && ewidget != priv->box)
3695 gtk_combo_box_popdown (combo_box);
3703 /* select something cool */
3704 ret = gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (priv->tree_view),
3710 return TRUE; /* clicked outside window? */
3712 gtk_tree_model_get_iter (priv->model, &iter, path);
3713 gtk_tree_path_free (path);
3715 gtk_combo_box_popdown (combo_box);
3717 if (tree_column_row_is_sensitive (combo_box, &iter))
3718 gtk_combo_box_set_active_iter (combo_box, &iter);
3724 gtk_combo_box_menu_key_press (GtkWidget *widget,
3728 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3730 if (!gtk_bindings_activate_event (G_OBJECT (widget), event))
3732 /* The menu hasn't managed the
3733 * event, forward it to the combobox
3735 gtk_bindings_activate_event (G_OBJECT (combo_box), event);
3742 gtk_combo_box_list_key_press (GtkWidget *widget,
3746 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3749 if (event->keyval == GDK_KEY_Return || event->keyval == GDK_KEY_ISO_Enter || event->keyval == GDK_KEY_KP_Enter ||
3750 event->keyval == GDK_KEY_space || event->keyval == GDK_KEY_KP_Space)
3752 GtkTreeModel *model = NULL;
3754 gtk_combo_box_popdown (combo_box);
3756 if (combo_box->priv->model)
3758 GtkTreeSelection *sel;
3760 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (combo_box->priv->tree_view));
3762 if (gtk_tree_selection_get_selected (sel, &model, &iter))
3763 gtk_combo_box_set_active_iter (combo_box, &iter);
3769 if (!gtk_bindings_activate_event (G_OBJECT (widget), event))
3771 /* The list hasn't managed the
3772 * event, forward it to the combobox
3774 gtk_bindings_activate_event (G_OBJECT (combo_box), event);
3781 gtk_combo_box_list_auto_scroll (GtkComboBox *combo_box,
3786 GtkAllocation allocation;
3787 GtkWidget *tree_view = combo_box->priv->tree_view;
3790 gtk_widget_get_allocation (tree_view, &allocation);
3792 adj = gtk_scrolled_window_get_hadjustment (GTK_SCROLLED_WINDOW (combo_box->priv->scrolled_window));
3793 if (adj && gtk_adjustment_get_upper (adj) - gtk_adjustment_get_lower (adj) > gtk_adjustment_get_page_size (adj))
3795 if (x <= allocation.x &&
3796 gtk_adjustment_get_lower (adj) < gtk_adjustment_get_value (adj))
3798 value = gtk_adjustment_get_value (adj) - (allocation.x - x + 1);
3799 gtk_adjustment_set_value (adj, value);
3801 else if (x >= allocation.x + allocation.width &&
3802 gtk_adjustment_get_upper (adj) - gtk_adjustment_get_page_size (adj) > gtk_adjustment_get_value (adj))
3804 value = gtk_adjustment_get_value (adj) + (x - allocation.x - allocation.width + 1);
3805 gtk_adjustment_set_value (adj, MAX (value, 0.0));
3809 adj = gtk_scrolled_window_get_vadjustment (GTK_SCROLLED_WINDOW (combo_box->priv->scrolled_window));
3810 if (adj && gtk_adjustment_get_upper (adj) - gtk_adjustment_get_lower (adj) > gtk_adjustment_get_page_size (adj))
3812 if (y <= allocation.y &&
3813 gtk_adjustment_get_lower (adj) < gtk_adjustment_get_value (adj))
3815 value = gtk_adjustment_get_value (adj) - (allocation.y - y + 1);
3816 gtk_adjustment_set_value (adj, value);
3818 else if (y >= allocation.height &&
3819 gtk_adjustment_get_upper (adj) - gtk_adjustment_get_page_size (adj) > gtk_adjustment_get_value (adj))
3821 value = gtk_adjustment_get_value (adj) + (y - allocation.height + 1);
3822 gtk_adjustment_set_value (adj, MAX (value, 0.0));
3828 gtk_combo_box_list_scroll_timeout (GtkComboBox *combo_box)
3830 GtkComboBoxPrivate *priv = combo_box->priv;
3833 if (priv->auto_scroll)
3835 gdk_window_get_device_position (gtk_widget_get_window (priv->tree_view),
3838 gtk_combo_box_list_auto_scroll (combo_box, x, y);
3845 gtk_combo_box_list_enter_notify (GtkWidget *widget,
3846 GdkEventCrossing *event,
3849 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
3851 combo_box->priv->auto_scroll = TRUE;
3857 gtk_combo_box_list_select_func (GtkTreeSelection *selection,
3858 GtkTreeModel *model,
3860 gboolean path_currently_selected,
3863 GList *list, *columns;
3864 gboolean sensitive = FALSE;
3866 columns = gtk_tree_view_get_columns (gtk_tree_selection_get_tree_view (selection));
3868 for (list = columns; list && !sensitive; list = list->next)
3870 GList *cells, *cell;
3871 gboolean cell_sensitive, cell_visible;
3873 GtkTreeViewColumn *column = GTK_TREE_VIEW_COLUMN (list->data);
3875 if (!gtk_tree_view_column_get_visible (column))
3878 gtk_tree_model_get_iter (model, &iter, path);
3879 gtk_tree_view_column_cell_set_cell_data (column, model, &iter,
3882 cell = cells = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column));
3885 g_object_get (cell->data,
3886 "sensitive", &cell_sensitive,
3887 "visible", &cell_visible,
3890 if (cell_visible && cell_sensitive)
3895 g_list_free (cells);
3897 sensitive = cell_sensitive;
3900 g_list_free (columns);
3906 gtk_combo_box_list_row_changed (GtkTreeModel *model,
3911 /* XXX Do nothing ? */
3915 * GtkCellLayout implementation
3917 static GtkCellArea *
3918 gtk_combo_box_cell_layout_get_area (GtkCellLayout *cell_layout)
3920 GtkComboBox *combo = GTK_COMBO_BOX (cell_layout);
3921 GtkComboBoxPrivate *priv = combo->priv;
3923 if (G_UNLIKELY (!priv->area))
3925 priv->area = gtk_cell_area_box_new ();
3926 g_object_ref_sink (priv->area);
3937 * gtk_combo_box_new:
3939 * Creates a new empty #GtkComboBox.
3941 * Return value: A new #GtkComboBox.
3946 gtk_combo_box_new (void)
3948 return g_object_new (GTK_TYPE_COMBO_BOX, NULL);
3952 * gtk_combo_box_new_with_area:
3953 * @area: the #GtkCellArea to use to layout cell renderers
3955 * Creates a new empty #GtkComboBox using @area to layout cells.
3957 * Return value: A new #GtkComboBox.
3960 gtk_combo_box_new_with_area (GtkCellArea *area)
3962 return g_object_new (GTK_TYPE_COMBO_BOX, "cell-area", area, NULL);
3966 * gtk_combo_box_new_with_area_and_entry:
3967 * @area: the #GtkCellArea to use to layout cell renderers
3969 * Creates a new empty #GtkComboBox with an entry.
3971 * The new combo box will use @area to layout cells.
3973 * Return value: A new #GtkComboBox.
3976 gtk_combo_box_new_with_area_and_entry (GtkCellArea *area)
3978 return g_object_new (GTK_TYPE_COMBO_BOX,
3986 * gtk_combo_box_new_with_entry:
3988 * Creates a new empty #GtkComboBox with an entry.
3990 * Return value: A new #GtkComboBox.
3993 gtk_combo_box_new_with_entry (void)
3995 return g_object_new (GTK_TYPE_COMBO_BOX, "has-entry", TRUE, NULL);
3999 * gtk_combo_box_new_with_model:
4000 * @model: A #GtkTreeModel.
4002 * Creates a new #GtkComboBox with the model initialized to @model.
4004 * Return value: A new #GtkComboBox.
4009 gtk_combo_box_new_with_model (GtkTreeModel *model)
4011 GtkComboBox *combo_box;
4013 g_return_val_if_fail (GTK_IS_TREE_MODEL (model), NULL);
4015 combo_box = g_object_new (GTK_TYPE_COMBO_BOX, "model", model, NULL);
4017 return GTK_WIDGET (combo_box);
4021 * gtk_combo_box_new_with_model_and_entry:
4022 * @model: A #GtkTreeModel
4024 * Creates a new empty #GtkComboBox with an entry
4025 * and with the model initialized to @model.
4027 * Return value: A new #GtkComboBox
4030 gtk_combo_box_new_with_model_and_entry (GtkTreeModel *model)
4032 return g_object_new (GTK_TYPE_COMBO_BOX,
4039 * gtk_combo_box_get_wrap_width:
4040 * @combo_box: A #GtkComboBox
4042 * Returns the wrap width which is used to determine the number of columns
4043 * for the popup menu. If the wrap width is larger than 1, the combo box
4046 * Returns: the wrap width.
4051 gtk_combo_box_get_wrap_width (GtkComboBox *combo_box)
4053 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4055 return combo_box->priv->wrap_width;
4059 * gtk_combo_box_set_wrap_width:
4060 * @combo_box: A #GtkComboBox
4061 * @width: Preferred number of columns
4063 * Sets the wrap width of @combo_box to be @width. The wrap width is basically
4064 * the preferred number of columns when you want the popup to be layed out
4070 gtk_combo_box_set_wrap_width (GtkComboBox *combo_box,
4073 GtkComboBoxPrivate *priv;
4075 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4076 g_return_if_fail (width >= 0);
4078 priv = combo_box->priv;
4080 if (width != priv->wrap_width)
4082 priv->wrap_width = width;
4084 gtk_combo_box_check_appearance (combo_box);
4086 if (GTK_IS_TREE_MENU (priv->popup_widget))
4087 _gtk_tree_menu_set_wrap_width (GTK_TREE_MENU (priv->popup_widget), priv->wrap_width);
4089 g_object_notify (G_OBJECT (combo_box), "wrap-width");
4094 * gtk_combo_box_get_row_span_column:
4095 * @combo_box: A #GtkComboBox
4097 * Returns the column with row span information for @combo_box.
4099 * Returns: the row span column.
4104 gtk_combo_box_get_row_span_column (GtkComboBox *combo_box)
4106 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4108 return combo_box->priv->row_column;
4112 * gtk_combo_box_set_row_span_column:
4113 * @combo_box: A #GtkComboBox.
4114 * @row_span: A column in the model passed during construction.
4116 * Sets the column with row span information for @combo_box to be @row_span.
4117 * The row span column contains integers which indicate how many rows
4118 * an item should span.
4123 gtk_combo_box_set_row_span_column (GtkComboBox *combo_box,
4126 GtkComboBoxPrivate *priv;
4129 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4131 priv = combo_box->priv;
4133 col = gtk_tree_model_get_n_columns (priv->model);
4134 g_return_if_fail (row_span >= -1 && row_span < col);
4136 if (row_span != priv->row_column)
4138 priv->row_column = row_span;
4140 if (GTK_IS_TREE_MENU (priv->popup_widget))
4141 _gtk_tree_menu_set_row_span_column (GTK_TREE_MENU (priv->popup_widget), priv->row_column);
4143 g_object_notify (G_OBJECT (combo_box), "row-span-column");
4148 * gtk_combo_box_get_column_span_column:
4149 * @combo_box: A #GtkComboBox
4151 * Returns the column with column span information for @combo_box.
4153 * Returns: the column span column.
4158 gtk_combo_box_get_column_span_column (GtkComboBox *combo_box)
4160 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), -1);
4162 return combo_box->priv->col_column;
4166 * gtk_combo_box_set_column_span_column:
4167 * @combo_box: A #GtkComboBox
4168 * @column_span: A column in the model passed during construction
4170 * Sets the column with column span information for @combo_box to be
4171 * @column_span. The column span column contains integers which indicate
4172 * how many columns an item should span.
4177 gtk_combo_box_set_column_span_column (GtkComboBox *combo_box,
4180 GtkComboBoxPrivate *priv;
4183 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4185 priv = combo_box->priv;
4187 col = gtk_tree_model_get_n_columns (priv->model);
4188 g_return_if_fail (column_span >= -1 && column_span < col);
4190 if (column_span != priv->col_column)
4192 priv->col_column = column_span;
4194 if (GTK_IS_TREE_MENU (priv->popup_widget))
4195 _gtk_tree_menu_set_column_span_column (GTK_TREE_MENU (priv->popup_widget), priv->col_column);
4197 g_object_notify (G_OBJECT (combo_box), "column-span-column");
4202 * gtk_combo_box_get_active:
4203 * @combo_box: A #GtkComboBox
4205 * Returns the index of the currently active item, or -1 if there's no
4206 * active item. If the model is a non-flat treemodel, and the active item
4207 * is not an immediate child of the root of the tree, this function returns
4208 * <literal>gtk_tree_path_get_indices (path)[0]</literal>, where
4209 * <literal>path</literal> is the #GtkTreePath of the active item.
4211 * Return value: An integer which is the index of the currently active item,
4212 * or -1 if there's no active item.
4217 gtk_combo_box_get_active (GtkComboBox *combo_box)
4219 GtkComboBoxPrivate *priv;
4222 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
4224 priv = combo_box->priv;
4226 if (gtk_tree_row_reference_valid (priv->active_row))
4230 path = gtk_tree_row_reference_get_path (priv->active_row);
4231 result = gtk_tree_path_get_indices (path)[0];
4232 gtk_tree_path_free (path);
4241 * gtk_combo_box_set_active:
4242 * @combo_box: A #GtkComboBox
4243 * @index_: An index in the model passed during construction, or -1 to have
4246 * Sets the active item of @combo_box to be the item at @index.
4251 gtk_combo_box_set_active (GtkComboBox *combo_box,
4254 GtkTreePath *path = NULL;
4255 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4256 g_return_if_fail (index_ >= -1);
4258 if (combo_box->priv->model == NULL)
4260 /* Save index, in case the model is set after the index */
4261 combo_box->priv->active = index_;
4267 path = gtk_tree_path_new_from_indices (index_, -1);
4269 gtk_combo_box_set_active_internal (combo_box, path);
4272 gtk_tree_path_free (path);
4276 gtk_combo_box_set_active_internal (GtkComboBox *combo_box,
4279 GtkComboBoxPrivate *priv = combo_box->priv;
4280 GtkTreePath *active_path;
4283 /* Remember whether the initially active row is valid. */
4284 gboolean is_valid_row_reference = gtk_tree_row_reference_valid (priv->active_row);
4286 if (path && is_valid_row_reference)
4288 active_path = gtk_tree_row_reference_get_path (priv->active_row);
4289 path_cmp = gtk_tree_path_compare (path, active_path);
4290 gtk_tree_path_free (active_path);
4295 if (priv->active_row)
4297 gtk_tree_row_reference_free (priv->active_row);
4298 priv->active_row = NULL;
4303 if (priv->tree_view)
4304 gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view)));
4307 GtkMenu *menu = GTK_MENU (priv->popup_widget);
4309 if (GTK_IS_MENU (menu))
4310 gtk_menu_set_active (menu, -1);
4313 if (priv->cell_view)
4314 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view), NULL);
4317 * Do not emit a "changed" signal when an already invalid selection was
4318 * now set to invalid.
4320 if (!is_valid_row_reference)
4326 gtk_tree_row_reference_new (priv->model, path);
4328 if (priv->tree_view)
4330 gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->tree_view),
4333 else if (GTK_IS_MENU (priv->popup_widget))
4335 /* FIXME handle nested menus better */
4336 gtk_menu_set_active (GTK_MENU (priv->popup_widget),
4337 gtk_tree_path_get_indices (path)[0]);
4340 if (priv->cell_view)
4341 gtk_cell_view_set_displayed_row (GTK_CELL_VIEW (priv->cell_view),
4345 g_signal_emit (combo_box, combo_box_signals[CHANGED], 0);
4346 g_object_notify (G_OBJECT (combo_box), "active");
4347 if (combo_box->priv->id_column >= 0)
4348 g_object_notify (G_OBJECT (combo_box), "active-id");
4353 * gtk_combo_box_get_active_iter:
4354 * @combo_box: A #GtkComboBox
4355 * @iter: (out): The uninitialized #GtkTreeIter
4357 * Sets @iter to point to the current active item, if it exists.
4359 * Return value: %TRUE, if @iter was set
4364 gtk_combo_box_get_active_iter (GtkComboBox *combo_box,
4370 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
4372 if (!gtk_tree_row_reference_valid (combo_box->priv->active_row))
4375 path = gtk_tree_row_reference_get_path (combo_box->priv->active_row);
4376 result = gtk_tree_model_get_iter (combo_box->priv->model, iter, path);
4377 gtk_tree_path_free (path);
4383 * gtk_combo_box_set_active_iter:
4384 * @combo_box: A #GtkComboBox
4385 * @iter: (allow-none): The #GtkTreeIter, or %NULL
4387 * Sets the current active item to be the one referenced by @iter, or
4388 * unsets the active item if @iter is %NULL.
4393 gtk_combo_box_set_active_iter (GtkComboBox *combo_box,
4396 GtkTreePath *path = NULL;
4398 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4401 path = gtk_tree_model_get_path (gtk_combo_box_get_model (combo_box), iter);
4403 gtk_combo_box_set_active_internal (combo_box, path);
4404 gtk_tree_path_free (path);
4408 * gtk_combo_box_set_model:
4409 * @combo_box: A #GtkComboBox
4410 * @model: (allow-none): A #GtkTreeModel
4412 * Sets the model used by @combo_box to be @model. Will unset a previously set
4413 * model (if applicable). If model is %NULL, then it will unset the model.
4415 * Note that this function does not clear the cell renderers, you have to
4416 * call gtk_cell_layout_clear() yourself if you need to set up different
4417 * cell renderers for the new model.
4422 gtk_combo_box_set_model (GtkComboBox *combo_box,
4423 GtkTreeModel *model)
4425 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4426 g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
4428 if (model == combo_box->priv->model)
4431 gtk_combo_box_unset_model (combo_box);
4436 combo_box->priv->model = model;
4437 g_object_ref (combo_box->priv->model);
4439 combo_box->priv->inserted_id =
4440 g_signal_connect (combo_box->priv->model, "row-inserted",
4441 G_CALLBACK (gtk_combo_box_model_row_inserted),
4443 combo_box->priv->deleted_id =
4444 g_signal_connect (combo_box->priv->model, "row-deleted",
4445 G_CALLBACK (gtk_combo_box_model_row_deleted),
4447 combo_box->priv->reordered_id =
4448 g_signal_connect (combo_box->priv->model, "rows-reordered",
4449 G_CALLBACK (gtk_combo_box_model_rows_reordered),
4451 combo_box->priv->changed_id =
4452 g_signal_connect (combo_box->priv->model, "row-changed",
4453 G_CALLBACK (gtk_combo_box_model_row_changed),
4456 if (combo_box->priv->tree_view)
4459 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view),
4460 combo_box->priv->model);
4461 gtk_combo_box_list_popup_resize (combo_box);
4464 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
4467 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget),
4468 combo_box->priv->model);
4471 if (combo_box->priv->cell_view)
4472 gtk_cell_view_set_model (GTK_CELL_VIEW (combo_box->priv->cell_view),
4473 combo_box->priv->model);
4475 if (combo_box->priv->active != -1)
4477 /* If an index was set in advance, apply it now */
4478 gtk_combo_box_set_active (combo_box, combo_box->priv->active);
4479 combo_box->priv->active = -1;
4483 gtk_combo_box_update_sensitivity (combo_box);
4485 g_object_notify (G_OBJECT (combo_box), "model");
4489 * gtk_combo_box_get_model:
4490 * @combo_box: A #GtkComboBox
4492 * Returns the #GtkTreeModel which is acting as data source for @combo_box.
4494 * Return value: (transfer none): A #GtkTreeModel which was passed
4495 * during construction.
4500 gtk_combo_box_get_model (GtkComboBox *combo_box)
4502 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
4504 return combo_box->priv->model;
4508 gtk_combo_box_real_move_active (GtkComboBox *combo_box,
4509 GtkScrollType scroll)
4512 GtkTreeIter new_iter;
4513 gboolean active_iter;
4516 if (!combo_box->priv->model)
4518 gtk_widget_error_bell (GTK_WIDGET (combo_box));
4522 active_iter = gtk_combo_box_get_active_iter (combo_box, &iter);
4526 case GTK_SCROLL_STEP_BACKWARD:
4527 case GTK_SCROLL_STEP_UP:
4528 case GTK_SCROLL_STEP_LEFT:
4531 found = tree_prev (combo_box, combo_box->priv->model,
4532 &iter, &new_iter, FALSE);
4535 /* else fall through */
4537 case GTK_SCROLL_PAGE_FORWARD:
4538 case GTK_SCROLL_PAGE_DOWN:
4539 case GTK_SCROLL_PAGE_RIGHT:
4540 case GTK_SCROLL_END:
4541 found = tree_last (combo_box, combo_box->priv->model, &new_iter, FALSE);
4544 case GTK_SCROLL_STEP_FORWARD:
4545 case GTK_SCROLL_STEP_DOWN:
4546 case GTK_SCROLL_STEP_RIGHT:
4549 found = tree_next (combo_box, combo_box->priv->model,
4550 &iter, &new_iter, FALSE);
4553 /* else fall through */
4555 case GTK_SCROLL_PAGE_BACKWARD:
4556 case GTK_SCROLL_PAGE_UP:
4557 case GTK_SCROLL_PAGE_LEFT:
4558 case GTK_SCROLL_START:
4559 found = tree_first (combo_box, combo_box->priv->model, &new_iter, FALSE);
4566 if (found && active_iter)
4568 GtkTreePath *old_path;
4569 GtkTreePath *new_path;
4571 old_path = gtk_tree_model_get_path (combo_box->priv->model, &iter);
4572 new_path = gtk_tree_model_get_path (combo_box->priv->model, &new_iter);
4574 if (gtk_tree_path_compare (old_path, new_path) == 0)
4577 gtk_tree_path_free (old_path);
4578 gtk_tree_path_free (new_path);
4583 gtk_combo_box_set_active_iter (combo_box, &new_iter);
4587 gtk_widget_error_bell (GTK_WIDGET (combo_box));
4592 gtk_combo_box_mnemonic_activate (GtkWidget *widget,
4593 gboolean group_cycling)
4595 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4597 if (combo_box->priv->has_entry)
4601 child = gtk_bin_get_child (GTK_BIN (combo_box));
4603 gtk_widget_grab_focus (child);
4606 gtk_widget_grab_focus (combo_box->priv->button);
4612 gtk_combo_box_grab_focus (GtkWidget *widget)
4614 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4616 if (combo_box->priv->has_entry)
4620 child = gtk_bin_get_child (GTK_BIN (combo_box));
4622 gtk_widget_grab_focus (child);
4625 gtk_widget_grab_focus (combo_box->priv->button);
4629 gtk_combo_box_destroy (GtkWidget *widget)
4631 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
4633 if (combo_box->priv->popup_idle_id > 0)
4635 g_source_remove (combo_box->priv->popup_idle_id);
4636 combo_box->priv->popup_idle_id = 0;
4639 gtk_combo_box_popdown (combo_box);
4641 if (combo_box->priv->row_separator_destroy)
4642 combo_box->priv->row_separator_destroy (combo_box->priv->row_separator_data);
4644 combo_box->priv->row_separator_func = NULL;
4645 combo_box->priv->row_separator_data = NULL;
4646 combo_box->priv->row_separator_destroy = NULL;
4648 GTK_WIDGET_CLASS (gtk_combo_box_parent_class)->destroy (widget);
4649 combo_box->priv->cell_view = NULL;
4653 gtk_combo_box_entry_contents_changed (GtkEntry *entry,
4656 GtkComboBox *combo_box = GTK_COMBO_BOX (user_data);
4659 * Fixes regression reported in bug #574059. The old functionality relied on
4660 * bug #572478. As a bugfix, we now emit the "changed" signal ourselves
4661 * when the selection was already set to -1.
4663 if (gtk_combo_box_get_active(combo_box) == -1)
4664 g_signal_emit_by_name (combo_box, "changed");
4666 gtk_combo_box_set_active (combo_box, -1);
4670 gtk_combo_box_entry_active_changed (GtkComboBox *combo_box,
4673 GtkTreeModel *model;
4676 if (gtk_combo_box_get_active_iter (combo_box, &iter))
4678 GtkEntry *entry = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (combo_box)));
4686 model = gtk_combo_box_get_model (combo_box);
4687 path = gtk_tree_model_get_path (model, &iter);
4688 path_str = gtk_tree_path_to_string (path);
4690 g_signal_handlers_block_by_func (entry,
4691 gtk_combo_box_entry_contents_changed,
4695 g_signal_emit (combo_box, combo_box_signals[FORMAT_ENTRY_TEXT], 0,
4698 gtk_entry_set_text (entry, text);
4700 g_signal_handlers_unblock_by_func (entry,
4701 gtk_combo_box_entry_contents_changed,
4704 gtk_tree_path_free (path);
4712 gtk_combo_box_format_entry_text (GtkComboBox *combo_box,
4715 GtkComboBoxPrivate *priv = combo_box->priv;
4716 GtkTreeModel *model;
4720 if (priv->text_column >= 0)
4722 model = gtk_combo_box_get_model (combo_box);
4723 gtk_tree_model_get_iter_from_string (model, &iter, path);
4725 gtk_tree_model_get (model, &iter,
4726 priv->text_column, &text,
4735 gtk_combo_box_constructor (GType type,
4736 guint n_construct_properties,
4737 GObjectConstructParam *construct_properties)
4740 GtkComboBox *combo_box;
4741 GtkComboBoxPrivate *priv;
4743 object = G_OBJECT_CLASS (gtk_combo_box_parent_class)->constructor
4744 (type, n_construct_properties, construct_properties);
4746 combo_box = GTK_COMBO_BOX (object);
4747 priv = combo_box->priv;
4751 priv->area = gtk_cell_area_box_new ();
4752 g_object_ref_sink (priv->area);
4755 priv->cell_view = gtk_cell_view_new_with_context (priv->area, NULL);
4756 gtk_cell_view_set_fit_model (GTK_CELL_VIEW (priv->cell_view), TRUE);
4757 gtk_cell_view_set_model (GTK_CELL_VIEW (priv->cell_view), priv->model);
4758 gtk_widget_set_parent (priv->cell_view, GTK_WIDGET (combo_box));
4759 _gtk_bin_set_child (GTK_BIN (combo_box), priv->cell_view);
4760 gtk_widget_show (priv->cell_view);
4762 gtk_combo_box_check_appearance (combo_box);
4764 if (priv->has_entry)
4767 GtkStyleContext *context;
4769 entry = gtk_entry_new ();
4770 gtk_widget_show (entry);
4771 gtk_container_add (GTK_CONTAINER (combo_box), entry);
4773 context = gtk_widget_get_style_context (GTK_WIDGET (combo_box));
4774 gtk_style_context_add_class (context, GTK_STYLE_CLASS_COMBOBOX_ENTRY);
4776 priv->text_renderer = gtk_cell_renderer_text_new ();
4777 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combo_box),
4778 priv->text_renderer, TRUE);
4780 gtk_combo_box_set_active (GTK_COMBO_BOX (combo_box), -1);
4782 g_signal_connect (combo_box, "changed",
4783 G_CALLBACK (gtk_combo_box_entry_active_changed), NULL);
4791 gtk_combo_box_dispose(GObject* object)
4793 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
4795 if (GTK_IS_MENU (combo_box->priv->popup_widget))
4797 gtk_combo_box_menu_destroy (combo_box);
4798 gtk_menu_detach (GTK_MENU (combo_box->priv->popup_widget));
4799 combo_box->priv->popup_widget = NULL;
4802 if (combo_box->priv->area)
4804 g_object_unref (combo_box->priv->area);
4805 combo_box->priv->area = NULL;
4808 if (GTK_IS_TREE_VIEW (combo_box->priv->tree_view))
4809 gtk_combo_box_list_destroy (combo_box);
4811 if (combo_box->priv->popup_window)
4813 gtk_widget_destroy (combo_box->priv->popup_window);
4814 combo_box->priv->popup_window = NULL;
4817 gtk_combo_box_unset_model (combo_box);
4819 G_OBJECT_CLASS (gtk_combo_box_parent_class)->dispose (object);
4823 gtk_combo_box_finalize (GObject *object)
4825 GtkComboBox *combo_box = GTK_COMBO_BOX (object);
4827 g_free (combo_box->priv->tearoff_title);
4829 G_OBJECT_CLASS (gtk_combo_box_parent_class)->finalize (object);
4833 gtk_cell_editable_key_press (GtkWidget *widget,
4837 GtkComboBox *combo_box = GTK_COMBO_BOX (data);
4839 if (event->keyval == GDK_KEY_Escape)
4841 g_object_set (combo_box,
4842 "editing-canceled", TRUE,
4844 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4845 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4849 else if (event->keyval == GDK_KEY_Return ||
4850 event->keyval == GDK_KEY_ISO_Enter ||
4851 event->keyval == GDK_KEY_KP_Enter)
4853 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4854 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4863 popdown_idle (gpointer data)
4865 GtkComboBox *combo_box;
4867 combo_box = GTK_COMBO_BOX (data);
4869 gtk_cell_editable_editing_done (GTK_CELL_EDITABLE (combo_box));
4870 gtk_cell_editable_remove_widget (GTK_CELL_EDITABLE (combo_box));
4872 g_object_unref (combo_box);
4878 popdown_handler (GtkWidget *widget,
4881 gdk_threads_add_idle (popdown_idle, g_object_ref (data));
4885 popup_idle (gpointer data)
4887 GtkComboBox *combo_box;
4889 combo_box = GTK_COMBO_BOX (data);
4891 if (GTK_IS_MENU (combo_box->priv->popup_widget) &&
4892 combo_box->priv->cell_view)
4893 g_signal_connect_object (combo_box->priv->popup_widget,
4894 "unmap", G_CALLBACK (popdown_handler),
4897 /* we unset this if a menu item is activated */
4898 g_object_set (combo_box,
4899 "editing-canceled", TRUE,
4901 gtk_combo_box_popup (combo_box);
4903 combo_box->priv->popup_idle_id = 0;
4904 combo_box->priv->activate_button = 0;
4905 combo_box->priv->activate_time = 0;
4911 gtk_combo_box_start_editing (GtkCellEditable *cell_editable,
4914 GtkComboBox *combo_box = GTK_COMBO_BOX (cell_editable);
4917 combo_box->priv->is_cell_renderer = TRUE;
4919 if (combo_box->priv->cell_view)
4921 g_signal_connect_object (combo_box->priv->button, "key-press-event",
4922 G_CALLBACK (gtk_cell_editable_key_press),
4925 gtk_widget_grab_focus (combo_box->priv->button);
4929 child = gtk_bin_get_child (GTK_BIN (combo_box));
4931 g_signal_connect_object (child, "key-press-event",
4932 G_CALLBACK (gtk_cell_editable_key_press),
4935 gtk_widget_grab_focus (child);
4936 gtk_widget_set_can_focus (combo_box->priv->button, FALSE);
4939 /* we do the immediate popup only for the optionmenu-like
4942 if (combo_box->priv->is_cell_renderer &&
4943 combo_box->priv->cell_view && !combo_box->priv->tree_view)
4945 if (event && event->type == GDK_BUTTON_PRESS)
4947 GdkEventButton *event_button = (GdkEventButton *)event;
4949 combo_box->priv->activate_button = event_button->button;
4950 combo_box->priv->activate_time = event_button->time;
4953 combo_box->priv->popup_idle_id =
4954 gdk_threads_add_idle (popup_idle, combo_box);
4960 * gtk_combo_box_get_add_tearoffs:
4961 * @combo_box: a #GtkComboBox
4963 * Gets the current value of the :add-tearoffs property.
4965 * Return value: the current value of the :add-tearoffs property.
4968 gtk_combo_box_get_add_tearoffs (GtkComboBox *combo_box)
4970 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
4972 return combo_box->priv->add_tearoffs;
4976 * gtk_combo_box_set_add_tearoffs:
4977 * @combo_box: a #GtkComboBox
4978 * @add_tearoffs: %TRUE to add tearoff menu items
4980 * Sets whether the popup menu should have a tearoff
4986 gtk_combo_box_set_add_tearoffs (GtkComboBox *combo_box,
4987 gboolean add_tearoffs)
4989 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
4991 add_tearoffs = add_tearoffs != FALSE;
4993 if (combo_box->priv->add_tearoffs != add_tearoffs)
4995 combo_box->priv->add_tearoffs = add_tearoffs;
4996 gtk_combo_box_check_appearance (combo_box);
4998 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
4999 _gtk_tree_menu_set_tearoff (GTK_TREE_MENU (combo_box->priv->popup_widget),
5000 combo_box->priv->add_tearoffs);
5002 g_object_notify (G_OBJECT (combo_box), "add-tearoffs");
5007 * gtk_combo_box_get_title:
5008 * @combo_box: a #GtkComboBox
5010 * Gets the current title of the menu in tearoff mode. See
5011 * gtk_combo_box_set_add_tearoffs().
5013 * Returns: the menu's title in tearoff mode. This is an internal copy of the
5014 * string which must not be freed.
5019 gtk_combo_box_get_title (GtkComboBox *combo_box)
5021 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5023 return combo_box->priv->tearoff_title;
5027 gtk_combo_box_update_title (GtkComboBox *combo_box)
5029 gtk_combo_box_check_appearance (combo_box);
5031 if (combo_box->priv->popup_widget &&
5032 GTK_IS_MENU (combo_box->priv->popup_widget))
5033 gtk_menu_set_title (GTK_MENU (combo_box->priv->popup_widget),
5034 combo_box->priv->tearoff_title);
5038 * gtk_combo_box_set_title:
5039 * @combo_box: a #GtkComboBox
5040 * @title: a title for the menu in tearoff mode
5042 * Sets the menu's title in tearoff mode.
5047 gtk_combo_box_set_title (GtkComboBox *combo_box,
5050 GtkComboBoxPrivate *priv;
5052 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5054 priv = combo_box->priv;
5056 if (strcmp (title ? title : "",
5057 priv->tearoff_title ? priv->tearoff_title : "") != 0)
5059 g_free (priv->tearoff_title);
5060 priv->tearoff_title = g_strdup (title);
5062 gtk_combo_box_update_title (combo_box);
5064 g_object_notify (G_OBJECT (combo_box), "tearoff-title");
5070 * gtk_combo_box_set_popup_fixed_width:
5071 * @combo_box: a #GtkComboBox
5072 * @fixed: whether to use a fixed popup width
5074 * Specifies whether the popup's width should be a fixed width
5075 * matching the allocated width of the combo box.
5080 gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box,
5083 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5085 if (combo_box->priv->popup_fixed_width != fixed)
5087 combo_box->priv->popup_fixed_width = fixed;
5089 g_object_notify (G_OBJECT (combo_box), "popup-fixed-width");
5094 * gtk_combo_box_get_popup_fixed_width:
5095 * @combo_box: a #GtkComboBox
5097 * Gets whether the popup uses a fixed width matching
5098 * the allocated width of the combo box.
5100 * Returns: %TRUE if the popup uses a fixed width
5105 gtk_combo_box_get_popup_fixed_width (GtkComboBox *combo_box)
5107 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5109 return combo_box->priv->popup_fixed_width;
5114 * gtk_combo_box_get_popup_accessible:
5115 * @combo_box: a #GtkComboBox
5117 * Gets the accessible object corresponding to the combo box's popup.
5119 * This function is mostly intended for use by accessibility technologies;
5120 * applications should have little use for it.
5122 * Returns: (transfer none): the accessible object corresponding
5123 * to the combo box's popup.
5128 gtk_combo_box_get_popup_accessible (GtkComboBox *combo_box)
5132 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5134 if (combo_box->priv->popup_widget)
5136 atk_obj = gtk_widget_get_accessible (combo_box->priv->popup_widget);
5144 * gtk_combo_box_get_row_separator_func: (skip)
5145 * @combo_box: a #GtkComboBox
5147 * Returns the current row separator function.
5149 * Return value: the current row separator function.
5153 GtkTreeViewRowSeparatorFunc
5154 gtk_combo_box_get_row_separator_func (GtkComboBox *combo_box)
5156 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5158 return combo_box->priv->row_separator_func;
5162 * gtk_combo_box_set_row_separator_func:
5163 * @combo_box: a #GtkComboBox
5164 * @func: a #GtkTreeViewRowSeparatorFunc
5165 * @data: (allow-none): user data to pass to @func, or %NULL
5166 * @destroy: (allow-none): destroy notifier for @data, or %NULL
5168 * Sets the row separator function, which is used to determine
5169 * whether a row should be drawn as a separator. If the row separator
5170 * function is %NULL, no separators are drawn. This is the default value.
5175 gtk_combo_box_set_row_separator_func (GtkComboBox *combo_box,
5176 GtkTreeViewRowSeparatorFunc func,
5178 GDestroyNotify destroy)
5180 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5182 if (combo_box->priv->row_separator_destroy)
5183 combo_box->priv->row_separator_destroy (combo_box->priv->row_separator_data);
5185 combo_box->priv->row_separator_func = func;
5186 combo_box->priv->row_separator_data = data;
5187 combo_box->priv->row_separator_destroy = destroy;
5189 /* Provoke the underlying treeview/menu to rebuild themselves with the new separator func */
5190 if (combo_box->priv->tree_view)
5192 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view), NULL);
5193 gtk_tree_view_set_model (GTK_TREE_VIEW (combo_box->priv->tree_view), combo_box->priv->model);
5196 if (GTK_IS_TREE_MENU (combo_box->priv->popup_widget))
5198 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget), NULL);
5199 _gtk_tree_menu_set_model (GTK_TREE_MENU (combo_box->priv->popup_widget), combo_box->priv->model);
5202 gtk_widget_queue_draw (GTK_WIDGET (combo_box));
5206 * gtk_combo_box_set_button_sensitivity:
5207 * @combo_box: a #GtkComboBox
5208 * @sensitivity: specify the sensitivity of the dropdown button
5210 * Sets whether the dropdown button of the combo box should be
5211 * always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF)
5212 * or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
5217 gtk_combo_box_set_button_sensitivity (GtkComboBox *combo_box,
5218 GtkSensitivityType sensitivity)
5220 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5222 if (combo_box->priv->button_sensitivity != sensitivity)
5224 combo_box->priv->button_sensitivity = sensitivity;
5225 gtk_combo_box_update_sensitivity (combo_box);
5227 g_object_notify (G_OBJECT (combo_box), "button-sensitivity");
5232 * gtk_combo_box_get_button_sensitivity:
5233 * @combo_box: a #GtkComboBox
5235 * Returns whether the combo box sets the dropdown button
5236 * sensitive or not when there are no items in the model.
5238 * Return Value: %GTK_SENSITIVITY_ON if the dropdown button
5239 * is sensitive when the model is empty, %GTK_SENSITIVITY_OFF
5240 * if the button is always insensitive or
5241 * %GTK_SENSITIVITY_AUTO if it is only sensitive as long as
5242 * the model has one item to be selected.
5247 gtk_combo_box_get_button_sensitivity (GtkComboBox *combo_box)
5249 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5251 return combo_box->priv->button_sensitivity;
5256 * gtk_combo_box_get_has_entry:
5257 * @combo_box: a #GtkComboBox
5259 * Returns whether the combo box has an entry.
5261 * Return Value: whether there is an entry in @combo_box.
5266 gtk_combo_box_get_has_entry (GtkComboBox *combo_box)
5268 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5270 return combo_box->priv->has_entry;
5274 * gtk_combo_box_set_entry_text_column:
5275 * @combo_box: A #GtkComboBox
5276 * @text_column: A column in @model to get the strings from for
5277 * the internal entry
5279 * Sets the model column which @combo_box should use to get strings from
5280 * to be @text_column. The column @text_column in the model of @combo_box
5281 * must be of type %G_TYPE_STRING.
5283 * This is only relevant if @combo_box has been created with
5284 * #GtkComboBox:has-entry as %TRUE.
5289 gtk_combo_box_set_entry_text_column (GtkComboBox *combo_box,
5292 GtkComboBoxPrivate *priv = combo_box->priv;
5293 GtkTreeModel *model;
5295 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5297 model = gtk_combo_box_get_model (combo_box);
5299 g_return_if_fail (text_column >= 0);
5300 g_return_if_fail (model == NULL || text_column < gtk_tree_model_get_n_columns (model));
5302 priv->text_column = text_column;
5304 if (priv->text_renderer != NULL)
5305 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combo_box),
5306 priv->text_renderer,
5307 "text", text_column,
5312 * gtk_combo_box_get_entry_text_column:
5313 * @combo_box: A #GtkComboBox.
5315 * Returns the column which @combo_box is using to get the strings
5316 * from to display in the internal entry.
5318 * Return value: A column in the data source model of @combo_box.
5323 gtk_combo_box_get_entry_text_column (GtkComboBox *combo_box)
5325 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
5327 return combo_box->priv->text_column;
5331 * gtk_combo_box_set_focus_on_click:
5332 * @combo: a #GtkComboBox
5333 * @focus_on_click: whether the combo box grabs focus when clicked
5336 * Sets whether the combo box will grab focus when it is clicked with
5337 * the mouse. Making mouse clicks not grab focus is useful in places
5338 * like toolbars where you don't want the keyboard focus removed from
5339 * the main area of the application.
5344 gtk_combo_box_set_focus_on_click (GtkComboBox *combo_box,
5345 gboolean focus_on_click)
5347 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5349 focus_on_click = focus_on_click != FALSE;
5351 if (combo_box->priv->focus_on_click != focus_on_click)
5353 combo_box->priv->focus_on_click = focus_on_click;
5355 if (combo_box->priv->button)
5356 gtk_button_set_focus_on_click (GTK_BUTTON (combo_box->priv->button),
5359 g_object_notify (G_OBJECT (combo_box), "focus-on-click");
5364 * gtk_combo_box_get_focus_on_click:
5365 * @combo: a #GtkComboBox
5367 * Returns whether the combo box grabs focus when it is clicked
5368 * with the mouse. See gtk_combo_box_set_focus_on_click().
5370 * Return value: %TRUE if the combo box grabs focus when it is
5371 * clicked with the mouse.
5376 gtk_combo_box_get_focus_on_click (GtkComboBox *combo_box)
5378 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5380 return combo_box->priv->focus_on_click;
5385 gtk_combo_box_buildable_custom_tag_start (GtkBuildable *buildable,
5386 GtkBuilder *builder,
5388 const gchar *tagname,
5389 GMarkupParser *parser,
5392 if (parent_buildable_iface->custom_tag_start (buildable, builder, child,
5393 tagname, parser, data))
5396 return _gtk_cell_layout_buildable_custom_tag_start (buildable, builder, child,
5397 tagname, parser, data);
5401 gtk_combo_box_buildable_custom_tag_end (GtkBuildable *buildable,
5402 GtkBuilder *builder,
5404 const gchar *tagname,
5407 if (!_gtk_cell_layout_buildable_custom_tag_end (buildable, builder, child, tagname, data))
5408 parent_buildable_iface->custom_tag_end (buildable, builder, child, tagname, data);
5412 gtk_combo_box_buildable_get_internal_child (GtkBuildable *buildable,
5413 GtkBuilder *builder,
5414 const gchar *childname)
5416 GtkComboBox *combo_box = GTK_COMBO_BOX (buildable);
5418 if (combo_box->priv->has_entry && strcmp (childname, "entry") == 0)
5419 return G_OBJECT (gtk_bin_get_child (GTK_BIN (buildable)));
5421 return parent_buildable_iface->get_internal_child (buildable, builder, childname);
5425 gtk_combo_box_get_preferred_width (GtkWidget *widget,
5429 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
5430 GtkComboBoxPrivate *priv = combo_box->priv;
5431 gint focus_width, focus_pad;
5432 gint font_size, arrow_size;
5433 PangoContext *context;
5434 PangoFontMetrics *metrics;
5435 const PangoFontDescription *font_desc;
5437 gint minimum_width = 0, natural_width = 0;
5438 gint child_min, child_nat;
5439 GtkStyleContext *style_context;
5440 GtkStateFlags state;
5442 gfloat arrow_scaling;
5444 child = gtk_bin_get_child (GTK_BIN (widget));
5447 gtk_widget_get_preferred_width (child, &child_min, &child_nat);
5449 gtk_widget_style_get (GTK_WIDGET (widget),
5450 "focus-line-width", &focus_width,
5451 "focus-padding", &focus_pad,
5452 "arrow-size", &arrow_size,
5453 "arrow-scaling", &arrow_scaling,
5456 style_context = gtk_widget_get_style_context (widget);
5457 state = gtk_widget_get_state_flags (widget);
5459 get_widget_padding (widget, &padding);
5460 font_desc = gtk_style_context_get_font (style_context, state);
5462 context = gtk_widget_get_pango_context (GTK_WIDGET (widget));
5463 metrics = pango_context_get_metrics (context, font_desc,
5464 pango_context_get_language (context));
5465 font_size = PANGO_PIXELS (pango_font_metrics_get_ascent (metrics) +
5466 pango_font_metrics_get_descent (metrics));
5467 pango_font_metrics_unref (metrics);
5469 arrow_size = MAX (arrow_size, font_size) * arrow_scaling;
5471 gtk_widget_set_size_request (priv->arrow, arrow_size, arrow_size);
5473 if (!priv->tree_view)
5476 if (priv->cell_view)
5478 gint sep_width, arrow_width;
5479 gint border_width, xpad;
5480 GtkBorder button_padding;
5482 border_width = gtk_container_get_border_width (GTK_CONTAINER (combo_box));
5483 get_widget_padding (priv->button, &button_padding);
5485 gtk_widget_get_preferred_width (priv->separator, &sep_width, NULL);
5486 gtk_widget_get_preferred_width (priv->arrow, &arrow_width, NULL);
5488 xpad = 2 * (border_width + focus_width + focus_pad) +
5489 button_padding.left + button_padding.right + padding.left + padding.right;
5491 minimum_width = child_min + sep_width + arrow_width + xpad;
5492 natural_width = child_nat + sep_width + arrow_width + xpad;
5496 gint but_width, but_nat_width;
5498 gtk_widget_get_preferred_width (priv->button,
5499 &but_width, &but_nat_width);
5501 minimum_width = child_min + but_width;
5502 natural_width = child_nat + but_nat_width;
5508 gint button_width, button_nat_width;
5510 /* sample + frame */
5511 minimum_width = child_min;
5512 natural_width = child_nat;
5514 minimum_width += 2 * focus_width;
5515 natural_width += 2 * focus_width;
5517 if (priv->cell_view_frame)
5519 if (priv->has_frame)
5521 gint border_width, xpad;
5522 GtkBorder frame_padding;
5524 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
5525 get_widget_padding (priv->cell_view_frame, &frame_padding);
5526 xpad = (2 * border_width) + frame_padding.left + frame_padding.right;
5528 minimum_width += xpad;
5529 natural_width += xpad;
5534 gtk_widget_get_preferred_width (priv->button,
5535 &button_width, &button_nat_width);
5537 minimum_width += button_width;
5538 natural_width += button_nat_width;
5541 minimum_width += padding.left + padding.right;
5542 natural_width += padding.left + padding.right;
5545 *minimum_size = minimum_width;
5548 *natural_size = natural_width;
5552 gtk_combo_box_get_preferred_height (GtkWidget *widget,
5558 /* Combo box is height-for-width only
5559 * (so we always just reserve enough height for the minimum width) */
5560 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, &min_width, NULL);
5561 GTK_WIDGET_GET_CLASS (widget)->get_preferred_height_for_width (widget, min_width, minimum_size, natural_size);
5565 gtk_combo_box_get_preferred_width_for_height (GtkWidget *widget,
5570 /* Combo box is height-for-width only
5571 * (so we assume we always reserved enough height for the minimum width) */
5572 GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_size, natural_size);
5577 gtk_combo_box_get_preferred_height_for_width (GtkWidget *widget,
5582 GtkComboBox *combo_box = GTK_COMBO_BOX (widget);
5583 GtkComboBoxPrivate *priv = combo_box->priv;
5584 gint focus_width, focus_pad;
5585 gint min_height = 0, nat_height = 0;
5590 gtk_widget_style_get (GTK_WIDGET (widget),
5591 "focus-line-width", &focus_width,
5592 "focus-padding", &focus_pad,
5595 child = gtk_bin_get_child (GTK_BIN (widget));
5597 get_widget_padding (widget, &padding);
5600 if (!priv->tree_view)
5603 if (priv->cell_view)
5605 /* calculate x/y padding and separator/arrow size */
5606 gint sep_width, arrow_width, sep_height, arrow_height;
5607 gint border_width, xpad, ypad;
5608 GtkBorder button_padding;
5610 border_width = gtk_container_get_border_width (GTK_CONTAINER (combo_box));
5611 get_widget_padding (priv->button, &button_padding);
5613 gtk_widget_get_preferred_width (priv->separator, &sep_width, NULL);
5614 gtk_widget_get_preferred_width (priv->arrow, &arrow_width, NULL);
5615 gtk_widget_get_preferred_height_for_width (priv->separator,
5616 sep_width, &sep_height, NULL);
5617 gtk_widget_get_preferred_height_for_width (priv->arrow,
5618 arrow_width, &arrow_height, NULL);
5620 xpad = 2 * (border_width + focus_width + focus_pad) +
5621 button_padding.left + button_padding.right;
5622 ypad = 2 * (border_width + focus_width + focus_pad) +
5623 button_padding.top + button_padding.bottom;
5625 size -= sep_width + arrow_width + xpad;
5627 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5628 * and fitting the whole treemodel */
5629 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5631 arrow_height = MAX (arrow_height, sep_height);
5632 min_height = MAX (min_height, arrow_height);
5633 nat_height = MAX (nat_height, arrow_height);
5640 /* there is a custom child widget inside (no priv->cell_view) */
5641 gint but_width, but_height;
5643 gtk_widget_get_preferred_width (priv->button, &but_width, NULL);
5644 gtk_widget_get_preferred_height_for_width (priv->button,
5645 but_width, &but_height, NULL);
5649 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5650 * and fitting the whole treemodel */
5651 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5653 min_height = MAX (min_height, but_height);
5654 nat_height = MAX (nat_height, but_height);
5660 gint but_width, but_height;
5661 gint xpad = 0, ypad = 0;
5663 gtk_widget_get_preferred_width (priv->button, &but_width, NULL);
5664 gtk_widget_get_preferred_height_for_width (priv->button,
5665 but_width, &but_height, NULL);
5667 if (priv->cell_view_frame && priv->has_frame)
5669 GtkBorder frame_padding;
5672 border_width = gtk_container_get_border_width (GTK_CONTAINER (priv->cell_view_frame));
5673 get_widget_padding (GTK_WIDGET (priv->cell_view_frame), &frame_padding);
5675 xpad = (2 * border_width) + padding.left + frame_padding.right;
5676 ypad = (2 * border_width) + padding.top + frame_padding.bottom;
5680 size -= 2 * focus_width;
5683 /* Get height-for-width of the child widget, usually a GtkCellArea calculating
5684 * and fitting the whole treemodel */
5685 gtk_widget_get_preferred_height_for_width (child, size, &min_height, &nat_height);
5687 min_height = MAX (min_height, but_height);
5688 nat_height = MAX (nat_height, but_height);
5694 min_height += padding.top + padding.bottom;
5695 nat_height += padding.top + padding.bottom;
5698 *minimum_size = min_height;
5701 *natural_size = nat_height;
5705 * gtk_combo_box_set_id_column:
5706 * @combo_box: A #GtkComboBox
5707 * @id_column: A column in @model to get string IDs for values from
5709 * Sets the model column which @combo_box should use to get string IDs
5710 * for values from. The column @id_column in the model of @combo_box
5711 * must be of type %G_TYPE_STRING.
5716 gtk_combo_box_set_id_column (GtkComboBox *combo_box,
5719 GtkComboBoxPrivate *priv = combo_box->priv;
5720 GtkTreeModel *model;
5722 g_return_if_fail (GTK_IS_COMBO_BOX (combo_box));
5724 if (id_column != priv->id_column)
5726 model = gtk_combo_box_get_model (combo_box);
5728 g_return_if_fail (id_column >= 0);
5729 g_return_if_fail (model == NULL ||
5730 id_column < gtk_tree_model_get_n_columns (model));
5732 priv->id_column = id_column;
5734 g_object_notify (G_OBJECT (combo_box), "id-column");
5735 g_object_notify (G_OBJECT (combo_box), "active-id");
5740 * gtk_combo_box_get_id_column:
5741 * @combo_box: A #GtkComboBox
5743 * Returns the column which @combo_box is using to get string IDs
5746 * Return value: A column in the data source model of @combo_box.
5751 gtk_combo_box_get_id_column (GtkComboBox *combo_box)
5753 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), 0);
5755 return combo_box->priv->id_column;
5759 * gtk_combo_box_get_active_id:
5760 * @combo_box: a #GtkComboBox
5762 * Returns the ID of the active row of @combo_box. This value is taken
5763 * from the active row and the column specified by the #GtkComboBox:id-column
5764 * property of @combo_box (see gtk_combo_box_set_id_column()).
5766 * The returned value is an interned string which means that you can
5767 * compare the pointer by value to other interned strings and that you
5770 * If the #GtkComboBox:id-column property of @combo_box is not set, or if
5771 * no row is active, or if the active row has a %NULL ID value, then %NULL
5774 * Return value: the ID of the active row, or %NULL
5779 gtk_combo_box_get_active_id (GtkComboBox *combo_box)
5781 GtkTreeModel *model;
5785 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), NULL);
5787 column = combo_box->priv->id_column;
5792 model = gtk_combo_box_get_model (combo_box);
5793 g_return_val_if_fail (gtk_tree_model_get_column_type (model, column) ==
5794 G_TYPE_STRING, NULL);
5796 if (gtk_combo_box_get_active_iter (combo_box, &iter))
5798 const gchar *interned;
5801 gtk_tree_model_get (model, &iter, column, &id, -1);
5802 interned = g_intern_string (id);
5812 * gtk_combo_box_set_active_id:
5813 * @combo_box: a #GtkComboBox
5814 * @active_id: (allow-none): the ID of the row to select, or %NULL
5816 * Changes the active row of @combo_box to the one that has an ID equal to
5817 * @active_id, or unsets the active row if @active_id is %NULL. Rows having
5818 * a %NULL ID string cannot be made active by this function.
5820 * If the #GtkComboBox:id-column property of @combo_box is unset or if no
5821 * row has the given ID then the function does nothing and returns %FALSE.
5823 * Returns: %TRUE if a row with a matching ID was found. If a %NULL
5824 * @active_id was given to unset the active row, the function
5825 * always returns %TRUE.
5830 gtk_combo_box_set_active_id (GtkComboBox *combo_box,
5831 const gchar *active_id)
5833 GtkTreeModel *model;
5835 gboolean match = FALSE;
5838 g_return_val_if_fail (GTK_IS_COMBO_BOX (combo_box), FALSE);
5840 if (active_id == NULL)
5842 gtk_combo_box_set_active (combo_box, -1);
5843 return TRUE; /* active row was successfully unset */
5846 column = combo_box->priv->id_column;
5851 model = gtk_combo_box_get_model (combo_box);
5852 g_return_val_if_fail (gtk_tree_model_get_column_type (model, column) ==
5853 G_TYPE_STRING, FALSE);
5855 if (gtk_tree_model_get_iter_first (model, &iter))
5859 gtk_tree_model_get (model, &iter, column, &id, -1);
5861 match = strcmp (id, active_id) == 0;
5866 gtk_combo_box_set_active_iter (combo_box, &iter);
5869 } while (gtk_tree_model_iter_next (model, &iter));