summaryrefslogtreecommitdiff
path: root/src/lib/ecore_wayland
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-15 16:30:18 -0800
committerCedric BAIL <cedric@osg.samsung.com>2017-02-15 16:30:22 -0800
commit5d389a1df64b93d4c10e25d98478526293435602 (patch)
treec9a821bee6cbafeca43907fb12d130c1b921e4a8 /src/lib/ecore_wayland
parent48627996d767b72aef15c33eea5a95c804525a01 (diff)
doxygen: fix typos and some wrong expressions in API reference.
Summary: I had fixed some typos and some wrong expressions, such as capital letters, singular, and orders of groups in API reference doxygen. Test Plan: Doxygen revision Reviewers: stefan, cedric, raster, Jaehyun_Cho, jpeg Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4658 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
Diffstat (limited to 'src/lib/ecore_wayland')
-rw-r--r--src/lib/ecore_wayland/Ecore_Wayland.h169
1 files changed, 84 insertions, 85 deletions
diff --git a/src/lib/ecore_wayland/Ecore_Wayland.h b/src/lib/ecore_wayland/Ecore_Wayland.h
index 286959ecf7..7db571e80c 100644
--- a/src/lib/ecore_wayland/Ecore_Wayland.h
+++ b/src/lib/ecore_wayland/Ecore_Wayland.h
@@ -227,11 +227,10 @@ struct _Ecore_Wl_Event_Interfaces_Bound
227 227
228/** 228/**
229 * @file 229 * @file
230 * @brief Ecore functions for dealing with the Wayland window system 230 * @brief Ecore functions for dealing with the Wayland window system.
231 * 231 *
232 * @defgroup Ecore_Wl_Group Ecore_Wayland - Wayland integration 232 * @defgroup Ecore_Wl_Group Ecore_Wayland - Wayland integration
233 * @ingroup Ecore 233 * @ingroup Ecore
234
235 * Ecore_Wl provides a wrapper and convenience functions for using the 234 * Ecore_Wl provides a wrapper and convenience functions for using the
236 * Wayland protocol in implementing a window system. Function groups for 235 * Wayland protocol in implementing a window system. Function groups for
237 * this part of the library include the following: 236 * this part of the library include the following:
@@ -270,19 +269,20 @@ EAPI extern int ECORE_WL_EVENT_INTERFACES_BOUND;
270 */ 269 */
271 270
272/** 271/**
273 * Initialize the Wayland display connection to the given display. 272 * @ingroup Ecore_Wl_Init_Group
273 * @brief Initializes the Wayland display connection to the given display.
274 * 274 *
275 * @param name Display target name. if @c NULL, the default display is 275 * @param name Display target name. if @c NULL, the default display is
276 * assumed. 276 * assumed.
277 * @return The number of times the library has been initialized without being 277 * @return The number of times the library has been initialized without being
278 * shut down. 0 is returned if an error occurs. 278 * shut down. @c 0 is returned if an error occurs.
279 * 279 *
280 * @ingroup Ecore_Wl_Init_Group
281 */ 280 */
282EAPI int ecore_wl_init(const char *name); 281EAPI int ecore_wl_init(const char *name);
283 282
284/** 283/**
285 * Shuts down the Ecore Wayland Library 284 * @ingroup Ecore_Wl_Init_Group
285 * @brief Shuts down the Ecore Wayland Library.
286 * 286 *
287 * In shutting down the library, the Wayland display connection is terminated 287 * In shutting down the library, the Wayland display connection is terminated
288 * and any event handlers for it are removed. 288 * and any event handlers for it are removed.
@@ -290,7 +290,6 @@ EAPI int ecore_wl_init(const char *name);
290 * @return The number of times the library has been initialized without 290 * @return The number of times the library has been initialized without
291 * being shut down. 291 * being shut down.
292 * 292 *
293 * @ingroup Ecore_Wl_Init_Group
294 */ 293 */
295EAPI int ecore_wl_shutdown(void); 294EAPI int ecore_wl_shutdown(void);
296 295
@@ -303,18 +302,18 @@ EAPI int ecore_wl_shutdown(void);
303 */ 302 */
304 303
305/** 304/**
306 * Sends all Wayland commands to the Wayland Display.
307 *
308 * @ingroup Ecore_Wl_Flush_Group 305 * @ingroup Ecore_Wl_Flush_Group
306 * @brief Sends all Wayland commands to the Wayland Display.
307 *
309 * @since 1.2 308 * @since 1.2
310 */ 309 */
311EAPI void ecore_wl_flush(void); 310EAPI void ecore_wl_flush(void);
312 311
313/** 312/**
314 * Flushes the command buffer and waits until all requests have been 313 * @ingroup Ecore_Wl_Flush_Group
314 * @brief Flushes the command buffer and waits until all requests have been
315 * processed by the server. 315 * processed by the server.
316 * 316 *
317 * @ingroup Ecore_Wl_Flush_Group
318 * @since 1.2 317 * @since 1.2
319 */ 318 */
320EAPI void ecore_wl_sync(void); 319EAPI void ecore_wl_sync(void);
@@ -327,27 +326,27 @@ EAPI void ecore_wl_sync(void);
327 */ 326 */
328 327
329/** 328/**
330 * Retrieves the Wayland Shm Interface used for the current Wayland connection. 329 * @ingroup Ecore_Wl_Display_Group
330 * @brief Retrieves the Wayland Shm Interface used for the current Wayland connection.
331 * 331 *
332 * @return The current wayland shm interface, or NULL on error 332 * @return The current wayland shm interface, or NULL on error
333 * 333 *
334 * @ingroup Ecore_Wl_Display_Group
335 * @since 1.2 334 * @since 1.2
336 */ 335 */
337EAPI struct wl_shm *ecore_wl_shm_get(void); 336EAPI struct wl_shm *ecore_wl_shm_get(void);
338 337
339/** 338/**
340 * Retrieves the Wayland Display Interface used for the current Wayland connection. 339 * @ingroup Ecore_Wl_Display_Group
340 * @brief Retrieves the Wayland Display Interface used for the current Wayland connection.
341 * 341 *
342 * @return The current wayland display interface, or NULL on error 342 * @return The current wayland display interface, or NULL on error
343 * 343 *
344 * @ingroup Ecore_Wl_Display_Group
345 * @since 1.2 344 * @since 1.2
346 */ 345 */
347EAPI struct wl_display *ecore_wl_display_get(void); 346EAPI struct wl_display *ecore_wl_display_get(void);
348 347
349/** 348/**
350 * Retrieves the Compositor interface. 349 * @brief Retrieves the Compositor interface.
351 * 350 *
352 * This interface is used by clients to request the creation of surfaces and 351 * This interface is used by clients to request the creation of surfaces and
353 * regions. 352 * regions.
@@ -357,29 +356,29 @@ EAPI struct wl_display *ecore_wl_display_get(void);
357 */ 356 */
358 357
359/** 358/**
360 * Retrieves the size of the current screen. 359 * @ingroup Ecore_Wl_Display_Group
360 * @brief Retrieves the size of the current screen.
361 * 361 *
362 * @param w where to return the width. May be NULL. Returns 0 on error. 362 * @param w Where to return the width. May be NULL. Returns @c 0 on error.
363 * @param h where to return the height. May be NULL. Returns 0 on error. 363 * @param h Where to return the height. May be NULL. Returns @c 0 on error.
364 * 364 *
365 * @ingroup Ecore_Wl_Display_Group
366 * @since 1.2 365 * @since 1.2
367 */ 366 */
368EAPI void ecore_wl_screen_size_get(int *w, int *h); 367EAPI void ecore_wl_screen_size_get(int *w, int *h);
369 368
370/** 369/**
371 * Retrieves the position of the current screen. 370 * @ingroup Ecore_Wl_Display_Group
371 * @brief Retrieves the position of the current screen.
372 * 372 *
373 * @param x where to return the horizontal position. May be NULL. Returns 0 on error. 373 * @param x Where to return the horizontal position. May be NULL. Returns @c 0 on error.
374 * @param y where to return the vertical position. May be NULL. Returns 0 on error. 374 * @param y Where to return the vertical position. May be NULL. Returns @c 0 on error.
375 * 375 *
376 * @ingroup Ecore_Wl_Display_Group
377 * @since 1.2 376 * @since 1.2
378 */ 377 */
379EAPI void ecore_wl_pointer_xy_get(int *x, int *y); 378EAPI void ecore_wl_pointer_xy_get(int *x, int *y);
380 379
381/** 380/**
382 * Return the screen DPI 381 * @brief Returns the screen DPI.
383 * 382 *
384 * This is a simplistic call to get DPI. It does not account for differing 383 * This is a simplistic call to get DPI. It does not account for differing
385 * DPI in the x and y axes nor does it account for multihead or xinerama and 384 * DPI in the x and y axes nor does it account for multihead or xinerama and
@@ -392,7 +391,7 @@ EAPI void ecore_wl_pointer_xy_get(int *x, int *y);
392EAPI int ecore_wl_dpi_get(void); 391EAPI int ecore_wl_dpi_get(void);
393 392
394/** 393/**
395 * Dispatch Wayland events 394 * @brief Dispatches Wayland events.
396 * 395 *
397 * Dispatches any events queued on the default queue. Wayland will attempt 396 * Dispatches any events queued on the default queue. Wayland will attempt
398 * to read from the display fd and queue things up according to the proxy 397 * to read from the display fd and queue things up according to the proxy
@@ -407,7 +406,7 @@ EAPI void ecore_wl_display_iterate(void);
407EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source); 406EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source);
408 407
409/** 408/**
410 * Retrieves the requested cursor from the cursor theme 409 * @brief Retrieves the requested cursor from the cursor theme.
411 * 410 *
412 * @param cursor_name The desired cursor name to be looked up in the theme 411 * @param cursor_name The desired cursor name to be looked up in the theme
413 * @return the cursor or NULL if the cursor cannot be found 412 * @return the cursor or NULL if the cursor cannot be found
@@ -420,7 +419,7 @@ EAPI struct wl_cursor *ecore_wl_cursor_get(const char *cursor_name);
420 * @defgroup Ecore_Wl_Input_Group Functions dealing with Wayland Input 419 * @defgroup Ecore_Wl_Input_Group Functions dealing with Wayland Input
421 * @ingroup Ecore_Wl_Group 420 * @ingroup Ecore_Wl_Group
422 * 421 *
423 * Functions to interface with Wayland Input 422 * Functions to interface with Wayland Input.
424 */ 423 */
425 424
426/** 425/**
@@ -452,7 +451,8 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input);
452 451
453 452
454/** 453/**
455 * Retrieves the Wayland Globals Interface list used for the current Wayland connection. 454 * @ingroup Ecore_Wl_Display_Group
455 * @brief Retrieves the Wayland Globals Interface list used for the current Wayland connection.
456 * 456 *
457 * This call, if done after the ECORE_WL_EVENT_INTERFACES_BOUND event was 457 * This call, if done after the ECORE_WL_EVENT_INTERFACES_BOUND event was
458 * received already, won't block the mainloop or trigger a dispatch. It will 458 * received already, won't block the mainloop or trigger a dispatch. It will
@@ -465,17 +465,16 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input);
465 * 465 *
466 * @return The current wayland globals interface list, or NULL on error 466 * @return The current wayland globals interface list, or NULL on error
467 * 467 *
468 * @ingroup Ecore_Wl_Display_Group
469 * @since 1.7.6 468 * @since 1.7.6
470 */ 469 */
471EAPI Eina_Inlist *ecore_wl_globals_get(void); 470EAPI Eina_Inlist *ecore_wl_globals_get(void);
472 471
473/** 472/**
474 * Retrieves the Wayland Registry used for the current Wayland connection. 473 * @ingroup Ecore_Wl_Display_Group
474 * @brief Retrieves the Wayland Registry used for the current Wayland connection.
475 * 475 *
476 * @return The current wayland registry, or NULL on error 476 * @return The current wayland registry, or NULL on error
477 * 477 *
478 * @ingroup Ecore_Wl_Display_Group
479 * @since 1.7.6 478 * @since 1.7.6
480 */ 479 */
481EAPI struct wl_registry *ecore_wl_registry_get(void); 480EAPI struct wl_registry *ecore_wl_registry_get(void);
@@ -488,7 +487,8 @@ EAPI struct wl_registry *ecore_wl_registry_get(void);
488 */ 487 */
489 488
490/** 489/**
491 * Creates a new window 490 * @ingroup Ecore_Wl_Window_Group
491 * @brief Creates a new window.
492 * 492 *
493 * @param parent The parent window to use. If @p parent is @c 0, the root window 493 * @param parent The parent window to use. If @p parent is @c 0, the root window
494 * of the default display is used. 494 * of the default display is used.
@@ -500,23 +500,23 @@ EAPI struct wl_registry *ecore_wl_registry_get(void);
500 * 500 *
501 * @return The new window, or NULL on failure 501 * @return The new window, or NULL on failure
502 * 502 *
503 * @ingroup Ecore_Wl_Window_Group
504 * @since 1.2 503 * @since 1.2
505 */ 504 */
506EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, int w, int h, int buffer_type); 505EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, int w, int h, int buffer_type);
507 506
508/** 507/**
509 * Deletes the given window 508 * @ingroup Ecore_Wl_Window_Group
509 * @brief Deletes the given window.
510 * 510 *
511 * @param win The given window 511 * @param win The given window
512 * 512 *
513 * @ingroup Ecore_Wl_Window_Group
514 * @since 1.2 513 * @since 1.2
515 */ 514 */
516EAPI void ecore_wl_window_free(Ecore_Wl_Window *win); 515EAPI void ecore_wl_window_free(Ecore_Wl_Window *win);
517 516
518/** 517/**
519 * Signals for Wayland to initiate a window move. 518 * @ingroup Ecore_Wl_Window_Group
519 * @brief Signals for Wayland to initiate a window move.
520 * 520 *
521 * The position requested (@p x, @p y) is not honored by Wayland because 521 * The position requested (@p x, @p y) is not honored by Wayland because
522 * Wayland does not allow specific window placement to be set. 522 * Wayland does not allow specific window placement to be set.
@@ -525,13 +525,13 @@ EAPI void ecore_wl_window_free(Ecore_Wl_Window *win);
525 * @param x X Position 525 * @param x X Position
526 * @param y Y Position 526 * @param y Y Position
527 * 527 *
528 * @ingroup Ecore_Wl_Window_Group
529 * @since 1.2 528 * @since 1.2
530 */ 529 */
531EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y); 530EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y);
532 531
533/** 532/**
534 * Signals for Wayland to initiate a window resize. 533 * @ingroup Ecore_Wl_Window_Group
534 * @brief Signals for Wayland to initiate a window resize.
535 * 535 *
536 * The size requested (@p w, @p h) is not honored by Wayland because 536 * The size requested (@p w, @p h) is not honored by Wayland because
537 * Wayland does not allow specific window sizes to be set. 537 * Wayland does not allow specific window sizes to be set.
@@ -541,7 +541,6 @@ EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y);
541 * @param h Height 541 * @param h Height
542 * @param location The edge of the window from where the resize should start. 542 * @param location The edge of the window from where the resize should start.
543 * 543 *
544 * @ingroup Ecore_Wl_Window_Group
545 * @since 1.2 544 * @since 1.2
546 */ 545 */
547EAPI void ecore_wl_window_resize(Ecore_Wl_Window *win, int w, int h, int location); 546EAPI void ecore_wl_window_resize(Ecore_Wl_Window *win, int w, int h, int location);
@@ -552,35 +551,35 @@ EAPI void ecore_wl_window_buffer_attach(Ecore_Wl_Window *win, struct wl_buffer *
552EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win); 551EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win);
553 552
554/** 553/**
555 * Shows a window 554 * @ingroup Ecore_Wl_Window_Group
555 * @brief Shows a window.
556 * 556 *
557 * Synonymous to "mapping" a window in Wayland System terminology. 557 * Synonymous to "mapping" a window in Wayland System terminology.
558 * 558 *
559 * @param win The window to show. 559 * @param win The window to show.
560 * 560 *
561 * @ingroup Ecore_Wl_Window_Group
562 * @since 1.2 561 * @since 1.2
563 */ 562 */
564EAPI void ecore_wl_window_show(Ecore_Wl_Window *win); 563EAPI void ecore_wl_window_show(Ecore_Wl_Window *win);
565 564
566/** 565/**
567 * Hides a window 566 * @ingroup Ecore_Wl_Window_Group
567 * @brief Hides a window.
568 * 568 *
569 * Synonymous to "unmapping" a window in Wayland System terminology. 569 * Synonymous to "unmapping" a window in Wayland System terminology.
570 * 570 *
571 * @param win The window to hide. 571 * @param win The window to hide.
572 * 572 *
573 * @ingroup Ecore_Wl_Window_Group
574 * @since 1.2 573 * @since 1.2
575 */ 574 */
576EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win); 575EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win);
577 576
578/** 577/**
579 * Raises a window 578 * @ingroup Ecore_Wl_Window_Group
579 * @brief Raises a window.
580 * 580 *
581 * @param win The window to raise. 581 * @param win The window to raise.
582 * 582 *
583 * @ingroup Ecore_Wl_Window_Group
584 * @since 1.2 583 * @since 1.2
585 */ 584 */
586EAPI void ecore_wl_window_raise(Ecore_Wl_Window *win); 585EAPI void ecore_wl_window_raise(Ecore_Wl_Window *win);
@@ -603,11 +602,11 @@ EAPI void ecore_wl_window_cursor_default_restore(Ecore_Wl_Window *win);
603EAPI void ecore_wl_window_parent_set(Ecore_Wl_Window *win, Ecore_Wl_Window *parent); 602EAPI void ecore_wl_window_parent_set(Ecore_Wl_Window *win, Ecore_Wl_Window *parent);
604 603
605/** 604/**
606 * Iconify a window 605 * @ingroup Ecore_Wl_Window_Group
606 * @brief Iconifies a window.
607 * 607 *
608 * @param win The window to iconifiy 608 * @param win The window to iconifiy
609 * 609 *
610 * @ingroup Ecore_Wl_Window_Group
611 * @since 1.12 610 * @since 1.12
612 */ 611 */
613EAPI void ecore_wl_window_iconified_set(Ecore_Wl_Window *win, Eina_Bool iconified); 612EAPI void ecore_wl_window_iconified_set(Ecore_Wl_Window *win, Eina_Bool iconified);
@@ -622,12 +621,12 @@ EAPI int ecore_wl_window_surface_id_get(Ecore_Wl_Window *win);
622EAPI Ecore_Wl_Input *ecore_wl_window_keyboard_get(Ecore_Wl_Window *win); 621EAPI Ecore_Wl_Input *ecore_wl_window_keyboard_get(Ecore_Wl_Window *win);
623 622
624/** 623/**
625 * Returns a wl_surface with no association to any wl_shell_surface. 624 * @ingroup Ecore_Wl_Window_Group
625 * @brief Returns a wl_surface with no association to any wl_shell_surface.
626 * 626 *
627 * @param win The window which will use this newly created surface. 627 * @param win The window which will use this newly created surface.
628 * @return wl_surface or NULL on error 628 * @return wl_surface or NULL on error
629 * 629 *
630 * @ingroup Ecore_Wl_Window_Group
631 * @since 1.8 630 * @since 1.8
632 */ 631 */
633EAPI struct wl_surface *ecore_wl_window_surface_create(Ecore_Wl_Window *win); 632EAPI struct wl_surface *ecore_wl_window_surface_create(Ecore_Wl_Window *win);
@@ -636,18 +635,19 @@ EAPI void ecore_wl_window_alpha_set(Ecore_Wl_Window *win, Eina_Bool alpha);
636EAPI Eina_Bool ecore_wl_window_alpha_get(Ecore_Wl_Window *win); 635EAPI Eina_Bool ecore_wl_window_alpha_get(Ecore_Wl_Window *win);
637 636
638/** 637/**
639 * Returns the Ecore_Wl_Window from a wl_surface 638 * @ingroup Ecore_Wl_Window_Group
639 * @brief Returns the Ecore_Wl_Window from a wl_surface.
640 * 640 *
641 * @param surface The surface for which to find the Ecore_Wl_Window from 641 * @param surface The surface for which to find the Ecore_Wl_Window from
642 * @return the Ecore_Wl_Window associated with this surface, or NULL if not found 642 * @return the Ecore_Wl_Window associated with this surface, or NULL if not found
643 * 643 *
644 * @ingroup Ecore_Wl_Window_Group
645 * @since 1.8 644 * @since 1.8
646 */ 645 */
647EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface); 646EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface);
648 647
649/** 648/**
650 * Set the input region of the Ecore_Wl_Window. 649 * @ingroup Ecore_Wl_Window_Group
650 * @brief Sets the input region of the Ecore_Wl_Window.
651 * 651 *
652 * To set an empty region, pass width and height as 0. 652 * To set an empty region, pass width and height as 0.
653 * 653 *
@@ -659,13 +659,13 @@ EAPI Ecore_Wl_Window *ecore_wl_window_surface_find(struct wl_surface *surface);
659 * @param w The width of the region. 659 * @param w The width of the region.
660 * @param h The height of the region. 660 * @param h The height of the region.
661 * 661 *
662 * @ingroup Ecore_Wl_Window_Group
663 * @since 1.8 662 * @since 1.8
664 */ 663 */
665EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h); 664EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
666 665
667/** 666/**
668 * Set the opaque region of the Ecore_Wl_Window 667 * @ingroup Ecore_Wl_Window_Group
668 * @brief Sets the opaque region of the Ecore_Wl_Window.
669 * 669 *
670 * @param win The window 670 * @param win The window
671 * @param x The left point of the region. 671 * @param x The left point of the region.
@@ -673,29 +673,28 @@ EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, i
673 * @param w The width of the region. 673 * @param w The width of the region.
674 * @param h The height of the region. 674 * @param h The height of the region.
675 * 675 *
676 * @ingroup Ecore_Wl_Window_Group
677 * @since 1.8 676 * @since 1.8
678 */ 677 */
679EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h); 678EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, int w, int h);
680 679
681/** 680/**
682 * Set the rotation of the Ecore_Wl_Window 681 * @ingroup Ecore_Wl_Window_Group
682 * @brief Sets the rotation of the Ecore_Wl_Window.
683 * 683 *
684 * @param win The window 684 * @param win The window
685 * @param rotation The degree of rotation for this window 685 * @param rotation The degree of rotation for this window
686 * 686 *
687 * @ingroup Ecore_Wl_Window_Group
688 * @since 1.8 687 * @since 1.8
689 */ 688 */
690EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation); 689EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation);
691 690
692/** 691/**
693 * Get the rotation of the Ecore_Wl_Window 692 * @ingroup Ecore_Wl_Window_Group
693 * @brief Gets the rotation of the Ecore_Wl_Window.
694 * 694 *
695 * @param win The window 695 * @param win The window
696 * @return The degree of rotation for this window 696 * @return The degree of rotation for this window
697 * 697 *
698 * @ingroup Ecore_Wl_Window_Group
699 * @since 1.8 698 * @since 1.8
700 */ 699 */
701EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win); 700EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win);
@@ -738,33 +737,33 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_start_drag(Ecore_Wl_Dnd *dnd);
738EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dnd); 737EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dnd);
739 738
740/** 739/**
740 * @ingroup Ecore_Wl_Dnd_Group
741 * @return false on error, true otherwise 741 * @return false on error, true otherwise
742 * 742 *
743 * @ingroup Ecore_Wl_Dnd_Group
744 * @since 1.8 743 * @since 1.8
745 */ 744 */
746EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **types_offered); 745EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **types_offered);
747 746
748/** 747/**
748 * @ingroup Ecore_Wl_Dnd_Group
749 * @return false if type not found or on error, true otherwise 749 * @return false if type not found or on error, true otherwise
750 * 750 *
751 * @ingroup Ecore_Wl_Dnd_Group
752 * @since 1.8 751 * @since 1.8
753 */ 752 */
754EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *type); 753EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *type);
755 754
756/** 755/**
756 * @ingroup Ecore_Wl_Dnd_Group
757 * @return true if input has a selection source, false otherwise or on error 757 * @return true if input has a selection source, false otherwise or on error
758 * 758 *
759 * @ingroup Ecore_Wl_Dnd_Group
760 * @since 1.8 759 * @since 1.8
761 */ 760 */
762EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input); 761EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input);
763 762
764/** 763/**
764 * @ingroup Ecore_Wl_Dnd_Group
765 * @return false on error, true otherwise 765 * @return false on error, true otherwise
766 * 766 *
767 * @ingroup Ecore_Wl_Dnd_Group
768 * @since 1.8 767 * @since 1.8
769 */ 768 */
770EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input); 769EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input);
@@ -782,9 +781,9 @@ EAPI void ecore_wl_dnd_drag_start(Ecore_Wl_Input *input, Ecore_Wl_Window *win, E
782EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input); 781EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input);
783 782
784/** 783/**
784 * @ingroup Ecore_Wl_Dnd_Group
785 * @return false if type not found or on error, true otherwise 785 * @return false if type not found or on error, true otherwise
786 * 786 *
787 * @ingroup Ecore_Wl_Dnd_Group
788 * @since 1.8 787 * @since 1.8
789 */ 788 */
790EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type); 789EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type);
@@ -796,9 +795,9 @@ EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type);
796EAPI void ecore_wl_dnd_drag_types_set(Ecore_Wl_Input *input, const char **types_offered); 795EAPI void ecore_wl_dnd_drag_types_set(Ecore_Wl_Input *input, const char **types_offered);
797 796
798/** 797/**
798 * @ingroup Ecore_Wl_Dnd_Group
799 * @return the data types being offered for drag-and-drop, or NULL on error 799 * @return the data types being offered for drag-and-drop, or NULL on error
800 * 800 *
801 * @ingroup Ecore_Wl_Dnd_Group
802 * @since 1.8 801 * @since 1.8
803 */ 802 */
804EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input); 803EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input);
@@ -810,7 +809,7 @@ EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input);
810/* EAPI Ecore_Wl_Dnd_Source *ecore_wl_dnd_drag_source_create(Ecore_Wl_Dnd *dnd); */ 809/* EAPI Ecore_Wl_Dnd_Source *ecore_wl_dnd_drag_source_create(Ecore_Wl_Dnd *dnd); */
811 810
812/** 811/**
813 * Enable/disable server mode. 812 * Enables/disables server mode.
814 * 813 *
815 * With this enabled, the compositor acts as a Wayland server, iterating 814 * With this enabled, the compositor acts as a Wayland server, iterating
816 * the display and dispatching events. With it disabled, the process is 815 * the display and dispatching events. With it disabled, the process is
@@ -833,7 +832,8 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on);
833 */ 832 */
834 833
835/** 834/**
836 * Create and return a new subsurface. 835 * @ingroup Ecore_Wl_Subsurf
836 * @brief Creates and returns a new subsurface.
837 * 837 *
838 * Create a new surface (and subsurface interface), with the parent surface 838 * Create a new surface (and subsurface interface), with the parent surface
839 * being the one associated with the given @param win. 839 * being the one associated with the given @param win.
@@ -844,34 +844,34 @@ EAPI void ecore_wl_server_mode_set(Eina_Bool on);
844 * @return the allocated and initialized Ecore_Wl_Subsurf object, or 844 * @return the allocated and initialized Ecore_Wl_Subsurf object, or
845 * NULL on failure 845 * NULL on failure
846 * 846 *
847 * @ingroup Ecore_Wl_Subsurf
848 * @since 1.8 847 * @since 1.8
849 */ 848 */
850EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win); 849EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win);
851 850
852/** 851/**
853 * Destroy the given subsurface, as well as the surface associated with it. 852 * @ingroup Ecore_Wl_Subsurf
853 * @brief Destroys the given subsurface, as well as the surface associated with it.
854 * 854 *
855 * @param ess the subsurface 855 * @param ess the subsurface
856 * 856 *
857 * @ingroup Ecore_Wl_Subsurf
858 * @since 1.8 857 * @since 1.8
859 */ 858 */
860EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess); 859EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess);
861 860
862/** 861/**
863 * Get the wl_surface for this subsurface 862 * @ingroup Ecore_Wl_Subsurf
863 * @brief Gets the wl_surface for this subsurface.
864 * 864 *
865 * @param ess the subsurface 865 * @param ess the subsurface
866 * @return the wl_surface associated with this subsurface, or NULL on failure 866 * @return the wl_surface associated with this subsurface, or NULL on failure
867 * 867 *
868 * @ingroup Ecore_Wl_Subsurf
869 * @since 1.8 868 * @since 1.8
870 */ 869 */
871EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess); 870EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess);
872 871
873/** 872/**
874 * Set the position of this subsurface, relative to its parent surface. 873 * @ingroup Ecore_Wl_Subsurf
874 * @brief Sets the position of this subsurface, relative to its parent surface.
875 * If ess is defined and the x, y coordinates differ from the currently 875 * If ess is defined and the x, y coordinates differ from the currently
876 * tracked position, this also schedules a sub-surface position change. 876 * tracked position, this also schedules a sub-surface position change.
877 * 877 *
@@ -879,26 +879,26 @@ EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess);
879 * @param x coordinate in the parent surface 879 * @param x coordinate in the parent surface
880 * @param y coordinate in the parent surface 880 * @param y coordinate in the parent surface
881 * 881 *
882 * @ingroup Ecore_Wl_Subsurf
883 * @since 1.8 882 * @since 1.8
884 */ 883 */
885EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y); 884EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y);
886 885
887/** 886/**
888 * Get the position of this subsurface, relative to its parent surface. 887 * @ingroup Ecore_Wl_Subsurf
888 * @brief Gets the position of this subsurface, relative to its parent surface.
889 * Coordinates will be returned in x and y if non-NULL. 889 * Coordinates will be returned in x and y if non-NULL.
890 * 890 *
891 * @param ess the subsurface 891 * @param ess the subsurface
892 * @param x coordinate in the parent surface, or NULL to ignore 892 * @param x coordinate in the parent surface, or NULL to ignore
893 * @param y coordinate in the parent surface, or NULL to ignore 893 * @param y coordinate in the parent surface, or NULL to ignore
894 * 894 *
895 * @ingroup Ecore_Wl_Subsurf
896 * @since 1.8 895 * @since 1.8
897 */ 896 */
898EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y); 897EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
899 898
900/** 899/**
901 * Place subsurface on layer above a reference surface 900 * @ingroup Ecore_Wl_Subsurf
901 * @brief Places subsurface on layer above a reference surface.
902 * 902 *
903 * Moves the @param ess subsurface to just above the reference @param 903 * Moves the @param ess subsurface to just above the reference @param
904 * surface, changing the z-order. The reference @param surface must 904 * surface, changing the z-order. The reference @param surface must
@@ -908,26 +908,26 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y);
908 * @param ess the subsurface 908 * @param ess the subsurface
909 * @param surface the sibling reference surface 909 * @param surface the sibling reference surface
910 * 910 *
911 * @ingroup Ecore_Wl_Subsurf
912 * @since 1.8 911 * @since 1.8
913 */ 912 */
914EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface *surface); 913EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
915 914
916/** 915/**
917 * Place subsurface on layer below a reference surface 916 * @ingroup Ecore_Wl_Subsurf
917 * @brief Places subsurface on layer below a reference surface.
918 * 918 *
919 * See ecore_wl_subsurf_place_above. 919 * See ecore_wl_subsurf_place_above.
920 * 920 *
921 * @param ess the subsurface 921 * @param ess the subsurface
922 * @param surface the sibling reference surface 922 * @param surface the sibling reference surface
923 * 923 *
924 * @ingroup Ecore_Wl_Subsurf
925 * @since 1.8 924 * @since 1.8
926 */ 925 */
927EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface *surface); 926EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface *surface);
928 927
929/** 928/**
930 * Enables or disables sub-surface synchronization 929 * @ingroup Ecore_Wl_Subsurf
930 * @brief Enables or disables sub-surface synchronization.
931 * 931 *
932 * When synchronization is enabled, surface commits on the subsurface 932 * When synchronization is enabled, surface commits on the subsurface
933 * will be cached and only applied when the parent surface's state is 933 * will be cached and only applied when the parent surface's state is
@@ -949,13 +949,13 @@ EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface
949 * @param ess the subsurface 949 * @param ess the subsurface
950 * @param val true to enable synchronization, false to desynchronize 950 * @param val true to enable synchronization, false to desynchronize
951 * 951 *
952 * @ingroup Ecore_Wl_Subsurf
953 * @since 1.8 952 * @since 1.8
954 */ 953 */
955EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val); 954EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val);
956 955
957/** 956/**
958 * Set an opaque region for the given subsurface. 957 * @ingroup Ecore_Wl_Subsurf
958 * @brief Sets an opaque region for the given subsurface.
959 * 959 *
960 * This is an optimization hint to the compositor to allow it avoid 960 * This is an optimization hint to the compositor to allow it avoid
961 * redrawing content unnecessarily. Note that marking transparent 961 * redrawing content unnecessarily. Note that marking transparent
@@ -969,7 +969,6 @@ EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val);
969 * @param w width to set as opaque 969 * @param w width to set as opaque
970 * @param h height to set as opaque 970 * @param h height to set as opaque
971 * 971 *
972 * @ingroup Ecore_Wl_Subsurf
973 * @since 1.8 972 * @since 1.8
974 */ 973 */
975EAPI void ecore_wl_subsurf_opaque_region_set(Ecore_Wl_Subsurf *ess, int x, int y, int w, int h); 974EAPI void ecore_wl_subsurf_opaque_region_set(Ecore_Wl_Subsurf *ess, int x, int y, int w, int h);