2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2007 IBM Corp.
6 * Copyright 2010, 2011 Novell, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #include "atspi-private.h"
26 /* TODO: Improve documentation and implement some missing functions */
29 * atspi_collection_is_ancestor_of:
31 * Not yet implemented.
35 atspi_collection_is_ancestor_of (AtspiCollection *collection,
36 AtspiAccessible *test,
39 g_warning ("Atspi: TODO: Implement is_ancestor_of");
44 new_message (AtspiCollection *collection, char *method)
46 AtspiAccessible *accessible;
51 accessible = ATSPI_ACCESSIBLE (collection);
52 if (!accessible->parent.app)
54 return dbus_message_new_method_call (accessible->parent.app->bus_name,
55 accessible->parent.path,
56 atspi_interface_collection,
61 append_match_rule (DBusMessage *message, AtspiMatchRule *rule)
65 dbus_message_iter_init_append (message, &iter);
66 return _atspi_match_rule_marshal (rule, &iter);
70 append_accessible (DBusMessage *message, AtspiAccessible *accessible)
74 dbus_message_iter_init_append (message, &iter);
75 dbus_message_iter_append_basic (&iter, DBUS_TYPE_OBJECT_PATH,
76 &accessible->parent.path);
77 return TRUE; /* TODO: Check for out-of-memory */
81 return_accessibles (DBusMessage *message)
83 DBusMessageIter iter, iter_array;
84 GArray *ret = g_array_new (TRUE, TRUE, sizeof (AtspiAccessible *));
86 _ATSPI_DBUS_CHECK_SIG (message, "a(so)", NULL, NULL);
88 dbus_message_iter_init (message, &iter);
89 dbus_message_iter_recurse (&iter, &iter_array);
91 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
93 AtspiAccessible *accessible;
94 accessible = _atspi_dbus_return_accessible_from_iter (&iter_array);
95 ret = g_array_append_val (ret, accessible);
96 /* Iter was moved already, so no need to call dbus_message_iter_next */
98 dbus_message_unref (message);
103 * atspi_collection_get_matches:
104 * @collection: A pointer to the #AtspiCollection to query.
105 * @rule: An #AtspiMatchRule describing the match criteria.
106 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
108 * @count: The maximum number of results to return, or 0 for no limit.
109 * @traverse: Not supported.
111 * Gets all #AtspiAccessible objects from the @collection matching a given
114 * Returns: (element-type AtspiAccessible*) (transfer full): All
115 * #AtspiAccessible objects matching the given match rule.
118 atspi_collection_get_matches (AtspiCollection *collection,
119 AtspiMatchRule *rule,
120 AtspiCollectionSortOrder sortby,
125 DBusMessage *message = new_message (collection, "GetMatches");
127 dbus_int32_t d_sortby = sortby;
128 dbus_int32_t d_count = count;
129 dbus_bool_t d_traverse = traverse;
134 if (!append_match_rule (message, rule))
136 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
137 DBUS_TYPE_INT32, &d_count,
138 DBUS_TYPE_BOOLEAN, &d_traverse,
140 reply = _atspi_dbus_send_with_reply_and_block (message, error);
143 return return_accessibles (reply);
147 * atspi_collection_get_matches_to:
148 * @collection: A pointer to the #AtspiCollection to query.
149 * @current_object: The object at which to start searching.
150 * @rule: An #AtspiMatchRule describing the match criteria.
151 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
153 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
154 * the objects to be traversed.
155 * @limit_scope: If #TRUE, only descendants of @current_object's parent
156 * will be returned. Otherwise (if #FALSE), any accessible may be
157 * returned if it would preceed @current_object in a flattened
159 * @count: The maximum number of results to return, or 0 for no limit.
160 * @traverse: Not supported.
162 * Gets all #AtspiAccessible objects from the @collection, after
163 * @current_object, matching a given @rule.
165 * Returns: (element-type AtspiAccessible*) (transfer full): All
166 * #AtspiAccessible objects matching the given match rule after
170 atspi_collection_get_matches_to (AtspiCollection *collection,
171 AtspiAccessible *current_object,
172 AtspiMatchRule *rule,
173 AtspiCollectionSortOrder sortby,
174 AtspiCollectionTreeTraversalType tree,
175 gboolean limit_scope,
180 DBusMessage *message = new_message (collection, "GetMatchesTo");
182 dbus_int32_t d_sortby = sortby;
183 dbus_int32_t d_tree = tree;
184 dbus_bool_t d_limit_scope = limit_scope;
185 dbus_int32_t d_count = count;
186 dbus_bool_t d_traverse = traverse;
191 if (!append_accessible (message, current_object))
193 if (!append_match_rule (message, rule))
195 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
196 DBUS_TYPE_UINT32, &d_tree,
197 DBUS_TYPE_BOOLEAN, &d_limit_scope,
198 DBUS_TYPE_INT32, &d_count,
199 DBUS_TYPE_BOOLEAN, &d_traverse,
201 reply = _atspi_dbus_send_with_reply_and_block (message, error);
204 return return_accessibles (reply);
208 * atspi_collection_get_matches_from:
209 * @collection: A pointer to the #AtspiCollection to query.
210 * @current_object: Upon reaching this object, searching should stop.
211 * @rule: An #AtspiMatchRule describing the match criteria.
212 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
214 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
215 * the objects to be traversed.
216 * @count: The maximum number of results to return, or 0 for no limit.
217 * @traverse: Not supported.
219 * Gets all #AtspiAccessible objects from the @collection, before
220 * @current_object, matching a given @rule.
222 * Returns: (element-type AtspiAccessible*) (transfer full): All
223 * #AtspiAccessible objects matching the given match rule that preceed
227 atspi_collection_get_matches_from (AtspiCollection *collection,
228 AtspiAccessible *current_object,
229 AtspiMatchRule *rule,
230 AtspiCollectionSortOrder sortby,
231 AtspiCollectionTreeTraversalType tree,
236 DBusMessage *message = new_message (collection, "GetMatchesFrom");
238 dbus_int32_t d_sortby = sortby;
239 dbus_int32_t d_tree = tree;
240 dbus_int32_t d_count = count;
241 dbus_bool_t d_traverse = traverse;
246 if (!append_accessible (message, current_object))
248 if (!append_match_rule (message, rule))
250 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
251 DBUS_TYPE_UINT32, &d_tree,
252 DBUS_TYPE_INT32, &d_count,
253 DBUS_TYPE_BOOLEAN, &d_traverse,
255 reply = _atspi_dbus_send_with_reply_and_block (message, error);
258 return return_accessibles (reply);
262 * atspi_collection_get_active_descendant:
264 * Not yet implemented.
267 atspi_collection_get_active_descendant (AtspiCollection *collection, GError **error)
269 g_warning ("atspi: TODO: Implement get_active_descendants");
274 atspi_collection_base_init (AtspiCollection *klass)
279 atspi_collection_get_type (void)
281 static GType type = 0;
284 static const GTypeInfo tinfo =
286 sizeof (AtspiCollection),
287 (GBaseInitFunc) atspi_collection_base_init,
288 (GBaseFinalizeFunc) NULL,
291 type = g_type_register_static (G_TYPE_INTERFACE, "AtspiCollection", &tinfo, 0);