gtksearchbar.c 18.1 KB
Newer Older
Bastien Nocera's avatar
Bastien Nocera committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/* GTK - The GIMP Toolkit
 * Copyright (C) 2013 Red Hat, Inc.
 *
 * Authors:
 * - Bastien Nocera <bnocera@redhat.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Modified by the GTK+ Team and others 2013.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
 */

#include "config.h"

#include "gtkentry.h"
#include "gtkentryprivate.h"
#include "gtkintl.h"
33
#include "gtkprivate.h"
34
#include "gtkrender.h"
Bastien Nocera's avatar
Bastien Nocera committed
35
#include "gtksearchbar.h"
36
#include "gtksearchentryprivate.h"
Bastien Nocera's avatar
Bastien Nocera committed
37 38 39

/**
 * SECTION:gtksearchbar
40
 * @Short_description: A toolbar to integrate a search entry with
Bastien Nocera's avatar
Bastien Nocera committed
41 42 43
 * @Title: GtkSearchBar
 *
 * #GtkSearchBar is a container made to have a search entry (possibly
44 45
 * with additional connex widgets, such as drop-down menus, or buttons)
 * built-in. The search bar would appear when a search is started through
46
 * typing on the keyboard, or the application’s search mode is toggled on.
Bastien Nocera's avatar
Bastien Nocera committed
47
 *
48 49 50 51 52
 * For keyboard presses to start a search, events will need to be
 * forwarded from the top-level window that contains the search bar.
 * See gtk_search_bar_handle_event() for example code. Common shortcuts
 * such as Ctrl+F should be handled as an application action, or through
 * the menu items.
Bastien Nocera's avatar
Bastien Nocera committed
53
 *
54 55 56 57
 * You will also need to tell the search bar about which entry you
 * are using as your search entry using gtk_search_bar_connect_entry().
 * The following example shows you how to create a more complex search
 * entry.
Bastien Nocera's avatar
Bastien Nocera committed
58
 *
59 60 61 62
 * # CSS nodes
 *
 * GtkSearchBar has a single CSS node with name searchbar.
 *
63 64
 * ## Creating a search bar
 *
65
 * [A simple example](https://git.gnome.org/browse/gtk+/tree/examples/search-bar.c)
Bastien Nocera's avatar
Bastien Nocera committed
66 67 68 69
 *
 * Since: 3.10
 */

70
typedef struct {
Bastien Nocera's avatar
Bastien Nocera committed
71 72
  /* Template widgets */
  GtkWidget   *revealer;
73
  GtkWidget   *tool_box;
Bastien Nocera's avatar
Bastien Nocera committed
74 75 76 77 78
  GtkWidget   *box_center;
  GtkWidget   *close_button;

  GtkWidget   *entry;
  gboolean     reveal_child;
79 80 81
} GtkSearchBarPrivate;

G_DEFINE_TYPE_WITH_PRIVATE (GtkSearchBar, gtk_search_bar, GTK_TYPE_BIN)
Bastien Nocera's avatar
Bastien Nocera committed
82 83 84 85 86 87 88 89 90 91

enum {
  PROP_0,
  PROP_SEARCH_MODE_ENABLED,
  PROP_SHOW_CLOSE_BUTTON,
  LAST_PROPERTY
};

static GParamSpec *widget_props[LAST_PROPERTY] = { NULL, };

92 93 94
static void
stop_search_cb (GtkWidget    *entry,
                GtkSearchBar *bar)
Bastien Nocera's avatar
Bastien Nocera committed
95
{
96 97
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
  gtk_revealer_set_reveal_child (GTK_REVEALER (priv->revealer), FALSE);
Bastien Nocera's avatar
Bastien Nocera committed
98 99 100 101 102 103 104
}

static gboolean
entry_key_pressed_event_cb (GtkWidget    *widget,
                            GdkEvent     *event,
                            GtkSearchBar *bar)
{
105 106 107 108 109 110
  if (event->key.keyval == GDK_KEY_Escape)
    {
      stop_search_cb (widget, bar);
      return GDK_EVENT_STOP;
    }
  else
Bastien Nocera's avatar
Bastien Nocera committed
111 112 113 114 115 116 117 118 119 120 121
    return GDK_EVENT_PROPAGATE;
}

