GNOME.org
 

[epiphany] docs: ephy-toolbar

commit b0891810b1015e23df760dffe6befb145c9a4e3d
Author: Diego Escalante Urrelo <diegoe gnome org>
Date:   Wed Dec 2 01:21:08 2009 -0500

    docs: ephy-toolbar
    
    Bug #503852

 doc/reference/Makefile.am           |    1 -
 doc/reference/epiphany-docs.sgml    |    1 +
 doc/reference/epiphany-sections.txt |   18 +++++
 doc/reference/epiphany.types        |    2 +
 src/ephy-toolbar.c                  |  122 ++++++++++++++++++++++++++++++++++-
 src/ephy-toolbar.h                  |    4 +-
 6 files changed, 144 insertions(+), 4 deletions(-)
---
diff --git a/doc/reference/Makefile.am b/doc/reference/Makefile.am
index 5a8ffeb..26d4f64 100644
--- a/doc/reference/Makefile.am
+++ b/doc/reference/Makefile.am
@@ -98,7 +98,6 @@ IGNORE_HFILES = \
 	popup-commands.h \
 	ppview-toolbar.h \
 	prefs-dialog.h \
-	ephy-toolbar.h \
 	ephy-fullscreen-popup.h \
 	ephy-link.h \
 	window-commands.h
diff --git a/doc/reference/epiphany-docs.sgml b/doc/reference/epiphany-docs.sgml
index f916702..97acb71 100644
--- a/doc/reference/epiphany-docs.sgml
+++ b/doc/reference/epiphany-docs.sgml
@@ -9,6 +9,7 @@
   <chapter>
     <title>Epiphany</title>
     <xi:include href="xml/ephy-statusbar.xml"/>
+    <xi:include href="xml/ephy-toolbar.xml"/>
     <xi:include href="xml/ephy-window.xml"/>
   </chapter>
   <chapter>
diff --git a/doc/reference/epiphany-sections.txt b/doc/reference/epiphany-sections.txt
index b389f15..1fe73f7 100644
--- a/doc/reference/epiphany-sections.txt
+++ b/doc/reference/epiphany-sections.txt
@@ -109,6 +109,24 @@ ephy_statusbar_remove_widget
 </SECTION>
 
 <SECTION>
+<FILE>ephy-toolbar</FILE>
+<TITLE>EphyToolbar</TITLE>
+EphyToolbar
+ephy_toolbar_new
+ephy_toolbar_get_action_group
+ephy_toolbar_set_favicon
+ephy_toolbar_set_show_leave_fullscreen
+ephy_toolbar_activate_location
+ephy_toolbar_get_location
+ephy_toolbar_set_location
+ephy_toolbar_set_navigation_actions
+ephy_toolbar_set_navigation_tooltips
+ephy_toolbar_set_security_state
+ephy_toolbar_set_spinning
+ephy_toolbar_set_zoom
+</SECTION>
+
+<SECTION>
 <FILE>ephy-window</FILE>
 <TITLE>EphyWindow</TITLE>
 EphyWindow
diff --git a/doc/reference/epiphany.types b/doc/reference/epiphany.types
index d9e4d16..a710225 100644
--- a/doc/reference/epiphany.types
+++ b/doc/reference/epiphany.types
@@ -16,7 +16,9 @@ ephy_zoom_action_get_type
 ephy_zoom_control_get_type
 
 #include <ephy-statusbar.h>
+#include <ephy-toolbar.h>
 #include <ephy-window.h>
 
 ephy_statusbar_get_type
+ephy_toolbar_get_type
 ephy_window_get_type
diff --git a/src/ephy-toolbar.c b/src/ephy-toolbar.c
index 3cd3eee..603662e 100644
--- a/src/ephy-toolbar.c
+++ b/src/ephy-toolbar.c
@@ -44,6 +44,13 @@
 #include <gtk/gtk.h>
 #include <string.h>
 
