fl_accessible_node.cc File Reference

#include "flutter/shell/platform/linux/fl_accessible_node.h"
#include "flutter/shell/platform/linux/fl_engine_private.h"

Go to the source code of this file.

Classes
struct	ActionData
struct	FlAccessibleNodePrivate

Macros
#define	FL_ACCESSIBLE_NODE_GET_PRIVATE(node)

Enumerations
enum	{   PROP_0 ,   PROP_ENGINE ,   PROP_VIEW_ID ,   PROP_ID ,   PROP_LAST }

Functions
static void	fl_accessible_node_component_interface_init (AtkComponentIface *iface)
static void	fl_accessible_node_action_interface_init (AtkActionIface *iface)
	G_DEFINE_TYPE_WITH_CODE (FlAccessibleNode, fl_accessible_node, ATK_TYPE_OBJECT, G_IMPLEMENT_INTERFACE(ATK_TYPE_COMPONENT, fl_accessible_node_component_interface_init) G_IMPLEMENT_INTERFACE(ATK_TYPE_ACTION, fl_accessible_node_action_interface_init)) static gboolean is_checkable(FlutterSemanticsFlags flags)
static gboolean	is_checked (FlutterSemanticsFlags flags)
static gboolean	is_focusable (FlutterSemanticsFlags flags)
static gboolean	is_focused (FlutterSemanticsFlags flags)
static gboolean	is_selected (FlutterSemanticsFlags flags)
static gboolean	is_sensitive (FlutterSemanticsFlags flags)
static gboolean	is_enabled (FlutterSemanticsFlags flags)
static gboolean	has_action (FlutterSemanticsAction actions, FlutterSemanticsAction action)
static ActionData *	get_action (FlAccessibleNodePrivate *priv, gint index)
static gboolean	has_child (GPtrArray *children, AtkObject *object)
static void	fl_accessible_node_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
static void	fl_accessible_node_dispose (GObject *object)
static const gchar *	fl_accessible_node_get_name (AtkObject *accessible)
static AtkObject *	fl_accessible_node_get_parent (AtkObject *accessible)
static gint	fl_accessible_node_get_index_in_parent (AtkObject *accessible)
static gint	fl_accessible_node_get_n_children (AtkObject *accessible)
static AtkObject *	fl_accessible_node_ref_child (AtkObject *accessible, gint i)
static AtkRole	fl_accessible_node_get_role (AtkObject *accessible)
static AtkStateSet *	fl_accessible_node_ref_state_set (AtkObject *accessible)
static void	fl_accessible_node_get_extents (AtkComponent *component, gint *x, gint *y, gint *width, gint *height, AtkCoordType coord_type)
static AtkLayer	fl_accessible_node_get_layer (AtkComponent *component)
static gboolean	fl_accessible_node_do_action (AtkAction *action, gint i)
static gint	fl_accessible_node_get_n_actions (AtkAction *action)
static const gchar *	fl_accessible_node_get_name (AtkAction *action, gint i)
static void	fl_accessible_node_set_name_impl (FlAccessibleNode *self, const gchar *name)
static void	fl_accessible_node_set_extents_impl (FlAccessibleNode *self, gint x, gint y, gint width, gint height)
static bool	flag_changed (bool old_flag, bool new_flag)
static void	fl_accessible_node_set_flags_impl (FlAccessibleNode *self, FlutterSemanticsFlags *flags)
static void	fl_accessible_node_set_actions_impl (FlAccessibleNode *self, FlutterSemanticsAction actions)
static void	fl_accessible_node_set_value_impl (FlAccessibleNode *self, const gchar *value)
static void	fl_accessible_node_set_text_selection_impl (FlAccessibleNode *self, gint base, gint extent)
static void	fl_accessible_node_set_text_direction_impl (FlAccessibleNode *self, FlutterTextDirection direction)
static void	fl_accessible_node_perform_action_impl (FlAccessibleNode *self, FlutterSemanticsAction action, GBytes *data)
static void	fl_accessible_node_class_init (FlAccessibleNodeClass *klass)
static void	fl_accessible_node_init (FlAccessibleNode *self)
FlAccessibleNode *	fl_accessible_node_new (FlEngine *engine, FlutterViewId view_id, int32_t node_id)
void	fl_accessible_node_set_parent (FlAccessibleNode *self, AtkObject *parent, gint index)
void	fl_accessible_node_set_children (FlAccessibleNode *self, GPtrArray *children)
void	fl_accessible_node_set_name (FlAccessibleNode *self, const gchar *name)
void	fl_accessible_node_set_extents (FlAccessibleNode *self, gint x, gint y, gint width, gint height)
void	fl_accessible_node_set_flags (FlAccessibleNode *self, FlutterSemanticsFlags *flags)
void	fl_accessible_node_set_actions (FlAccessibleNode *self, FlutterSemanticsAction actions)
void	fl_accessible_node_set_value (FlAccessibleNode *self, const gchar *value)
void	fl_accessible_node_set_text_selection (FlAccessibleNode *self, gint base, gint extent)
void	fl_accessible_node_set_text_direction (FlAccessibleNode *self, FlutterTextDirection direction)
void	fl_accessible_node_perform_action (FlAccessibleNode *self, FlutterSemanticsAction action, GBytes *data)

Variables
static ActionData	action_mapping []

Macro Definition Documentation

FL_ACCESSIBLE_NODE_GET_PRIVATE

#define FL_ACCESSIBLE_NODE_GET_PRIVATE

(

node

)

Value:

  ((FlAccessibleNodePrivate*)fl_accessible_node_get_instance_private( \
      FL_ACCESSIBLE_NODE(node)))

Definition at line 68 of file fl_accessible_node.cc.

                                                          {
  return flags.is_checked != kFlutterCheckStateNone ||
         flags.is_toggled != kFlutterTristateNone;
}
 
// Returns TRUE if [flags] indicate this element is checked.
static gboolean is_checked(FlutterSemanticsFlags flags) {
  return flags.is_checked == kFlutterCheckStateTrue ||
         flags.is_toggled == kFlutterTristateTrue;
}
 
// Returns TRUE if [flags] indicate this element is focusable.
static gboolean is_focusable(FlutterSemanticsFlags flags) {
  return flags.is_focused != kFlutterTristateNone;
}
 
// Returns TRUE if [flags] indicate this element is focused.
static gboolean is_focused(FlutterSemanticsFlags flags) {
  return flags.is_focused == kFlutterTristateTrue;
}
 
// Returns TRUE if [flags] indicate this element is selected.
static gboolean is_selected(FlutterSemanticsFlags flags) {
  return flags.is_selected == kFlutterTristateTrue;
}
 
// Returns TRUE if [flags] indicate this element is sensitive.
static gboolean is_sensitive(FlutterSemanticsFlags flags) {
  return flags.is_enabled != kFlutterTristateNone;
}
 
// Returns TRUE if [flags] indicate this element is enabled.
static gboolean is_enabled(FlutterSemanticsFlags flags) {
  return flags.is_enabled == kFlutterTristateTrue;
}
 
// Returns TRUE if [action] is set in [actions].
static gboolean has_action(FlutterSemanticsAction actions,
                           FlutterSemanticsAction action) {
  return (actions & action) != 0;
}
 
// Gets the nth action.
static ActionData* get_action(FlAccessibleNodePrivate* priv, gint index) {
  if (index < 0 || static_cast<guint>(index) >= priv->actions->len) {
    return nullptr;
  }
  return static_cast<ActionData*>(g_ptr_array_index(priv->actions, index));
}
 
// Checks if [object] is in [children].
static gboolean has_child(GPtrArray* children, AtkObject* object) {
  for (guint i = 0; i < children->len; i++) {
    if (g_ptr_array_index(children, i) == object) {
      return TRUE;
    }
  }
 
  return FALSE;
}
 
static void fl_accessible_node_set_property(GObject* object,
                                            guint prop_id,
                                            const GValue* value,
                                            GParamSpec* pspec) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(object);
  switch (prop_id) {
    case PROP_ENGINE:
      g_weak_ref_set(&priv->engine, g_value_get_object(value));
      break;
    case PROP_VIEW_ID:
      priv->view_id = g_value_get_int64(value);
      break;
    case PROP_ID:
      priv->node_id = g_value_get_int(value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
      break;
  }
}
 
static void fl_accessible_node_dispose(GObject* object) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(object);
 
  g_weak_ref_clear(&priv->engine);
  g_weak_ref_clear(&priv->parent);
  g_clear_pointer(&priv->name, g_free);
  g_clear_pointer(&priv->actions, g_ptr_array_unref);
  g_clear_pointer(&priv->children, g_ptr_array_unref);
 
  G_OBJECT_CLASS(fl_accessible_node_parent_class)->dispose(object);
}
 
// Implements AtkObject::get_name.
static const gchar* fl_accessible_node_get_name(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->name;
}
 
// Implements AtkObject::get_parent.
static AtkObject* fl_accessible_node_get_parent(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  g_autoptr(AtkObject) parent = ATK_OBJECT(g_weak_ref_get(&priv->parent));
  return parent;
}
 
// Implements AtkObject::get_index_in_parent.
static gint fl_accessible_node_get_index_in_parent(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->index;
}
 
// Implements AtkObject::get_n_children.
static gint fl_accessible_node_get_n_children(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->children->len;
}
 
// Implements AtkObject::ref_child.
static AtkObject* fl_accessible_node_ref_child(AtkObject* accessible, gint i) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
 
  if (i < 0 || static_cast<guint>(i) >= priv->children->len) {
    return nullptr;
  }
 
  return ATK_OBJECT(g_object_ref(g_ptr_array_index(priv->children, i)));
}
 
// Implements AtkObject::get_role.
static AtkRole fl_accessible_node_get_role(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  if (priv->flags.is_button) {
    return ATK_ROLE_PUSH_BUTTON;
  }
  if (priv->flags.is_in_mutually_exclusive_group &&
      priv->flags.is_checked != kFlutterCheckStateNone) {
    return ATK_ROLE_RADIO_BUTTON;
  }
  if (priv->flags.is_checked != kFlutterCheckStateNone) {
    return ATK_ROLE_CHECK_BOX;
  }
  if (priv->flags.is_toggled != kFlutterTristateNone) {
    return ATK_ROLE_TOGGLE_BUTTON;
  }
  if (priv->flags.is_slider) {
    return ATK_ROLE_SLIDER;
  }
  if (priv->flags.is_text_field && priv->flags.is_obscured) {
    return ATK_ROLE_PASSWORD_TEXT;
  }
  if (priv->flags.is_text_field) {
    return ATK_ROLE_TEXT;
  }
  if (priv->flags.is_header) {
    return ATK_ROLE_HEADER;
  }
  if (priv->flags.is_link) {
    return ATK_ROLE_LINK;
  }
  if (priv->flags.is_image) {
    return ATK_ROLE_IMAGE;
  }
 
  return ATK_ROLE_PANEL;
}
 
// Implements AtkObject::ref_state_set.
static AtkStateSet* fl_accessible_node_ref_state_set(AtkObject* accessible) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
 
  AtkStateSet* state_set = atk_state_set_new();
 
  if (!priv->flags.is_obscured) {
    atk_state_set_add_state(state_set, ATK_STATE_SHOWING);
  }
  if (!priv->flags.is_hidden) {
    atk_state_set_add_state(state_set, ATK_STATE_VISIBLE);
  }
  if (is_checkable(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_CHECKABLE);
  }
  if (is_checked(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_CHECKED);
  }
  if (is_focusable(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_FOCUSABLE);
  }
  if (is_focused(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_FOCUSED);
  }
  if (is_selected(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_SELECTED);
  }
  if (is_enabled(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_ENABLED);
  }
  if (is_sensitive(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_SENSITIVE);
  }
  if (priv->flags.is_read_only) {
    atk_state_set_add_state(state_set, ATK_STATE_READ_ONLY);
  }
  if (priv->flags.is_text_field) {
    atk_state_set_add_state(state_set, ATK_STATE_EDITABLE);
  }
 
  return state_set;
}
 
// Implements AtkComponent::get_extents.
static void fl_accessible_node_get_extents(AtkComponent* component,
                                           gint* x,
                                           gint* y,
                                           gint* width,
                                           gint* height,
                                           AtkCoordType coord_type) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(component);
 
  *x = 0;
  *y = 0;
  g_autoptr(AtkObject) parent = ATK_OBJECT(g_weak_ref_get(&priv->parent));
  if (parent != nullptr) {
    atk_component_get_extents(ATK_COMPONENT(parent), x, y, nullptr, nullptr,
                              coord_type);
  }
 
  *x += priv->x;
  *y += priv->y;
  *width = priv->width;
  *height = priv->height;
}
 
// Implements AtkComponent::get_layer.
static AtkLayer fl_accessible_node_get_layer(AtkComponent* component) {
  return ATK_LAYER_WIDGET;
}
 
// Implements AtkAction::do_action.
static gboolean fl_accessible_node_do_action(AtkAction* action, gint i) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&priv->engine));
  if (engine == nullptr) {
    return FALSE;
  }
 
  ActionData* data = get_action(priv, i);
  if (data == nullptr) {
    return FALSE;
  }
 
  fl_accessible_node_perform_action(FL_ACCESSIBLE_NODE(action), data->action,
                                    nullptr);
  return TRUE;
}
 
// Implements AtkAction::get_n_actions.
static gint fl_accessible_node_get_n_actions(AtkAction* action) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
  return priv->actions->len;
}
 
// Implements AtkAction::get_name.
static const gchar* fl_accessible_node_get_name(AtkAction* action, gint i) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
 
  ActionData* data = get_action(priv, i);
  if (data == nullptr) {
    return nullptr;
  }
 
  return data->name;
}
 
// Implements FlAccessibleNode::set_name.
static void fl_accessible_node_set_name_impl(FlAccessibleNode* self,
                                             const gchar* name) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_free(priv->name);
  priv->name = g_strdup(name);
}
 
// Implements FlAccessibleNode::set_extents.
static void fl_accessible_node_set_extents_impl(FlAccessibleNode* self,
                                                gint x,
                                                gint y,
                                                gint width,
                                                gint height) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  priv->x = x;
  priv->y = y;
  priv->width = width;
  priv->height = height;
}
 
// Check two boolean flags are different, in a way that handles true values
// being different (e.g. 1 and 2).
static bool flag_changed(bool old_flag, bool new_flag) {
  return !old_flag != !new_flag;
}
 
// Implements FlAccessibleNode::set_flags.
static void fl_accessible_node_set_flags_impl(FlAccessibleNode* self,
                                              FlutterSemanticsFlags* flags) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  FlutterSemanticsFlags old_flags = priv->flags;
  priv->flags = *flags;
 
  if (flag_changed(old_flags.is_obscured, flags->is_obscured)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SHOWING,
                                   !flags->is_obscured);
  }
  if (flag_changed(old_flags.is_hidden, flags->is_hidden)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_VISIBLE,
                                   !flags->is_hidden);
  }
  if (flag_changed(is_checkable(old_flags), is_checkable(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_CHECKABLE,
                                   is_checkable(priv->flags));
  }
  if (flag_changed(is_checked(old_flags), is_checked(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_CHECKED,
                                   is_checked(priv->flags));
  }
  if (flag_changed(is_focusable(old_flags), is_focusable(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_FOCUSABLE,
                                   is_focusable(priv->flags));
  }
  if (flag_changed(is_focused(old_flags), is_focused(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_FOCUSED,
                                   is_focused(priv->flags));
  }
  if (flag_changed(is_selected(old_flags), is_selected(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SELECTED,
                                   is_selected(priv->flags));
  }
  if (flag_changed(is_sensitive(old_flags), is_sensitive(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SENSITIVE,
                                   is_sensitive(priv->flags));
  }
  if (flag_changed(is_enabled(old_flags), is_enabled(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_ENABLED,
                                   is_enabled(priv->flags));
  }
  if (flag_changed(old_flags.is_read_only, flags->is_read_only)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_READ_ONLY,
                                   flags->is_read_only);
  }
  if (flag_changed(old_flags.is_text_field, flags->is_text_field)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_EDITABLE,
                                   flags->is_text_field);
  }
}
 
// Implements FlAccessibleNode::set_actions.
static void fl_accessible_node_set_actions_impl(
    FlAccessibleNode* self,
    FlutterSemanticsAction actions) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  // NOTE(robert-ancell): It appears that AtkAction doesn't have a method of
  // notifying that actions have changed, and even if it did an ATK client
  // might access the old IDs before checking for new ones. Keep an eye
  // out for a case where Flutter changes the actions on an item and see
  // if we can resolve this in another way.
  g_ptr_array_remove_range(priv->actions, 0, priv->actions->len);
  for (int i = 0; action_mapping[i].name != nullptr; i++) {
    if (has_action(actions, action_mapping[i].action)) {
      g_ptr_array_add(priv->actions, &action_mapping[i]);
    }
  }
}
 
// Implements FlAccessibleNode::set_value.
static void fl_accessible_node_set_value_impl(FlAccessibleNode* self,
                                              const gchar* value) {}
 
// Implements FlAccessibleNode::set_text_selection.
static void fl_accessible_node_set_text_selection_impl(FlAccessibleNode* self,
                                                       gint base,
                                                       gint extent) {}
 
// Implements FlAccessibleNode::set_text_direction.
static void fl_accessible_node_set_text_direction_impl(
    FlAccessibleNode* self,
    FlutterTextDirection direction) {}
 
// Implements FlAccessibleNode::perform_action.
static void fl_accessible_node_perform_action_impl(
    FlAccessibleNode* self,
    FlutterSemanticsAction action,
    GBytes* data) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&priv->engine));
  if (engine == nullptr) {
    return;
  }
  fl_engine_dispatch_semantics_action(engine, priv->view_id, priv->node_id,
                                      action, data);
}
 
static void fl_accessible_node_class_init(FlAccessibleNodeClass* klass) {
  G_OBJECT_CLASS(klass)->set_property = fl_accessible_node_set_property;
  G_OBJECT_CLASS(klass)->dispose = fl_accessible_node_dispose;
  ATK_OBJECT_CLASS(klass)->get_name = fl_accessible_node_get_name;
  ATK_OBJECT_CLASS(klass)->get_parent = fl_accessible_node_get_parent;
  ATK_OBJECT_CLASS(klass)->get_index_in_parent =
      fl_accessible_node_get_index_in_parent;
  ATK_OBJECT_CLASS(klass)->get_n_children = fl_accessible_node_get_n_children;
  ATK_OBJECT_CLASS(klass)->ref_child = fl_accessible_node_ref_child;
  ATK_OBJECT_CLASS(klass)->get_role = fl_accessible_node_get_role;
  ATK_OBJECT_CLASS(klass)->ref_state_set = fl_accessible_node_ref_state_set;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_name = fl_accessible_node_set_name_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_extents =
      fl_accessible_node_set_extents_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_flags =
      fl_accessible_node_set_flags_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_actions =
      fl_accessible_node_set_actions_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_value =
      fl_accessible_node_set_value_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_text_selection =
      fl_accessible_node_set_text_selection_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_text_direction =
      fl_accessible_node_set_text_direction_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->perform_action =
      fl_accessible_node_perform_action_impl;
 
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_ENGINE,
      g_param_spec_object(
          "engine", "engine", "Flutter engine", fl_engine_get_type(),
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
                                   G_PARAM_STATIC_STRINGS)));
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_VIEW_ID,
      g_param_spec_int64(
          "view-id", "view-id", "View ID that this node belongs to", 0,
          G_MAXINT64, 0,
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)));
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_ID,
      g_param_spec_int(
          "node-id", "node-id", "Accessibility node ID", 0, G_MAXINT, 0,
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
                                   G_PARAM_STATIC_STRINGS)));
}
 
static void fl_accessible_node_component_interface_init(
    AtkComponentIface* iface) {
  iface->get_extents = fl_accessible_node_get_extents;
  iface->get_layer = fl_accessible_node_get_layer;
}
 
static void fl_accessible_node_action_interface_init(AtkActionIface* iface) {
  iface->do_action = fl_accessible_node_do_action;
  iface->get_n_actions = fl_accessible_node_get_n_actions;
  iface->get_name = fl_accessible_node_get_name;
}
 
static void fl_accessible_node_init(FlAccessibleNode* self) {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_weak_ref_init(&priv->engine, nullptr);
  g_weak_ref_init(&priv->parent, nullptr);
  priv->actions = g_ptr_array_new();
  priv->children = g_ptr_array_new_with_free_func(g_object_unref);
}
 
FlAccessibleNode* fl_accessible_node_new(FlEngine* engine,
                                         FlutterViewId view_id,
                                         int32_t node_id) {
  FlAccessibleNode* self = FL_ACCESSIBLE_NODE(
      g_object_new(fl_accessible_node_get_type(), "engine", engine, "view-id",
                   view_id, "node-id", node_id, nullptr));
  return self;
}
 
void fl_accessible_node_set_parent(FlAccessibleNode* self,
                                   AtkObject* parent,
                                   gint index) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_weak_ref_set(&priv->parent, parent);
  priv->index = index;
}
 
void fl_accessible_node_set_children(FlAccessibleNode* self,
                                     GPtrArray* children) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  // Remove nodes that are no longer required.
  for (guint i = 0; i < priv->children->len;) {
    AtkObject* object = ATK_OBJECT(g_ptr_array_index(priv->children, i));
    if (has_child(children, object)) {
      i++;
    } else {
      g_signal_emit_by_name(self, "children-changed::remove", i, object,
                            nullptr);
      g_ptr_array_remove_index(priv->children, i);
    }
  }
 
  // Add new nodes.
  for (guint i = 0; i < children->len; i++) {
    AtkObject* object = ATK_OBJECT(g_ptr_array_index(children, i));
    if (!has_child(priv->children, object)) {
      g_ptr_array_add(priv->children, g_object_ref(object));
      g_signal_emit_by_name(self, "children-changed::add", i, object, nullptr);
    }
  }
}
 
