Pileus Git - ~andy/gtk/blob - gtk/gtkcombo.c

   1 /* gtkcombo - combo widget for gtk+
   2  * Copyright 1997 Paolo Molaro
   3  *
   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.
   8  *
   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.
  13  *
  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.
  17  */
  18
  19 /* $Id$ */
  20
  21 #include <string.h>
  22
  23 #include "gtkarrow.h"
  24 #include "gtklabel.h"
  25 #include "gtklist.h"
  26 #include "gtkentry.h"
  27 #include "gtkbutton.h"
  28 #include "gtklistitem.h"
  29 #include "gtkscrolledwindow.h"
  30 #include "gtkmain.h"
  31 #include "gtksignal.h"
  32 #include "gtkwindow.h"
  33 #include "gdk/gdkkeysyms.h"
  34 #include "gtkcombo.h"
  35
  36 const gchar *gtk_combo_string_key = "gtk-combo-string-value";
  37
  38 #define COMBO_LIST_MAX_HEIGHT 400
  39
  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,
  47                                                GdkEventFocus *event,
  48                                                GtkCombo      *combo);
  49 static void         gtk_combo_get_pos         (GtkCombo      *combo,
  50                                                gint          *x,
  51                                                gint          *y,
  52                                                gint          *height,
  53                                                gint          *width);
  54 static void         gtk_combo_popup_list      (GtkButton     *button,
  55                                                GtkCombo      *combo);
  56 static void         gtk_combo_update_entry    (GtkList       *list,
  57                                                GtkCombo      *combo);
  58 static void         gtk_combo_update_list     (GtkEntry      *entry,
  59                                                GtkCombo      *combo);
  60 static gint         gtk_combo_button_press    (GtkWidget     *widget,
  61                                                GdkEvent      *event,
  62                                                GtkCombo      *combo);
  63 static gint         gtk_combo_list_key_press  (GtkWidget     *widget,
  64                                                GdkEventKey   *event,
  65                                                GtkCombo      *combo);
  66 static gint         gtk_combo_entry_key_press (GtkEntry      *widget,
  67                                                GdkEventKey   *event,
  68                                                GtkCombo      *combo);
  69 static void         gtk_combo_item_destroy    (GtkObject     *object);
  70
  71 static GtkHBoxClass *parent_class = NULL;
  72
  73 void
  74 gtk_combo_class_init (GtkComboClass * klass)
  75 {
  76   GtkObjectClass *oclass;
  77
  78   parent_class = gtk_type_class (gtk_hbox_get_type ());
  79   oclass = (GtkObjectClass *) klass;
  80
  81   oclass->destroy = gtk_combo_destroy;
  82 }
  83
  84 static void
  85 gtk_combo_destroy (GtkObject * combo)
  86 {
  87   gtk_widget_destroy (GTK_COMBO (combo)->popwin);
  88   gtk_widget_unref (GTK_COMBO (combo)->popwin);
  89
  90   if (GTK_OBJECT_CLASS (parent_class)->destroy)
  91     (*GTK_OBJECT_CLASS (parent_class)->destroy) (combo);
  92 }
  93
  94 static int
  95 gtk_combo_entry_key_press (GtkEntry * entry, GdkEventKey * event, GtkCombo * combo)
  96 {
  97   GList *li;
  98   /* completion? */
  99   /*if ( event->keyval == GDK_Tab ) {
 100      gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
 101      return TRUE;
 102      } else */
 103   if (!combo->use_arrows || !GTK_LIST (combo->list)->children)
 104     return FALSE;
 105   li = g_list_find (GTK_LIST (combo->list)->children, gtk_combo_find (combo));
 106
 107   if ((event->keyval == GDK_Up)
 108       || (event->keyval == GDK_KP_Up)
 109       || ((event->state & GDK_MOD1_MASK) && ((event->keyval == 'p') || (event->keyval == 'P'))))
 110     {
 111       if (li)
 112         li = li->prev;
 113       if (!li && combo->use_arrows_always)
 114         {
 115           li = g_list_last (GTK_LIST (combo->list)->children);
 116         }
 117       if (li)
 118         {
 119           gtk_list_select_child (GTK_LIST (combo->list), GTK_WIDGET (li->data));
 120           gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
 121           return TRUE;
 122         }
 123     }
 124   else if ((event->keyval == GDK_Down)
 125            || (event->keyval == GDK_KP_Down)
 126            || ((event->state & GDK_MOD1_MASK) && ((event->keyval == 'n') || (event->keyval == 'N'))))
 127     {
 128       if (li)
 129         li = li->next;
 130       if (!li && combo->use_arrows_always)
 131         {
 132           li = GTK_LIST (combo->list)->children;
 133         }
 134       if (li)
 135         {
 136           gtk_list_select_child (GTK_LIST (combo->list), GTK_WIDGET (li->data));
 137           gtk_signal_emit_stop_by_name (GTK_OBJECT (entry), "key_press_event");
 138           return TRUE;
 139         }
 140     }
 141   return FALSE;
 142 }
 143
 144 static GtkListItem *
 145 gtk_combo_find (GtkCombo * combo)
 146 {
 147   gchar *text;
 148   gchar *ltext;
 149   GList *clist;
 150   int (*string_compare) (const char *, const char *);
 151
 152   if (combo->case_sensitive)
 153     string_compare = strcmp;
 154   else
 155     string_compare = (void*) g_strcasecmp;
 156
 157   text = gtk_entry_get_text (GTK_ENTRY (combo->entry));
 158   clist = GTK_LIST (combo->list)->children;
 159
 160   while (clist && clist->data)
 161     {
 162       ltext = gtk_combo_func (GTK_LIST_ITEM (clist->data));
 163       if (!ltext)
 164         continue;
 165       if (!(*string_compare) (ltext, text))
 166         return (GtkListItem *) clist->data;
 167       clist = clist->next;
 168     }
 169
 170   return NULL;
 171 }
 172
 173 static gchar *
 174 gtk_combo_func (GtkListItem * li)
 175 {
 176   GtkWidget *label;
 177   gchar *ltext = NULL;
 178
 179   ltext = (gchar *) gtk_object_get_data (GTK_OBJECT (li), gtk_combo_string_key);
 180   if (!ltext)
 181     {
 182       label = GTK_BIN (li)->child;
 183       if (!label || !GTK_IS_LABEL (label))
 184         return NULL;
 185       gtk_label_get (GTK_LABEL (label), &ltext);
 186     }
 187   return ltext;
 188 }
 189
 190 static gint
 191 gtk_combo_focus_idle (GtkCombo * combo)
 192 {
 193   if (combo)
 194     gtk_widget_grab_focus (combo->entry);
 195   return FALSE;
 196 }
 197
 198 static gint
 199 gtk_combo_entry_focus_out (GtkEntry * entry, GdkEventFocus * event, GtkCombo * combo)
 200 {
 201
 202   if (combo->value_in_list && !gtk_combo_find (combo))
 203     {
 204       /* gdk_beep(); *//* this can be annoying */
 205       if (combo->ok_if_empty && !strcmp (gtk_entry_get_text (entry), ""))
 206         return FALSE;
 207 #ifdef TEST
 208       printf ("INVALID ENTRY: `%s'\n", gtk_entry_get_text (entry));
 209 #endif
 210       gtk_grab_add (GTK_WIDGET (combo));
 211       /* this is needed because if we call gtk_widget_grab_focus()
 212          it isn't guaranteed it's the *last* call before the main-loop,
 213          so the focus can be lost anyway...
 214          the signal_emit_stop doesn't seem to work either...
 215        */
 216       gtk_idle_add ((GtkFunction) gtk_combo_focus_idle, combo);
 217       /*gtk_signal_emit_stop_by_name(GTK_OBJECT(entry), "focus_out_event"); */
 218       return TRUE;
 219     }
 220   return FALSE;
 221 }
 222
 223 static void
 224 gtk_combo_get_pos (GtkCombo * combo, gint * x, gint * y, gint * height, gint * width)
 225 {
 226   GtkAllocation *pos = &(GTK_WIDGET (combo->entry)->allocation);
 227   GtkRequisition req1;
 228   GtkRequisition req3;
 229   gint some_more = 10 + GTK_CONTAINER (combo->popup)->border_width * 2;         /* FIXME: calc from border_width ... */
 230
 231   gtk_widget_size_request (combo->popup, &req1);
 232   gtk_widget_size_request (combo->list, &req3);
 233
 234   *width = pos->width;
 235   gdk_window_get_origin (GTK_WIDGET (combo->entry)->window, x, y);
 236   *y += pos->height;
 237   *height = MIN (COMBO_LIST_MAX_HEIGHT, gdk_screen_height () - *y);
 238
 239   if (some_more + req3.width > *width)
 240     some_more += 11 + 2 * 2;    /* FIXME: get from the scrollbar and scrollbar_spacing */
 241   if (some_more + req3.height < *height)
 242     *height = some_more + req3.height;
 243
 244 }
 245
 246 static void
 247 gtk_combo_popup_list (GtkButton * button, GtkCombo * combo)
 248 {
 249   gint height, width, x, y;
 250
 251   if (!GTK_LIST (combo->list)->children)
 252     return;
 253   gtk_combo_get_pos (combo, &x, &y, &height, &width);
 254
 255   gtk_widget_set_uposition (combo->popwin, x, y);
 256   gtk_widget_set_usize (combo->popwin, width, height);
 257   gtk_widget_realize (combo->popwin);
 258   gdk_window_set_cursor (combo->popwin->window,
 259                          gdk_cursor_new (GDK_TOP_LEFT_ARROW));
 260   gdk_window_resize (combo->popwin->window, width, height);
 261   gtk_widget_show (combo->popwin);
 262   gtk_widget_grab_focus (combo->popwin);
 263   gtk_grab_add (combo->popwin);
 264   gdk_pointer_grab (combo->popwin->window, TRUE,
 265                     GDK_BUTTON_PRESS_MASK, NULL, NULL, GDK_CURRENT_TIME);
 266 }
 267
 268 #if 0
 269 static void
 270 prelight_bug (GtkButton * b, GtkCombo * combo)
 271 {
 272   /* avoid prelight state... */
 273   gtk_widget_set_state (combo->button, GTK_STATE_NORMAL);
 274
 275 }
 276 #endif
 277
 278 static void
 279 gtk_combo_update_entry (GtkList * list, GtkCombo * combo)
 280 {
 281   char *text;
 282
 283   gtk_grab_remove (GTK_WIDGET (combo));
 284   gtk_signal_handler_block (GTK_OBJECT (list), combo->list_change_id);
 285   if (list->selection)
 286     {
 287       text = gtk_combo_func (GTK_LIST_ITEM (list->selection->data));
 288       if (!text)
 289         text = "";
 290       gtk_entry_set_text (GTK_ENTRY (combo->entry), text);
 291     }
 292   gtk_widget_hide (combo->popwin);
 293   gtk_grab_remove (combo->popwin);
 294   gdk_pointer_ungrab (GDK_CURRENT_TIME);
 295   gtk_signal_handler_unblock (GTK_OBJECT (list), combo->list_change_id);
 296 }
 297
 298 static void
 299 gtk_combo_update_list (GtkEntry * entry, GtkCombo * combo)
 300 {
 301   GtkList *list = GTK_LIST (combo->list);
 302   GList *slist = list->selection;
 303   GtkListItem *li;
 304
 305   gtk_grab_remove (GTK_WIDGET (combo));
 306
 307   gtk_signal_handler_block (GTK_OBJECT (entry), combo->entry_change_id);
 308   if (slist && slist->data)
 309     gtk_list_unselect_child (list, GTK_WIDGET (slist->data));
 310   li = gtk_combo_find (combo);
 311   if (li)
 312     gtk_list_select_child (list, GTK_WIDGET (li));
 313   gtk_signal_handler_unblock (GTK_OBJECT (entry), combo->entry_change_id);
 314 }
 315
 316 static gint
 317 gtk_combo_button_press (GtkWidget * widget, GdkEvent * event, GtkCombo * combo)
 318 {
 319   GtkWidget *child;
 320
 321   child = gtk_get_event_widget (event);
 322
 323   /* We don't ask for button press events on the grab widget, so
 324    *  if an event is reported directly to the grab widget, it must
 325    *  be on a window outside the application (and thus we remove
 326    *  the popup window). Otherwise, we check if the widget is a child
 327    *  of the grab widget, and only remove the popup window if it
 328    *  is not.
 329    */
 330   if (child != widget)
 331     {
 332       while (child)
 333         {
 334           if (child == widget)
 335             return FALSE;
 336           child = child->parent;
 337         }
 338     }
 339
 340   gtk_widget_hide (combo->popwin);
 341   gtk_grab_remove (combo->popwin);
 342   gdk_pointer_ungrab (GDK_CURRENT_TIME);
 343
 344   return TRUE;
 345 }
 346
 347 static int
 348 gtk_combo_list_key_press (GtkWidget * widget, GdkEventKey * event, GtkCombo * combo)
 349 {
 350   if (event->keyval == GDK_Escape)
 351     {
 352       gtk_widget_hide (combo->popwin);
 353       gtk_grab_remove (combo->popwin);
 354       gdk_pointer_ungrab (GDK_CURRENT_TIME);
 355       return TRUE;
 356     }
 357   return FALSE;
 358 }
 359
 360 void
 361 gtk_combo_init (GtkCombo * combo)
 362 {
 363   GtkWidget *arrow;
 364
 365   combo->case_sensitive = 0;
 366   combo->value_in_list = 0;
 367   combo->ok_if_empty = 1;
 368   combo->use_arrows = 1;
 369   combo->use_arrows_always = 0;
 370   combo->entry = gtk_entry_new ();
 371   combo->button = gtk_button_new ();
 372   arrow = gtk_arrow_new (GTK_ARROW_DOWN, GTK_SHADOW_OUT);
 373   gtk_widget_show (arrow);
 374   gtk_container_add (GTK_CONTAINER (combo->button), arrow);
 375   gtk_box_pack_start (GTK_BOX (combo), combo->entry, TRUE, TRUE, 0);
 376   gtk_box_pack_end (GTK_BOX (combo), combo->button, FALSE, FALSE, 0);
 377   gtk_widget_show (combo->entry);
 378   gtk_widget_show (combo->button);
 379   combo->entry_change_id = gtk_signal_connect (GTK_OBJECT (combo->entry), "changed",
 380                               (GtkSignalFunc) gtk_combo_update_list, combo);
 381   gtk_signal_connect (GTK_OBJECT (combo->entry), "key_press_event",
 382                       (GtkSignalFunc) gtk_combo_entry_key_press, combo);
 383   gtk_signal_connect_after (GTK_OBJECT (combo->entry), "focus_out_event",
 384                             (GtkSignalFunc) gtk_combo_entry_focus_out, combo);
 385   gtk_signal_connect (GTK_OBJECT (combo->entry), "activate",
 386                       (GtkSignalFunc) gtk_combo_popup_list, combo);
 387   gtk_signal_connect (GTK_OBJECT (combo->button), "clicked",
 388                       (GtkSignalFunc) gtk_combo_popup_list, combo);
 389   /*gtk_signal_connect(GTK_OBJECT(combo->button), "clicked",
 390      (GtkSignalFunc)prelight_bug, combo); */
 391
 392   combo->popwin = gtk_window_new (GTK_WINDOW_POPUP);
 393   gtk_widget_ref (combo->popwin);
 394   gtk_window_set_policy (GTK_WINDOW (combo->popwin), 1, 1, 0);
 395   combo->popup = gtk_scrolled_window_new (NULL, NULL);
 396   gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (combo->popup),
 397                                 GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 398   combo->list = gtk_list_new ();
 399   gtk_list_set_selection_mode(GTK_LIST(combo->list), GTK_SELECTION_BROWSE);
 400   gtk_container_add (GTK_CONTAINER (combo->popwin), combo->popup);
 401   gtk_container_add (GTK_CONTAINER (combo->popup), combo->list);
 402   gtk_widget_show (combo->list);
 403   gtk_widget_show (combo->popup);
 404   gtk_widget_set_events (combo->popwin, gtk_widget_get_events (combo->popwin) | GDK_KEY_PRESS_MASK);
 405   combo->list_change_id = gtk_signal_connect (GTK_OBJECT (combo->list), "selection_changed",
 406                              (GtkSignalFunc) gtk_combo_update_entry, combo);
 407   gtk_signal_connect (GTK_OBJECT (combo->popwin), "key_press_event",
 408                       (GtkSignalFunc) gtk_combo_list_key_press, combo);
 409   gtk_signal_connect (GTK_OBJECT (combo->popwin), "button_press_event",
 410                       GTK_SIGNAL_FUNC (gtk_combo_button_press), combo);
 411
 412 }
 413
 414 guint
 415 gtk_combo_get_type ()
 416 {
 417   static guint combo_type = 0;
 418
 419   if (!combo_type)
 420     {
 421       GtkTypeInfo combo_info =
 422       {
 423         "GtkCombo",
 424         sizeof (GtkCombo),
 425         sizeof (GtkComboClass),
 426         (GtkClassInitFunc) gtk_combo_class_init,
 427         (GtkObjectInitFunc) gtk_combo_init,
 428         (GtkArgSetFunc) NULL,
 429         (GtkArgGetFunc) NULL,
 430       };
 431       combo_type = gtk_type_unique (gtk_hbox_get_type (), &combo_info);
 432     }
 433   return combo_type;
 434 }
 435
 436 GtkWidget *
 437 gtk_combo_new ()
 438 {
 439   return GTK_WIDGET (gtk_type_new (gtk_combo_get_type ()));
 440 }
 441
 442 void
 443 gtk_combo_set_value_in_list (GtkCombo * combo, gint val, gint ok_if_empty)
 444 {
 445   g_return_if_fail (combo != NULL);
 446   g_return_if_fail (GTK_IS_COMBO (combo));
 447
 448   combo->value_in_list = val;
 449   combo->ok_if_empty = ok_if_empty;
 450 }
 451
 452 void
 453 gtk_combo_set_case_sensitive (GtkCombo * combo, gint val)
 454 {
 455   g_return_if_fail (combo != NULL);
 456   g_return_if_fail (GTK_IS_COMBO (combo));
 457
 458   combo->case_sensitive = val;
 459 }
 460
 461 void
 462 gtk_combo_set_use_arrows (GtkCombo * combo, gint val)
 463 {
 464   g_return_if_fail (combo != NULL);
 465   g_return_if_fail (GTK_IS_COMBO (combo));
 466
 467   combo->use_arrows = val;
 468 }
 469
 470 void
 471 gtk_combo_set_use_arrows_always (GtkCombo * combo, gint val)
 472 {
 473   g_return_if_fail (combo != NULL);
 474   g_return_if_fail (GTK_IS_COMBO (combo));
 475
 476   combo->use_arrows_always = val;
 477   combo->use_arrows = 1;
 478 }
 479
 480 void
 481 gtk_combo_set_popdown_strings (GtkCombo * combo, GList * strings)
 482 {
 483   GList *list;
 484   GtkWidget *li;
 485
 486   g_return_if_fail (combo != NULL);
 487   g_return_if_fail (GTK_IS_COMBO (combo));
 488   g_return_if_fail (strings != NULL);
 489
 490   gtk_list_clear_items (GTK_LIST (combo->list), 0, -1);
 491   list = strings;
 492   while (list)
 493     {
 494       li = gtk_list_item_new_with_label ((gchar *) list->data);
 495       gtk_widget_show (li);
 496       gtk_container_add (GTK_CONTAINER (combo->list), li);
 497       list = list->next;
 498     }
 499 }
 500
 501 static void
 502 gtk_combo_item_destroy (GtkObject * object)
 503 {
 504   gchar *key;
 505
 506   key = gtk_object_get_data (object, gtk_combo_string_key);
 507   if (key)
 508     g_free (key);
 509 }
 510
 511 void
 512 gtk_combo_set_item_string (GtkCombo * combo, GtkItem * item, const gchar * item_value)
 513 {
 514   gchar *val;
 515   gint connected = 0;
 516
 517   g_return_if_fail (combo != NULL);
 518   g_return_if_fail (GTK_IS_COMBO (combo));
 519   g_return_if_fail (item != NULL);
 520
 521   val = gtk_object_get_data (GTK_OBJECT (item), gtk_combo_string_key);
 522   if (val)
 523     {
 524       g_free (val);
 525       connected = 1;
 526     }
 527   if (item_value)
 528     {
 529       val = g_strdup(item_value);
 530       gtk_object_set_data (GTK_OBJECT (item), gtk_combo_string_key, val);
 531       if (!connected)
 532         gtk_signal_connect (GTK_OBJECT (item), "destroy",
 533                           (GtkSignalFunc) gtk_combo_item_destroy, val);
 534     }
 535   else
 536     {
 537       gtk_object_set_data (GTK_OBJECT (item), gtk_combo_string_key, NULL);
 538       if (connected)
 539         gtk_signal_disconnect_by_data(GTK_OBJECT (item), val);
 540     }
 541 }