summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-04-24 08:26:18 -0400
committerChris Michael <cp.michael@samsung.com>2017-04-24 08:26:18 -0400
commita7bac868bcba99b0cdb67dccf6376cdd790e12bf (patch)
treebf65878c3e2ef7e8b469c9967d3499b29c9bc909 /src/lib/ecore_evas
parenta2e55b5c397f0be1328f0acfb4372b2ac6f2be23 (diff)
ecore_evas: Fix grammar for at/to/for/on/which/etc.
Summary: Fixes some grammar confusion for in that/this, that/which, to/at, to/for, at/by, etc. Subscribers: cedric, jpeg Differential Revision: https://phab.enlightenment.org/D4806
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 e160091f24..a800f2757b 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -196,7 +196,7 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
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, which 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)
@@ -204,7 +204,7 @@ EAPI void ecore_evas_engines_free(Eina_List *engines);
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 this 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
209 * it or use quotes. 209 * it or use quotes.
210 * 210 *
@@ -808,7 +808,7 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee);
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 a 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 * on 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
@@ -1131,7 +1131,7 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee);
1131 1131
1132/** 1132/**
1133 * @brief Creates 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 for 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.
1137 * @param x The X coordinate to be used. 1137 * @param x The X coordinate to be used.
@@ -1154,7 +1154,7 @@ EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee);
1154 1154
1155/** 1155/**
1156 * @brief Sets 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 for 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 @c EINA_TRUE, disables if equals @c EINA_FALSE. 1159 * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
1160 */ 1160 */
@@ -1162,7 +1162,7 @@ EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, E
1162 1162
1163/** 1163/**
1164 * @brief Gets 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 for 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 @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. 1167 * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
1168 */ 1168 */
@@ -1170,9 +1170,9 @@ EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas
1170 1170
1171/** 1171/**
1172 * @brief Adds an 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 for x11 then nothing is done.
1174 * @param ee The Ecore_Evas on which to add the window. 1174 * @param ee The Ecore_Evas for 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 to the Ecore_Evas.
1176 */ 1176 */
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
@@ -1221,7 +1221,7 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee);
1221 1221
1222/** 1222/**
1223 * @brief Creates 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 for 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.
1227 * @param x The X coordinate to be used. 1227 * @param x The X coordinate to be used.
@@ -1245,7 +1245,7 @@ EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee);
1245 1245
1246/** 1246/**
1247 * @brief Sets 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 for 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 @c EINA_TRUE, disables if equals @c EINA_FALSE. 1250 * @param on Enables the resize of Ecore_Evas if equals @c EINA_TRUE, disables if equals @c EINA_FALSE.
1251 */ 1251 */
@@ -1253,7 +1253,7 @@ EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bo
1253 1253
1254/** 1254/**
1255 * @brief Gets 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 for 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 @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE. 1258 * @return @c EINA_TRUE if the resize was managed directly, otherwise return @c EINA_FALSE.
1259 */ 1259 */
@@ -1261,15 +1261,15 @@ EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee);
1261 1261
1262/** 1262/**
1263 * @brief Adds 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 for 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 to the Ecore_Evas.
1267 */ 1267 */
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 Sets 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 for 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.
1275 * @param pre_cb The function to be called before the callback. 1275 * @param pre_cb The function to be called before the callback.
@@ -1519,7 +1519,7 @@ EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
1519 * buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be 1519 * buffer canvas' contents (with ecore_evas_buffer_pixels_get()) to be
1520 * used on another canvas, for whatever reason. The most common goal 1520 * used on another canvas, for whatever reason. The most common goal
1521 * of this setup is to @b save an image file with a whole canvas as 1521 * of this setup is to @b save an image file with a whole canvas as
1522 * contents, which could not be achieved by using an image file within 1522 * contents, that cannot be achieved by using an image file within
1523 * the target canvas. 1523 * the target canvas.
1524 * 1524 *
1525 * @warning Always resize the returned image and its underlying 1525 * @warning Always resize the returned image and its underlying
@@ -2578,7 +2578,7 @@ typedef void (*Ecore_Evas_Vnc_Client_Disconnected_Cb)(void *data, Ecore_Evas *ee
2578 * @param port The port number to start the VNC server. Use @c -1 to set the default VNC port (5900) 2578 * @param port The port number to start the VNC server. Use @c -1 to set the default VNC port (5900)
2579 * @param accept_cb A callback used to accept a new client. If @c NULL all clients will be accepted. 2579 * @param accept_cb A callback used to accept a new client. If @c NULL all clients will be accepted.
2580 * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL. 2580 * @param disc_cb A callback used to inform that a client has disconnected. It may be @c NULL.
2581 * @param data Data to @a cb 2581 * @param data Data to pass to @a accept_cb and @disc_cb
2582 * @return an Evas_Object that take everything under it to represent the view of the client. 2582 * @return an Evas_Object that take everything under it to represent the view of the client.
2583 * @see ecore_evas_vnc_stop() 2583 * @see ecore_evas_vnc_stop()
2584 * @see Ecore_Evas_Vnc_Client_Accept_Cb() 2584 * @see Ecore_Evas_Vnc_Client_Accept_Cb()
@@ -2654,7 +2654,7 @@ EAPI Evas *ecore_evas_ews_evas_get(void);
2654EAPI Evas_Object *ecore_evas_ews_background_get(void); 2654EAPI Evas_Object *ecore_evas_ews_background_get(void);
2655 2655
2656/** 2656/**
2657 * @brief Sets the current background, must be created at evas ecore_evas_ews_evas_get(). 2657 * @brief Sets the current background, must be created by evas ecore_evas_ews_evas_get().
2658 * 2658 *
2659 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below 2659 * It will be kept at lowest layer (EVAS_LAYER_MIN) and below
2660 * everything else. You can set any object, default is a black 2660 * everything else. You can set any object, default is a black
@@ -2720,7 +2720,7 @@ EAPI extern int ECORE_EVAS_EWS_EVENT_CONFIG_CHANGE; /**< some other window prope
2720 */ 2720 */
2721 2721
2722/** 2722/**
2723 * @defgroup Ecore_Evas_Extn External plug/socket infrastructure to remote canvases 2723 * @defgroup Ecore_Evas_Extn External plug/socket infrastructure for remote canvases
2724 * @ingroup Ecore_Evas_Group 2724 * @ingroup Ecore_Evas_Group
2725 * 2725 *
2726 * These functions allow 1 process to create a "socket" was pluged into which another 2726 * These functions allow 1 process to create a "socket" was pluged into which another