+/**
+ * SECTION:ephy-toolbar
+ * @short_description: Epiphany's toolbar widget
+ *
+ * #EphyToolbar is a customized #EggEditableToolbar.
+ */
+
 enum
 {
 	BACK_ACTION,
@@ -360,6 +367,9 @@ ephy_toolbar_set_window (EphyToolbar *toolbar,
 
 /**
  * ephy_toolbar_get_action_group
+ * @toolbar: an #EphyToolbar widget
+ *
+ * Gets the #GtkActionGroup for @toolbar.
  *
  * Return value: (transfer none):
  **/
@@ -369,6 +379,13 @@ ephy_toolbar_get_action_group (EphyToolbar *toolbar)
    return toolbar->priv->action_group;   
 }
 
+/**
+ * ephy_toolbar_set_favicon:
+ * @toolbar: an #EphyToolbar widget
+ * @icon: a #GdkPixbuf icon
+ *
+ * Sets @icon to be the favicon of @toolbar's internal #EphyLocationEntry.
+ **/
 void
 ephy_toolbar_set_favicon (EphyToolbar *toolbar,
 			  GdkPixbuf *icon)
@@ -378,6 +395,13 @@ ephy_toolbar_set_favicon (EphyToolbar *toolbar,
 	g_object_set (priv->actions[LOCATION_ACTION], "icon", icon, NULL);
 }
 
+/**
+ * ephy_toolbar_set_show_leave_fullscreen:
+ * @toolbar: an #EphyToolbar widget
+ * @show: %TRUE to show the leave fullscreen button
+ *
+ * Tells @toolbar if it should show the leave fullscreen button or not.
+ **/
 void
 ephy_toolbar_set_show_leave_fullscreen (EphyToolbar *toolbar,
 					gboolean show)
@@ -389,6 +413,12 @@ ephy_toolbar_set_show_leave_fullscreen (EphyToolbar *toolbar,
 	ephy_toolbar_update_fixed_visibility (toolbar);
 }
 
+/**
+ * ephy_toolbar_activate_location:
+ * @toolbar: an #EphyToolbar widget
+ *
+ * Calls ephy_location_entry_activate on @toolbar's internal #EphyLocationEntry.
+ **/
 void
 ephy_toolbar_activate_location (EphyToolbar *toolbar)
 {
@@ -425,6 +455,14 @@ ephy_toolbar_activate_location (EphyToolbar *toolbar)
 	ephy_location_entry_activate (EPHY_LOCATION_ENTRY (entry));
 }
 
+/**
+ * ephy_toolbar_get_location:
+ * @toolbar: an #EphyToolbar widget
+ *
+ * Gets the current address according to @toolbar's #EphyLocationAction.
+ *
+ * Returns: current @toolbar address
+ **/
 const char *
 ephy_toolbar_get_location (EphyToolbar *toolbar)
 {
@@ -434,6 +472,15 @@ ephy_toolbar_get_location (EphyToolbar *toolbar)
 	return ephy_location_action_get_address (action);
 }
 
+/**
+ * ephy_toolbar_set_location:
+ * @toolbar: an #EphyToolbar widget
+ * @address: current @toolbar address
+ * @typed_address: address currently typed by the user
+ *
+ * Calls ephy_location_action_set_address in the internal #EphyLocationAction
+ * with @address and @typed_address.
+ **/
 void
 ephy_toolbar_set_location (EphyToolbar *toolbar,
 			   const char *address,
@@ -449,6 +496,15 @@ ephy_toolbar_set_location (EphyToolbar *toolbar,
 	priv->updating_address = FALSE;
 }
 
+/**
+ * ephy_toolbar_set_navigation_actions:
+ * @toolbar: an #EphyToolbar widget
+ * @back: %TRUE if possible to go backward
+ * @forward: %TRUE if possible to go forward
+ * @up: %TRUE if possible to go up
+ *
+ * Sets the sensivity of navigation buttons in the @toolbar.
+ **/
 void
 ephy_toolbar_set_navigation_actions (EphyToolbar *toolbar,
 				     gboolean back,
@@ -462,6 +518,15 @@ ephy_toolbar_set_navigation_actions (EphyToolbar *toolbar,
 	ephy_action_change_sensitivity_flags (priv->actions[UP_ACTION], SENS_FLAG, !up);
 }
 
+/**
+ * ephy_toolbar_set_navigation_tooltips:
+ * @toolbar: an #EphyToolbar widget
+ * @back_title: text for back button tooltip
+ * @forward_title: text for forward button tooltip
+ *
+ * Sets the titles of back and forward pages as the tooltips of its corresponding
+ * navigation buttons.
+ **/
 void
 ephy_toolbar_set_navigation_tooltips (EphyToolbar *toolbar,
 				      const char *back_title,
@@ -482,6 +547,16 @@ ephy_toolbar_set_navigation_tooltips (EphyToolbar *toolbar,
 	g_value_unset (&value);
 }
 
+/**
+ * ephy_toolbar_set_security_state:
+ * @toolbar: an #EphyToolbar widget
+ * @is_secure: %TRUE if the page is loaded over a secure connection
+ * @show_lock: %TRUE to show the lock icon in the location entry
+ * @stock_id: stock-id to be used as the lock icon
+ * @tooltip: tooltip for the lock icon
+ *
+ * Sets properties on the lock icon inside the internal #EphyLocationEntry.
+ **/
 void
 ephy_toolbar_set_security_state (EphyToolbar *toolbar,
 				 gboolean is_secure,
@@ -502,6 +577,13 @@ ephy_toolbar_set_security_state (EphyToolbar *toolbar,
 		      NULL);
 }
 
+/**
+ * ephy_toolbar_set_spinning:
+ * @toolbar: an #EphyToolbar widget
+ * @spinning: %TRUE to set the internal #EphySpinner as active
+ *
+ * Controls the internal #EphySpinner activity.
+ **/
 void
 ephy_toolbar_set_spinning (EphyToolbar *toolbar,
 			   gboolean spinning)
@@ -513,6 +595,14 @@ ephy_toolbar_set_spinning (EphyToolbar *toolbar,
 	ephy_toolbar_update_spinner (toolbar);
 }
 
+/**
+ * ephy_toolbar_set_zoom:
+ * @toolbar: an #EphyToolbar widget
+ * @can_zoom: %TRUE if the current #EphyWebView can zoom
+ * @zoom: new zoom level
+ *
+ * Sets the zoom level to @zoom, but only if @can_zoom is %TRUE.
+ **/
 void
 ephy_toolbar_set_zoom (EphyToolbar *toolbar,
 		       gboolean can_zoom,
@@ -651,6 +741,12 @@ ephy_toolbar_class_init (EphyToolbarClass *klass)
 	widget_class->show = ephy_toolbar_show;
 	widget_class->hide = ephy_toolbar_hide;
 
+	/**
+	* EphyToolbar::activation-finished:
+	*
+	* Emitted when the user clicks on the security icon of the internal
+	* #EphyLocationEntry.
+	*/
 	signals[ACTIVATION_FINISHED] =
 		g_signal_new ("activation-finished",
 			      G_OBJECT_CLASS_TYPE (object_class),
@@ -661,6 +757,12 @@ ephy_toolbar_class_init (EphyToolbarClass *klass)
 			      G_TYPE_NONE,
 			      0);
 
+	/**
+	* EphyToolbar::exit-clicked:
+	*
+	* Emitted when the user clicks on the security icon of the internal
+	* #EphyLocationEntry.
+	*/
 	signals[EXIT_CLICKED] =
 		g_signal_new
 			("exit-clicked",
@@ -672,6 +774,12 @@ ephy_toolbar_class_init (EphyToolbarClass *klass)
 			 G_TYPE_NONE,
 			 0);
 
+	/**
+	* EphyToolbar::lock-clicked:
+	*
+	* Emitted when the user clicks on the security icon of the internal
+	* #EphyLocationEntry.
+	*/
 	signals[LOCK_CLICKED] =
 		g_signal_new
 			("lock-clicked",
@@ -682,7 +790,11 @@ ephy_toolbar_class_init (EphyToolbarClass *klass)
 			 g_cclosure_marshal_VOID__VOID,
 			 G_TYPE_NONE,
 			 0);
-
+	/**
+	* EphyToolbar:window:
+	*
+	* Parent window of the toolbar.
+	*/
 	g_object_class_install_property (object_class,
 					 PROP_WINDOW,
 					 g_param_spec_object ("window",
@@ -695,6 +807,14 @@ ephy_toolbar_class_init (EphyToolbarClass *klass)
 	g_type_class_add_private (object_class, sizeof(EphyToolbarPrivate));
 }
 
+/**
+ * ephy_toolbar_new:
+ * @window: parent window for the toolbar
+ *
+ * Creates a new #EphyToolbar and associates it with @window.
+ *
+ * Returns: a new #EphyToolbar
+ **/
 EphyToolbar *
 ephy_toolbar_new (EphyWindow *window)
 {
diff --git a/src/ephy-toolbar.h b/src/ephy-toolbar.h
index 370b1e1..13a3d7d 100644
--- a/src/ephy-toolbar.h
+++ b/src/ephy-toolbar.h
@@ -76,9 +76,9 @@ void		ephy_toolbar_set_favicon		(EphyToolbar *toolbar,
 void		ephy_toolbar_set_show_leave_fullscreen	(EphyToolbar *toolbar,
 							 gboolean show);
 
-void		ephy_toolbar_activate_location		(EphyToolbar *t);
+void		ephy_toolbar_activate_location		(EphyToolbar *toolbar);
 
-const char     *ephy_toolbar_get_location		(EphyToolbar *t);
+const char     *ephy_toolbar_get_location		(EphyToolbar *toolbar);
 
 void		ephy_toolbar_set_location		(EphyToolbar *toolbar,
 							 const char *address,
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]