summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYakov Goldberg <yakov.g@samsung.com>2014-02-18 16:14:30 +0200
committerYakov Goldberg <yakov.g@samsung.com>2014-02-18 16:27:52 +0200
commit9003085c5a9cee6dcbebd285d1de056a9976c277 (patch)
tree80c9f825ed3a8369c1f023e3c57aff013e26ab83
parent1d421bd943957f05b8097dffcbbe2e3bf0b51649 (diff)
elm atspi: add comments for Eo API
add minimum comments for Eo API to make Eolian correctly process methods and parameter directions
-rw-r--r--src/lib/elm_atspi_object_eo.h171
1 files changed, 171 insertions, 0 deletions
diff --git a/src/lib/elm_atspi_object_eo.h b/src/lib/elm_atspi_object_eo.h
index d1ff2b7a2..724846351 100644
--- a/src/lib/elm_atspi_object_eo.h
+++ b/src/lib/elm_atspi_object_eo.h
@@ -206,59 +206,144 @@ enum
206}; 206};
207/* Selection Interface - END */ 207/* Selection Interface - END */
208 208
209/**
210 * @def elm_atspi_obj_name_get
211 * @since 1.10
212 *
213 * @param[out] ret obj name
214 */
209#define elm_atspi_obj_name_get(ret)\ 215#define elm_atspi_obj_name_get(ret)\
210 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_NAME_GET), \ 216 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_NAME_GET), \
211 EO_TYPECHECK(const char **, ret) 217 EO_TYPECHECK(const char **, ret)
212 218
219/**
220 * @def elm_atspi_obj_role_get
221 * @since 1.10
222 *
223 * @param[out] ret
224 */
213#define elm_atspi_obj_role_get(role)\ 225#define elm_atspi_obj_role_get(role)\
214 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ROLE_GET), \ 226 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ROLE_GET), \
215 EO_TYPECHECK(AtspiRole*, role) 227 EO_TYPECHECK(AtspiRole*, role)
216 228
229/**
230 * @def elm_atspi_obj_role_name_get
231 * @since 1.10
232 *
233 * @param[out] ret
234 */
217#define elm_atspi_obj_role_name_get(ret)\ 235#define elm_atspi_obj_role_name_get(ret)\
218 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ROLE_NAME_GET),\ 236 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ROLE_NAME_GET),\
219 EO_TYPECHECK(const char **, ret) 237 EO_TYPECHECK(const char **, ret)
220 238
239/**
240 * @def elm_atspi_obj_localized_role_name_get
241 * @since 1.10
242 *
243 * @param[out] ret
244 */
221#define elm_atspi_obj_localized_role_name_get(ret)\ 245#define elm_atspi_obj_localized_role_name_get(ret)\
222 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_LOCALIZED_ROLE_NAME_GET),\ 246 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_LOCALIZED_ROLE_NAME_GET),\
223 EO_TYPECHECK(const char **, ret) 247 EO_TYPECHECK(const char **, ret)
224 248
249/**
250 * @def elm_atspi_obj_description_get
251 * @since 1.10
252 *
253 * @param[out] ret
254 */
225#define elm_atspi_obj_description_get(ret)\ 255#define elm_atspi_obj_description_get(ret)\
226 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_DESCRIPTION_GET),\ 256 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_DESCRIPTION_GET),\
227 EO_TYPECHECK(const char **, ret) 257 EO_TYPECHECK(const char **, ret)
228 258
259/**
260 * @def elm_atspi_obj_child_at_index_get
261 * @since 1.10
262 *
263 * @param[in] idx
264 * @param[out] ret
265 */
229#define elm_atspi_obj_child_at_index_get(idx, ret)\ 266#define elm_atspi_obj_child_at_index_get(idx, ret)\
230 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_CHILD_AT_INDEX_GET), \ 267 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_CHILD_AT_INDEX_GET), \
231 EO_TYPECHECK(int, idx),\ 268 EO_TYPECHECK(int, idx),\
232 EO_TYPECHECK(Elm_Atspi_Object**, ret) 269 EO_TYPECHECK(Elm_Atspi_Object**, ret)
233 270
271/**
272 * @def elm_atspi_obj_children_get
273 * @since 1.10
274 *
275 * @param[out] ret
276 */
234#define elm_atspi_obj_children_get(ret)\ 277#define elm_atspi_obj_children_get(ret)\
235 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_CHILDREN_GET),\ 278 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_CHILDREN_GET),\
236 EO_TYPECHECK(Eina_List**, ret) 279 EO_TYPECHECK(Eina_List**, ret)
237 280
281/**
282 * @def elm_atspi_obj_parent_get
283 * @since 1.10
284 *
285 * @param[out] ret
286 */
238#define elm_atspi_obj_parent_get(ret)\ 287#define elm_atspi_obj_parent_get(ret)\
239 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_PARENT_GET),\ 288 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_PARENT_GET),\
240 EO_TYPECHECK(Elm_Atspi_Object**, ret) 289 EO_TYPECHECK(Elm_Atspi_Object**, ret)
241 290
291/**
292 * @def elm_atspi_obj_object_get
293 * @since 1.10
294 *
295 * @param[out] ret
296 */
242#define elm_atspi_obj_object_get(ret)\ 297#define elm_atspi_obj_object_get(ret)\
243 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_OBJECT_GET),\ 298 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_OBJECT_GET),\
244 EO_TYPECHECK(Evas_Object**, ret) 299 EO_TYPECHECK(Evas_Object**, ret)
245 300
301/**
302 * @def elm_atspi_obj_index_in_parent_get
303 * @since 1.10
304 *
305 * @param[out] ret
306 */
246#define elm_atspi_obj_index_in_parent_get(ret)\ 307#define elm_atspi_obj_index_in_parent_get(ret)\
247 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_INDEX_IN_PARENT_GET),\ 308 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_INDEX_IN_PARENT_GET),\
248 EO_TYPECHECK(int*, ret) 309 EO_TYPECHECK(int*, ret)
249 310
311/**
312 * @def elm_atspi_obj_relation_set_get
313 * @since 1.10
314 */
250#define elm_atspi_obj_relation_set_get()\ 315#define elm_atspi_obj_relation_set_get()\
251 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_RELATION_SET_GET),\ 316 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_RELATION_SET_GET),\
252 EO_TYPECHECK() 317 EO_TYPECHECK()
253 318
319/**
320 * @def elm_atspi_obj_state_get
321 * @since 1.10
322 *
323 * @param[out] ret state
324 */
254#define elm_atspi_obj_state_get(ret)\ 325#define elm_atspi_obj_state_get(ret)\
255 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_STATE_GET),\ 326 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_STATE_GET),\
256 EO_TYPECHECK(Elm_Atspi_State*, ret) 327 EO_TYPECHECK(Elm_Atspi_State*, ret)
257 328
329/**
330 * @def elm_atspi_obj_attributes_get
331 * @since 1.10
332 *
333 */
258#define elm_atspi_obj_attributes_get()\ 334#define elm_atspi_obj_attributes_get()\
259 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ATTRIBUTES_GET),\ 335 ELM_ATSPI_OBJ_ID(ELM_ATSPI_OBJ_SUB_ID_ATTRIBUTES_GET),\
260 EO_TYPECHECK() 336 EO_TYPECHECK()
261 337
338/**
339 * @def elm_atspi_component_interface_contains
340 * @since 1.10
341 *
342 * @param[in] x
343 * @param[in] y
344 * @param[in] type
345 * @param[out] ret
346 */
262#define elm_atspi_component_interface_contains(x, y, type, ret)\ 347#define elm_atspi_component_interface_contains(x, y, type, ret)\
263 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_CONTAINS),\ 348 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_CONTAINS),\
264 EO_TYPECHECK(int, x),\ 349 EO_TYPECHECK(int, x),\
@@ -266,6 +351,15 @@ enum
266 EO_TYPECHECK(AtspiCoordType, type),\ 351 EO_TYPECHECK(AtspiCoordType, type),\
267 EO_TYPECHECK(Eina_Bool*, ret) 352 EO_TYPECHECK(Eina_Bool*, ret)
268 353
354/**
355 * @def elm_atspi_component_interface_accessible_at_point_get
356 * @since 1.10
357 *
358 * @param[in] x
359 * @param[in] y
360 * @param[in] type
361 * @param[out] ret
362 */
269#define elm_atspi_component_interface_accessible_at_point_get(x, y, type, ret)\ 363#define elm_atspi_component_interface_accessible_at_point_get(x, y, type, ret)\
270 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_ACCESSIBLE_AT_POINT_GET),\ 364 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_ACCESSIBLE_AT_POINT_GET),\
271 EO_TYPECHECK(int, x),\ 365 EO_TYPECHECK(int, x),\
@@ -273,6 +367,16 @@ enum
273 EO_TYPECHECK(AtspiCoordType, type),\ 367 EO_TYPECHECK(AtspiCoordType, type),\
274 EO_TYPECHECK(Elm_Atspi_Object**, ret) 368 EO_TYPECHECK(Elm_Atspi_Object**, ret)
275 369
370/**
371 * @def elm_atspi_component_interface_extents_get
372 * @since 1.10
373 *
374 * @param[out] x
375 * @param[out] y
376 * @param[out] w
377 * @param[out] h
378 * @param[out] type
379 */
276#define elm_atspi_component_interface_extents_get(x, y, w, h, type)\ 380#define elm_atspi_component_interface_extents_get(x, y, w, h, type)\
277 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_EXTENTS_GET),\ 381 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_EXTENTS_GET),\
278 EO_TYPECHECK(int*, x),\ 382 EO_TYPECHECK(int*, x),\
@@ -281,6 +385,17 @@ enum
281 EO_TYPECHECK(int*, h), \ 385 EO_TYPECHECK(int*, h), \
282 EO_TYPECHECK(AtspiCoordType, type) 386 EO_TYPECHECK(AtspiCoordType, type)
283 387
388/**
389 * @def elm_atspi_component_interface_extents_set
390 * @since 1.10
391 *
392 * @param[in] x
393 * @param[in] y
394 * @param[in] w
395 * @param[in] h
396 * @param[in] type
397 * @param[out] ret
398 */
284#define elm_atspi_component_interface_extents_set(x, y, w, h, type, ret)\ 399#define elm_atspi_component_interface_extents_set(x, y, w, h, type, ret)\
285 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_EXTENTS_SET),\ 400 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_EXTENTS_SET),\
286 EO_TYPECHECK(int, x),\ 401 EO_TYPECHECK(int, x),\
@@ -290,12 +405,29 @@ enum
290 EO_TYPECHECK(AtspiCoordType, type),\ 405 EO_TYPECHECK(AtspiCoordType, type),\
291 EO_TYPECHECK(Eina_Bool*, ret) 406 EO_TYPECHECK(Eina_Bool*, ret)
292 407
408/**
409 * @def elm_atspi_component_interface_position_get
410 * @since 1.10
411 *
412 * @param[out] x
413 * @param[out] y
414 * @param[in] type
415 */
293#define elm_atspi_component_interface_position_get(x, y, type)\ 416#define elm_atspi_component_interface_position_get(x, y, type)\
294 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_POSITION_GET),\ 417 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_POSITION_GET),\
295 EO_TYPECHECK(int*, x),\ 418 EO_TYPECHECK(int*, x),\
296 EO_TYPECHECK(int*, y), \ 419 EO_TYPECHECK(int*, y), \
297 EO_TYPECHECK(AtspiCoordType, type) 420 EO_TYPECHECK(AtspiCoordType, type)
298 421
422/**
423 * @def elm_atspi_component_interface_position_set
424 * @since 1.10
425 *
426 * @param[in] x
427 * @param[in] y
428 * @param[in] type
429 * @param[out] ret
430 */
299#define elm_atspi_component_interface_position_set(x, y, type, ret)\ 431#define elm_atspi_component_interface_position_set(x, y, type, ret)\
300 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_POSITION_SET),\ 432 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_POSITION_SET),\
301 EO_TYPECHECK(int, x),\ 433 EO_TYPECHECK(int, x),\
@@ -303,29 +435,68 @@ enum
303 EO_TYPECHECK(AtspiCoordType, type),\ 435 EO_TYPECHECK(AtspiCoordType, type),\
304 EO_TYPECHECK(Eina_Bool*, ret) 436 EO_TYPECHECK(Eina_Bool*, ret)
305 437
438/**
439 * @def elm_atspi_component_interface_size_get
440 * @since 1.10
441 *
442 * @param[out] x
443 * @param[out] y
444 */
306#define elm_atspi_component_interface_size_get(x, y)\ 445#define elm_atspi_component_interface_size_get(x, y)\
307 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_SIZE_GET),\ 446 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_SIZE_GET),\
308 EO_TYPECHECK(int*, x),\ 447 EO_TYPECHECK(int*, x),\
309 EO_TYPECHECK(int*, y) 448 EO_TYPECHECK(int*, y)
310 449
450/**
451 * @def elm_atspi_component_interface_size_set
452 * @since 1.10
453 *
454 * @param[in] x
455 * @param[in] y
456 * @param[out] ret
457 */
311#define elm_atspi_component_interface_size_set(x, y, ret)\ 458#define elm_atspi_component_interface_size_set(x, y, ret)\
312 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_SIZE_SET),\ 459 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_SIZE_SET),\
313 EO_TYPECHECK(int, x),\ 460 EO_TYPECHECK(int, x),\
314 EO_TYPECHECK(int, y),\ 461 EO_TYPECHECK(int, y),\
315 EO_TYPECHECK(Eina_Bool*, ret) 462 EO_TYPECHECK(Eina_Bool*, ret)
316 463
464/**
465 * @def elm_atspi_component_interface_layer_get
466 * @since 1.10
467 *
468 * @param[out] ret
469 */
317#define elm_atspi_component_interface_layer_get(ret)\ 470#define elm_atspi_component_interface_layer_get(ret)\
318 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_LAYER_GET),\ 471 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_LAYER_GET),\
319 EO_TYPECHECK(int*, ret) 472 EO_TYPECHECK(int*, ret)
320 473
474/**
475 * @def elm_atspi_component_interface_z_order_get
476 * @since 1.10
477 *
478 * @param[out] ret
479 */
321#define elm_atspi_component_interface_z_order_get(ret)\ 480#define elm_atspi_component_interface_z_order_get(ret)\
322 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_Z_ORDER_GET),\ 481 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_Z_ORDER_GET),\
323 EO_TYPECHECK(int*, ret) 482 EO_TYPECHECK(int*, ret)
324 483
484/**
485 * @def elm_atspi_component_interface_focus_grab
486 * @since 1.10
487 *
488 * @param[out] ret
489 */
325#define elm_atspi_component_interface_focus_grab(ret)\ 490#define elm_atspi_component_interface_focus_grab(ret)\
326 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_FOCUS_GRAB),\ 491 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_FOCUS_GRAB),\
327 EO_TYPECHECK(Eina_Bool*, ret) 492 EO_TYPECHECK(Eina_Bool*, ret)
328 493
494/**
495 * @def elm_atspi_component_interface_alpha_get
496 * @since 1.10
497 *
498 * @param[out] ret alpha
499 */
329#define elm_atspi_component_interface_alpha_get(ret)\ 500#define elm_atspi_component_interface_alpha_get(ret)\
330 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_ALPHA_GET),\ 501 ELM_ATSPI_COMPONENT_INTERFACE_ID(ELM_ATSPI_COMPONENT_INTERFACE_SUB_ID_ALPHA_GET),\
331 EO_TYPECHECK(double*, ret) 502 EO_TYPECHECK(double*, ret)