static void
preedit_changed_cb (GtkEntry  *entry,
                    GtkWidget *popup,
                    gboolean  *preedit_changed)
{
  *preedit_changed = TRUE;
}

122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
static gboolean
gtk_search_bar_handle_event_for_entry (GtkSearchBar *bar,
                                       GdkEvent     *event)
{
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
  gboolean handled;
  gboolean preedit_changed;
  guint preedit_change_id;
  gboolean res;
  char *old_text, *new_text;

  if (gtk_search_entry_is_keynav_event (event) ||
      event->key.keyval == GDK_KEY_space ||
      event->key.keyval == GDK_KEY_Menu)
    return GDK_EVENT_PROPAGATE;

  if (!gtk_widget_get_realized (priv->entry))
    gtk_widget_realize (priv->entry);

  handled = GDK_EVENT_PROPAGATE;
  preedit_changed = FALSE;
  preedit_change_id = g_signal_connect (priv->entry, "preedit-changed",
                                        G_CALLBACK (preedit_changed_cb), &preedit_changed);

  old_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (priv->entry)));
  res = gtk_widget_event (priv->entry, event);
  new_text = g_strdup (gtk_entry_get_text (GTK_ENTRY (priv->entry)));

  g_signal_handler_disconnect (priv->entry, preedit_change_id);

  if ((res && g_strcmp0 (new_text, old_text) != 0) || preedit_changed)
    handled = GDK_EVENT_STOP;

  g_free (old_text);
  g_free (new_text);

  return handled;
}

Bastien Nocera's avatar
Bastien Nocera committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174
/**
 * gtk_search_bar_handle_event:
 * @bar: a #GtkSearchBar
 * @event: a #GdkEvent containing key press events
 *
 * This function should be called when the top-level
 * window which contains the search bar received a key event.
 *
 * If the key event is handled by the search bar, the bar will
 * be shown, the entry populated with the entered text and %GDK_EVENT_STOP
 * will be returned. The caller should ensure that events are
 * not propagated further.
 *
 * If no entry has been connected to the search bar, using
175 176
 * gtk_search_bar_connect_entry(), this function will return
 * immediately with a warning.
Bastien Nocera's avatar
Bastien Nocera committed
177
 *
178 179
 * ## Showing the search bar on key presses
 *
180
 * |[<!-- language="C" -->
Bastien Nocera's avatar
Bastien Nocera committed
181
 * static gboolean
182 183 184
 * on_key_press_event (GtkWidget *widget,
 *                     GdkEvent  *event,
 *                     gpointer   user_data)
Bastien Nocera's avatar
Bastien Nocera committed
185
 * {
186 187
 *   GtkSearchBar *bar = GTK_SEARCH_BAR (user_data);
 *   return gtk_search_bar_handle_event (bar, event);
Bastien Nocera's avatar
Bastien Nocera committed
188 189
 * }
 *
190 191 192 193
 * g_signal_connect (window,
 *                  "key-press-event",
 *                   G_CALLBACK (on_key_press_event),
 *                   search_bar);
194
 * ]|
Bastien Nocera's avatar
Bastien Nocera committed
195
 *
196
 * Returns: %GDK_EVENT_STOP if the key press event resulted
197 198
 *     in text being entered in the search entry (and revealing
 *     the search bar if necessary), %GDK_EVENT_PROPAGATE otherwise.
Bastien Nocera's avatar
Bastien Nocera committed
199 200
 *
 * Since: 3.10
201
 */
Bastien Nocera's avatar
Bastien Nocera committed
202 203 204 205
gboolean
gtk_search_bar_handle_event (GtkSearchBar *bar,
                             GdkEvent     *event)
{
206
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
Bastien Nocera's avatar
Bastien Nocera committed
207
  gboolean handled;
208 209 210

  if (priv->reveal_child)
    return GDK_EVENT_PROPAGATE;
Bastien Nocera's avatar
Bastien Nocera committed
211

212
  if (priv->entry == NULL)
Bastien Nocera's avatar
Bastien Nocera committed
213 214 215 216 217
    {
      g_warning ("The search bar does not have an entry connected to it. Call gtk_search_bar_connect_entry() to connect one.");
      return GDK_EVENT_PROPAGATE;
    }

218 219 220 221
  if (GTK_IS_SEARCH_ENTRY (priv->entry))
    handled = gtk_search_entry_handle_event (GTK_SEARCH_ENTRY (priv->entry), event);
  else
    handled = gtk_search_bar_handle_event_for_entry (bar, event);
Bastien Nocera's avatar
Bastien Nocera committed
222

223 224
  if (handled == GDK_EVENT_STOP)
    gtk_revealer_set_reveal_child (GTK_REVEALER (priv->revealer), TRUE);
Bastien Nocera's avatar
Bastien Nocera committed
225 226 227 228 229 230 231 232 233

  return handled;
}

