Commit d704f2bd authored by Bastien Nocera's avatar Bastien Nocera

gtk: Add GtkSearchEntry

Add a search entry widget with the recommended behaviour implemented.
As used in gnome-control-center, Totem, gnome-documents and many others.

https://bugzilla.gnome.org/show_bug.cgi?id=652809
parent ab976ac8
......@@ -170,22 +170,6 @@ icon_press_cb (GtkEntry *entry,
if (position == GTK_ENTRY_ICON_PRIMARY)
gtk_menu_popup (GTK_MENU (menu), NULL, NULL, NULL, NULL,
event->button, event->time);
else
clear_entry (entry);
}
static void
text_changed_cb (GtkEntry *entry,
GParamSpec *pspec,
GtkWidget *button)
{
gboolean has_text;
has_text = gtk_entry_get_text_length (entry) > 0;
gtk_entry_set_icon_sensitive (entry,
GTK_ENTRY_ICON_SECONDARY,
has_text);
gtk_widget_set_sensitive (button, has_text);
}
static void
......@@ -282,7 +266,7 @@ do_search_entry (GtkWidget *do_widget)
gtk_container_set_border_width (GTK_CONTAINER (hbox), 0);
/* Create our entry */
entry = gtk_entry_new ();
entry = gtk_search_entry_new ();
gtk_box_pack_start (GTK_BOX (hbox), entry, FALSE, FALSE, 0);
/* Create the find and cancel buttons */
......@@ -307,15 +291,8 @@ do_search_entry (GtkWidget *do_widget)
search_by_name (NULL, GTK_ENTRY (entry));
/* Set up the clear icon */
gtk_entry_set_icon_from_stock (GTK_ENTRY (entry),
GTK_ENTRY_ICON_SECONDARY,
GTK_STOCK_CLEAR);
text_changed_cb (GTK_ENTRY (entry), NULL, find_button);
g_signal_connect (entry, "icon-press",
G_CALLBACK (icon_press_cb), NULL);
g_signal_connect (entry, "notify::text",
G_CALLBACK (text_changed_cb), find_button);
g_signal_connect (entry, "activate",
G_CALLBACK (activate_cb), NULL);
......
......@@ -129,6 +129,7 @@
<xi:include href="xml/gtkhscale.xml" />
<xi:include href="xml/gtkvscale.xml" />
<xi:include href="xml/gtkspinbutton.xml" />
<xi:include href="xml/gtksearchentry.xml" />
<xi:include href="xml/gtkeditable.xml" />
</chapter>
......
......@@ -2957,6 +2957,22 @@ gtk_scrolled_window_get_type
GtkScrolledWindowPrivate
</SECTION>
<SECTION>
<FILE>gtksearchentry</FILE>
<TITLE>GtkSearchEntry</TITLE>
GtkSearchEntry
gtk_search_entry_new
<SUBSECTION Standard>
GTK_TYPE_SEARCH_ENTRY
GTK_SEARCH_ENTRY
GTK_SEARCH_ENTRY_CLASS
GTK_IS_SEARCH_ENTRY
GTK_IS_SEARCH_ENTRY_CLASS
GTK_SEARCH_ENTRY_GET_CLASS
<SUBSECTION Private>
gtk_search_entry_get_type
</SECTION>
<SECTION>
<FILE>gtkseparator</FILE>
<TITLE>GtkSeparator</TITLE>
......
......@@ -309,6 +309,7 @@ gtk_public_h_sources = \
gtkscrollable.h \
gtkscrollbar.h \
gtkscrolledwindow.h \
gtksearchentry.h \
gtkselection.h \
gtkseparator.h \
gtkseparatormenuitem.h \
......@@ -571,6 +572,7 @@ gtk_base_c_sources = \
gactionobservable.c \
gtkactionable.c \
gtkquery.c \
gtksearchentry.c \
gtksearchengine.c \
gtksearchenginesimple.c \
fnmatch.c \
......
......@@ -165,6 +165,7 @@
#include <gtk/gtkscrollable.h>
#include <gtk/gtkscrollbar.h>
#include <gtk/gtkscrolledwindow.h>
#include <gtk/gtksearchentry.h>
#include <gtk/gtkselection.h>
#include <gtk/gtkseparator.h>
#include <gtk/gtkseparatormenuitem.h>
......
......@@ -2394,6 +2394,8 @@ gtk_scrolled_window_set_vadjustment
gtk_scrolled_window_unset_placement
gtk_scroll_step_get_type
gtk_scroll_type_get_type
gtk_search_entry_new
gtk_search_entry_get_type
gtk_selection_add_target
gtk_selection_add_targets
gtk_selection_clear_targets
......
/* GTK - The GIMP Toolkit
* Copyright (C) 2012 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 2012. 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 "gtksearchentry.h"
/**
* SECTION:gtksearchentry
* @Short_description: An entry which shows a search icon
* @Title: GtkSearchEntry
*
* #GtkSearchEntry is a subclass of #GtkEntry that has
* been tailored for use as a search entry.
*
* It will show an inactive symbolic "find" icon when the
* search entry is empty, and a symbolic "clear" icon when
* there is text. Clicking on the "clear" icon will empty
* the search entry.
*
* Note that the search/clear icon is shown using a secondary
* icon, and thus does not work if you are using the secondary
* icon position for some other purpose.
*
* Since: 3.6
*/
G_DEFINE_TYPE (GtkSearchEntry, gtk_search_entry, GTK_TYPE_ENTRY)
static void
gtk_search_entry_class_init (GtkSearchEntryClass *klass)
{
}
static void
search_entry_clear_cb (GtkEntry *entry,
gpointer user_data)
{
gtk_entry_set_text (entry, "");
}
static void
search_entry_changed_cb (GtkEntry *entry,
gpointer user_data)
{
const char *str, *icon_name;
gboolean active;
str = gtk_entry_get_text (entry);
if (str == NULL || *str == '\0')
{
icon_name = "edit-find-symbolic";
active = FALSE;
}
else
{
icon_name = "edit-clear-symbolic";
active = TRUE;
}
g_object_set (entry,
"secondary-icon-name", icon_name,
"secondary-icon-activatable", active,
"secondary-icon-sensitive", active,
NULL);
}
static void
gtk_search_entry_init (GtkSearchEntry *entry)
{
g_signal_connect (entry, "changed",
G_CALLBACK (search_entry_changed_cb), NULL);
g_signal_connect (entry, "icon-release",
G_CALLBACK (search_entry_clear_cb), NULL);
search_entry_changed_cb (GTK_ENTRY (entry), NULL);
}
/**
* gtk_search_entry_new:
*
* Creates a #GtkSearchEntry, with a find icon when the search field is
* empty, and a clear icon when it isn't.
*
* Return value: a new #GtkSearchEntry
*
* Since: 3.6
*/
GtkWidget *
gtk_search_entry_new (void)
{
return GTK_WIDGET (g_object_new (GTK_TYPE_SEARCH_ENTRY, NULL));
}
/* GTK - The GIMP Toolkit
* Copyright (C) 2012 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 2012. 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/.
*/
#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif
#ifndef __GTK_SEARCH_ENTRY_H__
#define __GTK_SEARCH_ENTRY_H__
#include <gtk/gtkentry.h>
G_BEGIN_DECLS
#define GTK_TYPE_SEARCH_ENTRY (gtk_search_entry_get_type ())
#define GTK_SEARCH_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GTK_TYPE_SEARCH_ENTRY, GtkSearchEntry))
#define GTK_SEARCH_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GTK_TYPE_SEARCH_ENTRY, GtkSearchEntryClass))
#define GTK_IS_SEARCH_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GTK_TYPE_SEARCH_ENTRY))
#define GTK_IS_SEARCH_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_SEARCH_ENTRY))
#define GTK_SEARCH_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_SEARCH_ENTRY, GtkSearchEntryClass))
typedef struct _GtkSearchEntry GtkSearchEntry;
typedef struct _GtkSearchEntryClass GtkSearchEntryClass;
struct _GtkSearchEntry
{
GtkEntry parent;
};
struct _GtkSearchEntryClass
{
GtkEntryClass parent_class;
/* Padding for future expansion */
void (*_gtk_reserved1) (void);
void (*_gtk_reserved2) (void);
void (*_gtk_reserved3) (void);
void (*_gtk_reserved4) (void);
};
GDK_AVAILABLE_IN_3_6
GType gtk_search_entry_get_type (void) G_GNUC_CONST;
GDK_AVAILABLE_IN_3_6
GtkWidget* gtk_search_entry_new (void);
G_END_DECLS
#endif /* __GTK_SEARCH_ENTRY_H__ */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment