summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-27 19:35:52 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-27 19:37:43 +0900
commit8c19d9251d2d243922057363b738780d770b4de5 (patch)
tree70467aa795a5b07c22d386cb0e4010cb22c0cfa8 /src/lib/ecore_evas
parent726994d175fb758b0b904418dbce13efd7f0cef6 (diff)
docs: Fix typos and some wrong expressions
Covers: Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Summary: I had fixed some typos and wrong expressions, such as capital letters, singular Etc. in Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, jpeg, Jaehyun_Cho Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4680
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h484
1 files changed, 242 insertions, 242 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 3d74e6bb95..e2c58a0a73 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -32,7 +32,7 @@
32 32
33/** 33/**
34 * @file Ecore_Evas.h 34 * @file Ecore_Evas.h
35 * @brief Evas wrapper functions 35 * @brief Evas wrapper functions.
36 * 36 *
37 * The following is a list of example that partially exemplify Ecore_Evas's API: 37 * The following is a list of example that partially exemplify Ecore_Evas's API:
38 * @li @ref ecore_evas_callbacks_example_c 38 * @li @ref ecore_evas_callbacks_example_c
@@ -86,7 +86,7 @@ extern "C" {
86 * @{ 86 * @{
87 */ 87 */
88 88
89/* these are dummy and just tell u what API levels ecore_evas supports - not if 89/* these are dummy and just tell you what API levels ecore_evas supports - not if
90 * the actual support is compiled in. You need to query for that separately. 90 * the actual support is compiled in. You need to query for that separately.
91 */ 91 */
92#define HAVE_ECORE_EVAS_X 1 92#define HAVE_ECORE_EVAS_X 1
@@ -154,9 +154,9 @@ typedef enum _Ecore_Evas_Object_Associate_Flags
154EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine); 154EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type engine);
155 155
156/** 156/**
157 * @brief Init the Ecore_Evas system. 157 * @brief Inits the Ecore_Evas system.
158 * 158 *
159 * @return How many times the lib has been initialized, 0 indicates failure. 159 * @return How many times the lib has been initialized, @c 0 indicates failure.
160 * 160 *
161 * Set up the Evas wrapper system. Init Evas and Ecore libraries. 161 * Set up the Evas wrapper system. Init Evas and Ecore libraries.
162 * 162 *
@@ -164,9 +164,9 @@ EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type eng
164 */ 164 */
165EAPI int ecore_evas_init(void); 165EAPI int ecore_evas_init(void);
166/** 166/**
167 * @brief Shut down the Ecore_Evas system. 167 * @brief Shuts down the Ecore_Evas system.
168 * 168 *
169 * @return 0 if ecore evas is fully shut down, or > 0 if it still being used. 169 * @return @c 0 if ecore evas is fully shut down, or > @c 0 if it still being used.
170 * 170 *
171 * This closes the Evas wrapper system down. Shut down Evas and Ecore libraries. 171 * This closes the Evas wrapper system down. Shut down Evas and Ecore libraries.
172 * 172 *
@@ -178,7 +178,7 @@ EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
178EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); 178EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
179 179
180/** 180/**
181 * @brief Return a list of supported engines names. 181 * @brief Returns a list of supported engines names.
182 * 182 *
183 * @return Newly allocated list with engines names. Engines names 183 * @return Newly allocated list with engines names. Engines names
184 * strings are internal and should be considered constants, do not 184 * strings are internal and should be considered constants, do not
@@ -188,21 +188,21 @@ EAPI Eina_List *ecore_evas_engines_get(void);
188/** 188/**
189 * @brief Free list returned by ecore_evas_engines_get() 189 * @brief Free list returned by ecore_evas_engines_get()
190 * 190 *
191 * @param engines list with engines names 191 * @param engines List with engines names
192 */ 192 */
193EAPI void ecore_evas_engines_free(Eina_List *engines); 193EAPI void ecore_evas_engines_free(Eina_List *engines);
194/** 194/**
195 * @brief Create a new Ecore_Evas based on engine name and common parameters. 195 * @brief Creates a new Ecore_Evas based on engine name and common parameters.
196 * 196 *
197 * @param engine_name engine name as returned by 197 * @param engine_name Engine name as returned by
198 * ecore_evas_engines_get() or @c NULL to use environment variable 198 * ecore_evas_engines_get() or @c NULL to use environment variable
199 * ECORE_EVAS_ENGINE, that can be undefined and in this case 199 * ECORE_EVAS_ENGINE, that can be undefined and in this case
200 * this call will try to find the first working engine. 200 * this call will try to find the first working engine.
201 * @param x horizontal position of window (not supported in all engines) 201 * @param x Horizontal position of window (not supported in all engines)
202 * @param y vertical position of window (not supported in all engines) 202 * @param y Vertical position of window (not supported in all engines)
203 * @param w width of window 203 * @param w Width of window
204 * @param h height of window 204 * @param h Height of window
205 * @param extra_options string with extra parameter, dependent on engines 205 * @param extra_options String with extra parameter, dependent on engines
206 * or @ NULL. String is usually in the form: 'key1=value1;key2=value2'. 206 * or @ NULL. String is usually in the form: 'key1=value1;key2=value2'.
207 * Pay attention that when getting that from shell commands, most 207 * Pay attention that when getting that from shell commands, most
208 * consider ';' as the command terminator, so you need to escape 208 * consider ';' as the command terminator, so you need to escape
@@ -212,7 +212,7 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
212 */ 212 */
213EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options); 213EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, int h, const char *extra_options);
214/** 214/**
215 * @brief Set whether an Ecore_Evas has an alpha channel or not. 215 * @brief Sets whether an Ecore_Evas has an alpha channel or not.
216 * 216 *
217 * @param ee The Ecore_Evas to shape 217 * @param ee The Ecore_Evas to shape
218 * @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to 218 * @param alpha @c EINA_TRUE to enable the alpha channel, @c EINA_FALSE to
@@ -229,7 +229,7 @@ EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, in
229 */ 229 */
230EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); 230EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
231/** 231/**
232 * @brief Query whether an Ecore_Evas has an alpha channel. 232 * @brief Queries whether an Ecore_Evas has an alpha channel.
233 * @param ee The Ecore_Evas to query. 233 * @param ee The Ecore_Evas to query.
234 * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does 234 * @return @c EINA_TRUE if ee has an alpha channel, @c EINA_FALSE if it does
235 * not. 235 * not.
@@ -241,7 +241,7 @@ EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha);
241 */ 241 */
242EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); 242EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
243/** 243/**
244 * @brief Set whether an Ecore_Evas has an transparent window or not. 244 * @brief Sets whether an Ecore_Evas has an transparent window or not.
245 * 245 *
246 * @param ee The Ecore_Evas to shape 246 * @param ee The Ecore_Evas to shape
247 * @param transparent @c EINA_TRUE to enable the transparent window, 247 * @param transparent @c EINA_TRUE to enable the transparent window,
@@ -256,7 +256,7 @@ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee);
256 */ 256 */
257EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent); 257EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent);
258/** 258/**
259 * @brief Query whether an Ecore_Evas is transparent. 259 * @brief Queries whether an Ecore_Evas is transparent.
260 * 260 *
261 * @param ee The Ecore_Evas to query. 261 * @param ee The Ecore_Evas to query.
262 * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't. 262 * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't.
@@ -265,7 +265,7 @@ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparen
265 */ 265 */
266EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); 266EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
267/** 267/**
268 * @brief Get the geometry of an Ecore_Evas. 268 * @brief Gets the geometry of an Ecore_Evas.
269 * 269 *
270 * @param ee The Ecore_Evas whose geometry y 270 * @param ee The Ecore_Evas whose geometry y
271 * @param x A pointer to an int to place the x coordinate in 271 * @param x A pointer to an int to place the x coordinate in
@@ -289,7 +289,7 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
289 */ 289 */
290EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); 290EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
291/** 291/**
292 * @brief Get the geometry which an Ecore_Evas was latest recently requested. 292 * @brief Gets the geometry which an Ecore_Evas was latest recently requested.
293 * 293 *
294 * @param ee The Ecore_Evas whose geometry y 294 * @param ee The Ecore_Evas whose geometry y
295 * @param x A pointer to an int to place the x coordinate in 295 * @param x A pointer to an int to place the x coordinate in
@@ -314,7 +314,7 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i
314 */ 314 */
315EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); 315EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
316/** 316/**
317 * @brief Set the Ecore_Evas window focus for the default seat. 317 * @brief Sets the Ecore_Evas window focus for the default seat.
318 * 318 *
319 * @param ee The Ecore_Evas 319 * @param ee The Ecore_Evas
320 * @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus. 320 * @param on @c EINA_TRUE for focus, @c EINA_FALSE to defocus.
@@ -327,7 +327,7 @@ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, i
327 */ 327 */
328EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); 328EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
329/** 329/**
330 * @brief Query whether the default seat has the Ecore_Evas focus. 330 * @brief Queries whether the default seat has the Ecore_Evas focus.
331 * 331 *
332 * @param ee The Ecore_Evas to set 332 * @param ee The Ecore_Evas to set
333 * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not. 333 * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not.
@@ -338,7 +338,7 @@ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on);
338EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee); 338EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
339 339
340/** 340/**
341 * @brief Set the Ecore_Evas windows focus for a given seat. 341 * @brief Sets the Ecore_Evas windows focus for a given seat.
342 * 342 *
343 * @param ee The Ecore_Evas 343 * @param ee The Ecore_Evas
344 * @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat. 344 * @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat.
@@ -354,7 +354,7 @@ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee);
354EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat, 354EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat,
355 Eina_Bool on); 355 Eina_Bool on);
356/** 356/**
357 * @brief Query whether an Ecore_Evas' window is focused or not. 357 * @brief Queries whether an Ecore_Evas' window is focused or not.
358 * 358 *
359 * @param ee The Ecore_Evas to set 359 * @param ee The Ecore_Evas to set
360 * @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat. 360 * @param seat An Efl_Input_Device that represents the seat or @c NULL for the default seat.
@@ -365,7 +365,7 @@ EAPI void ecore_evas_focus_device_set(Ecore_Evas *ee, Eo *seat,
365 */ 365 */
366EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat); 366EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat);
367/** 367/**
368 * @brief Iconify or uniconify an Ecore_Evas' window. 368 * @brief Iconifies or uniconifies an Ecore_Evas' window.
369 * 369 *
370 * @param ee The Ecore_Evas 370 * @param ee The Ecore_Evas
371 * @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify. 371 * @param on @c EINA_TRUE to iconify, @c EINA_FALSE to uniconify.
@@ -379,7 +379,7 @@ EAPI Eina_Bool ecore_evas_focus_device_get(const Ecore_Evas *ee, Eo *seat);
379 */ 379 */
380EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); 380EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
381/** 381/**
382 * @brief Query whether an Ecore_Evas' window is iconified or not. 382 * @brief Queries whether an Ecore_Evas' window is iconified or not.
383 * 383 *
384 * @param ee The Ecore_Evas to set 384 * @param ee The Ecore_Evas to set
385 * @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not. 385 * @return @c EINA_TRUE if @p ee is iconified, @c EINA_FALSE if not.
@@ -390,7 +390,7 @@ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on);
390 */ 390 */
391EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); 391EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
392/** 392/**
393 * @brief Set whether an Ecore_Evas' window is borderless or not. 393 * @brief Sets whether an Ecore_Evas' window is borderless or not.
394 * 394 *
395 * @param ee The Ecore_Evas 395 * @param ee The Ecore_Evas
396 * @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered. 396 * @param on @c EINA_TRUE for borderless, @c EINA_FALSE for bordered.
@@ -402,7 +402,7 @@ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee);
402 */ 402 */
403EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); 403EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
404/** 404/**
405 * @brief Query whether an Ecore_Evas' window is borderless or not. 405 * @brief Queries whether an Ecore_Evas' window is borderless or not.
406 * 406 *
407 * @param ee The Ecore_Evas to set 407 * @param ee The Ecore_Evas to set
408 * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not. 408 * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not.
@@ -411,7 +411,7 @@ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on);
411 */ 411 */
412EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); 412EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
413/** 413/**
414 * @brief Set whether or not an Ecore_Evas' window is fullscreen. 414 * @brief Sets whether or not an Ecore_Evas' window is fullscreen.
415 * 415 *
416 * @param ee The Ecore_Evas 416 * @param ee The Ecore_Evas
417 * @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not. 417 * @param on @c EINA_TRUE fullscreen, @c EINA_FALSE not.
@@ -423,7 +423,7 @@ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee);
423 */ 423 */
424EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); 424EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
425/** 425/**
426 * @brief Query whether an Ecore_Evas' window is fullscreen or not. 426 * @brief Queries whether an Ecore_Evas' window is fullscreen or not.
427 * 427 *
428 * @param ee The Ecore_Evas to set 428 * @param ee The Ecore_Evas to set
429 * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not. 429 * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not.
@@ -432,7 +432,7 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on);
432 */ 432 */
433EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); 433EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
434/** 434/**
435 * @brief Set another window that this window is a group member of 435 * @brief Sets another window that this window is a group member of.
436 * 436 *
437 * @param ee The Ecore_Evas 437 * @param ee The Ecore_Evas
438 * @param ee_group The other group member 438 * @param ee_group The other group member
@@ -447,7 +447,7 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee);
447 */ 447 */
448EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group); 448EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group);
449/** 449/**
450 * @brief Get the canvas group set. 450 * @brief Gets the canvas group set.
451 * 451 *
452 * This returns the handle set by ecore_evas_window_group_set(). 452 * This returns the handle set by ecore_evas_window_group_set().
453 * 453 *
@@ -459,7 +459,7 @@ EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *e
459 */ 459 */
460EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); 460EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
461/** 461/**
462 * @brief Set the aspect ratio of a canvas window 462 * @brief Sets the aspect ratio of a canvas window.
463 * 463 *
464 * @param ee The Ecore_Evas 464 * @param ee The Ecore_Evas
465 * @param aspect The aspect ratio (width divided by height), or 0 to disable 465 * @param aspect The aspect ratio (width divided by height), or 0 to disable
@@ -471,7 +471,7 @@ EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee);
471 */ 471 */
472EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); 472EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
473/** 473/**
474 * @brief Get the aspect ratio of a canvas window 474 * @brief Gets the aspect ratio of a canvas window.
475 * 475 *
476 * This returns the value set by ecore_evas_aspect_set(). 476 * This returns the value set by ecore_evas_aspect_set().
477 * 477 *
@@ -483,7 +483,7 @@ EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect);
483 */ 483 */
484EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); 484EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
485/** 485/**
486 * @brief Set The urgent hint flag 486 * @brief Sets The urgent hint flag.
487 * 487 *
488 * @param ee The Ecore_Evas 488 * @param ee The Ecore_Evas
489 * @param urgent The urgent state flag 489 * @param urgent The urgent state flag
@@ -496,7 +496,7 @@ EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee);
496 */ 496 */
497EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); 497EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
498/** 498/**
499 * @brief Get the urgent state on the cavas window 499 * @brief Gets the urgent state on the canvas window.
500 * 500 *
501 * This returns the value set by ecore_evas_urgent_set() 501 * This returns the value set by ecore_evas_urgent_set()
502 * 502 *
@@ -508,7 +508,7 @@ EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent);
508 */ 508 */
509EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); 509EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
510/** 510/**
511 * @brief Set the modal state flag on the canvas window 511 * @brief Sets the modal state flag on the canvas window.
512 * 512 *
513 * @param ee The Ecore_Evas 513 * @param ee The Ecore_Evas
514 * @param modal The modal hint flag 514 * @param modal The modal hint flag
@@ -522,7 +522,7 @@ EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee);
522 */ 522 */
523EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); 523EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
524/** 524/**
525 * @brief Get The modal flag 525 * @brief Gets The modal flag.
526 * 526 *
527 * This returns the value set by ecore_evas_modal_set(). 527 * This returns the value set by ecore_evas_modal_set().
528 * 528 *
@@ -534,7 +534,7 @@ EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal);
534 */ 534 */
535EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); 535EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
536/** 536/**
537 * @brief Set the "i demand attention" flag on a canvas window 537 * @brief Sets the "i demand attention" flag on a canvas window.
538 * 538 *
539 * @param ee The Ecore_Evas 539 * @param ee The Ecore_Evas
540 * @param demand The flag state to set 540 * @param demand The flag state to set
@@ -547,19 +547,19 @@ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee);
547 */ 547 */
548EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand); 548EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand);
549/** 549/**
550 * @brief Get the "i demand attention" flag 550 * @brief Gets the "i demand attention" flag.
551 * 551 *
552 * This returns the value set by ecore_evas_demand_attention_set(). 552 * This returns the value set by ecore_evas_demand_attention_set().
553 * 553 *
554 * @param ee The Ecore_Evas to set 554 * @param ee The Ecore_Evas to set
555 * @return The "i demand attention" flag. 555 * @return The "i demand attention" flag
556 * 556 *
557 * @see ecore_evas_demand_attention_set() 557 * @see ecore_evas_demand_attention_set()
558 * @since 1.2 558 * @since 1.2
559 */ 559 */
560EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); 560EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
561/** 561/**
562 * @brief Set the "focus skip" flag 562 * @brief Sets the "focus skip" flag.
563 * 563 *
564 * @param ee The Ecore_Evas 564 * @param ee The Ecore_Evas
565 * @param skip The "focus skip" state to set. 565 * @param skip The "focus skip" state to set.
@@ -574,12 +574,12 @@ EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee);
574 */ 574 */
575EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip); 575EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
576/** 576/**
577 * @brief Get the "focus skip" flag 577 * @brief Gets the "focus skip" flag.
578 * 578 *
579 * This returns the value set by ecore_evas_focus_skip_set(). 579 * This returns the value set by ecore_evas_focus_skip_set().
580 * 580 *
581 * @param ee The Ecore_Evas to set 581 * @param ee The Ecore_Evas to set
582 * @return The "focus skip" flag. 582 * @return The "focus skip" flag
583 * 583 *
584 * @see ecore_evas_focus_skip_set() 584 * @see ecore_evas_focus_skip_set()
585 * @since 1.2 585 * @since 1.2
@@ -587,7 +587,7 @@ EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip);
587EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee); 587EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
588 588
589/** 589/**
590 * @brief Set if this evas should ignore @b all events. 590 * @brief Sets if this evas should ignore @b all events.
591 * 591 *
592 * @param ee The Ecore_Evas whose window's to ignore events. 592 * @param ee The Ecore_Evas whose window's to ignore events.
593 * @param ignore The Ecore_Evas new ignore state. 593 * @param ignore The Ecore_Evas new ignore state.
@@ -596,7 +596,7 @@ EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee);
596 */ 596 */
597EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); 597EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
598/** 598/**
599 * @brief Return the ignore state of an Ecore_Evas' window. 599 * @brief Returns the ignore state of an Ecore_Evas' window.
600 * 600 *
601 * @param ee The Ecore_Evas whose window's ignore events state is returned. 601 * @param ee The Ecore_Evas whose window's ignore events state is returned.
602 * @return The Ecore_Evas window's ignore state. 602 * @return The Ecore_Evas window's ignore state.
@@ -605,19 +605,19 @@ EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore);
605 */ 605 */
606EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); 606EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee);
607/** 607/**
608 * @brief Query whether an Ecore_Evas' window is visible or not. 608 * @brief Queries whether an Ecore_Evas' window is visible or not.
609 * 609 *
610 * @param ee The Ecore_Evas to query. 610 * @param ee The Ecore_Evas to query.
611 * @return 1 if visible, 0 if not. 611 * @return @c 1 if visible, @c 0 if not.
612 * 612 *
613 * This function queries @p ee and returns 1 if it is visible, and 0 if not. 613 * This function queries @p ee and returns @c 1 if it is visible, and @c 0 if not.
614 * 614 *
615 * @see ecore_evas_show() 615 * @see ecore_evas_show()
616 * @see ecore_evas_hide() 616 * @see ecore_evas_hide()
617 */ 617 */
618EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); 618EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
619/** 619/**
620 * @brief Set the layer of an Ecore_Evas' window. 620 * @brief Sets the layer of an Ecore_Evas' window.
621 * 621 *
622 * @param ee The Ecore_Evas 622 * @param ee The Ecore_Evas
623 * @param layer The layer to put @p ee on. 623 * @param layer The layer to put @p ee on.
@@ -631,10 +631,10 @@ EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee);
631 */ 631 */
632EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); 632EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
633/** 633/**
634 * @brief Get the layer of an Ecore_Evas' window. 634 * @brief Gets the layer of an Ecore_Evas' window.
635 * 635 *
636 * @param ee The Ecore_Evas to set 636 * @param ee The Ecore_Evas to set
637 * @return the layer @p ee's window is on. 637 * @return The layer @p ee's window is on
638 * 638 *
639 * @see ecore_evas_layer_set() 639 * @see ecore_evas_layer_set()
640 * @see ecore_evas_lower() 640 * @see ecore_evas_lower()
@@ -642,10 +642,10 @@ EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer);
642 */ 642 */
643EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); 643EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
644/** 644/**
645 * @brief Maximize (or unmaximize) an Ecore_Evas' window. 645 * @brief Maximizes (or unmaximizes) an Ecore_Evas' window.
646 * 646 *
647 * @param ee The Ecore_Evas 647 * @param ee The Ecore_Evas
648 * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize. 648 * @param on @c EINA_TRUE to maximize, @c EINA_FALSE to unmaximize
649 * 649 *
650 * This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee 650 * This function maximizes @p ee if @p on is @c EINA_TRUE, or unmaximizes @p ee
651 * if @p on is @c EINA_FALSE. 651 * if @p on is @c EINA_FALSE.
@@ -654,7 +654,7 @@ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee);
654 */ 654 */
655EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); 655EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
656/** 656/**
657 * @brief Query whether an Ecore_Evas' window is maximized or not. 657 * @brief Queries whether an Ecore_Evas' window is maximized or not.
658 * 658 *
659 * @param ee The Ecore_Evas to set 659 * @param ee The Ecore_Evas to set
660 * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not. 660 * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not.
@@ -663,7 +663,7 @@ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on);
663 */ 663 */
664EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); 664EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
665/** 665/**
666 * @brief Query if the underlying windowing system supports the window profile. 666 * @brief Queries if the underlying windowing system supports the window profile.
667 * 667 *
668 * @param ee The Ecore_Evas 668 * @param ee The Ecore_Evas
669 * @return @c EINA_TRUE if the window profile is supported, @c EINA_FALSE otherwise. 669 * @return @c EINA_TRUE if the window profile is supported, @c EINA_FALSE otherwise.
@@ -673,7 +673,7 @@ EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee);
673 */ 673 */
674EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); 674EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee);
675/** 675/**
676 * @brief Set the window profile 676 * @brief Sets the window profile.
677 * 677 *
678 * @param ee The Ecore_Evas to set 678 * @param ee The Ecore_Evas to set
679 * @param profile The string value of the window profile 679 * @param profile The string value of the window profile
@@ -683,7 +683,7 @@ EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee);
683 */ 683 */
684EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile); 684EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile);
685/** 685/**
686 * @brief Get the window profile 686 * @brief Gets the window profile.
687 * 687 *
688 * @param ee The Ecore_Evas to get the window profile from. 688 * @param ee The Ecore_Evas to get the window profile from.
689 * @return The string value of the window profile, or NULL if none exists 689 * @return The string value of the window profile, or NULL if none exists
@@ -693,10 +693,10 @@ EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profi
693 */ 693 */
694EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); 694EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee);
695/** 695/**
696 * @brief Set the array of available window profiles 696 * @brief Sets the array of available window profiles.
697 * 697 *
698 * @param ee The Ecore_Evas to set 698 * @param ee The Ecore_Evas to set
699 * @param profiles The string array of available window profiels 699 * @param profiles The string array of available window profiles
700 * @param count The number of members in profiles 700 * @param count The number of members in profiles
701 * 701 *
702 * @warning Support for this depends on the underlying windowing system. 702 * @warning Support for this depends on the underlying windowing system.
@@ -704,19 +704,19 @@ EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee);
704 */ 704 */
705EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count); 705EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count);
706/** 706/**
707 * @brief Get the array of available window profiles 707 * @brief Gets the array of available window profiles.
708 * 708 *
709 * @param ee The Ecore_Evas to get available window profiles from. 709 * @param ee The Ecore_Evas to get available window profiles from.
710 * @param profiles Where to return the string array of available window profiles 710 * @param profiles Where to return the string array of available window profiles
711 * @param count Where to return the number of members in profiles 711 * @param count Where to return the number of members in profiles
712 * @return EINA_TRUE if available window profiles exist, EINA_FALSE otherwise 712 * @return @c EINA_TRUE if available window profiles exist, @c EINA_FALSE otherwise
713 * 713 *
714 * @warning Support for this depends on the underlying windowing system. 714 * @warning Support for this depends on the underlying windowing system.
715 * @since 1.8.0 715 * @since 1.8.0
716 */ 716 */
717EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count); 717EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count);
718/** 718/**
719 * @brief Query if the underlying windowing system supports the window manager rotation. 719 * @brief Queries if the underlying windowing system supports the window manager rotation.
720 * 720 *
721 * @param ee The Ecore_Evas 721 * @param ee The Ecore_Evas
722 * @return @c EINA_TRUE if the window manager rotation is supported, @c EINA_FALSE otherwise. 722 * @return @c EINA_TRUE if the window manager rotation is supported, @c EINA_FALSE otherwise.
@@ -726,7 +726,7 @@ EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char *
726 */ 726 */
727EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); 727EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee);
728/** 728/**
729 * @brief Set the preferred rotation hint. 729 * @brief Sets the preferred rotation hint.
730 * 730 *
731 * @param ee The Ecore_Evas to set 731 * @param ee The Ecore_Evas to set
732 * @param rotation Value to set the preferred rotation hint 732 * @param rotation Value to set the preferred rotation hint
@@ -736,17 +736,17 @@ EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee);
736 */ 736 */
737EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation); 737EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation);
738/** 738/**
739 * @brief Get the preferred rotation hint. 739 * @brief Gets the preferred rotation hint.
740 * 740 *
741 * @param ee The Ecore_Evas to get the preferred rotation hint from. 741 * @param ee The Ecore_Evas to get the preferred rotation hint from.
742 * @return The preferred rotation hint, -1 on failure. 742 * @return The preferred rotation hint, @c -1 on failure.
743 * 743 *
744 * @warning Support for this depends on the underlying windowing system. 744 * @warning Support for this depends on the underlying windowing system.
745 * @since 1.9.0 745 * @since 1.9.0
746 */ 746 */
747EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee); 747EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee);
748/** 748/**
749 * @brief Set the array of available window rotations. 749 * @brief Sets the array of available window rotations.
750 * 750 *
751 * @param ee The Ecore_Evas to set 751 * @param ee The Ecore_Evas to set
752 * @param rotations The integer array of available window rotations 752 * @param rotations The integer array of available window rotations
@@ -757,19 +757,19 @@ EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas
757 */ 757 */
758EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count); 758EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count);
759/** 759/**
760 * @brief Get the array of available window rotations. 760 * @brief Gets the array of available window rotations.
761 * 761 *
762 * @param ee The Ecore_Evas to get available window rotations from. 762 * @param ee The Ecore_Evas to get available window rotations from.
763 * @param rotations Where to return the integer array of available window rotations 763 * @param rotations Where to return the integer array of available window rotations
764 * @param count Where to return the number of members in rotations 764 * @param count Where to return the number of members in rotations
765 * @return EINA_TRUE if available window rotations exist, EINA_FALSE otherwise 765 * @return @c EINA_TRUE if available window rotations exist, @c EINA_FALSE otherwise
766 * 766 *
767 * @warning Support for this depends on the underlying windowing system. 767 * @warning Support for this depends on the underlying windowing system.
768 * @since 1.9.0 768 * @since 1.9.0
769 */ 769 */
770EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count); 770EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count);
771/** 771/**
772 * @brief Set manual rotation done mode of Ecore_Evas's window 772 * @brief Sets manual rotation done mode of Ecore_Evas's window.
773 * 773 *
774 * @param ee The Ecore_Evas 774 * @param ee The Ecore_Evas
775 * @param set If true, the window manager will not rotate the Ecore_Evas's window until 775 * @param set If true, the window manager will not rotate the Ecore_Evas's window until
@@ -780,7 +780,7 @@ EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas
780 */ 780 */
781EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set); 781EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set);
782/** 782/**
783 * @brief Get manual rotation done mode of Ecore_Evas's window 783 * @brief Gets manual rotation done mode of Ecore_Evas's window.
784 * 784 *
785 * @param ee The Ecore_Evas 785 * @param ee The Ecore_Evas
786 * @return If true, the manual rotation done mode is enabled 786 * @return If true, the manual rotation done mode is enabled
@@ -789,7 +789,7 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee,
789 */ 789 */
790EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee); 790EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee);
791/** 791/**
792 * @brief Set rotation finish manually 792 * @brief Sets rotation finish manually.
793 * 793 *
794 * @param ee The Ecore_Evas 794 * @param ee The Ecore_Evas
795 * 795 *
@@ -797,7 +797,7 @@ EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Eva
797 */ 797 */
798EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); 798EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
799/** 799/**
800 * @brief Get the list of supported auxiliary hint strings. 800 * @brief Gets the list of supported auxiliary hint strings.
801 * 801 *
802 * @param ee The Ecore_Evas 802 * @param ee The Ecore_Evas
803 * @return List of supported auxiliary hint strings. 803 * @return List of supported auxiliary hint strings.
@@ -819,7 +819,7 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
819 */ 819 */
820EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); 820EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee);
821/** 821/**
822 * @brief Get the list of allowed auxiliary hint ID. 822 * @brief Gets the list of allowed auxiliary hint ID.
823 * 823 *
824 * @param ee The Ecore_Evas 824 * @param ee The Ecore_Evas
825 * @return List of allowed auxiliary hint ID. 825 * @return List of allowed auxiliary hint ID.
@@ -831,42 +831,42 @@ EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee);
831 */ 831 */
832EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); 832EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee);
833/** 833/**
834 * @brief Create an auxiliary hint of the Ecore_Evas. 834 * @brief Creates an auxiliary hint of the Ecore_Evas.
835 * 835 *
836 * @param ee The Ecore_Evas 836 * @param ee The Ecore_Evas
837 * @param hint The auxiliary hint string. 837 * @param hint The auxiliary hint string.
838 * @param val The value string. 838 * @param val The value string.
839 * @return The ID of created auxiliary hint, or -1 on failure. 839 * @return The ID of created auxiliary hint, or @c -1 on failure.
840 * @warning Support for this depends on the underlying windowing system. 840 * @warning Support for this depends on the underlying windowing system.
841 * 841 *
842 * @since 1.10.0 842 * @since 1.10.0
843 */ 843 */
844EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val); 844EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val);
845/** 845/**
846 * @brief Delete an auxiliary hint of the Ecore_Evas. 846 * @brief Deletes an auxiliary hint of the Ecore_Evas.
847 * 847 *
848 * @param ee The Ecore_Evas 848 * @param ee The Ecore_Evas
849 * @param id The ID of the auxiliary hint. 849 * @param id The ID of the auxiliary hint.
850 * @return EINA_TRUE if no error occurred, EINA_FALSE otherwise. 850 * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
851 * @warning Support for this depends on the underlying windowing system. 851 * @warning Support for this depends on the underlying windowing system.
852 * 852 *
853 * @since 1.10.0 853 * @since 1.10.0
854 */ 854 */
855EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); 855EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id);
856/** 856/**
857 * @brief Change a value of the auxiliary hint. 857 * @brief Changes a value of the auxiliary hint.
858 * 858 *
859 * @param ee The Ecore_Evas 859 * @param ee The Ecore_Evas
860 * @param id The auxiliary hint ID. 860 * @param id The auxiliary hint ID.
861 * @param val The value string to be set. 861 * @param val The value string to be set.
862 * @return EINA_TRUE if no error occurred, EINA_FALSE otherwise. 862 * @return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
863 * @warning Support for this depends on the underlying windowing system. 863 * @warning Support for this depends on the underlying windowing system.
864 * 864 *
865 * @since 1.10.0 865 * @since 1.10.0
866 */ 866 */
867EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val); 867EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val);
868/** 868/**
869 * @brief Get a value of the auxiliary hint. 869 * @brief Gets a value of the auxiliary hint.
870 * 870 *
871 * @param ee The Ecore_Evas 871 * @param ee The Ecore_Evas
872 * @param id The auxiliary hint ID. 872 * @param id The auxiliary hint ID.
@@ -877,11 +877,11 @@ EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id,
877 */ 877 */
878EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id); 878EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id);
879/** 879/**
880 * @brief Get a ID of the auxiliary hint string. 880 * @brief Gets a ID of the auxiliary hint string.
881 * 881 *
882 * @param ee The Ecore_Evas 882 * @param ee The Ecore_Evas
883 * @param hint The auxiliary hint string. 883 * @param hint The auxiliary hint string.
884 * @return The ID of the auxiliary hint string, or -1 if none exists 884 * @return The ID of the auxiliary hint string, or @c -1 if none exists
885 * @warning Support for this depends on the underlying windowing system. 885 * @warning Support for this depends on the underlying windowing system.
886 * 886 *
887 * @since 1.15 887 * @since 1.15
@@ -889,7 +889,7 @@ EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id);
889EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const char *hint); 889EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const char *hint);
890 890
891/** 891/**
892 * @brief Send message to parent ecore 892 * @brief Sends message to parent ecore.
893 * 893 *
894 * @param ee The Ecore_Evas to set 894 * @param ee The Ecore_Evas to set
895 * @param msg_domain The domain of message 895 * @param msg_domain The domain of message
@@ -910,7 +910,7 @@ EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const cha
910 */ 910 */
911EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); 911EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
912/** 912/**
913 * @brief Send message to child ecore 913 * @brief Sends message to child ecore.
914 * 914 *
915 * @param ee The Ecore_Evas to set 915 * @param ee The Ecore_Evas to set
916 * @param msg_domain The domain of message 916 * @param msg_domain The domain of message
@@ -927,7 +927,7 @@ EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id,
927 */ 927 */
928EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); 928EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size);
929/** 929/**
930 * @brief Set a callback for parent Ecore_Evas message. 930 * @brief Sets a callback for parent Ecore_Evas message.
931 * 931 *
932 * @param ee The Ecore_Evas to set callbacks on 932 * @param ee The Ecore_Evas to set callbacks on
933 * @param func_parent_handle The handle to be called when message arive. 933 * @param func_parent_handle The handle to be called when message arive.
@@ -941,7 +941,7 @@ EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *
941 */ 941 */
942EAPI 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)); 942EAPI 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));
943/** 943/**
944 * @brief Set a callback for child Ecore_Evas message. 944 * @brief Sets a callback for child Ecore_Evas message.
945 * 945 *
946 * @param ee The Ecore_Evas to set callbacks on 946 * @param ee The Ecore_Evas to set callbacks on
947 * @param func_handle The handle to be called when message arive 947 * @param func_handle The handle to be called when message arive
@@ -956,7 +956,7 @@ EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_
956EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)); 956EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size));
957 957
958/** 958/**
959 * @brief Move an Ecore_Evas. 959 * @brief Moves an Ecore_Evas.
960 * 960 *
961 * @param ee The Ecore_Evas to move 961 * @param ee The Ecore_Evas to move
962 * @param x The x coordinate to move to 962 * @param x The x coordinate to move to
@@ -972,7 +972,7 @@ EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)
972 */ 972 */
973EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); 973EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
974/** 974/**
975 * @brief Resize an Ecore_Evas. 975 * @brief Resizes an Ecore_Evas.
976 * 976 *
977 * @param ee The Ecore_Evas to move 977 * @param ee The Ecore_Evas to move
978 * @param w The w coordinate to resize to 978 * @param w The w coordinate to resize to
@@ -988,7 +988,7 @@ EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y);
988 */ 988 */
989EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); 989EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
990/** 990/**
991 * @brief Move and resize an Ecore_Evas 991 * @brief Moves and resizes an Ecore_Evas.
992 * 992 *
993 * @param ee The Ecore_Evas to move and resize 993 * @param ee The Ecore_Evas to move and resize
994 * @param x The x coordinate to move to 994 * @param x The x coordinate to move to
@@ -996,7 +996,7 @@ EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
996 * @param w The w coordinate to resize to 996 * @param w The w coordinate to resize to
997 * @param h The h coordinate to resize to 997 * @param h The h coordinate to resize to
998 * 998 *
999 * This moves @p ee to the screen coordinates (@p x, @p y) and resizes 999 * This moves @p ee to the screen coordinates (@p x, @p y) and resizes
1000 * it to @p w x @p h. 1000 * it to @p w x @p h.
1001 * 1001 *
1002 * @warning Support for this depends on the underlying windowing system. 1002 * @warning Support for this depends on the underlying windowing system.
@@ -1007,10 +1007,10 @@ EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h);
1007 */ 1007 */
1008EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h); 1008EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h);
1009/** 1009/**
1010 * @brief Set the rotation of an Ecore_Evas' window. 1010 * @brief Sets the rotation of an Ecore_Evas' window.
1011 * 1011 *
1012 * @param ee The Ecore_Evas 1012 * @param ee The Ecore_Evas
1013 * @param rot the angle (in degrees) of rotation. 1013 * @param rot The angle (in degrees) of rotation
1014 * 1014 *
1015 * The allowed values of @p rot depend on the engine being used. Most only 1015 * The allowed values of @p rot depend on the engine being used. Most only
1016 * allow multiples of 90. 1016 * allow multiples of 90.
@@ -1021,10 +1021,10 @@ EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int
1021 */ 1021 */
1022EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); 1022EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
1023/** 1023/**
1024 * @brief Set the rotation of an Ecore_Evas' window 1024 * @brief Sets the rotation of an Ecore_Evas' window.
1025 * 1025 *
1026 * @param ee The Ecore_Evas 1026 * @param ee The Ecore_Evas
1027 * @param rot the angle (in degrees) of rotation. 1027 * @param rot The angle (in degrees) of rotation.
1028 * 1028 *
1029 * Like ecore_evas_rotation_set(), but it also resizes the window's contents so 1029 * Like ecore_evas_rotation_set(), but it also resizes the window's contents so
1030 * that they fit inside the current window geometry. 1030 * that they fit inside the current window geometry.
@@ -1035,17 +1035,17 @@ EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
1035 */ 1035 */
1036EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); 1036EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot);
1037/** 1037/**
1038 * @brief Get the rotation of an Ecore_Evas' window 1038 * @brief Gets the rotation of an Ecore_Evas' window
1039 * 1039 *
1040 * @param ee The Ecore_Evas 1040 * @param ee The Ecore_Evas
1041 * @return the angle (in degrees) of rotation. 1041 * @return The angle (in degrees) of rotation
1042 * 1042 *
1043 * @see ecore_evas_rotation_set() 1043 * @see ecore_evas_rotation_set()
1044 * @see ecore_evas_rotation_with_resize_set() 1044 * @see ecore_evas_rotation_with_resize_set()
1045 */ 1045 */
1046EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); 1046EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
1047/** 1047/**
1048 * @brief Raise an Ecore_Evas' window. 1048 * @brief Raises an Ecore_Evas' window.
1049 * 1049 *
1050 * @param ee The Ecore_Evas to raise. 1050 * @param ee The Ecore_Evas to raise.
1051 * 1051 *
@@ -1058,7 +1058,7 @@ EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee);
1058 */ 1058 */
1059EAPI void ecore_evas_raise(Ecore_Evas *ee); 1059EAPI void ecore_evas_raise(Ecore_Evas *ee);
1060/** 1060/**
1061 * @brief Lower an Ecore_Evas' window. 1061 * @brief Lowers an Ecore_Evas' window.
1062 * 1062 *
1063 * @param ee The Ecore_Evas to raise. 1063 * @param ee The Ecore_Evas to raise.
1064 * 1064 *
@@ -1071,7 +1071,7 @@ EAPI void ecore_evas_raise(Ecore_Evas *ee);
1071 */ 1071 */
1072EAPI void ecore_evas_lower(Ecore_Evas *ee); 1072EAPI void ecore_evas_lower(Ecore_Evas *ee);
1073/** 1073/**
1074 * @brief Set the title of an Ecore_Evas' window. 1074 * @brief Sets the title of an Ecore_Evas' window.
1075 * 1075 *
1076 * @param ee The Ecore_Evas whose title you wish to set. 1076 * @param ee The Ecore_Evas whose title you wish to set.
1077 * @param t The title 1077 * @param t The title
@@ -1082,7 +1082,7 @@ EAPI void ecore_evas_lower(Ecore_Evas *ee);
1082 */ 1082 */
1083EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); 1083EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
1084/** 1084/**
1085 * @brief Get the title of an Ecore_Evas' window. 1085 * @brief Gets the title of an Ecore_Evas' window.
1086 * 1086 *
1087 * @param ee The Ecore_Evas whose title you wish to get. 1087 * @param ee The Ecore_Evas whose title you wish to get.
1088 * @return The title of @p ee. 1088 * @return The title of @p ee.
@@ -1093,11 +1093,11 @@ EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t);
1093 */ 1093 */
1094EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); 1094EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
1095/** 1095/**
1096 * @brief Set the name and class of an Ecore_Evas' window. 1096 * @brief Sets the name and class of an Ecore_Evas' window.
1097 * 1097 *
1098 * @param ee the Ecore_Evas 1098 * @param ee the Ecore_Evas
1099 * @param n the name 1099 * @param n The name
1100 * @param c the class 1100 * @param c The class
1101 * 1101 *
1102 * This function sets the name of @p ee to @p n, and its class to @p c. The 1102 * This function sets the name of @p ee to @p n, and its class to @p c. The
1103 * meaning of @p name and @p class depends on the underlying windowing system. 1103 * meaning of @p name and @p class depends on the underlying windowing system.
@@ -1106,7 +1106,7 @@ EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee);
1106 */ 1106 */
1107EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c); 1107EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c);
1108/** 1108/**
1109 * @brief Get the name and class of an Ecore_Evas' window 1109 * @brief Gets the name and class of an Ecore_Evas' window.
1110 * 1110 *
1111 * This function gets the name of @p ee into @p n, and its class into 1111 * This function gets the name of @p ee into @p n, and its class into
1112 * @p c. 1112 * @p c.
@@ -1118,7 +1118,7 @@ EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const
1118 */ 1118 */
1119EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c); 1119EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c);
1120/** 1120/**
1121 * @brief Return a pointer to the underlying window. 1121 * @brief Returns a pointer to the underlying window.
1122 * 1122 *
1123 * @param ee The Ecore_Evas whose window is desired. 1123 * @param ee The Ecore_Evas whose window is desired.
1124 * @return A pointer to the underlying window. 1124 * @return A pointer to the underlying window.
@@ -1130,7 +1130,7 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
1130/* engine/target specific init calls */ 1130/* engine/target specific init calls */
1131 1131
1132/** 1132/**
1133 * @brief Create Ecore_Evas using software x11. 1133 * @brief Creates Ecore_Evas using software x11.
1134 * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned. 1134 * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
1135 * @param disp_name The name of the Ecore_Evas to be created. 1135 * @param disp_name The name of the Ecore_Evas to be created.
1136 * @param parent The parent of the Ecore_Evas to be created. 1136 * @param parent The parent of the Ecore_Evas to be created.
@@ -1143,7 +1143,7 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
1143EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); 1143EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
1144 1144
1145/** 1145/**
1146 * @brief Get the window from Ecore_Evas using software x11. 1146 * @brief Gets the window from Ecore_Evas using software x11.
1147 * @note If ecore is not compiled with support for x11 or if @p ee was not 1147 * @note If ecore is not compiled with support for x11 or if @p ee was not
1148 * created with ecore_evas_software_x11_new() then nothing is done and 1148 * created with ecore_evas_software_x11_new() then nothing is done and
1149 * 0 is returned. 1149 * 0 is returned.
@@ -1153,23 +1153,23 @@ EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_
1153EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); 1153EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
1154 1154
1155/** 1155/**
1156 * @brief Set the direct_resize of Ecore_Evas using software x11. 1156 * @brief Sets the direct_resize of Ecore_Evas using software x11.
1157 * @note If ecore is not compiled with support to x11 then nothing is done. 1157 * @note If ecore is not compiled with support to x11 then nothing is done.
1158 * @param ee The Ecore_Evas in which to set direct resize. 1158 * @param ee The Ecore_Evas in which to set direct resize.
1159 * @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE. 1159 * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
1160 */ 1160 */
1161EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); 1161EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
1162 1162
1163/** 1163/**
1164 * @brief Get if the Ecore_Evas is being directly resized using software x11. 1164 * @brief Gets if the Ecore_Evas is being directly resized using software x11.
1165 * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned. 1165 * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
1166 * @param ee The Ecore_Evas from which to get direct resize. 1166 * @param ee The Ecore_Evas from which to get direct resize.
1167 * @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE. 1167 * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
1168 */ 1168 */
1169EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee); 1169EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee);
1170 1170
1171/** 1171/**
1172 * @brief Add extra window on Ecore_Evas using software x11. 1172 * @brief Adds extra window on Ecore_Evas using software x11.
1173 * @note If ecore is not compiled with support to x11 then nothing is done. 1173 * @note If ecore is not compiled with support to x11 then nothing is done.
1174 * @param ee The Ecore_Evas on which to add the window. 1174 * @param ee The Ecore_Evas on which to add the window.
1175 * @param win The window to be added at the Ecore_Evas. 1175 * @param win The window to be added at the Ecore_Evas.
@@ -1177,7 +1177,7 @@ EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas
1177EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); 1177EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
1178 1178
1179/** 1179/**
1180 * @brief Create a new Ecore_Evas which does not contain an XWindow. It will 1180 * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will
1181 * only contain an XPixmap to render to 1181 * only contain an XPixmap to render to
1182 * 1182 *
1183 * @warning The XPixmap ID can change with every frame after it is rendered, 1183 * @warning The XPixmap ID can change with every frame after it is rendered,
@@ -1189,7 +1189,7 @@ EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *
1189EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); 1189EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
1190 1190
1191/** 1191/**
1192 * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas 1192 * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
1193 * 1193 *
1194 * @param ee The Ecore_Evas whose pixmap is desired. 1194 * @param ee The Ecore_Evas whose pixmap is desired.
1195 * @return The underlying Ecore_X_Pixmap 1195 * @return The underlying Ecore_X_Pixmap
@@ -1220,7 +1220,7 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee);
1220#define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE 4 1220#define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE 4
1221 1221
1222/** 1222/**
1223 * @brief Create Ecore_Evas using opengl x11. 1223 * @brief Creates Ecore_Evas using opengl x11.
1224 * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned. 1224 * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned.
1225 * @param disp_name The name of the display of the Ecore_Evas to be created. 1225 * @param disp_name The name of the display of the Ecore_Evas to be created.
1226 * @param parent The parent of the Ecore_Evas to be created. 1226 * @param parent The parent of the Ecore_Evas to be created.
@@ -1234,7 +1234,7 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window
1234EAPI 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); 1234EAPI 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);
1235 1235
1236/** 1236/**
1237 * @brief Get the window from Ecore_Evas using opengl x11. 1237 * @brief Gets the window from Ecore_Evas using opengl x11.
1238 * @note If ecore is not compiled with support for x11 or if @p ee was not 1238 * @note If ecore is not compiled with support for x11 or if @p ee was not
1239 * created with ecore_evas_gl_x11_new() then nothing is done and 1239 * created with ecore_evas_gl_x11_new() then nothing is done and
1240 * 0 is returned. 1240 * 0 is returned.
@@ -1244,23 +1244,23 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_
1244EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); 1244EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
1245 1245
1246/** 1246/**
1247 * @brief Set direct_resize for Ecore_Evas using opengl x11. 1247 * @brief Sets direct_resize for Ecore_Evas using opengl x11.
1248 * @note If ecore is not compiled with support to x11 then nothing is done. 1248 * @note If ecore is not compiled with support to x11 then nothing is done.
1249 * @param ee The Ecore_Evas in which to set direct resize. 1249 * @param ee The Ecore_Evas in which to set direct resize.
1250 * @param on Enables the resize of Ecore_Evas if equals EINA_TRUE, disables if equals EINA_FALSE. 1250 * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
1251 */ 1251 */
1252EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); 1252EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on);
1253 1253
1254/** 1254/**
1255 * @brief Get if the Ecore_Evas is being directly resized using opengl x11. 1255 * @brief Gets if the Ecore_Evas is being directly resized using opengl x11.
1256 * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned. 1256 * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned.
1257 * @param ee The Ecore_Evas from which to get direct resize. 1257 * @param ee The Ecore_Evas from which to get direct resize.
1258 * @return EINA_TRUE if the resize was managed directly, otherwise return EINA_FALSE. 1258 * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
1259 */ 1259 */
1260EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); 1260EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
1261 1261
1262/** 1262/**
1263 * @brief Add extra window on Ecore_Evas using opengl x11. 1263 * @brief Adds extra window on Ecore_Evas using opengl x11.
1264 * @note If ecore is not compiled with support to x11 then nothing is done. 1264 * @note If ecore is not compiled with support to x11 then nothing is done.
1265 * @param ee The Ecore_Evas for which to add the window. 1265 * @param ee The Ecore_Evas for which to add the window.
1266 * @param win The window to be added at the Ecore_Evas. 1266 * @param win The window to be added at the Ecore_Evas.
@@ -1268,7 +1268,7 @@ EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
1268EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); 1268EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win);
1269 1269
1270/** 1270/**
1271 * @brief Set the functions to be used before and after the swap callback. 1271 * @brief Sets the functions to be used before and after the swap callback.
1272 * @note If ecore is not compiled with support to x11 then nothing is done and the function is returned. 1272 * @note If ecore is not compiled with support to x11 then nothing is done and the function is returned.
1273 * @param ee The Ecore_Evas for which to set the swap callback. 1273 * @param ee The Ecore_Evas for which to set the swap callback.
1274 * @param data The data for which to set the swap callback. 1274 * @param data The data for which to set the swap callback.
@@ -1278,8 +1278,8 @@ EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ec
1278EAPI 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)); 1278EAPI 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));
1279 1279
1280/** 1280/**
1281 * @brief Create a new Ecore_Evas which does not contain an XWindow. It will 1281 * @brief Creates a new Ecore_Evas which does not contain an XWindow. It will
1282 * only contain an XPixmap to render to 1282 * only contain an XPixmap to render to.
1283 * 1283 *
1284 * @warning The XPixmap ID can change with every frame after it is rendered, 1284 * @warning The XPixmap ID can change with every frame after it is rendered,
1285 * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you 1285 * so you should ALWAYS call ecore_evas_software_x11_pixmap_get when you
@@ -1290,7 +1290,7 @@ EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Ev
1290EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); 1290EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h);
1291 1291
1292/** 1292/**
1293 * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas 1293 * @brief Returns the underlying Ecore_X_Pixmap used in the Ecore_Evas.
1294 * 1294 *
1295 * @param ee The Ecore_Evas whose pixmap is desired. 1295 * @param ee The Ecore_Evas whose pixmap is desired.
1296 * @return The underlying Ecore_X_Pixmap 1296 * @return The underlying Ecore_X_Pixmap
@@ -1325,7 +1325,7 @@ EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Ev
1325EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED; 1325EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED;
1326 1326
1327/** 1327/**
1328 * @brief Create Ecore_Evas using fb backend. 1328 * @brief Creates Ecore_Evas using fb backend.
1329 * @param disp_name The name of the display to be used. 1329 * @param disp_name The name of the display to be used.
1330 * @param rotation The rotation to be used. 1330 * @param rotation The rotation to be used.
1331 * @param w The width of the Ecore_Evas to be created. 1331 * @param w The width of the Ecore_Evas to be created.
@@ -1354,7 +1354,7 @@ EAPI Ecore_Evas *ecore_evas_drm_new(const char *device, unsigned int parent,
1354EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** @since 1.12 */ 1354EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int parent, int x, int y, int w, int h); /** @since 1.12 */
1355 1355
1356/** 1356/**
1357 * @brief Create a new @c Ecore_Evas canvas bound to the Evas 1357 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas.
1358 * @b buffer engine 1358 * @b buffer engine
1359 * 1359 *
1360 * @param w The width of the canvas, in pixels 1360 * @param w The width of the canvas, in pixels
@@ -1377,7 +1377,7 @@ EAPI Ecore_Evas *ecore_evas_gl_drm_new(const char *device, unsigned int pare
1377EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h); 1377EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
1378 1378
1379/** 1379/**
1380 * @brief Create a new @c Ecore_Evas canvas bound to the Evas 1380 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas.
1381 * @b buffer engine, giving custom allocation and freeing functions for 1381 * @b buffer engine, giving custom allocation and freeing functions for
1382 * the canvas memory region 1382 * the canvas memory region
1383 * 1383 *
@@ -1413,7 +1413,7 @@ EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h);
1413EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc_func) (void *data, int size), void (*free_func) (void *data, void *pix), const void *data); 1413EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc_func) (void *data, int size), void (*free_func) (void *data, void *pix), const void *data);
1414 1414
1415/** 1415/**
1416 * @brief Grab a pointer to the actual pixels array of a given 1416 * @brief Grabs a pointer to the actual pixels array of a given
1417 * @c Ecore_Evas @b buffer canvas/window. 1417 * @c Ecore_Evas @b buffer canvas/window.
1418 * 1418 *
1419 * @param ee An @c Ecore_Evas handle 1419 * @param ee An @c Ecore_Evas handle
@@ -1431,7 +1431,7 @@ EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc
1431EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee); 1431EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
1432 1432
1433/** 1433/**
1434 * @brief Return a pointer to the Ecore_Evas parent of the given Ecore_Evas. 1434 * @brief Returns a pointer to the Ecore_Evas parent of the given Ecore_Evas.
1435 * 1435 *
1436 * @param ee An @c Ecore_Evas handle 1436 * @param ee An @c Ecore_Evas handle
1437 * @return A pointer to the Ecore_Evas parent. 1437 * @return A pointer to the Ecore_Evas parent.
@@ -1445,7 +1445,7 @@ EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
1445EAPI Ecore_Evas *ecore_evas_buffer_ecore_evas_parent_get(Ecore_Evas *ee); 1445EAPI Ecore_Evas *ecore_evas_buffer_ecore_evas_parent_get(Ecore_Evas *ee);
1446 1446
1447/** 1447/**
1448 * @brief Create a new @c Ecore_Evas canvas bound to the Evas 1448 * @brief Creates a new @c Ecore_Evas canvas bound to the Evas
1449 * @b ews (Ecore + Evas Single Process Windowing System) engine 1449 * @b ews (Ecore + Evas Single Process Windowing System) engine
1450 * 1450 *
1451 * EWS is a simple single process windowing system. The backing store 1451 * EWS is a simple single process windowing system. The backing store
@@ -1458,8 +1458,8 @@ EAPI Ecore_Evas *ecore_evas_buffer_ecore_evas_parent_get(Ecore_Evas *ee);
1458 * ecore_evas_new("ews"...)) will all be software buffer windows 1458 * ecore_evas_new("ews"...)) will all be software buffer windows
1459 * automatic rendered to the backing store. 1459 * automatic rendered to the backing store.
1460 * 1460 *
1461 * @param x horizontal position of window, in pixels 1461 * @param x Horizontal position of window, in pixels
1462 * @param y vertical position of window, in pixels 1462 * @param y Vertical position of window, in pixels
1463 * @param w The width of the canvas, in pixels 1463 * @param w The width of the canvas, in pixels
1464 * @param h The height of the canvas, in pixels 1464 * @param h The height of the canvas, in pixels
1465 * @return A new @c Ecore_Evas instance or @c NULL, on failure 1465 * @return A new @c Ecore_Evas instance or @c NULL, on failure
@@ -1473,7 +1473,7 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
1473 1473
1474 1474
1475/** 1475/**
1476 * @brief Return the backing store image object that represents the given 1476 * @brief Returns the backing store image object that represents the given
1477 * window in EWS. 1477 * window in EWS.
1478 * @return The evas object of EWS backing store. 1478 * @return The evas object of EWS backing store.
1479 * 1479 *
@@ -1489,8 +1489,8 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h);
1489EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); 1489EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
1490 1490
1491/** 1491/**
1492 * @brief Call the window to be deleted (freed), but can let user decide to 1492 * @brief Calls the window to be deleted (freed), but can let user decide to
1493 * forbid it by using ecore_evas_callback_delete_request_set() 1493 * forbid it by using ecore_evas_callback_delete_request_set().
1494 * 1494 *
1495 * @param ee The Ecore_Evas for which window will be deleted. 1495 * @param ee The Ecore_Evas for which window will be deleted.
1496 * @since 1.1 1496 * @since 1.1
@@ -1498,7 +1498,7 @@ EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee);
1498EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); 1498EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
1499 1499
1500/** 1500/**
1501 * @brief Create an Evas image object with image data <b>bound to an 1501 * @brief Creates an Evas image object with image data <b>bound to an
1502 * own, internal @c Ecore_Evas canvas wrapper</b> 1502 * own, internal @c Ecore_Evas canvas wrapper</b>
1503 * 1503 *
1504 * @param ee_target @c Ecore_Evas to have the canvas receiving the new 1504 * @param ee_target @c Ecore_Evas to have the canvas receiving the new
@@ -1543,8 +1543,8 @@ EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
1543EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target); 1543EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target);
1544 1544
1545/** 1545/**
1546 * @brief Retrieve the internal @c Ecore_Evas handle of an image 1546 * @brief Retrieves the internal @c Ecore_Evas handle of an image
1547 * object created via ecore_evas_object_image_new() 1547 * object created via ecore_evas_object_image_new().
1548 * 1548 *
1549 * @param obj A handle to an image object created via 1549 * @param obj A handle to an image object created via
1550 * ecore_evas_object_image_new() 1550 * ecore_evas_object_image_new()
@@ -1641,16 +1641,16 @@ EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h);
1641 1641
1642/* generic manipulation calls */ 1642/* generic manipulation calls */
1643/** 1643/**
1644 * @brief Get the engine name used by this Ecore_Evas(window). 1644 * @brief Gets the engine name used by this Ecore_Evas(window).
1645 * 1645 *
1646 * @param ee Ecore_Evas whose engine's name is desired. 1646 * @param ee Ecore_Evas whose engine's name is desired
1647 * @return A string that can(usually) be used in ecore_evas_new() 1647 * @return A string that can(usually) be used in ecore_evas_new()
1648 * 1648 *
1649 * @see ecore_evas_free() 1649 * @see ecore_evas_free()
1650 */ 1650 */
1651EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee); 1651EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
1652/** 1652/**
1653 * @brief Return the Ecore_Evas for this Evas 1653 * @brief Returns the Ecore_Evas for this Evas.
1654 * 1654 *
1655 * @param e The Evas to get the Ecore_Evas from 1655 * @param e The Evas to get the Ecore_Evas from
1656 * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one. 1656 * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one.
@@ -1659,7 +1659,7 @@ EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee);
1659 */ 1659 */
1660EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); 1660EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
1661/** 1661/**
1662 * @brief Free an Ecore_Evas 1662 * @brief Frees an Ecore_Evas.
1663 * 1663 *
1664 * @param ee The Ecore_Evas to free 1664 * @param ee The Ecore_Evas to free
1665 * 1665 *
@@ -1667,7 +1667,7 @@ EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e);
1667 */ 1667 */
1668EAPI void ecore_evas_free(Ecore_Evas *ee); 1668EAPI void ecore_evas_free(Ecore_Evas *ee);
1669/** 1669/**
1670 * @brief Retrieve user data associated with an Ecore_Evas. 1670 * @brief Retrieves user data associated with an Ecore_Evas.
1671 * 1671 *
1672 * @param ee The Ecore_Evas to retrieve the user data from. 1672 * @param ee The Ecore_Evas to retrieve the user data from.
1673 * @param key The key which the user data to be retrieved is associated with. 1673 * @param key The key which the user data to be retrieved is associated with.
@@ -1675,14 +1675,14 @@ EAPI void ecore_evas_free(Ecore_Evas *ee);
1675 * This function retrieves user specific data that has been stored within an 1675 * This function retrieves user specific data that has been stored within an
1676 * Ecore_Evas structure with ecore_evas_data_set(). 1676 * Ecore_Evas structure with ecore_evas_data_set().
1677 * 1677 *
1678 * @returns @c NULL on error or no data found, A pointer to the user data on 1678 * @return @c NULL on error or no data found, A pointer to the user data on
1679 * success. 1679 * success.
1680 * 1680 *
1681 * @see ecore_evas_data_set() 1681 * @see ecore_evas_data_set()
1682 */ 1682 */
1683EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); 1683EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
1684/** 1684/**
1685 * @brief Store user data in an Ecore_Evas structure. 1685 * @brief Stores user data in an Ecore_Evas structure.
1686 * 1686 *
1687 * @param ee The Ecore_Evas to store the user data in. 1687 * @param ee The Ecore_Evas to store the user data in.
1688 * @param key A unique string to associate the user data against. Cannot 1688 * @param key A unique string to associate the user data against. Cannot
@@ -1700,7 +1700,7 @@ EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key);
1700 */ 1700 */
1701EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data); 1701EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data);
1702/** 1702/**
1703 * @brief Set a callback for Ecore_Evas resize events. 1703 * @brief Sets a callback for Ecore_Evas resize events.
1704 * @param ee The Ecore_Evas to set callbacks on 1704 * @param ee The Ecore_Evas to set callbacks on
1705 * @param func The function to call 1705 * @param func The function to call
1706 1706
@@ -1712,7 +1712,7 @@ EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void
1712 */ 1712 */
1713EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1713EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1714/** 1714/**
1715 * @brief Set a callback for Ecore_Evas move events. 1715 * @brief Sets a callback for Ecore_Evas move events.
1716 * @param ee The Ecore_Evas to set callbacks on 1716 * @param ee The Ecore_Evas to set callbacks on
1717 * @param func The function to call 1717 * @param func The function to call
1718 1718
@@ -1724,7 +1724,7 @@ EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event
1724 */ 1724 */
1725EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1725EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1726/** 1726/**
1727 * @brief Set a callback for Ecore_Evas show events. 1727 * @brief Sets a callback for Ecore_Evas show events.
1728 * @param ee The Ecore_Evas to set callbacks on 1728 * @param ee The Ecore_Evas to set callbacks on
1729 * @param func The function to call 1729 * @param func The function to call
1730 1730
@@ -1736,7 +1736,7 @@ EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_C
1736 */ 1736 */
1737EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1737EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1738/** 1738/**
1739 * @brief Set a callback for Ecore_Evas hide events. 1739 * @brief Sets a callback for Ecore_Evas hide events.
1740 * @param ee The Ecore_Evas to set callbacks on 1740 * @param ee The Ecore_Evas to set callbacks on
1741 * @param func The function to call 1741 * @param func The function to call
1742 1742
@@ -1748,7 +1748,7 @@ EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_C
1748 */ 1748 */
1749EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1749EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1750/** 1750/**
1751 * @brief Set a callback for Ecore_Evas delete request events. 1751 * @brief Sets a callback for Ecore_Evas delete request events.
1752 * @param ee The Ecore_Evas to set callbacks on 1752 * @param ee The Ecore_Evas to set callbacks on
1753 * @param func The function to call 1753 * @param func The function to call
1754 1754
@@ -1760,7 +1760,7 @@ EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_C
1760 */ 1760 */
1761EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1761EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1762/** 1762/**
1763 * @brief Set a callback for Ecore_Evas destroy events. 1763 * @brief Sets a callback for Ecore_Evas destroy events.
1764 * @param ee The Ecore_Evas to set callbacks on 1764 * @param ee The Ecore_Evas to set callbacks on
1765 * @param func The function to call 1765 * @param func The function to call
1766 1766
@@ -1772,7 +1772,7 @@ EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Ev
1772 */ 1772 */
1773EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1773EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1774/** 1774/**
1775 * @brief Set a callback for Ecore_Evas focus in events. 1775 * @brief Sets a callback for Ecore_Evas focus in events.
1776 * @param ee The Ecore_Evas to set callbacks on 1776 * @param ee The Ecore_Evas to set callbacks on
1777 * @param func The function to call 1777 * @param func The function to call
1778 1778
@@ -1786,7 +1786,7 @@ EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Even
1786 */ 1786 */
1787EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1787EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1788/** 1788/**
1789 * @brief Set a callback for Ecore_Evas focus out events. 1789 * @brief Sets a callback for Ecore_Evas focus out events.
1790 * @param ee The Ecore_Evas to set callbacks on 1790 * @param ee The Ecore_Evas to set callbacks on
1791 * @param func The function to call 1791 * @param func The function to call
1792 1792
@@ -1800,7 +1800,7 @@ EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Eve
1800 */ 1800 */
1801EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1801EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1802/** 1802/**
1803 * @brief Set a callback for Ecore_Evas focus in events. 1803 * @brief Sets a callback for Ecore_Evas focus in events.
1804 * @param ee The Ecore_Evas to set callbacks on 1804 * @param ee The Ecore_Evas to set callbacks on
1805 * @param func The function to call 1805 * @param func The function to call
1806 1806
@@ -1814,7 +1814,7 @@ EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Ev
1814 */ 1814 */
1815EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); 1815EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func);
1816/** 1816/**
1817 * @brief Set a callback for Ecore_Evas focus out events. 1817 * @brief Sets a callback for Ecore_Evas focus out events.
1818 * @param ee The Ecore_Evas to set callbacks on 1818 * @param ee The Ecore_Evas to set callbacks on
1819 * @param func The function to call 1819 * @param func The function to call
1820 1820
@@ -1828,7 +1828,7 @@ EAPI void ecore_evas_callback_focus_device_in_set(Ecore_Evas *ee, Ecore_E
1828 */ 1828 */
1829EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func); 1829EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_Evas_Focus_Device_Event_Cb func);
1830/** 1830/**
1831 * @brief Set a callback for Ecore_Evas sticky events. 1831 * @brief Sets a callback for Ecore_Evas sticky events.
1832 * @param ee The Ecore_Evas to set callbacks on 1832 * @param ee The Ecore_Evas to set callbacks on
1833 * @param func The function to call 1833 * @param func The function to call
1834 1834
@@ -1840,7 +1840,7 @@ EAPI void ecore_evas_callback_focus_device_out_set(Ecore_Evas *ee, Ecore_
1840 */ 1840 */
1841EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1841EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1842/** 1842/**
1843 * @brief Set a callback for Ecore_Evas un-sticky events. 1843 * @brief Sets a callback for Ecore_Evas un-sticky events.
1844 * @param ee The Ecore_Evas to set callbacks on 1844 * @param ee The Ecore_Evas to set callbacks on
1845 * @param func The function to call 1845 * @param func The function to call
1846 1846
@@ -1852,7 +1852,7 @@ EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event
1852 */ 1852 */
1853EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1853EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1854/** 1854/**
1855 * @brief Set a callback for Ecore_Evas mouse in events. 1855 * @brief Sets a callback for Ecore_Evas mouse in events.
1856 * @param ee The Ecore_Evas to set callbacks on 1856 * @param ee The Ecore_Evas to set callbacks on
1857 * @param func The function to call 1857 * @param func The function to call
1858 1858
@@ -1865,7 +1865,7 @@ EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Eve
1865 */ 1865 */
1866EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); 1866EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func);
1867/** 1867/**
1868 * @brief Set a callback for Ecore_Evas mouse out events. 1868 * @brief Sets a callback for Ecore_Evas mouse out events.
1869 * @param ee The Ecore_Evas to set callbacks on 1869 * @param ee The Ecore_Evas to set callbacks on
1870 * @param func The function to call 1870 * @param func The function to call
1871 1871
@@ -1878,7 +1878,7 @@ EAPI void ecore_evas_callback_device_mouse_in_set(Ecore_Evas *ee, Ecore_E
1878 */ 1878 */
1879EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func); 1879EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Mouse_IO_Cb func);
1880/** 1880/**
1881 * @brief Set a callback for Ecore_Evas mouse in events. 1881 * @brief Sets a callback for Ecore_Evas mouse in events.
1882 * @param ee The Ecore_Evas to set callbacks on 1882 * @param ee The Ecore_Evas to set callbacks on
1883 * @param func The function to call 1883 * @param func The function to call
1884 1884
@@ -1892,7 +1892,7 @@ EAPI void ecore_evas_callback_device_mouse_out_set(Ecore_Evas *ee, Ecore_
1892 */ 1892 */
1893EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1893EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1894/** 1894/**
1895 * @brief Set a callback for Ecore_Evas mouse out events. 1895 * @brief Sets a callback for Ecore_Evas mouse out events.
1896 * @param ee The Ecore_Evas to set callbacks on 1896 * @param ee The Ecore_Evas to set callbacks on
1897 * @param func The function to call 1897 * @param func The function to call
1898 1898
@@ -1906,7 +1906,7 @@ EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Eve
1906 */ 1906 */
1907EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1907EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1908/** 1908/**
1909 * @brief Set a callback for Ecore_Evas pre render events. 1909 * @brief Sets a callback for Ecore_Evas pre render events.
1910 * @param ee The Ecore_Evas to set callbacks on 1910 * @param ee The Ecore_Evas to set callbacks on
1911 * @param func The function to call 1911 * @param func The function to call
1912 1912
@@ -1918,7 +1918,7 @@ EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Ev
1918 */ 1918 */
1919EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1919EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1920/** 1920/**
1921 * @brief Set a callback for Ecore_Evas mouse post render events. 1921 * @brief Sets a callback for Ecore_Evas mouse post render events.
1922 * @param ee The Ecore_Evas to set callbacks on 1922 * @param ee The Ecore_Evas to set callbacks on
1923 * @param func The function to call 1923 * @param func The function to call
1924 1924
@@ -1930,7 +1930,7 @@ EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_E
1930 */ 1930 */
1931EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1931EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1932/** 1932/**
1933 * @brief Set a callback for Ecore_Evas pre-free event. 1933 * @brief Sets a callback for Ecore_Evas pre-free event.
1934 * @param ee The Ecore_Evas to set callbacks on 1934 * @param ee The Ecore_Evas to set callbacks on
1935 * @param func The function to call 1935 * @param func The function to call
1936 * 1936 *
@@ -1942,7 +1942,7 @@ EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_
1942 */ 1942 */
1943EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1943EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1944/** 1944/**
1945 * @brief Set a callback for Ecore_Evas state changes. 1945 * @brief Sets a callback for Ecore_Evas state changes.
1946 * @param ee The Ecore_Evas to set callbacks on 1946 * @param ee The Ecore_Evas to set callbacks on
1947 * @param func The function to call 1947 * @param func The function to call
1948 1948
@@ -1956,7 +1956,7 @@ EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Eve
1956EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); 1956EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func);
1957 1957
1958/** 1958/**
1959 * @brief Get an Ecore_Evas's Evas 1959 * @brief Gets an Ecore_Evas's Evas.
1960 * @param ee The Ecore_Evas whose Evas you wish to get 1960 * @param ee The Ecore_Evas whose Evas you wish to get
1961 * @return The Evas wrapped by @p ee 1961 * @return The Evas wrapped by @p ee
1962 * 1962 *
@@ -1965,7 +1965,7 @@ EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas
1965EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); 1965EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
1966 1966
1967/** 1967/**
1968 * @brief Provide Managed move co-ordinates for an Ecore_Evas 1968 * @brief Provides Managed move co-ordinates for an Ecore_Evas.
1969 * @param ee The Ecore_Evas to move 1969 * @param ee The Ecore_Evas to move
1970 * @param x The x coordinate to set as the managed location 1970 * @param x The x coordinate to set as the managed location
1971 * @param y The y coordinate to set as the managed location 1971 * @param y The y coordinate to set as the managed location
@@ -1975,7 +1975,7 @@ EAPI Evas *ecore_evas_get(const Ecore_Evas *ee);
1975EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y); 1975EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
1976 1976
1977/** 1977/**
1978 * @brief Set whether an Ecore_Evas is shaped or not. 1978 * @brief Sets whether an Ecore_Evas is shaped or not.
1979 * 1979 *
1980 * @param ee The Ecore_Evas to shape. 1980 * @param ee The Ecore_Evas to shape.
1981 * @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not. 1981 * @param shaped @c EINA_TRUE to shape, @c EINA_FALSE to not.
@@ -1990,7 +1990,7 @@ EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y);
1990EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped); 1990EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
1991 1991
1992/** 1992/**
1993 * @brief Query whether an Ecore_Evas is shaped or not. 1993 * @brief Queries whether an Ecore_Evas is shaped or not.
1994 * 1994 *
1995 * @param ee The Ecore_Evas to query. 1995 * @param ee The Ecore_Evas to query.
1996 * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not. 1996 * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not.
@@ -1999,7 +1999,7 @@ EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped);
1999 */ 1999 */
2000EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); 2000EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
2001/** 2001/**
2002 * @brief Show an Ecore_Evas' window 2002 * @brief Shows an Ecore_Evas' window.
2003 * 2003 *
2004 * @param ee The Ecore_Evas to show. 2004 * @param ee The Ecore_Evas to show.
2005 * 2005 *
@@ -2007,7 +2007,7 @@ EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee);
2007 */ 2007 */
2008EAPI void ecore_evas_show(Ecore_Evas *ee); 2008EAPI void ecore_evas_show(Ecore_Evas *ee);
2009/** 2009/**
2010 * @brief Hide an Ecore_Evas' window 2010 * @brief Hides an Ecore_Evas' window.
2011 * 2011 *
2012 * @param ee The Ecore_Evas to hide. 2012 * @param ee The Ecore_Evas to hide.
2013 * 2013 *
@@ -2016,7 +2016,7 @@ EAPI void ecore_evas_show(Ecore_Evas *ee);
2016EAPI void ecore_evas_hide(Ecore_Evas *ee); 2016EAPI void ecore_evas_hide(Ecore_Evas *ee);
2017 2017
2018/** 2018/**
2019 * @brief Activate (set focus to, via the window manager) an Ecore_Evas' window. 2019 * @brief Activates (set focus to, via the window manager) an Ecore_Evas' window.
2020 * @param ee The Ecore_Evas to activate. 2020 * @param ee The Ecore_Evas to activate.
2021 * 2021 *
2022 * This functions activates the Ecore_Evas. 2022 * This functions activates the Ecore_Evas.
@@ -2025,7 +2025,7 @@ EAPI void ecore_evas_activate(Ecore_Evas *ee);
2025 2025
2026 2026
2027/** 2027/**
2028 * @brief Set the minimum size of a given @c Ecore_Evas window 2028 * @brief Sets the minimum size of a given @c Ecore_Evas window.
2029 * 2029 *
2030 * @param ee An @c Ecore_Evas window's handle 2030 * @param ee An @c Ecore_Evas window's handle
2031 * @param w The minimum width 2031 * @param w The minimum width
@@ -2044,7 +2044,7 @@ EAPI void ecore_evas_activate(Ecore_Evas *ee);
2044EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h); 2044EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
2045 2045
2046/** 2046/**
2047 * @brief Get the minimum size set for a given @c Ecore_Evas window 2047 * @brief Gets the minimum size set for a given @c Ecore_Evas window.
2048 * 2048 *
2049 * @param ee An @c Ecore_Evas window's handle 2049 * @param ee An @c Ecore_Evas window's handle
2050 * @param w A pointer to an int to place the minimum width in. 2050 * @param w A pointer to an int to place the minimum width in.
@@ -2058,7 +2058,7 @@ EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h);
2058EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h); 2058EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
2059 2059
2060/** 2060/**
2061 * @brief Set the maximum size of a given @c Ecore_Evas window 2061 * @brief Sets the maximum size of a given @c Ecore_Evas window.
2062 * 2062 *
2063 * @param ee An @c Ecore_Evas window's handle 2063 * @param ee An @c Ecore_Evas window's handle
2064 * @param w The maximum width 2064 * @param w The maximum width
@@ -2073,7 +2073,7 @@ EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h);
2073EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h); 2073EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
2074 2074
2075/** 2075/**
2076 * @brief Get the maximum size set for a given @c Ecore_Evas window 2076 * @brief Gets the maximum size set for a given @c Ecore_Evas window.
2077 * 2077 *
2078 * @param ee An @c Ecore_Evas window's handle 2078 * @param ee An @c Ecore_Evas window's handle
2079 * @param w A pointer to an int to place the maximum width in. 2079 * @param w A pointer to an int to place the maximum width in.
@@ -2087,7 +2087,7 @@ EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h);
2087EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h); 2087EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
2088 2088
2089/** 2089/**
2090 * @brief Set the base size for a given @c Ecore_Evas window 2090 * @brief Sets the base size for a given @c Ecore_Evas window.
2091 * 2091 *
2092 * @param ee An @c Ecore_Evas window's handle 2092 * @param ee An @c Ecore_Evas window's handle
2093 * @param w The base width 2093 * @param w The base width
@@ -2102,7 +2102,7 @@ EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h);
2102EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h); 2102EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
2103 2103
2104/** 2104/**
2105 * @brief Get the base size set for a given @c Ecore_Evas window 2105 * @brief Gets the base size set for a given @c Ecore_Evas window.
2106 * 2106 *
2107 * @param ee An @c Ecore_Evas window's handle 2107 * @param ee An @c Ecore_Evas window's handle
2108 * @param w A pointer to an int to place the base width in. 2108 * @param w A pointer to an int to place the base width in.
@@ -2116,7 +2116,7 @@ EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h);
2116EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h); 2116EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
2117 2117
2118/** 2118/**
2119 * @brief Set the "size step" for a given @c Ecore_Evas window 2119 * @brief Sets the "size step" for a given @c Ecore_Evas window.
2120 * 2120 *
2121 * @param ee An @c Ecore_Evas window's handle 2121 * @param ee An @c Ecore_Evas window's handle
2122 * @param w The step width 2122 * @param w The step width
@@ -2129,7 +2129,7 @@ EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h);
2129EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h); 2129EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
2130 2130
2131/** 2131/**
2132 * @brief Get the "size step" set for a given @c Ecore_Evas window 2132 * @brief Gets the "size step" set for a given @c Ecore_Evas window.
2133 * 2133 *
2134 * @param ee An @c Ecore_Evas window's handle 2134 * @param ee An @c Ecore_Evas window's handle
2135 * @param w A pointer to an int to place the step width in. 2135 * @param w A pointer to an int to place the step width in.
@@ -2143,7 +2143,7 @@ EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h);
2143EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h); 2143EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
2144 2144
2145/** 2145/**
2146 * @brief Set the cursor for the default pointer device. 2146 * @brief Sets the cursor for the default pointer device.
2147 * 2147 *
2148 * @param ee The Ecore_Evas 2148 * @param ee The Ecore_Evas
2149 * @param file The path to an image file for the cursor. 2149 * @param file The path to an image file for the cursor.
@@ -2166,7 +2166,7 @@ EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h);
2166 */ 2166 */
2167EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y); 2167EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y);
2168/** 2168/**
2169 * @brief Get information about an Ecore_Evas' default pointer device. 2169 * @brief Gets information about an Ecore_Evas' default pointer device.
2170 * 2170 *
2171 * @param ee The Ecore_Evas to get 2171 * @param ee The Ecore_Evas to get
2172 * @param obj A pointer to an Evas_Object to place the cursor Evas_Object. 2172 * @param obj A pointer to an Evas_Object to place the cursor Evas_Object.
@@ -2183,7 +2183,7 @@ EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int lay
2183EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y); 2183EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y);
2184 2184
2185/** 2185/**
2186 * @brief Set the cursor for the default pointer device. 2186 * @brief Sets the cursor for the default pointer device.
2187 * 2187 *
2188 * @param ee The Ecore_Evas 2188 * @param ee The Ecore_Evas
2189 * @param obj The Evas_Object which will be the cursor. 2189 * @param obj The Evas_Object which will be the cursor.
@@ -2201,7 +2201,7 @@ EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj,
2201EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y); 2201EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, int layer, int hot_x, int hot_y);
2202 2202
2203/** 2203/**
2204 * @brief Unset the cursor of the default pointer device. 2204 * @brief Unsets the cursor of the default pointer device.
2205 * 2205 *
2206 * @param ee The Ecore_Evas to unset the cursor. 2206 * @param ee The Ecore_Evas to unset the cursor.
2207 * 2207 *
@@ -2217,7 +2217,7 @@ EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj,
2217EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee); 2217EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee);
2218 2218
2219/** 2219/**
2220 * @brief Set the cursor of an Ecore_Evas specified pointer device. 2220 * @brief Sets the cursor of an Ecore_Evas specified pointer device.
2221 * 2221 *
2222 * @param ee The Ecore_Evas 2222 * @param ee The Ecore_Evas
2223 * @param pointer A pointer device to set the cursor. Use @c NULL for the default. 2223 * @param pointer A pointer device to set the cursor. Use @c NULL for the default.
@@ -2237,7 +2237,7 @@ EAPI void ecore_evas_object_cursor_device_set(Ecore_Evas *ee, Efl_Input_Device *
2237 Evas_Object *obj, int layer, 2237 Evas_Object *obj, int layer,
2238 int hot_x, int hot_y); 2238 int hot_x, int hot_y);
2239/** 2239/**
2240 * @brief Get information about an Ecore_Evas' specified pointer device. 2240 * @brief Gets information about an Ecore_Evas' specified pointer device.
2241 * 2241 *
2242 * @param ee The Ecore_Evas 2242 * @param ee The Ecore_Evas
2243 * @param pointer A pointer device to set the cursor. Use @c NULL for the default. 2243 * @param pointer A pointer device to set the cursor. Use @c NULL for the default.
@@ -2256,7 +2256,7 @@ EAPI Eina_Bool ecore_evas_cursor_device_get(const Ecore_Evas *ee, Efl_Input_Devi
2256 int *hot_x, int *hot_y); 2256 int *hot_x, int *hot_y);
2257 2257
2258/** 2258/**
2259 * @brief Tell the WM whether or not to ignore an Ecore_Evas' window 2259 * @brief Tells the WM whether or not to ignore an Ecore_Evas' window.
2260 * 2260 *
2261 * @param ee The Ecore_Evas. 2261 * @param ee The Ecore_Evas.
2262 * @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not. 2262 * @param on @c EINA_TRUE to ignore, @c EINA_FALSE to not.
@@ -2267,7 +2267,7 @@ EAPI Eina_Bool ecore_evas_cursor_device_get(const Ecore_Evas *ee, Efl_Input_Devi
2267EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on); 2267EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
2268 2268
2269/** 2269/**
2270 * @brief Query whether an Ecore_Evas' window is overridden or not 2270 * @brief Queries whether an Ecore_Evas' window is overridden or not.
2271 * 2271 *
2272 * @param ee The Ecore_Evas to set. 2272 * @param ee The Ecore_Evas to set.
2273 * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not. 2273 * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not.
@@ -2275,7 +2275,7 @@ EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on);
2275EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee); 2275EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
2276 2276
2277/** 2277/**
2278 * @brief Set whether or not an Ecore_Evas' window should avoid damage 2278 * @brief Sets whether or not an Ecore_Evas' window should avoid damage.
2279 * 2279 *
2280 * @param ee The Ecore_Evas 2280 * @param ee The Ecore_Evas
2281 * @param on The type of the damage management 2281 * @param on The type of the damage management
@@ -2303,7 +2303,7 @@ EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee);
2303EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on); 2303EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on);
2304 2304
2305/** 2305/**
2306 * @brief Query whether an Ecore_Evas' window avoids damage or not 2306 * @brief Queries whether an Ecore_Evas' window avoids damage or not.
2307 * @param ee The Ecore_Evas to set 2307 * @param ee The Ecore_Evas to set
2308 * @return The type of the damage management 2308 * @return The type of the damage management
2309 * 2309 *
@@ -2311,7 +2311,7 @@ EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Da
2311EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee); 2311EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee);
2312 2312
2313/** 2313/**
2314 * @brief Set the withdrawn state of an Ecore_Evas' window. 2314 * @brief Sets the withdrawn state of an Ecore_Evas' window.
2315 * @param ee The Ecore_Evas whose window's withdrawn state is set. 2315 * @param ee The Ecore_Evas whose window's withdrawn state is set.
2316 * @param withdrawn The Ecore_Evas window's new withdrawn state. 2316 * @param withdrawn The Ecore_Evas window's new withdrawn state.
2317 * 2317 *
@@ -2319,7 +2319,7 @@ EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *
2319EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); 2319EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
2320 2320
2321/** 2321/**
2322 * @brief Return the withdrawn state of an Ecore_Evas' window. 2322 * @brief Returns the withdrawn state of an Ecore_Evas' window.
2323 * @param ee The Ecore_Evas whose window's withdrawn state is returned. 2323 * @param ee The Ecore_Evas whose window's withdrawn state is returned.
2324 * @return The Ecore_Evas window's withdrawn state. 2324 * @return The Ecore_Evas window's withdrawn state.
2325 * 2325 *
@@ -2327,7 +2327,7 @@ EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn);
2327EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); 2327EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
2328 2328
2329/** 2329/**
2330 * @brief Set the sticky state of an Ecore_Evas window. 2330 * @brief Sets the sticky state of an Ecore_Evas window.
2331 * 2331 *
2332 * @param ee The Ecore_Evas whose window's sticky state is set. 2332 * @param ee The Ecore_Evas whose window's sticky state is set.
2333 * @param sticky The Ecore_Evas window's new sticky state. 2333 * @param sticky The Ecore_Evas window's new sticky state.
@@ -2336,7 +2336,7 @@ EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee);
2336EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); 2336EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
2337 2337
2338/** 2338/**
2339 * @brief Return the sticky state of an Ecore_Evas' window. 2339 * @brief Returns the sticky state of an Ecore_Evas' window.
2340 * 2340 *
2341 * @param ee The Ecore_Evas whose window's sticky state is returned. 2341 * @param ee The Ecore_Evas whose window's sticky state is returned.
2342 * @return The Ecore_Evas window's sticky state. 2342 * @return The Ecore_Evas window's sticky state.
@@ -2345,7 +2345,7 @@ EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky);
2345EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee); 2345EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
2346 2346
2347/** 2347/**
2348 * @brief Enable/disable manual render 2348 * @brief Enables/disables manual render.
2349 * 2349 *
2350 * @param ee An @c Ecore_Evas handle 2350 * @param ee An @c Ecore_Evas handle
2351 * @param manual_render Enable/disable manual render. @c EINA_TRUE to enable 2351 * @param manual_render Enable/disable manual render. @c EINA_TRUE to enable
@@ -2364,7 +2364,7 @@ EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee);
2364EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render); 2364EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render);
2365 2365
2366/** 2366/**
2367 * @brief Get enable/disable status of manual render 2367 * @brief Gets enable/disable status of manual render.
2368 * 2368 *
2369 * @param ee An @c Ecore_Evas handle 2369 * @param ee An @c Ecore_Evas handle
2370 * @return @c EINA_TRUE if manual render is enabled, @c EINA_FALSE if manual 2370 * @return @c EINA_TRUE if manual render is enabled, @c EINA_FALSE if manual
@@ -2376,7 +2376,7 @@ EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_r
2376EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee); 2376EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
2377 2377
2378/** 2378/**
2379 * @brief Register an @c Ecore_Evas to receive events through ecore_input_evas. 2379 * @brief Registers an @c Ecore_Evas to receive events through ecore_input_evas.
2380 * 2380 *
2381 * @param ee The @c Ecore_Evas handle. 2381 * @param ee The @c Ecore_Evas handle.
2382 * 2382 *
@@ -2389,7 +2389,7 @@ EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee);
2389 */ 2389 */
2390EAPI void ecore_evas_input_event_register(Ecore_Evas *ee); 2390EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
2391/** 2391/**
2392 * @brief Unregister an @c Ecore_Evas receiving events through ecore_input_evas. 2392 * @brief Unregisters an @c Ecore_Evas receiving events through ecore_input_evas.
2393 * 2393 *
2394 * @param ee The @c Ecore_Evas handle. 2394 * @param ee The @c Ecore_Evas handle.
2395 * 2395 *
@@ -2399,7 +2399,7 @@ EAPI void ecore_evas_input_event_register(Ecore_Evas *ee);
2399EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee); 2399EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee);
2400 2400
2401/** 2401/**
2402 * @brief Force immediate rendering on a given @c Ecore_Evas window 2402 * @brief Forces immediate rendering on a given @c Ecore_Evas window.
2403 * 2403 *
2404 * @param ee An @c Ecore_Evas handle 2404 * @param ee An @c Ecore_Evas handle
2405 * 2405 *
@@ -2411,20 +2411,20 @@ EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
2411EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); 2411EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
2412 2412
2413/** 2413/**
2414 * @brief Get geometry of screen associated with this Ecore_Evas. 2414 * @brief Gets geometry of screen associated with this Ecore_Evas.
2415 * 2415 *
2416 * @param ee The Ecore_Evas whose window's to query container screen geometry. 2416 * @param ee The Ecore_Evas whose window's to query container screen geometry.
2417 * @param x where to return the horizontal offset value. May be @c NULL. 2417 * @param x Where to return the horizontal offset value. May be @c NULL.
2418 * @param y where to return the vertical offset value. May be @c NULL. 2418 * @param y Where to return the vertical offset value. May be @c NULL.
2419 * @param w where to return the width value. May be @c NULL. 2419 * @param w Where to return the width value. May be @c NULL.
2420 * @param h where to return the height value. May be @c NULL. 2420 * @param h Where to return the height value. May be @c NULL.
2421 * 2421 *
2422 * @since 1.1 2422 * @since 1.1
2423 */ 2423 */
2424EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); 2424EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
2425 2425
2426/** 2426/**
2427 * @brief Get the dpi of the screen the Ecore_Evas is primarily on. 2427 * @brief Gets the dpi of the screen the Ecore_Evas is primarily on.
2428 * 2428 *
2429 * @param ee The Ecore_Evas whose window's to query. 2429 * @param ee The Ecore_Evas whose window's to query.
2430 * @param xdpi Pointer to integer to store horizontal DPI. May be @c NULL. 2430 * @param xdpi Pointer to integer to store horizontal DPI. May be @c NULL.
@@ -2438,7 +2438,7 @@ EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame)
2438EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED; 2438EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED;
2439 2439
2440/** 2440/**
2441 * @brief Set shadow geometry for client-side decorations 2441 * @brief Sets shadow geometry for client-side decorations.
2442 * 2442 *
2443 * Note that the framespace contains both a shadow or glow around the window, 2443 * Note that the framespace contains both a shadow or glow around the window,
2444 * and the window borders (title bar, etc...). 2444 * and the window borders (title bar, etc...).
@@ -2448,7 +2448,7 @@ EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee) EINA_DEPRECATED
2448EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, int w, int h); 2448EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, int w, int h);
2449 2449
2450/** 2450/**
2451 * @brief Get shadow geometry for client-side decorations 2451 * @brief Gets shadow geometry for client-side decorations.
2452 * 2452 *
2453 * Note that the framespace contains both a shadow or glow around the window, 2453 * Note that the framespace contains both a shadow or glow around the window,
2454 * and the window borders (title bar, etc...). 2454 * and the window borders (title bar, etc...).
@@ -2458,7 +2458,7 @@ EAPI void ecore_evas_shadow_geometry_set(Ecore_Evas *ee, int x, int y, in
2458EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); 2458EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h);
2459 2459
2460/** 2460/**
2461 * @brief Associate the given object to this ecore evas. 2461 * @brief Associates the given object to this ecore evas.
2462 * 2462 *
2463 * @param ee The Ecore_Evas to associate to @a obj 2463 * @param ee The Ecore_Evas to associate to @a obj
2464 * @param obj The object to associate to @a ee 2464 * @param obj The object to associate to @a ee
@@ -2500,7 +2500,7 @@ EAPI void ecore_evas_shadow_geometry_get(const Ecore_Evas *ee, int *x, in
2500 */ 2500 */
2501EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags); 2501EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags);
2502/** 2502/**
2503 * @brief Cancel the association set with ecore_evas_object_associate(). 2503 * @brief Cancels the association set with ecore_evas_object_associate().
2504 * 2504 *
2505 * @param ee The Ecore_Evas to dissociate from @a obj 2505 * @param ee The Ecore_Evas to dissociate from @a obj
2506 * @param obj The object to dissociate from @a ee 2506 * @param obj The object to dissociate from @a ee
@@ -2508,7 +2508,7 @@ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj,
2508 */ 2508 */
2509EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); 2509EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj);
2510/** 2510/**
2511 * @brief Get the object associated with @p ee 2511 * @brief Gets the object associated with @p ee.
2512 * 2512 *
2513 * @param ee The Ecore_Evas to get the object from. 2513 * @param ee The Ecore_Evas to get the object from.
2514 * @return The associated object, or @c NULL if there is no associated object. 2514 * @return The associated object, or @c NULL if there is no associated object.
@@ -2519,7 +2519,7 @@ EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee);
2519EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage); 2519EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage);
2520 2520
2521/** 2521/**
2522 * @brief Get a list of all the ecore_evases. 2522 * @brief Gets a list of all the ecore_evases.
2523 * 2523 *
2524 * @return A list of ecore_evases. 2524 * @return A list of ecore_evases.
2525 * 2525 *
@@ -2529,7 +2529,7 @@ EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Get
2529 */ 2529 */
2530EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); 2530EAPI Eina_List *ecore_evas_ecore_evas_list_get(void);
2531/** 2531/**
2532 * @brief Get a list of all the sub ecore_evases. 2532 * @brief Gets a list of all the sub ecore_evases.
2533 * 2533 *
2534 * @param ee Ecore_Evas to get the list from. 2534 * @param ee Ecore_Evas to get the list from.
2535 * @return A list of sub ecore_evases, or @c NULL if there is no sub ecore_evases. 2535 * @return A list of sub ecore_evases, or @c NULL if there is no sub ecore_evases.
@@ -2586,7 +2586,7 @@ EAPI Eina_Bool ecore_evas_vnc_start(Ecore_Evas *ee, const char *addr, int p
2586 Ecore_Evas_Vnc_Client_Disconnected_Cb disc_cb, void *data); 2586 Ecore_Evas_Vnc_Client_Disconnected_Cb disc_cb, void *data);
2587 2587
2588/** 2588/**
2589 * @brief Stop a running VNC server 2589 * @brief Stops a running VNC server
2590 * 2590 *
2591 * @param ee Ecore_Evas to stop the VNC server 2591 * @param ee Ecore_Evas to stop the VNC server
2592 * @return @c EINA_TRUE if the VNC server was stopped, @c EINA_FALSE otherwise. 2592 * @return @c EINA_TRUE if the VNC server was stopped, @c EINA_FALSE otherwise.
@@ -2607,7 +2607,7 @@ EAPI Eina_Bool ecore_evas_vnc_stop(Ecore_Evas *ee);
2607 */ 2607 */
2608 2608
2609/** 2609/**
2610 * @brief Set the engine to be used by the backing store engine. 2610 * @brief Sets the engine to be used by the backing store engine.
2611 * 2611 *
2612 * @param engine The engine to be set. 2612 * @param engine The engine to be set.
2613 * @param options The options of the engine to be set. 2613 * @param options The options of the engine to be set.
@@ -2617,7 +2617,7 @@ EAPI Eina_Bool ecore_evas_vnc_stop(Ecore_Evas *ee);
2617EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); 2617EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options);
2618 2618
2619/** 2619/**
2620 * @brief Reconfigure the backing store used. 2620 * @brief Reconfigures the backing store used.
2621 * 2621 *
2622 * @param x The X coordinate to be used. 2622 * @param x The X coordinate to be used.
2623 * @param y The Y coordinate to be used. 2623 * @param y The Y coordinate to be used.
@@ -2629,7 +2629,7 @@ EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options
2629EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); 2629EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
2630 2630
2631/** 2631/**
2632 * @brief Return the internal backing store in use. 2632 * @brief Returns the internal backing store in use.
2633 * 2633 *
2634 * @return The internal backing store in use. 2634 * @return The internal backing store in use.
2635 * @note this will forced it to be created, making future calls to 2635 * @note this will forced it to be created, making future calls to
@@ -2641,7 +2641,7 @@ EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h);
2641EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); 2641EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
2642 2642
2643/** 2643/**
2644 * @brief Return the internal backing store in use. 2644 * @brief Returns the internal backing store in use.
2645 * 2645 *
2646 * @return The internal backing store in use. 2646 * @return The internal backing store in use.
2647 * @note this will forced it to be created, making future calls to 2647 * @note this will forced it to be created, making future calls to
@@ -2653,12 +2653,12 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void);
2653EAPI Evas *ecore_evas_ews_evas_get(void); 2653EAPI Evas *ecore_evas_ews_evas_get(void);
2654 2654
2655/** 2655/**
2656 * @brief Get the current background. 2656 * @brief Gets the current background.
2657 */ 2657 */
2658EAPI Evas_Object *ecore_evas_ews_background_get(void); 2658EAPI Evas_Object *ecore_evas_ews_background_get(void);
2659 2659
2660/** 2660/**
2661 * @brief Set the current background, must be created at evas ecore_evas_ews_evas_get() 2661 * @brief Sets the current background, must be created at evas ecore_evas_ews_evas_get().
2662 * 2662 *
2663 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below 2663 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below
2664 * everything else. You can set any object, default is a black 2664 * everything else. You can set any object, default is a black
@@ -2670,16 +2670,16 @@ EAPI Evas_Object *ecore_evas_ews_background_get(void);
2670EAPI void ecore_evas_ews_background_set(Evas_Object *o); 2670EAPI void ecore_evas_ews_background_set(Evas_Object *o);
2671 2671
2672/** 2672/**
2673 * @brief Return all Ecore_Evas* created by EWS. 2673 * @brief Returns all Ecore_Evas* created by EWS.
2674 * 2674 *
2675 * @return An eina list of Ecore_evases. 2675 * @return An eina list of Ecore_evases.
2676 e @note Do not change the returned list or its contents. 2676 * @note Do not change the returned list or its contents.
2677 * @since 1.1 2677 * @since 1.1
2678 */ 2678 */
2679EAPI const Eina_List *ecore_evas_ews_children_get(void); 2679EAPI const Eina_List *ecore_evas_ews_children_get(void);
2680 2680
2681/** 2681/**
2682 * @brief Set the identifier of the manager taking care of internal windows. 2682 * @brief Sets the identifier of the manager taking care of internal windows.
2683 * 2683 *
2684 * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider 2684 * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider
2685 * handling it to know if you should stop handling events yourself 2685 * handling it to know if you should stop handling events yourself
@@ -2693,7 +2693,7 @@ EAPI const Eina_List *ecore_evas_ews_children_get(void);
2693EAPI void ecore_evas_ews_manager_set(const void *manager); 2693EAPI void ecore_evas_ews_manager_set(const void *manager);
2694 2694
2695/** 2695/**
2696 * @brief Get the identifier of the manager taking care of internal windows. 2696 * @brief Gets the identifier of the manager taking care of internal windows.
2697 * 2697 *
2698 * @return the value set by ecore_evas_ews_manager_set() 2698 * @return the value set by ecore_evas_ews_manager_set()
2699 * @since 1.1 2699 * @since 1.1
@@ -2742,11 +2742,11 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a p
2742EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */ 2742EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */
2743 2743
2744/** 2744/**
2745 * @brief Create a new Ecore_Evas canvas for the new external ecore evas socket 2745 * @brief Creates a new Ecore_Evas canvas for the new external ecore evas socket
2746 * 2746 *
2747 * @param w The width of the canvas, in pixels 2747 * @param w The width of the canvas, in pixels
2748 * @param h The height of the canvas, in pixels 2748 * @param h The height of the canvas, in pixels
2749 * @return A new @c Ecore_Evas instance or @c NULL, on failure 2749 * @return A new @c Ecore_Evas instance, or @c NULL on failure
2750 * 2750 *
2751 * This creates a new extn_socket canvas wrapper, with image data array 2751 * This creates a new extn_socket canvas wrapper, with image data array
2752 * @b bound to the ARGB format, 8 bits per pixel. 2752 * @b bound to the ARGB format, 8 bits per pixel.
@@ -2812,7 +2812,7 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p
2812 * Note that events come in later after the event happened. You may want to be 2812 * Note that events come in later after the event happened. You may want to be
2813 * careful as data structures you had associated with the image object 2813 * careful as data structures you had associated with the image object
2814 * may have been freed after deleting, but the object may still be around 2814 * may have been freed after deleting, but the object may still be around
2815 * awating cleanup and thus still be valid.You can change the size with something like: 2815 * awaiting cleanup and thus still be valid.You can change the size with something like:
2816 * 2816 *
2817 * @see ecore_evas_extn_socket_listen() 2817 * @see ecore_evas_extn_socket_listen()
2818 * @see ecore_evas_extn_plug_new() 2818 * @see ecore_evas_extn_plug_new()
@@ -2824,7 +2824,7 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p
2824EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); 2824EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
2825 2825
2826/** 2826/**
2827 * @brief Create a socket to provide the service for external ecore evas 2827 * @brief Creates a socket to provide the service for external ecore evas
2828 * socket. 2828 * socket.
2829 * 2829 *
2830 * @param ee The Ecore_Evas. 2830 * @param ee The Ecore_Evas.
@@ -2852,7 +2852,7 @@ EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h);
2852EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys); 2852EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys);
2853 2853
2854/** 2854/**
2855 * @brief Set the blocking about mouse events to Ecore Evas. 2855 * @brief Sets the blocking about mouse events to Ecore Evas.
2856 * 2856 *
2857 * @param ee The Ecore_Evas. 2857 * @param ee The Ecore_Evas.
2858 * @param events_block The blocking about mouse events. 2858 * @param events_block The blocking about mouse events.
@@ -2864,7 +2864,7 @@ EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname
2864EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool events_block); 2864EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool events_block);
2865 2865
2866/** 2866/**
2867 * @brief Get the blocking about mouse events to Ecore Evas. 2867 * @brief Gets the blocking about mouse events to Ecore Evas.
2868 * 2868 *
2869 * @param ee The Ecore_Evas. 2869 * @param ee The Ecore_Evas.
2870 2870
@@ -2877,7 +2877,7 @@ EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool even
2877EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee); 2877EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee);
2878 2878
2879/** 2879/**
2880 * @brief Lock the pixel data so the socket cannot change it 2880 * @brief Locks the pixel data so the socket cannot change it.
2881 * 2881 *
2882 * @param obj The image object returned by ecore_evas_extn_plug_new() to lock 2882 * @param obj The image object returned by ecore_evas_extn_plug_new() to lock
2883 * 2883 *
@@ -2901,7 +2901,7 @@ EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee);
2901EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj); 2901EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
2902 2902
2903/** 2903/**
2904 * @brief Unlock the pixel data so the socket can change it again. 2904 * @brief Unlocks the pixel data so the socket can change it again.
2905 * 2905 *
2906 * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock 2906 * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock
2907 * 2907 *
@@ -2916,7 +2916,7 @@ EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj);
2916EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj); 2916EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
2917 2917
2918/** 2918/**
2919 * @brief Create a new external ecore evas plug 2919 * @brief Creates a new external ecore evas plug.
2920 * 2920 *
2921 * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live. 2921 * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
2922 * @return An evas image object that will contain the image output of a socket. 2922 * @return An evas image object that will contain the image output of a socket.
@@ -2947,7 +2947,7 @@ EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj);
2947EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target); 2947EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
2948 2948
2949/** 2949/**
2950 * @brief Connect an external ecore evas plug to service provided by external 2950 * @brief Connects an external ecore evas plug to service provided by external
2951 * ecore evas socket. 2951 * ecore evas socket.
2952 * 2952 *
2953 * @param obj The Ecore_Evas containing the canvas in which the new image 2953 * @param obj The Ecore_Evas containing the canvas in which the new image
@@ -2966,7 +2966,7 @@ EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target);
2966EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys); 2966EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
2967 2967
2968/** 2968/**
2969 * @brief Retrieve the coordinates of the default mouse pointer 2969 * @brief Retrieves the coordinates of the default mouse pointer.
2970 * 2970 *
2971 * @param ee The Ecore_Evas containing the pointer 2971 * @param ee The Ecore_Evas containing the pointer
2972 * @param x Pointer to integer to store horizontal coordinate. May be @c NULL. 2972 * @param x Pointer to integer to store horizontal coordinate. May be @c NULL.
@@ -2978,7 +2978,7 @@ EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcnam
2978EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y); 2978EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y);
2979 2979
2980/** 2980/**
2981 * @brief Set the coordinates of the mouse pointer 2981 * @brief Sets the coordinates of the mouse pointer.
2982 * 2982 *
2983 * @param ee The Ecore_Evas containing the pointer 2983 * @param ee The Ecore_Evas containing the pointer
2984 * @param x The horizontal coordinate to move the pointer to 2984 * @param x The horizontal coordinate to move the pointer to
@@ -2991,7 +2991,7 @@ EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Co
2991EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y); 2991EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y);
2992 2992
2993/** 2993/**
2994 * @brief Retrieve the coordinates of the mouse pointer 2994 * @brief Retrieves the coordinates of the mouse pointer.
2995 * 2995 *
2996 * @param ee The Ecore_Evas containing the pointer 2996 * @param ee The Ecore_Evas containing the pointer
2997 * @param pointer The pointer device, use @c NULL for the default pointer. 2997 * @param pointer The pointer device, use @c NULL for the default pointer.
@@ -3002,7 +3002,7 @@ EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_
3002EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input_Device *pointer, Evas_Coord *x, Evas_Coord *y); 3002EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input_Device *pointer, Evas_Coord *x, Evas_Coord *y);
3003 3003
3004/** 3004/**
3005 * @brief Retrieve the Visual used for pixmap creation 3005 * @brief Retrieves the Visual used for pixmap creation.
3006 * 3006 *
3007 * @param ee The Ecore_Evas containing the pixmap 3007 * @param ee The Ecore_Evas containing the pixmap
3008 * 3008 *
@@ -3017,7 +3017,7 @@ EAPI void ecore_evas_pointer_device_xy_get(const Ecore_Evas *ee, const Efl_Input
3017EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); 3017EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee);
3018 3018
3019/** 3019/**
3020 * @brief Retrieve the Colormap used for pixmap creation 3020 * @brief Retrieves the Colormap used for pixmap creation.
3021 * 3021 *
3022 * @param ee The Ecore_Evas containing the pixmap 3022 * @param ee The Ecore_Evas containing the pixmap
3023 * 3023 *
@@ -3032,7 +3032,7 @@ EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee);
3032EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee); 3032EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee);
3033 3033
3034/** 3034/**
3035 * @brief Retrieve the depth used for pixmap creation 3035 * @brief Retrieves the depth used for pixmap creation.
3036 * 3036 *
3037 * @param ee The Ecore_Evas containing the pixmap 3037 * @param ee The Ecore_Evas containing the pixmap
3038 * 3038 *
Copyright © Enlightenment.org