changes to the API.
+2001-06-27 Brian Cameron <brian.cameron@sun.com>
+ *atk/atkaction.c atk/atkaction.h atk/atkcomponent.c
+ atk/atkcomponent.h atk/atkhyperlink.c atk/atkhypertext.c
+ atk/atkimage.c atk/atkimage.h atk/atkobject.c
+ atk/atkobject.h atk/atkobjectfactory.c atk/atkregistry.c
+ atk/atkstateset.c atk/atkstreamablecontent.c
+ atk/atkstreamablecontent.h atk/atktable.c
+ atk/atktext.c, docs/atk-docs.sgml docs/atk-sections.txt
+ and some docs/tmpl files.
+ Updated gtk-docs fixing spelling errors and making minor
+ changes to the API.
+
2001-06-27 Louise Miller <lousie.miller@sun.com>
*atk/atkselection.h, atk/atkselection.c
changed return type to gboolean for
/**
* atk_action_do_action:
* @action: a #GObject instance that implements AtkActionIface
- * @i: the action to be performed
+ * @i: the action index corresponding to the action to be performed
*
* Perform the specified action on the object
**/
* If there are more than one, the first one is considered the
* "default" action of the object.
*
- * Returns: a the number of actions , or 0
- * if @action does not implement this interface.
+ * Returns: a the number of actions, or 0 if @action does not
+ * implement this interface.
**/
gint
atk_action_get_n_actions (AtkAction *obj)
/**
* atk_action_get_description:
* @action: a #GObject instance that implements AtkActionIface
- * @i: a %gint indicating the action
+ * @i: the action index corresponding to the action to be performed
*
* Returns a description of the specified action of the object
*
/**
* atk_action_get_keybinding:
* @action: a #GObject instance that implements AtkActionIface
- * @i: a %gint indicating the action
+ * @i: the action index corresponding to the action to be performed
*
* Returns a keybinding associated with this action, if one exists.
*
/*
* The interface AtkAction should be supported by any object that can
* perform one or more actions. The interface provides the standard
- * mechanism for an assitive technology to determine what those actions
+ * mechanism for an assistive technology to determine what those actions
* are as well as tell the object to perform them. Any object that can
* be manipulated should support this interface.
*/
{
GTypeInterface parent;
- gboolean (*do_action) (AtkAction *action,
- gint i);
- gint (*get_n_actions) (AtkAction *action);
+ gboolean (*do_action) (AtkAction *action,
+ gint i);
+ gint (*get_n_actions) (AtkAction *action);
G_CONST_RETURN gchar* (*get_description) (AtkAction *action,
gint i);
G_CONST_RETURN gchar* (*get_keybinding) (AtkAction *action,
gint i);
-
};
+
GType atk_action_get_type ();
/*
* @x: x coordinate
* @y: y coordinate
*
- * Sets the postition of @component
+ * Sets the position of @component
**/
void
atk_component_set_position (AtkComponent *component,
{
GTypeInterface parent;
- guint (* add_focus_handler) (AtkComponent *component,
- AtkFocusHandler handler);
- gboolean (* contains) (AtkComponent *component,
+ guint (* add_focus_handler) (AtkComponent *component,
+ AtkFocusHandler handler);
+ gboolean (* contains) (AtkComponent *component,
gint x,
gint y);
gint *y,
gint *width,
gint *height);
- void (* get_position) (AtkComponent *component,
- gint *x,
- gint *y);
- void (* get_position_on_screen) (AtkComponent *component,
- gint *root_x,
- gint *root_y);
- void (* get_size) (AtkComponent *component,
- gint *width,
- gint *height);
- void (* grab_focus) (AtkComponent *component);
- void (* remove_focus_handler) (AtkComponent *component,
- guint handler_id);
- void (* set_extents) (AtkComponent *component,
- gint x,
- gint y,
- gint width,
- gint height);
- void (* set_position) (AtkComponent *component,
- gint x,
- gint y);
- void (* set_size) (AtkComponent *component,
- gint width,
- gint height);
+ void (* get_position) (AtkComponent *component,
+ gint *x,
+ gint *y);
+ void (* get_position_on_screen) (AtkComponent *component,
+ gint *root_x,
+ gint *root_y);
+ void (* get_size) (AtkComponent *component,
+ gint *width,
+ gint *height);
+ void (* grab_focus) (AtkComponent *component);
+ void (* remove_focus_handler) (AtkComponent *component,
+ guint handler_id);
+ void (* set_extents) (AtkComponent *component,
+ gint x,
+ gint y,
+ gint width,
+ gint height);
+ void (* set_position) (AtkComponent *component,
+ gint x,
+ gint y);
+ void (* set_size) (AtkComponent *component,
+ gint width,
+ gint height);
};
GType atk_component_get_type ();
* @link: an #AtkHyperlink
* @i: a (zero-index) integer specifying the desired anchor
*
- * Returns the item associated with this hyperlinks nth anchor. For instance,
- * the returned #AtkObject will implement #AtkText if @link is a text hyperlink,
- * #AtkImage if @link is an image hyperlink etc.
+ * Returns the item associated with this hyperlinks nth anchor.
+ * For instance, the returned #AtkObject will implement #AtkText
+ * if @link is a text hyperlink, #AtkImage if @link is an image
+ * hyperlink etc.
*
* Multiple anchors are primarily used by client-side image maps.
*
* 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)
+ * Since the document that a link is associated with may have changed
+ * this method returns %TRUE if the link is still valid (with
+ * respect to the document it references) and %FALSE otherwise.
*
* Returns: whether or not this link is still valid.
**/
* @char_index: a character index
*
* Gets the index into the array of hyperlinks that is associated with
- * the character specified by @cahr_index, or -1 if there is no hyperlink
+ * the character specified by @char_index, or -1 if there is no hyperlink
* associated with this character.
*
* Returns: an index into the array of hyperlinks in @hypertext
}
/**
- * atk_image_get_storage_type:
- * @image: a #GObject instance that implements AtkImageIface
- *
- * Gets the type of representation being used to store image data
- *
- * Returns: an #AtkStorageType representing the image storage type
- **/
-AtkImageType
-atk_image_get_storage_type (AtkImage *obj)
-{
- AtkImageIface *iface;
-
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
-
- iface = ATK_IMAGE_GET_IFACE (obj);
-
- if (iface->get_storage_type)
- {
- return (iface->get_storage_type) (obj);
- }
- else
- {
- return 0;
- }
-}
-
-/**
* atk_image_get_image_description:
* @image: a #GObject instance that implements AtkImageIface
*
}
/**
- * atk_image_get_image_height:
+ * atk_image_get_image_size:
* @image: a #GObject instance that implements AtkImageIface
+ * @height: filled with the image height
+ * @width: filled with the image width
*
* Get the height, in pixels/screen coords, of this image.
- *
- * Returns: an integer representing the image height in pixel coords
- **/
-gint
-atk_image_get_image_height (AtkImage *obj)
-{
- AtkImageIface *iface;
-
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
-
- iface = ATK_IMAGE_GET_IFACE (obj);
-
- if (iface->get_image_height)
- {
- return (iface->get_image_height) (obj);
- }
- else
- {
- return 0;
- }
-}
-
-/**
- * atk_image_get_image_width:
- * @image: a #GObject instance that implements AtkImageIface
- *
- * Get the width, in pixel/screen coords, of this image.
- *
- * Returns: an integer representing the image width
**/
-gint
-atk_image_get_image_width (AtkImage *obj)
+void
+atk_image_get_image_size (AtkImage *obj, int *height, int *width)
{
AtkImageIface *iface;
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
+ g_return_if_fail (obj != NULL);
+ g_return_if_fail (ATK_IS_IMAGE (obj));
iface = ATK_IMAGE_GET_IFACE (obj);
- if (iface->get_image_width)
+ if (iface->get_image_size)
{
- return (iface->get_image_width) (obj);
+ return (iface->get_image_size) (obj, height, width);
}
else
{
- return 0;
+ return;
}
}
/**
* atk_image_set_image_description:
* @image: a #GObject instance that implements AtkImageIface
- * @description: a string desciption to set for @image
+ * @description: a string description to set for @image
*
* Sets the textual description for this image.
*
#endif
typedef struct _AtkImageIface AtkImageIface;
-/**
- *AtkImageType:
- *@ATK_IMAGE_EMPTY:
- *@ATK_IMAGE_PIXMAP:
- *@ATK_IMAGE_IMAGE:
- *@ATK_IMAGE_PIXBUF:
- *@ATK_IMAGE_STOCK:
- *@ATK_IMAGE_ICON_SET:
- *
- *The representation being used to store the image data
- **/
-typedef enum
-{
- ATK_IMAGE_EMPTY,
- ATK_IMAGE_PIXMAP,
- ATK_IMAGE_IMAGE,
- ATK_IMAGE_PIXBUF,
- ATK_IMAGE_STOCK,
- ATK_IMAGE_ICON_SET
-} AtkImageType;
-
struct _AtkImageIface
{
GTypeInterface parent;
- AtkImageType (*get_storage_type) (AtkImage *image);
- G_CONST_RETURN gchar* ( *get_image_description) (AtkImage *image);
- gint ( *get_image_height) (AtkImage *image);
- gint ( *get_image_width) (AtkImage *image);
- gboolean ( *set_image_description) (AtkImage *image,
- const gchar *description);
-
+ G_CONST_RETURN gchar* ( *get_image_description) (AtkImage *image);
+ void ( *get_image_size) (AtkImage *image,
+ gint *height,
+ gint *width);
+ gboolean ( *set_image_description) (AtkImage *image,
+ const gchar *description);
};
+
GType atk_image_get_type (void);
-AtkImageType atk_image_get_storage_type (AtkImage *image);
G_CONST_RETURN gchar* atk_image_get_image_description (AtkImage *image);
-gint atk_image_get_image_height (AtkImage *image);
-
-gint atk_image_get_image_width (AtkImage *image);
+void atk_image_get_image_size (AtkImage *image,
+ gint *height,
+ gint *width);
gboolean atk_image_set_image_description (AtkImage *image,
const gchar *description);
#ifdef __cplusplus
}
#endif /* __cplusplus */
-
-
#endif /* __ATK_IMAGE_H__ */
g_object_class_install_property (gobject_class,
PROP_TABLE_COLUMN_DESCRIPTION,
g_param_spec_int (atk_object_name_property_table_column_description,
- "Accessible Table Columnn Description",
+ "Accessible Table Column Description",
"Is used to notify that the table columnscription has changed ",
0,
G_MAXINT,
* atk_object_ref_relation_set:
* @accessible: an #AtkObject
*
- * Gets the RelationSet associated with the object
+ * Gets the #AtkRelationSet associated with the object
*
* Returns: an #AtkRelationSet representing the relation set of the object.
**/
* atk_object_ref_state_set:
* @accessible: an #AtkObject
*
- * Gets a reference to the state set of the accessible; the caller should
- * unreference it.
+ * Gets a reference to the state set of the accessible; the caller must
+ * unreference it when it is no longer needed.
*
* Returns: a reference to an #AtkStateSet which is the state
* set of the accessible
*@ATK_ROLE_POPUP_MENU: A temporary window that is usually used to offer the user a list of choices, and then hides when the user selects one of those choices
*@ATK_ROLE_PROGRESS_BAR: An object used to indicate how much of a task has been completed
*@ATK_ROLE_PUSH_BUTTON: An object the user can manipulate to tell the application to do something
- *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become uncghecked when this one is checked
+ *@ATK_ROLE_RADIO_BUTTON: A specialized check box that will cause other radio buttons in the same group to become unchecked when this one is checked
*@ATK_ROLE_RADIO_MENU_ITEM: A check menu item which belongs to a group. At each instant exactly one of the radio menu items from a group is selected
*@ATK_ROLE_ROOT_PANE: A specialized pane that has a glass pane and a layered pane as its children
*@ATK_ROLE_ROW_HEADER: The header for a row of data
*@ATK_ROLE_SPLIT_PANE: A specialized panel that presents two other panels at the same time
*@ATK_ROLE_SPIN_BUTTON: An object used to get an integer or floating point number from the user
*@ATK_ROLE_STATUSBAR: An object which reports messages of minor importance to the user
- *@ATK_ROLE_TABLE: An object used to rpesent information in terms of rows and columns
+ *@ATK_ROLE_TABLE: An object used to represent information in terms of rows and columns
*@ATK_ROLE_TABLE_CELL: A cell in a table
*@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
*@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
*@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
*@ATK_ROLE_TEXT: An object that presents text to the user
- *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not procide a separate indicator for the current state
+ *@ATK_ROLE_TOGGLE_BUTTON: A specialized push button that can be checked or unchecked, but does not provide a separate indicator for the current state
*@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
*@ATK_ROLE_TOOL_TIP: An object that provides information about another object
- *@ATK_ROLE_TREE: An object used to repsent hierarchical information to the user
+ *@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
*@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
*@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
*@ATK_ROLE_WINDOW: A top level window with no title or border
* object type
* @obj: a #GObject
*
- * Provides an #AtkObject that implements an accessability interface
+ * Provides an #AtkObject that implements an accessibility interface
* on behalf of @obj
*
- * Returns: an #AtkObject that implements an accessability interface
+ * Returns: an #AtkObject that implements an accessibility interface
* on behalf of @obj
**/
AtkObject*
* @factory: an #AtkObjectFactory to invalidate
*
* Inform @factory that it is no longer being used to create
- * accessables. When called, @factory may need to inform
+ * accessibles. When called, @factory may need to inform
* #AtkObjects which it has created that they need to be re-instantiated.
* Note: primarily used for runtime replacement of #AtkObjectFactorys
* in object registries.
* atk_registry_set_factory_type:
* @registry: the #AtkRegistry in which to register the type association
* @type: an #AtkObject type
- * @factory_type: an #AtkObjectFactory type to associate with @type
+ * @factory_type: an #AtkObjectFactory type to associate with @type. Must
+ * implement AtkObject appropriate for @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.
+ * appropriate for @type.
**/
void
atk_registry_set_factory_type (AtkRegistry *registry,
* @type: a #GType with which to look up the associated #AtkObjectFactory
*
* Gets an #AtkObjectFactory appropriate for creating #AtkObjects
- * of type @type.
+ * appropriate for @type.
*
* Returns: an #AtkObjectFactory appropriate for creating #AtkObjects
- * of type @type.
+ * appropriate for @type.
**/
AtkObjectFactory*
atk_registry_get_factory (AtkRegistry *registry,
* 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.
+ * for whom accessibility information will be provided.
*
* Returns: a default implementation of the #AtkObjectFactory/type
* registry
*
* Constructs the union of the two sets.
*
- * Returns: a new #AtkStateSet which is the union of the two sets.
+ * Returns: a new #AtkStateSet which is the union of the two sets,
+ * returning %NULL is empty.
**/
AtkStateSet*
atk_state_set_or_sets (AtkStateSet *set,
* @set: an #AtkStateSet
* @compare_set: another #AtkStateSet
*
- * 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.
+ * Constructs the exclusive-or of the two sets, returning %NULL is empty.
+ * The set returned by this operation contains the states in exactly
+ * one of the two sets.
*
* Returns: a new #AtkStateSet which contains the states which are
* in exactly one of the two sets.
/**
* atk_streamable_content_get_n_mime_types:
- * @obj: a GObject instance that implements AtkStreamableContentIface
+ * @streamable: a GObject instance that implements AtkStreamableContentIface
*
* Gets the number of mime types supported by this object.
*
* Returns: a gint which is the number of mime types supported by the object.
**/
gint
-atk_streamable_content_get_n_mime_types (AtkStreamableContent *obj)
+atk_streamable_content_get_n_mime_types (AtkStreamableContent *streamable)
{
AtkStreamableContentIface *iface;
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (obj), 0);
+ g_return_val_if_fail (streamable != NULL, 0);
+ g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), 0);
- iface = ATK_STREAMABLE_CONTENT_GET_IFACE (obj);
+ iface = ATK_STREAMABLE_CONTENT_GET_IFACE (streamable);
if (iface->get_n_mime_types)
- return (iface->get_n_mime_types) (obj);
+ return (iface->get_n_mime_types) (streamable);
else
return 0;
}
/**
* atk_streamable_content_get_mime_type:
- * @obj: a GObject instance that implements AtkStreamableContent
+ * @streamable: a GObject instance that implements AtkStreamableContent
* @i: a gint representing the position of the mime type starting from 0
*
* Gets the character string of the specified mime type. The first mime
- * type is at position 0, the second at position1, and so on.
+ * type is at position 0, the second at position 1, and so on.
*
- * Returns : a gchar* respresenting the specified mime type; the caller
+ * Returns : a gchar* representing the specified mime type; the caller
* should not free the character string.
**/
G_CONST_RETURN gchar*
-atk_streamable_content_get_mime_type (AtkStreamableContent *obj,
+atk_streamable_content_get_mime_type (AtkStreamableContent *streamable,
gint i)
{
AtkStreamableContentIface *iface;
- g_return_val_if_fail (obj != NULL, NULL);
+ g_return_val_if_fail (streamable != NULL, NULL);
g_return_val_if_fail (i >= 0, NULL);
- g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (obj), NULL);
+ g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), NULL);
- iface = ATK_STREAMABLE_CONTENT_GET_IFACE (obj);
+ iface = ATK_STREAMABLE_CONTENT_GET_IFACE (streamable);
if (iface->get_mime_type)
- return (iface->get_mime_type) (obj, i);
+ return (iface->get_mime_type) (streamable, i);
else
return NULL;
}
/**
* atk_streamable_content_get_stream:
- * @obj: a GObject instance that implements AtkStreamableContentIface
+ * @streamable: a GObject instance that implements AtkStreamableContentIface
* @mime_type: a gchar* representing the mime type
*
* Gets the content in the specified mime type
* type.
**/
GIOChannel*
-atk_streamable_content_get_stream (AtkStreamableContent *obj,
+atk_streamable_content_get_stream (AtkStreamableContent *streamable,
const gchar *mime_type)
{
AtkStreamableContentIface *iface;
- g_return_val_if_fail (obj != NULL, NULL);
+ g_return_val_if_fail (streamable != NULL, NULL);
g_return_val_if_fail (mime_type != NULL, NULL);
- g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (obj), NULL);
+ g_return_val_if_fail (ATK_IS_STREAMABLE_CONTENT (streamable), NULL);
- iface = ATK_STREAMABLE_CONTENT_GET_IFACE (obj);
+ iface = ATK_STREAMABLE_CONTENT_GET_IFACE (streamable);
if (iface->get_stream)
- return (iface->get_stream) (obj, mime_type);
+ return (iface->get_stream) (streamable, mime_type);
else
return NULL;
}
gint (* get_n_mime_types) (AtkStreamableContent *streamable);
/*
* Gets the specified mime type supported by this object.
- * The mime types are 0-based so the dirst mime type is
+ * The mime types are 0-based so the first mime type is
* at index 0, the second at index 1 and so on.
*
* This assumes that the strings for the mime types are stored in the
* use type checking/interface checking macros or the
* atk_get_accessible_table() convenience method.
*
- * Returns: a AtkObject* representing a sumary description of the table,
+ * Returns: a AtkObject* representing a summary description of the table,
* or zero if value does not implement this interface.
**/
AtkObject*
* @row: a #gint representing a row in @table
* @column: a #gint representing a column in @table
*
- * Gets a boolean value indicating whether the acessible object
+ * Gets a boolean value indicating whether the accessible 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
* atk_text_get_selection:
* @text: an #AtkText
* @selection_num: The selection number. The selected regions are
- * assigned numbers that corrispond to how far the region is from the
+ * assigned numbers that correspond to how far the region is from the
* start of the text. The selected region closest to the beginning
* of the text region is assigned the number 0, etc. Note that adding,
* moving or deleting a selected region can change the numbering.
* atk_text_remove_selection:
* @text: an #AtkText
* @selection_num: The selection number. The selected regions are
- * assigned numbers that corrispond to how far the region is from the
+ * assigned numbers that correspond to how far the region is from the
* start of the text. The selected region closest to the beginning
* of the text region is assigned the number 0, etc. Note that adding,
* moving or deleting a selected region can change the numbering.
* atk_text_set_selection:
* @text: an #AtkText
* @selection_num: The selection number. The selected regions are
- * assigned numbers that corrispond to how far the region is from the
+ * assigned numbers that correspond to how far the region is from the
* start of the text. The selected region closest to the beginning
* of the text region is assigned the number 0, etc. Note that adding,
* moving or deleting a selected region can change the numbering.
<!doctype book PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
<!entity atk-AtkAction SYSTEM "sgml/atkaction.sgml">
-<!entity atk-atkcomponent SYSTEM "sgml/atkcomponent.sgml">
-<!entity atk-atkeditabletext SYSTEM "sgml/atkeditabletext.sgml">
+<!entity atk-AtkComponent SYSTEM "sgml/atkcomponent.sgml">
+<!entity atk-AtkEditabletext SYSTEM "sgml/atkeditabletext.sgml">
<!entity atk-AtkHyperlink SYSTEM "sgml/atkhyperlink.sgml">
-<!entity atk-atkhypertext SYSTEM "sgml/atkhypertext.sgml">
-<!entity atk-atkimage SYSTEM "sgml/atkimage.sgml">
+<!entity atk-AtkHypertext SYSTEM "sgml/atkhypertext.sgml">
+<!entity atk-AtkImage SYSTEM "sgml/atkimage.sgml">
<!entity atk-AtkNoOpObject SYSTEM "sgml/atknoopobject.sgml">
<!entity atk-AtkNoOpObjectFactory SYSTEM "sgml/atknoopobjectfactory.sgml">
<!entity atk-AtkObject SYSTEM "sgml/atkobject.sgml">
<!entity atk-AtkRegistry SYSTEM "sgml/atkregistry.sgml">
<!entity atk-AtkRelation SYSTEM "sgml/atkrelation.sgml">
<!entity atk-AtkRelationSet SYSTEM "sgml/atkrelationset.sgml">
-<!entity atk-atkselection SYSTEM "sgml/atkselection.sgml">
+<!entity atk-AtkSelection SYSTEM "sgml/atkselection.sgml">
+<!entity atk-AtkState SYSTEM "sgml/atkstate.sgml">
<!entity atk-AtkStateSet SYSTEM "sgml/atkstateset.sgml">
-<!entity atk-atktable SYSTEM "sgml/atktable.sgml">
-<!entity atk-atktext SYSTEM "sgml/atktext.sgml">
-<!entity atk-atkvalue SYSTEM "sgml/atkvalue.sgml">
-<!entity atk-atkstate SYSTEM "sgml/atkstate.sgml">
-<!entity atk-atkutil SYSTEM "sgml/atkutil.sgml">
+<!entity atk-AtkStreamableContent SYSTEM "sgml/atkstreamablecontent.sgml">
+<!entity atk-AtkTable SYSTEM "sgml/atktable.sgml">
+<!entity atk-AtkText SYSTEM "sgml/atktext.sgml">
+<!entity atk-AtkUtil SYSTEM "sgml/atkutil.sgml">
+<!entity atk-AtkValue SYSTEM "sgml/atkvalue.sgml">
]>
<book>
<chapter id="atk">
<title>ATK Library</title>
&atk-AtkAction;
- &atk-atkcomponent;
- &atk-atkeditabletext;
+ &atk-AtkComponent;
+ &atk-AtkEditabletext;
&atk-AtkHyperlink;
- &atk-atkhypertext;
- &atk-atkimage;
+ &atk-AtkHypertext;
+ &atk-AtkImage;
&atk-AtkNoOpObject;
&atk-AtkNoOpObjectFactory;
&atk-AtkObject;
&atk-AtkRegistry;
&atk-AtkRelation;
&atk-AtkRelationSet;
- &atk-atkselection;
+ &atk-AtkSelection;
+ &atk-AtkState;
&atk-AtkStateSet;
- &atk-atktable;
- &atk-atktext;
- &atk-atkvalue;
- &atk-atkstate;
- &atk-atkutil;
+ &atk-AtkStreamableContent;
+ &atk-AtkTable;
+ &atk-AtkText;
+ &atk-AtkUtil;
+ &atk-AtkValue;
</chapter>
</book>
<TITLE>AtkComponent</TITLE>
AtkComponent
AtkComponentIface
-AtkFocusHandler
atk_component_add_focus_handler
atk_component_contains
atk_component_get_accessible_at_point
ATK_IS_COMPONENT
ATK_TYPE_COMPONENT
ATK_COMPONENT_GET_IFACE
+AtkFocusHandler
atk_component_get_type
</SECTION>
<TITLE>AtkImage</TITLE>
AtkImage
AtkImageIface
-AtkImageType
-atk_image_get_storage_type
atk_image_get_image_description
-atk_image_get_image_height
-atk_image_get_image_width
+atk_image_get_image_size
atk_image_set_image_description
<SUBSECTION Standard>
ATK_IMAGE
AtkTableIface
atk_table_ref_at
atk_table_get_index_at
-atk_table_get_row_at_index
atk_table_get_column_at_index
-atk_table_get_caption
+atk_table_get_row_at_index
atk_table_get_n_columns
-atk_table_get_column_description
-atk_table_get_column_extent_at
-atk_table_get_column_header
atk_table_get_n_rows
-atk_table_get_row_description
+atk_table_get_column_extent_at
atk_table_get_row_extent_at
+atk_table_get_caption
+atk_table_get_column_description
+atk_table_get_row_description
+atk_table_get_column_header
atk_table_get_row_header
atk_table_get_summary
+atk_table_set_caption
+atk_table_set_row_description
+atk_table_set_column_description
+atk_table_set_row_header
+atk_table_set_column_header
+atk_table_set_summary
atk_table_get_selected_columns
atk_table_get_selected_rows
atk_table_is_column_selected
atk_table_is_row_selected
atk_table_is_selected
-atk_table_add_row_selection
-atk_table_remove_row_selection
atk_table_add_column_selection
+atk_table_add_row_selection
atk_table_remove_column_selection
-atk_table_set_caption
-atk_table_set_column_description
-atk_table_set_column_header
-atk_table_set_row_description
-atk_table_set_row_header
-atk_table_set_summary
+atk_table_remove_row_selection
<SUBSECTION Standard>
ATK_TABLE
ATK_IS_TABLE
</SECTION>
<SECTION>
+<FILE>atkstreamablecontent</FILE>
+<TITLE>AtkStreamableContent</TITLE>
+atk_streamable_content_get_n_mime_types
+atk_streamable_content_get_mime_type
+atk_streamable_content_get_stream
+<SUBSECTION Standard>
+atk_streamable_content_get_type
+</SECTION>
+
+<SECTION>
<FILE>atkutil</FILE>
<TITLE>AtkUtil</TITLE>
atk_add_focus_tracker
atk
+<!-- ##### USER_FUNCTION AtkFocusHandler ##### -->
+<para>
+
+</para>
+
+@Param1:
+@Param2:
+
+<!-- ##### ENUM AtkImageType ##### -->
+<para>
+
+</para>
+
+@ATK_IMAGE_EMPTY:
+@ATK_IMAGE_PIXMAP:
+@ATK_IMAGE_IMAGE:
+@ATK_IMAGE_PIXBUF:
+@ATK_IMAGE_STOCK:
+@ATK_IMAGE_ICON_SET:
+
<!-- ##### FUNCTION atk_editable_text_select_text ##### -->
<para>
@end_pos:
@attributes:
+<!-- ##### FUNCTION atk_image_get_image_height ##### -->
+<para>
+
+</para>
+
+@image:
+@Returns:
+
+<!-- ##### FUNCTION atk_image_get_image_width ##### -->
+<para>
+
+</para>
+
+@image:
+@Returns:
+
+<!-- ##### FUNCTION atk_image_get_storage_type ##### -->
+<para>
+
+</para>
+
+@image:
+@Returns:
+
+<!-- ##### FUNCTION atk_streamable_content_get_type ##### -->
+<para>
+
+</para>
+
+@Returns:
+
<!-- ##### FUNCTION atk_text_get_range_attributes ##### -->
<para>
<para>
The interface AtkAction should be supported by any object that can
perform one or more actions. The interface provides the standard
-mechanism for an assitive technology to determine what those actions
+mechanism for an assistive technology to determine what those actions
are as well as tell the object to perform them. Any object that can
be manipulated should support this interface.
</para>
@set_position:
@set_size:
-<!-- ##### USER_FUNCTION AtkFocusHandler ##### -->
-<para>
-
-</para>
-
-@Param1:
-@Param2:
-
-
<!-- ##### FUNCTION atk_component_add_focus_handler ##### -->
<para>
</para>
@parent:
-@get_storage_type:
@get_image_description:
-@get_image_height:
-@get_image_width:
+@get_image_size:
@set_image_description:
-<!-- ##### ENUM AtkImageType ##### -->
-<para>
-
-</para>
-
-@ATK_IMAGE_EMPTY:
-@ATK_IMAGE_PIXMAP:
-@ATK_IMAGE_IMAGE:
-@ATK_IMAGE_PIXBUF:
-@ATK_IMAGE_STOCK:
-@ATK_IMAGE_ICON_SET:
-
-<!-- ##### FUNCTION atk_image_get_storage_type ##### -->
-<para>
-
-</para>
-
-@image:
-@Returns:
-
-
<!-- ##### FUNCTION atk_image_get_image_description ##### -->
<para>
@Returns:
-<!-- ##### FUNCTION atk_image_get_image_height ##### -->
+<!-- ##### FUNCTION atk_image_get_image_size ##### -->
<para>
</para>
@image:
-@Returns:
-
-
-<!-- ##### FUNCTION atk_image_get_image_width ##### -->
-<para>
-
-</para>
-
-@image:
-@Returns:
+@height:
+@width:
<!-- ##### FUNCTION atk_image_set_image_description ##### -->
AtkObject
<!-- ##### SECTION Short_Description ##### -->
-represents the minimum information all accessable objects return
+represents the minimum information all accessible objects return
<!-- ##### SECTION Long_Description ##### -->
<para>
description, role and state of the object, as well information about
its parent and children. It is also possible to obtain more specific
accessibility information about a component if it supports one or more
-of the following interfaces:
+of the other ATK interfaces:
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### SECTION Title ##### -->
-atkselection
+AtkSelection
<!-- ##### SECTION Short_Description ##### -->
accessibility interface for determining what the current selected
<!-- ##### SECTION Long_Description ##### -->
<para>
-This AtkSelection interface provides the standard mechanism for an
+The AtkSelection interface provides the standard mechanism for an
assistive technology to determine what the current selected children are,
as well as modify the selection set. Any object that has children that
can be selected should support the AtkSelection interface.
@Returns:
-<!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
+<!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_get_column_at_index ##### -->
+<!-- ##### FUNCTION atk_table_get_row_at_index ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_get_caption ##### -->
+<!-- ##### FUNCTION atk_table_get_n_columns ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_get_n_columns ##### -->
+<!-- ##### FUNCTION atk_table_get_n_rows ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_get_column_description ##### -->
+<!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
<para>
</para>
@table:
+@row:
@column:
@Returns:
-<!-- ##### FUNCTION atk_table_get_column_extent_at ##### -->
+<!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_get_column_header ##### -->
+<!-- ##### FUNCTION atk_table_get_caption ##### -->
<para>
</para>
@table:
-@column:
@Returns:
-<!-- ##### FUNCTION atk_table_get_n_rows ##### -->
+<!-- ##### FUNCTION atk_table_get_column_description ##### -->
<para>
</para>
@table:
+@column:
@Returns:
@Returns:
-<!-- ##### FUNCTION atk_table_get_row_extent_at ##### -->
+<!-- ##### FUNCTION atk_table_get_column_header ##### -->
<para>
</para>
@table:
-@row:
@column:
@Returns:
@Returns:
-<!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
+<!-- ##### FUNCTION atk_table_set_caption ##### -->
<para>
</para>
@table:
-@selected:
-@Returns:
+@caption:
+<!-- # Unused Parameters # -->
+@accessible:
-<!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
+<!-- ##### FUNCTION atk_table_set_row_description ##### -->
<para>
</para>
@table:
-@selected:
-@Returns:
+@row:
+@description:
+<!-- # Unused Parameters # -->
+@accessible:
-<!-- ##### FUNCTION atk_table_is_column_selected ##### -->
+<!-- ##### FUNCTION atk_table_set_column_description ##### -->
<para>
</para>
@table:
@column:
-@Returns:
+@description:
+<!-- # Unused Parameters # -->
+@accessible:
-<!-- ##### FUNCTION atk_table_is_row_selected ##### -->
+<!-- ##### FUNCTION atk_table_set_row_header ##### -->
<para>
</para>
@table:
@row:
-@Returns:
+@header:
-<!-- ##### FUNCTION atk_table_is_selected ##### -->
+<!-- ##### FUNCTION atk_table_set_column_header ##### -->
<para>
</para>
@table:
-@row:
@column:
-@Returns:
+@header:
-<!-- ##### FUNCTION atk_table_add_row_selection ##### -->
+<!-- ##### FUNCTION atk_table_set_summary ##### -->
<para>
</para>
@table:
-@row:
-@Returns:
+@accessible:
-<!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
+<!-- ##### FUNCTION atk_table_get_selected_columns ##### -->
<para>
</para>
@table:
-@row:
+@selected:
@Returns:
-<!-- ##### FUNCTION atk_table_add_column_selection ##### -->
+<!-- ##### FUNCTION atk_table_get_selected_rows ##### -->
<para>
</para>
@table:
-@column:
+@selected:
@Returns:
-<!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
+<!-- ##### FUNCTION atk_table_is_column_selected ##### -->
<para>
</para>
@Returns:
-<!-- ##### FUNCTION atk_table_set_caption ##### -->
+<!-- ##### FUNCTION atk_table_is_row_selected ##### -->
<para>
</para>
@table:
-@caption:
-<!-- # Unused Parameters # -->
-@accessible:
+@row:
+@Returns:
-<!-- ##### FUNCTION atk_table_set_column_description ##### -->
+<!-- ##### FUNCTION atk_table_is_selected ##### -->
<para>
</para>
@table:
+@row:
@column:
-@description:
-<!-- # Unused Parameters # -->
-@accessible:
+@Returns:
-<!-- ##### FUNCTION atk_table_set_column_header ##### -->
+<!-- ##### FUNCTION atk_table_add_column_selection ##### -->
<para>
</para>
@table:
@column:
-@header:
+@Returns:
-<!-- ##### FUNCTION atk_table_set_row_description ##### -->
+<!-- ##### FUNCTION atk_table_add_row_selection ##### -->
<para>
</para>
@table:
@row:
-@description:
-<!-- # Unused Parameters # -->
-@accessible:
+@Returns:
-<!-- ##### FUNCTION atk_table_set_row_header ##### -->
+<!-- ##### FUNCTION atk_table_remove_column_selection ##### -->
<para>
</para>
@table:
-@row:
-@header:
+@column:
+@Returns:
-<!-- ##### FUNCTION atk_table_set_summary ##### -->
+<!-- ##### FUNCTION atk_table_remove_row_selection ##### -->
<para>
</para>
@table:
-@accessible:
+@row:
+@Returns:
AtkUtil
<!-- ##### SECTION Short_Description ##### -->
-
+general purpose utility class
<!-- ##### SECTION Long_Description ##### -->
<para>
+The AtkUtility interface provides general purpose utility functions.
</para>
<!-- ##### SECTION See_Also ##### -->
projects / platform / upstream / atk.git / commitdiff