gtkmm: Gtk::Accessible Class Reference
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. More... | |
const GtkAccessible* | gobj () const |
Provides access to the underlying C GObject. More... | |
Role | get_accessible_role () const |
Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible. More... | |
void | update_state (State state, const Glib::ValueBase& value) |
Updates an accessible state. More... | |
void | update_property (Property property, const Glib::ValueBase& value) |
Updates an accessible property. More... | |
void | update_relation (Relation relation, const Glib::ValueBase& value) |
Updates an accessible relation. More... | |
void | reset_state (State state) |
Resets the accessible state to its default value. More... | |
void | reset_property (Property property) |
Resets the accessible property to its default value. More... | |
void | reset_relation (Relation relation) |
Resets the accessible relation to its default value. More... | |
Glib::PropertyProxy< Role > | property_accessible_role () |
The accessible role of the given Gtk::Accessible implementation. More... | |
Glib::PropertyProxy_ReadOnly< Role > | property_accessible_role () const |
The accessible role of the given Gtk::Accessible implementation. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexcept override | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () const |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (const ObjectBase &)=delete |
void | set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value) |
void | get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const |
void | set_property (const Glib::ustring &property_name, const PropertyType &value) |
void | get_property (const Glib::ustring &property_name, PropertyType &value) const |
PropertyType | get_property (const Glib::ustring &property_name) const |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot) |
sigc::connection | connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot) |
void | freeze_notify () |
void | thaw_notify () |
virtual void | reference () const |
virtual void | unreference () const |
GObject * | gobj () |
const GObject * | gobj () const |
GObject * | gobj_copy () const |
Public Member Functions inherited from sigc::trackable | |
trackable () noexcept | |
trackable (const trackable &src) noexcept | |
trackable (trackable &&src) noexcept | |
~trackable () | |
void | add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const |
void | notify_callbacks () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) noexcept |
void | remove_destroy_notify_callback (notifiable *data) const |
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. More... | |
Protected Member Functions | |
Accessible () | |
You should derive from this class to use it. More... | |
Protected Member Functions inherited from Glib::ObjectBase | |
ObjectBase () | |
ObjectBase (const char *custom_type_name) | |
ObjectBase (const std::type_info &custom_type_info) | |
ObjectBase (ObjectBase &&src) noexcept | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
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. More... | |
Detailed Description
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:
- a “role”, represented by a value of the Gtk::Accessible::Role enumeration
- an “attribute”, represented by a set of Gtk::Accessible::State, Gtk::Accessible::Property and Gtk::Accessible::Relation values
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().
Constructor & Destructor Documentation
|
protected |
You should derive from this class to use it.
|
noexcept |
|
overridenoexcept |
Member Function Documentation
|
static |
Role Gtk::Accessible::get_accessible_role | ( | ) | const |
Retrieves the Gtk::Accessible::Role for the given Gtk::Accessible.
- Returns
- A Gtk::Accessible::Role.
|
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
- Returns
- A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
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
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::Accessible::reset_property | ( | Property | property | ) |
Resets the accessible property to its default value.
- Parameters
-
property A Gtk::Accessible::Property.
void Gtk::Accessible::reset_relation | ( | Relation | relation | ) |
Resets the accessible relation to its default value.
- Parameters
-
relation A Gtk::Accessible::Relation.
void Gtk::Accessible::reset_state | ( | State | state | ) |
Resets the accessible state to its default value.
- Parameters
-
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.
- Parameters
-
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.
- Parameters
-
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.
- Parameters
-
state A Gtk::Accessible::State. value A Glib::ValueBase.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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.
- Returns
- A C++ instance that wraps this C instance.