![]() |
![]() |
This class is the primary class for accessibility support via the Accessibility ToolKit (ATK). Objects which are instances of Atk::Object (or instances of Atk::Object-derived types) are queried for properties which relate basic (and generic) properties of a UI component such as name and description. Instances of Atk::Object may also be queried as to whether they implement other ATK interfaces (e.g. Atk::Action, Atk::Component, 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 Atk::Object 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 Atk::Object implementation is insufficient, via instances of a new Atk::Object subclass.
Public Member Functions | |
bool | add_relationship (RelationType relationship, const Glib::RefPtr<Object>& target) |
Adds a relationship of the specified type with the specified target. | |
Glib::RefPtr<Atk::Object> | get_accessible_child (int i) |
Gets a reference to the specified accessible child of the object. | |
Glib::ustring | get_description () const |
Gets the accessible description of the accessible. | |
int | get_index_in_parent () |
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent. | |
int | get_n_accessible_children () const |
Gets the number of accessible children of the accessible. | |
Glib::ustring | get_name () const |
Gets the accessible name of the accessible. | |
Glib::RefPtr<Atk::Object> | get_parent () |
Gets the accessible parent of the accessible. | |
Glib::RefPtr<RelationSet> | get_relation_set () |
Gets the Atk::RelationSet associated with the object. | |
Role | get_role () const |
Gets the role of the accessible. | |
Glib::RefPtr<StateSet> | get_state_set () |
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed. | |
const AtkObject* | gobj () const |
Provides access to the underlying C GObject. | |
AtkObject* | gobj () |
Provides access to the underlying C GObject. | |
AtkObject* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | notify_state_change (State state, bool value) |
Emits a state-change signal for the specified state. | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_component_layer () const |
The accessible layer of this object. | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_component_mdi_zorder () const |
The accessible MDI value of this object. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_description () const |
Description of an object. | |
Glib::PropertyProxy<Glib::ustring> | property_accessible_description () |
Description of an object. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_name () const |
Object instance's name formatted for assistive technology access. | |
Glib::PropertyProxy<Glib::ustring> | property_accessible_name () |
Object instance's name formatted for assistive technology access. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Atk::Object >> | property_accessible_parent () const |
Is used to notify that the parent has changed. | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_parent () |
Is used to notify that the parent has changed. | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_role () const |
The accessible role of this object. | |
Glib::PropertyProxy<int> | property_accessible_role () |
The accessible role of this object. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_table_caption () const |
Is used to notify that the table caption has changed; this property should not be used. | |
Glib::PropertyProxy<Glib::ustring> | property_accessible_table_caption () |
Is used to notify that the table caption has changed; this property should not be used. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_table_column_description () const |
Is used to notify that the table column description has changed. | |
Glib::PropertyProxy<Glib::ustring> | property_accessible_table_column_description () |
Is used to notify that the table column description has changed. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Atk::Object >> | property_accessible_table_column_header () const |
Is used to notify that the table column header has changed. | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_column_header () |
Is used to notify that the table column header has changed. | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_table_row_description () const |
Is used to notify that the table row description has changed. | |
Glib::PropertyProxy<Glib::ustring> | property_accessible_table_row_description () |
Is used to notify that the table row description has changed. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Atk::Object >> | property_accessible_table_row_header () const |
Is used to notify that the table row header has changed. | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_row_header () |
Is used to notify that the table row header has changed. | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Atk::Object >> | property_accessible_table_summary () const |
Is used to notify that the table summary has changed. | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_summary () |
Is used to notify that the table summary has changed. | |
Glib::PropertyProxy_ReadOnly< double > | property_accessible_value () const |
Is used to notify that the value has changed. | |
Glib::PropertyProxy<double> | property_accessible_value () |
Is used to notify that the value has changed. | |
bool | remove_relationship (RelationType relationship, const Glib::RefPtr<Object>& target) |
Removes a relationship of the specified type with the specified target. | |
void | set_description (const Glib::ustring& description) |
Sets the accessible description of the accessible. | |
void | set_name (const Glib::ustring& name) |
Sets the accessible name of the accessible. | |
void | set_parent (const Glib::RefPtr<Atk::Object>& parent) |
Sets the accessible parent of the accessible. | |
void | set_role (Role role) |
Sets the role of the accessible. | |
Glib::SignalProxy1< void, void** > | signal_active_descendant_changed () |
Glib::SignalProxy2< void, guint, gpointer > | signal_children_changed () |
Glib::SignalProxy1< void, bool > | signal_focus_event () |
Glib::SignalProxy1< void, AtkPropertyValues* > | signal_property_change () |
Glib::SignalProxy2< void, const Glib::ustring&, bool > | signal_state_change () |
Glib::SignalProxy0<void> | signal_visible_data_changed () |
virtual | ~Object () |
Protected Member Functions | |
virtual void | on_active_descendant_changed (void** child) |
virtual void | on_children_changed (guint change_index, gpointer changed_child) |
virtual void | on_focus_event (bool focus_in) |
virtual void | on_property_change (AtkPropertyValues* values) |
virtual void | on_state_change (const Glib::ustring& name, bool state_set) |
virtual void | on_visible_data_changed () |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr<Atk::Object> | wrap (AtkObject* object, bool take_copy=false) |
|
Reimplemented from Glib::Object. |
|
Adds a relationship of the specified type with the specified target.
|
|
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.
|
|
Gets the accessible description of the accessible.
|
|
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
|
|
Gets the number of accessible children of the accessible.
|
|
Gets the accessible name of the accessible.
|
|
Gets the accessible parent of the accessible.
|
|
Gets the Atk::RelationSet associated with the object.
|
|
Gets the role of the accessible.
|
|
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
|
|
Provides access to the underlying C GObject.
Reimplemented from Glib::ObjectBase. Reimplemented in Atk::NoOpObject, and Atk::ObjectAccessible. |
|
Provides access to the underlying C GObject.
Reimplemented from Glib::ObjectBase. Reimplemented in Atk::NoOpObject, and Atk::ObjectAccessible. |
|
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented in Atk::NoOpObject, and Atk::ObjectAccessible. |
|
Emits a state-change signal for the specified state.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The accessible layer of this object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The accessible MDI value of this object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Description of an object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Description of an object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Object instance's name formatted for assistive technology access. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Object instance's name formatted for assistive technology access. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the parent has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the parent has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The accessible role of this object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
The accessible role of this object. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table caption has changed; this property should not be used. accessible-table-caption-object should be used instead. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table caption has changed; this property should not be used. accessible-table-caption-object should be used instead. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table column description has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table column description has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table column header has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table column header has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table row description has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table row description has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table row header has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table row header has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table summary has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the table summary has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the value has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Is used to notify that the value has changed. You rarely need to use properties because there are get_ and set_ methods for almost all of them.
|
|
Removes a relationship of the specified type with the specified target.
|
|
Sets the accessible description of the accessible.
|
|
Sets the accessible name of the accessible.
|
|
Sets the accessible parent of the accessible.
|
|
Sets the role of the accessible.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|