void fl_accessible_node_set_name(FlAccessibleNode* self, const gchar* name) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_name(self, name);
}
 
void fl_accessible_node_set_extents(FlAccessibleNode* self,
                                    gint x,
                                    gint y,
                                    gint width,
                                    gint height) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_extents(self, x, y, width,
                                                         height);
}
 
void fl_accessible_node_set_flags(FlAccessibleNode* self,
                                  FlutterSemanticsFlags* flags) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_flags(self, flags);
}
 
void fl_accessible_node_set_actions(FlAccessibleNode* self,
                                    FlutterSemanticsAction actions) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_actions(self, actions);
}
 
void fl_accessible_node_set_value(FlAccessibleNode* self, const gchar* value) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_value(self, value);
}
 
void fl_accessible_node_set_text_selection(FlAccessibleNode* self,
                                           gint base,
                                           gint extent) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_text_selection(self, base,
                                                                extent);
}
 
void fl_accessible_node_set_text_direction(FlAccessibleNode* self,
                                           FlutterTextDirection direction) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_text_direction(self,
                                                                direction);
}
 
void fl_accessible_node_perform_action(FlAccessibleNode* self,
                                       FlutterSemanticsAction action,
                                       GBytes* data) {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->perform_action(self, action, data);
}

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
PROP_0
PROP_ENGINE
PROP_VIEW_ID
PROP_ID
PROP_LAST

Definition at line 66 of file fl_accessible_node.cc.

{ PROP_0, PROP_ENGINE, PROP_VIEW_ID, PROP_ID, PROP_LAST };

Function Documentation

fl_accessible_node_action_interface_init()

static void fl_accessible_node_action_interface_init ( AtkActionIface *  iface )

static

Definition at line 544 of file fl_accessible_node.cc.

                                                                            {
  iface->do_action = fl_accessible_node_do_action;
  iface->get_n_actions = fl_accessible_node_get_n_actions;
  iface->get_name = fl_accessible_node_get_name;
}

References fl_accessible_node_do_action(), fl_accessible_node_get_n_actions(), and fl_accessible_node_get_name().

fl_accessible_node_class_init()

static void fl_accessible_node_class_init ( FlAccessibleNodeClass *  klass )

static

Definition at line 491 of file fl_accessible_node.cc.

                                                                        {
  G_OBJECT_CLASS(klass)->set_property = fl_accessible_node_set_property;
  G_OBJECT_CLASS(klass)->dispose = fl_accessible_node_dispose;
  ATK_OBJECT_CLASS(klass)->get_name = fl_accessible_node_get_name;
  ATK_OBJECT_CLASS(klass)->get_parent = fl_accessible_node_get_parent;
  ATK_OBJECT_CLASS(klass)->get_index_in_parent =
      fl_accessible_node_get_index_in_parent;
  ATK_OBJECT_CLASS(klass)->get_n_children = fl_accessible_node_get_n_children;
  ATK_OBJECT_CLASS(klass)->ref_child = fl_accessible_node_ref_child;
  ATK_OBJECT_CLASS(klass)->get_role = fl_accessible_node_get_role;
  ATK_OBJECT_CLASS(klass)->ref_state_set = fl_accessible_node_ref_state_set;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_name = fl_accessible_node_set_name_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_extents =
      fl_accessible_node_set_extents_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_flags =
      fl_accessible_node_set_flags_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_actions =
      fl_accessible_node_set_actions_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_value =
      fl_accessible_node_set_value_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_text_selection =
      fl_accessible_node_set_text_selection_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->set_text_direction =
      fl_accessible_node_set_text_direction_impl;
  FL_ACCESSIBLE_NODE_CLASS(klass)->perform_action =
      fl_accessible_node_perform_action_impl;
 
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_ENGINE,
      g_param_spec_object(
          "engine", "engine", "Flutter engine", fl_engine_get_type(),
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
                                   G_PARAM_STATIC_STRINGS)));
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_VIEW_ID,
      g_param_spec_int64(
          "view-id", "view-id", "View ID that this node belongs to", 0,
          G_MAXINT64, 0,
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY)));
  g_object_class_install_property(
      G_OBJECT_CLASS(klass), PROP_ID,
      g_param_spec_int(
          "node-id", "node-id", "Accessibility node ID", 0, G_MAXINT, 0,
          static_cast<GParamFlags>(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
                                   G_PARAM_STATIC_STRINGS)));
}

References fl_accessible_node_dispose(), fl_accessible_node_get_index_in_parent(), fl_accessible_node_get_n_children(), fl_accessible_node_get_name(), fl_accessible_node_get_parent(), fl_accessible_node_get_role(), fl_accessible_node_perform_action_impl(), fl_accessible_node_ref_child(), fl_accessible_node_ref_state_set(), fl_accessible_node_set_actions_impl(), fl_accessible_node_set_extents_impl(), fl_accessible_node_set_flags_impl(), fl_accessible_node_set_name_impl(), fl_accessible_node_set_property(), fl_accessible_node_set_text_direction_impl(), fl_accessible_node_set_text_selection_impl(), fl_accessible_node_set_value_impl(), PROP_ENGINE, PROP_ID, and PROP_VIEW_ID.

fl_accessible_node_component_interface_init()

static void fl_accessible_node_component_interface_init ( AtkComponentIface *  iface )

static

Definition at line 538 of file fl_accessible_node.cc.

                              {
  iface->get_extents = fl_accessible_node_get_extents;
  iface->get_layer = fl_accessible_node_get_layer;
}

References fl_accessible_node_get_extents(), and fl_accessible_node_get_layer().

fl_accessible_node_dispose()

static void fl_accessible_node_dispose ( GObject *  object )

static

Definition at line 169 of file fl_accessible_node.cc.

                                                        {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(object);
 
  g_weak_ref_clear(&priv->engine);
  g_weak_ref_clear(&priv->parent);
  g_clear_pointer(&priv->name, g_free);
  g_clear_pointer(&priv->actions, g_ptr_array_unref);
  g_clear_pointer(&priv->children, g_ptr_array_unref);
 
  G_OBJECT_CLASS(fl_accessible_node_parent_class)->dispose(object);
}

References FlAccessibilityHandlerPrivate::engine, FL_ACCESSIBLE_NODE_GET_PRIVATE, and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_do_action()

static gboolean fl_accessible_node_do_action ( AtkAction *  action, gint  i  )

static

Definition at line 327 of file fl_accessible_node.cc.

                                                                        {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
 
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&priv->engine));
  if (engine == nullptr) {
    return FALSE;
  }
 
  ActionData* data = get_action(priv, i);
  if (data == nullptr) {
    return FALSE;
  }
 
  fl_accessible_node_perform_action(FL_ACCESSIBLE_NODE(action), data->action,
                                    nullptr);
  return TRUE;
}

References action, engine, FlAccessibilityHandlerPrivate::engine, FL_ACCESSIBLE_NODE_GET_PRIVATE, fl_accessible_node_perform_action(), g_autoptr(), get_action(), i, priv, and TRUE.

Referenced by fl_accessible_node_action_interface_init().

fl_accessible_node_get_extents()

