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;
95 accessible = _atspi_dbus_return_accessible_from_iter (&iter_array);
96 new_array = g_array_append_val (ret, accessible);
99 /* Iter was moved already, so no need to call dbus_message_iter_next */
101 dbus_message_unref (message);
106 * atspi_collection_get_matches:
108 * @collection: A pointer to the #AtspiCollection to query.
110 * @rule: An #AtspiMatchRule describing the match criteria.
112 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
115 * @count: The maximum number of results to return, or 0 for no limit.
117 * @traverse: Not supported.
119 * Gets all #AtspiAccessible objects from the @collection matching a given
122 * Returns: (element-type AtspiAccessible*) (transfer full): All
123 * #AtspiAccessible objects matching the given match rule.
126 atspi_collection_get_matches (AtspiCollection *collection,
127 AtspiMatchRule *rule,
128 AtspiCollectionSortOrder sortby,
133 DBusMessage *message = new_message (collection, "GetMatches");
135 dbus_int32_t d_sortby = sortby;
136 dbus_int32_t d_count = count;
137 dbus_bool_t d_traverse = traverse;
142 if (!append_match_rule (message, rule))
144 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
145 DBUS_TYPE_INT32, &d_count,
146 DBUS_TYPE_BOOLEAN, &d_traverse,
148 reply = _atspi_dbus_send_with_reply_and_block (message, error);
151 return return_accessibles (reply);
155 * atspi_collection_get_matches_to:
157 * @collection: A pointer to the #AtspiCollection to query.
159 * @current_object: The object at which to start searching.
161 * @rule: An #AtspiMatchRule describing the match criteria.
163 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
166 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
167 * the objects to be traversed.
169 * @restrict: If #TRUE, only descendants of @current_object's parent
170 * will be returned. Otherwise (if #FALSE), any accessible may be returned
171 * if it would preceed @current_object in a flattened hierarchy.
173 * @count: The maximum number of results to return, or 0 for no limit.
175 * @traverse: Not supported.
177 * Gets all #AtspiAccessible objects from the @collection, after
178 * @current_object, matching a given @rule.
180 * Returns: (element-type AtspiAccessible*) (transfer full): All
181 * #AtspiAccessible objects matching the given match rule after
185 atspi_collection_get_matches_to (AtspiCollection *collection,
186 AtspiAccessible *current_object,
187 AtspiMatchRule *rule,
188 AtspiCollectionSortOrder sortby,
189 AtspiCollectionTreeTraversalType tree,
195 DBusMessage *message = new_message (collection, "GetMatchesTo");
197 dbus_int32_t d_sortby = sortby;
198 dbus_int32_t d_tree = tree;
199 dbus_bool_t d_restrict = restrict;
200 dbus_int32_t d_count = count;
201 dbus_bool_t d_traverse = traverse;
206 if (!append_accessible (message, current_object))
208 if (!append_match_rule (message, rule))
210 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
211 DBUS_TYPE_UINT32, &d_tree,
212 DBUS_TYPE_BOOLEAN, &d_restrict,
213 DBUS_TYPE_INT32, &d_count,
214 DBUS_TYPE_BOOLEAN, &d_traverse,
216 reply = _atspi_dbus_send_with_reply_and_block (message, error);
219 return return_accessibles (reply);
223 * atspi_collection_get_matches_from:
225 * @collection: A pointer to the #AtspiCollection to query.
227 * @current_object: Upon reaching this object, searching should stop.
229 * @rule: An #AtspiMatchRule describing the match criteria.
231 * @sortby: An #AtspiCollectionSortOrder specifying the way the results are to
234 * @tree: An #AtspiCollectionTreeTraversalType specifying restrictions on
235 * the objects to be traversed.
237 * @count: The maximum number of results to return, or 0 for no limit.
239 * @traverse: Not supported.
241 * Gets all #AtspiAccessible objects from the @collection, before
242 * @current_object, matching a given @rule.
244 * Returns: (element-type AtspiAccessible*) (transfer full): All
245 * #AtspiAccessible objects matching the given match rule that preceed
249 atspi_collection_get_matches_from (AtspiCollection *collection,
250 AtspiAccessible *current_object,
251 AtspiMatchRule *rule,
252 AtspiCollectionSortOrder sortby,
253 AtspiCollectionTreeTraversalType tree,
258 DBusMessage *message = new_message (collection, "GetMatchesFrom");
260 dbus_int32_t d_sortby = sortby;
261 dbus_int32_t d_tree = tree;
262 dbus_int32_t d_count = count;
263 dbus_bool_t d_traverse = traverse;
268 if (!append_accessible (message, current_object))
270 if (!append_match_rule (message, rule))
272 dbus_message_append_args (message, DBUS_TYPE_UINT32, &d_sortby,
273 DBUS_TYPE_UINT32, &d_tree,
274 DBUS_TYPE_INT32, &d_count,
275 DBUS_TYPE_BOOLEAN, &d_traverse,
277 reply = _atspi_dbus_send_with_reply_and_block (message, error);
280 return return_accessibles (reply);
284 * atspi_collection_get_active_descendant:
286 * Not yet implemented.
289 atspi_collection_get_active_descendant (AtspiCollection *collection, GError **error)
291 g_warning ("atspi: TODO: Implement get_active_descendants");
296 atspi_collection_base_init (AtspiCollection *klass)
301 atspi_collection_get_type (void)
303 static GType type = 0;
306 static const GTypeInfo tinfo =
308 sizeof (AtspiCollection),
309 (GBaseInitFunc) atspi_collection_base_init,
310 (GBaseFinalizeFunc) NULL,
313 type = g_type_register_static (G_TYPE_INTERFACE, "AtspiCollection", &tinfo, 0);