atkmm 2.28.3
|
The base object class for the Accessibility Toolkit API. More...
#include <atkmm/object.h>
Public Member Functions | |
Object (Object && src) noexcept | |
Object & | operator= (Object && src) noexcept |
~Object () noexcept override | |
AtkObject * | gobj () |
Provides access to the underlying C GObject. More... | |
const AtkObject * | gobj () const |
Provides access to the underlying C GObject. More... | |
AtkObject * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
Glib::ustring | get_name () const |
Gets the accessible name of the accessible. More... | |
Glib::ustring | get_description () const |
Gets the accessible description of the accessible. More... | |
Glib::RefPtr< Atk::Object > | get_parent () |
Gets the accessible parent of the accessible. More... | |
int | get_n_accessible_children () const |
Gets the number of accessible children of the accessible. More... | |
Glib::RefPtr< Atk::Object > | get_accessible_child (int i) |
Gets a reference to the specified accessible child of the object. More... | |
Glib::RefPtr< RelationSet > | get_relation_set () |
Gets the Atk::RelationSet associated with the object. More... | |
Role | get_role () const |
Gets the role of the accessible. More... | |
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. More... | |
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. More... | |
void | set_name (const Glib::ustring & name) |
Sets the accessible name of the accessible. More... | |
void | set_description (const Glib::ustring & description) |
Sets the accessible description of the accessible. More... | |
void | set_parent (const Glib::RefPtr< Atk::Object > & parent) |
Sets the accessible parent of the accessible. More... | |
void | set_role (Role role) |
Sets the role of the accessible. More... | |
void | notify_state_change (State state, bool value) |
Emits a state-change signal for the specified state. More... | |
bool | add_relationship (RelationType relationship, const Glib::RefPtr< Object > & target) |
Adds a relationship of the specified type with the specified target. More... | |
bool | remove_relationship (RelationType relationship, const Glib::RefPtr< Object > & target) |
Removes a relationship of the specified type with the specified target. More... | |
Glib::SignalProxy< void, guint, gpointer > | signal_children_changed () |
Glib::SignalProxy< void, bool > | signal_focus_event () |
Glib::SignalProxy< void, AtkPropertyValues * > | signal_property_change () |
Glib::SignalProxy< void, const Glib::ustring &, bool > | signal_state_change () |
Glib::SignalProxy< void > | signal_visible_data_changed () |
Glib::SignalProxy< void, void ** > | signal_active_descendant_changed () |
Glib::PropertyProxy< Glib::ustring > | property_accessible_name () |
Object instance’s name formatted for assistive technology access. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_name () const |
Object instance’s name formatted for assistive technology access. More... | |
Glib::PropertyProxy< Glib::ustring > | property_accessible_description () |
Description of an object, formatted for assistive technology access. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_description () const |
Description of an object, formatted for assistive technology access. More... | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_parent () |
Parent of the current accessible as returned by Atk::Object::get_parent(). More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > | property_accessible_parent () const |
Parent of the current accessible as returned by Atk::Object::get_parent(). More... | |
Glib::PropertyProxy< double > | property_accessible_value () |
Is used to notify that the value has changed. More... | |
Glib::PropertyProxy_ReadOnly< double > | property_accessible_value () const |
Is used to notify that the value has changed. More... | |
Glib::PropertyProxy< int > | property_accessible_role () |
The accessible role of this object. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_role () const |
The accessible role of this object. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_component_layer () const |
The accessible layer of this object. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_accessible_component_mdi_zorder () const |
The accessible MDI value of this object. More... | |
Glib::PropertyProxy< Glib::ustring > | property_accessible_table_caption () |
Is used to notify that the table caption has changed; this property should not be used. More... | |
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. More... | |
Glib::PropertyProxy< Glib::ustring > | property_accessible_table_column_description () |
Is used to notify that the table column description has changed. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_table_column_description () const |
Is used to notify that the table column description has changed. More... | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_column_header () |
Is used to notify that the table column header has changed. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > | property_accessible_table_column_header () const |
Is used to notify that the table column header has changed. More... | |
Glib::PropertyProxy< Glib::ustring > | property_accessible_table_row_description () |
Is used to notify that the table row description has changed. More... | |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_accessible_table_row_description () const |
Is used to notify that the table row description has changed. More... | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_row_header () |
Is used to notify that the table row header has changed. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > | property_accessible_table_row_header () const |
Is used to notify that the table row header has changed. More... | |
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > | property_accessible_table_summary () |
Is used to notify that the table summary has changed. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > | property_accessible_table_summary () const |
Is used to notify that the table summary has changed. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
virtual void | on_children_changed (guint change_index, gpointer changed_child) |
This is a default handler for the signal signal_children_changed(). More... | |
virtual void | on_focus_event (bool focus_in) |
This is a default handler for the signal signal_focus_event(). More... | |
virtual void | on_property_change (AtkPropertyValues * values) |
This is a default handler for the signal signal_property_change(). More... | |
virtual void | on_state_change (const Glib::ustring & name, bool state_set) |
This is a default handler for the signal signal_state_change(). More... | |
virtual void | on_visible_data_changed () |
This is a default handler for the signal signal_visible_data_changed(). More... | |
virtual void | on_active_descendant_changed (void ** child) |
This is a default handler for the signal signal_active_descendant_changed(). More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Atk::Object > | wrap (AtkObject * object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
The base object class for the Accessibility Toolkit API.
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.
|
noexcept |
|
overridenoexcept |
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.
By default this is the one assigned with 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 set_parent(), and will return it with this method.
If you are only interested on the parent assigned with set_parent(), use peek_parent().
Glib::RefPtr< RelationSet > Atk::Object::get_relation_set | ( | ) |
Gets the Atk::RelationSet associated with the object.
Role Atk::Object::get_role | ( | ) | const |
Gets the role of the accessible.
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.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
void Atk::Object::notify_state_change | ( | State | state, |
bool | value | ||
) |
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.
state | An Atk::State whose state is changed. |
value | A bool which indicates whether the state is being set on or off. |
|
protectedvirtual |
This is a default handler for the signal signal_active_descendant_changed().
|
protectedvirtual |
This is a default handler for the signal signal_children_changed().
|
protectedvirtual |
This is a default handler for the signal signal_focus_event().
|
protectedvirtual |
This is a default handler for the signal signal_property_change().
|
protectedvirtual |
This is a default handler for the signal signal_state_change().
|
protectedvirtual |
This is a default handler for the signal signal_visible_data_changed().
Glib::PropertyProxy_ReadOnly< int > Atk::Object::property_accessible_component_layer | ( | ) | const |
The accessible layer of this object.
Default value: 0
Glib::PropertyProxy_ReadOnly< int > Atk::Object::property_accessible_component_mdi_zorder | ( | ) | const |
The accessible MDI value of this object.
Default value: -2147483648
Glib::PropertyProxy< Glib::ustring > Atk::Object::property_accessible_description | ( | ) |
Description of an object, formatted for assistive technology access.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Atk::Object::property_accessible_description | ( | ) | const |
Description of an object, formatted for assistive technology access.
Default value: ""
Glib::PropertyProxy< Glib::ustring > Atk::Object::property_accessible_name | ( | ) |
Object instance’s name formatted for assistive technology access.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Atk::Object::property_accessible_name | ( | ) | const |
Object instance’s name formatted for assistive technology access.
Default value: ""
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > Atk::Object::property_accessible_parent | ( | ) |
Parent of the current accessible as returned by Atk::Object::get_parent().
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > Atk::Object::property_accessible_parent | ( | ) | const |
Parent of the current accessible as returned by Atk::Object::get_parent().
Glib::PropertyProxy< int > Atk::Object::property_accessible_role | ( | ) |
The accessible role of this object.
Default value: Atk::ROLE_UNKNOWN
Glib::PropertyProxy_ReadOnly< int > Atk::Object::property_accessible_role | ( | ) | const |
The accessible role of this object.
Default value: Atk::ROLE_UNKNOWN
Glib::PropertyProxy< Glib::ustring > Atk::Object::property_accessible_table_caption | ( | ) |
Is used to notify that the table caption has changed; this property should not be used.
accessible-table-caption-object should be used instead.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Atk::Object::property_accessible_table_caption | ( | ) | const |
Is used to notify that the table caption has changed; this property should not be used.
accessible-table-caption-object should be used instead.
Default value: ""
Glib::PropertyProxy< Glib::ustring > Atk::Object::property_accessible_table_column_description | ( | ) |
Is used to notify that the table column description has changed.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Atk::Object::property_accessible_table_column_description | ( | ) | const |
Is used to notify that the table column description has changed.
Default value: ""
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > Atk::Object::property_accessible_table_column_header | ( | ) |
Is used to notify that the table column header has changed.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > Atk::Object::property_accessible_table_column_header | ( | ) | const |
Is used to notify that the table column header has changed.
Glib::PropertyProxy< Glib::ustring > Atk::Object::property_accessible_table_row_description | ( | ) |
Is used to notify that the table row description has changed.
Default value: ""
Glib::PropertyProxy_ReadOnly< Glib::ustring > Atk::Object::property_accessible_table_row_description | ( | ) | const |
Is used to notify that the table row description has changed.
Default value: ""
Glib::PropertyProxy< Glib::RefPtr< Atk::Object > > 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 > > 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 > > Atk::Object::property_accessible_table_summary | ( | ) |
Is used to notify that the table summary has changed.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< Atk::Object > > Atk::Object::property_accessible_table_summary | ( | ) | const |
Is used to notify that the table summary has changed.
Glib::PropertyProxy< double > Atk::Object::property_accessible_value | ( | ) |
Is used to notify that the value has changed.
Default value: 0
Glib::PropertyProxy_ReadOnly< double > Atk::Object::property_accessible_value | ( | ) | const |
Is used to notify that the value has changed.
Default value: 0
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.
You can't set the description to nullptr
. This is reserved for the initial value. In this aspect nullptr
is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
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.
You can't set the name to nullptr
. This is reserved for the initial value. In this aspect nullptr
is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use "".
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 can be nullptr
.
parent | An Atk::Object to be set as the accessible parent. |
void Atk::Object::set_role | ( | Role | role | ) |
Sets the role of the accessible.
role | An Atk::Role to be set as the role. |
Glib::SignalProxy< void, void ** > Atk::Object::signal_active_descendant_changed | ( | ) |
void on_my_active_descendant_changed(void** child)
Flags: Run Last
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.
child | The newly focused object. |
Glib::SignalProxy< void, guint, gpointer > Atk::Object::signal_children_changed | ( | ) |
void on_my_children_changed(guint change_index, gpointer changed_child)
Flags: Run Last
The signal "children-changed" is emitted when a child is added or removed form an object. It supports two details: "add" and "remove"
change_index | 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. |
changed_child | 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 nullptr . |
Glib::SignalProxy< void, bool > Atk::Object::signal_focus_event | ( | ) |
void on_my_focus_event(bool focus_in)
Flags: Run Last
The signal "focus-event" is emitted when an object gained or lost focus.
Deprecated: 2.9.4: Use the Atk::Object::signal_state_change() signal instead.
focus_in | A boolean value which indicates whether the object gained or lost focus. |
Glib::SignalProxy< void, AtkPropertyValues * > Atk::Object::signal_property_change | ( | ) |
void on_my_property_change(AtkPropertyValues* values)
Flags: Run Last
The signal "property-change" is emitted when an object's property value changes. values contains an Atk::PropertyValues 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 Glib::object_notify() to emit property-changed notifications. Atk::Object::signal_property_changed() is needed by the implementation of atk_add_global_event_listener() because GObject notify doesn't support emission hooks.
values | An Atk::PropertyValues containing the new value of the property which changed. |
Glib::SignalProxy< void, const Glib::ustring &, bool > Atk::Object::signal_state_change | ( | ) |
void on_my_state_change(const Glib::ustring& name, bool state_set)
Flags: Run Last
The "state-change" signal is emitted when an object's state changes. The detail value identifies the state type which has changed.
name | The name of the state which has changed. |
state_set | A boolean which indicates whether the state has been set or unset. |
Glib::SignalProxy< void > Atk::Object::signal_visible_data_changed | ( | ) |
void on_my_visible_data_changed()
Flags: Run Last
The "visible-data-changed" signal is emitted when the visual appearance of the object changed.
|
related |
A Glib::wrap() method for this object.
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. |