static void
reveal_child_changed_cb (GObject      *object,
                         GParamSpec   *pspec,
                         GtkSearchBar *bar)
{
234
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
Bastien Nocera's avatar
Bastien Nocera committed
235 236 237
  gboolean reveal_child;

  g_object_get (object, "reveal-child", &reveal_child, NULL);
238 239 240
  if (reveal_child)
    gtk_widget_set_child_visible (priv->revealer, TRUE);

241
  if (reveal_child == priv->reveal_child)
Bastien Nocera's avatar
Bastien Nocera committed
242 243
    return;

244
  priv->reveal_child = reveal_child;
Bastien Nocera's avatar
Bastien Nocera committed
245

246 247 248 249 250 251 252
  if (priv->entry)
    {
      if (reveal_child)
        _gtk_entry_grab_focus (GTK_ENTRY (priv->entry), FALSE);
      else
        gtk_entry_set_text (GTK_ENTRY (priv->entry), "");
    }
Bastien Nocera's avatar
Bastien Nocera committed
253 254 255 256

  g_object_notify (G_OBJECT (bar), "search-mode-enabled");
}

257 258 259 260 261 262 263 264 265 266 267 268 269
static void
child_revealed_changed_cb (GObject      *object,
                           GParamSpec   *pspec,
                           GtkSearchBar *bar)
{
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
  gboolean val;

  g_object_get (object, "child-revealed", &val, NULL);
  if (!val)
    gtk_widget_set_child_visible (priv->revealer, FALSE);
}

Bastien Nocera's avatar
Bastien Nocera committed
270 271 272 273
static void
close_button_clicked_cb (GtkWidget    *button,
                         GtkSearchBar *bar)
{
274 275 276
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

  gtk_revealer_set_reveal_child (GTK_REVEALER (priv->revealer), FALSE);
Bastien Nocera's avatar
Bastien Nocera committed
277 278 279 280 281 282 283
}

static void
gtk_search_bar_add (GtkContainer *container,
                    GtkWidget    *child)
{
  GtkSearchBar *bar = GTK_SEARCH_BAR (container);
284
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
Bastien Nocera's avatar
Bastien Nocera committed
285 286 287 288

  /* When constructing the widget, we want the revealer to be added
   * as the first child of the search bar, as an implementation detail.
   * After that, the child added by the application should be added
289
   * to box_center.
Bastien Nocera's avatar
Bastien Nocera committed
290
   */
291
  if (priv->box_center == NULL)
Bastien Nocera's avatar
Bastien Nocera committed
292 293
    {
      GTK_CONTAINER_CLASS (gtk_search_bar_parent_class)->add (container, child);
294 295 296
    }
  else
    {
297
      gtk_container_add (GTK_CONTAINER (priv->box_center), child);
Bastien Nocera's avatar
Bastien Nocera committed
298
      /* If an entry is the only child, save the developer a couple of
299 300
       * lines of code
       */
Bastien Nocera's avatar
Bastien Nocera committed
301 302 303 304 305 306
      if (GTK_IS_ENTRY (child))
        gtk_search_bar_connect_entry (bar, GTK_ENTRY (child));
    }
}

static void
307 308 309 310
gtk_search_bar_set_property (GObject      *object,
                             guint         prop_id,
                             const GValue *value,
                             GParamSpec   *pspec)
