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

   1 /* gtkentrycompletion.c
   2  * Copyright (C) 2003  Kristian Rietveld  <kris@gtk.org>
   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
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #include "config.h"
  21 #include "gtkentrycompletion.h"
  22 #include "gtkentryprivate.h"
  23 #include "gtkcelllayout.h"
  24
  25 #include "gtkintl.h"
  26 #include "gtkcellrenderertext.h"
  27 #include "gtkframe.h"
  28 #include "gtktreeselection.h"
  29 #include "gtktreeview.h"
  30 #include "gtkscrolledwindow.h"
  31 #include "gtkvbox.h"
  32 #include "gtkwindow.h"
  33 #include "gtkentry.h"
  34 #include "gtkmain.h"
  35 #include "gtkmarshalers.h"
  36
  37 #include "gtkprivate.h"
  38 #include "gtkalias.h"
  39
  40 #include <string.h>
  41
  42
  43 /* signals */
  44 enum
  45 {
  46   INSERT_PREFIX,
  47   MATCH_SELECTED,
  48   ACTION_ACTIVATED,
  49   CURSOR_ON_MATCH,
  50   LAST_SIGNAL
  51 };
  52
  53 /* properties */
  54 enum
  55 {
  56   PROP_0,
  57   PROP_MODEL,
  58   PROP_MINIMUM_KEY_LENGTH,
  59   PROP_TEXT_COLUMN,
  60   PROP_INLINE_COMPLETION,
  61   PROP_POPUP_COMPLETION,
  62   PROP_POPUP_SET_WIDTH,
  63   PROP_POPUP_SINGLE_MATCH,
  64   PROP_INLINE_SELECTION
  65 };
  66
  67 #define GTK_ENTRY_COMPLETION_GET_PRIVATE(obj)(G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_ENTRY_COMPLETION, GtkEntryCompletionPrivate))
  68
  69 static void                                                             gtk_entry_completion_cell_layout_init    (GtkCellLayoutIface      *iface);
  70 static void     gtk_entry_completion_set_property        (GObject      *object,
  71                                                           guint         prop_id,
  72                                                           const GValue *value,
  73                                                           GParamSpec   *pspec);
  74 static void     gtk_entry_completion_get_property        (GObject      *object,
  75                                                           guint         prop_id,
  76                                                           GValue       *value,
  77                                                           GParamSpec   *pspec);
  78 static void                                                             gtk_entry_completion_finalize            (GObject                 *object);
  79
  80 static void     gtk_entry_completion_pack_start          (GtkCellLayout         *cell_layout,
  81                                                           GtkCellRenderer       *cell,
  82                                                           gboolean               expand);
  83 static void     gtk_entry_completion_pack_end            (GtkCellLayout         *cell_layout,
  84                                                           GtkCellRenderer       *cell,
  85                                                           gboolean               expand);
  86 static void                                                                      gtk_entry_completion_clear               (GtkCellLayout           *cell_layout);
  87 static void     gtk_entry_completion_add_attribute       (GtkCellLayout         *cell_layout,
  88                                                           GtkCellRenderer       *cell,
  89                                                           const char            *attribute,
  90                                                           gint                   column);
  91 static void     gtk_entry_completion_set_cell_data_func  (GtkCellLayout         *cell_layout,
  92                                                           GtkCellRenderer       *cell,
  93                                                           GtkCellLayoutDataFunc  func,
  94                                                           gpointer               func_data,
  95                                                           GDestroyNotify         destroy);
  96 static void     gtk_entry_completion_clear_attributes    (GtkCellLayout         *cell_layout,
  97                                                           GtkCellRenderer       *cell);
  98 static void     gtk_entry_completion_reorder             (GtkCellLayout         *cell_layout,
  99                                                           GtkCellRenderer       *cell,
 100                                                           gint                   position);
 101 static GList *  gtk_entry_completion_get_cells           (GtkCellLayout         *cell_layout);
 102
 103 static gboolean gtk_entry_completion_visible_func        (GtkTreeModel       *model,
 104                                                           GtkTreeIter        *iter,
 105                                                           gpointer            data);
 106 static gboolean gtk_entry_completion_popup_key_event     (GtkWidget          *widget,
 107                                                           GdkEventKey        *event,
 108                                                           gpointer            user_data);
 109 static gboolean gtk_entry_completion_popup_button_press  (GtkWidget          *widget,
 110                                                           GdkEventButton     *event,
 111                                                           gpointer            user_data);
 112 static gboolean gtk_entry_completion_list_button_press   (GtkWidget          *widget,
 113                                                           GdkEventButton     *event,
 114                                                           gpointer            user_data);
 115 static gboolean gtk_entry_completion_action_button_press (GtkWidget          *widget,
 116                                                           GdkEventButton     *event,
 117                                                           gpointer            user_data);
 118 static void     gtk_entry_completion_selection_changed   (GtkTreeSelection   *selection,
 119                                                           gpointer            data);
 120 static gboolean gtk_entry_completion_list_enter_notify   (GtkWidget          *widget,
 121                                                           GdkEventCrossing   *event,
 122                                                           gpointer            data);
 123 static gboolean gtk_entry_completion_list_motion_notify  (GtkWidget          *widget,
 124                                                           GdkEventMotion     *event,
 125                                                           gpointer            data);
 126 static void     gtk_entry_completion_insert_action       (GtkEntryCompletion *completion,
 127                                                           gint                index,
 128                                                           const gchar        *string,
 129                                                           gboolean            markup);
 130 static void     gtk_entry_completion_action_data_func    (GtkTreeViewColumn  *tree_column,
 131                                                           GtkCellRenderer    *cell,
 132                                                           GtkTreeModel       *model,
 133                                                           GtkTreeIter        *iter,
 134                                                           gpointer            data);
 135
 136 static gboolean gtk_entry_completion_match_selected      (GtkEntryCompletion *completion,
 137                                                           GtkTreeModel       *model,
 138                                                           GtkTreeIter        *iter);
 139 static gboolean gtk_entry_completion_real_insert_prefix  (GtkEntryCompletion *completion,
 140                                                           const gchar        *prefix);
 141 static gboolean gtk_entry_completion_cursor_on_match     (GtkEntryCompletion *completion,
 142                                                           GtkTreeModel       *model,
 143                                                           GtkTreeIter        *iter);
 144 static gboolean gtk_entry_completion_insert_completion   (GtkEntryCompletion *completion,
 145                                                           GtkTreeModel       *model,
 146                                                           GtkTreeIter        *iter);
 147 static void     gtk_entry_completion_insert_completion_text (GtkEntryCompletion *completion,
 148                                                              const gchar *text);
 149
 150 static guint entry_completion_signals[LAST_SIGNAL] = { 0 };
 151
 152 /* GtkBuildable */
 153 static void     gtk_entry_completion_buildable_init      (GtkBuildableIface  *iface);
 154
 155 G_DEFINE_TYPE_WITH_CODE (GtkEntryCompletion, gtk_entry_completion, G_TYPE_OBJECT,
 156                          G_IMPLEMENT_INTERFACE (GTK_TYPE_CELL_LAYOUT,
 157                                                 gtk_entry_completion_cell_layout_init)
 158                          G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
 159                                                 gtk_entry_completion_buildable_init))
 160
 161
 162 static void
 163 gtk_entry_completion_class_init (GtkEntryCompletionClass *klass)
 164 {
 165   GObjectClass *object_class;
 166
 167   object_class = (GObjectClass *)klass;
 168
 169   object_class->set_property = gtk_entry_completion_set_property;
 170   object_class->get_property = gtk_entry_completion_get_property;
 171   object_class->finalize = gtk_entry_completion_finalize;
 172
 173   klass->match_selected = gtk_entry_completion_match_selected;
 174   klass->insert_prefix = gtk_entry_completion_real_insert_prefix;
 175   klass->cursor_on_match = gtk_entry_completion_cursor_on_match;
 176
 177   /**
 178    * GtkEntryCompletion::insert-prefix:
 179    * @widget: the object which received the signal
 180    * @prefix: the common prefix of all possible completions
 181    *
 182    * Gets emitted when the inline autocompletion is triggered.
 183    * The default behaviour is to make the entry display the
 184    * whole prefix and select the newly inserted part.
 185    *
 186    * Applications may connect to this signal in order to insert only a
 187    * smaller part of the @prefix into the entry - e.g. the entry used in
 188    * the #GtkFileChooser inserts only the part of the prefix up to the
 189    * next '/'.
 190    *
 191    * Return value: %TRUE if the signal has been handled
 192    *
 193    * Since: 2.6
 194    */
 195   entry_completion_signals[INSERT_PREFIX] =
 196     g_signal_new (I_("insert-prefix"),
 197                   G_TYPE_FROM_CLASS (klass),
 198                   G_SIGNAL_RUN_LAST,
 199                   G_STRUCT_OFFSET (GtkEntryCompletionClass, insert_prefix),
 200                   _gtk_boolean_handled_accumulator, NULL,
 201                   _gtk_marshal_BOOLEAN__STRING,
 202                   G_TYPE_BOOLEAN, 1,
 203                   G_TYPE_STRING);
 204
 205   /**
 206    * GtkEntryCompletion::match-selected:
 207    * @widget: the object which received the signal
 208    * @model: the #GtkTreeModel containing the matches
 209    * @iter: a #GtkTreeIter positioned at the selected match
 210    *
 211    * Gets emitted when a match from the list is selected.
 212    * The default behaviour is to replace the contents of the
 213    * entry with the contents of the text column in the row
 214    * pointed to by @iter.
 215    *
 216    * Return value: %TRUE if the signal has been handled
 217    *
 218    * Since: 2.4
 219    */
 220   entry_completion_signals[MATCH_SELECTED] =
 221     g_signal_new (I_("match-selected"),
 222                   G_TYPE_FROM_CLASS (klass),
 223                   G_SIGNAL_RUN_LAST,
 224                   G_STRUCT_OFFSET (GtkEntryCompletionClass, match_selected),
 225                   _gtk_boolean_handled_accumulator, NULL,
 226                   _gtk_marshal_BOOLEAN__OBJECT_BOXED,
 227                   G_TYPE_BOOLEAN, 2,
 228                   GTK_TYPE_TREE_MODEL,
 229                   GTK_TYPE_TREE_ITER);
 230   /**
 231    * GtkEntryCompletion::cursor-on-match:
 232    * @widget: the object which received the signal
 233    * @model: the #GtkTreeModel containing the matches
 234    * @iter: a #GtkTreeIter positioned at the selected match
 235    *
 236    * Gets emitted when a match from the cursor is on a match
 237    * of the list.The default behaviour is to replace the contents
 238    * of the entry with the contents of the text column in the row
 239    * pointed to by @iter.
 240    *
 241    * Return value: %TRUE if the signal has been handled
 242    *
 243    * Since: 2.12
 244    */
 245
 246   entry_completion_signals[CURSOR_ON_MATCH] =
 247     g_signal_new (I_("cursor-on-match"),
 248                   G_TYPE_FROM_CLASS (klass),
 249                   G_SIGNAL_RUN_LAST,
 250                   G_STRUCT_OFFSET (GtkEntryCompletionClass, cursor_on_match),
 251                   _gtk_boolean_handled_accumulator, NULL,
 252                   _gtk_marshal_BOOLEAN__OBJECT_BOXED,
 253                   G_TYPE_BOOLEAN, 2,
 254                   GTK_TYPE_TREE_MODEL,
 255                   GTK_TYPE_TREE_ITER);
 256
 257   /**
 258    * GtkEntryCompletion::action-activated:
 259    * @widget: the object which received the signal
 260    * @index: the index of the activated action
 261    *
 262    * Gets emitted when an action is activated.
 263    *
 264    * Since: 2.4
 265    */
 266   entry_completion_signals[ACTION_ACTIVATED] =
 267     g_signal_new (I_("action-activated"),
 268                   G_TYPE_FROM_CLASS (klass),
 269                   G_SIGNAL_RUN_LAST,
 270                   G_STRUCT_OFFSET (GtkEntryCompletionClass, action_activated),
 271                   NULL, NULL,
 272                   _gtk_marshal_VOID__INT,
 273                   G_TYPE_NONE, 1,
 274                   G_TYPE_INT);
 275
 276   g_object_class_install_property (object_class,
 277                                    PROP_MODEL,
 278                                    g_param_spec_object ("model",
 279                                                         P_("Completion Model"),
 280                                                         P_("The model to find matches in"),
 281                                                         GTK_TYPE_TREE_MODEL,
 282                                                         GTK_PARAM_READWRITE));
 283   g_object_class_install_property (object_class,
 284                                    PROP_MINIMUM_KEY_LENGTH,
 285                                    g_param_spec_int ("minimum-key-length",
 286                                                      P_("Minimum Key Length"),
 287                                                      P_("Minimum length of the search key in order to look up matches"),
 288                                                      0,
 289                                                      G_MAXINT,
 290                                                      1,
 291                                                      GTK_PARAM_READWRITE));
 292   /**
 293    * GtkEntryCompletion:text-column:
 294    *
 295    * The column of the model containing the strings.
 296    * Note that the strings must be UTF-8.
 297    *
 298    * Since: 2.6
 299    */
 300   g_object_class_install_property (object_class,
 301                                    PROP_TEXT_COLUMN,
 302                                    g_param_spec_int ("text-column",
 303                                                      P_("Text column"),
 304                                                      P_("The column of the model containing the strings."),
 305                                                      -1,
 306                                                      G_MAXINT,
 307                                                      -1,
 308                                                      GTK_PARAM_READWRITE));
 309
 310   /**
 311    * GtkEntryCompletion:inline-completion:
 312    *
 313    * Determines whether the common prefix of the possible completions
 314    * should be inserted automatically in the entry. Note that this
 315    * requires text-column to be set, even if you are using a custom
 316    * match function.
 317    *
 318    * Since: 2.6
 319    **/
 320   g_object_class_install_property (object_class,
 321                                    PROP_INLINE_COMPLETION,
 322                                    g_param_spec_boolean ("inline-completion",
 323                                                          P_("Inline completion"),
 324                                                          P_("Whether the common prefix should be inserted automatically"),
 325                                                          FALSE,
 326                                                          GTK_PARAM_READWRITE));
 327   /**
 328    * GtkEntryCompletion:popup-completion:
 329    *
 330    * Determines whether the possible completions should be
 331    * shown in a popup window.
 332    *
 333    * Since: 2.6
 334    **/
 335   g_object_class_install_property (object_class,
 336                                    PROP_POPUP_COMPLETION,
 337                                    g_param_spec_boolean ("popup-completion",
 338                                                          P_("Popup completion"),
 339                                                          P_("Whether the completions should be shown in a popup window"),
 340                                                          TRUE,
 341                                                          GTK_PARAM_READWRITE));
 342
 343   /**
 344    * GtkEntryCompletion:popup-set-width:
 345    *
 346    * Determines whether the completions popup window will be
 347    * resized to the width of the entry.
 348    *
 349    * Since: 2.8
 350    */
 351   g_object_class_install_property (object_class,
 352                                    PROP_POPUP_SET_WIDTH,
 353                                    g_param_spec_boolean ("popup-set-width",
 354                                                          P_("Popup set width"),
 355                                                          P_("If TRUE, the popup window will have the same size as the entry"),
 356                                                          TRUE,
 357                                                          GTK_PARAM_READWRITE));
 358
 359   /**
 360    * GtkEntryCompletion:popup-single-match:
 361    *
 362    * Determines whether the completions popup window will shown
 363    * for a single possible completion. You probably want to set
 364    * this to %FALSE if you are using
 365    * <link linkend="GtkEntryCompletion--inline-completion">inline
 366    * completion</link>.
 367    *
 368    * Since: 2.8
 369    */
 370   g_object_class_install_property (object_class,
 371                                    PROP_POPUP_SINGLE_MATCH,
 372                                    g_param_spec_boolean ("popup-single-match",
 373                                                          P_("Popup single match"),
 374                                                          P_("If TRUE, the popup window will appear for a single match."),
 375                                                          TRUE,
 376                                                          GTK_PARAM_READWRITE));
 377   /**
 378    * GtkEntryCompletion:inline-selection:
 379    *
 380    * Determines whether the possible completions on the popup
 381    * will appear in the entry as you navigate through them.
 382
 383    * Since: 2.12
 384    */
 385   g_object_class_install_property (object_class,
 386                                    PROP_INLINE_SELECTION,
 387                                    g_param_spec_boolean ("inline-selection",
 388                                                          P_("Inline selection"),
 389                                                          P_("Your description here"),
 390                                                          FALSE,
 391                                                          GTK_PARAM_READWRITE));
 392
 393   g_type_class_add_private (object_class, sizeof (GtkEntryCompletionPrivate));
 394 }
 395
 396 static void
 397 gtk_entry_completion_buildable_init (GtkBuildableIface *iface)
 398 {
 399   iface->add_child = _gtk_cell_layout_buildable_add_child;
 400   iface->custom_tag_start = _gtk_cell_layout_buildable_custom_tag_start;
 401   iface->custom_tag_end = _gtk_cell_layout_buildable_custom_tag_end;
 402 }
 403
 404 static void
 405 gtk_entry_completion_cell_layout_init (GtkCellLayoutIface *iface)
 406 {
 407   iface->pack_start = gtk_entry_completion_pack_start;
 408   iface->pack_end = gtk_entry_completion_pack_end;
 409   iface->clear = gtk_entry_completion_clear;
 410   iface->add_attribute = gtk_entry_completion_add_attribute;
 411   iface->set_cell_data_func = gtk_entry_completion_set_cell_data_func;
 412   iface->clear_attributes = gtk_entry_completion_clear_attributes;
 413   iface->reorder = gtk_entry_completion_reorder;
 414   iface->get_cells = gtk_entry_completion_get_cells;
 415 }
 416
 417 static void
 418 gtk_entry_completion_init (GtkEntryCompletion *completion)
 419 {
 420   GtkCellRenderer *cell;
 421   GtkTreeSelection *sel;
 422   GtkEntryCompletionPrivate *priv;
 423   GtkWidget *popup_frame;
 424
 425   /* yes, also priv, need to keep the code readable */
 426   priv = completion->priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (completion);
 427
 428   priv->minimum_key_length = 1;
 429   priv->text_column = -1;
 430   priv->has_completion = FALSE;
 431   priv->inline_completion = FALSE;
 432   priv->popup_completion = TRUE;
 433   priv->popup_set_width = TRUE;
 434   priv->popup_single_match = TRUE;
 435   priv->inline_selection = FALSE;
 436
 437   /* completions */
 438   priv->filter_model = NULL;
 439
 440   priv->tree_view = gtk_tree_view_new ();
 441   g_signal_connect (priv->tree_view, "button-press-event",
 442                     G_CALLBACK (gtk_entry_completion_list_button_press),
 443                     completion);
 444   g_signal_connect (priv->tree_view, "enter-notify-event",
 445                     G_CALLBACK (gtk_entry_completion_list_enter_notify),
 446                     completion);
 447   g_signal_connect (priv->tree_view, "motion-notify-event",
 448                     G_CALLBACK (gtk_entry_completion_list_motion_notify),
 449                     completion);
 450
 451   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->tree_view), FALSE);
 452   gtk_tree_view_set_hover_selection (GTK_TREE_VIEW (priv->tree_view), TRUE);
 453
 454   sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->tree_view));
 455   gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
 456   gtk_tree_selection_unselect_all (sel);
 457   g_signal_connect (sel, "changed",
 458                     G_CALLBACK (gtk_entry_completion_selection_changed),
 459                     completion);
 460   priv->first_sel_changed = TRUE;
 461
 462   priv->column = gtk_tree_view_column_new ();
 463   gtk_tree_view_append_column (GTK_TREE_VIEW (priv->tree_view), priv->column);
 464
 465   priv->scrolled_window = gtk_scrolled_window_new (NULL, NULL);
 466   gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (priv->scrolled_window),
 467                                   GTK_POLICY_NEVER,
 468                                   GTK_POLICY_AUTOMATIC);
 469   gtk_scrolled_window_set_shadow_type (GTK_SCROLLED_WINDOW (priv->scrolled_window),
 470                                        GTK_SHADOW_NONE);
 471
 472   /* a nasty hack to get the completions treeview to size nicely */
 473   gtk_widget_set_size_request (GTK_SCROLLED_WINDOW (priv->scrolled_window)->vscrollbar, -1, 0);
 474
 475   /* actions */
 476   priv->actions = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_BOOLEAN);
 477
 478   priv->action_view =
 479     gtk_tree_view_new_with_model (GTK_TREE_MODEL (priv->actions));
 480   g_object_ref_sink (priv->action_view);
 481   g_signal_connect (priv->action_view, "button-press-event",
 482                     G_CALLBACK (gtk_entry_completion_action_button_press),
 483                     completion);
 484   g_signal_connect (priv->action_view, "enter-notify-event",
 485                     G_CALLBACK (gtk_entry_completion_list_enter_notify),
 486                     completion);
 487   g_signal_connect (priv->action_view, "motion-notify-event",
 488                     G_CALLBACK (gtk_entry_completion_list_motion_notify),
 489                     completion);
 490   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (priv->action_view), FALSE);
 491   gtk_tree_view_set_hover_selection (GTK_TREE_VIEW (priv->action_view), TRUE);
 492
 493   sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (priv->action_view));
 494   gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
 495   gtk_tree_selection_unselect_all (sel);
 496
 497   cell = gtk_cell_renderer_text_new ();
 498   gtk_tree_view_insert_column_with_data_func (GTK_TREE_VIEW (priv->action_view),
 499                                               0, "",
 500                                               cell,
 501                                               gtk_entry_completion_action_data_func,
 502                                               NULL,
 503                                               NULL);
 504
 505   /* pack it all */
 506   priv->popup_window = gtk_window_new (GTK_WINDOW_POPUP);
 507   gtk_window_set_resizable (GTK_WINDOW (priv->popup_window), FALSE);
 508   gtk_window_set_type_hint (GTK_WINDOW(priv->popup_window),
 509                             GDK_WINDOW_TYPE_HINT_COMBO);
 510   g_signal_connect (priv->popup_window, "key-press-event",
 511                     G_CALLBACK (gtk_entry_completion_popup_key_event),
 512                     completion);
 513   g_signal_connect (priv->popup_window, "key-release-event",
 514                     G_CALLBACK (gtk_entry_completion_popup_key_event),
 515                     completion);
 516   g_signal_connect (priv->popup_window, "button-press-event",
 517                     G_CALLBACK (gtk_entry_completion_popup_button_press),
 518                     completion);
 519
 520   popup_frame = gtk_frame_new (NULL);
 521   gtk_frame_set_shadow_type (GTK_FRAME (popup_frame),
 522                              GTK_SHADOW_ETCHED_IN);
 523   gtk_widget_show (popup_frame);
 524   gtk_container_add (GTK_CONTAINER (priv->popup_window), popup_frame);
 525
 526   priv->vbox = gtk_vbox_new (FALSE, 0);
 527   gtk_container_add (GTK_CONTAINER (popup_frame), priv->vbox);
 528
 529   gtk_container_add (GTK_CONTAINER (priv->scrolled_window), priv->tree_view);
 530   gtk_box_pack_start (GTK_BOX (priv->vbox), priv->scrolled_window,
 531                       TRUE, TRUE, 0);
 532
 533   /* we don't want to see the action treeview when no actions have
 534    * been inserted, so we pack the action treeview after the first
 535    * action has been added
 536    */
 537 }
 538
 539 static void
 540 gtk_entry_completion_set_property (GObject      *object,
 541                                    guint         prop_id,
 542                                    const GValue *value,
 543                                    GParamSpec   *pspec)
 544 {
 545   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (object);
 546   GtkEntryCompletionPrivate *priv = completion->priv;
 547
 548   switch (prop_id)
 549     {
 550       case PROP_MODEL:
 551         gtk_entry_completion_set_model (completion,
 552                                         g_value_get_object (value));
 553         break;
 554
 555       case PROP_MINIMUM_KEY_LENGTH:
 556         gtk_entry_completion_set_minimum_key_length (completion,
 557                                                      g_value_get_int (value));
 558         break;
 559
 560       case PROP_TEXT_COLUMN:
 561         priv->text_column = g_value_get_int (value);
 562         break;
 563
 564       case PROP_INLINE_COMPLETION:
 565         priv->inline_completion = g_value_get_boolean (value);
 566         break;
 567
 568       case PROP_POPUP_COMPLETION:
 569         priv->popup_completion = g_value_get_boolean (value);
 570         break;
 571
 572       case PROP_POPUP_SET_WIDTH:
 573         priv->popup_set_width = g_value_get_boolean (value);
 574         break;
 575
 576       case PROP_POPUP_SINGLE_MATCH:
 577         priv->popup_single_match = g_value_get_boolean (value);
 578         break;
 579
 580       case PROP_INLINE_SELECTION:
 581         priv->inline_selection = g_value_get_boolean (value);
 582         break;
 583
 584       default:
 585         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 586         break;
 587     }
 588 }
 589
 590 static void
 591 gtk_entry_completion_get_property (GObject    *object,
 592                                    guint       prop_id,
 593                                    GValue     *value,
 594                                    GParamSpec *pspec)
 595 {
 596   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (object);
 597
 598   switch (prop_id)
 599     {
 600       case PROP_MODEL:
 601         g_value_set_object (value,
 602                             gtk_entry_completion_get_model (completion));
 603         break;
 604
 605       case PROP_MINIMUM_KEY_LENGTH:
 606         g_value_set_int (value, gtk_entry_completion_get_minimum_key_length (completion));
 607         break;
 608
 609       case PROP_TEXT_COLUMN:
 610         g_value_set_int (value, gtk_entry_completion_get_text_column (completion));
 611         break;
 612
 613       case PROP_INLINE_COMPLETION:
 614         g_value_set_boolean (value, gtk_entry_completion_get_inline_completion (completion));
 615         break;
 616
 617       case PROP_POPUP_COMPLETION:
 618         g_value_set_boolean (value, gtk_entry_completion_get_popup_completion (completion));
 619         break;
 620
 621       case PROP_POPUP_SET_WIDTH:
 622         g_value_set_boolean (value, gtk_entry_completion_get_popup_set_width (completion));
 623         break;
 624
 625       case PROP_POPUP_SINGLE_MATCH:
 626         g_value_set_boolean (value, gtk_entry_completion_get_popup_single_match (completion));
 627         break;
 628
 629       case PROP_INLINE_SELECTION:
 630         g_value_set_boolean (value, gtk_entry_completion_get_inline_selection (completion));
 631         break;
 632
 633       default:
 634         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 635         break;
 636     }
 637 }
 638
 639 static void
 640 gtk_entry_completion_finalize (GObject *object)
 641 {
 642   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (object);
 643   GtkEntryCompletionPrivate *priv = completion->priv;
 644
 645   if (priv->tree_view)
 646     gtk_widget_destroy (priv->tree_view);
 647
 648   if (priv->entry)
 649     gtk_entry_set_completion (GTK_ENTRY (priv->entry), NULL);
 650
 651   if (priv->actions)
 652     g_object_unref (priv->actions);
 653   if (priv->action_view)
 654     g_object_unref (priv->action_view);
 655
 656   g_free (priv->case_normalized_key);
 657   g_free (priv->completion_prefix);
 658
 659   if (priv->popup_window)
 660     gtk_widget_destroy (priv->popup_window);
 661
 662   if (priv->match_notify)
 663     (* priv->match_notify) (priv->match_data);
 664
 665   G_OBJECT_CLASS (gtk_entry_completion_parent_class)->finalize (object);
 666 }
 667
 668 /* implement cell layout interface */
 669 static void
 670 gtk_entry_completion_pack_start (GtkCellLayout   *cell_layout,
 671                                  GtkCellRenderer *cell,
 672                                  gboolean         expand)
 673 {
 674   GtkEntryCompletionPrivate *priv;
 675
 676   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 677
 678   gtk_tree_view_column_pack_start (priv->column, cell, expand);
 679 }
 680
 681 static void
 682 gtk_entry_completion_pack_end (GtkCellLayout   *cell_layout,
 683                                GtkCellRenderer *cell,
 684                                gboolean         expand)
 685 {
 686   GtkEntryCompletionPrivate *priv;
 687
 688   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 689
 690   gtk_tree_view_column_pack_end (priv->column, cell, expand);
 691 }
 692
 693 static void
 694 gtk_entry_completion_clear (GtkCellLayout *cell_layout)
 695 {
 696   GtkEntryCompletionPrivate *priv;
 697
 698   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 699
 700   gtk_tree_view_column_clear (priv->column);
 701 }
 702
 703 static void
 704 gtk_entry_completion_add_attribute (GtkCellLayout   *cell_layout,
 705                                     GtkCellRenderer *cell,
 706                                     const gchar     *attribute,
 707                                     gint             column)
 708 {
 709   GtkEntryCompletionPrivate *priv;
 710
 711   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 712
 713   gtk_tree_view_column_add_attribute (priv->column, cell, attribute, column);
 714 }
 715
 716 static void
 717 gtk_entry_completion_set_cell_data_func (GtkCellLayout          *cell_layout,
 718                                          GtkCellRenderer        *cell,
 719                                          GtkCellLayoutDataFunc   func,
 720                                          gpointer                func_data,
 721                                          GDestroyNotify          destroy)
 722 {
 723   GtkEntryCompletionPrivate *priv;
 724
 725   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 726
 727   gtk_cell_layout_set_cell_data_func (GTK_CELL_LAYOUT (priv->column),
 728                                       cell, func, func_data, destroy);
 729 }
 730
 731 static void
 732 gtk_entry_completion_clear_attributes (GtkCellLayout   *cell_layout,
 733                                        GtkCellRenderer *cell)
 734 {
 735   GtkEntryCompletionPrivate *priv;
 736
 737   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 738
 739   gtk_tree_view_column_clear_attributes (priv->column, cell);
 740 }
 741
 742 static void
 743 gtk_entry_completion_reorder (GtkCellLayout   *cell_layout,
 744                               GtkCellRenderer *cell,
 745                               gint             position)
 746 {
 747   GtkEntryCompletionPrivate *priv;
 748
 749   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 750
 751   gtk_cell_layout_reorder (GTK_CELL_LAYOUT (priv->column), cell, position);
 752 }
 753
 754 static GList *
 755 gtk_entry_completion_get_cells (GtkCellLayout *cell_layout)
 756 {
 757   GtkEntryCompletionPrivate *priv;
 758
 759   priv = GTK_ENTRY_COMPLETION_GET_PRIVATE (cell_layout);
 760
 761   return gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (priv->column));
 762 }
 763
 764 /* all those callbacks */
 765 static gboolean
 766 gtk_entry_completion_default_completion_func (GtkEntryCompletion *completion,
 767                                               const gchar        *key,
 768                                               GtkTreeIter        *iter,
 769                                               gpointer            user_data)
 770 {
 771   gchar *item = NULL;
 772   gchar *normalized_string;
 773   gchar *case_normalized_string;
 774
 775   gboolean ret = FALSE;
 776
 777   GtkTreeModel *model;
 778
 779   model = gtk_tree_model_filter_get_model (completion->priv->filter_model);
 780
 781   g_return_val_if_fail (gtk_tree_model_get_column_type (model, completion->priv->text_column) == G_TYPE_STRING,
 782                         FALSE);
 783
 784   gtk_tree_model_get (model, iter,
 785                       completion->priv->text_column, &item,
 786                       -1);
 787
 788   if (item != NULL)
 789     {
 790       normalized_string = g_utf8_normalize (item, -1, G_NORMALIZE_ALL);
 791       case_normalized_string = g_utf8_casefold (normalized_string, -1);
 792
 793       if (!strncmp (key, case_normalized_string, strlen (key)))
 794         ret = TRUE;
 795
 796       g_free (item);
 797       g_free (normalized_string);
 798       g_free (case_normalized_string);
 799     }
 800
 801   return ret;
 802 }
 803
 804 static gboolean
 805 gtk_entry_completion_visible_func (GtkTreeModel *model,
 806                                    GtkTreeIter  *iter,
 807                                    gpointer      data)
 808 {
 809   gboolean ret = FALSE;
 810
 811   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (data);
 812
 813   if (!completion->priv->case_normalized_key)
 814     return ret;
 815
 816   if (completion->priv->match_func)
 817     ret = (* completion->priv->match_func) (completion,
 818                                             completion->priv->case_normalized_key,
 819                                             iter,
 820                                             completion->priv->match_data);
 821   else if (completion->priv->text_column >= 0)
 822     ret = gtk_entry_completion_default_completion_func (completion,
 823                                                         completion->priv->case_normalized_key,
 824                                                         iter,
 825                                                         NULL);
 826
 827   return ret;
 828 }
 829
 830 static gboolean
 831 gtk_entry_completion_popup_key_event (GtkWidget   *widget,
 832                                       GdkEventKey *event,
 833                                       gpointer     user_data)
 834 {
 835   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (user_data);
 836
 837   if (!GTK_WIDGET_MAPPED (completion->priv->popup_window))
 838     return FALSE;
 839
 840   /* propagate event to the entry */
 841   gtk_widget_event (completion->priv->entry, (GdkEvent *)event);
 842
 843   return TRUE;
 844 }
 845
 846 static gboolean
 847 gtk_entry_completion_popup_button_press (GtkWidget      *widget,
 848                                          GdkEventButton *event,
 849                                          gpointer        user_data)
 850 {
 851   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (user_data);
 852
 853   if (!GTK_WIDGET_MAPPED (completion->priv->popup_window))
 854     return FALSE;
 855
 856   /* if we come here, it's usually time to popdown */
 857   _gtk_entry_completion_popdown (completion);
 858
 859   return TRUE;
 860 }
 861
 862 static gboolean
 863 gtk_entry_completion_list_button_press (GtkWidget      *widget,
 864                                         GdkEventButton *event,
 865                                         gpointer        user_data)
 866 {
 867   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (user_data);
 868   GtkTreePath *path = NULL;
 869
 870   if (!GTK_WIDGET_MAPPED (completion->priv->popup_window))
 871     return FALSE;
 872
 873   if (gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (widget),
 874                                      event->x, event->y,
 875                                      &path, NULL, NULL, NULL))
 876     {
 877       GtkTreeIter iter;
 878       gboolean entry_set;
 879
 880       gtk_tree_model_get_iter (GTK_TREE_MODEL (completion->priv->filter_model),
 881                                &iter, path);
 882       gtk_tree_path_free (path);
 883
 884       g_signal_handler_block (completion->priv->entry,
 885                               completion->priv->changed_id);
 886       g_signal_emit (completion, entry_completion_signals[MATCH_SELECTED],
 887                      0, GTK_TREE_MODEL (completion->priv->filter_model),
 888                      &iter, &entry_set);
 889       g_signal_handler_unblock (completion->priv->entry,
 890                                 completion->priv->changed_id);
 891
 892       _gtk_entry_completion_popdown (completion);
 893
 894       return TRUE;
 895     }
 896
 897   return FALSE;
 898 }
 899
 900 static gboolean
 901 gtk_entry_completion_action_button_press (GtkWidget      *widget,
 902                                           GdkEventButton *event,
 903                                           gpointer        user_data)
 904 {
 905   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (user_data);
 906   GtkTreePath *path = NULL;
 907
 908   if (!GTK_WIDGET_MAPPED (completion->priv->popup_window))
 909     return FALSE;
 910
 911   _gtk_entry_reset_im_context (GTK_ENTRY (completion->priv->entry));
 912
 913   if (gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (widget),
 914                                      event->x, event->y,
 915                                      &path, NULL, NULL, NULL))
 916     {
 917       g_signal_emit (completion, entry_completion_signals[ACTION_ACTIVATED],
 918                      0, gtk_tree_path_get_indices (path)[0]);
 919       gtk_tree_path_free (path);
 920
 921       _gtk_entry_completion_popdown (completion);
 922       return TRUE;
 923     }
 924
 925   return FALSE;
 926 }
 927
 928 static void
 929 gtk_entry_completion_action_data_func (GtkTreeViewColumn *tree_column,
 930                                        GtkCellRenderer   *cell,
 931                                        GtkTreeModel      *model,
 932                                        GtkTreeIter       *iter,
 933                                        gpointer           data)
 934 {
 935   gchar *string = NULL;
 936   gboolean markup;
 937
 938   gtk_tree_model_get (model, iter,
 939                       0, &string,
 940                       1, &markup,
 941                       -1);
 942
 943   if (!string)
 944     return;
 945
 946   if (markup)
 947     g_object_set (cell,
 948                   "text", NULL,
 949                   "markup", string,
 950                   NULL);
 951   else
 952     g_object_set (cell,
 953                   "markup", NULL,
 954                   "text", string,
 955                   NULL);
 956
 957   g_free (string);
 958 }
 959
 960 static void
 961 gtk_entry_completion_selection_changed (GtkTreeSelection *selection,
 962                                         gpointer          data)
 963 {
 964   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (data);
 965
 966   if (completion->priv->first_sel_changed)
 967     {
 968       completion->priv->first_sel_changed = FALSE;
 969       if (gtk_widget_is_focus (completion->priv->tree_view))
 970         gtk_tree_selection_unselect_all (selection);
 971     }
 972 }
 973
 974 /* public API */
 975
 976 /**
 977  * gtk_entry_completion_new:
 978  *
 979  * Creates a new #GtkEntryCompletion object.
 980  *
 981  * Return value: A newly created #GtkEntryCompletion object.
 982  *
 983  * Since: 2.4
 984  */
 985 GtkEntryCompletion *
 986 gtk_entry_completion_new (void)
 987 {
 988   GtkEntryCompletion *completion;
 989
 990   completion = g_object_new (GTK_TYPE_ENTRY_COMPLETION, NULL);
 991
 992   return completion;
 993 }
 994
 995 /**
 996  * gtk_entry_completion_get_entry:
 997  * @completion: A #GtkEntryCompletion.
 998  *
 999  * Gets the entry @completion has been attached to.
1000  *
1001  * Return value: The entry @completion has been attached to.
1002  *
1003  * Since: 2.4
1004  */
1005 GtkWidget *
1006 gtk_entry_completion_get_entry (GtkEntryCompletion *completion)
1007 {
1008   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), NULL);
1009
1010   return completion->priv->entry;
1011 }
1012
1013 /**
1014  * gtk_entry_completion_set_model:
1015  * @completion: A #GtkEntryCompletion.
1016  * @model: The #GtkTreeModel.
1017  *
1018  * Sets the model for a #GtkEntryCompletion. If @completion already has
1019  * a model set, it will remove it before setting the new model.
1020  * If model is %NULL, then it will unset the model.
1021  *
1022  * Since: 2.4
1023  */
1024 void
1025 gtk_entry_completion_set_model (GtkEntryCompletion *completion,
1026                                 GtkTreeModel       *model)
1027 {
1028   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1029   g_return_if_fail (model == NULL || GTK_IS_TREE_MODEL (model));
1030
1031   if (!model)
1032     {
1033       gtk_tree_view_set_model (GTK_TREE_VIEW (completion->priv->tree_view),
1034                                NULL);
1035       _gtk_entry_completion_popdown (completion);
1036       completion->priv->filter_model = NULL;
1037       return;
1038     }
1039
1040   /* code will unref the old filter model (if any) */
1041   completion->priv->filter_model =
1042     GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new (model, NULL));
1043   gtk_tree_model_filter_set_visible_func (completion->priv->filter_model,
1044                                           gtk_entry_completion_visible_func,
1045                                           completion,
1046                                           NULL);
1047
1048   gtk_tree_view_set_model (GTK_TREE_VIEW (completion->priv->tree_view),
1049                            GTK_TREE_MODEL (completion->priv->filter_model));
1050   g_object_unref (completion->priv->filter_model);
1051
1052   g_object_notify (G_OBJECT (completion), "model");
1053
1054   if (GTK_WIDGET_VISIBLE (completion->priv->popup_window))
1055     _gtk_entry_completion_resize_popup (completion);
1056 }
1057
1058 /**
1059  * gtk_entry_completion_get_model:
1060  * @completion: A #GtkEntryCompletion.
1061  *
1062  * Returns the model the #GtkEntryCompletion is using as data source.
1063  * Returns %NULL if the model is unset.
1064  *
1065  * Return value: A #GtkTreeModel, or %NULL if none is currently being used.
1066  *
1067  * Since: 2.4
1068  */
1069 GtkTreeModel *
1070 gtk_entry_completion_get_model (GtkEntryCompletion *completion)
1071 {
1072   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), NULL);
1073
1074   if (!completion->priv->filter_model)
1075     return NULL;
1076
1077   return gtk_tree_model_filter_get_model (completion->priv->filter_model);
1078 }
1079
1080 /**
1081  * gtk_entry_completion_set_match_func:
1082  * @completion: A #GtkEntryCompletion.
1083  * @func: The #GtkEntryCompletionMatchFunc to use.
1084  * @func_data: The user data for @func.
1085  * @func_notify: Destroy notifier for @func_data.
1086  *
1087  * Sets the match function for @completion to be @func. The match function
1088  * is used to determine if a row should or should not be in the completion
1089  * list.
1090  *
1091  * Since: 2.4
1092  */
1093 void
1094 gtk_entry_completion_set_match_func (GtkEntryCompletion          *completion,
1095                                      GtkEntryCompletionMatchFunc  func,
1096                                      gpointer                     func_data,
1097                                      GDestroyNotify               func_notify)
1098 {
1099   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1100
1101   if (completion->priv->match_notify)
1102     (* completion->priv->match_notify) (completion->priv->match_data);
1103
1104   completion->priv->match_func = func;
1105   completion->priv->match_data = func_data;
1106   completion->priv->match_notify = func_notify;
1107 }
1108
1109 /**
1110  * gtk_entry_completion_set_minimum_key_length:
1111  * @completion: A #GtkEntryCompletion.
1112  * @length: The minimum length of the key in order to start completing.
1113  *
1114  * Requires the length of the search key for @completion to be at least
1115  * @length. This is useful for long lists, where completing using a small
1116  * key takes a lot of time and will come up with meaningless results anyway
1117  * (ie, a too large dataset).
1118  *
1119  * Since: 2.4
1120  */
1121 void
1122 gtk_entry_completion_set_minimum_key_length (GtkEntryCompletion *completion,
1123                                              gint                length)
1124 {
1125   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1126   g_return_if_fail (length >= 0);
1127
1128   if (completion->priv->minimum_key_length != length)
1129     {
1130       completion->priv->minimum_key_length = length;
1131
1132       g_object_notify (G_OBJECT (completion), "minimum-key-length");
1133     }
1134 }
1135
1136 /**
1137  * gtk_entry_completion_get_minimum_key_length:
1138  * @completion: A #GtkEntryCompletion.
1139  *
1140  * Returns the minimum key length as set for @completion.
1141  *
1142  * Return value: The currently used minimum key length.
1143  *
1144  * Since: 2.4
1145  */
1146 gint
1147 gtk_entry_completion_get_minimum_key_length (GtkEntryCompletion *completion)
1148 {
1149   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), 0);
1150
1151   return completion->priv->minimum_key_length;
1152 }
1153
1154 /**
1155  * gtk_entry_completion_complete:
1156  * @completion: A #GtkEntryCompletion.
1157  *
1158  * Requests a completion operation, or in other words a refiltering of the
1159  * current list with completions, using the current key. The completion list
1160  * view will be updated accordingly.
1161  *
1162  * Since: 2.4
1163  */
1164 void
1165 gtk_entry_completion_complete (GtkEntryCompletion *completion)
1166 {
1167   gchar *tmp;
1168
1169   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1170
1171   if (!completion->priv->filter_model)
1172     return;
1173
1174   g_free (completion->priv->case_normalized_key);
1175
1176   tmp = g_utf8_normalize (gtk_entry_get_text (GTK_ENTRY (completion->priv->entry)),
1177                           -1, G_NORMALIZE_ALL);
1178   completion->priv->case_normalized_key = g_utf8_casefold (tmp, -1);
1179   g_free (tmp);
1180
1181   gtk_tree_model_filter_refilter (completion->priv->filter_model);
1182
1183   if (GTK_WIDGET_VISIBLE (completion->priv->popup_window))
1184     _gtk_entry_completion_resize_popup (completion);
1185 }
1186
1187 static void
1188 gtk_entry_completion_insert_action (GtkEntryCompletion *completion,
1189                                     gint                index,
1190                                     const gchar        *string,
1191                                     gboolean            markup)
1192 {
1193   GtkTreeIter iter;
1194
1195   gtk_list_store_insert (completion->priv->actions, &iter, index);
1196   gtk_list_store_set (completion->priv->actions, &iter,
1197                       0, string,
1198                       1, markup,
1199                       -1);
1200
1201   if (!completion->priv->action_view->parent)
1202     {
1203       GtkTreePath *path = gtk_tree_path_new_from_indices (0, -1);
1204
1205       gtk_tree_view_set_cursor (GTK_TREE_VIEW (completion->priv->action_view),
1206                                 path, NULL, FALSE);
1207       gtk_tree_path_free (path);
1208
1209       gtk_box_pack_start (GTK_BOX (completion->priv->vbox),
1210                           completion->priv->action_view, FALSE, FALSE, 0);
1211       gtk_widget_show (completion->priv->action_view);
1212     }
1213 }
1214
1215 /**
1216  * gtk_entry_completion_insert_action_text:
1217  * @completion: A #GtkEntryCompletion.
1218  * @index_: The index of the item to insert.
1219  * @text: Text of the item to insert.
1220  *
1221  * Inserts an action in @completion's action item list at position @index_
1222  * with text @text. If you want the action item to have markup, use
1223  * gtk_entry_completion_insert_action_markup().
1224  *
1225  * Since: 2.4
1226  */
1227 void
1228 gtk_entry_completion_insert_action_text (GtkEntryCompletion *completion,
1229                                          gint                index_,
1230                                          const gchar        *text)
1231 {
1232   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1233   g_return_if_fail (text != NULL);
1234
1235   gtk_entry_completion_insert_action (completion, index_, text, FALSE);
1236 }
1237
1238 /**
1239  * gtk_entry_completion_insert_action_markup:
1240  * @completion: A #GtkEntryCompletion.
1241  * @index_: The index of the item to insert.
1242  * @markup: Markup of the item to insert.
1243  *
1244  * Inserts an action in @completion's action item list at position @index_
1245  * with markup @markup.
1246  *
1247  * Since: 2.4
1248  */
1249 void
1250 gtk_entry_completion_insert_action_markup (GtkEntryCompletion *completion,
1251                                            gint                index_,
1252                                            const gchar        *markup)
1253 {
1254   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1255   g_return_if_fail (markup != NULL);
1256
1257   gtk_entry_completion_insert_action (completion, index_, markup, TRUE);
1258 }
1259
1260 /**
1261  * gtk_entry_completion_delete_action:
1262  * @completion: A #GtkEntryCompletion.
1263  * @index_: The index of the item to Delete.
1264  *
1265  * Deletes the action at @index_ from @completion's action list.
1266  *
1267  * Since: 2.4
1268  */
1269 void
1270 gtk_entry_completion_delete_action (GtkEntryCompletion *completion,
1271                                     gint                index_)
1272 {
1273   GtkTreeIter iter;
1274
1275   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1276   g_return_if_fail (index_ >= 0);
1277
1278   gtk_tree_model_iter_nth_child (GTK_TREE_MODEL (completion->priv->actions),
1279                                  &iter, NULL, index_);
1280   gtk_list_store_remove (completion->priv->actions, &iter);
1281 }
1282
1283 /**
1284  * gtk_entry_completion_set_text_column:
1285  * @completion: A #GtkEntryCompletion.
1286  * @column: The column in the model of @completion to get strings from.
1287  *
1288  * Convenience function for setting up the most used case of this code: a
1289  * completion list with just strings. This function will set up @completion
1290  * to have a list displaying all (and just) strings in the completion list,
1291  * and to get those strings from @column in the model of @completion.
1292  *
1293  * This functions creates and adds a #GtkCellRendererText for the selected
1294  * column. If you need to set the text column, but don't want the cell
1295  * renderer, use g_object_set() to set the ::text_column property directly.
1296  *
1297  * Since: 2.4
1298  */
1299 void
1300 gtk_entry_completion_set_text_column (GtkEntryCompletion *completion,
1301                                       gint                column)
1302 {
1303   GtkCellRenderer *cell;
1304
1305   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1306   g_return_if_fail (column >= 0);
1307
1308   completion->priv->text_column = column;
1309
1310   cell = gtk_cell_renderer_text_new ();
1311   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (completion),
1312                               cell, TRUE);
1313   gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (completion),
1314                                  cell,
1315                                  "text", column);
1316
1317   g_object_notify (G_OBJECT (completion), "text-column");
1318 }
1319
1320 /**
1321  * gtk_entry_completion_get_text_column:
1322  * @completion: a #GtkEntryCompletion
1323  *
1324  * Returns the column in the model of @completion to get strings from.
1325  *
1326  * Return value: the column containing the strings
1327  *
1328  * Since: 2.6
1329  **/
1330 gint
1331 gtk_entry_completion_get_text_column (GtkEntryCompletion *completion)
1332 {
1333   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), -1);
1334
1335   return completion->priv->text_column;
1336 }
1337
1338 /* private */
1339
1340 static gboolean
1341 gtk_entry_completion_list_enter_notify (GtkWidget        *widget,
1342                                         GdkEventCrossing *event,
1343                                         gpointer          data)
1344 {
1345   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (data);
1346
1347   return completion->priv->ignore_enter;
1348 }
1349
1350 static gboolean
1351 gtk_entry_completion_list_motion_notify (GtkWidget      *widget,
1352                                          GdkEventMotion *event,
1353                                          gpointer        data)
1354 {
1355   GtkEntryCompletion *completion = GTK_ENTRY_COMPLETION (data);
1356
1357   completion->priv->ignore_enter = FALSE;
1358
1359   return FALSE;
1360 }
1361
1362
1363 /* some nasty size requisition */
1364 gboolean
1365 _gtk_entry_completion_resize_popup (GtkEntryCompletion *completion)
1366 {
1367   gint x, y;
1368   gint matches, actions, items, height, x_border, y_border;
1369   GdkScreen *screen;
1370   gint monitor_num;
1371   gint vertical_separator;
1372   GdkRectangle monitor;
1373   GtkRequisition popup_req;
1374   GtkRequisition entry_req;
1375   GtkTreePath *path;
1376   gboolean above;
1377   gint width;
1378   GtkTreeViewColumn *action_column;
1379   gint action_height;
1380
1381   if (!completion->priv->entry->window)
1382     return FALSE;
1383
1384   gdk_window_get_origin (completion->priv->entry->window, &x, &y);
1385   _gtk_entry_get_borders (GTK_ENTRY (completion->priv->entry), &x_border, &y_border);
1386
1387   matches = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (completion->priv->filter_model), NULL);
1388   actions = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (completion->priv->actions), NULL);
1389   action_column  = gtk_tree_view_get_column (GTK_TREE_VIEW (completion->priv->action_view), 0);
1390
1391   gtk_tree_view_column_cell_get_size (completion->priv->column, NULL,
1392                                       NULL, NULL, NULL, &height);
1393   gtk_tree_view_column_cell_get_size (action_column, NULL,
1394                                       NULL, NULL, NULL, &action_height);
1395
1396   gtk_widget_style_get (GTK_WIDGET (completion->priv->tree_view),
1397                         "vertical-separator", &vertical_separator,
1398                         NULL);
1399
1400   height += vertical_separator;
1401
1402   gtk_widget_realize (completion->priv->tree_view);
1403
1404   screen = gtk_widget_get_screen (GTK_WIDGET (completion->priv->entry));
1405   monitor_num = gdk_screen_get_monitor_at_window (screen,
1406                                                   GTK_WIDGET (completion->priv->entry)->window);
1407   gdk_screen_get_monitor_geometry (screen, monitor_num, &monitor);
1408
1409
1410
1411   if (y > monitor.height / 2)
1412     items = MIN (matches, (((monitor.y + y) - (actions * action_height)) / height) - 1);
1413   else
1414     items = MIN (matches, (((monitor.height - y) - (actions * action_height)) / height) - 1);
1415
1416   if (items <= 0)
1417     gtk_widget_hide (completion->priv->scrolled_window);
1418   else
1419     gtk_widget_show (completion->priv->scrolled_window);
1420
1421   if (completion->priv->popup_set_width)
1422     width = MIN (completion->priv->entry->allocation.width, monitor.width) - 2 * x_border;
1423   else
1424     width = -1;
1425
1426   gtk_tree_view_columns_autosize (GTK_TREE_VIEW (completion->priv->tree_view));
1427   gtk_widget_set_size_request (completion->priv->tree_view, width, items * height);
1428
1429   if (actions)
1430     {
1431       gtk_widget_show (completion->priv->action_view);
1432       gtk_widget_set_size_request (completion->priv->action_view, width, -1);
1433     }
1434   else
1435     gtk_widget_hide (completion->priv->action_view);
1436
1437   gtk_widget_size_request (completion->priv->popup_window, &popup_req);
1438   gtk_widget_size_request (completion->priv->entry, &entry_req);
1439
1440   if (x < monitor.x)
1441     x = monitor.x;
1442   else if (x + popup_req.width > monitor.x + monitor.width)
1443     x = monitor.x + monitor.width - popup_req.width;
1444
1445   if (y + entry_req.height + popup_req.height <= monitor.y + monitor.height ||
1446       y - monitor.y < (monitor.y + monitor.height) - (y + entry_req.height))
1447     {
1448       y += entry_req.height;
1449       above = FALSE;
1450     }
1451   else
1452     {
1453       y -= popup_req.height;
1454       above = TRUE;
1455     }
1456
1457   if (matches > 0)
1458     {
1459       path = gtk_tree_path_new_from_indices (above ? matches - 1 : 0, -1);
1460       gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW (completion->priv->tree_view), path,
1461                                     NULL, FALSE, 0.0, 0.0);
1462       gtk_tree_path_free (path);
1463     }
1464
1465   gtk_window_move (GTK_WINDOW (completion->priv->popup_window), x, y);
1466
1467   return above;
1468 }
1469
1470 void
1471 _gtk_entry_completion_popup (GtkEntryCompletion *completion)
1472 {
1473   GtkTreeViewColumn *column;
1474   GList *renderers;
1475   GtkWidget *toplevel;
1476
1477   if (GTK_WIDGET_MAPPED (completion->priv->popup_window))
1478     return;
1479
1480   if (!GTK_WIDGET_MAPPED (completion->priv->entry))
1481     return;
1482
1483   if (!GTK_WIDGET_HAS_FOCUS (completion->priv->entry))
1484     return;
1485
1486   completion->priv->ignore_enter = TRUE;
1487
1488   column = gtk_tree_view_get_column (GTK_TREE_VIEW (completion->priv->action_view), 0);
1489   renderers = gtk_cell_layout_get_cells (GTK_CELL_LAYOUT (column));
1490   gtk_widget_ensure_style (completion->priv->tree_view);
1491   g_object_set (GTK_CELL_RENDERER (renderers->data), "cell-background-gdk",
1492                 &completion->priv->tree_view->style->bg[GTK_STATE_NORMAL],
1493                 NULL);
1494   g_list_free (renderers);
1495
1496   gtk_widget_show_all (completion->priv->vbox);
1497
1498   /* default on no match */
1499   completion->priv->current_selected = -1;
1500
1501   _gtk_entry_completion_resize_popup (completion);
1502
1503   toplevel = gtk_widget_get_toplevel (completion->priv->entry);
1504   if (GTK_IS_WINDOW (toplevel))
1505     gtk_window_group_add_window (gtk_window_get_group (GTK_WINDOW (toplevel)),
1506                                  GTK_WINDOW (completion->priv->popup_window));
1507
1508   /* prevent the first row being focused */
1509   gtk_widget_grab_focus (completion->priv->tree_view);
1510
1511   gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (completion->priv->tree_view)));
1512   gtk_tree_selection_unselect_all (gtk_tree_view_get_selection (GTK_TREE_VIEW (completion->priv->action_view)));
1513
1514   gtk_window_set_screen (GTK_WINDOW (completion->priv->popup_window),
1515                          gtk_widget_get_screen (completion->priv->entry));
1516
1517   gtk_widget_show (completion->priv->popup_window);
1518
1519   gtk_grab_add (completion->priv->popup_window);
1520   gdk_pointer_grab (completion->priv->popup_window->window, TRUE,
1521                     GDK_BUTTON_PRESS_MASK |
1522                     GDK_BUTTON_RELEASE_MASK |
1523                     GDK_POINTER_MOTION_MASK,
1524                     NULL, NULL, GDK_CURRENT_TIME);
1525 }
1526
1527 void
1528 _gtk_entry_completion_popdown (GtkEntryCompletion *completion)
1529 {
1530   if (!GTK_WIDGET_MAPPED (completion->priv->popup_window))
1531     return;
1532
1533   completion->priv->ignore_enter = FALSE;
1534
1535   gdk_pointer_ungrab (GDK_CURRENT_TIME);
1536   gtk_grab_remove (completion->priv->popup_window);
1537
1538   gtk_widget_hide (completion->priv->popup_window);
1539 }
1540
1541 static gboolean
1542 gtk_entry_completion_match_selected (GtkEntryCompletion *completion,
1543                                      GtkTreeModel       *model,
1544                                      GtkTreeIter        *iter)
1545 {
1546   gchar *str = NULL;
1547
1548   gtk_tree_model_get (model, iter, completion->priv->text_column, &str, -1);
1549   gtk_entry_set_text (GTK_ENTRY (completion->priv->entry), str ? str : "");
1550
1551   /* move cursor to the end */
1552   gtk_editable_set_position (GTK_EDITABLE (completion->priv->entry), -1);
1553
1554   g_free (str);
1555
1556   return TRUE;
1557 }
1558
1559 static gboolean
1560 gtk_entry_completion_cursor_on_match (GtkEntryCompletion *completion,
1561                                       GtkTreeModel       *model,
1562                                       GtkTreeIter        *iter)
1563 {
1564   gtk_entry_completion_insert_completion (completion, model, iter);
1565
1566   return TRUE;
1567 }
1568
1569 static gchar *
1570 gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion)
1571 {
1572   GtkTreeIter iter;
1573   gchar *prefix = NULL;
1574   gboolean valid;
1575   const gchar *key;
1576
1577   if (completion->priv->text_column < 0)
1578     return NULL;
1579
1580   key = gtk_entry_get_text (GTK_ENTRY (completion->priv->entry));
1581
1582   valid = gtk_tree_model_get_iter_first (GTK_TREE_MODEL (completion->priv->filter_model),
1583                                          &iter);
1584
1585   while (valid)
1586     {
1587       gchar *text;
1588
1589       gtk_tree_model_get (GTK_TREE_MODEL (completion->priv->filter_model),
1590                           &iter, completion->priv->text_column, &text,
1591                           -1);
1592
1593       if (text && g_str_has_prefix (text, key))
1594         {
1595           if (!prefix)
1596             prefix = g_strdup (text);
1597           else
1598             {
1599               gchar *p = prefix;
1600               gchar *q = text;
1601
1602               while (*p && *p == *q)
1603                 {
1604                   p++;
1605                   q++;
1606                 }
1607
1608               *p = '\0';
1609
1610               if (p > prefix)
1611                 {
1612                   /* strip a partial multibyte character */
1613                   q = g_utf8_find_prev_char (prefix, p);
1614                   switch (g_utf8_get_char_validated (q, p - q))
1615                     {
1616                     case (gunichar)-2:
1617                     case (gunichar)-1:
1618                       *q = 0;
1619                     default: ;
1620                     }
1621                 }
1622             }
1623         }
1624
1625       g_free (text);
1626       valid = gtk_tree_model_iter_next (GTK_TREE_MODEL (completion->priv->filter_model),
1627                                         &iter);
1628     }
1629
1630   return prefix;
1631 }
1632
1633
1634 static gboolean
1635 gtk_entry_completion_real_insert_prefix (GtkEntryCompletion *completion,
1636                                          const gchar        *prefix)
1637 {
1638   if (prefix)
1639     {
1640       gint key_len;
1641       gint prefix_len;
1642       const gchar *key;
1643
1644       prefix_len = g_utf8_strlen (prefix, -1);
1645
1646       key = gtk_entry_get_text (GTK_ENTRY (completion->priv->entry));
1647       key_len = g_utf8_strlen (key, -1);
1648
1649       if (prefix_len > key_len)
1650         {
1651           gint pos = prefix_len;
1652
1653           gtk_editable_insert_text (GTK_EDITABLE (completion->priv->entry),
1654                                     prefix + strlen (key), -1, &pos);
1655           gtk_editable_select_region (GTK_EDITABLE (completion->priv->entry),
1656                                       key_len, prefix_len);
1657
1658           completion->priv->has_completion = TRUE;
1659         }
1660     }
1661
1662   return TRUE;
1663 }
1664
1665 /**
1666  * gtk_entry_completion_get_completion_prefix:
1667  * @completion: a #GtkEntryCompletion
1668  *
1669  * Get the original text entered by the user that triggered
1670  * the completion or %NULL if there's no completion ongoing.
1671  *
1672  * Returns: the prefix for the current completion
1673  *
1674  * Since: 2.12
1675  **/
1676 const gchar*
1677 gtk_entry_completion_get_completion_prefix (GtkEntryCompletion *completion)
1678 {
1679   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), NULL);
1680
1681   return completion->priv->completion_prefix;
1682 }
1683
1684 static void
1685 gtk_entry_completion_insert_completion_text (GtkEntryCompletion *completion,
1686                                              const gchar *text)
1687 {
1688   GtkEntryCompletionPrivate *priv = completion->priv;
1689   gint len;
1690
1691   priv = completion->priv;
1692
1693   if (priv->changed_id > 0)
1694     g_signal_handler_block (priv->entry, priv->changed_id);
1695
1696   if (priv->insert_text_id > 0)
1697     g_signal_handler_block (priv->entry, priv->insert_text_id);
1698
1699   gtk_entry_set_text (GTK_ENTRY (priv->entry), text);
1700
1701   len = strlen (priv->completion_prefix);
1702   gtk_editable_select_region (GTK_EDITABLE (priv->entry), len, -1);
1703
1704   if (priv->changed_id > 0)
1705     g_signal_handler_unblock (priv->entry, priv->changed_id);
1706
1707   if (priv->insert_text_id > 0)
1708     g_signal_handler_unblock (priv->entry, priv->insert_text_id);
1709 }
1710
1711 static gboolean
1712 gtk_entry_completion_insert_completion (GtkEntryCompletion *completion,
1713                                         GtkTreeModel       *model,
1714                                         GtkTreeIter        *iter)
1715 {
1716   gchar *str = NULL;
1717
1718   if (completion->priv->text_column < 0)
1719     return FALSE;
1720
1721   gtk_tree_model_get (model, iter,
1722                       completion->priv->text_column, &str,
1723                       -1);
1724
1725   gtk_entry_completion_insert_completion_text (completion, str);
1726
1727   g_free (str);
1728
1729   return TRUE;
1730 }
1731
1732 /**
1733  * gtk_entry_completion_insert_prefix:
1734  * @completion: a #GtkEntryCompletion
1735  *
1736  * Requests a prefix insertion.
1737  *
1738  * Since: 2.6
1739  **/
1740
1741 void
1742 gtk_entry_completion_insert_prefix (GtkEntryCompletion *completion)
1743 {
1744   gboolean done;
1745   gchar *prefix;
1746
1747   if (completion->priv->insert_text_id > 0)
1748     g_signal_handler_block (completion->priv->entry,
1749                             completion->priv->insert_text_id);
1750
1751   prefix = gtk_entry_completion_compute_prefix (completion);
1752   if (prefix)
1753     {
1754       g_signal_emit (completion, entry_completion_signals[INSERT_PREFIX],
1755                      0, prefix, &done);
1756       g_free (prefix);
1757     }
1758
1759   if (completion->priv->insert_text_id > 0)
1760     g_signal_handler_unblock (completion->priv->entry,
1761                               completion->priv->insert_text_id);
1762 }
1763
1764 /**
1765  * gtk_entry_completion_set_inline_completion:
1766  * @completion: a #GtkEntryCompletion
1767  * @inline_completion: %TRUE to do inline completion
1768  *
1769  * Sets whether the common prefix of the possible completions should
1770  * be automatically inserted in the entry.
1771  *
1772  * Since: 2.6
1773  **/
1774 void
1775 gtk_entry_completion_set_inline_completion (GtkEntryCompletion *completion,
1776                                             gboolean            inline_completion)
1777 {
1778   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1779
1780   inline_completion = inline_completion != FALSE;
1781
1782   if (completion->priv->inline_completion != inline_completion)
1783     {
1784       completion->priv->inline_completion = inline_completion;
1785
1786       g_object_notify (G_OBJECT (completion), "inline-completion");
1787     }
1788 }
1789
1790 /**
1791  * gtk_entry_completion_get_inline_completion:
1792  * @completion: a #GtkEntryCompletion
1793  *
1794  * Returns whether the common prefix of the possible completions should
1795  * be automatically inserted in the entry.
1796  *
1797  * Return value: %TRUE if inline completion is turned on
1798  *
1799  * Since: 2.6
1800  **/
1801 gboolean
1802 gtk_entry_completion_get_inline_completion (GtkEntryCompletion *completion)
1803 {
1804   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), FALSE);
1805
1806   return completion->priv->inline_completion;
1807 }
1808
1809 /**
1810  * gtk_entry_completion_set_popup_completion:
1811  * @completion: a #GtkEntryCompletion
1812  * @popup_completion: %TRUE to do popup completion
1813  *
1814  * Sets whether the completions should be presented in a popup window.
1815  *
1816  * Since: 2.6
1817  **/
1818 void
1819 gtk_entry_completion_set_popup_completion (GtkEntryCompletion *completion,
1820                                            gboolean            popup_completion)
1821 {
1822   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1823
1824   popup_completion = popup_completion != FALSE;
1825
1826   if (completion->priv->popup_completion != popup_completion)
1827     {
1828       completion->priv->popup_completion = popup_completion;
1829
1830       g_object_notify (G_OBJECT (completion), "popup-completion");
1831     }
1832 }
1833
1834
1835 /**
1836  * gtk_entry_completion_get_popup_completion:
1837  * @completion: a #GtkEntryCompletion
1838  *
1839  * Returns whether the completions should be presented in a popup window.
1840  *
1841  * Return value: %TRUE if popup completion is turned on
1842  *
1843  * Since: 2.6
1844  **/
1845 gboolean
1846 gtk_entry_completion_get_popup_completion (GtkEntryCompletion *completion)
1847 {
1848   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), TRUE);
1849
1850   return completion->priv->popup_completion;
1851 }
1852
1853 /**
1854  * gtk_entry_completion_set_popup_set_width:
1855  * @completion: a #GtkEntryCompletion
1856  * @popup_set_width: %TRUE to make the width of the popup the same as the entry
1857  *
1858  * Sets whether the completion popup window will be resized to be the same
1859  * width as the entry.
1860  *
1861  * Since: 2.8
1862  */
1863 void
1864 gtk_entry_completion_set_popup_set_width (GtkEntryCompletion *completion,
1865                                           gboolean            popup_set_width)
1866 {
1867   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1868
1869   popup_set_width = popup_set_width != FALSE;
1870
1871   if (completion->priv->popup_set_width != popup_set_width)
1872     {
1873       completion->priv->popup_set_width = popup_set_width;
1874
1875       g_object_notify (G_OBJECT (completion), "popup-set-width");
1876     }
1877 }
1878
1879 /**
1880  * gtk_entry_completion_get_popup_set_width:
1881  * @completion: a #GtkEntryCompletion
1882  *
1883  * Returns whether the  completion popup window will be resized to the
1884  * width of the entry.
1885  *
1886  * Return value: %TRUE if the popup window will be resized to the width of
1887  *   the entry
1888  *
1889  * Since: 2.8
1890  **/
1891 gboolean
1892 gtk_entry_completion_get_popup_set_width (GtkEntryCompletion *completion)
1893 {
1894   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), TRUE);
1895
1896   return completion->priv->popup_set_width;
1897 }
1898
1899
1900 /**
1901  * gtk_entry_completion_set_popup_single_match:
1902  * @completion: a #GtkEntryCompletion
1903  * @popup_single_match: %TRUE if the popup should appear even for a single
1904  *   match
1905  *
1906  * Sets whether the completion popup window will appear even if there is
1907  * only a single match. You may want to set this to %FALSE if you
1908  * are using <link linkend="GtkEntryCompletion--inline-completion">inline
1909  * completion</link>.
1910  *
1911  * Since: 2.8
1912  */
1913 void
1914 gtk_entry_completion_set_popup_single_match (GtkEntryCompletion *completion,
1915                                              gboolean            popup_single_match)
1916 {
1917   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1918
1919   popup_single_match = popup_single_match != FALSE;
1920
1921   if (completion->priv->popup_single_match != popup_single_match)
1922     {
1923       completion->priv->popup_single_match = popup_single_match;
1924
1925       g_object_notify (G_OBJECT (completion), "popup-single-match");
1926     }
1927 }
1928
1929 /**
1930  * gtk_entry_completion_get_popup_single_match:
1931  * @completion: a #GtkEntryCompletion
1932  *
1933  * Returns whether the completion popup window will appear even if there is
1934  * only a single match.
1935  *
1936  * Return value: %TRUE if the popup window will appear regardless of the
1937  *    number of matches.
1938  *
1939  * Since: 2.8
1940  **/
1941 gboolean
1942 gtk_entry_completion_get_popup_single_match (GtkEntryCompletion *completion)
1943 {
1944   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), TRUE);
1945
1946   return completion->priv->popup_single_match;
1947 }
1948
1949 /**
1950  * gtk_entry_completion_set_inline_selection:
1951  * @completion: a #GtkEntryCompletion
1952  * @inline_selection: %TRUE to do inline selection
1953  *
1954  * Sets whether it is possible to cycle through the possible completions
1955  * inside the entry.
1956  *
1957  * Since: 2.12
1958  **/
1959 void
1960 gtk_entry_completion_set_inline_selection (GtkEntryCompletion *completion,
1961                                            gboolean inline_selection)
1962 {
1963   g_return_if_fail (GTK_IS_ENTRY_COMPLETION (completion));
1964
1965   inline_selection = inline_selection != FALSE;
1966
1967   if (completion->priv->inline_selection != inline_selection)
1968     {
1969       completion->priv->inline_selection = inline_selection;
1970
1971       g_object_notify (G_OBJECT (completion), "inline-selection");
1972     }
1973 }
1974
1975 /**
1976  * gtk_entry_completion_get_inline_selection:
1977  * @completion: a #GtkEntryCompletion
1978  *
1979  * Returns %TRUE if inline-selection mode is turned on.
1980  *
1981  * Returns: %TRUE if inline-selection mode is on
1982  *
1983  * Since: 2.12
1984  **/
1985 gboolean
1986 gtk_entry_completion_get_inline_selection (GtkEntryCompletion *completion)
1987 {
1988   g_return_val_if_fail (GTK_IS_ENTRY_COMPLETION (completion), FALSE);
1989
1990   return completion->priv->inline_selection;
1991 }
1992
1993 #define __GTK_ENTRY_COMPLETION_C__
1994 #include "gtkaliasdef.c"