X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=atk%2Fatkobject.c;h=b1ecf78bf9550f884724d87f08693689313e54a9;hb=ce6359bb49c008e9b4b0c893a26042d8aa9b816a;hp=79019f69031b01f6e54d5d1bbfc552c91d2be0aa;hpb=7a56a583b968de3db888135dec1d6c73e593ad6e;p=platform%2Fupstream%2Fatk.git diff --git a/atk/atkobject.c b/atk/atkobject.c old mode 100755 new mode 100644 index 79019f6..b1ecf78 --- a/atk/atkobject.c +++ b/atk/atkobject.c @@ -17,24 +17,47 @@ * Boston, MA 02111-1307, USA. */ +#include "config.h" + #include +#include #include - -#ifdef G_OS_WIN32 -#define STRICT -#include -#undef STRICT -#undef FOCUS_EVENT /* pollutes the namespace - * like a six hundred pound gorilla */ -#endif +#include #include "atk.h" #include "atkmarshal.h" -#include "atk-enum-types.h" -#include "atkintl.h" +#include "atkprivate.h" + +/** + * SECTION:atkobject + * @Short_description: The base object class for the Accessibility Toolkit API. + * @Title:AtkObject + * + * This class is the primary class for accessibility support via the + * Accessibility ToolKit (ATK). Objects which are instances of + * #AtkObject (or instances of AtkObject-derived types) are queried + * for properties which relate basic (and generic) properties of a UI + * component such as name and description. Instances of #AtkObject + * may also be queried as to whether they implement other ATK + * interfaces (e.g. #AtkAction, #AtkComponent, etc.), as appropriate + * to the role which a given UI component plays in a user interface. + * + * All UI components in an application which provide useful + * information or services to the user must provide corresponding + * #AtkObject instances on request (in GTK+, for instance, usually on + * a call to #gtk_widget_get_accessible ()), either via ATK support + * built into the toolkit for the widget class or ancestor class, or + * in the case of custom widgets, if the inherited #AtkObject + * implementation is insufficient, via instances of a new #AtkObject + * subclass. + * + * See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also + * #GtkAccessible). + * + */ -static GPtrArray *extra_roles = NULL; +static GPtrArray *role_names = NULL; enum { @@ -69,102 +92,127 @@ enum { LAST_SIGNAL }; -typedef struct _AtkRoleItem AtkRoleItem; - -struct _AtkRoleItem -{ - AtkRole role; - gchar *name; -}; - -static AtkRoleItem role_items [] = -{ - { ATK_ROLE_INVALID, N_("invalid")}, - { ATK_ROLE_ACCEL_LABEL, N_("accelerator label")}, - { ATK_ROLE_ALERT, N_("alert")}, - { ATK_ROLE_ANIMATION, N_("animation")}, - { ATK_ROLE_ARROW, N_("arrow")}, - { ATK_ROLE_CALENDAR, N_("calendar")}, - { ATK_ROLE_CANVAS, N_("canvas")}, - { ATK_ROLE_CHECK_BOX, N_("check box")}, - { ATK_ROLE_CHECK_MENU_ITEM, N_("check menu item")}, - { ATK_ROLE_COLOR_CHOOSER, N_("color chooser")}, - { ATK_ROLE_COLUMN_HEADER, N_("column header")}, - { ATK_ROLE_COMBO_BOX, N_("combo box")}, - { ATK_ROLE_DATE_EDITOR, N_("dateeditor")}, - { ATK_ROLE_DESKTOP_ICON, N_("desktop icon")}, - { ATK_ROLE_DESKTOP_FRAME, N_("desktop frame")}, - { ATK_ROLE_DIAL, N_("dial")}, - { ATK_ROLE_DIALOG, N_("dialog")}, - { ATK_ROLE_DIRECTORY_PANE, N_("directory pane")}, - { ATK_ROLE_DRAWING_AREA, N_("drawing area")}, - { ATK_ROLE_FILE_CHOOSER, N_("file chooser")}, - { ATK_ROLE_FILLER, N_("filler")}, +/* These are listed here for extraction by intltool */ +#if 0 + N_("invalid") + N_("accelerator label") + N_("alert") + N_("animation") + N_("arrow") + N_("calendar") + N_("canvas") + N_("check box") + N_("check menu item") + N_("color chooser") + N_("column header") + N_("combo box") + N_("dateeditor") + N_("desktop icon") + N_("desktop frame") + N_("dial") + N_("dialog") + N_("directory pane") + N_("drawing area") + N_("file chooser") + N_("filler") /* I know it looks wrong but that is what Java returns */ - { ATK_ROLE_FONT_CHOOSER, N_("fontchooser")}, - { ATK_ROLE_FRAME, N_("frame")}, - { ATK_ROLE_GLASS_PANE, N_("glass pane")}, - { ATK_ROLE_HTML_CONTAINER, N_("html container")}, - { ATK_ROLE_ICON, N_("icon")}, - { ATK_ROLE_IMAGE, N_("image")}, - { ATK_ROLE_INTERNAL_FRAME, N_("internal frame")}, - { ATK_ROLE_LABEL, N_("label")}, - { ATK_ROLE_LAYERED_PANE, N_("layered pane")}, - { ATK_ROLE_LIST, N_("list")}, - { ATK_ROLE_LIST_ITEM, N_("list item")}, - { ATK_ROLE_MENU, N_("menu")}, - { ATK_ROLE_MENU_BAR, N_("menu bar")}, - { ATK_ROLE_MENU_ITEM, N_("menu item")}, - { ATK_ROLE_OPTION_PANE, N_("option pane")}, - { ATK_ROLE_PAGE_TAB, N_("page tab")}, - { ATK_ROLE_PAGE_TAB_LIST, N_("page tab list")}, - { ATK_ROLE_PANEL, N_("panel")}, - { ATK_ROLE_PASSWORD_TEXT, N_("password text")}, - { ATK_ROLE_POPUP_MENU, N_("popup menu")}, - { ATK_ROLE_PROGRESS_BAR, N_("progress bar")}, - { ATK_ROLE_PUSH_BUTTON, N_("push button")}, - { ATK_ROLE_RADIO_BUTTON, N_("radio button")}, - { ATK_ROLE_RADIO_MENU_ITEM, N_("radio menu item")}, - { ATK_ROLE_ROOT_PANE, N_("root pane")}, - { ATK_ROLE_ROW_HEADER, N_("row header")}, - { ATK_ROLE_SCROLL_BAR, N_("scroll bar")}, - { ATK_ROLE_SCROLL_PANE, N_("scroll pane")}, - { ATK_ROLE_SEPARATOR, N_("separator")}, - { ATK_ROLE_SLIDER, N_("slider")}, - { ATK_ROLE_SPLIT_PANE, N_("split pane")}, - { ATK_ROLE_SPIN_BUTTON, N_("spin button")}, - { ATK_ROLE_STATUSBAR, N_("statusbar")}, - { ATK_ROLE_TABLE, N_("table")}, - { ATK_ROLE_TABLE_CELL, N_("table cell")}, - { ATK_ROLE_TABLE_COLUMN_HEADER, N_("table column header")}, - { ATK_ROLE_TABLE_ROW_HEADER, N_("table row header")}, - { ATK_ROLE_TEAR_OFF_MENU_ITEM, N_("tear off menu item")}, - { ATK_ROLE_TERMINAL, N_("terminal")}, - { ATK_ROLE_TEXT, N_("text")}, - { ATK_ROLE_TOGGLE_BUTTON, N_("toggle button")}, - { ATK_ROLE_TOOL_BAR, N_("tool bar")}, - { ATK_ROLE_TOOL_TIP, N_("tool tip")}, - { ATK_ROLE_TREE, N_("tree")}, - { ATK_ROLE_TREE_TABLE, N_("tree table")}, - { ATK_ROLE_UNKNOWN, N_("unknown")}, - { ATK_ROLE_VIEWPORT, N_("viewport")}, - { ATK_ROLE_WINDOW, N_("window")}, - { ATK_ROLE_HEADER, N_("header")}, - { ATK_ROLE_FOOTER, N_("footer")}, - { ATK_ROLE_PARAGRAPH, N_("paragraph")}, - { ATK_ROLE_APPLICATION, N_("application")}, - { ATK_ROLE_AUTOCOMPLETE, N_("autocomplete")}, - { ATK_ROLE_EDITBAR, N_("edit bar")}, - { ATK_ROLE_EMBEDDED, N_("embedded component")}, - { ATK_ROLE_ENTRY, N_("entry")}, - { ATK_ROLE_CHART, N_("chart")}, - { ATK_ROLE_CAPTION, N_("caption")}, - { ATK_ROLE_DOCUMENT_FRAME, N_("document frame")}, - { ATK_ROLE_HEADING, N_("heading")}, - { ATK_ROLE_PAGE, N_("page")}, - { ATK_ROLE_SECTION, N_("section")}, - { ATK_ROLE_REDUNDANT_OBJECT, N_("redundant object")} -}; + N_("fontchooser") + N_("frame") + N_("glass pane") + N_("html container") + N_("icon") + N_("image") + N_("internal frame") + N_("label") + N_("layered pane") + N_("list") + N_("list item") + N_("menu") + N_("menu bar") + N_("menu item") + N_("option pane") + N_("page tab") + N_("page tab list") + N_("panel") + N_("password text") + N_("popup menu") + N_("progress bar") + N_("push button") + N_("radio button") + N_("radio menu item") + N_("root pane") + N_("row header") + N_("scroll bar") + N_("scroll pane") + N_("separator") + N_("slider") + N_("split pane") + N_("spin button") + N_("statusbar") + N_("table") + N_("table cell") + N_("table column header") + N_("table row header") + N_("tear off menu item") + N_("terminal") + N_("text") + N_("toggle button") + N_("tool bar") + N_("tool tip") + N_("tree") + N_("tree table") + N_("unknown") + N_("viewport") + N_("window") + N_("header") + N_("footer") + N_("paragraph") + N_("ruler") + N_("application") + N_("autocomplete") + N_("edit bar") + N_("embedded component") + N_("entry") + N_("chart") + N_("caption") + N_("document frame") + N_("heading") + N_("page") + N_("section") + N_("redundant object") + N_("form") + N_("link") + N_("input method window") + N_("table row") + N_("tree item") + N_("document spreadsheet") + N_("document presentation") + N_("document text") + N_("document web") + N_("document email") + N_("comment") + N_("list box") + N_("grouping") + N_("image map") + N_("notification") + N_("info bar") + N_("level bar") + N_("title bar") + N_("block quote") + N_("audio") + N_("video") + N_("definition") + N_("article") + N_("landmark") + N_("log") + N_("marquee") + N_("math") + N_("rating") + N_("timer") + N_("description list") + N_("description term") + N_("description value") +#endif /* 0 */ static void atk_object_class_init (AtkObjectClass *klass); static void atk_object_init (AtkObject *accessible, @@ -182,10 +230,8 @@ static void atk_object_real_get_property (GObject *object, GValue *value, GParamSpec *pspec); static void atk_object_finalize (GObject *object); -static G_CONST_RETURN gchar* - atk_object_real_get_name (AtkObject *object); -static G_CONST_RETURN gchar* - atk_object_real_get_description +static const gchar* atk_object_real_get_name (AtkObject *object); +static const gchar* atk_object_real_get_description (AtkObject *object); static AtkObject* atk_object_real_get_parent (AtkObject *object); static AtkRole atk_object_real_get_role (AtkObject *object); @@ -201,74 +247,58 @@ static void atk_object_real_set_parent (AtkObject *object, AtkObject *parent); static void atk_object_real_set_role (AtkObject *object, AtkRole role); -static guint atk_object_real_connect_property_change_handler - (AtkObject *obj, - AtkPropertyChangeHandler - *handler); -static void atk_object_real_remove_property_change_handler - (AtkObject *obj, - guint handler_id); static void atk_object_notify (GObject *obj, GParamSpec *pspec); - +static const gchar* atk_object_real_get_object_locale + (AtkObject *object); static guint atk_object_signals[LAST_SIGNAL] = { 0, }; static gpointer parent_class = NULL; -static const gchar* atk_object_name_property_name = "accessible-name"; -static const gchar* atk_object_name_property_description = "accessible-description"; -static const gchar* atk_object_name_property_parent = "accessible-parent"; -static const gchar* atk_object_name_property_value = "accessible-value"; -static const gchar* atk_object_name_property_role = "accessible-role"; -static const gchar* atk_object_name_property_component_layer = "accessible-component-layer"; -static const gchar* atk_object_name_property_component_mdi_zorder = "accessible-component-mdi-zorder"; -static const gchar* atk_object_name_property_table_caption = "accessible-table-caption"; -static const gchar* atk_object_name_property_table_column_description = "accessible-table-column-description"; -static const gchar* atk_object_name_property_table_column_header = "accessible-table-column-header"; -static const gchar* atk_object_name_property_table_row_description = "accessible-table-row-description"; -static const gchar* atk_object_name_property_table_row_header = "accessible-table-row-header"; -static const gchar* atk_object_name_property_table_summary = "accessible-table-summary"; -static const gchar* atk_object_name_property_table_caption_object = "accessible-table-caption-object"; -static const gchar* atk_object_name_property_hypertext_num_links = "accessible-hypertext-nlinks"; +static const gchar* const atk_object_name_property_name = "accessible-name"; +static const gchar* const atk_object_name_property_description = "accessible-description"; +static const gchar* const atk_object_name_property_parent = "accessible-parent"; +static const gchar* const atk_object_name_property_value = "accessible-value"; +static const gchar* const atk_object_name_property_role = "accessible-role"; +static const gchar* const atk_object_name_property_component_layer = "accessible-component-layer"; +static const gchar* const atk_object_name_property_component_mdi_zorder = "accessible-component-mdi-zorder"; +static const gchar* const atk_object_name_property_table_caption = "accessible-table-caption"; +static const gchar* const atk_object_name_property_table_column_description = "accessible-table-column-description"; +static const gchar* const atk_object_name_property_table_column_header = "accessible-table-column-header"; +static const gchar* const atk_object_name_property_table_row_description = "accessible-table-row-description"; +static const gchar* const atk_object_name_property_table_row_header = "accessible-table-row-header"; +static const gchar* const atk_object_name_property_table_summary = "accessible-table-summary"; +static const gchar* const atk_object_name_property_table_caption_object = "accessible-table-caption-object"; +static const gchar* const atk_object_name_property_hypertext_num_links = "accessible-hypertext-nlinks"; -#ifdef G_OS_WIN32 - -#undef ATK_LOCALEDIR - -#define ATK_LOCALEDIR get_atk_locale_dir() - -G_WIN32_DLLMAIN_FOR_DLL_NAME(static, dll_name) - -static char * -get_atk_locale_dir (void) +static void +initialize_role_names () { - return g_win32_get_package_installation_subdirectory - (GETTEXT_PACKAGE, dll_name, "lib/locale"); -} + GTypeClass *enum_class; + GEnumValue *enum_value; + int i; + gchar *role_name = NULL; -#endif + if (role_names) + return; -static void -gettext_initialization (void) -{ -#ifdef ENABLE_NLS - static gboolean gettext_initialized = FALSE; + role_names = g_ptr_array_new (); + enum_class = g_type_class_ref (ATK_TYPE_ROLE); + if (!G_IS_ENUM_CLASS(enum_class)) + return; - if (!gettext_initialized) + for (i = 0; i < ATK_ROLE_LAST_DEFINED; i++) { - const char *dir = g_getenv ("ATK_ALT_LOCALEDIR"); + enum_value = g_enum_get_value (G_ENUM_CLASS (enum_class), i); + role_name = g_strdup (enum_value->value_nick); + // We want the role names to be in the format "check button" and not "check-button" + _compact_name (role_name); + g_ptr_array_add (role_names, role_name); + } - gettext_initialized = TRUE; - if (dir == NULL) - dir = ATK_LOCALEDIR; + g_type_class_unref (enum_class); - bindtextdomain (GETTEXT_PACKAGE, dir); -#ifdef HAVE_BIND_TEXTDOMAIN_CODESET - bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8"); -#endif - } -#endif } GType @@ -323,10 +353,7 @@ atk_object_class_init (AtkObjectClass *klass) klass->set_description = atk_object_real_set_description; klass->set_parent = atk_object_real_set_parent; klass->set_role = atk_object_real_set_role; - klass->connect_property_change_handler = - atk_object_real_connect_property_change_handler; - klass->remove_property_change_handler = - atk_object_real_remove_property_change_handler; + klass->get_object_locale = atk_object_real_get_object_locale; /* * We do not define default signal handlers here @@ -337,13 +364,13 @@ atk_object_class_init (AtkObjectClass *klass) klass->visible_data_changed = NULL; klass->active_descendant_changed = NULL; - gettext_initialization (); + _gettext_initialization (); g_object_class_install_property (gobject_class, PROP_NAME, g_param_spec_string (atk_object_name_property_name, _("Accessible Name"), - _("Object instance\'s name formatted for assistive technology access"), + _("Object instance’s name formatted for assistive technology access"), NULL, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, @@ -357,9 +384,19 @@ atk_object_class_init (AtkObjectClass *klass) PROP_PARENT, g_param_spec_object (atk_object_name_property_parent, _("Accessible Parent"), - _("Is used to notify that the parent has changed"), + _("Parent of the current accessible as returned by atk_object_get_parent()"), ATK_TYPE_OBJECT, G_PARAM_READWRITE)); + + /** + * AtkObject:accessible-value: + * + * Numeric value of this object, in case being and AtkValue. + * + * Deprecated: Since 2.12. Use atk_value_get_value_and_text() to get + * the value, and value-changed signal to be notified on their value + * changes. + */ g_object_class_install_property (gobject_class, PROP_VALUE, g_param_spec_double (atk_object_name_property_value, @@ -376,7 +413,7 @@ atk_object_class_init (AtkObjectClass *klass) _("The accessible role of this object"), 0, G_MAXINT, - 0, + ATK_ROLE_UNKNOWN, G_PARAM_READWRITE)); g_object_class_install_property (gobject_class, PROP_LAYER, @@ -396,6 +433,14 @@ atk_object_class_init (AtkObjectClass *klass) G_MAXINT, G_MININT, G_PARAM_READABLE)); + + /** + * AtkObject:accessible-table-caption: + * + * Table caption. + * + * Deprecated: Since 1.3. Use table-caption-object instead. + */ g_object_class_install_property (gobject_class, PROP_TABLE_CAPTION, g_param_spec_string (atk_object_name_property_table_caption, @@ -403,6 +448,14 @@ atk_object_class_init (AtkObjectClass *klass) _("Is used to notify that the table caption has changed; this property should not be used. accessible-table-caption-object should be used instead"), NULL, G_PARAM_READWRITE)); + /** + * AtkObject:accessible-table-column-header: + * + * Accessible table column header. + * + * Deprecated: Since 2.12. Use atk_table_get_column_header() and + * atk_table_set_column_header() instead. + */ g_object_class_install_property (gobject_class, PROP_TABLE_COLUMN_HEADER, g_param_spec_object (atk_object_name_property_table_column_header, @@ -410,6 +463,15 @@ atk_object_class_init (AtkObjectClass *klass) _("Is used to notify that the table column header has changed"), ATK_TYPE_OBJECT, G_PARAM_READWRITE)); + + /** + * AtkObject:accessible-table-column-description: + * + * Accessible table column description. + * + * Deprecated: Since 2.12. Use atk_table_get_column_description() + * and atk_table_set_column_description() instead. + */ g_object_class_install_property (gobject_class, PROP_TABLE_COLUMN_DESCRIPTION, g_param_spec_string (atk_object_name_property_table_column_description, @@ -417,6 +479,15 @@ atk_object_class_init (AtkObjectClass *klass) _("Is used to notify that the table column description has changed"), NULL, G_PARAM_READWRITE)); + + /** + * AtkObject:accessible-table-row-header: + * + * Accessible table row header. + * + * Deprecated: Since 2.12. Use atk_table_get_row_header() and + * atk_table_set_row_header() instead. + */ g_object_class_install_property (gobject_class, PROP_TABLE_ROW_HEADER, g_param_spec_object (atk_object_name_property_table_row_header, @@ -424,6 +495,14 @@ atk_object_class_init (AtkObjectClass *klass) _("Is used to notify that the table row header has changed"), ATK_TYPE_OBJECT, G_PARAM_READWRITE)); + /** + * AtkObject:accessible-table-row-description: + * + * Accessible table row description. + * + * Deprecated: Since 2.12. Use atk_table_get_row_description() and + * atk_table_set_row_description() instead. + */ g_object_class_install_property (gobject_class, PROP_TABLE_ROW_DESCRIPTION, g_param_spec_string (atk_object_name_property_table_row_description, @@ -454,6 +533,22 @@ atk_object_class_init (AtkObjectClass *klass) G_MAXINT, 0, G_PARAM_READABLE)); + + /** + * AtkObject::children-changed: + * @atkobject: the object which received the signal. + * @arg1: The index of the added or removed child. The value can be + * -1. This is used if the value is not known by the implementor + * when the child is added/removed or irrelevant. + * @arg2: A gpointer to the child AtkObject which was added or + * removed. If the child was removed, it is possible that it is not + * available for the implementor. In that case this pointer can be + * NULL. + * + * The signal "children-changed" is emitted when a child is added or + * removed form an object. It supports two details: "add" and + * "remove" + */ atk_object_signals[CHILDREN_CHANGED] = g_signal_new ("children_changed", G_TYPE_FROM_CLASS (klass), @@ -463,6 +558,18 @@ atk_object_class_init (AtkObjectClass *klass) g_cclosure_marshal_VOID__UINT_POINTER, G_TYPE_NONE, 2, G_TYPE_UINT, G_TYPE_POINTER); + + /** + * AtkObject::focus-event: + * @atkobject: the object which received the signal + * @arg1: a boolean value which indicates whether the object gained + * or lost focus. + * + * The signal "focus-event" is emitted when an object gained or lost + * focus. + * + * Deprecated: 2.9.4: Use the #AtkObject::state-change signal instead. + */ atk_object_signals[FOCUS_EVENT] = g_signal_new ("focus_event", G_TYPE_FROM_CLASS (klass), @@ -472,6 +579,26 @@ atk_object_class_init (AtkObjectClass *klass) g_cclosure_marshal_VOID__BOOLEAN, G_TYPE_NONE, 1, G_TYPE_BOOLEAN); + /** + * AtkObject::property-change: + * @atkobject: the object which received the signal. + * @arg1: an #AtkPropertyValues containing the new value of the + * property which changed. + * + * The signal "property-change" is emitted when an object's property + * value changes. @arg1 contains an #AtkPropertyValues with the name + * and the new value of the property whose value has changed. Note + * that, as with GObject notify, getting this signal does not + * guarantee that the value of the property has actually changed; it + * may also be emitted when the setter of the property is called to + * reinstate the previous value. + * + * Toolkit implementor note: ATK implementors should use + * g_object_notify() to emit property-changed + * notifications. #AtkObject::property-changed is needed by the + * implementation of atk_add_global_event_listener() because GObject + * notify doesn't support emission hooks. + */ atk_object_signals[PROPERTY_CHANGE] = g_signal_new ("property_change", G_TYPE_FROM_CLASS (klass), @@ -481,6 +608,17 @@ atk_object_class_init (AtkObjectClass *klass) g_cclosure_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER); + + /** + * AtkObject::state-change: + * @atkobject: the object which received the signal. + * @arg1: The name of the state which has changed + * @arg2: A boolean which indicates whether the state has been set or unset. + * + * The "state-change" signal is emitted when an object's state + * changes. The detail value identifies the state type which has + * changed. + */ atk_object_signals[STATE_CHANGE] = g_signal_new ("state_change", G_TYPE_FROM_CLASS (klass), @@ -491,6 +629,14 @@ atk_object_class_init (AtkObjectClass *klass) G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN); + + /** + * AtkObject::visible-data-changed: + * @atkobject: the object which received the signal. + * + * The "visible-data-changed" signal is emitted when the visual + * appearance of the object changed. + */ atk_object_signals[VISIBLE_DATA_CHANGED] = g_signal_new ("visible_data_changed", G_TYPE_FROM_CLASS (klass), @@ -499,6 +645,17 @@ atk_object_class_init (AtkObjectClass *klass) (GSignalAccumulator) NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); + + /** + * AtkObject::active-descendant-changed: + * @atkobject: the object which received the signal. + * @arg1: the newly focused object. + * + * The "active-descendant-changed" signal is emitted by an object + * which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus + * object in the object changes. For instance, a table will emit the + * signal when the cell in the table which has focus changes. + */ atk_object_signals[ACTIVE_DESCENDANT_CHANGED] = g_signal_new ("active_descendant_changed", G_TYPE_FROM_CLASS (klass), @@ -549,7 +706,7 @@ atk_implementor_get_type (void) * * Returns: a character string representing the accessible name of the object. **/ -G_CONST_RETURN gchar* +const gchar* atk_object_get_name (AtkObject *accessible) { AtkObjectClass *klass; @@ -573,7 +730,7 @@ atk_object_get_name (AtkObject *accessible) * of the accessible. * **/ -G_CONST_RETURN gchar* +const gchar* atk_object_get_description (AtkObject *accessible) { AtkObjectClass *klass; @@ -591,9 +748,17 @@ atk_object_get_description (AtkObject *accessible) * atk_object_get_parent: * @accessible: an #AtkObject * - * Gets the accessible parent of the accessible. + * Gets the accessible parent of the accessible. By default this is + * the one assigned with atk_object_set_parent(), but it is assumed + * that ATK implementors have ways to get the parent of the object + * without the need of assigning it manually with + * atk_object_set_parent(), and will return it with this method. * - * Returns: a #AtkObject representing the accessible parent of the accessible + * If you are only interested on the parent assigned with + * atk_object_set_parent(), use atk_object_peek_parent(). + * + * Returns: (transfer none): an #AtkObject representing the accessible + * parent of the accessible **/ AtkObject* atk_object_get_parent (AtkObject *accessible) @@ -610,6 +775,27 @@ atk_object_get_parent (AtkObject *accessible) } /** + * atk_object_peek_parent: + * @accessible: an #AtkObject + * + * Gets the accessible parent of the accessible, if it has been + * manually assigned with atk_object_set_parent. Otherwise, this + * function returns %NULL. + * + * This method is intended as an utility for ATK implementors, and not + * to be exposed to accessible tools. See atk_object_get_parent() for + * further reference. + * + * Returns: (transfer none): an #AtkObject representing the accessible + * parent of the accessible if assigned + **/ +AtkObject* +atk_object_peek_parent (AtkObject *accessible) +{ + return accessible->accessible_parent; +} + +/** * atk_object_get_n_accessible_children: * @accessible: an #AtkObject * @@ -641,8 +827,8 @@ atk_object_get_n_accessible_children (AtkObject *accessible) * The accessible children are 0-based so the first accessible child is * at index 0, the second at index 1 and so on. * - * Returns: an #AtkObject representing the specified accessible child - * of the accessible. + * Returns: (transfer full): an #AtkObject representing the specified + * accessible child of the accessible. **/ AtkObject* atk_object_ref_accessible_child (AtkObject *accessible, @@ -665,7 +851,8 @@ atk_object_ref_accessible_child (AtkObject *accessible, * * Gets the #AtkRelationSet associated with the object. * - * Returns: an #AtkRelationSet representing the relation set of the object. + * Returns: (transfer full): an #AtkRelationSet representing the relation set + * of the object. **/ AtkRelationSet* atk_object_ref_relation_set (AtkObject *accessible) @@ -685,18 +872,38 @@ atk_object_ref_relation_set (AtkObject *accessible) * atk_role_register: * @name: a character string describing the new role. * - * Registers the role specified by @name. + * Registers the role specified by @name. @name must be a meaningful + * name. So it should not be empty, or consisting on whitespaces. * - * Returns: an #AtkRole for the new role. + * Deprecated: Since 2.12. If your application/toolkit doesn't find a + * suitable role for a specific object defined at #AtkRole, please + * submit a bug in order to add a new role to the specification. + * + * Returns: an #AtkRole for the new role if added + * properly. ATK_ROLE_INVALID in case of error. **/ AtkRole atk_role_register (const gchar *name) { - if (!extra_roles) - extra_roles = g_ptr_array_new (); + gboolean valid = FALSE; + gint i = 0; + glong length = g_utf8_strlen (name, -1); + + for (i=0; i < length; i++) { + if (name[i]!=' ') { + valid = TRUE; + break; + } + } - g_ptr_array_add (extra_roles, g_strdup (name)); - return extra_roles->len + ATK_ROLE_LAST_DEFINED; + if (!valid) + return ATK_ROLE_INVALID; + + if (!role_names) + initialize_role_names (); + + g_ptr_array_add (role_names, g_strdup (name)); + return role_names->len - 1; } /** @@ -727,9 +934,9 @@ atk_object_get_role (AtkObject *accessible) * * Gets the layer of the accessible. * - * Returns: an #AtkLayer which is the layer of the accessible + * Deprecated: Use atk_component_get_layer instead. * - * @Deprecated: Use atk_component_get_layer instead. + * Returns: an #AtkLayer which is the layer of the accessible **/ AtkLayer atk_object_get_layer (AtkObject *accessible) @@ -752,11 +959,12 @@ atk_object_get_layer (AtkObject *accessible) * Gets the zorder of the accessible. The value G_MININT will be returned * if the layer of the accessible is not ATK_LAYER_MDI. * + * Deprecated: Use atk_component_get_mdi_zorder instead. + * * Returns: a gint which is the zorder of the accessible, i.e. the depth at * which the component is shown in relation to other components in the same * container. * - * @Deprecated: Use atk_component_get_mdi_zorder instead. **/ gint atk_object_get_mdi_zorder (AtkObject *accessible) @@ -779,7 +987,7 @@ atk_object_get_mdi_zorder (AtkObject *accessible) * 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 + * Returns: (transfer full): a reference to an #AtkStateSet which is the state * set of the accessible **/ AtkStateSet* @@ -824,13 +1032,17 @@ atk_object_get_index_in_parent (AtkObject *accessible) * @accessible: an #AtkObject * @name: a character string to be set as the accessible name * - * Sets the accessible name of the accessible. + * Sets the accessible name of the accessible. You can't set the name + * to NULL. This is reserved for the initial value. In this aspect + * NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to + * a empty value you can use "". **/ void atk_object_set_name (AtkObject *accessible, const gchar *name) { AtkObjectClass *klass; + gboolean notify = FALSE; g_return_if_fail (ATK_IS_OBJECT (accessible)); g_return_if_fail (name != NULL); @@ -838,23 +1050,31 @@ atk_object_set_name (AtkObject *accessible, klass = ATK_OBJECT_GET_CLASS (accessible); if (klass->set_name) { + /* Do not notify for initial name setting. See bug 665870 */ + notify = (accessible->name != NULL); + (klass->set_name) (accessible, name); - g_object_notify (G_OBJECT (accessible), atk_object_name_property_name); + if (notify) + g_object_notify (G_OBJECT (accessible), atk_object_name_property_name); } } /** * atk_object_set_description: * @accessible: an #AtkObject - * @description : a character string to be set as the accessible description + * @description: a character string to be set as the accessible description * - * Sets the accessible description of the accessible. + * Sets the accessible description of the accessible. You can't set + * the description to NULL. This is reserved for the initial value. In + * this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set + * the name to a empty value you can use "". **/ void atk_object_set_description (AtkObject *accessible, const gchar *description) { AtkObjectClass *klass; + gboolean notify = FALSE; g_return_if_fail (ATK_IS_OBJECT (accessible)); g_return_if_fail (description != NULL); @@ -862,17 +1082,22 @@ atk_object_set_description (AtkObject *accessible, klass = ATK_OBJECT_GET_CLASS (accessible); if (klass->set_description) { + /* Do not notify for initial name setting. See bug 665870 */ + notify = (accessible->description != NULL); + (klass->set_description) (accessible, description); - g_object_notify (G_OBJECT (accessible), atk_object_name_property_description); + if (notify) + g_object_notify (G_OBJECT (accessible), + atk_object_name_property_description); } } /** * atk_object_set_parent: * @accessible: an #AtkObject - * @parent : an #AtkObject to be set as the accessible parent + * @parent: an #AtkObject to be set as the accessible parent * - * Sets the accessible parent of the accessible. + * Sets the accessible parent of the accessible. @parent can be NULL. **/ void atk_object_set_parent (AtkObject *accessible, @@ -893,7 +1118,7 @@ atk_object_set_parent (AtkObject *accessible, /** * atk_object_set_role: * @accessible: an #AtkObject - * @role : an #AtkRole to be set as the role + * @role: an #AtkRole to be set as the role * * Sets the role of the accessible. **/ @@ -923,9 +1148,10 @@ atk_object_set_role (AtkObject *accessible, /** * atk_object_connect_property_change_handler: * @accessible: an #AtkObject - * @handler : a function to be called when a property changes its value + * @handler: a function to be called when a property changes its value * - * Specifies a function to be called when a property changes value. + * Deprecated: Since 2.12. Connect directly to property-change or + * notify signals. * * Returns: a #guint which is the handler id used in * atk_object_remove_property_change_handler() @@ -949,8 +1175,10 @@ atk_object_connect_property_change_handler (AtkObject *accessible, /** * atk_object_remove_property_change_handler: * @accessible: an #AtkObject - * @handler_id : a guint which identifies the handler to be removed. - * + * @handler_id: a guint which identifies the handler to be removed. + * + * Deprecated: Since 2.12. + * * Removes a property change handler. **/ void @@ -970,16 +1198,21 @@ atk_object_remove_property_change_handler (AtkObject *accessible, * atk_object_notify_state_change: * @accessible: an #AtkObject * @state: an #AtkState whose state is changed - * @value : a gboolean which indicates whether the state is being set on or off + * @value: a gboolean which indicates whether the state is being set on or off * - * Emits a state-change signal for the specified state. + * Emits a state-change signal for the specified state. + * + * Note that as a general rule when the state of an existing object changes, + * emitting a notification is expected. **/ void atk_object_notify_state_change (AtkObject *accessible, AtkState state, gboolean value) { - G_CONST_RETURN gchar* name; + const gchar* name; + + g_return_if_fail (ATK_IS_OBJECT (accessible)); name = atk_state_type_get_name (state); g_signal_emit (accessible, atk_object_signals[STATE_CHANGE], @@ -995,20 +1228,21 @@ atk_object_notify_state_change (AtkObject *accessible, * Gets a reference to an object's #AtkObject implementation, if * the object implements #AtkObjectIface * - * Returns: a reference to an object's #AtkObject implementation + * Returns: (transfer full): a reference to an object's #AtkObject + * implementation */ AtkObject * -atk_implementor_ref_accessible (AtkImplementor *object) +atk_implementor_ref_accessible (AtkImplementor *implementor) { AtkImplementorIface *iface; AtkObject *accessible = NULL; - g_return_val_if_fail (ATK_IS_IMPLEMENTOR (object), NULL); + g_return_val_if_fail (ATK_IS_IMPLEMENTOR (implementor), NULL); - iface = ATK_IMPLEMENTOR_GET_IFACE (object); + iface = ATK_IMPLEMENTOR_GET_IFACE (implementor); if (iface != NULL) - accessible = iface->ref_accessible (object); + accessible = iface->ref_accessible (implementor); g_return_val_if_fail ((accessible != NULL), NULL); @@ -1017,11 +1251,21 @@ atk_implementor_ref_accessible (AtkImplementor *object) /** + * atk_object_get_attributes: + * @accessible: An #AtkObject. + * * Get a list of properties applied to this object as a whole, as an #AtkAttributeSet consisting of * name-value pairs. As such these attributes may be considered weakly-typed properties or annotations, * as distinct from strongly-typed object data available via other get/set methods. * Not all objects have explicit "name-value pair" #AtkAttributeSet properties. - * @Since ATK 1.12 + * + * Since: 1.12 + * + * Returns: (transfer full): an #AtkAttributeSet consisting of all + * explicit properties/annotations applied to the object, or an empty + * set if the object has no name-value pair attributes assigned to + * it. This #atkattributeset should be freed by a call to + * atk_attribute_set_free(). */ AtkAttributeSet * atk_object_get_attributes (AtkObject *accessible) @@ -1166,13 +1410,13 @@ atk_object_finalize (GObject *object) G_OBJECT_CLASS (parent_class)->finalize (object); } -static G_CONST_RETURN gchar* +static const gchar* atk_object_real_get_name (AtkObject *object) { return object->name; } -static G_CONST_RETURN gchar* +static const gchar* atk_object_real_get_description (AtkObject *object) { return object->description; @@ -1181,7 +1425,7 @@ atk_object_real_get_description (AtkObject *object) static AtkObject* atk_object_real_get_parent (AtkObject *object) { - return object->accessible_parent; + return atk_object_peek_parent (object); } static AtkRole @@ -1200,24 +1444,10 @@ static AtkStateSet* atk_object_real_ref_state_set (AtkObject *accessible) { AtkStateSet *state_set; - AtkObject *ap; AtkObject *focus_object; state_set = atk_state_set_new (); - ap = atk_object_get_parent (accessible); - if (ap) - if (ATK_IS_SELECTION (ap)) - { - int i; - - atk_state_set_add_state (state_set, ATK_STATE_SELECTABLE); - - i = atk_object_get_index_in_parent (accessible); - if (i >= 0) - if (atk_selection_is_child_selected(ATK_SELECTION (ap), i)) - atk_state_set_add_state (state_set, ATK_STATE_SELECTED); - } focus_object = atk_get_focus_object (); if (focus_object == accessible) atk_state_set_add_state (state_set, ATK_STATE_FOCUSED); @@ -1260,26 +1490,6 @@ atk_object_real_set_role (AtkObject *object, object->role = role; } -static guint -atk_object_real_connect_property_change_handler (AtkObject *obj, - AtkPropertyChangeHandler *handler) -{ - return g_signal_connect_closure_by_id (obj, - atk_object_signals[PROPERTY_CHANGE], - 0, - g_cclosure_new ( - G_CALLBACK (handler), NULL, - (GClosureNotify) NULL), - FALSE); -} - -static void -atk_object_real_remove_property_change_handler (AtkObject *obj, - guint handler_id) -{ - g_signal_handler_disconnect (obj, handler_id); -} - /** * atk_object_initialize: * @accessible: a #AtkObject @@ -1334,28 +1544,18 @@ atk_object_notify (GObject *obj, * * Returns: the string describing the AtkRole */ -G_CONST_RETURN gchar* +const gchar* atk_role_get_name (AtkRole role) { - gchar *name = NULL; - gint i; - - for (i = 0; i < G_N_ELEMENTS (role_items); i++) - { - if (role == role_items[i].role) - return role_items[i].name; - } + g_return_val_if_fail (role >= 0, NULL); - if (extra_roles) - { - gint n = role; + if (!role_names) + initialize_role_names (); - n -= ATK_ROLE_LAST_DEFINED + 1; + if (role < role_names->len) + return g_ptr_array_index (role_names, role); - if (n < extra_roles->len) - name = g_ptr_array_index (extra_roles, n); - } - return name; + return NULL; } /** @@ -1366,32 +1566,54 @@ atk_role_get_name (AtkRole role) * * Returns: the localized string describing the AtkRole **/ -G_CONST_RETURN gchar* +const gchar* atk_role_get_localized_name (AtkRole role) { - G_CONST_RETURN gchar *name; - gint i; + _gettext_initialization (); - gettext_initialization (); + return dgettext (GETTEXT_PACKAGE, atk_role_get_name (role)); +} - for (i = 0; i < G_N_ELEMENTS (role_items); i++) - { - if (role == role_items[i].role) - return dgettext (GETTEXT_PACKAGE, role_items[i].name); - } - name = atk_role_get_name (role); +static const gchar* +atk_object_real_get_object_locale (AtkObject *object) +{ + return setlocale (LC_MESSAGES, NULL); +} + +/** + * atk_object_get_object_locale: + * @accessible: an #AtkObject + * + * Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale + * of @accessible. + * + * Since: 2.8 + * + * Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES + * locale of @accessible. + **/ +const gchar* +atk_object_get_object_locale (AtkObject *accessible) +{ + AtkObjectClass *klass; + + g_return_val_if_fail (ATK_IS_OBJECT (accessible), NULL); - return name; + klass = ATK_OBJECT_GET_CLASS (accessible); + if (klass->get_object_locale) + return (klass->get_object_locale) (accessible); + else + return NULL; } + /** * atk_role_for_name: * @name: a string which is the (non-localized) name of an ATK role. * * Get the #AtkRole type corresponding to a rolew name. * - * Returns: the #AtkRole enumerated type corresponding to the specified -name, + * Returns: the #AtkRole enumerated type corresponding to the specified name, * or #ATK_ROLE_INVALID if no matching role is found. **/ AtkRole @@ -1402,28 +1624,22 @@ atk_role_for_name (const gchar *name) g_return_val_if_fail (name, ATK_ROLE_INVALID); - for (i = 0; i < G_N_ELEMENTS (role_items); i++) - { - if (strcmp (name, role_items[i].name) == 0) - return role_items[i].role; - } + if (!role_names) + initialize_role_names (); - if (extra_roles) + for (i = 0; i < role_names->len; i++) { - for (i = 0; i < extra_roles->len; i++) - { - gchar *extra_role = (gchar *)g_ptr_array_index (extra_roles, i); + gchar *role_name = (gchar *)g_ptr_array_index (role_names, i); - g_return_val_if_fail (extra_role, ATK_ROLE_INVALID); + g_return_val_if_fail (role_name, ATK_ROLE_INVALID); - if (strcmp (name, extra_role) == 0) - { - role = i + 1 + ATK_ROLE_LAST_DEFINED; - break; - } + if (strcmp (name, role_name) == 0) + { + role = i; + break; } } - + return role; } @@ -1435,7 +1651,7 @@ atk_role_for_name (const gchar *name) * * Adds a relationship of the specified type with the specified target. * - * Returns TRUE if the relationship is added. + * Returns: TRUE if the relationship is added. **/ gboolean atk_object_add_relationship (AtkObject *object, @@ -1448,6 +1664,10 @@ atk_object_add_relationship (AtkObject *object, g_return_val_if_fail (ATK_IS_OBJECT (object), FALSE); g_return_val_if_fail (ATK_IS_OBJECT (target), FALSE); + if (atk_relation_set_contains_target (object->relation_set, + relationship, target)) + return FALSE; + array[0] = target; relation = atk_relation_new (array, 1, relationship); atk_relation_set_add (object->relation_set, relation); @@ -1464,39 +1684,29 @@ atk_object_add_relationship (AtkObject *object, * * Removes a relationship of the specified type with the specified target. * - * Returns TRUE if the relationship is removed. + * Returns: TRUE if the relationship is removed. **/ gboolean atk_object_remove_relationship (AtkObject *object, AtkRelationType relationship, AtkObject *target) { - gint n_relations, i; gboolean ret = FALSE; AtkRelation *relation; + GPtrArray *array; g_return_val_if_fail (ATK_IS_OBJECT (object), FALSE); g_return_val_if_fail (ATK_IS_OBJECT (target), FALSE); - n_relations = atk_relation_set_get_n_relations (object->relation_set); - for (i = 0; i < n_relations; i++) + relation = atk_relation_set_get_relation_by_type (object->relation_set, relationship); + + if (relation) { - relation = atk_relation_set_get_relation (object->relation_set, i); - if (atk_relation_get_relation_type (relation) == relationship) - { - GPtrArray *array; - - array = atk_relation_get_target (relation); - - if (g_ptr_array_index (array, 0) == target) - { - atk_relation_set_remove (object->relation_set, relation); - ret = TRUE; - break; - } - } + ret = atk_relation_remove_target (relation, target); + array = atk_relation_get_target (relation); + if (!array || array->len == 0) + atk_relation_set_remove (object->relation_set, relation); } - return ret; }