Bastien Nocera's avatar
Bastien Nocera committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
{
  GtkSearchBar *bar = GTK_SEARCH_BAR (object);

  switch (prop_id)
    {
    case PROP_SEARCH_MODE_ENABLED:
      gtk_search_bar_set_search_mode (bar, g_value_get_boolean (value));
      break;
    case PROP_SHOW_CLOSE_BUTTON:
      gtk_search_bar_set_show_close_button (bar, g_value_get_boolean (value));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void
329 330 331 332
gtk_search_bar_get_property (GObject    *object,
                             guint       prop_id,
                             GValue     *value,
                             GParamSpec *pspec)
Bastien Nocera's avatar
Bastien Nocera committed
333 334
{
  GtkSearchBar *bar = GTK_SEARCH_BAR (object);
335
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
Bastien Nocera's avatar
Bastien Nocera committed
336 337 338 339

  switch (prop_id)
    {
    case PROP_SEARCH_MODE_ENABLED:
340
      g_value_set_boolean (value, priv->reveal_child);
Bastien Nocera's avatar
Bastien Nocera committed
341 342 343 344 345 346 347 348 349 350
      break;
    case PROP_SHOW_CLOSE_BUTTON:
      g_value_set_boolean (value, gtk_search_bar_get_show_close_button (bar));
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

Matthias Clasen's avatar
Matthias Clasen committed
351 352 353
static void gtk_search_bar_set_entry (GtkSearchBar *bar,
                                      GtkEntry     *entry);

Bastien Nocera's avatar
Bastien Nocera committed
354 355 356 357 358
static void
gtk_search_bar_dispose (GObject *object)
{
  GtkSearchBar *bar = GTK_SEARCH_BAR (object);

359
  gtk_search_bar_set_entry (bar, NULL);
Bastien Nocera's avatar
Bastien Nocera committed
360 361 362 363

  G_OBJECT_CLASS (gtk_search_bar_parent_class)->dispose (object);
}

364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
static gboolean
gtk_search_bar_draw (GtkWidget *widget,
                     cairo_t *cr)
{
  gint width, height;
  GtkStyleContext *context;

  width = gtk_widget_get_allocated_width (widget);
  height = gtk_widget_get_allocated_height (widget);
  context = gtk_widget_get_style_context (widget);

  gtk_render_background (context, cr, 0, 0, width, height);
  gtk_render_frame (context, cr, 0, 0, width, height);

  GTK_WIDGET_CLASS (gtk_search_bar_parent_class)->draw (widget, cr);

  return FALSE;
}

Bastien Nocera's avatar
Bastien Nocera committed
383 384 385 386 387 388 389 390 391 392
static void
gtk_search_bar_class_init (GtkSearchBarClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);
  GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
  GtkContainerClass *container_class = GTK_CONTAINER_CLASS (klass);

  object_class->dispose = gtk_search_bar_dispose;
  object_class->set_property = gtk_search_bar_set_property;
  object_class->get_property = gtk_search_bar_get_property;
393
  widget_class->draw = gtk_search_bar_draw;
Bastien Nocera's avatar
Bastien Nocera committed
394 395 396 397 398 399 400 401 402

  container_class->add = gtk_search_bar_add;

  /**
   * GtkEntry:search-mode-enabled:
   *
   * Whether the search mode is on and the search bar shown.
   *
   * See gtk_search_bar_set_search_mode() for details.
403
   */
Bastien Nocera's avatar
Bastien Nocera committed
404 405 406 407
  widget_props[PROP_SEARCH_MODE_ENABLED] = g_param_spec_boolean ("search-mode-enabled",
                                                                 P_("Search Mode Enabled"),
                                                                 P_("Whether the search mode is on and the search bar shown"),
                                                                 FALSE,
408
                                                                 GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
409

Bastien Nocera's avatar
Bastien Nocera committed
410 411 412 413
  /**
   * GtkEntry:show-close-button:
   *
   * Whether to show the close button in the toolbar.
414
   */
Bastien Nocera's avatar
Bastien Nocera committed
415 416 417
  widget_props[PROP_SHOW_CLOSE_BUTTON] = g_param_spec_boolean ("show-close-button",
                                                               P_("Show Close Button"),
                                                               P_("Whether to show the close button in the toolbar"),
418
                                                               FALSE,
419
                                                               GTK_PARAM_READWRITE|G_PARAM_CONSTRUCT|G_PARAM_EXPLICIT_NOTIFY);
Bastien Nocera's avatar
Bastien Nocera committed
420 421 422

  g_object_class_install_properties (object_class, LAST_PROPERTY, widget_props);

423
  gtk_widget_class_set_template_from_resource (widget_class, "/org/gtk/libgtk/ui/gtksearchbar.ui");
424 425 426 427
  gtk_widget_class_bind_template_child_private (widget_class, GtkSearchBar, tool_box);
  gtk_widget_class_bind_template_child_private (widget_class, GtkSearchBar, revealer);
  gtk_widget_class_bind_template_child_private (widget_class, GtkSearchBar, box_center);
  gtk_widget_class_bind_template_child_private (widget_class, GtkSearchBar, close_button);
428 429

  gtk_widget_class_set_css_name (widget_class, "searchbar");
Bastien Nocera's avatar
Bastien Nocera committed
430 431 432 433 434
}

static void
gtk_search_bar_init (GtkSearchBar *bar)
{
435
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);
Bastien Nocera's avatar
Bastien Nocera committed
436 437 438

  gtk_widget_init_template (GTK_WIDGET (bar));

439 440 441 442
  /* We use child-visible to avoid the unexpanded revealer
   * peaking out by 1 pixel
   */
  gtk_widget_set_child_visible (priv->revealer, FALSE);
Bastien Nocera's avatar
Bastien Nocera committed
443

444
  g_signal_connect (priv->revealer, "notify::reveal-child",
Bastien Nocera's avatar
Bastien Nocera committed
445
                    G_CALLBACK (reveal_child_changed_cb), bar);
446 447
  g_signal_connect (priv->revealer, "notify::child-revealed",
                    G_CALLBACK (child_revealed_changed_cb), bar);
Bastien Nocera's avatar
Bastien Nocera committed
448

449 450
  gtk_widget_set_no_show_all (priv->close_button, TRUE);
  g_signal_connect (priv->close_button, "clicked",
Bastien Nocera's avatar
Bastien Nocera committed
451 452 453 454 455 456 457 458
                    G_CALLBACK (close_button_clicked_cb), bar);
};

/**
 * gtk_search_bar_new:
 *
 * Creates a #GtkSearchBar. You will need to tell it about
 * which widget is going to be your text entry using
459
 * gtk_search_bar_connect_entry().
Bastien Nocera's avatar
Bastien Nocera committed
460
 *
461
 * Returns: a new #GtkSearchBar
Bastien Nocera's avatar
Bastien Nocera committed
462 463 464 465 466 467 468 469 470
 *
 * Since: 3.10
 */
GtkWidget *
gtk_search_bar_new (void)
{
  return g_object_new (GTK_TYPE_SEARCH_BAR, NULL);
}

471 472 473
static void
gtk_search_bar_set_entry (GtkSearchBar *bar,
                          GtkEntry     *entry)
Bastien Nocera's avatar
Bastien Nocera committed
474
{
475 476 477
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

  if (priv->entry != NULL)
Bastien Nocera's avatar
Bastien Nocera committed
478
    {
479 480 481 482
      if (GTK_IS_SEARCH_ENTRY (priv->entry))
        g_signal_handlers_disconnect_by_func (priv->entry, stop_search_cb, bar);
      else
        g_signal_handlers_disconnect_by_func (priv->entry, entry_key_pressed_event_cb, bar);
483
      g_object_remove_weak_pointer (G_OBJECT (priv->entry), (gpointer *) &priv->entry);
Bastien Nocera's avatar
Bastien Nocera committed
484 485
    }

486 487 488
  priv->entry = GTK_WIDGET (entry);

  if (priv->entry != NULL)
Bastien Nocera's avatar
Bastien Nocera committed
489
    {
490
      g_object_add_weak_pointer (G_OBJECT (priv->entry), (gpointer *) &priv->entry);
491 492 493 494 495 496
      if (GTK_IS_SEARCH_ENTRY (priv->entry))
        g_signal_connect (priv->entry, "stop-search",
                          G_CALLBACK (stop_search_cb), bar);
      else
        g_signal_connect (priv->entry, "key-press-event",
                          G_CALLBACK (entry_key_pressed_event_cb), bar);
Bastien Nocera's avatar
Bastien Nocera committed
497 498 499
    }
}

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
/**
 * gtk_search_bar_connect_entry:
 * @bar: a #GtkSearchBar
 * @entry: a #GtkEntry
 *
 * Connects the #GtkEntry widget passed as the one to be used in
 * this search bar. The entry should be a descendant of the search bar.
 * This is only required if the entry isn’t the direct child of the
 * search bar (as in our main example).
 *
 * Since: 3.10
 */
void
gtk_search_bar_connect_entry (GtkSearchBar *bar,
                              GtkEntry     *entry)
{
  g_return_if_fail (GTK_IS_SEARCH_BAR (bar));
  g_return_if_fail (entry == NULL || GTK_IS_ENTRY (entry));

  gtk_search_bar_set_entry (bar, entry);
}

Bastien Nocera's avatar
Bastien Nocera committed
522 523 524 525 526 527
/**
 * gtk_search_bar_get_search_mode:
 * @bar: a #GtkSearchBar
 *
 * Returns whether the search mode is on or off.
 *
528
 * Returns: whether search mode is toggled on
Bastien Nocera's avatar
Bastien Nocera committed
529 530
 *
 * Since: 3.10
531
 */
Bastien Nocera's avatar
Bastien Nocera committed
532 533 534
gboolean
gtk_search_bar_get_search_mode (GtkSearchBar *bar)
{
535 536
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

Bastien Nocera's avatar
Bastien Nocera committed
537 538
  g_return_val_if_fail (GTK_IS_SEARCH_BAR (bar), FALSE);

539
  return priv->reveal_child;
Bastien Nocera's avatar
Bastien Nocera committed
540 541 542 543 544 545 546 547 548 549
}

/**
 * gtk_search_bar_set_search_mode:
 * @bar: a #GtkSearchBar
 * @search_mode: the new state of the search mode
 *
 * Switches the search mode on or off.
 *
 * Since: 3.10
550
 */
Bastien Nocera's avatar
Bastien Nocera committed
551 552 553 554
void
gtk_search_bar_set_search_mode (GtkSearchBar *bar,
                                gboolean      search_mode)
{
555 556
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

Bastien Nocera's avatar
Bastien Nocera committed
557 558
  g_return_if_fail (GTK_IS_SEARCH_BAR (bar));

559
  gtk_revealer_set_reveal_child (GTK_REVEALER (priv->revealer), search_mode);
Bastien Nocera's avatar
Bastien Nocera committed
560 561 562 563 564 565 566 567
}

/**
 * gtk_search_bar_get_show_close_button:
 * @bar: a #GtkSearchBar
 *
 * Returns whether the close button is shown.
 *
568
 * Returns: whether the close button is shown
Bastien Nocera's avatar
Bastien Nocera committed
569 570
 *
 * Since: 3.10
571
 */
Bastien Nocera's avatar
Bastien Nocera committed
572 573 574
gboolean
gtk_search_bar_get_show_close_button (GtkSearchBar *bar)
{
575 576
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

Bastien Nocera's avatar
Bastien Nocera committed
577 578
  g_return_val_if_fail (GTK_IS_SEARCH_BAR (bar), FALSE);

579
  return gtk_widget_get_visible (priv->close_button);
Bastien Nocera's avatar
Bastien Nocera committed
580 581 582 583 584
}

/**
 * gtk_search_bar_set_show_close_button:
 * @bar: a #GtkSearchBar
585
 * @visible: whether the close button will be shown or not
Bastien Nocera's avatar
Bastien Nocera committed
586
 *
587
 * Shows or hides the close button. Applications that
William Jon McCann's avatar
William Jon McCann committed
588
 * already have a “search” toggle button should not show a close
589 590
 * button in their search bar, as it duplicates the role of the
 * toggle button.
Bastien Nocera's avatar
Bastien Nocera committed
591 592
 *
 * Since: 3.10
593
 */
Bastien Nocera's avatar
Bastien Nocera committed
594 595 596 597
void
gtk_search_bar_set_show_close_button (GtkSearchBar *bar,
                                      gboolean      visible)
{
598 599
  GtkSearchBarPrivate *priv = gtk_search_bar_get_instance_private (bar);

Bastien Nocera's avatar
Bastien Nocera committed
600 601
  g_return_if_fail (GTK_IS_SEARCH_BAR (bar));

602 603 604 605 606 607 608
  visible = visible != FALSE;

  if (gtk_widget_get_visible (priv->close_button) != visible)
    {
      gtk_widget_set_visible (priv->close_button, visible);
      g_object_notify (G_OBJECT (bar), "show-close-button");
    }
Bastien Nocera's avatar
Bastien Nocera committed
609
}