/**
* atk_action_do_action:
- * @value: a GObject instance that implements AtkActionIface
- * @return: void
+ * @action: a GObject instance that implements AtkActionIface
+ * @i: a %gint indicating the action to be performed
+ *
+ * This function would be called by an application with
+ * the argument being a AtkObject object cast to (AtkAction).
+ * The function will just check that * the corresponding
+ * function pointer is not NULL and will call it.
+ * The "real" implementation of the function for accessible will be
+ * provided in a support library
+ *
**/
void
atk_action_do_action (AtkAction *obj,
/**
* atk_action_get_n_actions:
- * @value: a GObject instance that implements AtkActionIface
- * @return: a gint representing the number of actions , or 0
- * if value does not implement this interface.
+ * @action: a GObject instance that implements AtkActionIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
- * indication of whether GaccessibleActionValue is implemented, they should
- * use type checking/interface checking macros or the
- * atk_object_get_action_interface() convenience method.
+ *
+ * This function would be called by an application with
+ * the argument being a AtkObject object cast to (AtkAction).
+ * The function will just check that * the corresponding
+ * function pointer is not NULL and will call it.
+ * The "real" implementation of the function for accessible will be
+ * provided in a support library
+ *
+ * Returns a %gint representing the number of actions , or 0
+ * if value does not implement this interface.
**/
gint
atk_action_get_n_actions (AtkAction *obj)
/**
* atk_action_get_description:
- * @value: a GObject instance that implements AtkActionIface
- * @return: a #gchar representing the description, or %NULL
- * if value does not implement this interface.
+ * @action: a GObject instance that implements AtkActionIface
+ * @i: a %gint indicating the action
+ *
+ *
+ * This function would be called by an application with
+ * the argument being a AtkObject object cast to (AtkAction).
+ * The function will just check that * the corresponding
+ * function pointer is not NULL and will call it.
+ * The "real" implementation of the function for accessible will be
+ * provided in a support library
*
- * WARNING: callers should not rely on %NULL or on a zero value for
- * indication of whether GaccessibleValue is implemented, they should
- * use type checking/interface checking macros or the
- * atk_object_get_action_interface() convenience method.
+ * Returns a #gchar representing the description, or %NULL
+ * if value does not implement this interface.
**/
G_CONST_RETURN gchar*
atk_action_get_description (AtkAction *obj,
/**
* atk_action_get_keybinding:
- * @value: a GObject instance that implements AtkActionIface
- * @return: a #gchar representing the keybinding, or %NULL
+ * @action: a GObject instance that implements AtkActionIface
+ * @i: a %gint indicating the action
+ *
+ *
+ * This function would be called by an application with
+ * the argument being a AtkObject object cast to (AtkAction).
+ * The function will just check that * the corresponding
+ * function pointer is not NULL and will call it.
+ * The "real" implementation of the function for accessible will be
+ * provided in a support library
+ *
+ * Returns a #gchar representing the keybinding, or %NULL
* if there is no keybinding for this action.
*
**/
}
/**
+ *atk_component_add_focus_handler:
+ *@component: The #AtkComponent to attach the @handler to
+ *@handler: The #AtkFocusHandler to be attached to @component
*
+ * Add the specified handler to the set of functions to be called
+ * when this object receives focus (in or out) events.
+ *
+ * Returns:
**/
guint
atk_component_add_focus_handler (AtkComponent *component,
}
/**
+ *atk_component_remove_focus_handler:
+ *@component: the #AtkComponent to remove the focus handler from
+ *@handler_id: the handler id of the focus handler to be removed
+ * from @component
*
+ * Remove the handler specified by @handler_id from the list of
+ * functions to be executed when this object receives focus (in or out)
**/
void
atk_component_remove_focus_handler (AtkComponent *component,
(iface->remove_focus_handler) (component, handler_id);
}
+/**
+ *atk_component_contains:
+ *@component: the #AtkComponent
+ *@x: x coordinate relative to the coordinate system of @component
+ *@y: y coordinate relative to the coordinate system of @component
+ *
+ * Checks whether the specified point is within the extent of the @component,
+ * the points x and y coordinates are defined to be relative to the
+ * coordinate system of the @component.
+ *
+ * Returns: a #gboolean indicating whether the specified point is within
+ * the extent of the @component
+ **/
gboolean
atk_component_contains (AtkComponent *component,
gint x,
return FALSE;
}
+/**
+ *atk_component_get_accessible_at_point:
+ *@component: the #AtkComponent
+ *@x: local x coordinate
+ *@y: local y coordinate
+ *
+ * Gets the accessible child, if one exists, contained at the local
+ * coordinate point specified by @x and @y.
+ *
+ *Returns: the accessible child, if one exists, contained at the local
+ * coordinate point specified by @x and @y.
+ **/
AtkObject*
atk_component_get_accessible_at_point (AtkComponent *component,
gint x,
}
}
+/**
+ *atk_component_get_extents:
+ *@component: an #AtkComponent
+ *@x: address of #gint to put x coordinate
+ *@y: address of #gint to put y coordinate
+ *@width: address of #gint to put width
+ *@height: address of #gint to put height
+ *
+ * Gets the rectangle which gives the extent of the @component.
+ *
+ **/
void
atk_component_get_extents (AtkComponent *component,
gint *x,
(iface->get_extents) (component, x, y, width, height);
}
+/**
+ *atk_component_get_position:
+ *@component: an #AtkComponent
+ *@x: address of #gint to put x coordinate position
+ *@y: address of #gint to put y coordinate position
+ *
+ * Gets the position of @component relative to the parent in the form of
+ * a point specifying @component's top-left corner in the screen's
+ * coordinate space.
+ **/
void
atk_component_get_position (AtkComponent *component,
gint *x,
(iface->get_position) (component, x, y);
}
+/**
+ *atk_component_get_position_on_screen:
+ *@component: an #AtkComponent
+ *@x: address of #gint to put x coordinate position
+ *@y: address of #gint to put y coordinate position
+ *
+ * Gets the position of the @component on the screen
+ **/
void
atk_component_get_position_on_screen (AtkComponent *component,
gint *x,
return (iface->get_position_on_screen) (component, x, y);
}
+/**
+ *atk_component_get_size:
+ *@component: an #AtkComponent
+ *@width: address of #gint to put width of @component
+ *@height: address of #gint to put height of @component
+ *
+ * Gets the size of the @component.
+ **/
void
atk_component_get_size (AtkComponent *component,
gint *x,
(iface->get_size) (component, x, y);
}
+/**
+ *atk_component_grab_focus:
+ *@component: an #AtkComponent
+ *
+ * Grabs focus for this @component
+ **/
void
atk_component_grab_focus (AtkComponent *component)
{
(iface->grab_focus) (component);
}
+/**
+ *atk_component_set_extents:
+ *@component: an #AtkComponent
+ *@x: x coordinate to set for @component
+ *@y: y coordinate to set for @component
+ *@width: width to set for @component
+ *@height: height to set for @component
+ *
+ * Sets the extents of @component
+ **/
void
atk_component_set_extents (AtkComponent *component,
gint x,
(iface->set_extents) (component, x, y, width, height);
}
+/**
+ *atk_component_set_position:
+ *@component: an #AtkComponent
+ *@x: x coordinate
+ *@y: y coordinate
+ *
+ * Sets the postition of @component
+ **/
void
atk_component_set_position (AtkComponent *component,
gint x,
(iface->set_position) (component, x, y);
}
+/**
+ *atk_component_set_size:
+ *@component: an #AtkComponent
+ *@width: width to set for @component
+ *@height: height to set for @component
+ *
+ * Set the size of the @component
+ **/
void
atk_component_set_size (AtkComponent *component,
gint x,
}
+/**
+ *atk_editable_text_select_text:
+ *@text: an #AtkEditableText
+ *@start_pos: start position
+ *@end_pos: end position
+ *
+ *Select text between @start_pos and @end_pos
+ **/
void
atk_editable_text_select_text (AtkEditableText *text,
gint start_pos,
(*(iface->select_text)) (text, start_pos, end_pos);
}
+/**
+ *atk_editable_text_set_attributes:
+ *@text: an #AtkEditableText
+ *@start_pos: start position
+ *@end_pos: end position
+ *@attributes: a #PangoAttrList to set for @text
+ *
+ *Set attributes for text between @start_pos and @end_pos
+ **/
void
atk_editable_text_set_attributes (AtkEditableText *text,
gint start_pos,
(*(iface->set_attributes)) (text, start_pos, end_pos, attributes);
}
+/**
+ *atk_editable_text_set_text_contents:
+ *@text: an #AtkEditableText
+ *@string: string to set for text contents of @text
+ *
+ *Set text contents of @text
+ **/
void
atk_editable_text_set_text_contents (AtkEditableText *text,
const gchar *string)
(*(iface->set_text_contents)) (text, string);
}
+/**
+ *atk_editable_text_insert_text:
+ *@text: an #AtkEditableText
+ *@string: a #gchar string to insert
+ *@length: number of characters to insert @string
+ *@position: position at which to insert @string
+ *
+ *Insert @length characters of @string into text contents
+ * of @text at position @position
+ **/
void
atk_editable_text_insert_text (AtkEditableText *text,
const gchar *string,
(*(iface->insert_text)) (text, string, length, position);
}
+/**
+ *atk_editable_text_copy_text:
+ *@text: an #AtkEditableText
+ *@start_pos: start position
+ *@end_pos: end position
+ *
+ * Copy text between @start_pos and @end_pos
+ **/
void
atk_editable_text_copy_text (AtkEditableText *text,
gint start_pos,
(*(iface->copy_text)) (text, start_pos, end_pos);
}
+/**
+ *atk_editable_text_cut_text:
+ *@text: an #AtkEditableText
+ *@start_pos: start position
+ *@end_pos: end position
+ *
+ * Cut text between @start_pos and @end_pos
+ **/
void
atk_editable_text_cut_text (AtkEditableText *text,
gint start_pos,
(*(iface->cut_text)) (text, start_pos, end_pos);
}
+/**
+ *atk_editable_text_delete_text:
+ *@text: an #AtkEditableText
+ *@start_pos: start position
+ *@end_pos: end position
+ *
+ * Delete text between @start_pos and @end_pos
+ **/
void
atk_editable_text_delete_text (AtkEditableText *text,
gint start_pos,
(*(iface->delete_text)) (text, start_pos, end_pos);
}
+/**
+ *atk_editable_text_paste_text:
+ *@text: an #AtkEditableText
+ *@position: position to paste
+ *
+ * Paste text at @position
+ **/
void
atk_editable_text_paste_text (AtkEditableText *text,
gint position)
{
}
+/**
+ *atk_hyperlink_get_anchor:
+ *@link: an #AtkHyperlink
+ *@i:
+ *
+ * Returns an object which represents the link anchor, as appropriate for
+ * that link.
+ *
+ * Returns: an object which represents the link anchor, as appropriate for
+ * that link.
+ **/
GObject*
atk_hyperlink_get_anchor (AtkHyperlink *link,
gint i)
return (klass->get_anchor) (link, i);
}
+/**
+ *atk_hyperlink_get_object:
+ *@link: an #AtkHyperlink
+ *@i:
+ *
+ * Returns an object which represents the link action, as appropriate for
+ * that link.
+ *
+ * Returns: an object which represents the link action, as appropriate for
+ * that link.
+ **/
GObject*
atk_hyperlink_get_object (AtkHyperlink *link,
gint i)
return (klass->get_object) (link, i);
}
+/**
+ *atk_hyperlink_get_end_actions:
+ *@link: an #AtkHyperlink
+ *
+ *
+ **/
+//gint
+//atk_hyperlink_get_end_actions (AtkHyperlink *link)
+//{
+// AtkHyperlinkClass *klass;
+//
+// g_return_val_if_fail ((link != NULL), 0);
+// g_return_val_if_fail (ATK_IS_HYPERLINK (link), 0);
+//
+// klass = ATK_HYPERLINK_GET_CLASS (link);
+// g_return_val_if_fail ((klass->get_end_index != NULL), 0);
+//
+// return (klass->get_end_index) (link);
+//}
+
+/**
+ *atk_hyperlink_get_end_index:
+ *@link: an #AtkHyperlink
+ *
+ * Gets the index with the hypertext document at which this link ends
+ *
+ *Returns: the index with the hypertext document at which this link ends
+ **/
gint
atk_hyperlink_get_end_index (AtkHyperlink *link)
{
return (klass->get_end_index) (link);
}
+/**
+ *atk_hyperlink_get_start_index:
+ *@link: an #AtkHyperlink
+ *
+ * Gets the index with the hypertext document at which this link begins
+ *
+ *Returns: the index with the hypertext document at which this link begins
+ **/
gint
atk_hyperlink_get_start_index (AtkHyperlink *link)
{
return (klass->get_end_index) (link);
}
+/**
+ *atk_hyperlink_is_valid:
+ *@link: an #AtkHyperlink
+ *
+ * Since the document a link is associated with may have changed, this
+ * method returns whether or not this link is still valid (with respect
+ * to the document is references)
+ *
+ *Returns: whether or not this link is still valid.
+ **/
gboolean
-atk_hyperlink_get_is_valid (AtkHyperlink *link)
+atk_hyperlink_get_valid (AtkHyperlink *link)
{
AtkHyperlinkClass *klass;
*/
GObject* (* get_object) (AtkHyperlink *link,
gint i);
+ //gint (* get_end_actions) (AtkHyperlink *link);
/*
* Gets the index with the hypertext document at which this link ends
*/
gint atk_hyperlink_get_end_index (AtkHyperlink *link);
+//gint atk_hyperlink_get_end_actions (AtkHyperlink *link);
+
gint atk_hyperlink_get_start_index (AtkHyperlink *link);
gboolean atk_hyperlink_is_valid (AtkHyperlink *link);
parent_class = g_type_class_ref (ATK_TYPE_HYPERTEXT);
}
+/**
+ *atk_hypertext_get_link:
+ *@hypertext: an #AtkHypertext
+ *@link_index: the index of the link to be returned
+ *
+ * Gets the link in this hypertext document at index
+ * @link_index
+ *
+ *Returns: the link in this hypertext document at
+ * index @link_index
+ **/
AtkHyperLink*
atk_hypertext_get_link (AtkHypertext *hypertext,
gint link_index)
return NULL;
}
+/**
+ *atk_hypertext_get_n_links:
+ *@hypertext: an #AtkHypertext
+ *
+ * Gets the number of links within this hypertext document.
+ *
+ *Returns: the number of links within this hypertext document
+ **/
gint
atk_hypertext_get_n_links (AtkHypertext *hypertext)
{
return 0;
}
+/**
+ *atk_hypertext_get_link_index:
+ *@hypertext: an #AtkHypertext
+ *@char_index: a character index
+ *
+ * Gets the index into the array of hyperlinks that is associated with
+ * @char_index character index, or -1 if there is no hyperlink associated with
+ * @char_index.
+ *
+ * Returns: the index into the array of hyperlinks that is associated with
+ * @char_index character index, or -1 if there is no hyperlink associated with
+ * @char_index.
+ **/
gint
atk_hypertext_get_link_index (AtkHypertext *hypertext,
gint char_index)
/**
* atk_image_get_storage_type:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a AtkStorageType representing the image storage type
+ * @image: a GObject instance that implements AtkImageIface
*
+ * Gets the type of representation being used to store image data
* [maybe this method will be replaced, watch this space.]
*
+ * Returns: a AtkStorageType representing the image storage type
**/
AtkImageType
atk_image_get_storage_type (AtkImage *obj)
/**
* atk_image_get_image_description:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gchar* representing the image description
+ * @image: a GObject instance that implements AtkImageIface
*
* Get a textual description of this image.
+ *
+ * Returns: a gchar* representing the image description
**/
G_CONST_RETURN gchar*
atk_image_get_image_description (AtkImage *obj)
/**
* atk_image_get_image_height:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gint representing the image height in pixel coords
+ * @image: a GObject instance that implements AtkImageIface
*
* Get the height, in pixels/screen coords, of this image.
*
+ * Returns: a gint representing the image height in pixel coords
**/
gint
atk_image_get_image_height (AtkImage *obj)
/**
* atk_image_get_image_width:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gint representing the image width
+ * @image: a GObject instance that implements AtkImageIface
*
* Get the width, in pixel/screen coords, of this image.
*
+ * Returns: a gint representing the image width
**/
gint
atk_image_get_image_width (AtkImage *obj)
/**
* atk_image_set_image_description:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: boolean TRUE, or FALSE if operation could
- * not be completed.
+ * @image: a GObject instance that implements AtkImageIface
+ * @description: a #gchar desciption to set for @image
*
* Sets the textual description for this image.
*
+ * Returns: boolean TRUE, or FALSE if operation could
+ * not be completed.
**/
gboolean
atk_image_set_image_description (AtkImage *obj,
parent_class = g_type_class_ref (ATK_TYPE_OBJECT);
}
+/**
+ *atk_no_op_object_new:
+ *@obj: a #GObject
+ *
+ *Provides a default (non-functioning stub) #AtkObject.
+ *Application maintainers should not use this method.
+ *
+ *Returns: a default (non-functioning stub) #AtkObject
+ **/
AtkObject*
atk_no_op_object_new (GObject *obj)
{
class->create_accessible = atk_no_op_object_factory_create_accessible;
}
+/**
+ *atk_no_op_object_factory_new:
+ *
+ *Creates an instance of an #AtkObjectFactory which generates primitive
+ *(non-functioning) #AtkObjects.
+ *
+ *Returns: an instance of an #AtkObjectFactory
+ **/
AtkObjectFactory*
atk_no_op_object_factory_new ()
{
{
}
+/**
+ *atk_implementor_get_type:
+ *
+ *Returns: a #GType
+ **/
GType
atk_implementor_get_type (void)
{
}
/**
- * atk_object_get_name
+ * atk_object_get_name:
* @accessible: a #AtkObject
- * return values: a character string representing the accessible name of the object.
*
* Gets the accessible name of the accessible
+ *
+ * Returns: a character string representing the accessible name of the object.
**/
G_CONST_RETURN gchar*
atk_object_get_name (AtkObject *accessible)
}
/**
- * atk_object_get_description
+ * atk_object_get_description:
* @accessible: a #AtkObject
- * return values: a character string representing the accessible description of the accessible.
*
* Gets the accessible description of the accessible
+ *
+ * Returns: a character string representing the accessible description of the accessible.
+ *
**/
G_CONST_RETURN gchar*
atk_object_get_description (AtkObject *accessible)
}
/**
- * atk_object_get_parent
+ * atk_object_get_parent:
* @accessible: a #AtkObject
- * return values: a #AtkObject representing the accessible parent of the accessible.
*
* Gets the accessible description of the accessible
+ *
+ * Returns: a #AtkObject representing the accessible parent of the accessible.
**/
AtkObject*
atk_object_get_parent (AtkObject *accessible)
}
/**
- * atk_object_get_n_accessible_children
+ * atk_object_get_n_accessible_children:
* @accessible: a #AtkObject
- * return values: a gint representing the number of accessible children of the accessible.
*
* Gets the number of accessible children of the accessible
+ *
+ * Returns: a gint representing the number of accessible children of the accessible.
**/
gint
atk_object_get_n_accessible_children (AtkObject *accessible)
}
/**
- * atk_object_ref_accessible_child
+ * atk_object_ref_accessible_child:
* @accessible: a #AtkObject
* @i: a gint representing the position of the child, starting from 0
- * return values: a #AtkObject representing the specified accessible child of the accessible.
*
- * Returns a reference to the specified accessible child of the object.
+ * Gets a reference to the specified accessible child of the object.
* The accessible children are 0-based so the first accessible child is
* at index 0, the second at index 1 and so on.
+ *
+ * Returns: a #AtkObject representing the specified accessible child of the accessible.
**/
AtkObject*
atk_object_ref_accessible_child (AtkObject *accessible,
}
/**
- * atk_object_ref_accessible_child
+ * atk_object_ref_relation_set:
* @accessible: a #AtkObject
- * return values: a #AtkRelationSet representing the relation set of the object.
*
- * Returns a relation to the relation set associated of the accessible.
+ * Gets the RelationSet associated with the object
+ *
+ * Returns: a #AtkRelationSet representing the relation set of the object.
**/
AtkRelationSet*
atk_object_ref_relation_set (AtkObject *accessible)
}
/**
- * atk_role_register
+ * atk_role_register:
* @name: a character string describing the new role.
- * return values: a #AtkRole value for the new role.
*
- * Returns a #AtkRole value for the new role.
+ * Returns: a #AtkRole value for the new role.
**/
AtkRole
atk_role_register (const gchar *name)
}
/**
- * atk_object_get_role
+ * atk_object_get_role:
* @accessible: a #AtkObject
- * return values: a #AtkRole which is the role of the accessible
*
* Gets the role of the accessible
+ *
+ * Returns: a #AtkRole which is the role of the accessible
**/
AtkRole
atk_object_get_role (AtkObject *accessible) {
}
/**
- * atk_object_ref_state_set
+ * atk_object_ref_state_set:
* @accessible: a #AtkObject
- * return values: a reference to a #AtkStateSet which is the state set of the accessible
*
- * returns a reference to the state set of the accessible; the caller should
+ * Gets a reference to the state set of the accessible; the caller should
* unreference it.
+ *
+ * Returns: a reference to a #AtkStateSet which is the state set of the accessible
**/
AtkStateSet*
atk_object_ref_state_set (AtkObject *accessible) {
}
/**
- * atk_object_get_index_in_parent
+ * atk_object_get_index_in_parent:
* @accessible: a #AtkObject
- * return values: a gint which is the index of the accessible in its parent
*
* Gets the 0-based index of this accessible in its parent; returns -1 if the
* accessible does not have an accessible parent.
+ *
+ * Returns: a gint which is the index of the accessible in its parent
**/
gint
atk_object_get_index_in_parent (AtkObject *accessible)
}
/**
- * atk_object_set_name
+ * atk_object_set_name:
* @accessible: a #AtkObject
- * @name : a character string to be set as the accessible name
+ * @name: a character string to be set as the accessible name
*
* Sets the accessible name of the accessible
**/
}
/**
- * atk_object_set_description
+ * atk_object_set_description:
* @accessible: a #AtkObject
* @description : a character string to be set as the accessible description
*
}
/**
- * atk_object_set_parent
+ * atk_object_set_parent:
* @accessible: a #AtkObject
* @parent : a #AtkObject to be set as the accessible parent
*
}
/**
- * atk_object_set_role
+ * atk_object_set_role:
* @accessible: a #AtkObject
* @role : a #AtkRole to be set as the role
*
}
/**
- * atk_object_connect_property_change_handler
+ * atk_object_connect_property_change_handler:
* @accessible: a #AtkObject
* @handler : a #AtkPropertyChangeHandler, a function to be called when a property changes its value
- * return values: a guint which is the handler id used in atk_object_remove_property_change_handler
*
* Specifies a function to be called when a property changes value.
+ *
+ * Returns: a guint which is the handler id used in atk_object_remove_property_change_handler
**/
guint
atk_object_connect_property_change_handler (AtkObject *accessible,
}
/**
- * atk_object_remove_property_change_handler
+ * atk_object_remove_property_change_handler:
* @accessible: a #AtkObject
* @handler_id : a guint which identifies the handler to be removed.
*
}
/**
- * atk_implementor_ref_accessible
- * @object: The GObject instance which should implement #AtkImplementorIface
+ * atk_implementor_ref_accessible:
+ * @implementor: The GObject instance which should implement #AtkImplementorIface
* if a non-null return value is required.
- * Return a reference to an object's AtkObject implementation, if
- * the object implements AtkObjectIface.
+ *
+ * Returns a reference to an object's #AtkObject implementation, if
+ * the object implements #AtkObjectIface
+ *
+ * Returns: a reference to an object's #AtkObject implementation, if
+ * the object implements #AtkObjectIface
*/
AtkObject *
atk_implementor_ref_accessible (AtkImplementor *object)
}
-
+/**
+ *atk_object_factory_create_accessible:
+ *@factory: The #AtkObjectFactory associated with @obj's
+ *object type
+ *@obj: a #GObject
+ *
+ *Provides a #AtkObject that implements an accessability interface
+ *on behalf of @obj
+ *
+ *Returns: an #AtkObject that implements an accessability interface
+ *on behalf of @obj
+ **/
AtkObject*
atk_object_factory_create_accessible (AtkObjectFactory *factory,
GObject *obj)
return accessible;
}
+/**
+ *atk_object_factory_invalidate:
+ *@factory: an #AtkObjectFactory
+ *
+ *Inform @factory that it is no longer being used to create
+ * accessables. When called, @factory may need to inform
+ * #AtkObject's which it has created that they need to be re-instantiated.
+ * Note: primarily used for runtime replacement of #AtkObjectFactory's
+ * in object registries.
+ **/
void
atk_object_factory_invalidate (AtkObjectFactory *factory)
{
g_free (registry->factory_singleton_cache);
}
-
+/**
+ *atk_registry_set_factory_type:
+ *@registry: the #AtkRegistry in which to register the association
+ * between an #AtkObjectFactory #GType and an #AtkObject @GType
+ *@type: an #AtkObject #GType
+ *@factory_type: an #AtkObjectFactory #GType to associate with @type
+ *
+ *Associate an #AtkObjectFactory subclass with a #GType. Note:
+ * The associated @factory_type will thereafter be responsible for
+ * the creation of new #AtkObject implementations for instances
+ * of type @type.
+ **/
void
atk_registry_set_factory_type (AtkRegistry *registry,
GType type,
GUINT_TO_POINTER (factory_type));
}
+/**
+ *atk_registry_get_factory_type:
+ *@registry: an #AtkRegistry
+ *@type: a #GType with which to look up the associated #AtkObjectFactory
+ * subclass
+ *
+ *Provides a GType indicating the #AtkObjectFactory subclass
+ * associated with type @type
+ *
+ *Returns: a GType indicating the AtkObjectFactory subclass
+ * associated with type @type
+ **/
GType
atk_registry_get_factory_type (AtkRegistry *registry,
GType type)
return factory_type;
}
-
+/**
+ *atk_registry_get_factory:
+ *@registry: an #AtkRegistry
+ *@type: a #GType with which to look up the associated #AtkObjectFactory
+ *
+ *Returns an #AtkObjectFactory appropriate for creating #AtkObjects
+ * of type @type.
+ *
+ *Returns: an #AtkObjectFactory appropriate for creating #AtkObjects
+ * of type @type.
+ **/
AtkObjectFactory*
atk_registry_get_factory (AtkRegistry *registry,
GType type)
return ATK_OBJECT_FACTORY (factory_pointer);
}
-
+/**
+ *atk_get_default_registry:
+ *
+ *Return a default implementation of the #AtkObjectFactory/type
+ * registry.
+ *Note: For most toolkit maintainers, this will be the correct
+ * registry for registering new #AtkObject factories. Following
+ * a call to this function, maintainers may call atk_registry_set_factory_type()
+ * to associate an #AtkObjectFactory subclass with the GType of objects
+ * for whom accessability information will be provided.
+ *
+ *Returns: a default implementation of the #AtkObjectFactory/type
+ * registry
+ **/
AtkRegistry*
atk_get_default_registry ()
{
void atk_registry_set_factory_type (AtkRegistry *registry,
GType type,
GType factory_type);
-
+GType atk_registry_get_factory_type (AtkRegistry *registry,
+ GType type);
AtkObjectFactory* atk_registry_get_factory (AtkRegistry *registry,
GType type);
gobject_class->finalize = atk_relation_finalize;
}
+/**
+ *atk_relation_type_register:
+ *@name: a #gchar name
+ *
+ * Associate @name with a new #AtkRelationType
+ *
+ *Returns: an #AtkRelationType associated with @name
+ **/
AtkRelationType
atk_relation_type_register (const gchar *name)
{
return (++type);
}
+/**
+ *atk_relation_new:
+ *@targets: an array of pointers to #AtkObjects
+ *@n_targets: number of #AtkObjects pointed to by @targets
+ *@relationship: an #AtkRelationType with which to create the new
+ * #AtkRelation
+ *
+ * Create a new relation for the specified key and the specified list
+ * of targets.
+ *
+ * Returns: a pointer to a new #AtkRelation
+ **/
AtkRelation*
atk_relation_new (AtkObject **targets,
gint n_targets,
return relation;
}
+/**
+ *atk_relation_get_relation_type:
+ *@relation: an #AtkRelation
+ *
+ * Gets the type of @relation
+ *
+ *Returns: the type of @relation
+ **/
AtkRelationType
atk_relation_get_relation_type (AtkRelation *relation)
{
return relation->relationship;
}
+/**
+ *atk_relation_get_target:
+ *@relation: an #AtkRelation
+ *
+ * Gets the target list of @relation
+ *
+ *Returns: the target list of @relation
+ **/
GPtrArray*
atk_relation_get_target (AtkRelation *relation)
{
}
/**
- * atk_relation_set_new
- * return values: a new #AtkRelationSet
+ * atk_relation_set_new:
*
* Creates a new empty relation set.
+ *
+ * Returns: a new #AtkRelationSet
**/
AtkRelationSet*
atk_relation_set_new (void)
}
/**
- * atk_relation_set_contains
+ * atk_relation_set_contains:
* @set: a #AtkRelationSet
- * @relationtype: a #AtkRelationType
- * return values: %TRUE if @relationtype is the relationship type of a relation in @set.
+ * @relationship: a #AtkRelationType
*
* Determines whether the relation set contains a relation that matches the
* specified type.
+ *
+ * Returns: %TRUE if @relationtype is the relationship type of a relation in @set.
**/
gboolean
atk_relation_set_contains (AtkRelationSet *set,
}
/**
- * atk_relation_set_remove
+ * atk_relation_set_remove:
* @set: a #AtkRelationSet
* @relation: a #AtkRelation
*
* Removes a relation from the relation set.
- *
* This function unref's the AtkRelation so it will be deleted unless there
* is another reference to it.
**/
}
/**
- * atk_relation_set_add
+ * atk_relation_set_add:
* @set: a #AtkRelationSet
* @relation: a #AtkRelation
*
* Add a new relation to the current relation set if it is not already
* present.
- *
* This function ref's the AtkRelation so the caller of this function
* should unref it to ensure that it will be destroyed when the AtkRelationSet
* is destroyed.
}
/**
- * atk_relation_set_get_n_relations
+ * atk_relation_set_get_n_relations:
* @set: a #AtkRelationSet
- * return values: a gint representing the number of relations in the set.
*
* Determines the number of relations in a relation set.
+ *
+ * Returns: a gint representing the number of relations in the set.
**/
gint
atk_relation_set_get_n_relations (AtkRelationSet *set)
* atk_relation_set_get_relation
* @set: a #AtkRelationSet
* @i: a gint representing a position in the set, starting from 0.
- * return values: a #AtkRelation, which is the relation at position i in the set.
*
* Determines the relation at the specified position in the relation set.
+ *
+ * Returns: a #AtkRelation, which is the relation at position i in the set.
**/
AtkRelation*
atk_relation_set_get_relation (AtkRelationSet *set,
}
/**
- * atk_relation_set_get_relation_type
+ * atk_relation_set_get_relation_by_type:
* @set: a #AtkRelationSet
* @relationship: a #AtkRelationType
- * return values: a #AtkRelation, which is a relation matching the specified type.
*
* Finds a relation that matches the specified type.
+ *
+ * Returns: a #AtkRelation, which is a relation matching the specified type.
**/
AtkRelation*
atk_relation_set_get_relation_by_type (AtkRelationSet *set,
/**
* atk_selection_add_selection:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: void
+ * @selection: a GObject instance that implements AtkSelectionIface
+ * @i: a #gint specifying an accessible child of @selection
+ *
+ * Adds the specified accessible child of the object to the
+ * object's selection.
**/
void
atk_selection_add_selection (AtkSelection *obj,
/**
* atk_selection_clear_selection:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: void
+ * @selection: a GObject instance that implements AtkSelectionIface
+ *
+ * Clears the selection in the object so that no children in the object
+ * are selected.
**/
void
atk_selection_clear_selection (AtkSelection *obj)
/**
* atk_selection_ref_selection:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: a AtkObject* representing the selected accessible , or NULL
- * if value does not implement this interface.
+ * @selection: a GObject instance that implements AtkSelectionIface
+ * @i: a #gint specifying an accessible child of @selection
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets a reference to the accessible object representing the specified
+ * selected * child of the object.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
+ *
+ * Returns: a AtkObject* representing the selected accessible , or NULL
+ * if value does not implement this interface.
**/
AtkObject*
atk_selection_ref_selection (AtkSelection *obj,
/**
* atk_selection_get_selection_count:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: a gint representing the number of items selected, or 0
- * if value does not implement this interface.
+ * @selection: a GObject instance that implements AtkSelectionIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the number of accessible children currently selected.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
+ *
+ * Returns: a gint representing the number of items selected, or 0
+ * if value does not implement this interface.
**/
gint
atk_selection_get_selection_count (AtkSelection *obj)
/**
* atk_selection_is_child_selected:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: a gboolean representing the specified child is selected, or 0
- * if value does not implement this interface.
+ * @selection: a GObject instance that implements AtkSelectionIface
+ * @i: a #gint specifying an accessible child of @selection
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Determines if the current child of this object is selected
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
+ *
+ * Returns: a gboolean representing the specified child is selected, or 0
+ * if value does not implement this interface.
**/
gboolean
atk_selection_is_child_selected (AtkSelection *obj,
/**
* atk_selection_remove_selection:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: void
+ * @selection: a GObject instance that implements AtkSelectionIface
+ * @i: a #gint specifying an accessible child of @selection
+ *
+ * Removes the specified child of the object from the object's selection.
**/
void
atk_selection_remove_selection (AtkSelection *obj,
/**
* atk_selection_select_all_selection:
- * @value: a GObject instance that implements AtkSelectionIface
- * @return: void
+ * @selection: a GObject instance that implements AtkSelectionIface
+ *
+ * Causes every child of the object to be selected if the object
+ * supports multiple selections.
**/
void
atk_selection_select_all_selection (AtkSelection *obj)
};
/**
- * atk_state_type_register
+ * atk_state_type_register:
* @name: a character string describing the new state.
- * return values: a #AtkState value for the new state.
*
- * Returns a #AtkState value for the new state.
+ * Returns: a #AtkState value for the new state.
**/
AtkStateType
atk_state_type_register (const gchar *name)
}
/**
- * atk_state_type_get_name
- * @state: The #AtkStateType whose name is required
- * Return the string describing the state
+ * atk_state_type_get_name:
+ * @type: The #AtkStateType whose name is required
+ *
+ * Returns: the string describing the state
*/
G_CONST_RETURN gchar*
atk_state_type_get_name (AtkStateType state)
return NULL;
}
+/**
+ * atk_state_type_for_name:
+ * @name:
+ *
+ * Returns:
+ */
AtkStateType
atk_state_type_for_name (const gchar *name)
{
}
/**
- * atk_state_set_new
- * return values: a new #AtkStateSet
+ * atk_state_set_new:
*
* Creates a new empty state set.
+ *
+ * Returns: a new #AtkStateSet
**/
AtkStateSet*
atk_state_set_new (void)
}
/**
- * atk_state_set_is_empty
- * @type: a #AtkStateType
- * return values: %TRUE if @set has no states set
+ * atk_state_set_is_empty:
+ * @set: a #AtkStateType
*
* Checks whether the state set is empty, i.e. has no states set.
+ *
+ * Returns: %TRUE if @set has no states set
**/
gboolean
atk_state_set_is_empty (AtkStateSet *set)
}
/**
- * atk_state_set_add_state
+ * atk_state_set_add_state:
* @set: a #AtkStateSet
* @type: a #AtkStateType
- * return values: %TRUE if the state for @type is not already in @set.
*
* Add a new state for the specified type to the current state set if
* it is not already present
+ *
+ * Returns: %TRUE if the state for @type is not already in @set.
**/
gboolean
atk_state_set_add_state (AtkStateSet *set,
}
}
/**
- * atk_state_set_add_states
+ * atk_state_set_add_states:
* @set: a #AtkStateSet
* @types: a array of #AtkStateType
* @n_types: The number of elements in the array
}
/**
- * atk_state_set_clear_states
+ * atk_state_set_clear_states:
* @set: a #AtkStateSet
*
* Removes all states from the state set.
}
/**
- * atk_state_set_contains_state
+ * atk_state_set_contains_state:
* @set: a #AtkStateSet
* @type: a #AtkStateType
- * return values: %TRUE if @type is the state type is in @set.
*
* Checks whether the state for the specified type is in the specified set.
+ *
+ * Returns: %TRUE if @type is the state type is in @set.
**/
gboolean
atk_state_set_contains_state (AtkStateSet *set,
}
/**
- * atk_state_set_contains_states
+ * atk_state_set_contains_states:
* @set: a #AtkStateSet
* @types: a array of #AtkStateType
* @n_types: The number of elements in the array
- * return values: %TRUE if all the states for @type are in @set.
*
* Checks whether the states for all the specified types are in the
* specified set.
+ *
+ * Returns: %TRUE if all the states for @type are in @set.
**/
gboolean
atk_state_set_contains_states (AtkStateSet *set,
}
/**
- * atk_state_set_remove_state
+ * atk_state_set_remove_state:
* @set: a #AtkStateSet
* @type: a #AtkType
- * return values: %TRUE if @type was the state type is in @set.
*
* Removes the state for the specified type from the state set.
+ *
+ * Returns: %TRUE if @type was the state type is in @set.
**/
gboolean
atk_state_set_remove_state (AtkStateSet *set,
}
/**
- * atk_state_set_and_sets
+ * atk_state_set_and_sets:
* @set: a #AtkStateSet
* @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which is the intersection of the two sets.
*
* Constructs the intersection of the two sets, returning NULL if the
* intersection is empty.
+ *
+ * Returns: a new #AtkStateSet which is the intersection of the two sets.
**/
AtkStateSet*
atk_state_set_and_sets (AtkStateSet *set,
}
/**
- * atk_state_set_or_sets
+ * atk_state_set_or_sets:
* @set: a #AtkStateSet
* @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which is the union of the two sets.
*
* Constructs the union of the two sets.
+ *
+ * Returns: a new #AtkStateSet which is the union of the two sets.
**/
AtkStateSet*
atk_state_set_or_sets (AtkStateSet *set,
}
/**
- * atk_state_set_xor_sets
+ * atk_state_set_xor_sets:
* @set: a #AtkStateSet
* @compare_set: another #AtkStateSet
- * return values: a new #AtkStateSet which contains the states which are in exactly one of ht two sets.
*
* Constructs the xor of the two sets, returing NULL is empty. The set returned by this operation contains the4 sattes in exactly one of the two sets.
+ *
+ * Returns: a new #AtkStateSet which contains the states which are in exactly one of ht two sets.
**/
AtkStateSet*
atk_state_set_xor_sets (AtkStateSet *set,
/**
* atk_table_ref_at:
- * @obj: a GObject instance that implements AtkTableIface
- * return values: a AtkObject* representing the referred to accessible
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @column: a #gint representing a column in @table
*
- * Get a reference to the table cell at #row, #column
+ * Get a reference to the table cell at @row, @column
*
+ * Returns: a AtkObject* representing the referred to accessible
**/
AtkObject*
atk_table_ref_at (AtkTable *obj,
/**
* atk_table_get_index_at:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint representing the index at specified position, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Returns a #gint representing the index at the specified @row and @column,
+ * or 0 if value does not implement this interface.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a #gint representing the index at specified position, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_index_at (AtkTable *obj,
/**
* atk_table_get_row_at_index:
- * @value: a GObject instance that implements AtkTableInterface
- * @return: a gint representing the row at the specified index, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableInterface
+ * @index: a #gint representing an index in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Returns a #gint representing the row at the specified @index, or 0
+ * if the value does not implement this interface
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the row at the specified index, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_row_at_index (AtkTable *obj,
/**
* atk_table_get_column_at_index:
- * @value: a GObject instance that implements AtkTableInterface
- * @return: a gint representing the column at the specified index, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableInterface
+ * @index: a #gint representing an index in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Returns a #gint representing the column at the specified @index, or 0
+ * if the value does not implement this interface
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the column at the specified index, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_column_at_index (AtkTable *obj,
/**
* atk_table_get_caption:
- * @value: a GObject instance that implements AtkTableInterface
- * @return: a AtkObject* representing the table caption, or NULL
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableInterface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the caption for the @table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkObject* representing the table caption, or %NULL
+ * if value does not implement this interface.
**/
AtkObject*
atk_table_get_caption (AtkTable *obj)
/**
* atk_table_get_n_columns:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint representing the number of columns, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the number of columns in the table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the number of columns, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_n_columns (AtkTable *obj)
/**
* atk_table_get_column_description:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a AtkObject* representing the table description, or NULL
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the description text of the specified @column in the table
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkObject* representing the table description, or NULL
+ * if value does not implement this interface.
**/
AtkObject*
atk_table_get_column_description (AtkTable *obj,
/**
* atk_table_get_column_extent_at:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint representing the column extent at specified position, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the number of columns occupied by the accessible object
+ * at the specified @row and @column in the @table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the column extent at specified position, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_column_extent_at (AtkTable *obj,
/**
* atk_table_get_column_header:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a AtkObject* representing the column headers, or NULL
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the column headers of an accessible table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkObject* representing the column headers, or %NULL
+ * if value does not implement this interface.
**/
AtkTable*
atk_table_get_column_header (AtkTable *obj)
/**
* atk_table_get_n_rows:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint representing the number of rows, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the number of rows in the table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the number of rows, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_n_rows (AtkTable *obj)
/**
* atk_table_get_row_description:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a AtkObject* representing the table description, or NULL
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @r: a #gint representing a row in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the description text of the specified row in the table
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkObject* representing the table description, or %NULL
+ * if value does not implement this interface.
**/
AtkObject*
atk_table_get_row_description (AtkTable *obj,
/**
* atk_table_get_row_extent_at:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint representing the row extent at specified position, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the number of rows occupied by the accessible object
+ * at a specified @row and @column in the @table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint representing the row extent at specified position, or 0
+ * if value does not implement this interface.
**/
gint
atk_table_get_row_extent_at (AtkTable *obj,
/**
* atk_table_get_row_header:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a AtkTable* representing the row headers, or NULL
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the row headers of an accessible table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkTable* representing the row headers, or %NULL
+ * if value does not implement this interface.
**/
AtkTable*
atk_table_get_row_header (AtkTable *obj)
/**
* atk_table_get_summary:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a AtkObject* representing a sumary description of the table,
- * or NULL if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the summary description of the table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a AtkObject* representing a sumary description of the table,
+ * or %NULL if value does not implement this interface.
**/
AtkObject*
atk_table_get_summary (AtkTable *obj)
/**
* atk_table_get_selected_rows:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint* representing the selected rows,
- * or NULL if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the selected rows of the table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint* representing the selected rows,
+ * or %NULL if value does not implement this interface.
**/
gint*
atk_table_get_selected_rows (AtkTable *obj)
/**
* atk_table_get_selected_columns:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gint* representing the selected columns,
- * or NULL if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the selected columns of the table.
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gint* representing the selected columns,
+ * or %NULL if value does not implement this interface.
+ *
**/
gint*
atk_table_get_selected_columns (AtkTable *obj)
/**
* atk_table_is_column_selected:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gboolean representing the column is selected, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets a boolean value indicating whether the specified @column
+ * is selected
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gboolean representing if the column is selected, or 0
+ * if value does not implement this interface.
**/
gboolean
atk_table_is_column_selected (AtkTable *obj,
/**
* atk_table_is_row_selected:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gboolean representing the row is selected, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets a boolean value indicating whether the specified @row
+ * is selected
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gboolean representing if the row is selected, or 0
+ * if value does not implement this interface.
**/
gboolean
atk_table_is_row_selected (AtkTable *obj,
/**
* atk_table_is_selected:
- * @value: a GObject instance that implements AtkTableIface
- * @return: a gboolean representing the cell is selected, or 0
- * if value does not implement this interface.
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @column: a #gint representing a column in @table
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets a boolean value indicating whether the acessible object
+ * at the specified @row and @column is selected
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkSelectionIface is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
+ *
+ * Returns: a gboolean representing if the cell is selected, or 0
+ * if value does not implement this interface.
**/
gboolean
atk_table_is_selected (AtkTable *obj,
/**
* atk_table_set_caption:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @accessible: an #AtkObject representing the caption to set for @table
+ *
+ * Sets the caption for the table.
**/
void
atk_table_set_caption (AtkTable *obj,
/**
* atk_table_set_column_description:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @column: a #gint representing a column in @table
+ * @accessible: an #AtkObject representing the description text
+ * to set for the specified @column of the @table
+ *
+ * Sets the description text for the specified @column of the @table.
**/
void
atk_table_set_column_description (AtkTable *obj,
/**
* atk_table_set_column_header:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @column: a #gint representing a column in @table
+ * @header: an #AtkTable
+ *
+ * Sets the specified column header to @header
**/
void
atk_table_set_column_header (AtkTable *obj,
/**
* atk_table_set_row_description:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @accessible: an #AtkObject representing the description text
+ * to set for the specified @row of @table
+ *
+ * Sets the description text for the specified @row of @table.
**/
void
atk_table_set_row_description (AtkTable *obj,
/**
* atk_table_set_row_header:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @row: a #gint representing a row in @table
+ * @header: an #AtkTable
+ *
+ * Sets the specified row header to @header
**/
void
atk_table_set_row_header (AtkTable *obj,
/**
* atk_table_set_summary:
- * @value: a GObject instance that implements AtkTableIface
- * @return: void
+ * @table: a GObject instance that implements AtkTableIface
+ * @accessible: an #AtkObject representing the summary description
+ * to set for @table
+ *
+ * Sets the summary description of the table
**/
void
atk_table_set_summary (AtkTable *obj,
};
typedef struct _FocusTracker FocusTracker;
+/**
+ *atk_focus_tracker_init:
+ *@add_function: 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
+ * ATK interface if any specific work needs to be done to enable
+ * focus tracking.
+ **/
void
atk_focus_tracker_init (AtkFocusTrackerInit init)
{
focus_tracker_init = init;
}
+/**
+ *atk_add_focus_tracker:
+ *@focus_tracker: Function to be added to the list of functions to be called
+ * when an object receives focus.
+ *
+ * Adds the specified function to the list of functions to be called
+ * when an object receives focus.
+ *
+ * Returns: added focus tracker id, or 0 on failure.
+ **/
guint
atk_add_focus_tracker (AtkFocusTracker focus_tracker)
{
}
}
+/**
+ *atk_remove_focus_tracker:
+ *@tracker_id: the id of the focus tracker to remove
+ *
+ * Removes the specified focus tracker from the list of functions
+ * to be called when any object receives focus
+ *
+ **/
void
atk_remove_focus_tracker (guint tracker_id)
{
}
}
+/**
+ *atk_focus_tracker_notify:
+ *@object: an #AtkObject
+ *
+ * Cause the focus tracker functions which have been specified to be
+ * executed for the object.
+ *
+ **/
void
atk_focus_tracker_notify (AtkObject *object)
{
/**
* atk_value_get_current_value:
- * @obj@: a GObject instance that implements AtkValueIface
+ * @obj: a GObject instance that implements AtkValueIface
* @value: a #GValue representing the current accessible value
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the value of this object
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkValue is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
* @obj: a GObject instance that implements AtkValueIface
* @value: a #GValue representing the maximum accessible value
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the maximum value of this object
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkValue is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
* @obj: a GObject instance that implements AtkValueIface
* @value: a #GValue representing the minimum accessible value
*
- * WARNING: callers should not rely on %NULL or on a zero value for
+ * Gets the mimnimum value of this object
+ * Note: callers should not rely on %NULL or on a zero value for
* indication of whether AtkValue is implemented, they should
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
* atk_value_set_current_value:
* @obj: a GObject instance that implements AtkValueIface
* @value: a #GValue which is the desired new accessible value.
- * @return: %true if new value is successfully set, %false otherwise.
+ *
+ * Sets the value of this object
+ *
+ * Returns: %true if new value is successfully set, %false otherwise.
**/
gboolean
atk_value_set_current_value (AtkValue *obj,
projects / platform / upstream / atk.git / commitdiff