summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-04-04 09:24:55 -0400
committerChris Michael <cp.michael@samsung.com>2017-04-04 09:24:55 -0400
commita28f4e3ba337a8cd5378c07a66e0d599b702a89b (patch)
tree323367c2c5767acde8a924e66daa1dc61892e012 /src/lib/ecore_evas
parentcd60f0a1be468280de1e45f5642a7701145c28f2 (diff)
ecore_evas: Fix some pluralization grammatical errors
Subscribers: cedric, jpeg Differential Revision: https://phab.enlightenment.org/D4729
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index da23432e0a..fd76431cde 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -34,7 +34,7 @@
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 examples that partially exemplify Ecore_Evas's API:
38 * @li @ref ecore_evas_callbacks_example_c 38 * @li @ref ecore_evas_callbacks_example_c
39 * @li @ref ecore_evas_object_example_c 39 * @li @ref ecore_evas_object_example_c
40 * @li @ref ecore_evas_basics_example_c 40 * @li @ref ecore_evas_basics_example_c
@@ -63,7 +63,7 @@ extern "C" {
63 * @defgroup Ecore_Evas_Group Ecore_Evas wrapper/helper set of functions 63 * @defgroup Ecore_Evas_Group Ecore_Evas wrapper/helper set of functions
64 * @ingroup Ecore 64 * @ingroup Ecore
65 * 65 *
66 * Ecore evas is a set of functions that makes it easy to tie together ecore's 66 * Ecore evas is a set of functions that make it easy to tie together ecore's
67 * main loop and input handling to evas. As such it's a natural base for EFL 67 * main loop and input handling to evas. As such it's a natural base for EFL
68 * applications. While this combination makes it easy to create the basic 68 * applications. While this combination makes it easy to create the basic
69 * aspects all applications need, for normal applications(ones with buttons, 69 * aspects all applications need, for normal applications(ones with buttons,
@@ -178,9 +178,9 @@ 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 Returns a list of supported engines names. 181 * @brief Returns a list of supported engine names.
182 * 182 *
183 * @return Newly allocated list with engines names. Engines names 183 * @return Newly allocated list with engine names. Engine names
184 * strings are internal and should be considered constants, do not 184 * strings are internal and should be considered constants, do not
185 * free or modify them, to free the list use ecore_evas_engines_free(). 185 * free or modify them, to free the list use ecore_evas_engines_free().
186 */ 186 */
@@ -188,7 +188,7 @@ 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 engine names
192 */ 192 */
193EAPI void ecore_evas_engines_free(Eina_List *engines); 193EAPI void ecore_evas_engines_free(Eina_List *engines);
194/** 194/**
@@ -274,8 +274,8 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee);
274 * @param h A pointer to an int to place the h size in 274 * @param h A pointer to an int to place the h size in
275 * 275 *
276 * This function takes four pointers to (already allocated) ints, and places 276 * This function takes four pointers to (already allocated) ints, and places
277 * the geometry of @p ee in them. If any of the parameters is not desired you 277 * the geometry of @p ee in them. If any of the parameters are not desired you
278 * may pass @c NULL on them. 278 * may pass @c NULL for them.
279 * 279 *
280 * @code 280 * @code
281 * int x, y, w, h; 281 * int x, y, w, h;
@@ -299,7 +299,7 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i
299 * 299 *
300 * This function takes four pointers to (already allocated) ints, and places 300 * This function takes four pointers to (already allocated) ints, and places
301 * the geometry which @p ee was latest recently requested . If any of the 301 * the geometry which @p ee was latest recently requested . If any of the
302 * parameters is not desired you may pass @c NULL on them. 302 * parameters are not desired you may pass @c NULL for them.
303 * This function can represent recently requested geometry. 303 * This function can represent recently requested geometry.
304 * ecore_evas_geometry_get function returns the value is updated after engine 304 * ecore_evas_geometry_get function returns the value is updated after engine
305 * finished request. By comparison, ecore_evas_request_geometry_get returns 305 * finished request. By comparison, ecore_evas_request_geometry_get returns
@@ -807,22 +807,22 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
807 * @warning Support for this depends on the underlying windowing system. 807 * @warning Support for this depends on the underlying windowing system.
808 * 808 *
809 * The window auxiliary hint is the value which is used to decide which actions should 809 * The window auxiliary hint is the value which is used to decide which actions should
810 * be made available to the user by the window manager. If you want to set specific hint 810 * be made available to the user by the window manager. If you want to set a specific hint
811 * to your window, then you should check whether it exists in the supported auxiliary 811 * to your window, then you should check whether it exists in the supported auxiliary
812 * hints that are registered in the root window by the window manager. Once you've added 812 * hints that are registered in the root window by the window manager. Once you've added
813 * an auxiliary hint, you can get a new ID which is used to change value and delete hint. 813 * an auxiliary hint, you can get a new ID which is used to change value and delete hint.
814 * The window manager sends the response message to the application on receiving auxiliary 814 * The window manager sends the response message to the application on receiving auxiliary
815 * hint change event. A list of auxiliary hint within the Ecore_Evas has this format: 815 * hint change event. A list of auxiliary hints within the Ecore_Evas has this format:
816 * ID:HINT:VALUE,ID:HINT:VALUE,... 816 * ID:HINT:VALUE,ID:HINT:VALUE,...
817 * 817 *
818 * @since 1.10.0 818 * @since 1.10.0
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 Gets the list of allowed auxiliary hint ID. 822 * @brief Gets the list of allowed auxiliary hint IDs.
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 IDs.
826 * @note This function is low level. Instead of using it directly, consider 826 * @note This function is low level. Instead of using it directly, consider
827 * using the callback mechanism in Elementary such as "aux,hint,allowed". 827 * using the callback mechanism in Elementary such as "aux,hint,allowed".
828 * @warning Support for this depends on the underlying windowing system. 828 * @warning Support for this depends on the underlying windowing system.
@@ -1026,8 +1026,8 @@ EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot);
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 content so
1030 * that they fit inside the current window geometry. 1030 * that it fits inside the current window geometry.
1031 * 1031 *
1032 * @warning Support for this depends on the underlying windowing system. 1032 * @warning Support for this depends on the underlying windowing system.
1033 * 1033 *
@@ -1169,7 +1169,7 @@ EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, E
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 Adds extra window on Ecore_Evas using software x11. 1172 * @brief Adds an 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.
@@ -1438,7 +1438,7 @@ EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee);
1438 * 1438 *
1439 * A use case for the function is to determine if the buffer is used inside 1439 * A use case for the function is to determine if the buffer is used inside
1440 * X11 or Wayland. Since the buffer engine doesn't give any indication on 1440 * X11 or Wayland. Since the buffer engine doesn't give any indication on
1441 * it, we need to retrieve information from the Ecore_Evas parents. 1441 * it, we need to retrieve information from the Ecore_Evas parent.
1442 * 1442 *
1443 * @since 1.13 1443 * @since 1.13
1444 */ 1444 */
@@ -1543,7 +1543,7 @@ 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 Retrieves the internal @c Ecore_Evas handle of an image 1546 * @brief Retrieve 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
@@ -2733,7 +2733,7 @@ EAPI extern int ECORE_EVAS_EWS_EVENT_CONFIG_CHANGE; /**< some other window prope
2733 * 2733 *
2734 * These functions allow 1 process to create a "socket" was pluged into which another 2734 * These functions allow 1 process to create a "socket" was pluged into which another
2735 * process can create a "plug" remotely to plug into. 2735 * process can create a "plug" remotely to plug into.
2736 * Socket can provides content for several plugs. 2736 * Socket can provide content for several plugs.
2737 * This is best for small sized objects (about the size range 2737 * This is best for small sized objects (about the size range
2738 * of a small icon up to a few large icons). Sine the plug is actually an 2738 * of a small icon up to a few large icons). Sine the plug is actually an
2739 * image object, you can fetch the pixel data 2739 * image object, you can fetch the pixel data
@@ -2895,7 +2895,7 @@ EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee);
2895 * ecore_evas_extn_plug_object_data_unlock(). Keeping a lock over more than 2895 * ecore_evas_extn_plug_object_data_unlock(). Keeping a lock over more than
2896 * 1 iteration of the main ecore loop will be problematic, so avoid it. Also 2896 * 1 iteration of the main ecore loop will be problematic, so avoid it. Also
2897 * forgetting to unlock may cause the socket process to freeze and thus create 2897 * forgetting to unlock may cause the socket process to freeze and thus create
2898 * odd behavior. 2898 * odd behaviors.
2899 * 2899 *
2900 * @see ecore_evas_extn_plug_new() 2900 * @see ecore_evas_extn_plug_new()
2901 * @see ecore_evas_extn_plug_object_data_unlock() 2901 * @see ecore_evas_extn_plug_object_data_unlock()