![]() |
![]() |
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. | ||||
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 () | |||
Related Functions | ||||
(Note that these are not member functions.) | ||||
Glib::RefPtr<Atk::Object> | wrap (AtkObject* object, bool take_copy=false) | |||
|
virtual Atk::Object::~Object | ( | ) | [virtual] |
bool Atk::Object::add_relationship | ( | RelationType | relationship, | |
const Glib::RefPtr<Object>& | target | |||
) |
Adds a relationship of the specified type with the specified target.
relationship | The Atk::RelationType of the relation. | |
target | The Atk::Object which is to be the target of the relation. |
true
if the relationship is added. Glib::RefPtr<Atk::Object> Atk::Object::get_accessible_child | ( | int | i | ) |
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.
i | A int representing the position of the child, starting from 0. |
Glib::ustring Atk::Object::get_description | ( | ) | const |
Gets the accessible description of the accessible.
int Atk::Object::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 Atk::Object::get_n_accessible_children | ( | ) | const |
Gets the number of accessible children of the accessible.
Glib::ustring Atk::Object::get_name | ( | ) | const |
Gets the accessible name of the accessible.
Glib::RefPtr<Atk::Object> Atk::Object::get_parent | ( | ) |
Gets the accessible parent of the accessible.
Glib::RefPtr<RelationSet> Atk::Object::get_relation_set | ( | ) |
Gets the Atk::RelationSet associated with the object.
Role Atk::Object::get_role | ( | ) | const |
Glib::RefPtr<StateSet> Atk::Object::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* Atk::Object::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented in Atk::NoOpObject, and Atk::ObjectAccessible.
AtkObject* Atk::Object::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented in Atk::NoOpObject, and Atk::ObjectAccessible.
AtkObject* Atk::Object::gobj_copy | ( | ) |
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.
void Atk::Object::notify_state_change | ( | State | state, | |
bool | value | |||
) |
Emits a state-change signal for the specified state.
state | An Atk::State whose state is changed. | |
value | A bool which indicates whether the state is being set on or off. |
bool Atk::Object::remove_relationship | ( | RelationType | relationship, | |
const Glib::RefPtr<Object>& | target | |||
) |
Removes a relationship of the specified type with the specified target.
relationship | The Atk::RelationType of the relation. | |
target | The Atk::Object which is the target of the relation to be removed. |
true
if the relationship is removed. void Atk::Object::set_description | ( | const Glib::ustring & | description | ) |
Sets the accessible description of the accessible.
description | A character string to be set as the accessible description. |
void Atk::Object::set_name | ( | const Glib::ustring & | name | ) |
Sets the accessible name of the accessible.
name | A character string to be set as the accessible name. |
void Atk::Object::set_parent | ( | const Glib::RefPtr<Atk::Object>& | parent | ) |
Sets the accessible parent of the accessible.
parent | An Atk::Object to be set as the accessible parent. |
void Atk::Object::set_role | ( | Role | role | ) |
Glib::SignalProxy1< void,void** > Atk::Object::signal_active_descendant_changed | ( | ) |
void active_descendant_changed(void** child)
Glib::SignalProxy2< void,guint,gpointer > Atk::Object::signal_children_changed | ( | ) |
void children_changed(guint change_index, gpointer changed_child)
Glib::SignalProxy1< void,bool > Atk::Object::signal_focus_event | ( | ) |
void focus_event(bool focus_in)
Glib::SignalProxy1< void,AtkPropertyValues* > Atk::Object::signal_property_change | ( | ) |
void property_change(AtkPropertyValues* values)
Glib::SignalProxy2< void,const Glib::ustring&,bool > Atk::Object::signal_state_change | ( | ) |
void state_change(const Glib::ustring& name, bool state_set)
Glib::SignalProxy0< void > Atk::Object::signal_visible_data_changed | ( | ) |
void visible_data_changed()
Glib::RefPtr<Atk::Object> wrap | ( | AtkObject * | object, | |
bool | take_copy = false | |||
) | [related] |
object | The C instance |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |