X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=atk%2Fatkobject.h;h=b89b430c24e88384380d9ba00314f63a078e789b;hb=1bed4dd0d7eb38405278154d4351045e9e341bb1;hp=404b505f1cc5dbc404047dc800616cdb28550b80;hpb=82a1f6f8090e385ad9c61a6b4f83ca5ba9c97fd1;p=platform%2Fupstream%2Fatk.git diff --git a/atk/atkobject.h b/atk/atkobject.h index 404b505..b89b430 100755 --- a/atk/atkobject.h +++ b/atk/atkobject.h @@ -25,21 +25,13 @@ #define __ATK_OBJECT_H__ #include + +#include #include #include G_BEGIN_DECLS -/* - * AtkObject represents the minimum information all accessible objects - * return. This information includes accessible name, accessible - * 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: - */ - - /** *AtkRole: *@ATK_ROLE_INVALID: Invalid role @@ -102,7 +94,13 @@ G_BEGIN_DECLS *@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_TERMINAL: An object that represents an accessible terminal. @Since: ATK-0.6 - *@ATK_ROLE_TEXT: An object that presents text to the user + *@ATK_ROLE_TEXT: An interactive widget that supports multiple lines of text and + * optionally accepts user input, but whose purpose is not to solicit user input. + * Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor + * but inappropriate for an input field in a dialog box or web form. For widgets + * whose purpose is to solicit input from the user, see ATK_ROLE_ENTRY and + * ATK_ROLE_PASSWORD_TEXT. For generic objects which display a brief amount of + * textual information, see ATK_ROLE_STATIC. *@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 @@ -188,6 +186,41 @@ G_BEGIN_DECLS *@ATK_ROLE_TIMER: An object containing a numerical counter which * indicates an amount of elapsed time from a start point, or the time * remaining until an end point. @Since: ATK-2.12 + *@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of + * term-value groups. A term-value group represents a individual + * description and consist of one or more names + * (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values + * (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be + * more than one group with the same term name. @Since: ATK-2.12 + *@ATK_ROLE_DESCRIPTION_TERM: An object that represents the term, or + * name, part of a term-description group in a description + * list. @Since: ATK-2.12 + *@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the + * description, definition or value of a term-description group in a + * description list. The values within a group are alternatives, + * meaning that you can have several ATK_ROLE_DESCRIPTION_VALUE for a + * given ATK_ROLE_DESCRIPTION_TERM. @Since: ATK-2.12 + *@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a + * brief amount of information to the user and whose role is known by the + * implementor but lacks semantic value for the user. Examples in which + * ATK_ROLE_STATIC is appropriate include the message displayed in a message box + * and an image used as an alternative means to display text. ATK_ROLE_STATIC + * should not be applied to widgets which are traditionally interactive, objects + * which display a significant amount of content, or any object which has an + * accessible relation pointing to another object. Implementors should expose the + * displayed information through the accessible name of the object. If doing so seems + * inappropriate, it may indicate that a different role should be used. For + * labels which describe another widget, see ATK_ROLE_LABEL. For text views, see + * ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose + * role is not known by the implementor, see ATK_ROLE_UNKNOWN. @Since: ATK-2.16. + *@ATK_ROLE_MATH_FRACTION: An object that represents a mathematical fraction. + * @Since: ATK-2.16. + *@ATK_ROLE_MATH_ROOT: An object that represents a mathematical expression + * displayed with a radical. @Since: ATK-2.16. + *@ATK_ROLE_SUBSCRIPT: An object that contains text that is displayed as a + * subscript. @Since: ATK-2.16. + *@ATK_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a + * superscript. @Since: ATK-2.16. *@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration * * Describes the role of an object @@ -273,7 +306,7 @@ typedef enum ATK_ROLE_RULER, ATK_ROLE_APPLICATION, ATK_ROLE_AUTOCOMPLETE, - ATK_ROLE_EDITBAR, + ATK_ROLE_EDITBAR, /**/ ATK_ROLE_EMBEDDED, ATK_ROLE_ENTRY, ATK_ROLE_CHART, @@ -312,6 +345,14 @@ typedef enum ATK_ROLE_MATH, ATK_ROLE_RATING, ATK_ROLE_TIMER, + ATK_ROLE_DESCRIPTION_LIST, + ATK_ROLE_DESCRIPTION_TERM, + ATK_ROLE_DESCRIPTION_VALUE, + ATK_ROLE_STATIC, + ATK_ROLE_MATH_FRACTION, + ATK_ROLE_MATH_ROOT, + ATK_ROLE_SUBSCRIPT, + ATK_ROLE_SUPERSCRIPT, ATK_ROLE_LAST_DEFINED } AtkRole; @@ -403,20 +444,13 @@ typedef struct _AtkStateSet AtkStateSet; /** * AtkPropertyValues: - * @property_name: The name of the ATK property which is being presented or which has been changed. - * @old_value: The old property value, NULL; in some contexts this value is undefined (see note below). + * @property_name: The name of the ATK property which has changed. + * @old_value: NULL. This field is not used anymore. * @new_value: The new value of the named property. * - * Note: for most properties the old_value field of #AtkPropertyValues - * will not contain a valid value. - * - * Currently, the only property for which old_value is used is - * accessible-state; for instance if there is a focus state the - * property change handler will be called for the object which lost the focus - * with the old_value containing an #AtkState value corresponding to focused - * and the property change handler will be called for the object which - * received the focus with the new_value containing an #AtkState value - * corresponding to focused. + * Note: @old_value field of #AtkPropertyValues will not contain a + * valid value. This is a field defined with the purpose of contain + * the previous value of the property, but is not used anymore. * **/ struct _AtkPropertyValues @@ -460,6 +494,8 @@ typedef gboolean (*AtkFunction) (gpointer user_data); * An AtkPropertyChangeHandler is a function which is executed when an * AtkObject's property changes value. It is specified in a call to * atk_object_connect_property_change_handler(). + * + * Deprecated: Since 2.12. */ typedef void (*AtkPropertyChangeHandler) (AtkObject* obj, AtkPropertyValues* vals); @@ -479,6 +515,13 @@ struct _AtkObject /** * AtkObjectClass: + * @connect_property_change_handler: specifies a function to be called + * when a property changes value. This virtual function is + * deprecated since 2.12 and it should not be overriden. Connect + * directly to property-change or notify signal instead. + * @remove_property_change_handler: removes a property changed handler + * as returned by @connect_property_change_handler. This virtual + * function is deprecated sice 2.12 and it should not be overriden. * @focus_event: The signal handler which is executed when there is a * focus event for an object. This virtual function is deprecated * since 2.9.4 and it should not be overriden. Use @@ -619,6 +662,7 @@ void (* initialize) (AtkObject AtkFunction pad1; }; +ATK_AVAILABLE_IN_ALL GType atk_object_get_type (void); /** @@ -634,66 +678,94 @@ struct _AtkImplementorIface AtkObject* (*ref_accessible) (AtkImplementor *implementor); }; -GType atk_implementor_get_type (void); +ATK_AVAILABLE_IN_ALL +GType atk_implementor_get_type (void); +ATK_AVAILABLE_IN_ALL AtkObject* atk_implementor_ref_accessible (AtkImplementor *implementor); /* * Properties directly supported by AtkObject */ +ATK_AVAILABLE_IN_ALL const gchar* atk_object_get_name (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL const gchar* atk_object_get_description (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkObject* atk_object_get_parent (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkObject* atk_object_peek_parent (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL gint atk_object_get_n_accessible_children (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkObject* atk_object_ref_accessible_child (AtkObject *accessible, gint i); +ATK_AVAILABLE_IN_ALL AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkRole atk_object_get_role (AtkObject *accessible); -G_DEPRECATED_FOR(atk_component_get_layer) +ATK_DEPRECATED_FOR(atk_component_get_layer) AtkLayer atk_object_get_layer (AtkObject *accessible); -G_DEPRECATED_FOR(atk_component_get_mdi_zorder) +ATK_DEPRECATED_FOR(atk_component_get_mdi_zorder) gint atk_object_get_mdi_zorder (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkAttributeSet* atk_object_get_attributes (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL AtkStateSet* atk_object_ref_state_set (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL gint atk_object_get_index_in_parent (AtkObject *accessible); +ATK_AVAILABLE_IN_ALL void atk_object_set_name (AtkObject *accessible, const gchar *name); +ATK_AVAILABLE_IN_ALL void atk_object_set_description (AtkObject *accessible, const gchar *description); +ATK_AVAILABLE_IN_ALL void atk_object_set_parent (AtkObject *accessible, AtkObject *parent); +ATK_AVAILABLE_IN_ALL void atk_object_set_role (AtkObject *accessible, AtkRole role); +ATK_DEPRECATED_IN_2_12 guint atk_object_connect_property_change_handler (AtkObject *accessible, AtkPropertyChangeHandler *handler); +ATK_DEPRECATED_IN_2_12 void atk_object_remove_property_change_handler (AtkObject *accessible, guint handler_id); +ATK_AVAILABLE_IN_ALL void atk_object_notify_state_change (AtkObject *accessible, AtkState state, gboolean value); +ATK_AVAILABLE_IN_ALL void atk_object_initialize (AtkObject *accessible, gpointer data); - + +ATK_AVAILABLE_IN_ALL const gchar* atk_role_get_name (AtkRole role); +ATK_AVAILABLE_IN_ALL AtkRole atk_role_for_name (const gchar *name); /* NEW in 1.1: convenience API */ +ATK_AVAILABLE_IN_ALL gboolean atk_object_add_relationship (AtkObject *object, AtkRelationType relationship, AtkObject *target); +ATK_AVAILABLE_IN_ALL gboolean atk_object_remove_relationship (AtkObject *object, AtkRelationType relationship, AtkObject *target); +ATK_AVAILABLE_IN_ALL const gchar* atk_role_get_localized_name (AtkRole role); +ATK_DEPRECATED_IN_2_12 AtkRole atk_role_register (const gchar *name); +ATK_AVAILABLE_IN_2_8 const gchar* atk_object_get_object_locale (AtkObject *accessible); G_END_DECLS