diff options
author | Bryce Harrington <bryce@osg.samsung.com> | 2017-05-10 10:49:17 +0200 |
---|---|---|
committer | Stefan Schmidt <stefan@osg.samsung.com> | 2017-05-10 10:49:17 +0200 |
commit | 0f5ab72ed073ef552db206bd9831aa73c862efe2 (patch) | |
tree | 5fb14e3b729d968886cccec3098c85b77f1c1244 /src/lib/ecore_evas | |
parent | 4baeb17dbab8e438465b402dc6d11bf46613f506 (diff) |
ecore_evas: Improve linespacing consistency
Summary:
Adds a line between each function so it's more obvious what doc goes
with what API routine. Reorganize the doxygen elements so they're
consistently ordered and spaced.
No code or documentation changes; mostly just whitespace.
Reviewers: cedric
Subscribers: jpeg
Differential Revision: https://phab.enlightenment.org/D4866
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r-- | src/lib/ecore_evas/Ecore_Evas.h | 319 |
1 files changed, 244 insertions, 75 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 0675f8d6c8..9a2d8dd38d 100644 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h | |||
@@ -163,6 +163,7 @@ EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type eng | |||
163 | * @see ecore_evas_shutdown() | 163 | * @see ecore_evas_shutdown() |
164 | */ | 164 | */ |
165 | EAPI int ecore_evas_init(void); | 165 | EAPI int ecore_evas_init(void); |
166 | |||
166 | /** | 167 | /** |
167 | * @brief Shuts down the Ecore_Evas system. | 168 | * @brief Shuts down the Ecore_Evas system. |
168 | * | 169 | * |
@@ -189,9 +190,10 @@ EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync); | |||
189 | /** | 190 | /** |
190 | * @brief Get the compositing synchronization state | 191 | * @brief Get the compositing synchronization state |
191 | * | 192 | * |
193 | * @return True if app comp sync is enabled. | ||
194 | * | ||
192 | * @note This is an experimental functionality and is likely to be removed. | 195 | * @note This is an experimental functionality and is likely to be removed. |
193 | * | 196 | * |
194 | * @return True if app comp sync is enabled. | ||
195 | */ | 197 | */ |
196 | EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); | 198 | EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); |
197 | 199 | ||
@@ -203,12 +205,14 @@ EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); | |||
203 | * free or modify them, to free the list use ecore_evas_engines_free(). | 205 | * free or modify them, to free the list use ecore_evas_engines_free(). |
204 | */ | 206 | */ |
205 | EAPI Eina_List *ecore_evas_engines_get(void); | 207 | EAPI Eina_List *ecore_evas_engines_get(void); |
208 | |||
206 | /** | 209 | /** |
207 | * @brief Free list returned by ecore_evas_engines_get() | 210 | * @brief Free list returned by ecore_evas_engines_get() |
208 | * | 211 | * |
209 | * @param engines List with engine names | 212 | * @param engines List with engine names |
210 | */ | 213 | */ |
211 | EAPI void ecore_evas_engines_free(Eina_List *engines); | 214 | EAPI void ecore_evas_engines_free(Eina_List *engines); |
215 | |||
212 | /** | 216 | /** |
213 | * @brief Creates a new Ecore_Evas based on engine name and common parameters. | 217 | * @brief Creates a new Ecore_Evas based on engine name and common parameters. |
214 | * | 218 | * |
@@ -225,10 +229,10 @@ EAPI void ecore_evas_engines_free(Eina_List *engines); | |||
225 | * Pay attention that when getting this from shell commands, most | 229 | * Pay attention that when getting this from shell commands, most |
226 | * consider ';' as the command terminator, so you need to escape | 230 | * consider ';' as the command terminator, so you need to escape |
227 | * it or use quotes. | 231 | * it or use quotes. |
228 | * | ||
229 | * @return Ecore_Evas instance or @c NULL if creation failed. | 232 | * @return Ecore_Evas instance or @c NULL if creation failed. |
230 | */ | 233 | */ |
231 | EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options); | 234 | EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options); |
235 | |||
232 | /** | 236 | /** |
233 | * @brief Sets whether an Ecore_Evas has an alpha channel or not. | 237 | * @brief Sets whether an Ecore_Evas has an alpha channel or not. |
234 | * | 238 | * |
@@ -246,9 +250,12 @@ EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, in | |||
246 | * @warning Support for this depends on the underlying windowing system. | 250 | * @warning Support for this depends on the underlying windowing system. |
247 | */ | 251 | */ |
248 | EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); | 252 | EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); |
253 | |||
249 | /** | 254 | /** |
250 | * @brief Queries whether an Ecore_Evas has an alpha channel. | 255 | * @brief Queries whether an Ecore_Evas has an alpha channel. |
256 | * | ||
251 | * @param ee The Ecore_Evas to query. | 257 | * @param ee The Ecore_Evas to query. |
258 | * | ||
252 | * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does | 259 | * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does |
253 | * not. | 260 | * not. |
254 | * | 261 | * |
@@ -258,6 +265,7 @@ EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); | |||
258 | * @see ecore_evas_alpha_set() | 265 | * @see ecore_evas_alpha_set() |
259 | */ | 266 | */ |
260 | EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); | 267 | EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); |
268 | |||
261 | /** | 269 | /** |
262 | * @brief Sets whether an Ecore_Evas has an transparent window or not. | 270 | * @brief Sets whether an Ecore_Evas has an transparent window or not. |
263 | * | 271 | * |
@@ -273,6 +281,7 @@ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); | |||
273 | * @see ecore_evas_alpha_set() | 281 | * @see ecore_evas_alpha_set() |
274 | */ | 282 | */ |
275 | EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent); | 283 | EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent); |
284 | |||
276 | /** | 285 | /** |
277 | * @brief Queries whether an Ecore_Evas is transparent. | 286 | * @brief Queries whether an Ecore_Evas is transparent. |
278 | * | 287 | * |
@@ -282,6 +291,7 @@ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparen | |||
282 | * @see ecore_evas_transparent_set() | 291 | * @see ecore_evas_transparent_set() |
283 | */ | 292 | */ |
284 | EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); | 293 | EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); |
294 | |||
285 | /** | 295 | /** |
286 | * @brief Gets the geometry of an Ecore_Evas. | 296 | * @brief Gets the geometry of an Ecore_Evas. |
287 | * | 297 | * |
@@ -306,6 +316,7 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); | |||
306 | * @see ecore_evas_move_resize() | 316 | * @see ecore_evas_move_resize() |
307 | */ | 317 | */ |
308 | EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); | 318 | EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); |
319 | |||
309 | /** | 320 | /** |
310 | * @brief Gets the geometry which an Ecore_Evas was latest recently requested. | 321 | * @brief Gets the geometry which an Ecore_Evas was latest recently requested. |
311 | * | 322 | * |
@@ -331,6 +342,7 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i | |||
331 | * @since 1.1 | 342 | * @since 1.1 |
332 | */ | 343 | */ |
333 | EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); | 344 | EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); |
345 | |||
334 | /** | 346 | /** |
335 | * @brief Sets the Ecore_Evas window focus for the default seat. | 347 | * @brief Sets the Ecore_Evas window focus for the default seat. |
336 | * | 348 | * |
@@ -344,6 +356,7 @@ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, i | |||
344 | * @see ecore_evas_focus_device_set() | 356 | * @see ecore_evas_focus_device_set() |
345 | */ | 357 | */ |
346 | EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); | 358 | EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); |
359 | |||
347 | /** | 360 | /** |
348 | * @brief Queries whether the default seat has the Ecore_Evas focus. | 361 | * @brief Queries whether the default seat has the Ecore_Evas focus. |
349 | * | 362 | * |
@@ -382,6 +395,7 @@ EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat, | |||
382 | * @since 1.19 | 395 | * @since 1.19 |
383 | */ | 396 | */ |
384 | EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat); | 397 | EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat); |
398 | |||
385 | /** | 399 | /** |
386 | * @brief Iconifies or uniconifies an Ecore_Evas' window. | 400 | * @brief Iconifies or uniconifies an Ecore_Evas' window. |
387 | * | 401 | * |
@@ -396,6 +410,7 @@ EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat); | |||
396 | * @warning Support for this depends on the underlying windowing system. | 410 | * @warning Support for this depends on the underlying windowing system. |
397 | */ | 411 | */ |
398 | EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); | 412 | EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); |
413 | |||
399 | /** | 414 | /** |
400 | * @brief Queries whether an Ecore_Evas' window is iconified or not. | 415 | * @brief Queries whether an Ecore_Evas' window is iconified or not. |
401 | * | 416 | * |
@@ -407,6 +422,7 @@ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); | |||
407 | * @see ecore_evas_iconified_set() | 422 | * @see ecore_evas_iconified_set() |
408 | */ | 423 | */ |
409 | EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); | 424 | EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); |
425 | |||
410 | /** | 426 | /** |
411 | * @brief Sets whether an Ecore_Evas' window is borderless or not. | 427 | * @brief Sets whether an Ecore_Evas' window is borderless or not. |
412 | * | 428 | * |
@@ -419,6 +435,7 @@ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); | |||
419 | * @warning Support for this depends on the underlying windowing system. | 435 | * @warning Support for this depends on the underlying windowing system. |
420 | */ | 436 | */ |
421 | EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); | 437 | EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); |
438 | |||
422 | /** | 439 | /** |
423 | * @brief Queries whether an Ecore_Evas' window is borderless or not. | 440 | * @brief Queries whether an Ecore_Evas' window is borderless or not. |
424 | * | 441 | * |
@@ -428,6 +445,7 @@ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); | |||
428 | * @see ecore_evas_borderless_set() | 445 | * @see ecore_evas_borderless_set() |
429 | */ | 446 | */ |
430 | EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); | 447 | EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); |
448 | |||
431 | /** | 449 | /** |
432 | * @brief Sets whether or not an Ecore_Evas' window is fullscreen. | 450 | * @brief Sets whether or not an Ecore_Evas' window is fullscreen. |
433 | * | 451 | * |
@@ -440,6 +458,7 @@ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); | |||
440 | * @warning Support for this depends on the underlying windowing system. | 458 | * @warning Support for this depends on the underlying windowing system. |
441 | */ | 459 | */ |
442 | EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); | 460 | EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); |
461 | |||
443 | /** | 462 | /** |
444 | * @brief Queries whether an Ecore_Evas' window is fullscreen or not. | 463 | * @brief Queries whether an Ecore_Evas' window is fullscreen or not. |
445 | * | 464 | * |
@@ -449,6 +468,7 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); | |||
449 | * @see ecore_evas_fullscreen_set() | 468 | * @see ecore_evas_fullscreen_set() |
450 | */ | 469 | */ |
451 | EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); | 470 | EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); |
471 | |||
452 | /** | 472 | /** |
453 | * @brief Sets another window that this window is a group member of. | 473 | * @brief Sets another window that this window is a group member of. |
454 | * | 474 | * |
@@ -464,6 +484,7 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); | |||
464 | * @since 1.2 | 484 | * @since 1.2 |
465 | */ | 485 | */ |
466 | EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group); | 486 | EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group); |
487 | |||
467 | /** | 488 | /** |
468 | * @brief Gets the canvas group set. | 489 | * @brief Gets the canvas group set. |
469 | * | 490 | * |
@@ -476,6 +497,7 @@ EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *e | |||
476 | * @since 1.2 | 497 | * @since 1.2 |
477 | */ | 498 | */ |
478 | EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); | 499 | EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); |
500 | |||
479 | /** | 501 | /** |
480 | * @brief Sets the aspect ratio of a canvas window. | 502 | * @brief Sets the aspect ratio of a canvas window. |
481 | * | 503 | * |
@@ -488,6 +510,7 @@ EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); | |||
488 | * @since 1.2 | 510 | * @since 1.2 |
489 | */ | 511 | */ |
490 | EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); | 512 | EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); |
513 | |||
491 | /** | 514 | /** |
492 | * @brief Gets the aspect ratio of a canvas window. | 515 | * @brief Gets the aspect ratio of a canvas window. |
493 | * | 516 | * |
@@ -500,6 +523,7 @@ EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); | |||
500 | * @since 1.2 | 523 | * @since 1.2 |
501 | */ | 524 | */ |
502 | EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); | 525 | EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); |
526 | |||
503 | /** | 527 | /** |
504 | * @brief Sets The urgent hint flag. | 528 | * @brief Sets The urgent hint flag. |
505 | * | 529 | * |
@@ -513,6 +537,7 @@ EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); | |||
513 | * @since 1.2 | 537 | * @since 1.2 |
514 | */ | 538 | */ |
515 | EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); | 539 | EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); |
540 | |||
516 | /** | 541 | /** |
517 | * @brief Gets the urgent state on the canvas window. | 542 | * @brief Gets the urgent state on the canvas window. |
518 | * | 543 | * |
@@ -525,6 +550,7 @@ EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); | |||
525 | * @since 1.2 | 550 | * @since 1.2 |
526 | */ | 551 | */ |
527 | EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); | 552 | EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); |
553 | |||
528 | /** | 554 | /** |
529 | * @brief Sets the modal state flag on the canvas window. | 555 | * @brief Sets the modal state flag on the canvas window. |
530 | * | 556 | * |
@@ -539,6 +565,7 @@ EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); | |||
539 | * @since 1.2 | 565 | * @since 1.2 |
540 | */ | 566 | */ |
541 | EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); | 567 | EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); |
568 | |||
542 | /** | 569 | /** |
543 | * @brief Gets The modal flag. | 570 | * @brief Gets The modal flag. |
544 | * | 571 | * |
@@ -551,6 +578,7 @@ EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); | |||
551 | * @since 1.2 | 578 | * @since 1.2 |
552 | */ | 579 | */ |
553 | EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); | 580 | EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); |
581 | |||
554 | /** | 582 | /** |
555 | * @brief Sets the "i demand attention" flag on a canvas window. | 583 | * @brief Sets the "i demand attention" flag on a canvas window. |
556 | * | 584 | * |
@@ -564,6 +592,7 @@ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); | |||
564 | * @since 1.2 | 592 | * @since 1.2 |
565 | */ | 593 | */ |
566 | EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand); | 594 | EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand); |
595 | |||
567 | /** | 596 | /** |
568 | * @brief Gets the "i demand attention" flag. | 597 | * @brief Gets the "i demand attention" flag. |
569 | * | 598 | * |
@@ -576,6 +605,7 @@ EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool deman | |||
576 | * @since 1.2 | 605 | * @since 1.2 |
577 | */ | 606 | */ |
578 | EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); | 607 | EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); |
608 | |||
579 | /** | 609 | /** |
580 | * @brief Sets the "focus skip" flag. | 610 | * @brief Sets the "focus skip" flag. |
581 | * | 611 | * |
@@ -591,6 +621,7 @@ EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); | |||
591 | * @since 1.2 | 621 | * @since 1.2 |
592 | */ | 622 | */ |
593 | EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip); | 623 | EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip); |
624 | |||
594 | /** | 625 | /** |
595 | * @brief Gets the "focus skip" flag. | 626 | * @brief Gets the "focus skip" flag. |
596 | * | 627 | * |
@@ -613,6 +644,7 @@ EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee); | |||
613 | * @warning Support for this depends on the underlying windowing system. | 644 | * @warning Support for this depends on the underlying windowing system. |
614 | */ | 645 | */ |
615 | EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); | 646 | EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); |
647 | |||
616 | /** | 648 | /** |
617 | * @brief Returns the ignore state of an Ecore_Evas' window. | 649 | * @brief Returns the ignore state of an Ecore_Evas' window. |
618 | * | 650 | * |
@@ -622,6 +654,7 @@ EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); | |||
622 | * @see ecore_evas_ignore_events_set() | 654 | * @see ecore_evas_ignore_events_set() |
623 | */ | 655 | */ |
624 | EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); | 656 | EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); |
657 | |||
625 | /** | 658 | /** |
626 | * @brief Queries whether an Ecore_Evas' window is visible or not. | 659 | * @brief Queries whether an Ecore_Evas' window is visible or not. |
627 | * | 660 | * |
@@ -634,6 +667,7 @@ EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); | |||
634 | * @see ecore_evas_hide() | 667 | * @see ecore_evas_hide() |
635 | */ | 668 | */ |
636 | EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); | 669 | EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); |
670 | |||
637 | /** | 671 | /** |
638 | * @brief Sets the layer of an Ecore_Evas' window. | 672 | * @brief Sets the layer of an Ecore_Evas' window. |
639 | * | 673 | * |
@@ -648,6 +682,7 @@ EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); | |||
648 | * @see ecore_evas_raise() | 682 | * @see ecore_evas_raise() |
649 | */ | 683 | */ |
650 | EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); | 684 | EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); |
685 | |||
651 | /** | 686 | /** |
652 | * @brief Gets the layer of an Ecore_Evas' window. | 687 | * @brief Gets the layer of an Ecore_Evas' window. |
653 | * | 688 | * |
@@ -659,6 +694,7 @@ EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); | |||
659 | * @see ecore_evas_raise() | 694 | * @see ecore_evas_raise() |
660 | */ | 695 | */ |
661 | EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); | 696 | EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); |
697 | |||
662 | /** | 698 | /** |
663 | * @brief Maximizes (or unmaximizes) an Ecore_Evas' window. | 699 | * @brief Maximizes (or unmaximizes) an Ecore_Evas' window. |
664 | * | 700 | * |
@@ -671,6 +707,7 @@ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); | |||
671 | * @warning Support for this depends on the underlying windowing system. | 707 | * @warning Support for this depends on the underlying windowing system. |
672 | */ | 708 | */ |
673 | EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); | 709 | EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); |
710 | |||
674 | /** | 711 | /** |
675 | * @brief Queries whether an Ecore_Evas' window is maximized or not. | 712 | * @brief Queries whether an Ecore_Evas' window is maximized or not. |
676 | * | 713 | * |
@@ -680,6 +717,7 @@ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); | |||
680 | * @see ecore_evas_maximized_set() | 717 | * @see ecore_evas_maximized_set() |
681 | */ | 718 | */ |
682 | EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); | 719 | EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); |
720 | |||
683 | /** | 721 | /** |
684 | * @brief Queries if the underlying windowing system supports the window profile. | 722 | * @brief Queries if the underlying windowing system supports the window profile. |
685 | * | 723 | * |
@@ -690,6 +728,7 @@ EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); | |||
690 | * @since 1.8.0 | 728 | * @since 1.8.0 |
691 | */ | 729 | */ |
692 | EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); | 730 | EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); |
731 | |||
693 | /** | 732 | /** |
694 | * @brief Sets the window profile. | 733 | * @brief Sets the window profile. |
695 | * | 734 | * |
@@ -700,6 +739,7 @@ EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); | |||
700 | * @since 1.8.0 | 739 | * @since 1.8.0 |
701 | */ | 740 | */ |
702 | EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile); | 741 | EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile); |
742 | |||
703 | /** | 743 | /** |
704 | * @brief Gets the window profile. | 744 | * @brief Gets the window profile. |
705 | * | 745 | * |
@@ -710,6 +750,7 @@ EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profi | |||
710 | * @since 1.8.0 | 750 | * @since 1.8.0 |
711 | */ | 751 | */ |
712 | EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); | 752 | EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); |
753 | |||
713 | /** | 754 | /** |
714 | * @brief Sets the array of available window profiles. | 755 | * @brief Sets the array of available window profiles. |
715 | * | 756 | * |
@@ -721,6 +762,7 @@ EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); | |||
721 | * @since 1.8.0 | 762 | * @since 1.8.0 |
722 | */ | 763 | */ |
723 | EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count); | 764 | EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count); |
765 | |||
724 | /** | 766 | /** |
725 | * @brief Gets the array of available window profiles. | 767 | * @brief Gets the array of available window profiles. |
726 | * | 768 | * |
@@ -733,6 +775,7 @@ EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const | |||
733 | * @since 1.8.0 | 775 | * @since 1.8.0 |
734 | */ | 776 | */ |
735 | EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count); | 777 | EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count); |
778 | |||
736 | /** | 779 | /** |
737 | * @brief Queries if the underlying windowing system supports the window manager rotation. | 780 | * @brief Queries if the underlying windowing system supports the window manager rotation. |
738 | * | 781 | * |
@@ -743,6 +786,7 @@ EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char * | |||
743 | * @since 1.9.0 | 786 | * @since 1.9.0 |
744 | */ | 787 | */ |
745 | EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); | 788 | EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); |
789 | |||
746 | /** | 790 | /** |
747 | * @brief Sets the preferred rotation hint. | 791 | * @brief Sets the preferred rotation hint. |
748 | * | 792 | * |
@@ -753,6 +797,7 @@ EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); | |||
753 | * @since 1.9.0 | 797 | * @since 1.9.0 |
754 | */ | 798 | */ |
755 | EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation); | 799 | EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation); |
800 | |||
756 | /** | 801 | /** |
757 | * @brief Gets the preferred rotation hint. | 802 | * @brief Gets the preferred rotation hint. |
758 | * | 803 | * |
@@ -763,6 +808,7 @@ EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, i | |||
763 | * @since 1.9.0 | 808 | * @since 1.9.0 |
764 | */ | 809 | */ |
765 | EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee); | 810 | EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee); |
811 | |||
766 | /** | 812 | /** |
767 | * @brief Sets the array of available window rotations. | 813 | * @brief Sets the array of available window rotations. |
768 | * | 814 | * |
@@ -774,6 +820,7 @@ EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas | |||
774 | * @since 1.9.0 | 820 | * @since 1.9.0 |
775 | */ | 821 | */ |
776 | EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count); | 822 | EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count); |
823 | |||
777 | /** | 824 | /** |
778 | * @brief Gets the array of available window rotations. | 825 | * @brief Gets the array of available window rotations. |
779 | * | 826 | * |
@@ -786,6 +833,7 @@ EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, | |||
786 | * @since 1.9.0 | 833 | * @since 1.9.0 |
787 | */ | 834 | */ |
788 | EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count); | 835 | EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count); |
836 | |||
789 | /** | 837 | /** |
790 | * @brief Sets manual rotation done mode of Ecore_Evas's window. | 838 | * @brief Sets manual rotation done mode of Ecore_Evas's window. |
791 | * | 839 | * |
@@ -797,6 +845,7 @@ EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas | |||
797 | * @since 1.9.0 | 845 | * @since 1.9.0 |
798 | */ | 846 | */ |
799 | EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set); | 847 | EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set); |
848 | |||
800 | /** | 849 | /** |
801 | * @brief Gets manual rotation done mode of Ecore_Evas's window. | 850 | * @brief Gets manual rotation done mode of Ecore_Evas's window. |
802 | * | 851 | * |
@@ -806,6 +855,7 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, | |||
806 | * @since 1.9.0 | 855 | * @since 1.9.0 |
807 | */ | 856 | */ |
808 | EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee); | 857 | EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee); |
858 | |||
809 | /** | 859 | /** |
810 | * @brief Sets rotation finish manually. | 860 | * @brief Sets rotation finish manually. |
811 | * | 861 | * |
@@ -814,11 +864,13 @@ EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Eva | |||
814 | * @since 1.9.0 | 864 | * @since 1.9.0 |
815 | */ | 865 | */ |
816 | EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); | 866 | EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); |
867 | |||
817 | /** | 868 | /** |
818 | * @brief Gets the list of supported auxiliary hint strings. | 869 | * @brief Gets the list of supported auxiliary hint strings. |
819 | * | 870 | * |
820 | * @param ee The Ecore_Evas | 871 | * @param ee The Ecore_Evas |
821 | * @return List of supported auxiliary hint strings. | 872 | * @return List of supported auxiliary hint strings. |
873 | * | ||
822 | * @note Do not change the returned list of its contents. Auxiliary hint | 874 | * @note Do not change the returned list of its contents. Auxiliary hint |
823 | * strings are internal and should be considered constants, do not free or | 875 | * strings are internal and should be considered constants, do not free or |
824 | * modify them. | 876 | * modify them. |
@@ -836,11 +888,13 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); | |||
836 | * @since 1.10.0 | 888 | * @since 1.10.0 |
837 | */ | 889 | */ |
838 | EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); | 890 | EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); |
891 | |||
839 | /** | 892 | /** |
840 | * @brief Gets the list of allowed auxiliary hint IDs. | 893 | * @brief Gets the list of allowed auxiliary hint IDs. |
841 | * | 894 | * |
842 | * @param ee The Ecore_Evas | 895 | * @param ee The Ecore_Evas |
843 | * @return List of allowed auxiliary hint IDs. | 896 | * @return List of allowed auxiliary hint IDs. |
897 | * | ||
844 | * @note This function is low level. Instead of using it directly, consider | 898 | * @note This function is low level. Instead of using it directly, consider |
845 | * using the callback mechanism in Elementary such as "aux,hint,allowed". | 899 | * using the callback mechanism in Elementary such as "aux,hint,allowed". |
846 | * @warning Support for this depends on the underlying windowing system. | 900 | * @warning Support for this depends on the underlying windowing system. |
@@ -848,6 +902,7 @@ EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); | |||
848 | * @since 1.10.0 | 902 | * @since 1.10.0 |
849 | */ | 903 | */ |
850 | EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); | 904 | EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); |
905 | |||
851 | /** | 906 | /** |
852 | * @brief Creates an auxiliary hint of the Ecore_Evas. | 907 | * @brief Creates an auxiliary hint of the Ecore_Evas. |
853 | * | 908 | * |
@@ -855,22 +910,26 @@ EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); | |||
855 | * @param hint The auxiliary hint string. | 910 | * @param hint The auxiliary hint string. |
856 | * @param val The value string. | 911 | * @param val The value string. |
857 | * @return The ID of created auxiliary hint, or @c -1 on failure. | 912 | * @return The ID of created auxiliary hint, or @c -1 on failure. |
913 | * | ||
858 | * @warning Support for this depends on the underlying windowing system. | 914 | * @warning Support for this depends on the underlying windowing system. |
859 | * | 915 | * |
860 | * @since 1.10.0 | 916 | * @since 1.10.0 |
861 | */ | 917 | */ |
862 | EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val); | 918 | EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val); |
919 | |||
863 | /** | 920 | /** |
864 | * @brief Deletes an auxiliary hint of the Ecore_Evas. | 921 | * @brief Deletes an auxiliary hint of the Ecore_Evas. |
865 | * | 922 | * |
866 | * @param ee The Ecore_Evas | 923 | * @param ee The Ecore_Evas |
867 | * @param id The ID of the auxiliary hint. | 924 | * @param id The ID of the auxiliary hint. |
868 | * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise. | 925 | * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise. |
926 | * | ||
869 | * @warning Support for this depends on the underlying windowing system. | 927 | * @warning Support for this depends on the underlying windowing system. |
870 | * | 928 | * |
871 | * @since 1.10.0 | 929 | * @since 1.10.0 |
872 | */ | 930 | */ |
873 | EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); | 931 | EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); |
932 | |||
874 | /** | 933 | /** |
875 | * @brief Changes a value of the auxiliary hint. | 934 | * @brief Changes a value of the auxiliary hint. |
876 | * | 935 | * |
@@ -878,28 +937,33 @@ EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); | |||
878 | * @param id The auxiliary hint ID. | 937 | * @param id The auxiliary hint ID. |
879 | * @param val The value string to be set. | 938 | * @param val The value string to be set. |
880 | * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise. | 939 | * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise. |
940 | * | ||
881 | * @warning Support for this depends on the underlying windowing system. | 941 | * @warning Support for this depends on the underlying windowing system. |
882 | * | 942 | * |
883 | * @since 1.10.0 | 943 | * @since 1.10.0 |
884 | */ | 944 | */ |
885 | EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val); | 945 | EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val); |
946 | |||
886 | /** | 947 | /** |
887 | * @brief Gets a value of the auxiliary hint. | 948 | * @brief Gets a value of the auxiliary hint. |
888 | * | 949 | * |
889 | * @param ee The Ecore_Evas | 950 | * @param ee The Ecore_Evas |
890 | * @param id The auxiliary hint ID. | 951 | * @param id The auxiliary hint ID. |
891 | * @return The string value of the auxiliary hint ID, or NULL if none exists | 952 | * @return The string value of the auxiliary hint ID, or NULL if none exists |
953 | * | ||
892 | * @warning Support for this depends on the underlying windowing system. | 954 | * @warning Support for this depends on the underlying windowing system. |
893 | * | 955 | * |
894 | * @since 1.15 | 956 | * @since 1.15 |
895 | */ | 957 | */ |
896 | EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id); | 958 | EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id); |
959 | |||
897 | /** | 960 | /** |
898 | * @brief Gets a ID of the auxiliary hint string. | 961 | * @brief Gets a ID of the auxiliary hint string. |
899 | * | 962 | * |
900 | * @param ee The Ecore_Evas | 963 | * @param ee The Ecore_Evas |
901 | * @param hint The auxiliary hint string. | 964 | * @param hint The auxiliary hint string. |
902 | * @return The ID of the auxiliary hint string, or @c -1 if none exists | 965 | * @return The ID of the auxiliary hint string, or @c -1 if none exists |
966 | * | ||
903 | * @warning Support for this depends on the underlying windowing system. | 967 | * @warning Support for this depends on the underlying windowing system. |
904 | * | 968 | * |
905 | * @since 1.15 | 969 | * @since 1.15 |
@@ -927,6 +991,7 @@ EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const cha | |||
927 | * @li @ref ecore_evas_extn_plug_example | 991 | * @li @ref ecore_evas_extn_plug_example |
928 | */ | 992 | */ |
929 | EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); | 993 | EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); |
994 | |||
930 | /** | 995 | /** |
931 | * @brief Sends message to child ecore. | 996 | * @brief Sends message to child ecore. |
932 | * | 997 | * |
@@ -944,6 +1009,7 @@ EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, | |||
944 | * @see eecore_evas_callback_msg_handle_set() | 1009 | * @see eecore_evas_callback_msg_handle_set() |
945 | */ | 1010 | */ |
946 | EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); | 1011 | EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); |
1012 | |||
947 | /** | 1013 | /** |
948 | * @brief Sets a callback for parent Ecore_Evas message. | 1014 | * @brief Sets a callback for parent Ecore_Evas message. |
949 | * | 1015 | * |
@@ -958,6 +1024,7 @@ EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void * | |||
958 | * @see eecore_evas_callback_msg_handle_set() | 1024 | * @see eecore_evas_callback_msg_handle_set() |
959 | */ | 1025 | */ |
960 | EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)); | 1026 | EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)); |
1027 | |||
961 | /** | 1028 | /** |
962 | * @brief Sets a callback for child Ecore_Evas message. | 1029 | * @brief Sets a callback for child Ecore_Evas message. |
963 | * | 1030 | * |
@@ -989,6 +1056,7 @@ EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle) | |||
989 | * @see ecore_evas_move_resize() | 1056 | * @see ecore_evas_move_resize() |
990 | */ | 1057 | */ |
991 | EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); | 1058 | EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); |
1059 | |||
992 | /** | 1060 | /** |
993 | * @brief Resizes an Ecore_Evas. | 1061 | * @brief Resizes an Ecore_Evas. |
994 | * | 1062 | * |
@@ -1005,6 +1073,7 @@ EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); | |||
1005 | * @see ecore_evas_move_resize() | 1073 | * @see ecore_evas_move_resize() |
1006 | */ | 1074 | */ |
1007 | EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); | 1075 | EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); |
1076 | |||
1008 | /** | 1077 | /** |
1009 | * @brief Moves and resizes an Ecore_Evas. | 1078 | * @brief Moves and resizes an Ecore_Evas. |
1010 | * | 1079 | * |
@@ -1024,6 +1093,7 @@ EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); | |||
1024 | * @see ecore_evas_resize() | 1093 | * @see ecore_evas_resize() |
1025 | */ | 1094 | */ |
1026 | EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h); | 1095 | EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h); |
1096 | |||
1027 | /** | 1097 | /** |
1028 | * @brief Sets the rotation of an Ecore_Evas' window. | 1098 | * @brief Sets the rotation of an Ecore_Evas' window. |
1029 | * | 1099 | * |
@@ -1038,6 +1108,7 @@ EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int | |||
1038 | * @see ecore_evas_rotation_with_resize_set() | 1108 | * @see ecore_evas_rotation_with_resize_set() |
1039 | */ | 1109 | */ |
1040 | EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); | 1110 | EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); |
1111 | |||
1041 | /** | 1112 | /** |
1042 | * @brief Sets the rotation of an Ecore_Evas' window. | 1113 | * @brief Sets the rotation of an Ecore_Evas' window. |
1043 | * | 1114 | * |
@@ -1052,6 +1123,7 @@ EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); | |||
1052 | * @see ecore_evas_rotation_set() | 1123 | * @see ecore_evas_rotation_set() |
1053 | */ | 1124 | */ |
1054 | EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); | 1125 | EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); |
1126 | |||
1055 | /** | 1127 | /** |
1056 | * @brief Gets the rotation of an Ecore_Evas' window | 1128 | * @brief Gets the rotation of an Ecore_Evas' window |
1057 | * | 1129 | * |
@@ -1062,6 +1134,7 @@ EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); | |||
1062 | * @see ecore_evas_rotation_with_resize_set() | 1134 | * @see ecore_evas_rotation_with_resize_set() |
1063 | */ | 1135 | */ |
1064 | EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); | 1136 | EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); |
1137 | |||
1065 | /** | 1138 | /** |
1066 | * @brief Raises an Ecore_Evas' window. | 1139 | * @brief Raises an Ecore_Evas' window. |
1067 | * | 1140 | * |
@@ -1075,6 +1148,7 @@ EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); | |||
1075 | * @see ecore_evas_layer_set() | 1148 | * @see ecore_evas_layer_set() |
1076 | */ | 1149 | */ |
1077 | EAPI void ecore_evas_raise(Ecore_Evas *ee); | 1150 | EAPI void ecore_evas_raise(Ecore_Evas *ee); |
1151 | |||
1078 | /** | 1152 | /** |
1079 | * @brief Lowers an Ecore_Evas' window. | 1153 | * @brief Lowers an Ecore_Evas' window. |
1080 | * | 1154 | * |
@@ -1088,6 +1162,7 @@ EAPI void ecore_evas_raise(Ecore_Evas *ee); | |||
1088 | * @see ecore_evas_layer_set() | 1162 | * @see ecore_evas_layer_set() |
1089 | */ | 1163 | */ |
1090 | EAPI void ecore_evas_lower(Ecore_Evas *ee); | 1164 | EAPI void ecore_evas_lower(Ecore_Evas *ee); |
1165 | |||
1091 | /** | 1166 | /** |
1092 | * @brief Sets the title of an Ecore_Evas' window. | 1167 | * @brief Sets the title of an Ecore_Evas' window. |
1093 | * | 1168 | * |
@@ -1099,6 +1174,7 @@ EAPI void ecore_evas_lower(Ecore_Evas *ee); | |||
1099 | * @warning Support for this depends on the underlying windowing system. | 1174 | * @warning Support for this depends on the underlying windowing system. |
1100 | */ | 1175 | */ |
1101 | EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); | 1176 | EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); |
1177 | |||
1102 | /** | 1178 | /** |
1103 | * @brief Gets the title of an Ecore_Evas' window. | 1179 | * @brief Gets the title of an Ecore_Evas' window. |
1104 | * | 1180 | * |
@@ -1110,6 +1186,7 @@ EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); | |||
1110 | * @see ecore_evas_title_set() | 1186 | * @see ecore_evas_title_set() |
1111 | */ | 1187 | */ |
1112 | EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); | 1188 | EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); |
1189 | |||
1113 | /** | 1190 | /** |
1114 | * @brief Sets the name and class of an Ecore_Evas' window. | 1191 | * @brief Sets the name and class of an Ecore_Evas' window. |
1115 | * | 1192 | * |
@@ -1123,18 +1200,21 @@ EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); | |||
1123 | * @warning Support for this depends on the underlying windowing system. | 1200 | * @warning Support for this depends on the underlying windowing system. |
1124 | */ | 1201 | */ |
1125 | EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c); | 1202 | EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c); |
1203 | |||
1126 | /** | 1204 | /** |
1127 | * @brief Gets the name and class of an Ecore_Evas' window. | 1205 | * @brief Gets the name and class of an Ecore_Evas' window. |
1128 | * | 1206 | * |
1129 | * This function gets the name of @p ee into @p n, and its class into | ||
1130 | * @p c. | ||
1131 | * | ||
1132 | * @param ee The Ecore_Evas to query. | 1207 | * @param ee The Ecore_Evas to query. |
1133 | * @param n A pointer to a string to place the name in. | 1208 | * @param n A pointer to a string to place the name in. |
1134 | * @param c A pointer to a string to place the class in. | 1209 | * @param c A pointer to a string to place the class in. |
1210 | * | ||
1211 | * This function gets the name of @p ee into @p n, and its class into | ||
1212 | * @p c. | ||
1213 | * | ||
1135 | * @see ecore_evas_name_class_set() | 1214 | * @see ecore_evas_name_class_set() |
1136 | */ | 1215 | */ |
1137 | EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c); | 1216 | EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c); |
1217 | |||
1138 | /** | 1218 | /** |
1139 | * @brief Returns a pointer to the underlying window. | 1219 | * @brief Returns a pointer to the underlying window. |
1140 | * | 1220 | * |
@@ -1149,7 +1229,7 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); | |||
1149 | 1229 | ||
1150 | /** | 1230 | /** |
1151 | * @brief Creates Ecore_Evas using software x11. | 1231 | * @brief Creates Ecore_Evas using software x11. |
1152 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. | 1232 | * |
1153 | * @param disp_name The name of the Ecore_Evas to be created. | 1233 | * @param disp_name The name of the Ecore_Evas to be created. |
1154 | * @param parent The parent of the Ecore_Evas to be created. | 1234 | * @param parent The parent of the Ecore_Evas to be created. |
1155 | * @param x The X coordinate to be used. | 1235 | * @param x The X coordinate to be used. |
@@ -1157,40 +1237,50 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); | |||
1157 | * @param w The width of the Ecore_Evas to be created. | 1237 | * @param w The width of the Ecore_Evas to be created. |
1158 | * @param h The height of the Ecore_Evas to be created. | 1238 | * @param h The height of the Ecore_Evas to be created. |
1159 | * @return A handle to the created Ecore_Evas. | 1239 | * @return A handle to the created Ecore_Evas. |
1240 | * | ||
1241 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. | ||
1160 | */ | 1242 | */ |
1161 | EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); | 1243 | EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); |
1162 | 1244 | ||
1163 | /** | 1245 | /** |
1164 | * @brief Gets the window from Ecore_Evas using software x11. | 1246 | * @brief Gets the window from Ecore_Evas using software x11. |
1247 | * | ||
1248 | * @param ee The Ecore_Evas from which to get the window. | ||
1249 | * @return The window of type Ecore_X_Window. | ||
1250 | * | ||
1165 | * @note If ecore is not compiled with support for x11 or if @p ee was not | 1251 | * @note If ecore is not compiled with support for x11 or if @p ee was not |
1166 | * created with ecore_evas_software_x11_new() then nothing is done and | 1252 | * created with ecore_evas_software_x11_new() then nothing is done and |
1167 | * 0 is returned. | 1253 | * 0 is returned. |
1168 | * @param ee The Ecore_Evas from which to get the window. | ||
1169 | * @return The window of type Ecore_X_Window. | ||
1170 | */ | 1254 | */ |
1171 | EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); | 1255 | EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); |
1172 | 1256 | ||
1173 | /** | 1257 | /** |
1174 | * @brief Sets the direct_resize of Ecore_Evas using software x11. | 1258 | * @brief Sets the direct_resize of Ecore_Evas using software x11. |
1175 | * @note If ecore is not compiled with support for x11 then nothing is done. | 1259 | * |
1176 | * @param ee The Ecore_Evas in which to set direct resize. | 1260 | * @param ee The Ecore_Evas in which to set direct resize. |
1177 | * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE. | 1261 | * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE. |
1262 | * | ||
1263 | * @note If ecore is not compiled with support for x11 then nothing is done. | ||
1178 | */ | 1264 | */ |
1179 | EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); | 1265 | EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); |
1180 | 1266 | ||
1181 | /** | 1267 | /** |
1182 | * @brief Gets if the Ecore_Evas is being directly resized using software x11. | 1268 | * @brief Gets if the Ecore_Evas is being directly resized using software x11. |
1183 | * @note If ecore is not compiled with support for x11 then nothing is done and EINA_FALSE is returned. | 1269 | * |
1184 | * @param ee The Ecore_Evas from which to get direct resize. | 1270 | * @param ee The Ecore_Evas from which to get direct resize. |
1185 | * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. | 1271 | * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. |
1272 | * | ||
1273 | * @note If ecore is not compiled with support for x11 then nothing is done and EINA_FALSE is returned. | ||
1186 | */ | 1274 | */ |
1187 | EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee); | 1275 | EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee); |
1188 | 1276 | ||
1189 | /** | 1277 | /** |
1190 | * @brief Adds an extra window on Ecore_Evas using software x11. | 1278 | * @brief Adds an extra window on Ecore_Evas using software x11. |
1191 | * @note If ecore is not compiled with support for x11 then nothing is done. | 1279 | * |
1192 | * @param ee The Ecore_Evas for which to add the window. | 1280 | * @param ee The Ecore_Evas for which to add the window. |
1193 | * @param win The window to be added to the Ecore_Evas. | 1281 | * @param win The window to be added to the Ecore_Evas. |
1282 | * | ||
1283 | * @note If ecore is not compiled with support for x11 then nothing is done. | ||
1194 | */ | 1284 | */ |
1195 | EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); | 1285 | EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); |
1196 | 1286 | ||
@@ -1240,22 +1330,30 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee); | |||
1240 | /** | 1330 | /** |
1241 | * @brief Creates Ecore_Evas using opengl x11. | 1331 | * @brief Creates Ecore_Evas using opengl x11. |
1242 | * | 1332 | * |
1243 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. | ||
1244 | * | ||
1245 | * @param disp_name The name of the display of the Ecore_Evas to be created. | 1333 | * @param disp_name The name of the display of the Ecore_Evas to be created. |
1246 | * @param parent The parent of the Ecore_Evas to be created. | 1334 | * @param parent The parent of the Ecore_Evas to be created. |
1247 | * @param x The X coordinate to be used. | 1335 | * @param x The X coordinate to be used. |
1248 | * @param y The Y coordinate to be used. | 1336 | * @param y The Y coordinate to be used. |
1249 | * @param w The width of the Ecore_Evas to be created. | 1337 | * @param w The width of the Ecore_Evas to be created. |
1250 | * @param h The height of the Ecore_Evas to be created. | 1338 | * @param h The height of the Ecore_Evas to be created. |
1251 | * | ||
1252 | * @return The new Ecore_Evas. | 1339 | * @return The new Ecore_Evas. |
1340 | * | ||
1341 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. | ||
1253 | */ | 1342 | */ |
1254 | EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); | 1343 | EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); |
1255 | 1344 | ||
1256 | /** | 1345 | /** |
1257 | * @brief Create Ecore_Evas using OpenGL X11, with options | 1346 | * @brief Create Ecore_Evas using OpenGL X11, with options |
1258 | * | 1347 | * |
1348 | * @param disp_name The name of the display of the Ecore_Evas to be created. | ||
1349 | * @param parent The parent of the Ecore_Evas to be created. | ||
1350 | * @param x The X coordinate to be used. | ||
1351 | * @param y The Y coordinate to be used. | ||
1352 | * @param w The width of the Ecore_Evas to be created. | ||
1353 | * @param h The height of the Ecore_Evas to be created. | ||
1354 | * @param opt The options array (see above) | ||
1355 | * @return The new Ecore_Evas. | ||
1356 | * | ||
1259 | * Allows creation of an Ecore_Evas, similar to ecore_evas_gl_x11_new, | 1357 | * Allows creation of an Ecore_Evas, similar to ecore_evas_gl_x11_new, |
1260 | * except it permits passing in @p opt, a NULL-terminated C array of | 1358 | * except it permits passing in @p opt, a NULL-terminated C array of |
1261 | * key/value pairs for various settings, as follows: | 1359 | * key/value pairs for various settings, as follows: |
@@ -1268,60 +1366,61 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window | |||
1268 | * ECORE_EVAS_GL_X11_OPT_GL_MSAA: msaa_bits | 1366 | * ECORE_EVAS_GL_X11_OPT_GL_MSAA: msaa_bits |
1269 | * | 1367 | * |
1270 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. | 1368 | * @note If ecore is not compiled with support for x11 then nothing is done and NULL is returned. |
1271 | * | ||
1272 | * @param disp_name The name of the display of the Ecore_Evas to be created. | ||
1273 | * @param parent The parent of the Ecore_Evas to be created. | ||
1274 | * @param x The X coordinate to be used. | ||
1275 | * @param y The Y coordinate to be used. | ||
1276 | * @param w The width of the Ecore_Evas to be created. | ||
1277 | * @param h The height of the Ecore_Evas to be created. | ||
1278 | * @param opt The options array (see above) | ||
1279 | * | ||
1280 | * @return The new Ecore_Evas. | ||
1281 | */ | 1369 | */ |
1282 | EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt); | 1370 | EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt); |
1283 | 1371 | ||
1284 | /** | 1372 | /** |
1285 | * @brief Gets the window from Ecore_Evas using opengl x11. | 1373 | * @brief Gets the window from Ecore_Evas using opengl x11. |
1374 | * | ||
1375 | * @param ee The Ecore_Evas from which to get the window. | ||
1376 | * @return The window of type Ecore_X_Window of Ecore_Evas. | ||
1377 | * | ||
1286 | * @note If ecore is not compiled with support for x11 or if @p ee was not | 1378 | * @note If ecore is not compiled with support for x11 or if @p ee was not |
1287 | * created with ecore_evas_gl_x11_new() then nothing is done and | 1379 | * created with ecore_evas_gl_x11_new() then nothing is done and |
1288 | * 0 is returned. | 1380 | * 0 is returned. |
1289 | * @param ee The Ecore_Evas from which to get the window. | ||
1290 | * @return The window of type Ecore_X_Window of Ecore_Evas. | ||
1291 | */ | 1381 | */ |
1292 | EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); | 1382 | EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); |
1293 | 1383 | ||
1294 | /** | 1384 | /** |
1295 | * @brief Sets direct_resize for Ecore_Evas using opengl x11. | 1385 | * @brief Sets direct_resize for Ecore_Evas using opengl x11. |
1296 | * @note If ecore is not compiled with support for x11 then nothing is done. | 1386 | * |
1297 | * @param ee The Ecore_Evas in which to set direct resize. | 1387 | * @param ee The Ecore_Evas in which to set direct resize. |
1298 | * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE. | 1388 | * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE. |
1389 | * | ||
1390 | * @note If ecore is not compiled with support for x11 then nothing is done. | ||
1299 | */ | 1391 | */ |
1300 | EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); | 1392 | EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); |
1301 | 1393 | ||
1302 | /** | 1394 | /** |
1303 | * @brief Gets if the Ecore_Evas is being directly resized using opengl x11. | 1395 | * @brief Gets if the Ecore_Evas is being directly resized using opengl x11. |
1304 | * @note If ecore is not compiled with support for x11 then nothing is done and EINA_FALSE is returned. | 1396 | * |
1305 | * @param ee The Ecore_Evas from which to get direct resize. | 1397 | * @param ee The Ecore_Evas from which to get direct resize. |
1398 | * | ||
1399 | * @note If ecore is not compiled with support for x11 then nothing is done and EINA_FALSE is returned. | ||
1400 | * | ||
1306 | * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. | 1401 | * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. |
1307 | */ | 1402 | */ |
1308 | EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); | 1403 | EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); |
1309 | 1404 | ||
1310 | /** | 1405 | /** |
1311 | * @brief Adds extra window on Ecore_Evas using opengl x11. | 1406 | * @brief Adds extra window on Ecore_Evas using opengl x11. |
1312 | * @note If ecore is not compiled with support for x11 then nothing is done. | 1407 | * |
1313 | * @param ee The Ecore_Evas for which to add the window. | 1408 | * @param ee The Ecore_Evas for which to add the window. |
1314 | * @param win The window to be added to the Ecore_Evas. | 1409 | * @param win The window to be added to the Ecore_Evas. |
1410 | * | ||
1411 | * @note If ecore is not compiled with support for x11 then nothing is done. | ||
1315 | */ | 1412 | */ |
1316 | EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); | 1413 | EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); |
1317 | 1414 | ||
1318 | /** | 1415 | /** |
1319 | * @brief Sets the functions to be used before and after the swap callback. | 1416 | * @brief Sets the functions to be used before and after the swap callback. |
1320 | * @note If ecore is not compiled with support for x11 then nothing is done and the function is returned. | 1417 | * |
1321 | * @param ee The Ecore_Evas for which to set the swap callback. | 1418 | * @param ee The Ecore_Evas for which to set the swap callback. |
1322 | * @param data The data for which to set the swap callback. | 1419 | * @param data The data for which to set the swap callback. |
1323 | * @param pre_cb The function to be called before the callback. | 1420 | * @param pre_cb The function to be called before the callback. |
1324 | * @param post_cb The function to be called after the callback. | 1421 | * @param post_cb The function to be called after the callback. |
1422 | * | ||
1423 | * @note If ecore is not compiled with support for x11 then nothing is done and the function is returned. | ||
1325 | */ | 1424 | */ |
1326 | EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e)); | 1425 | EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e)); |
1327 | 1426 | ||
@@ -1374,6 +1473,7 @@ EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Eva | |||
1374 | 1473 | ||
1375 | /** | 1474 | /** |
1376 | * @brief Creates Ecore_Evas using fb backend. | 1475 | * @brief Creates Ecore_Evas using fb backend. |
1476 | * | ||
1377 | * @param disp_name The name of the display to be used. | 1477 | * @param disp_name The name of the display to be used. |
1378 | * @param rotation The rotation to be used. | 1478 | * @param rotation The rotation to be used. |
1379 | * @param w The width of the Ecore_Evas to be created. | 1479 | * @param w The width of the Ecore_Evas to be created. |
@@ -1523,13 +1623,14 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); | |||
1523 | /** | 1623 | /** |
1524 | * @brief Returns the backing store image object that represents the given | 1624 | * @brief Returns the backing store image object that represents the given |
1525 | * window in EWS. | 1625 | * window in EWS. |
1626 | * | ||
1627 | * @param ee The Ecore_Evas from which to get the backing store. | ||
1526 | * @return The evas object of EWS backing store. | 1628 | * @return The evas object of EWS backing store. |
1527 | * | 1629 | * |
1528 | * @note This should not be modified anyhow, but may be helpful to | 1630 | * @note This should not be modified anyhow, but may be helpful to |
1529 | * determine stacking and geometry of it for window managers | 1631 | * determine stacking and geometry of it for window managers |
1530 | * that decorate windows. | 1632 | * that decorate windows. |
1531 | * | 1633 | * |
1532 | * @param ee The Ecore_Evas from which to get the backing store. | ||
1533 | * @see ecore_evas_ews_manager_set() | 1634 | * @see ecore_evas_ews_manager_set() |
1534 | * @see ecore_evas_ews_evas_get() | 1635 | * @see ecore_evas_ews_evas_get() |
1535 | * @since 1.1 | 1636 | * @since 1.1 |
@@ -1541,6 +1642,7 @@ EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); | |||
1541 | * forbid it by using ecore_evas_callback_delete_request_set(). | 1642 | * forbid it by using ecore_evas_callback_delete_request_set(). |
1542 | * | 1643 | * |
1543 | * @param ee The Ecore_Evas for which window will be deleted. | 1644 | * @param ee The Ecore_Evas for which window will be deleted. |
1645 | * | ||
1544 | * @since 1.1 | 1646 | * @since 1.1 |
1545 | */ | 1647 | */ |
1546 | EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); | 1648 | EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); |
@@ -1679,10 +1781,10 @@ EAPI Ecore_Evas *ecore_evas_software_wince_gdi_new(Ecore_WinCE_Window *paren | |||
1679 | EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; | 1781 | EAPI Ecore_WinCE_Window *ecore_evas_software_wince_window_get(const Ecore_Evas *ee) EINA_DEPRECATED; |
1680 | 1782 | ||
1681 | EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent, | 1783 | EAPI Ecore_Evas *ecore_evas_cocoa_new(Ecore_Cocoa_Window *parent, |
1682 | int x, | 1784 | int x, |
1683 | int y, | 1785 | int y, |
1684 | int w, | 1786 | int w, |
1685 | int h); | 1787 | int h); |
1686 | 1788 | ||
1687 | EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h); | 1789 | EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h); |
1688 | 1790 | ||
@@ -1697,6 +1799,7 @@ EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h); | |||
1697 | * @see ecore_evas_free() | 1799 | * @see ecore_evas_free() |
1698 | */ | 1800 | */ |
1699 | EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee); | 1801 | EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee); |
1802 | |||
1700 | /** | 1803 | /** |
1701 | * @brief Returns the Ecore_Evas for this Evas. | 1804 | * @brief Returns the Ecore_Evas for this Evas. |
1702 | * | 1805 | * |
@@ -1706,6 +1809,7 @@ EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee); | |||
1706 | * @warning Only use on Evas' created with ecore evas! | 1809 | * @warning Only use on Evas' created with ecore evas! |
1707 | */ | 1810 | */ |
1708 | EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); | 1811 | EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); |
1812 | |||
1709 | /** | 1813 | /** |
1710 | * @brief Frees an Ecore_Evas. | 1814 | * @brief Frees an Ecore_Evas. |
1711 | * | 1815 | * |
@@ -1714,21 +1818,22 @@ EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); | |||
1714 | * This frees up any memory used by the Ecore_Evas. | 1818 | * This frees up any memory used by the Ecore_Evas. |
1715 | */ | 1819 | */ |
1716 | EAPI void ecore_evas_free(Ecore_Evas *ee); | 1820 | EAPI void ecore_evas_free(Ecore_Evas *ee); |
1821 | |||
1717 | /** | 1822 | /** |
1718 | * @brief Retrieves user data associated with an Ecore_Evas. | 1823 | * @brief Retrieves user data associated with an Ecore_Evas. |
1719 | * | 1824 | * |
1720 | * @param ee The Ecore_Evas to retrieve the user data from. | 1825 | * @param ee The Ecore_Evas to retrieve the user data from. |
1721 | * @param key The key which the user data to be retrieved is associated with. | 1826 | * @param key The key which the user data to be retrieved is associated with. |
1827 | * @return @c NULL on error or no data found, A pointer to the user data on | ||
1828 | * success. | ||
1722 | * | 1829 | * |
1723 | * This function retrieves user specific data that has been stored within an | 1830 | * This function retrieves user specific data that has been stored within an |
1724 | * Ecore_Evas structure with ecore_evas_data_set(). | 1831 | * Ecore_Evas structure with ecore_evas_data_set(). |
1725 | * | 1832 | * |
1726 | * @return @c NULL on error or no data found, A pointer to the user data on | ||
1727 | * success. | ||
1728 | * | ||
1729 | * @see ecore_evas_data_set() | 1833 | * @see ecore_evas_data_set() |
1730 | */ | 1834 | */ |
1731 | EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); | 1835 | EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); |
1836 | |||
1732 | /** | 1837 | /** |
1733 | * @brief Stores user data in an Ecore_Evas structure. | 1838 | * @brief Stores user data in an Ecore_Evas structure. |
1734 | * | 1839 | * |
@@ -1747,11 +1852,13 @@ EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); | |||
1747 | * @see ecore_evas_data_get() | 1852 | * @see ecore_evas_data_get() |
1748 | */ | 1853 | */ |
1749 | EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data); | 1854 | EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data); |
1855 | |||
1750 | /** | 1856 | /** |
1751 | * @brief Sets a callback for Ecore_Evas resize events. | 1857 | * @brief Sets a callback for Ecore_Evas resize events. |
1858 | * | ||
1752 | * @param ee The Ecore_Evas to set callbacks on | 1859 | * @param ee The Ecore_Evas to set callbacks on |
1753 | * @param func The function to call | 1860 | * @param func The function to call |
1754 | 1861 | * | |
1755 | * A call to this function will set a callback on an Ecore_Evas, causing | 1862 | * A call to this function will set a callback on an Ecore_Evas, causing |
1756 | * @p func to be called whenever @p ee is resized. | 1863 | * @p func to be called whenever @p ee is resized. |
1757 | * | 1864 | * |
@@ -1759,11 +1866,13 @@ EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void | |||
1759 | * windowing system. | 1866 | * windowing system. |
1760 | */ | 1867 | */ |
1761 | EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1868 | EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1869 | |||
1762 | /** | 1870 | /** |
1763 | * @brief Sets a callback for Ecore_Evas move events. | 1871 | * @brief Sets a callback for Ecore_Evas move events. |
1872 | * | ||
1764 | * @param ee The Ecore_Evas to set callbacks on | 1873 | * @param ee The Ecore_Evas to set callbacks on |
1765 | * @param func The function to call | 1874 | * @param func The function to call |
1766 | 1875 | * | |
1767 | * A call to this function will set a callback on an Ecore_Evas, causing | 1876 | * A call to this function will set a callback on an Ecore_Evas, causing |
1768 | * @p func to be called whenever @p ee is moved. | 1877 | * @p func to be called whenever @p ee is moved. |
1769 | * | 1878 | * |
@@ -1771,11 +1880,13 @@ EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event | |||
1771 | * windowing system. | 1880 | * windowing system. |
1772 | */ | 1881 | */ |
1773 | EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1882 | EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1883 | |||
1774 | /** | 1884 | /** |
1775 | * @brief Sets a callback for Ecore_Evas show events. | 1885 | * @brief Sets a callback for Ecore_Evas show events. |
1886 | * | ||
1776 | * @param ee The Ecore_Evas to set callbacks on | 1887 | * @param ee The Ecore_Evas to set callbacks on |
1777 | * @param func The function to call | 1888 | * @param func The function to call |
1778 | 1889 | * | |
1779 | * A call to this function will set a callback on an Ecore_Evas, causing | 1890 | * A call to this function will set a callback on an Ecore_Evas, causing |
1780 | * @p func to be called whenever @p ee is shown. | 1891 | * @p func to be called whenever @p ee is shown. |
1781 | * | 1892 | * |
@@ -1783,11 +1894,13 @@ EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_C | |||
1783 | * windowing system. | 1894 | * windowing system. |
1784 | */ | 1895 | */ |
1785 | EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1896 | EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1897 | |||
1786 | /** | 1898 | /** |
1787 | * @brief Sets a callback for Ecore_Evas hide events. | 1899 | * @brief Sets a callback for Ecore_Evas hide events. |
1900 | * | ||
1788 | * @param ee The Ecore_Evas to set callbacks on | 1901 | * @param ee The Ecore_Evas to set callbacks on |
1789 | * @param func The function to call | 1902 | * @param func The function to call |
1790 | 1903 | * | |
1791 | * A call to this function will set a callback on an Ecore_Evas, causing | 1904 | * A call to this function will set a callback on an Ecore_Evas, causing |
1792 | * @p func to be called whenever @p ee is hidden. | 1905 | * @p func to be called whenever @p ee is hidden. |
1793 | * | 1906 | * |
@@ -1795,11 +1908,13 @@ EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_C | |||
1795 | * windowing system. | 1908 | * windowing system. |
1796 | */ | 1909 | */ |
1797 | EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1910 | EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1911 | |||
1798 | /** | 1912 | /** |
1799 | * @brief Sets a callback for Ecore_Evas delete request events. | 1913 | * @brief Sets a callback for Ecore_Evas delete request events. |
1914 | * | ||
1800 | * @param ee The Ecore_Evas to set callbacks on | 1915 | * @param ee The Ecore_Evas to set callbacks on |
1801 | * @param func The function to call | 1916 | * @param func The function to call |
1802 | 1917 | * | |
1803 | * A call to this function will set a callback on an Ecore_Evas, causing | 1918 | * A call to this function will set a callback on an Ecore_Evas, causing |
1804 | * @p func to be called whenever @p ee gets a delete request. | 1919 | * @p func to be called whenever @p ee gets a delete request. |
1805 | * | 1920 | * |
@@ -1807,11 +1922,13 @@ EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_C | |||
1807 | * windowing system. | 1922 | * windowing system. |
1808 | */ | 1923 | */ |
1809 | EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1924 | EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1925 | |||
1810 | /** | 1926 | /** |
1811 | * @brief Sets a callback for Ecore_Evas destroy events. | 1927 | * @brief Sets a callback for Ecore_Evas destroy events. |
1928 | * | ||
1812 | * @param ee The Ecore_Evas to set callbacks on | 1929 | * @param ee The Ecore_Evas to set callbacks on |
1813 | * @param func The function to call | 1930 | * @param func The function to call |
1814 | 1931 | * | |
1815 | * A call to this function will set a callback on an Ecore_Evas, causing | 1932 | * A call to this function will set a callback on an Ecore_Evas, causing |
1816 | * @p func to be called whenever @p ee is destroyed. | 1933 | * @p func to be called whenever @p ee is destroyed. |
1817 | * | 1934 | * |
@@ -1819,6 +1936,7 @@ EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Ev | |||
1819 | * windowing system. | 1936 | * windowing system. |
1820 | */ | 1937 | */ |
1821 | EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1938 | EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1939 | |||
1822 | /** | 1940 | /** |
1823 | * @brief Sets a callback for Ecore_Evas focus in events. | 1941 | * @brief Sets a callback for Ecore_Evas focus in events. |
1824 | * @param ee The Ecore_Evas to set callbacks on | 1942 | * @param ee The Ecore_Evas to set callbacks on |
@@ -1830,56 +1948,68 @@ EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Even | |||
1830 | * @warning If and when this function is called depends on the underlying | 1948 | * @warning If and when this function is called depends on the underlying |
1831 | * windowing system. | 1949 | * windowing system. |
1832 | * @note This function only reports focus in events for the default seat! | 1950 | * @note This function only reports focus in events for the default seat! |
1951 | * | ||
1833 | * @see ecore_evas_callback_focus_device_in_set() | 1952 | * @see ecore_evas_callback_focus_device_in_set() |
1834 | */ | 1953 | */ |
1835 | EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1954 | EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1955 | |||
1836 | /** | 1956 | /** |
1837 | * @brief Sets a callback for Ecore_Evas focus out events. | 1957 | * @brief Sets a callback for Ecore_Evas focus out events. |
1958 | * | ||
1838 | * @param ee The Ecore_Evas to set callbacks on | 1959 | * @param ee The Ecore_Evas to set callbacks on |
1839 | * @param func The function to call | 1960 | * @param func The function to call |
1840 | 1961 | * | |
1841 | * A call to this function will set a callback on an Ecore_Evas, causing | 1962 | * A call to this function will set a callback on an Ecore_Evas, causing |
1842 | * @p func to be called whenever @p ee loses focus. | 1963 | * @p func to be called whenever @p ee loses focus. |
1843 | * | 1964 | * |
1844 | * @warning If and when this function is called depends on the underlying | 1965 | * @warning If and when this function is called depends on the underlying |
1845 | * windowing system. | 1966 | * windowing system. |
1846 | * @note This function only reports focus in events for the default seat! | 1967 | * @note This function only reports focus in events for the default seat! |
1968 | * | ||
1847 | * @see ecore_evas_callback_focus_device_out_set() | 1969 | * @see ecore_evas_callback_focus_device_out_set() |
1848 | */ | 1970 | */ |
1849 | EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 1971 | EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
1972 | |||
1850 | /** | 1973 | /** |
1851 | * @brief Sets a callback for Ecore_Evas focus in events. | 1974 | * @brief Sets a callback for Ecore_Evas focus in events. |
1975 | * | ||
1852 | * @param ee The Ecore_Evas to set callbacks on | 1976 | * @param ee The Ecore_Evas to set callbacks on |
1853 | * @param func The function to call | 1977 | * @param func The function to call |
1854 | 1978 | * | |
1855 | * A call to this function will set a callback on an Ecore_Evas, causing | 1979 | * A call to this function will set a callback on an Ecore_Evas, causing |
1856 | * @p func to be called whenever @p ee gets focus. | 1980 | * @p func to be called whenever @p ee gets focus. |
1857 | * | 1981 | * |
1858 | * @warning If and when this function is called depends on the underlying | 1982 | * @warning If and when this function is called depends on the underlying |
1859 | * windowing system. | 1983 | * windowing system. |
1984 | * | ||
1860 | * @see ecore_evas_callback_focus_device_out_set() | 1985 | * @see ecore_evas_callback_focus_device_out_set() |
1861 | * @since 1.19 | 1986 | * @since 1.19 |
1862 | */ | 1987 | */ |
1863 | EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); | 1988 | EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); |
1989 | |||
1864 | /** | 1990 | /** |
1865 | * @brief Sets a callback for Ecore_Evas focus out events. | 1991 | * @brief Sets a callback for Ecore_Evas focus out events. |
1992 | * | ||
1866 | * @param ee The Ecore_Evas to set callbacks on | 1993 | * @param ee The Ecore_Evas to set callbacks on |
1867 | * @param func The function to call | 1994 | * @param func The function to call |
1868 | 1995 | * | |
1869 | * A call to this function will set a callback on an Ecore_Evas, causing | 1996 | * A call to this function will set a callback on an Ecore_Evas, causing |
1870 | * @p func to be called whenever @p ee loses focus. | 1997 | * @p func to be called whenever @p ee loses focus. |
1871 | * | 1998 | * |
1872 | * @warning If and when this function is called depends on the underlying | 1999 | * @warning If and when this function is called depends on the underlying |
1873 | * windowing system. | 2000 | * windowing system. |
2001 | * | ||
1874 | * @see ecore_evas_callback_focus_device_in_set() | 2002 | * @see ecore_evas_callback_focus_device_in_set() |
1875 | * @since 1.19 | 2003 | * @since 1.19 |
1876 | */ | 2004 | */ |
1877 | EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); | 2005 | EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); |
2006 | |||
1878 | /** | 2007 | /** |
1879 | * @brief Sets a callback for Ecore_Evas sticky events. | 2008 | * @brief Sets a callback for Ecore_Evas sticky events. |
2009 | * | ||
1880 | * @param ee The Ecore_Evas to set callbacks on | 2010 | * @param ee The Ecore_Evas to set callbacks on |
1881 | * @param func The function to call | 2011 | * @param func The function to call |
1882 | 2012 | * | |
1883 | * A call to this function will set a callback on an Ecore_Evas, causing | 2013 | * A call to this function will set a callback on an Ecore_Evas, causing |
1884 | * @p func to be called whenever @p ee becomes sticky. | 2014 | * @p func to be called whenever @p ee becomes sticky. |
1885 | * | 2015 | * |
@@ -1887,8 +2017,10 @@ EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_ | |||
1887 | * windowing system. | 2017 | * windowing system. |
1888 | */ | 2018 | */ |
1889 | EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2019 | EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2020 | |||
1890 | /** | 2021 | /** |
1891 | * @brief Sets a callback for Ecore_Evas un-sticky events. | 2022 | * @brief Sets a callback for Ecore_Evas un-sticky events. |
2023 | * | ||
1892 | * @param ee The Ecore_Evas to set callbacks on | 2024 | * @param ee The Ecore_Evas to set callbacks on |
1893 | * @param func The function to call | 2025 | * @param func The function to call |
1894 | 2026 | ||
@@ -1899,65 +2031,79 @@ EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event | |||
1899 | * windowing system. | 2031 | * windowing system. |
1900 | */ | 2032 | */ |
1901 | EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2033 | EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2034 | |||
1902 | /** | 2035 | /** |
1903 | * @brief Sets a callback for Ecore_Evas mouse in events. | 2036 | * @brief Sets a callback for Ecore_Evas mouse in events. |
2037 | * | ||
1904 | * @param ee The Ecore_Evas to set callbacks on | 2038 | * @param ee The Ecore_Evas to set callbacks on |
1905 | * @param func The function to call | 2039 | * @param func The function to call |
1906 | 2040 | * | |
1907 | * A call to this function will set a callback on an Ecore_Evas, causing | 2041 | * A call to this function will set a callback on an Ecore_Evas, causing |
1908 | * @p func to be called whenever the mouse enters @p ee. | 2042 | * @p func to be called whenever the mouse enters @p ee. |
1909 | * | 2043 | * |
1910 | * @warning If and when this function is called depends on the underlying | 2044 | * @warning If and when this function is called depends on the underlying |
1911 | * windowing system. | 2045 | * windowing system. |
2046 | * | ||
1912 | * @since 1.19 | 2047 | * @since 1.19 |
1913 | */ | 2048 | */ |
1914 | EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); | 2049 | EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); |
2050 | |||
1915 | /** | 2051 | /** |
1916 | * @brief Sets a callback for Ecore_Evas mouse out events. | 2052 | * @brief Sets a callback for Ecore_Evas mouse out events. |
2053 | * | ||
1917 | * @param ee The Ecore_Evas to set callbacks on | 2054 | * @param ee The Ecore_Evas to set callbacks on |
1918 | * @param func The function to call | 2055 | * @param func The function to call |
1919 | 2056 | * | |
1920 | * A call to this function will set a callback on an Ecore_Evas, causing | 2057 | * A call to this function will set a callback on an Ecore_Evas, causing |
1921 | * @p func to be called whenever the mouse leaves @p ee. | 2058 | * @p func to be called whenever the mouse leaves @p ee. |
1922 | * | 2059 | * |
1923 | * @warning If and when this function is called depends on the underlying | 2060 | * @warning If and when this function is called depends on the underlying |
1924 | * windowing system. | 2061 | * windowing system. |
2062 | * | ||
1925 | * @since 1.19 | 2063 | * @since 1.19 |
1926 | */ | 2064 | */ |
1927 | EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); | 2065 | EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); |
2066 | |||
1928 | /** | 2067 | /** |
1929 | * @brief Sets a callback for Ecore_Evas mouse in events. | 2068 | * @brief Sets a callback for Ecore_Evas mouse in events. |
2069 | * | ||
1930 | * @param ee The Ecore_Evas to set callbacks on | 2070 | * @param ee The Ecore_Evas to set callbacks on |
1931 | * @param func The function to call | 2071 | * @param func The function to call |
1932 | 2072 | * | |
1933 | * A call to this function will set a callback on an Ecore_Evas, causing | 2073 | * A call to this function will set a callback on an Ecore_Evas, causing |
1934 | * @p func to be called whenever the mouse enters @p ee. | 2074 | * @p func to be called whenever the mouse enters @p ee. |
1935 | * | 2075 | * |
1936 | * @note the @p func will only report events for the default mouse. | 2076 | * @note the @p func will only report events for the default mouse. |
1937 | * @warning If and when this function is called depends on the underlying | 2077 | * @warning If and when this function is called depends on the underlying |
1938 | * windowing system. | 2078 | * windowing system. |
2079 | * | ||
1939 | * @see ecore_evas_callback_device_mouse_in_set | 2080 | * @see ecore_evas_callback_device_mouse_in_set |
1940 | */ | 2081 | */ |
1941 | EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2082 | EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2083 | |||
1942 | /** | 2084 | /** |
1943 | * @brief Sets a callback for Ecore_Evas mouse out events. | 2085 | * @brief Sets a callback for Ecore_Evas mouse out events. |
2086 | * | ||
1944 | * @param ee The Ecore_Evas to set callbacks on | 2087 | * @param ee The Ecore_Evas to set callbacks on |
1945 | * @param func The function to call | 2088 | * @param func The function to call |
1946 | 2089 | * | |
1947 | * A call to this function will set a callback on an Ecore_Evas, causing | 2090 | * A call to this function will set a callback on an Ecore_Evas, causing |
1948 | * @p func to be called whenever the mouse leaves @p ee. | 2091 | * @p func to be called whenever the mouse leaves @p ee. |
1949 | * | 2092 | * |
1950 | * @note the @p func will only report events for the default mouse. | 2093 | * @note the @p func will only report events for the default mouse. |
1951 | * @warning If and when this function is called depends on the underlying | 2094 | * @warning If and when this function is called depends on the underlying |
1952 | * windowing system. | 2095 | * windowing system. |
2096 | * | ||
1953 | * @see ecore_evas_callback_device_mouse_out_set | 2097 | * @see ecore_evas_callback_device_mouse_out_set |
1954 | */ | 2098 | */ |
1955 | EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2099 | EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2100 | |||
1956 | /** | 2101 | /** |
1957 | * @brief Sets a callback for Ecore_Evas pre-render events. | 2102 | * @brief Sets a callback for Ecore_Evas pre-render events. |
2103 | * | ||
1958 | * @param ee The Ecore_Evas to set callbacks on | 2104 | * @param ee The Ecore_Evas to set callbacks on |
1959 | * @param func The function to call | 2105 | * @param func The function to call |
1960 | 2106 | * | |
1961 | * A call to this function will set a callback on an Ecore_Evas, causing | 2107 | * A call to this function will set a callback on an Ecore_Evas, causing |
1962 | * @p func to be called just before the evas in @p ee is rendered. | 2108 | * @p func to be called just before the evas in @p ee is rendered. |
1963 | * | 2109 | * |
@@ -1965,11 +2111,13 @@ EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Ev | |||
1965 | * windowing system. | 2111 | * windowing system. |
1966 | */ | 2112 | */ |
1967 | EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2113 | EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2114 | |||
1968 | /** | 2115 | /** |
1969 | * @brief Sets a callback for Ecore_Evas mouse post-render events. | 2116 | * @brief Sets a callback for Ecore_Evas mouse post-render events. |
2117 | * | ||
1970 | * @param ee The Ecore_Evas to set callbacks on | 2118 | * @param ee The Ecore_Evas to set callbacks on |
1971 | * @param func The function to call | 2119 | * @param func The function to call |
1972 | 2120 | * | |
1973 | * A call to this function will set a callback on an Ecore_Evas, causing | 2121 | * A call to this function will set a callback on an Ecore_Evas, causing |
1974 | * @p func to be called just after the evas in @p ee is rendered. | 2122 | * @p func to be called just after the evas in @p ee is rendered. |
1975 | * | 2123 | * |
@@ -1977,8 +2125,10 @@ EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_E | |||
1977 | * windowing system. | 2125 | * windowing system. |
1978 | */ | 2126 | */ |
1979 | EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2127 | EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2128 | |||
1980 | /** | 2129 | /** |
1981 | * @brief Sets a callback for Ecore_Evas pre-free event. | 2130 | * @brief Sets a callback for Ecore_Evas pre-free event. |
2131 | * | ||
1982 | * @param ee The Ecore_Evas to set callbacks on | 2132 | * @param ee The Ecore_Evas to set callbacks on |
1983 | * @param func The function to call | 2133 | * @param func The function to call |
1984 | * | 2134 | * |
@@ -1989,22 +2139,26 @@ EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_ | |||
1989 | * windowing system. | 2139 | * windowing system. |
1990 | */ | 2140 | */ |
1991 | EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2141 | EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2142 | |||
1992 | /** | 2143 | /** |
1993 | * @brief Sets a callback for Ecore_Evas state changes. | 2144 | * @brief Sets a callback for Ecore_Evas state changes. |
2145 | * | ||
1994 | * @param ee The Ecore_Evas to set callbacks on | 2146 | * @param ee The Ecore_Evas to set callbacks on |
1995 | * @param func The function to call | 2147 | * @param func The function to call |
1996 | 2148 | * | |
1997 | * A call to this function will set a callback on an Ecore_Evas, causing | 2149 | * A call to this function will set a callback on an Ecore_Evas, causing |
1998 | * @p func to be called whenever @p ee changes state. | 2150 | * @p func to be called whenever @p ee changes state. |
1999 | * | 2151 | * |
2000 | * @since 1.2 | ||
2001 | * @warning If and when this function is called depends on the underlying | 2152 | * @warning If and when this function is called depends on the underlying |
2002 | * windowing system. | 2153 | * windowing system. |
2154 | * | ||
2155 | * @since 1.2 | ||
2003 | */ | 2156 | */ |
2004 | EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); | 2157 | EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); |
2005 | 2158 | ||
2006 | /** | 2159 | /** |
2007 | * @brief Gets an Ecore_Evas's Evas. | 2160 | * @brief Gets an Ecore_Evas's Evas. |
2161 | * | ||
2008 | * @param ee The Ecore_Evas whose Evas you wish to get | 2162 | * @param ee The Ecore_Evas whose Evas you wish to get |
2009 | * @return The Evas wrapped by @p ee | 2163 | * @return The Evas wrapped by @p ee |
2010 | * | 2164 | * |
@@ -2014,6 +2168,7 @@ EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); | |||
2014 | 2168 | ||
2015 | /** | 2169 | /** |
2016 | * @brief Provides Managed move co-ordinates for an Ecore_Evas. | 2170 | * @brief Provides Managed move co-ordinates for an Ecore_Evas. |
2171 | * | ||
2017 | * @param ee The Ecore_Evas to move | 2172 | * @param ee The Ecore_Evas to move |
2018 | * @param x The x coordinate to set as the managed location | 2173 | * @param x The x coordinate to set as the managed location |
2019 | * @param y The y coordinate to set as the managed location | 2174 | * @param y The y coordinate to set as the managed location |
@@ -2046,6 +2201,7 @@ EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped); | |||
2046 | * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not. | 2201 | * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not. |
2047 | */ | 2202 | */ |
2048 | EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); | 2203 | EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); |
2204 | |||
2049 | /** | 2205 | /** |
2050 | * @brief Shows an Ecore_Evas' window. | 2206 | * @brief Shows an Ecore_Evas' window. |
2051 | * | 2207 | * |
@@ -2054,6 +2210,7 @@ EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); | |||
2054 | * This function makes @p ee visible. | 2210 | * This function makes @p ee visible. |
2055 | */ | 2211 | */ |
2056 | EAPI void ecore_evas_show(Ecore_Evas *ee); | 2212 | EAPI void ecore_evas_show(Ecore_Evas *ee); |
2213 | |||
2057 | /** | 2214 | /** |
2058 | * @brief Hides an Ecore_Evas' window. | 2215 | * @brief Hides an Ecore_Evas' window. |
2059 | * | 2216 | * |
@@ -2065,6 +2222,7 @@ EAPI void ecore_evas_hide(Ecore_Evas *ee); | |||
2065 | 2222 | ||
2066 | /** | 2223 | /** |
2067 | * @brief Activates (set focus to, via the window manager) an Ecore_Evas' window. | 2224 | * @brief Activates (set focus to, via the window manager) an Ecore_Evas' window. |
2225 | * | ||
2068 | * @param ee The Ecore_Evas to activate. | 2226 | * @param ee The Ecore_Evas to activate. |
2069 | * | 2227 | * |
2070 | * This functions activates the Ecore_Evas. | 2228 | * This functions activates the Ecore_Evas. |
@@ -2213,6 +2371,7 @@ EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h); | |||
2213 | * @see ecore_evas_cursor_unset() | 2371 | * @see ecore_evas_cursor_unset() |
2214 | */ | 2372 | */ |
2215 | EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y); | 2373 | EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y); |
2374 | |||
2216 | /** | 2375 | /** |
2217 | * @brief Gets information about an Ecore_Evas' default pointer device. | 2376 | * @brief Gets information about an Ecore_Evas' default pointer device. |
2218 | * | 2377 | * |
@@ -2352,25 +2511,25 @@ EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Da | |||
2352 | 2511 | ||
2353 | /** | 2512 | /** |
2354 | * @brief Queries whether an Ecore_Evas' window avoids damage or not. | 2513 | * @brief Queries whether an Ecore_Evas' window avoids damage or not. |
2514 | * | ||
2355 | * @param ee The Ecore_Evas to set | 2515 | * @param ee The Ecore_Evas to set |
2356 | * @return The type of the damage management | 2516 | * @return The type of the damage management |
2357 | * | ||
2358 | */ | 2517 | */ |
2359 | EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee); | 2518 | EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee); |
2360 | 2519 | ||
2361 | /** | 2520 | /** |
2362 | * @brief Sets the withdrawn state of an Ecore_Evas' window. | 2521 | * @brief Sets the withdrawn state of an Ecore_Evas' window. |
2522 | * | ||
2363 | * @param ee The Ecore_Evas whose window's withdrawn state is set. | 2523 | * @param ee The Ecore_Evas whose window's withdrawn state is set. |
2364 | * @param withdrawn The Ecore_Evas window's new withdrawn state. | 2524 | * @param withdrawn The Ecore_Evas window's new withdrawn state. |
2365 | * | ||
2366 | */ | 2525 | */ |
2367 | EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); | 2526 | EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); |
2368 | 2527 | ||
2369 | /** | 2528 | /** |
2370 | * @brief Returns the withdrawn state of an Ecore_Evas' window. | 2529 | * @brief Returns the withdrawn state of an Ecore_Evas' window. |
2530 | * | ||
2371 | * @param ee The Ecore_Evas whose window's withdrawn state is returned. | 2531 | * @param ee The Ecore_Evas whose window's withdrawn state is returned. |
2372 | * @return The Ecore_Evas window's withdrawn state. | 2532 | * @return The Ecore_Evas window's withdrawn state. |
2373 | * | ||
2374 | */ | 2533 | */ |
2375 | EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); | 2534 | EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); |
2376 | 2535 | ||
@@ -2379,7 +2538,6 @@ EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); | |||
2379 | * | 2538 | * |
2380 | * @param ee The Ecore_Evas whose window's sticky state is set. | 2539 | * @param ee The Ecore_Evas whose window's sticky state is set. |
2381 | * @param sticky The Ecore_Evas window's new sticky state. | 2540 | * @param sticky The Ecore_Evas window's new sticky state. |
2382 | * | ||
2383 | */ | 2541 | */ |
2384 | EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); | 2542 | EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); |
2385 | 2543 | ||
@@ -2388,7 +2546,6 @@ EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); | |||
2388 | * | 2546 | * |
2389 | * @param ee The Ecore_Evas whose window's sticky state is returned. | 2547 | * @param ee The Ecore_Evas whose window's sticky state is returned. |
2390 | * @return The Ecore_Evas window's sticky state. | 2548 | * @return The Ecore_Evas window's sticky state. |
2391 | * | ||
2392 | */ | 2549 | */ |
2393 | EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee); | 2550 | EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee); |
2394 | 2551 | ||
@@ -2436,6 +2593,7 @@ EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee); | |||
2436 | * @since 1.1 | 2593 | * @since 1.1 |
2437 | */ | 2594 | */ |
2438 | EAPI void ecore_evas_input_event_register(Ecore_Evas *ee); | 2595 | EAPI void ecore_evas_input_event_register(Ecore_Evas *ee); |
2596 | |||
2439 | /** | 2597 | /** |
2440 | * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas. | 2598 | * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas. |
2441 | * | 2599 | * |
@@ -2459,6 +2617,9 @@ EAPI void ecore_evas_manual_render(Ecore_Evas *ee); | |||
2459 | /** | 2617 | /** |
2460 | * @brief Sets comp syncing to enabled/disabled | 2618 | * @brief Sets comp syncing to enabled/disabled |
2461 | * | 2619 | * |
2620 | * @param ee An @c Ecore_Evas handle | ||
2621 | * @param do_sync True to enable comp syncing, False to disable | ||
2622 | * | ||
2462 | * Turns on client+server synchronized rendering in X11. Comp sync is | 2623 | * Turns on client+server synchronized rendering in X11. Comp sync is |
2463 | * disabled by default, but can be turned on optionally. Can also be | 2624 | * disabled by default, but can be turned on optionally. Can also be |
2464 | * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC | 2625 | * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC |
@@ -2466,21 +2627,17 @@ EAPI void ecore_evas_manual_render(Ecore_Evas *ee); | |||
2466 | * | 2627 | * |
2467 | * @note This is an experimental functionality and is likely to be | 2628 | * @note This is an experimental functionality and is likely to be |
2468 | * removed in future versions of EFL. | 2629 | * removed in future versions of EFL. |
2469 | * | ||
2470 | * @param ee An @c Ecore_Evas handle | ||
2471 | * @param do_sync True to enable comp syncing, False to disable | ||
2472 | */ | 2630 | */ |
2473 | EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); | 2631 | EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); |
2474 | 2632 | ||
2475 | /** | 2633 | /** |
2476 | * @brief Gets the comp sync state | 2634 | * @brief Gets the comp sync state |
2477 | * | 2635 | * |
2478 | * @note This is an experimental functionality and is likely to be | ||
2479 | * removed in future versions of EFL. | ||
2480 | * | ||
2481 | * @param ee An @c Ecore_Evas handle | 2636 | * @param ee An @c Ecore_Evas handle |
2482 | * | ||
2483 | * @return True if composition synchronization is enabled, False otherwise | 2637 | * @return True if composition synchronization is enabled, False otherwise |
2638 | * | ||
2639 | * @note This is an experimental functionality and is likely to be | ||
2640 | * removed in future versions of EFL. | ||
2484 | */ | 2641 | */ |
2485 | EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); | 2642 | EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); |
2486 | 2643 | ||
@@ -2573,6 +2730,7 @@ EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, in | |||
2573 | * etc. | 2730 | * etc. |
2574 | */ | 2731 | */ |
2575 | EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags); | 2732 | EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags); |
2733 | |||
2576 | /** | 2734 | /** |
2577 | * @brief Cancels the association set with ecore_evas_object_associate(). | 2735 | * @brief Cancels the association set with ecore_evas_object_associate(). |
2578 | * | 2736 | * |
@@ -2581,6 +2739,7 @@ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, | |||
2581 | * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. | 2739 | * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. |
2582 | */ | 2740 | */ |
2583 | EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); | 2741 | EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); |
2742 | |||
2584 | /** | 2743 | /** |
2585 | * @brief Gets the object associated with @p ee. | 2744 | * @brief Gets the object associated with @p ee. |
2586 | * | 2745 | * |
@@ -2602,6 +2761,7 @@ EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Get | |||
2602 | * just deleting the list. | 2761 | * just deleting the list. |
2603 | */ | 2762 | */ |
2604 | EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); | 2763 | EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); |
2764 | |||
2605 | /** | 2765 | /** |
2606 | * @brief Gets a list of all the sub ecore_evases. | 2766 | * @brief Gets a list of all the sub ecore_evases. |
2607 | * | 2767 | * |
@@ -2625,10 +2785,12 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee); | |||
2625 | 2785 | ||
2626 | /** | 2786 | /** |
2627 | * @brief A callback used to accept a new client. | 2787 | * @brief A callback used to accept a new client. |
2788 | * | ||
2628 | * @param data The callback data | 2789 | * @param data The callback data |
2629 | * @param ee The Ecore_Evas | 2790 | * @param ee The Ecore_Evas |
2630 | * @param client_host The address of the new client. | 2791 | * @param client_host The address of the new client. |
2631 | * @return @c EINA_TRUE to accept the client, @c EINA_FALSE otherwise. | 2792 | * @return @c EINA_TRUE to accept the client, @c EINA_FALSE otherwise. |
2793 | * | ||
2632 | * @see ecore_evas_vnc_start() | 2794 | * @see ecore_evas_vnc_start() |
2633 | * @since 1.19 | 2795 | * @since 1.19 |
2634 | */ | 2796 | */ |
@@ -2636,9 +2798,11 @@ typedef Eina_Bool (*Ecore_Evas_Vnc_Client_Accept_Cb)(void *data, Ecore_Evas *ee, | |||
2636 | 2798 | ||
2637 | /** | 2799 | /** |
2638 | * @brief A callback used to inform that a client has disconnected. | 2800 | * @brief A callback used to inform that a client has disconnected. |
2801 | * | ||
2639 | * @param data The callback data | 2802 | * @param data The callback data |
2640 | * @param ee The Ecore_Evas | 2803 | * @param ee The Ecore_Evas |
2641 | * @param client_host The address of the client | 2804 | * @param client_host The address of the client |
2805 | * | ||
2642 | * @see ecore_evas_vnc_start() | 2806 | * @see ecore_evas_vnc_start() |
2643 | * @since 1.19 | 2807 | * @since 1.19 |
2644 | */ | 2808 | */ |
@@ -2654,6 +2818,7 @@ typedef void (*Ecore_Evas_Vnc_Client_Disconnected_Cb)(void *data, Ecore_Evas *ee | |||
2654 | * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL. | 2818 | * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL. |
2655 | * @param data Data to pass to @a accept_cb and @disc_cb | 2819 | * @param data Data to pass to @a accept_cb and @disc_cb |
2656 | * @return an Evas_Object that take everything under it to represent the view of the client. | 2820 | * @return an Evas_Object that take everything under it to represent the view of the client. |
2821 | * | ||
2657 | * @see ecore_evas_vnc_stop() | 2822 | * @see ecore_evas_vnc_stop() |
2658 | * @see Ecore_Evas_Vnc_Client_Accept_Cb() | 2823 | * @see Ecore_Evas_Vnc_Client_Accept_Cb() |
2659 | * @since 1.19 | 2824 | * @since 1.19 |
@@ -2682,6 +2847,7 @@ EAPI Evas_Object *ecore_evas_vnc_start(Ecore_Evas *ee, const char *addr, int por | |||
2682 | * @param engine The engine to be set. | 2847 | * @param engine The engine to be set. |
2683 | * @param options The options of the engine to be set. | 2848 | * @param options The options of the engine to be set. |
2684 | * @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use. | 2849 | * @return @c EINA_TRUE on success, @c EINA_FALSE if ews is already in use. |
2850 | * | ||
2685 | * @since 1.1 | 2851 | * @since 1.1 |
2686 | */ | 2852 | */ |
2687 | EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); | 2853 | EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); |
@@ -2694,6 +2860,7 @@ EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options | |||
2694 | * @param w The width of the Ecore_Evas to setup. | 2860 | * @param w The width of the Ecore_Evas to setup. |
2695 | * @param h The height of the Ecore_Evas to setup. | 2861 | * @param h The height of the Ecore_Evas to setup. |
2696 | * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. | 2862 | * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. |
2863 | * | ||
2697 | * @since 1.1 | 2864 | * @since 1.1 |
2698 | */ | 2865 | */ |
2699 | EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); | 2866 | EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); |
@@ -2702,6 +2869,7 @@ EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); | |||
2702 | * @brief Returns the internal backing store in use. | 2869 | * @brief Returns the internal backing store in use. |
2703 | * | 2870 | * |
2704 | * @return The internal backing store in use. | 2871 | * @return The internal backing store in use. |
2872 | * | ||
2705 | * @note this will force it to be created, making future calls to | 2873 | * @note this will force it to be created, making future calls to |
2706 | * ecore_evas_ews_engine_set() void. | 2874 | * ecore_evas_ews_engine_set() void. |
2707 | * | 2875 | * |
@@ -2714,6 +2882,7 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); | |||
2714 | * @brief Returns the internal backing store in use. | 2882 | * @brief Returns the internal backing store in use. |
2715 | * | 2883 | * |
2716 | * @return The internal backing store in use. | 2884 | * @return The internal backing store in use. |
2885 | * | ||
2717 | * @note this will force it to be created, making future calls to | 2886 | * @note this will force it to be created, making future calls to |
2718 | * ecore_evas_ews_engine_set() void. | 2887 | * ecore_evas_ews_engine_set() void. |
2719 | * | 2888 | * |
@@ -2730,12 +2899,13 @@ EAPI Evas_Object *ecore_evas_ews_background_get(void); | |||
2730 | /** | 2899 | /** |
2731 | * @brief Sets the current background, must be created by evas ecore_evas_ews_evas_get(). | 2900 | * @brief Sets the current background, must be created by evas ecore_evas_ews_evas_get(). |
2732 | * | 2901 | * |
2902 | * @param o The Evas_Object for which to set the background. | ||
2903 | * | ||
2733 | * It will be kept at lowest layer (EVAS_LAYER_MIN) and below | 2904 | * It will be kept at lowest layer (EVAS_LAYER_MIN) and below |
2734 | * everything else. You can set any object, default is a black | 2905 | * everything else. You can set any object, default is a black |
2735 | * rectangle. | 2906 | * rectangle. |
2736 | * | 2907 | * |
2737 | * @note previous object will be deleted! | 2908 | * @note previous object will be deleted! |
2738 | * @param o The Evas_Object for which to set the background. | ||
2739 | */ | 2909 | */ |
2740 | EAPI void ecore_evas_ews_background_set(Evas_Object *o); | 2910 | EAPI void ecore_evas_ews_background_set(Evas_Object *o); |
2741 | 2911 | ||
@@ -2743,7 +2913,9 @@ EAPI void ecore_evas_ews_background_set(Evas_Object *o); | |||
2743 | * @brief Returns all Ecore_Evas* created by EWS. | 2913 | * @brief Returns all Ecore_Evas* created by EWS. |
2744 | * | 2914 | * |
2745 | * @return An eina list of Ecore_evases. | 2915 | * @return An eina list of Ecore_evases. |
2916 | * | ||
2746 | * @note Do not change the returned list or its contents. | 2917 | * @note Do not change the returned list or its contents. |
2918 | * | ||
2747 | * @since 1.1 | 2919 | * @since 1.1 |
2748 | */ | 2920 | */ |
2749 | EAPI const Eina_List *ecore_evas_ews_children_get(void); | 2921 | EAPI const Eina_List *ecore_evas_ews_children_get(void); |
@@ -2751,12 +2923,12 @@ EAPI const Eina_List *ecore_evas_ews_children_get(void); | |||
2751 | /** | 2923 | /** |
2752 | * @brief Sets the identifier of the manager taking care of internal windows. | 2924 | * @brief Sets the identifier of the manager taking care of internal windows. |
2753 | * | 2925 | * |
2926 | * @param manager any unique identifier address. | ||
2927 | * | ||
2754 | * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider | 2928 | * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider |
2755 | * handling it to know if you should stop handling events yourself | 2929 | * handling it to know if you should stop handling events yourself |
2756 | * (ie: another manager took over) | 2930 | * (ie: another manager took over) |
2757 | * | 2931 | * |
2758 | * @param manager any unique identifier address. | ||
2759 | * | ||
2760 | * @see ecore_evas_ews_manager_get() | 2932 | * @see ecore_evas_ews_manager_get() |
2761 | * @since 1.1 | 2933 | * @since 1.1 |
2762 | */ | 2934 | */ |
@@ -2766,6 +2938,7 @@ EAPI void ecore_evas_ews_manager_set(const void *manager); | |||
2766 | * @brief Gets the identifier of the manager taking care of internal windows. | 2938 | * @brief Gets the identifier of the manager taking care of internal windows. |
2767 | * | 2939 | * |
2768 | * @return the value set by ecore_evas_ews_manager_set() | 2940 | * @return the value set by ecore_evas_ews_manager_set() |
2941 | * | ||
2769 | * @since 1.1 | 2942 | * @since 1.1 |
2770 | */ | 2943 | */ |
2771 | EAPI const void *ecore_evas_ews_manager_get(void); | 2944 | EAPI const void *ecore_evas_ews_manager_get(void); |
@@ -2937,7 +3110,6 @@ EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool even | |||
2937 | * @brief Gets the blocking about mouse events to Ecore Evas. | 3110 | * @brief Gets the blocking about mouse events to Ecore Evas. |
2938 | * | 3111 | * |
2939 | * @param ee The Ecore_Evas. | 3112 | * @param ee The Ecore_Evas. |
2940 | |||
2941 | * @return The blocking about mouse events. | 3113 | * @return The blocking about mouse events. |
2942 | * | 3114 | * |
2943 | * @see ecore_evas_extn_socket_events_block_set() | 3115 | * @see ecore_evas_extn_socket_events_block_set() |
@@ -3075,7 +3247,6 @@ EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input | |||
3075 | * @brief Retrieves the Visual used for pixmap creation. | 3247 | * @brief Retrieves the Visual used for pixmap creation. |
3076 | * | 3248 | * |
3077 | * @param ee The Ecore_Evas containing the pixmap | 3249 | * @param ee The Ecore_Evas containing the pixmap |
3078 | * | ||
3079 | * @return The Visual which was used when creating the pixmap | 3250 | * @return The Visual which was used when creating the pixmap |
3080 | * | 3251 | * |
3081 | * @warning If and when this function is called depends on the underlying | 3252 | * @warning If and when this function is called depends on the underlying |
@@ -3090,7 +3261,6 @@ EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); | |||
3090 | * @brief Retrieves the Colormap used for pixmap creation. | 3261 | * @brief Retrieves the Colormap used for pixmap creation. |
3091 | * | 3262 | * |
3092 | * @param ee The Ecore_Evas containing the pixmap | 3263 | * @param ee The Ecore_Evas containing the pixmap |
3093 | * | ||
3094 | * @return The Colormap which was used when creating the pixmap | 3264 | * @return The Colormap which was used when creating the pixmap |
3095 | * | 3265 | * |
3096 | * @warning If and when this function is called depends on the underlying | 3266 | * @warning If and when this function is called depends on the underlying |
@@ -3105,7 +3275,6 @@ EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee); | |||
3105 | * @brief Retrieves the depth used for pixmap creation. | 3275 | * @brief Retrieves the depth used for pixmap creation. |
3106 | * | 3276 | * |
3107 | * @param ee The Ecore_Evas containing the pixmap | 3277 | * @param ee The Ecore_Evas containing the pixmap |
3108 | * | ||
3109 | * @return The depth which was used when creating the pixmap | 3278 | * @return The depth which was used when creating the pixmap |
3110 | * | 3279 | * |
3111 | * @warning If and when this function is called depends on the underlying | 3280 | * @warning If and when this function is called depends on the underlying |