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