[epiphany] docs: ephy-search-entry
- From: Diego Escalante Urrelo <diegoe src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [epiphany] docs: ephy-search-entry
- Date: Fri, 4 Dec 2009 03:09:59 +0000 (UTC)
commit 7572ea1934778ab1b19376cde518b5571bda3947
Author: Diego Escalante Urrelo <diegoe gnome org>
Date: Tue Dec 1 13:45:15 2009 -0500
docs: ephy-search-entry
lib/widgets/ephy-search-entry.c | 18 ++++++++++++++++++
lib/widgets/ephy-search-entry.h | 2 +-
2 files changed, 19 insertions(+), 1 deletions(-)
---
diff --git a/lib/widgets/ephy-search-entry.c b/lib/widgets/ephy-search-entry.c
index 2e5f2e7..2fb28e0 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 dd675d1..5ea2526 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]