+2005-11-16 Bill Haneman <bill.haneman@sun.com>
+
+ * atk/atkimage.c:
+ * atk/atkhypertext.c:
+ * atk/atkobjectfactory.c:
+ * atk/atktable.c: Moved error return code
+ description to 'Returns' section.
+ * docs/tmpl/atkutil.sgml:
+ Committed a docs patch from Bill Abt.
+
2005-11-01 Simos Xenitellis <simos@gnome.org>
* configure.in: Added tt (Tatar) to ALL_LINGUAS.
* @char_index: a character index
*
* Gets the index into the array of hyperlinks that is associated with
- * the character specified by @char_index, or -1 if there is no hyperlink
- * associated with this character.
+ * the character specified by @char_index.
*
- * Returns: an index into the array of hyperlinks in @hypertext
+ * Returns: an index into the array of hyperlinks in @hypertext,
+ * or -1 if there is no hyperlink associated with this character.
**/
gint
atk_hypertext_get_link_index (AtkHypertext *hypertext,
/**
* atk_image_get_image_position:
* @image: a #GObject instance that implements AtkImageIface
- * @x: address of #gint to put x coordinate position
- * @y: address of #gint to put y coordinate position
+ * @x: address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
+ * @y: address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
* @coord_type: specifies whether the coordinates are relative to the screen
* or to the components top level window
*
* Gets the position of the image in the form of a point specifying the
- * images top-left corner. The values of @x and @y are returned as -1
- * if the values cannot be obtained.
+ * images top-left corner.
**/
void
atk_image_get_image_position (AtkImage *image,
* @factory: an #AtkObjectFactory
*
* Gets the GType of the accessible which is created by the factory.
- * The value G_TYPE_INVALID is returned if no type if found.
* Returns: the type of the accessible which is created by the @factory.
+ * The value G_TYPE_INVALID is returned if no type if found.
**/
GType
atk_object_factory_get_accessible_type (AtkObjectFactory *factory)
* @column: a #gint representing a column in @table
*
* Gets a #gint representing the index at the specified @row and @column.
+ *
+ * Returns: a #gint representing the index at specified position.
* The value -1 is returned if the object at row,column is not a child
* of table or table does not implement this interface.
- *
- * Returns: a #gint representing the index at specified position
**/
gint
atk_table_get_index_at (AtkTable *table,
* @table: a GObject instance that implements AtkTableInterface
* @index_: a #gint representing an index in @table
*
- * Gets a #gint representing the row at the specified @index_, or -1
- * if the table does not implement this interface
+ * Gets a #gint representing the row at the specified @index_.
*
- * Returns: a gint representing the row at the specified index.
+ * Returns: a gint representing the row at the specified index,
+ * or -1 if the table does not implement this interface
**/
gint
atk_table_get_row_at_index (AtkTable *table,
* @table: a GObject instance that implements AtkTableInterface
* @index_: a #gint representing an index in @table
*
- * Gets a #gint representing the column at the specified @index_, or -1
- * if the table does not implement this interface
+ * Gets a #gint representing the column at the specified @index_.
*
- * Returns: a gint representing the column at the specified index.
+ * Returns: a gint representing the column at the specified index,
+ * or -1 if the table does not implement this interface
**/
gint
atk_table_get_column_at_index (AtkTable *table,
/**
* atk_focus_tracker_init:
- * @add_function: Function to be called for focus tracker initialization
+ * @init: Function to be called for focus tracker initialization
*
* Specifies the function to be called for focus tracker initialization.
* This function should be called by an implementation of the
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
<!-- ##### STRUCT AtkUtil ##### -->
<para>
The AtkObject structure should not be accessed directly.
AtkObject on which the event occurred.
</para>
-@Param1:
+@Param1: an #AtkObject
<!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
An AtkKeySnoopFunc is a function which is called when a keyboard event occurs.
</para>
-@event:
-@func_data:
-@Returns:
+@event: keyboard event
+@func_data: a data gpointer for the function
+@Returns: return code
<!-- ##### FUNCTION atk_add_key_event_listener ##### -->