aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiego Escalante Urrelo <diegoe@gnome.org>2009-12-02 02:45:15 +0800
committerDiego Escalante Urrelo <diegoe@gnome.org>2009-12-03 06:22:58 +0800
commit7572ea1934778ab1b19376cde518b5571bda3947 (patch)
tree29684793d722083de198e6f052086e3d7b39ef66
parentf29b3148fd369e8100ef423424e3585db935e4d6 (diff)
downloadgsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar.gz
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar.bz2
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar.lz
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar.xz
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.tar.zst
gsoc2013-epiphany-7572ea1934778ab1b19376cde518b5571bda3947.zip
docs: ephy-search-entry
-rw-r--r--lib/widgets/ephy-search-entry.c18
-rw-r--r--lib/widgets/ephy-search-entry.h2
2 files changed, 19 insertions, 1 deletions
diff --git a/lib/widgets/ephy-search-entry.c b/lib/widgets/ephy-search-entry.c
index 2e5f2e731..2fb28e009 100644
--- a/lib/widgets/ephy-search-entry.c
+++ b/lib/widgets/ephy-search-entry.c
@@ -23,6 +23,15 @@
#include "ephy-search-entry.h"
+/**
+ * SECTION:ephy-search-entry
+ * @short_description: A search entry widget
+ * @see_also: #GtkEntry
+ *
+ * #EphySearchEntry implements a #GtkEntry for handling user search input.
+ * It implements a search timeout and easy cleaning.
+ */
+
static void ephy_search_entry_class_init (EphySearchEntryClass *klass);
static void ephy_search_entry_init (EphySearchEntry *entry);
@@ -49,6 +58,15 @@ ephy_search_entry_class_init (EphySearchEntryClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
+ /**
+ * EphySearchEntry::search:
+ * @entry: the object on which the signal is emitted
+ * @text: the text introduced by the user
+ *
+ * Emitted when the user activates the search entry after introducing
+ * text.
+ *
+ */
ephy_search_entry_signals[SEARCH] =
g_signal_new ("search",
G_OBJECT_CLASS_TYPE (object_class),
diff --git a/lib/widgets/ephy-search-entry.h b/lib/widgets/ephy-search-entry.h
index dd675d12a..5ea2526d2 100644
--- a/lib/widgets/ephy-search-entry.h
+++ b/lib/widgets/ephy-search-entry.h
@@ -43,7 +43,7 @@ struct _EphySearchEntryClass
{
GtkEntryClass parent;
- void (*search) (EphySearchEntry *view, const char *text);
+ void (*search) (EphySearchEntry *entry, const char *text);
};
struct _EphySearchEntry