r3020 - in trunk/src/target/OM-2007.2/libraries/libmokoui2: . libmokoui

[thomas at sita.openmoko.org]

Author: thomas
Date: 2007-09-20 16:00:55 +0200 (Thu, 20 Sep 2007)
New Revision: 3020

Modified:
   trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
   trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c
Log:
* libmokoui/moko-search-bar.c: (moko_search_bar_init),
(moko_search_bar_new), (moko_search_bar_new_with_combo),
(moko_search_bar_get_combo_box), (moko_search_bar_get_entry),
(moko_search_bar_search_visible):

Add documentation for MokoSearchBar


Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog	2007-09-20 13:33:19 UTC (rev 3019)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog	2007-09-20 14:00:55 UTC (rev 3020)
@@ -1,5 +1,14 @@
 2007-09-20  Thomas Wood  <thomas at openedhand.com>
 
+	* libmokoui/moko-search-bar.c: (moko_search_bar_init),
+	(moko_search_bar_new), (moko_search_bar_new_with_combo),
+	(moko_search_bar_get_combo_box), (moko_search_bar_get_entry),
+	(moko_search_bar_search_visible):
+
+	Add documentation for MokoSearchBar
+
+2007-09-20  Thomas Wood  <thomas at openedhand.com>
+
 	* doc/reference/libmokoui2-docs.sgml: Add title and section name
 
 2007-09-19  Thomas Wood  <thomas at openedhand.com>

Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c	2007-09-20 13:33:19 UTC (rev 3019)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c	2007-09-20 14:00:55 UTC (rev 3020)
@@ -217,6 +217,14 @@
 		G_CALLBACK (entry_changed_cb), self);
 }
 
+/**
+ * moko_search_bar_new:
+ *
+ * Create a new MokoSearBar widget
+ *
+ * returns: The newly created MokoSearchBar
+ */
+
 GtkWidget *
 moko_search_bar_new (void)
 {
@@ -224,6 +232,15 @@
 		"combo", gtk_combo_box_new (), NULL));
 }
 
+/**
+ * moko_search_bar_new_with_combo:
+ * @comno: a GtkComboBox to use as the combobox
+ *
+ * Creates a MokoSearchBar with the specified combo box
+ *
+ * returns: the newly created MokoSearchBar
+ */
+
 GtkWidget *
 moko_search_bar_new_with_combo (GtkComboBox *combo)
 {
@@ -231,6 +248,14 @@
 		"combo", combo, NULL));
 }
 
+/**
+ * moko_search_bar_get_combo_box:
+ * @self: a MokoSearchBar
+ *
+ * Get a pointer to the GtkComboBox being used in the MokoSearchBar
+ *
+ * returns: the GtkComboBox
+ */
 GtkComboBox *
 moko_search_bar_get_combo_box (MokoSearchBar *self)
 {
@@ -239,6 +264,15 @@
 	return combo;
 }
 
+
+/**
+ * moko_search_bar_get_entry:
+ * @self: a MokoSearchBar
+ *
+ * Retrieve the GtkEntry widget being used in the MokoSearchBar
+ *
+ * returns: the GtkEntry
+ */
 GtkEntry *
 moko_search_bar_get_entry (MokoSearchBar *self)
 {
@@ -247,6 +281,14 @@
 	return entry;
 }
 
+/**
+ * moko_search_bar_search_visible:
+ * @self: a MokoSaerchBar
+ *
+ * Determine the visibility of the search entry.
+ *
+ * returns: TRUE if the search entry is visible
+ */
 gboolean
 moko_search_bar_search_visible (MokoSearchBar *self)
 {
@@ -255,6 +297,14 @@
 	return GTK_WIDGET_VISIBLE (priv->entry);
 }
 
+
+/**
+ * moko_search_bar_toggle:
+ * @self: a MokoSearchBar
+ *
+ * Toggle the search button on the MokoSearchBar.
+ * This toggles the visibility of the combo box and entry widgets.
+ */
 void
 moko_search_bar_toggle (MokoSearchBar *self)
 {