fl_accessible_node.h File Reference

#include <atk/atk.h>
#include <gio/gio.h>
#include "flutter/shell/platform/embedder/embedder.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_engine.h"

Go to the source code of this file.

Classes
struct	_FlAccessibleNodeClass

Functions
G_BEGIN_DECLS	G_DECLARE_DERIVABLE_TYPE (FlAccessibleNode, fl_accessible_node, FL, ACCESSIBLE_NODE, AtkObject)
FlAccessibleNode *	fl_accessible_node_new (FlEngine *engine, FlutterViewId view_id, int32_t node_id)
void	fl_accessible_node_set_parent (FlAccessibleNode *node, AtkObject *parent, gint index)
void	fl_accessible_node_set_children (FlAccessibleNode *node, GPtrArray *children)
: a node name.
fl_accessible_node_set_name: @node: an #FlAccessibleNode. Sets the name of this node as reported to the a11y consumer.
void	fl_accessible_node_set_name (FlAccessibleNode *node, const gchar *name)
void	fl_accessible_node_set_extents (FlAccessibleNode *node, gint x, gint y, gint width, gint height)
void	fl_accessible_node_set_flags (FlAccessibleNode *node, FlutterSemanticsFlags *flags)
void	fl_accessible_node_set_actions (FlAccessibleNode *node, FlutterSemanticsAction actions)
void	fl_accessible_node_set_value (FlAccessibleNode *node, const gchar *value)
void	fl_accessible_node_set_text_selection (FlAccessibleNode *node, gint base, gint extent)
void	fl_accessible_node_set_text_direction (FlAccessibleNode *node, FlutterTextDirection direction)
void	fl_accessible_node_perform_action (FlAccessibleNode *node, FlutterSemanticsAction action, GBytes *data)

Function Documentation

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 722 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 view_id.

Referenced by create_node(), 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 821 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);
}

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_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 791 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);
}

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

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 740 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, and priv.

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 773 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, width, x, and y.

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

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 784 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);
}

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

fl_accessible_node_set_name()

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

Definition at line 767 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);
}

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

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 731 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, and priv.

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

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 813 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);
}

Referenced by fl_view_accessible_handle_update_semantics().

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 804 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);
}

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

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 798 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 value.

Referenced by fl_view_accessible_handle_update_semantics(), and TEST_F().

G_DECLARE_DERIVABLE_TYPE()

G_BEGIN_DECLS G_DECLARE_DERIVABLE_TYPE	(	FlAccessibleNode	,
		fl_accessible_node	,
		FL	,
		ACCESSIBLE_NODE	,
		AtkObject
	)