gtkmm 4.9.3
|
Accessible interface. More...
#include <gtkmm/accessible.h>
Public Member Functions | |
Accessible (Accessible && src) noexcept | |
Accessible & | operator= (Accessible && src) noexcept |
~Accessible () noexcept override | |
GtkAccessible * | gobj () |
Provides access to the underlying C GObject. | |
const GtkAccessible * | gobj () const |
Provides access to the underlying C GObject. | |
Glib::RefPtr< ATContext > | get_at_context () |
Retrieves the Gtk::ATContext for the given Gtk::Accessible . | |
Glib::RefPtr< const ATContext > | get_at_context () const |
Retrieves the Gtk::ATContext for the given Gtk::Accessible . | |
bool | get_platform_state (PlatformState state) const |
Query a platform state, such as focus. | |
Glib::RefPtr< Accessible > | get_accessible_parent () |
Retrieves the accessible accessible for an accessible object. | |
Glib::RefPtr< const Accessible > | get_accessible_parent () const |
Retrieves the accessible accessible for an accessible object. | |
Glib::RefPtr< Accessible > | get_first_accessible_child () |
Retrieves the first accessible child of an accessible object. | |
Glib::RefPtr< const Accessible > | get_first_accessible_child () const |
Retrieves the first accessible child of an accessible object. | |
Glib::RefPtr< Accessible > | get_next_accessible_sibling () |
Retrieves the next accessible sibling of an accessible object. | |
Glib::RefPtr< const Accessible > | get_next_accessible_sibling () const |
Retrieves the next accessible sibling of an accessible object. | |
bool | get_bounds (int & x, int & y, int & width, int & height) const |
Queries the coordinates and dimensions of this accessible. | |
Role | get_accessible_role () const |
Retrieves the accessible role of an accessible object. | |
void | update_state (State state, const Glib::ValueBase & value) |
Updates an accessible state. | |
void | update_property (Property property, const Glib::ValueBase & value) |
Updates an accessible property. | |
void | update_relation (Relation relation, const Glib::ValueBase & value) |
Updates an accessible relation. | |
void | reset_state (State state) |
Resets the accessible state to its default value. | |
void | reset_property (Property property) |
Resets the accessible property to its default value. | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. | |
Static Public Member Functions | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
Accessible () | |
You should derive from this class to use it. | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::Accessible > | wrap (GtkAccessible * object, bool take_copy=false) |
A Glib::wrap() method for this object. | |
Accessible interface.
Gtk::Accessible provides an interface for describing a UI element, like a Gtk::Widget, in a way that can be consumed by Assistive Technologies, or “AT”. Every accessible implementation has:
The role cannot be changed after instantiating a Gtk::Accessible implementation.
The attributes are updated every time a UI element's state changes in a way that should be reflected by assistive technologies. For instance, if a Gtk::Widget visibility changes, the Gtk::Accessible::State::HIDDEN state will also change to reflect Gtk::Widget::property_visible().
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
|
static |
Glib::RefPtr< Accessible > Gtk::Accessible::get_accessible_parent | ( | ) |
Retrieves the accessible accessible for an accessible object.
This function returns nullptr
for top level widgets
Glib::RefPtr< const Accessible > Gtk::Accessible::get_accessible_parent | ( | ) | const |
Retrieves the accessible accessible for an accessible object.
This function returns nullptr
for top level widgets
Role Gtk::Accessible::get_accessible_role | ( | ) | const |
Retrieves the accessible role of an accessible object.
Glib::RefPtr< ATContext > Gtk::Accessible::get_at_context | ( | ) |
Retrieves the Gtk::ATContext
for the given Gtk::Accessible
.
Gtk::ATContext
. Glib::RefPtr< const ATContext > Gtk::Accessible::get_at_context | ( | ) | const |
Retrieves the Gtk::ATContext
for the given Gtk::Accessible
.
Gtk::ATContext
. bool Gtk::Accessible::get_bounds | ( | int & | x, |
int & | y, | ||
int & | width, | ||
int & | height | ||
) | const |
Queries the coordinates and dimensions of this accessible.
This functionality can be overridden by Gtk::Accessible
implementations, e.g. to get the bounds from an ignored child widget.
x | The x coordinate of the top left corner of the accessible. |
y | The y coordinate of the top left corner of the widget. |
width | The width of the accessible object. |
height | The height of the accessible object. |
Glib::RefPtr< Accessible > Gtk::Accessible::get_first_accessible_child | ( | ) |
Retrieves the first accessible child of an accessible object.
since: 4.10
Glib::RefPtr< const Accessible > Gtk::Accessible::get_first_accessible_child | ( | ) | const |
Retrieves the first accessible child of an accessible object.
since: 4.10
Glib::RefPtr< Accessible > Gtk::Accessible::get_next_accessible_sibling | ( | ) |
Retrieves the next accessible sibling of an accessible object.
since: 4.10
Glib::RefPtr< const Accessible > Gtk::Accessible::get_next_accessible_sibling | ( | ) | const |
Retrieves the next accessible sibling of an accessible object.
since: 4.10
bool Gtk::Accessible::get_platform_state | ( | PlatformState | state | ) | const |
Query a platform state, such as focus.
See gtk_accessible_platform_changed().
This functionality can be overridden by Gtk::Accessible
implementations, e.g. to get platform state from an ignored child widget, as is the case for Gtk::Text
wrappers.
state | Platform state to query. |
|
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.
|
noexcept |
Glib::PropertyProxy< Role > Gtk::Accessible::property_accessible_role | ( | ) |
The accessible role of the given Gtk::Accessible
implementation.
The accessible role cannot be changed once set.
Default value: Gtk::Accessible::Role::NONE
Glib::PropertyProxy_ReadOnly< Role > Gtk::Accessible::property_accessible_role | ( | ) | const |
The accessible role of the given Gtk::Accessible
implementation.
The accessible role cannot be changed once set.
Default value: Gtk::Accessible::Role::NONE
void Gtk::Accessible::reset_property | ( | Property | property | ) |
Resets the accessible property to its default value.
property | A Gtk::Accessible::Property . |
void Gtk::Accessible::reset_relation | ( | Relation | relation | ) |
Resets the accessible relation to its default value.
relation | A Gtk::Accessible::Relation . |
void Gtk::Accessible::reset_state | ( | State | state | ) |
Resets the accessible state to its default value.
state | A Gtk::Accessible::State . |
void Gtk::Accessible::update_property | ( | Property | property, |
const Glib::ValueBase & | value | ||
) |
Updates an accessible property.
This function should be called by Gtk::Widget types whenever an accessible property change must be communicated to assistive technologies.
property | A Gtk::Accessible::Property. |
value | A Glib::ValueBase. |
void Gtk::Accessible::update_relation | ( | Relation | relation, |
const Glib::ValueBase & | value | ||
) |
Updates an accessible relation.
This function should be called by Gtk::Widget types whenever an accessible relation change must be communicated to assistive technologies.
relation | A Gtk::Accessible::Relation. |
value | A Glib::ValueBase. |
void Gtk::Accessible::update_state | ( | State | state, |
const Glib::ValueBase & | value | ||
) |
Updates an accessible state.
This function should be called by Gtk::Widget types whenever an accessible state change must be communicated to assistive technologies.
state | A Gtk::Accessible::State. |
value | A Glib::ValueBase. |
|
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. |