1 /* gtkcombo - combo widget for gtk+
2 * Copyright 1997 Paolo Molaro
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 Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "gtkeventbox.h"
26 #include "gtkbutton.h"
27 #include "gtklistitem.h"
28 #include "gtkscrolledwindow.h"
30 #include "gtksignal.h"
31 #include "gtkwindow.h"
32 #include "gdk/gdkkeysyms.h"
36 const gchar *gtk_combo_string_key = "gtk-combo-string-value";
38 #define COMBO_LIST_MAX_HEIGHT 400
40 static void gtk_combo_class_init (GtkComboClass *klass);
41 static void gtk_combo_init (GtkCombo *combo);
42 static void gtk_combo_destroy (GtkObject *combo);
43 static GtkListItem *gtk_combo_find (GtkCombo *combo);
44 static gchar * gtk_combo_func (GtkListItem *li);
45 static gint gtk_combo_focus_idle (GtkCombo *combo);
46 static gint gtk_combo_entry_focus_out (GtkEntry *entry,
49 static void gtk_combo_get_pos (GtkCombo *combo,
54 static void gtk_combo_popup_list (GtkButton *button,
56 static void gtk_combo_update_entry (GtkList *list,
58 static void gtk_combo_update_list (GtkEntry *entry,
60 static gint gtk_combo_button_press (GtkWidget *widget,
63 static gint gtk_combo_list_key_press (GtkWidget *widget,
66 static gint gtk_combo_entry_key_press (GtkEntry *widget,
69 static void gtk_combo_item_destroy (GtkObject *object);
70 static void gtk_combo_size_allocate (GtkWidget *widget,
71 GtkAllocation *allocation);
73 static GtkHBoxClass *parent_class = NULL;
76 gtk_combo_class_init (GtkComboClass * klass)
78 GtkObjectClass *oclass;
79 GtkWidgetClass *widget_class;
81 parent_class = gtk_type_class (gtk_hbox_get_type ());
82 oclass = (GtkObjectClass *) klass;
83 widget_class = (GtkWidgetClass *) klass;
85 oclass->destroy = gtk_combo_destroy;
87 widget_class->size_allocate = gtk_combo_size_allocate;
91 gtk_combo_destroy (GtkObject * combo)
93 gtk_widget_destroy (GTK_COMBO (combo)->popwin);
94 gtk_widget_unref (GTK_COMBO (combo)->popwin);
96 if (GTK_OBJECT_CLASS (parent_class)->destroy)
97 (*GTK_OBJECT_CLASS (parent_class)->destroy) (combo);
101 gtk_combo_entry_key_press (GtkEntry * entry, GdkEventKey * event, GtkCombo * combo)
105 /*if ( event->keyval == GDK_Tab ) {
106 gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
109 if (!combo->use_arrows || !GTK_LIST (combo->list)->children)
111 li = g_list_find (GTK_LIST (combo->list)->children, gtk_combo_find (combo));
113 if ((event->keyval == GDK_Up)
114 || (event->keyval == GDK_KP_Up)
115 || ((event->state & GDK_MOD1_MASK) && ((event->keyval == 'p') || (event->keyval == 'P'))))
119 if (!li && combo->use_arrows_always)
121 li = g_list_last (GTK_LIST (combo->list)->children);
125 gtk_list_select_child (GTK_LIST (combo->list), GTK_WIDGET (li->data));
126 gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
130 else if ((event->keyval == GDK_Down)
131 || (event->keyval == GDK_KP_Down)
132 || ((event->state & GDK_MOD1_MASK) && ((event->keyval == 'n') || (event->keyval == 'N'))))
136 if (!li && combo->use_arrows_always)
138 li = GTK_LIST (combo->list)->children;
142 gtk_list_select_child (GTK_LIST (combo->list), GTK_WIDGET (li->data));
143 gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
151 gtk_combo_find (GtkCombo * combo)
156 int (*string_compare) (const char *, const char *);
158 if (combo->case_sensitive)
159 string_compare = strcmp;
161 string_compare = g_strcasecmp;
163 text = gtk_entry_get_text (GTK_ENTRY (combo->entry));
164 clist = GTK_LIST (combo->list)->children;
166 while (clist && clist->data)
168 ltext = gtk_combo_func (GTK_LIST_ITEM (clist->data));
171 if (!(*string_compare) (ltext, text))
172 return (GtkListItem *) clist->data;
180 gtk_combo_func (GtkListItem * li)
185 ltext = (gchar *) gtk_object_get_data (GTK_OBJECT (li), gtk_combo_string_key);
188 label = GTK_BIN (li)->child;
189 if (!label || !GTK_IS_LABEL (label))
191 gtk_label_get (GTK_LABEL (label), <ext);
197 gtk_combo_focus_idle (GtkCombo * combo)
200 gtk_widget_grab_focus (combo->entry);
205 gtk_combo_entry_focus_out (GtkEntry * entry, GdkEventFocus * event, GtkCombo * combo)
208 if (combo->value_in_list && !gtk_combo_find (combo))
210 /* gdk_beep(); *//* this can be annoying */
211 if (combo->ok_if_empty && !strcmp (gtk_entry_get_text (entry), ""))
214 printf ("INVALID ENTRY: `%s'\n", gtk_entry_get_text (entry));
216 gtk_grab_add (GTK_WIDGET (combo));
217 /* this is needed because if we call gtk_widget_grab_focus()
218 it isn't guaranteed it's the *last* call before the main-loop,
219 so the focus can be lost anyway...
220 the signal_emit_stop doesn't seem to work either...
222 gtk_idle_add ((GtkFunction) gtk_combo_focus_idle, combo);
223 /*gtk_signal_emit_stop_by_name(GTK_OBJECT(entry), "focus_out_event"); */
230 gtk_combo_get_pos (GtkCombo * combo, gint * x, gint * y, gint * height, gint * width)
234 GtkScrolledWindow *popup;
237 GtkRequisition list_requisition;
238 gboolean show_hscroll = FALSE;
239 gboolean show_vscroll = FALSE;
247 widget = GTK_WIDGET(combo);
248 popup = GTK_SCROLLED_WINDOW (combo->popup);
249 popwin = GTK_BIN (combo->popwin);
251 gdk_window_get_origin (combo->entry->window, x, y);
252 real_height = MIN (combo->entry->requisition.height,
253 combo->entry->allocation.height);
255 avail_height = gdk_screen_height () - *y;
257 gtk_widget_size_request (combo->list, &list_requisition);
258 min_height = MIN (list_requisition.height,
259 popup->vscrollbar->requisition.height);
262 alloc_width = widget->allocation.width -
263 2 * popwin->child->style->klass->xthickness -
264 2 * GTK_CONTAINER (popwin->child)->border_width -
265 2 * GTK_CONTAINER (combo->popup)->border_width -
266 2 * GTK_CONTAINER (popup->viewport)->border_width -
267 2 * popup->viewport->style->klass->xthickness;
270 2 * popwin->child->style->klass->ythickness +
271 2 * GTK_CONTAINER (popwin->child)->border_width +
272 2 * GTK_CONTAINER (combo->popup)->border_width +
273 2 * GTK_CONTAINER (popup->viewport)->border_width +
274 2 * popup->viewport->style->klass->xthickness;
278 old_width = alloc_width;
279 old_height = work_height;
282 alloc_width < list_requisition.width)
284 work_height += popup->hscrollbar->requisition.height +
285 GTK_SCROLLED_WINDOW_CLASS
286 (GTK_OBJECT (combo->popup)->klass)->scrollbar_spacing;
290 work_height + list_requisition.height > avail_height)
292 if (work_height + min_height > avail_height &&
293 *y - real_height > avail_height)
295 *y -= (work_height +list_requisition.height + real_height);
299 popup->vscrollbar->requisition.width +
300 GTK_SCROLLED_WINDOW_CLASS
301 (GTK_OBJECT (combo->popup)->klass)->scrollbar_spacing;
304 } while (old_width != alloc_width || old_height != work_height);
306 *width = widget->allocation.width;
308 *height = avail_height;
310 *height = work_height + list_requisition.height;
317 gtk_combo_popup_list (GtkButton * button, GtkCombo * combo)
319 gint height, width, x, y;
320 gint old_width, old_height;
322 if (!GTK_LIST (combo->list)->children)
325 old_width = combo->popwin->allocation.width;
326 old_height = combo->popwin->allocation.height;
328 gtk_combo_get_pos (combo, &x, &y, &height, &width);
330 /* workaround for gtk_scrolled_window_size_allocate bug */
331 if (old_width != width || old_height != height)
333 gtk_widget_hide (GTK_SCROLLED_WINDOW (combo->popup)->hscrollbar);
334 gtk_widget_hide (GTK_SCROLLED_WINDOW (combo->popup)->vscrollbar);
337 gtk_widget_set_uposition (combo->popwin, x, y);
338 gtk_widget_set_usize (combo->popwin, width, height);
339 gtk_widget_realize (combo->popwin);
340 gdk_window_resize (combo->popwin->window, width, height);
341 gtk_widget_show (combo->popwin);
343 gtk_widget_grab_focus (combo->popwin);
344 gtk_grab_add (combo->popwin);
345 gdk_pointer_grab (combo->popwin->window, TRUE,
346 GDK_BUTTON_PRESS_MASK |
347 GDK_BUTTON_RELEASE_MASK |
348 GDK_POINTER_MOTION_MASK,
349 NULL, NULL, GDK_CURRENT_TIME);
354 prelight_bug (GtkButton * b, GtkCombo * combo)
356 /* avoid prelight state... */
357 gtk_widget_set_state (combo->button, GTK_STATE_NORMAL);
363 gtk_combo_update_entry (GtkList * list, GtkCombo * combo)
367 gtk_grab_remove (GTK_WIDGET (combo));
368 gtk_signal_handler_block (GTK_OBJECT (list), combo->list_change_id);
371 text = gtk_combo_func (GTK_LIST_ITEM (list->selection->data));
374 gtk_entry_set_text (GTK_ENTRY (combo->entry), text);
376 gtk_widget_hide (combo->popwin);
377 gtk_grab_remove (combo->popwin);
378 gdk_pointer_ungrab (GDK_CURRENT_TIME);
379 gtk_signal_handler_unblock (GTK_OBJECT (list), combo->list_change_id);
383 gtk_combo_update_list (GtkEntry * entry, GtkCombo * combo)
385 GtkList *list = GTK_LIST (combo->list);
386 GList *slist = list->selection;
389 gtk_grab_remove (GTK_WIDGET (combo));
391 gtk_signal_handler_block (GTK_OBJECT (entry), combo->entry_change_id);
392 if (slist && slist->data)
393 gtk_list_unselect_child (list, GTK_WIDGET (slist->data));
394 li = gtk_combo_find (combo);
396 gtk_list_select_child (list, GTK_WIDGET (li));
397 gtk_signal_handler_unblock (GTK_OBJECT (entry), combo->entry_change_id);
401 gtk_combo_button_press (GtkWidget * widget, GdkEvent * event, GtkCombo * combo)
405 child = gtk_get_event_widget (event);
407 /* We don't ask for button press events on the grab widget, so
408 * if an event is reported directly to the grab widget, it must
409 * be on a window outside the application (and thus we remove
410 * the popup window). Otherwise, we check if the widget is a child
411 * of the grab widget, and only remove the popup window if it
420 child = child->parent;
424 gtk_widget_hide (combo->popwin);
425 gtk_grab_remove (combo->popwin);
426 gdk_pointer_ungrab (GDK_CURRENT_TIME);
432 gtk_combo_list_key_press (GtkWidget * widget, GdkEventKey * event, GtkCombo * combo)
434 if (event->keyval == GDK_Escape)
436 gtk_widget_hide (combo->popwin);
437 gtk_grab_remove (combo->popwin);
438 gdk_pointer_ungrab (GDK_CURRENT_TIME);
445 gtk_combo_init (GtkCombo * combo)
449 GtkWidget *event_box;
452 combo->case_sensitive = 0;
453 combo->value_in_list = 0;
454 combo->ok_if_empty = 1;
455 combo->use_arrows = 1;
456 combo->use_arrows_always = 0;
457 combo->entry = gtk_entry_new ();
458 combo->button = gtk_button_new ();
459 arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_OUT);
460 gtk_widget_show (arrow);
461 gtk_container_add (GTK_CONTAINER (combo->button), arrow);
462 gtk_box_pack_start (GTK_BOX (combo), combo->entry, TRUE, TRUE, 0);
463 gtk_box_pack_end (GTK_BOX (combo), combo->button, FALSE, FALSE, 0);
464 gtk_widget_show (combo->entry);
465 gtk_widget_show (combo->button);
466 combo->entry_change_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "changed",
467 (GtkSignalFunc) gtk_combo_update_list, combo);
468 gtk_signal_connect (GTK_OBJECT (combo->entry), "key_press_event",
469 (GtkSignalFunc) gtk_combo_entry_key_press, combo);
470 gtk_signal_connect_after (GTK_OBJECT (combo->entry), "focus_out_event",
471 (GtkSignalFunc) gtk_combo_entry_focus_out, combo);
472 combo->activate_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "activate",
473 (GtkSignalFunc) gtk_combo_popup_list, combo);
474 gtk_signal_connect (GTK_OBJECT (combo->button), "clicked",
475 (GtkSignalFunc) gtk_combo_popup_list, combo);
476 /*gtk_signal_connect(GTK_OBJECT(combo->button), "clicked",
477 (GtkSignalFunc)prelight_bug, combo); */
479 combo->popwin = gtk_window_new (GTK_WINDOW_POPUP);
480 gtk_widget_ref (combo->popwin);
481 gtk_window_set_policy (GTK_WINDOW (combo->popwin), 1, 1, 0);
483 gtk_widget_set_events (combo->popwin, GDK_KEY_PRESS_MASK);
485 event_box = gtk_event_box_new ();
486 gtk_container_add (GTK_CONTAINER (combo->popwin), event_box);
487 gtk_widget_show (event_box);
489 gtk_widget_realize (event_box);
490 cursor = gdk_cursor_new (GDK_TOP_LEFT_ARROW);
491 gdk_window_set_cursor (event_box->window, cursor);
492 gdk_cursor_destroy (cursor);
494 frame = gtk_frame_new (NULL);
495 gtk_container_add (GTK_CONTAINER (event_box), frame);
496 gtk_frame_set_shadow_type (GTK_FRAME (frame), GTK_SHADOW_OUT);
497 gtk_widget_show (frame);
499 combo->popup = gtk_scrolled_window_new (NULL, NULL);
500 gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (combo->popup),
501 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
503 combo->list = gtk_list_new ();
504 gtk_list_set_selection_mode(GTK_LIST(combo->list), GTK_SELECTION_BROWSE);
505 gtk_container_add (GTK_CONTAINER (frame), combo->popup);
506 gtk_container_add (GTK_CONTAINER (combo->popup), combo->list);
507 gtk_widget_show (combo->list);
508 gtk_widget_show (combo->popup);
510 combo->list_change_id = gtk_signal_connect (GTK_OBJECT (combo->list), "selection_changed",
511 (GtkSignalFunc) gtk_combo_update_entry, combo);
512 gtk_signal_connect (GTK_OBJECT (combo->popwin), "key_press_event",
513 (GtkSignalFunc) gtk_combo_list_key_press, combo);
514 gtk_signal_connect (GTK_OBJECT (combo->popwin), "button_press_event",
515 GTK_SIGNAL_FUNC (gtk_combo_button_press), combo);
520 gtk_combo_get_type ()
522 static guint combo_type = 0;
526 GtkTypeInfo combo_info =
530 sizeof (GtkComboClass),
531 (GtkClassInitFunc) gtk_combo_class_init,
532 (GtkObjectInitFunc) gtk_combo_init,
533 (GtkArgSetFunc) NULL,
534 (GtkArgGetFunc) NULL,
536 combo_type = gtk_type_unique (gtk_hbox_get_type (), &combo_info);
544 return GTK_WIDGET (gtk_type_new (gtk_combo_get_type ()));
548 gtk_combo_set_value_in_list (GtkCombo * combo, gint val, gint ok_if_empty)
550 g_return_if_fail (combo != NULL);
551 g_return_if_fail (GTK_IS_COMBO (combo));
553 combo->value_in_list = val;
554 combo->ok_if_empty = ok_if_empty;
558 gtk_combo_set_case_sensitive (GtkCombo * combo, gint val)
560 g_return_if_fail (combo != NULL);
561 g_return_if_fail (GTK_IS_COMBO (combo));
563 combo->case_sensitive = val;
567 gtk_combo_set_use_arrows (GtkCombo * combo, gint val)
569 g_return_if_fail (combo != NULL);
570 g_return_if_fail (GTK_IS_COMBO (combo));
572 combo->use_arrows = val;
576 gtk_combo_set_use_arrows_always (GtkCombo * combo, gint val)
578 g_return_if_fail (combo != NULL);
579 g_return_if_fail (GTK_IS_COMBO (combo));
581 combo->use_arrows_always = val;
582 combo->use_arrows = 1;
586 gtk_combo_set_popdown_strings (GtkCombo * combo, GList * strings)
591 g_return_if_fail (combo != NULL);
592 g_return_if_fail (GTK_IS_COMBO (combo));
593 g_return_if_fail (strings != NULL);
595 gtk_list_clear_items (GTK_LIST (combo->list), 0, -1);
599 li = gtk_list_item_new_with_label ((gchar *) list->data);
600 gtk_widget_show (li);
601 gtk_container_add (GTK_CONTAINER (combo->list), li);
607 gtk_combo_item_destroy (GtkObject * object)
611 key = gtk_object_get_data (object, gtk_combo_string_key);
617 gtk_combo_set_item_string (GtkCombo * combo, GtkItem * item, const gchar * item_value)
622 g_return_if_fail (combo != NULL);
623 g_return_if_fail (GTK_IS_COMBO (combo));
624 g_return_if_fail (item != NULL);
626 val = gtk_object_get_data (GTK_OBJECT (item), gtk_combo_string_key);
634 val = g_strdup(item_value);
635 gtk_object_set_data (GTK_OBJECT (item), gtk_combo_string_key, val);
637 gtk_signal_connect (GTK_OBJECT (item), "destroy",
638 (GtkSignalFunc) gtk_combo_item_destroy, val);
642 gtk_object_set_data (GTK_OBJECT (item), gtk_combo_string_key, NULL);
644 gtk_signal_disconnect_by_data(GTK_OBJECT (item), val);
649 gtk_combo_size_allocate (GtkWidget *widget,
650 GtkAllocation *allocation)
654 g_return_if_fail (widget != NULL);
655 g_return_if_fail (GTK_IS_COMBO (widget));
656 g_return_if_fail (allocation != NULL);
658 GTK_WIDGET_CLASS (parent_class)->size_allocate (widget, allocation);
660 combo = GTK_COMBO (widget);
662 if (combo->entry->allocation.height > combo->entry->requisition.height)
664 GtkAllocation button_allocation;
666 button_allocation = combo->button->allocation;
667 button_allocation.height = combo->entry->requisition.height;
668 button_allocation.y = combo->entry->allocation.y +
669 (combo->entry->allocation.height - combo->entry->requisition.height)
671 gtk_widget_size_allocate (combo->button, &button_allocation);
676 gtk_combo_disable_activate (GtkCombo* combo)
678 g_return_if_fail (combo != NULL);
679 g_return_if_fail (GTK_IS_COMBO (combo));
681 if ( combo->activate_id ) {
682 gtk_signal_disconnect(GTK_OBJECT(combo), combo->activate_id);
683 combo->activate_id = 0;