eog r4576 - in trunk: . src

[csaavedra svn gnome org]

Author: csaavedra
Date: Tue May 20 22:11:03 2008
New Revision: 4576
URL: http://svn.gnome.org/viewvc/eog?rev=4576&view=rev

Log:
2008-05-20  Claudio Saavedra  <csaavedra gnome org>

	* src/eog-message-area.c: (eog_message_area_class_init):
	* src/eog-thumb-nav.c:

	Add documentation for EogMessageArea and EogThumbNav.



Modified:
   trunk/ChangeLog
   trunk/src/eog-message-area.c
   trunk/src/eog-thumb-nav.c

Modified: trunk/src/eog-message-area.c
==============================================================================
--- trunk/src/eog-message-area.c	(original)
+++ trunk/src/eog-message-area.c	Tue May 20 22:11:03 2008
@@ -184,6 +184,13 @@
 
 	g_type_class_add_private (object_class, sizeof(EogMessageAreaPrivate));
 
+/**
+ * EogMessageArea::response:
+ * @message_area: the object which received the signal.
+ *
+ * The #EogMessageArea::response signal is emitted when one of the
+ * activatable widgets packed into @message_area is activated.
+ */
 	signals[SIGNAL_RESPONSE] = 
 		g_signal_new ("response",
 			      G_OBJECT_CLASS_TYPE (class),
@@ -279,6 +286,15 @@
 	eog_message_area_response (message_area, response_id);
 }
 
+/**
+ * eog_message_area_add_action_widget:
+ * @message_area: an #EogMessageArea.
+ * @child: The widget to be packed into the message area.
+ * @response_id: A response id for @child.
+ *
+ * Adds a widget to the action area of @message_area. Only 'activatable'
+ * widgets can be packed into the action area of a #EogMessageArea.
+ **/
 void
 eog_message_area_add_action_widget (EogMessageArea *message_area,
 				    GtkWidget      *child,
@@ -330,6 +346,14 @@
 	}
 }
 
+/**
+ * eog_message_area_set_contents:
+ * @message_area: an #EogMessageArea.
+ * @contents: a #GtkWidget.
+ *
+ * Sets the contents of @message_area. The @contents will
+ * be packed into the message area.
+ **/
 void
 eog_message_area_set_contents(EogMessageArea *message_area,
 			      GtkWidget      *contents)
@@ -346,6 +370,16 @@
 			    0);	
 }
 
+/**
+ * eog_message_area_add_button:
+ * @message_area: an #EogMessageArea.
+ * @button_text: The text for the button to be added.
+ * @response_id: A response id.
+ *
+ * Adds a single button to @message_area.
+ *
+ * Returns: The newly added #GtkButton.
+ **/
 GtkWidget *
 eog_message_area_add_button (EogMessageArea *message_area,
 			       const gchar      *button_text,
@@ -398,6 +432,14 @@
 	}
 }
 
+/**
+ * eog_message_area_add_buttons:
+ * @message_area: An #EogMessageArea.
+ * @first_button_text: the text for the first button to be added.
+ * @...: text for extra buttons, terminated with %NULL.
+ *
+ * Adds one or more buttons to @message_area.
+ **/
 void
 eog_message_area_add_buttons (EogMessageArea *message_area,
 			      const gchar    *first_button_text,
@@ -420,6 +462,15 @@
 	return g_object_new (EOG_TYPE_MESSAGE_AREA, NULL);
 }
 
+/**
+ * eog_message_area_new_with_buttons:
+ * @first_button_text: The text for the first button.
+ * @...: additional buttons, terminated with %NULL.
+ *
+ * Creates a new #EogMessageArea with default buttons.
+ *
+ * Returns: A newly created #EogMessageArea widget.
+ **/
 GtkWidget *
 eog_message_area_new_with_buttons (const gchar *first_button_text,
                                    ...)
@@ -440,6 +491,16 @@
 	return GTK_WIDGET (message_area);
 }
 
+/**
+ * eog_message_area_set_response_sensitive:
+ * @message_area: a #EogMessageArea.
+ * @response_id: the response id associated to the widget whose
+ * sensitivity is to be set.
+ * @setting: %TRUE to set the widget sensitive, %FALSE otherwise.
+ *
+ * Sets sensitivity in @message_area's child widget associated to
+ * @response_id.
+ **/
 void
 eog_message_area_set_response_sensitive (EogMessageArea *message_area,
 					   gint              response_id,
@@ -467,6 +528,15 @@
 	g_list_free (children);
 }
 