static void fl_accessible_node_get_extents ( AtkComponent *  component, gint *  x, gint *  y, gint *  width, gint *  height, AtkCoordType  coord_type  )

static

Definition at line 299 of file fl_accessible_node.cc.

                                                                    {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(component);
 
  *x = 0;
  *y = 0;
  g_autoptr(AtkObject) parent = ATK_OBJECT(g_weak_ref_get(&priv->parent));
  if (parent != nullptr) {
    atk_component_get_extents(ATK_COMPONENT(parent), x, y, nullptr, nullptr,
                              coord_type);
  }
 
  *x += priv->x;
  *y += priv->y;
  *width = priv->width;
  *height = priv->height;
}

References FL_ACCESSIBLE_NODE_GET_PRIVATE, g_autoptr(), height, priv, width, x, and y.

Referenced by fl_accessible_node_component_interface_init().

fl_accessible_node_get_index_in_parent()

static gint fl_accessible_node_get_index_in_parent ( AtkObject *  accessible )

static

Definition at line 195 of file fl_accessible_node.cc.

                                                                          {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->index;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_get_layer()

static AtkLayer fl_accessible_node_get_layer ( AtkComponent *  component )

static

Definition at line 322 of file fl_accessible_node.cc.

                                                                      {
  return ATK_LAYER_WIDGET;
}

Referenced by fl_accessible_node_component_interface_init().

fl_accessible_node_get_n_actions()

static gint fl_accessible_node_get_n_actions ( AtkAction *  action )

static

Definition at line 346 of file fl_accessible_node.cc.

                                                                {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
  return priv->actions->len;
}

References action, FL_ACCESSIBLE_NODE_GET_PRIVATE, and priv.

Referenced by fl_accessible_node_action_interface_init().

fl_accessible_node_get_n_children()

static gint fl_accessible_node_get_n_children ( AtkObject *  accessible )

static

Definition at line 201 of file fl_accessible_node.cc.

                                                                     {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->children->len;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_get_name() [1/2]

static const gchar * fl_accessible_node_get_name ( AtkAction *  action, gint  i  )

static

Definition at line 352 of file fl_accessible_node.cc.

                                                                           {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(action);
 
  ActionData* data = get_action(priv, i);
  if (data == nullptr) {
    return nullptr;
  }
 
  return data->name;
}

References action, FL_ACCESSIBLE_NODE_GET_PRIVATE, get_action(), i, and priv.

fl_accessible_node_get_name() [2/2]

static const gchar * fl_accessible_node_get_name ( AtkObject *  accessible )

static

Definition at line 182 of file fl_accessible_node.cc.

                                                                       {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  return priv->name;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, and priv.

Referenced by fl_accessible_node_action_interface_init(), and fl_accessible_node_class_init().

fl_accessible_node_get_parent()

static AtkObject * fl_accessible_node_get_parent ( AtkObject *  accessible )

static

Definition at line 188 of file fl_accessible_node.cc.

                                                                       {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  g_autoptr(AtkObject) parent = ATK_OBJECT(g_weak_ref_get(&priv->parent));
  return parent;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, g_autoptr(), and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_get_role()

static AtkRole fl_accessible_node_get_role ( AtkObject *  accessible )

static

Definition at line 218 of file fl_accessible_node.cc.

                                                                  {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
  if (priv->flags.is_button) {
    return ATK_ROLE_PUSH_BUTTON;
  }
  if (priv->flags.is_in_mutually_exclusive_group &&
      priv->flags.is_checked != kFlutterCheckStateNone) {
    return ATK_ROLE_RADIO_BUTTON;
  }
  if (priv->flags.is_checked != kFlutterCheckStateNone) {
    return ATK_ROLE_CHECK_BOX;
  }
  if (priv->flags.is_toggled != kFlutterTristateNone) {
    return ATK_ROLE_TOGGLE_BUTTON;
  }
  if (priv->flags.is_slider) {
    return ATK_ROLE_SLIDER;
  }
  if (priv->flags.is_text_field && priv->flags.is_obscured) {
    return ATK_ROLE_PASSWORD_TEXT;
  }
  if (priv->flags.is_text_field) {
    return ATK_ROLE_TEXT;
  }
  if (priv->flags.is_header) {
    return ATK_ROLE_HEADER;
  }
  if (priv->flags.is_link) {
    return ATK_ROLE_LINK;
  }
  if (priv->flags.is_image) {
    return ATK_ROLE_IMAGE;
  }
 
  return ATK_ROLE_PANEL;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, kFlutterCheckStateNone, kFlutterTristateNone, and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_init()

static void fl_accessible_node_init ( FlAccessibleNode *  self )

static

Definition at line 550 of file fl_accessible_node.cc.

                                                            {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_weak_ref_init(&priv->engine, nullptr);
  g_weak_ref_init(&priv->parent, nullptr);
  priv->actions = g_ptr_array_new();
  priv->children = g_ptr_array_new_with_free_func(g_object_unref);
}

References FlAccessibilityHandlerPrivate::engine, FL_ACCESSIBLE_NODE_GET_PRIVATE, priv, and self.

fl_accessible_node_new()

FlAccessibleNode * fl_accessible_node_new	(	FlEngine *	engine,
		FlutterViewId	view_id,
		int32_t	node_id
	)

fl_accessible_node_new: @engine: the #FlEngine this node came from. @view_id: the view ID this object represents. @node_id: the semantics node ID this object represents.

Creates a new accessibility object that exposes Flutter accessibility information to ATK.

Returns: a new #FlAccessibleNode.

Definition at line 558 of file fl_accessible_node.cc.

                                                          {
  FlAccessibleNode* self = FL_ACCESSIBLE_NODE(
      g_object_new(fl_accessible_node_get_type(), "engine", engine, "view-id",
                   view_id, "node-id", node_id, nullptr));
  return self;
}

References engine, self, and view_id.

Referenced by create_node(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

fl_accessible_node_perform_action()

void fl_accessible_node_perform_action	(	FlAccessibleNode *	node,
		FlutterSemanticsAction	action,
		GBytes *	data
	)

fl_accessible_node_perform_action: @node: an #FlAccessibleNode. @action: the action being dispatched. @data: (allow-none): data associated with the action.

Performs a semantic action for this node.

Definition at line 657 of file fl_accessible_node.cc.

                                                     {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->perform_action(self, action, data);
}

References action, and self.

Referenced by fl_accessible_node_do_action(), fl_accessible_text_field_copy_text(), fl_accessible_text_field_cut_text(), fl_accessible_text_field_paste_text(), perform_set_selection_action(), and perform_set_text_action().

fl_accessible_node_perform_action_impl()

static void fl_accessible_node_perform_action_impl ( FlAccessibleNode *  self, FlutterSemanticsAction  action, GBytes *  data  )

static

Definition at line 478 of file fl_accessible_node.cc.

                  {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_autoptr(FlEngine) engine = FL_ENGINE(g_weak_ref_get(&priv->engine));
  if (engine == nullptr) {
    return;
  }
  fl_engine_dispatch_semantics_action(engine, priv->view_id, priv->node_id,
                                      action, data);
}

References action, engine, FlAccessibilityHandlerPrivate::engine, FL_ACCESSIBLE_NODE_GET_PRIVATE, fl_engine_dispatch_semantics_action(), g_autoptr(), priv, and self.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_ref_child()

static AtkObject * fl_accessible_node_ref_child ( AtkObject *  accessible, gint  i  )

static

Definition at line 207 of file fl_accessible_node.cc.

                                                                              {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
 
  if (i < 0 || static_cast<guint>(i) >= priv->children->len) {
    return nullptr;
  }
 
  return ATK_OBJECT(g_object_ref(g_ptr_array_index(priv->children, i)));
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, i, and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_ref_state_set()

static AtkStateSet * fl_accessible_node_ref_state_set ( AtkObject *  accessible )

static

Definition at line 256 of file fl_accessible_node.cc.

                                                                            {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(accessible);
 
  AtkStateSet* state_set = atk_state_set_new();
 
  if (!priv->flags.is_obscured) {
    atk_state_set_add_state(state_set, ATK_STATE_SHOWING);
  }
  if (!priv->flags.is_hidden) {
    atk_state_set_add_state(state_set, ATK_STATE_VISIBLE);
  }
  if (is_checkable(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_CHECKABLE);
  }
  if (is_checked(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_CHECKED);
  }
  if (is_focusable(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_FOCUSABLE);
  }
  if (is_focused(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_FOCUSED);
  }
  if (is_selected(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_SELECTED);
  }
  if (is_enabled(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_ENABLED);
  }
  if (is_sensitive(priv->flags)) {
    atk_state_set_add_state(state_set, ATK_STATE_SENSITIVE);
  }
  if (priv->flags.is_read_only) {
    atk_state_set_add_state(state_set, ATK_STATE_READ_ONLY);
  }
  if (priv->flags.is_text_field) {
    atk_state_set_add_state(state_set, ATK_STATE_EDITABLE);
  }
 
  return state_set;
}

References accessible, FL_ACCESSIBLE_NODE_GET_PRIVATE, is_checked(), is_enabled(), is_focusable(), is_focused(), is_selected(), is_sensitive(), and priv.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_actions()

void fl_accessible_node_set_actions	(	FlAccessibleNode *	node,
		FlutterSemanticsAction	actions
	)

fl_accessible_node_set_actions: @node: an #FlAccessibleNode. @actions: the actions this node can perform.

Sets the actions that this node can perform.

Definition at line 627 of file fl_accessible_node.cc.

                                                                    {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_actions(self, actions);
}

References self.

Referenced by fl_view_accessible_handle_update_semantics(), TEST_F(), TEST_F(), and TEST_F().

fl_accessible_node_set_actions_impl()

static void fl_accessible_node_set_actions_impl ( FlAccessibleNode *  self, FlutterSemanticsAction  actions  )

static

Definition at line 445 of file fl_accessible_node.cc.

                                    {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  // NOTE(robert-ancell): It appears that AtkAction doesn't have a method of
  // notifying that actions have changed, and even if it did an ATK client
  // might access the old IDs before checking for new ones. Keep an eye
  // out for a case where Flutter changes the actions on an item and see
  // if we can resolve this in another way.
  g_ptr_array_remove_range(priv->actions, 0, priv->actions->len);
  for (int i = 0; action_mapping[i].name != nullptr; i++) {
    if (has_action(actions, action_mapping[i].action)) {
      g_ptr_array_add(priv->actions, &action_mapping[i]);
    }
  }
}

References action, action_mapping, FL_ACCESSIBLE_NODE_GET_PRIVATE, has_action(), i, ActionData::name, priv, and self.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_children()

void fl_accessible_node_set_children	(	FlAccessibleNode *	node,
		GPtrArray *	children
	)

fl_accessible_node_set_children: @node: an #FlAccessibleNode. @children: (transfer none) (element-type AtkObject): a list of #AtkObject.

Sets the children of this node. The children can be changed at any time.

Definition at line 576 of file fl_accessible_node.cc.

                                                          {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  // Remove nodes that are no longer required.
  for (guint i = 0; i < priv->children->len;) {
    AtkObject* object = ATK_OBJECT(g_ptr_array_index(priv->children, i));
    if (has_child(children, object)) {
      i++;
    } else {
      g_signal_emit_by_name(self, "children-changed::remove", i, object,
                            nullptr);
      g_ptr_array_remove_index(priv->children, i);
    }
  }
 
  // Add new nodes.
  for (guint i = 0; i < children->len; i++) {
    AtkObject* object = ATK_OBJECT(g_ptr_array_index(children, i));
    if (!has_child(priv->children, object)) {
      g_ptr_array_add(priv->children, g_object_ref(object));
      g_signal_emit_by_name(self, "children-changed::add", i, object, nullptr);
    }
  }
}

References FL_ACCESSIBLE_NODE_GET_PRIVATE, has_child(), i, priv, and self.

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

fl_accessible_node_set_extents()

void fl_accessible_node_set_extents	(	FlAccessibleNode *	node,
		gint	x,
		gint	y,
		gint	width,
		gint	height
	)

fl_accessible_node_set_extents: @node: an #FlAccessibleNode. @x: x co-ordinate of this node relative to its parent. @y: y co-ordinate of this node relative to its parent. @width: width of this node in pixels. @height: height of this node in pixels.

Sets the position and size of this node.

Definition at line 609 of file fl_accessible_node.cc.

                                                 {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_extents(self, x, y, width,
                                                         height);
}

References height, self, width, x, and y.

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

fl_accessible_node_set_extents_impl()

static void fl_accessible_node_set_extents_impl ( FlAccessibleNode *  self, gint  x, gint  y, gint  width, gint  height  )

static

Definition at line 372 of file fl_accessible_node.cc.

                                                             {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  priv->x = x;
  priv->y = y;
  priv->width = width;
  priv->height = height;
}

References FL_ACCESSIBLE_NODE_GET_PRIVATE, height, priv, self, width, x, and y.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_flags()

void fl_accessible_node_set_flags	(	FlAccessibleNode *	node,
		FlutterSemanticsFlags *	flags
	)

fl_accessible_node_set_flags: @node: an #FlAccessibleNode. @flags: the flags for this node.

Sets the flags for this node.

Definition at line 620 of file fl_accessible_node.cc.

                                                                {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_flags(self, flags);
}

References self.

Referenced by fl_view_accessible_handle_update_semantics(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

fl_accessible_node_set_flags_impl()

static void fl_accessible_node_set_flags_impl ( FlAccessibleNode *  self, FlutterSemanticsFlags *  flags  )

static

Definition at line 391 of file fl_accessible_node.cc.

                                                                            {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
 
  FlutterSemanticsFlags old_flags = priv->flags;
  priv->flags = *flags;
 
  if (flag_changed(old_flags.is_obscured, flags->is_obscured)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SHOWING,
                                   !flags->is_obscured);
  }
  if (flag_changed(old_flags.is_hidden, flags->is_hidden)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_VISIBLE,
                                   !flags->is_hidden);
  }
  if (flag_changed(is_checkable(old_flags), is_checkable(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_CHECKABLE,
                                   is_checkable(priv->flags));
  }
  if (flag_changed(is_checked(old_flags), is_checked(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_CHECKED,
                                   is_checked(priv->flags));
  }
  if (flag_changed(is_focusable(old_flags), is_focusable(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_FOCUSABLE,
                                   is_focusable(priv->flags));
  }
  if (flag_changed(is_focused(old_flags), is_focused(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_FOCUSED,
                                   is_focused(priv->flags));
  }
  if (flag_changed(is_selected(old_flags), is_selected(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SELECTED,
                                   is_selected(priv->flags));
  }
  if (flag_changed(is_sensitive(old_flags), is_sensitive(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_SENSITIVE,
                                   is_sensitive(priv->flags));
  }
  if (flag_changed(is_enabled(old_flags), is_enabled(priv->flags))) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_ENABLED,
                                   is_enabled(priv->flags));
  }
  if (flag_changed(old_flags.is_read_only, flags->is_read_only)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_READ_ONLY,
                                   flags->is_read_only);
  }
  if (flag_changed(old_flags.is_text_field, flags->is_text_field)) {
    atk_object_notify_state_change(ATK_OBJECT(self), ATK_STATE_EDITABLE,
                                   flags->is_text_field);
  }
}

References atk_object_notify_state_change(), FL_ACCESSIBLE_NODE_GET_PRIVATE, flag_changed(), is_checked(), is_enabled(), is_focusable(), is_focused(), FlutterSemanticsFlags::is_hidden, FlutterSemanticsFlags::is_obscured, FlutterSemanticsFlags::is_read_only, is_selected(), is_sensitive(), FlutterSemanticsFlags::is_text_field, priv, and self.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_name()

void fl_accessible_node_set_name	(	FlAccessibleNode *	self,
		const gchar *	name
	)

Definition at line 603 of file fl_accessible_node.cc.

                                                                            {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_name(self, name);
}

References name, and self.

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

fl_accessible_node_set_name_impl()

static void fl_accessible_node_set_name_impl ( FlAccessibleNode *  self, const gchar *  name  )

static

Definition at line 364 of file fl_accessible_node.cc.

                                                                {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_free(priv->name);
  priv->name = g_strdup(name);
}

References FL_ACCESSIBLE_NODE_GET_PRIVATE, name, priv, and self.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_parent()

void fl_accessible_node_set_parent	(	FlAccessibleNode *	node,
		AtkObject *	parent,
		gint	index
	)

fl_accessible_node_set_parent: @node: an #FlAccessibleNode. @parent: an #AtkObject. @index: the index of this node in the parent.

Sets the parent of this node. The parent can be changed at any time.

Definition at line 567 of file fl_accessible_node.cc.

                                               {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(self);
  g_weak_ref_set(&priv->parent, parent);
  priv->index = index;
}

References FL_ACCESSIBLE_NODE_GET_PRIVATE, priv, and self.

Referenced by fl_view_accessible_handle_update_semantics(), get_node(), TEST_F(), and TEST_F().

fl_accessible_node_set_property()

static void fl_accessible_node_set_property ( GObject *  object, guint  prop_id, const GValue *  value, GParamSpec *  pspec  )

static

Definition at line 148 of file fl_accessible_node.cc.

                                                               {
  FlAccessibleNodePrivate* priv = FL_ACCESSIBLE_NODE_GET_PRIVATE(object);
  switch (prop_id) {
    case PROP_ENGINE:
      g_weak_ref_set(&priv->engine, g_value_get_object(value));
      break;
    case PROP_VIEW_ID:
      priv->view_id = g_value_get_int64(value);
      break;
    case PROP_ID:
      priv->node_id = g_value_get_int(value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
      break;
  }
}

References FlAccessibilityHandlerPrivate::engine, FL_ACCESSIBLE_NODE_GET_PRIVATE, priv, PROP_ENGINE, PROP_ID, prop_id, PROP_VIEW_ID, pspec, and value.

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_text_direction()

void fl_accessible_node_set_text_direction	(	FlAccessibleNode *	node,
		FlutterTextDirection	direction
	)

fl_accessible_node_set_text_direction: @node: an #FlAccessibleNode. @direction: the direction of the text.

Sets the text direction of this node.

Definition at line 649 of file fl_accessible_node.cc.

                                                                           {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_text_direction(self,
                                                                direction);
}

References self.

Referenced by fl_view_accessible_handle_update_semantics().

fl_accessible_node_set_text_direction_impl()

static void fl_accessible_node_set_text_direction_impl ( FlAccessibleNode *  self, FlutterTextDirection  direction  )

static

Definition at line 473 of file fl_accessible_node.cc.

                                    {}

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_text_selection()

void fl_accessible_node_set_text_selection	(	FlAccessibleNode *	node,
		gint	base,
		gint	extent
	)

fl_accessible_node_set_text_selection: @node: an #FlAccessibleNode. @base: the position at which the text selection originates. @extent: the position at which the text selection terminates.

Sets the text selection of this node.

Definition at line 640 of file fl_accessible_node.cc.

                                                        {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_text_selection(self, base,
                                                                extent);
}

References self.

Referenced by fl_view_accessible_handle_update_semantics(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

fl_accessible_node_set_text_selection_impl()

static void fl_accessible_node_set_text_selection_impl ( FlAccessibleNode *  self, gint  base, gint  extent  )

static

Definition at line 468 of file fl_accessible_node.cc.

                                                                    {}

Referenced by fl_accessible_node_class_init().

fl_accessible_node_set_value()

void fl_accessible_node_set_value	(	FlAccessibleNode *	node,
		const gchar *	value
	)

fl_accessible_node_set_value: @node: an #FlAccessibleNode. @value: a node value.

Sets the value of this node.

Definition at line 634 of file fl_accessible_node.cc.

                                                                              {
  g_return_if_fail(FL_IS_ACCESSIBLE_NODE(self));
 
  return FL_ACCESSIBLE_NODE_GET_CLASS(self)->set_value(self, value);
}

References self, and value.

Referenced by fl_view_accessible_handle_update_semantics(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

fl_accessible_node_set_value_impl()

static void fl_accessible_node_set_value_impl ( FlAccessibleNode *  self, const gchar *  value  )

static

Definition at line 464 of file fl_accessible_node.cc.

                                                                  {}

Referenced by fl_accessible_node_class_init().

flag_changed()

static bool flag_changed ( bool  old_flag, bool  new_flag  )

static

Definition at line 386 of file fl_accessible_node.cc.

                                                       {
  return !old_flag != !new_flag;
}

Referenced by fl_accessible_node_set_flags_impl().

G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	FlAccessibleNode	,
		fl_accessible_node	,
		ATK_TYPE_OBJECT	,
		G_IMPLEMENT_INTERFACE(ATK_TYPE_COMPONENT, fl_accessible_node_component_interface_init) G_IMPLEMENT_INTERFACE(ATK_TYPE_ACTION, fl_accessible_node_action_interface_init)
	)

Definition at line 76 of file fl_accessible_node.cc.

                                                          {
  return flags.is_checked != kFlutterCheckStateNone ||
         flags.is_toggled != kFlutterTristateNone;
}

References FlutterSemanticsFlags::is_checked, FlutterSemanticsFlags::is_toggled, kFlutterCheckStateNone, and kFlutterTristateNone.

get_action()

static ActionData * get_action ( FlAccessibleNodePrivate *  priv, gint  index  )

static

Definition at line 130 of file fl_accessible_node.cc.

                                                                         {
  if (index < 0 || static_cast<guint>(index) >= priv->actions->len) {
    return nullptr;
  }
  return static_cast<ActionData*>(g_ptr_array_index(priv->actions, index));
}

References priv.

Referenced by fl_accessible_node_do_action(), and fl_accessible_node_get_name().

has_action()

static gboolean has_action ( FlutterSemanticsAction  actions, FlutterSemanticsAction  action  )

static

Definition at line 124 of file fl_accessible_node.cc.

                                                          {
  return (actions & action) != 0;
}

References action.

Referenced by fl_accessible_node_set_actions_impl().

has_child()

static gboolean has_child ( GPtrArray *  children, AtkObject *  object  )

static

Definition at line 138 of file fl_accessible_node.cc.

                                                                  {
  for (guint i = 0; i < children->len; i++) {
    if (g_ptr_array_index(children, i) == object) {
      return TRUE;
    }
  }
 
  return FALSE;
}

References i, and TRUE.

Referenced by fl_accessible_node_set_children().

is_checked()

static gboolean is_checked ( FlutterSemanticsFlags  flags )

static

Definition at line 93 of file fl_accessible_node.cc.

                                                        {
  return flags.is_checked == kFlutterCheckStateTrue ||
         flags.is_toggled == kFlutterTristateTrue;
}

References FlutterSemanticsFlags::is_checked, FlutterSemanticsFlags::is_toggled, kFlutterCheckStateTrue, and kFlutterTristateTrue.

Referenced by fl_accessible_node_ref_state_set(), and fl_accessible_node_set_flags_impl().

is_enabled()

static gboolean is_enabled ( FlutterSemanticsFlags  flags )

static

Definition at line 119 of file fl_accessible_node.cc.

                                                        {
  return flags.is_enabled == kFlutterTristateTrue;
}

References FlutterSemanticsFlags::is_enabled, and kFlutterTristateTrue.

Referenced by find_stage_by_record(), fl_accessible_node_ref_state_set(), fl_accessible_node_set_flags_impl(), and ui::AXEventGenerator::OnIntAttributeChanged().

is_focusable()

static gboolean is_focusable ( FlutterSemanticsFlags  flags )

static

Definition at line 99 of file fl_accessible_node.cc.

                                                          {
  return flags.is_focused != kFlutterTristateNone;
}

References FlutterSemanticsFlags::is_focused, and kFlutterTristateNone.

Referenced by fl_accessible_node_ref_state_set(), and fl_accessible_node_set_flags_impl().

is_focused()

static gboolean is_focused ( FlutterSemanticsFlags  flags )

static

Definition at line 104 of file fl_accessible_node.cc.

                                                        {
  return flags.is_focused == kFlutterTristateTrue;
}

References FlutterSemanticsFlags::is_focused, and kFlutterTristateTrue.

Referenced by fl_accessible_node_ref_state_set(), fl_accessible_node_set_flags_impl(), and window_state_event_cb().

is_selected()

static gboolean is_selected ( FlutterSemanticsFlags  flags )

static

Definition at line 109 of file fl_accessible_node.cc.

                                                         {
  return flags.is_selected == kFlutterTristateTrue;
}

References FlutterSemanticsFlags::is_selected, and kFlutterTristateTrue.

Referenced by fl_accessible_node_ref_state_set(), fl_accessible_node_set_flags_impl(), and ui::TEST_F().

is_sensitive()

static gboolean is_sensitive ( FlutterSemanticsFlags  flags )

static

Definition at line 114 of file fl_accessible_node.cc.

                                                          {
  return flags.is_enabled != kFlutterTristateNone;
}

References FlutterSemanticsFlags::is_enabled, and kFlutterTristateNone.

Referenced by fl_accessible_node_ref_state_set(), and fl_accessible_node_set_flags_impl().

Variable Documentation

action_mapping

ActionData action_mapping[]

static

Initial value:

= {
    {kFlutterSemanticsActionTap, "Tap"},
    {kFlutterSemanticsActionLongPress, "LongPress"},
    {kFlutterSemanticsActionScrollLeft, "ScrollLeft"},
    {kFlutterSemanticsActionScrollRight, "ScrollRight"},
    {kFlutterSemanticsActionScrollUp, "ScrollUp"},
    {kFlutterSemanticsActionScrollDown, "ScrollDown"},
    {kFlutterSemanticsActionIncrease, "Increase"},
    {kFlutterSemanticsActionDecrease, "Decrease"},
    {kFlutterSemanticsActionShowOnScreen, "ShowOnScreen"},
    {kFlutterSemanticsActionMoveCursorForwardByCharacter,
     "MoveCursorForwardByCharacter"},
    {kFlutterSemanticsActionMoveCursorBackwardByCharacter,
     "MoveCursorBackwardByCharacter"},
    {kFlutterSemanticsActionCopy, "Copy"},
    {kFlutterSemanticsActionCut, "Cut"},
    {kFlutterSemanticsActionPaste, "Paste"},
    {kFlutterSemanticsActionDidGainAccessibilityFocus,
     "DidGainAccessibilityFocus"},
    {kFlutterSemanticsActionDidLoseAccessibilityFocus,
     "DidLoseAccessibilityFocus"},
    {kFlutterSemanticsActionCustomAction, "CustomAction"},
    {kFlutterSemanticsActionDismiss, "Dismiss"},
    {kFlutterSemanticsActionMoveCursorForwardByWord, "MoveCursorForwardByWord"},
    {kFlutterSemanticsActionMoveCursorBackwardByWord,
     "MoveCursorBackwardByWord"},
    {kFlutterSemanticsActionFocus, "Focus"},
    {kFlutterSemanticsActionExpand, "Expand"},
    {kFlutterSemanticsActionCollapse, "Collapse"},
    {static_cast<FlutterSemanticsAction>(0), nullptr}}

Definition at line 13 of file fl_accessible_node.cc.

                                     {
    {kFlutterSemanticsActionTap, "Tap"},
    {kFlutterSemanticsActionLongPress, "LongPress"},
    {kFlutterSemanticsActionScrollLeft, "ScrollLeft"},
    {kFlutterSemanticsActionScrollRight, "ScrollRight"},
    {kFlutterSemanticsActionScrollUp, "ScrollUp"},
    {kFlutterSemanticsActionScrollDown, "ScrollDown"},
    {kFlutterSemanticsActionIncrease, "Increase"},
    {kFlutterSemanticsActionDecrease, "Decrease"},
    {kFlutterSemanticsActionShowOnScreen, "ShowOnScreen"},
    {kFlutterSemanticsActionMoveCursorForwardByCharacter,
     "MoveCursorForwardByCharacter"},
    {kFlutterSemanticsActionMoveCursorBackwardByCharacter,
     "MoveCursorBackwardByCharacter"},
    {kFlutterSemanticsActionCopy, "Copy"},
    {kFlutterSemanticsActionCut, "Cut"},
    {kFlutterSemanticsActionPaste, "Paste"},
    {kFlutterSemanticsActionDidGainAccessibilityFocus,
     "DidGainAccessibilityFocus"},
    {kFlutterSemanticsActionDidLoseAccessibilityFocus,
     "DidLoseAccessibilityFocus"},
    {kFlutterSemanticsActionCustomAction, "CustomAction"},
    {kFlutterSemanticsActionDismiss, "Dismiss"},
    {kFlutterSemanticsActionMoveCursorForwardByWord, "MoveCursorForwardByWord"},
    {kFlutterSemanticsActionMoveCursorBackwardByWord,
     "MoveCursorBackwardByWord"},
    {kFlutterSemanticsActionFocus, "Focus"},
    {kFlutterSemanticsActionExpand, "Expand"},
    {kFlutterSemanticsActionCollapse, "Collapse"},
    {static_cast<FlutterSemanticsAction>(0), nullptr}};

Referenced by fl_accessible_node_set_actions_impl().