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;
86 _ATSPI_DBUS_CHECK_SIG (message, "a(so)", NULL, NULL);
88 ret = g_array_new (TRUE, TRUE, sizeof (AtspiAccessible *));
90 dbus_message_iter_init (message, &iter);
91 dbus_message_iter_recurse (&iter, &iter_array);
93 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
95 AtspiAccessible *accessible;
96 accessible = _atspi_dbus_return_accessible_from_iter (&iter_array);
97 ret = g_array_append_val (ret, accessible);
98 /* Iter was moved already, so no need to call dbus_message_iter_next */
100 dbus_message_unref (message);
105 * atspi_collection_get_matches:
106 * @collection: A pointer to the #AtspiCollection to query.
107 * @rule: An #AtspiMatchRule describing the match criteria.
108 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
110 * @count: The maximum number of results to return, or 0 for no limit.
111 * @traverse: Not supported.
113 * Gets all #AtspiAccessible objects from the @collection matching a given
116 * Returns: (element-type AtspiAccessible*) (transfer full): All
117 * #AtspiAccessible objects matching the given match rule.
120 atspi_collection_get_matches (AtspiCollection *collection,
121 AtspiMatchRule *rule,
122 AtspiCollectionSortOrder sortby,
127 DBusMessage *message = new_message (collection, "GetMatches");
129 dbus_int32_t d_sortby = sortby;
130 dbus_int32_t d_count = count;
131 dbus_bool_t d_traverse = traverse;
136 if (!append_match_rule (message, rule))
138 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
139 DBUS_TYPE_INT32, &d_count,
140 DBUS_TYPE_BOOLEAN, &d_traverse,
142 reply = _atspi_dbus_send_with_reply_and_block (message, error);
145 return return_accessibles (reply);
149 * atspi_collection_get_matches_to:
150 * @collection: A pointer to the #AtspiCollection to query.
151 * @current_object: The object at which to start searching.
152 * @rule: An #AtspiMatchRule describing the match criteria.
153 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
155 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
156 * the objects to be traversed.
157 * @limit_scope: If #TRUE, only descendants of @current_object's parent
158 * will be returned. Otherwise (if #FALSE), any accessible may be
159 * returned if it would preceed @current_object in a flattened
161 * @count: The maximum number of results to return, or 0 for no limit.
162 * @traverse: Not supported.
164 * Gets all #AtspiAccessible objects from the @collection, after
165 * @current_object, matching a given @rule.
167 * Returns: (element-type AtspiAccessible*) (transfer full): All
168 * #AtspiAccessible objects matching the given match rule after
172 atspi_collection_get_matches_to (AtspiCollection *collection,
173 AtspiAccessible *current_object,
174 AtspiMatchRule *rule,
175 AtspiCollectionSortOrder sortby,
176 AtspiCollectionTreeTraversalType tree,
177 gboolean limit_scope,
182 DBusMessage *message = new_message (collection, "GetMatchesTo");
184 dbus_int32_t d_sortby = sortby;
185 dbus_int32_t d_tree = tree;
186 dbus_bool_t d_limit_scope = limit_scope;
187 dbus_int32_t d_count = count;
188 dbus_bool_t d_traverse = traverse;
193 if (!append_accessible (message, current_object))
195 if (!append_match_rule (message, rule))
197 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
198 DBUS_TYPE_UINT32, &d_tree,
199 DBUS_TYPE_BOOLEAN, &d_limit_scope,
200 DBUS_TYPE_INT32, &d_count,
201 DBUS_TYPE_BOOLEAN, &d_traverse,
203 reply = _atspi_dbus_send_with_reply_and_block (message, error);
206 return return_accessibles (reply);
210 * atspi_collection_get_matches_from:
211 * @collection: A pointer to the #AtspiCollection to query.
212 * @current_object: Upon reaching this object, searching should stop.
213 * @rule: An #AtspiMatchRule describing the match criteria.
214 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
216 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
217 * the objects to be traversed.
218 * @count: The maximum number of results to return, or 0 for no limit.
219 * @traverse: Not supported.
221 * Gets all #AtspiAccessible objects from the @collection, before
222 * @current_object, matching a given @rule.
224 * Returns: (element-type AtspiAccessible*) (transfer full): All
225 * #AtspiAccessible objects matching the given match rule that preceed
229 atspi_collection_get_matches_from (AtspiCollection *collection,
230 AtspiAccessible *current_object,
231 AtspiMatchRule *rule,
232 AtspiCollectionSortOrder sortby,
233 AtspiCollectionTreeTraversalType tree,
238 DBusMessage *message = new_message (collection, "GetMatchesFrom");
240 dbus_int32_t d_sortby = sortby;
241 dbus_int32_t d_tree = tree;
242 dbus_int32_t d_count = count;
243 dbus_bool_t d_traverse = traverse;
248 if (!append_accessible (message, current_object))
250 if (!append_match_rule (message, rule))
252 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
253 DBUS_TYPE_UINT32, &d_tree,
254 DBUS_TYPE_INT32, &d_count,
255 DBUS_TYPE_BOOLEAN, &d_traverse,
257 reply = _atspi_dbus_send_with_reply_and_block (message, error);
260 return return_accessibles (reply);
264 * atspi_collection_get_active_descendant:
266 * Returns: (transfer full): The active descendant of the given object.
267 * Not yet implemented.
270 atspi_collection_get_active_descendant (AtspiCollection *collection, GError **error)
272 g_warning ("atspi: TODO: Implement get_active_descendants");
277 atspi_collection_base_init (AtspiCollection *klass)
282 atspi_collection_get_type (void)
284 static GType type = 0;
287 static const GTypeInfo tinfo =
289 sizeof (AtspiCollection),
290 (GBaseInitFunc) atspi_collection_base_init,
291 (GBaseFinalizeFunc) NULL,
294 type = g_type_register_static (G_TYPE_INTERFACE, "AtspiCollection", &tinfo, 0);