+/**
+ * eog_message_area_set_default_response:
+ * @message_area: an #EogMessageArea.
+ * @response_id: the response id associated to the widget to
+ * be set default.
+ *
+ * Sets the default response in @message_area. This is done by
+ * making the widget associated to @response_id the default widget.
+ **/
 void
 eog_message_area_set_default_response (EogMessageArea *message_area,
 					 gint              response_id)
@@ -492,6 +562,13 @@
 	g_list_free (children);
 }
 
+/**
+ * eog_message_area_response:
+ * @message_area: an #EogMessageArea.
+ * @response_id: The response id for the emission.
+ *
+ * Emits a #EogMessageArea::response signal to the given #EogMessageArea.
+ **/
 void
 eog_message_area_response (EogMessageArea *message_area,
 			   gint              response_id)
@@ -504,6 +581,18 @@
 		       response_id);
 }
 
+/**
+ * eog_message_area_add_stock_button_with_text:
+ * @message_area: An #EogMessageArea.
+ * @text: The text for the button.
+ * @stock_id: A stock item.
+ * @response_id: A response id for the button.
+ *
+ * Adds a new button to @message_area containing a image from stock and a
+ * user defined text. Stock items may have a macro defined, like %GTK_STOCK_OK.
+ *
+ * Returns: the newly added #GtkButton.
+ **/
 GtkWidget *
 eog_message_area_add_stock_button_with_text (EogMessageArea *message_area, 
 				    	     const gchar    *text,

Modified: trunk/src/eog-thumb-nav.c
==============================================================================
--- trunk/src/eog-thumb-nav.c	(original)
+++ trunk/src/eog-thumb-nav.c	Tue May 20 22:11:03 2008
@@ -406,6 +406,16 @@
 	gtk_adjustment_value_changed (priv->adj);
 }
 
+/**
+ * eog_thumb_nav_new:
+ * @thumbview: an #EogThumbView to embed in the navigation widget.
+ * @mode: The navigation mode.
+ * @show_buttons: Whether to show the navigation buttons.
+ *
+ * Creates a new thumbnail navigation widget.
+ *
+ * Returns: a new #EogThumbNav object.
+ **/
 GtkWidget *
 eog_thumb_nav_new (GtkWidget       *thumbview, 
 		   EogThumbNavMode  mode, 
@@ -424,6 +434,15 @@
 	return GTK_WIDGET (nav);
 }
 
+/**
+ * eog_thumb_nav_get_show_buttons:
+ * @nav: an #EogThumbNav.
+ *
+ * Gets whether the navigation buttons are visible.
+ *
+ * Returns: %TRUE if the navigation buttons are visible,
+ * %FALSE otherwise.
+ **/
 gboolean
 eog_thumb_nav_get_show_buttons (EogThumbNav *nav)
 {
@@ -432,6 +451,14 @@
 	return nav->priv->show_buttons; 
 }
 
+/**
+ * eog_thumb_nav_set_show_buttons:
+ * @nav: an #EogThumbNav.
+ * @show_buttons: %TRUE to show the buttons, %FALSE to hide them.
+ *
+ * Sets whether the navigation buttons to the left and right of the
+ * widget should be visible.
+ **/
 void 
 eog_thumb_nav_set_show_buttons (EogThumbNav *nav, gboolean show_buttons)
 {
@@ -451,6 +478,14 @@
 	}
 }
 
+/**
+ * eog_thumb_nav_get_mode:
+ * @nav: an #EogThumbNav.
+ *
+ * Gets the navigation mode in @nav.
+ *
+ * Returns: A value in #EogThumbNavMode.
+ **/
 EogThumbNavMode
 eog_thumb_nav_get_mode (EogThumbNav *nav)
 {
@@ -459,6 +494,13 @@
 	return nav->priv->mode; 
 }
 
+/**
+ * eog_thumb_nav_set_mode:
+ * @nav: An #EogThumbNav.
+ * @mode: One of #EogThumbNavMode.
+ *
+ * Sets the navigation mode in @nav. See #EogThumbNavMode for details.
+ **/
 void 
 eog_thumb_nav_set_mode (EogThumbNav *nav, EogThumbNavMode mode)
 {