diff options
Diffstat (limited to '')
-rw-r--r-- | libraries/evas/src/lib/Evas.h | 433 |
1 files changed, 313 insertions, 120 deletions
diff --git a/libraries/evas/src/lib/Evas.h b/libraries/evas/src/lib/Evas.h index 5898290..b85bbeb 100644 --- a/libraries/evas/src/lib/Evas.h +++ b/libraries/evas/src/lib/Evas.h | |||
@@ -5,6 +5,7 @@ | |||
5 | @date 2000-2011 | 5 | @date 2000-2011 |
6 | 6 | ||
7 | Please see the @ref authors page for contact details. | 7 | Please see the @ref authors page for contact details. |
8 | |||
8 | @link Evas.h Evas API @endlink | 9 | @link Evas.h Evas API @endlink |
9 | 10 | ||
10 | @section toc Table of Contents | 11 | @section toc Table of Contents |
@@ -342,7 +343,7 @@ extern "C" { | |||
342 | #endif | 343 | #endif |
343 | 344 | ||
344 | #define EVAS_VERSION_MAJOR 1 | 345 | #define EVAS_VERSION_MAJOR 1 |
345 | #define EVAS_VERSION_MINOR 0 | 346 | #define EVAS_VERSION_MINOR 2 |
346 | 347 | ||
347 | typedef struct _Evas_Version | 348 | typedef struct _Evas_Version |
348 | { | 349 | { |
@@ -432,6 +433,9 @@ typedef enum _Evas_Callback_Type | |||
432 | */ | 433 | */ |
433 | EVAS_CALLBACK_IMAGE_UNLOADED, /**< Image data has been unloaded (by some mechanims in Evas that throw out original image data) */ | 434 | EVAS_CALLBACK_IMAGE_UNLOADED, /**< Image data has been unloaded (by some mechanims in Evas that throw out original image data) */ |
434 | 435 | ||
436 | EVAS_CALLBACK_RENDER_PRE, /**< Called just before rendering starts on the canvas target @since 1.2 */ | ||
437 | EVAS_CALLBACK_RENDER_POST, /**< Called just after rendering stops on the canvas target @since 1.2 */ | ||
438 | |||
435 | EVAS_CALLBACK_LAST /**< kept as last element/sentinel -- not really an event */ | 439 | EVAS_CALLBACK_LAST /**< kept as last element/sentinel -- not really an event */ |
436 | } Evas_Callback_Type; /**< The types of events triggering a callback */ | 440 | } Evas_Callback_Type; /**< The types of events triggering a callback */ |
437 | 441 | ||
@@ -1061,7 +1065,8 @@ struct _Evas_Event_Hold /** Hold change event */ | |||
1061 | typedef enum _Evas_Object_Pointer_Mode | 1065 | typedef enum _Evas_Object_Pointer_Mode |
1062 | { | 1066 | { |
1063 | EVAS_OBJECT_POINTER_MODE_AUTOGRAB, /**< default, X11-like */ | 1067 | EVAS_OBJECT_POINTER_MODE_AUTOGRAB, /**< default, X11-like */ |
1064 | EVAS_OBJECT_POINTER_MODE_NOGRAB /**< pointer always bound to the object right below it */ | 1068 | EVAS_OBJECT_POINTER_MODE_NOGRAB, /**< pointer always bound to the object right below it */ |
1069 | EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN /**< useful on object with "repeat events" enabled, where mouse/touch up and down events WONT be repeated to objects and these objects wont be auto-grabbed. @since 1.2 */ | ||
1065 | } Evas_Object_Pointer_Mode; /**< How the mouse pointer should be handled by Evas. */ | 1070 | } Evas_Object_Pointer_Mode; /**< How the mouse pointer should be handled by Evas. */ |
1066 | 1071 | ||
1067 | typedef void (*Evas_Smart_Cb) (void *data, Evas_Object *obj, void *event_info); /**< Evas smart objects' "smart callback" function signature */ | 1072 | typedef void (*Evas_Smart_Cb) (void *data, Evas_Object *obj, void *event_info); /**< Evas smart objects' "smart callback" function signature */ |
@@ -1220,7 +1225,7 @@ EAPI Evas_Alloc_Error evas_alloc_error (void); | |||
1220 | * | 1225 | * |
1221 | * @ingroup Evas_Group | 1226 | * @ingroup Evas_Group |
1222 | */ | 1227 | */ |
1223 | EAPI int evas_async_events_fd_get (void) EINA_WARN_UNUSED_RESULT EINA_PURE; | 1228 | EAPI int evas_async_events_fd_get (void) EINA_WARN_UNUSED_RESULT; |
1224 | 1229 | ||
1225 | /** | 1230 | /** |
1226 | * @brief Trigger the processing of all events waiting on the file | 1231 | * @brief Trigger the processing of all events waiting on the file |
@@ -1339,7 +1344,7 @@ EAPI void evas_focus_out (Evas *e); | |||
1339 | * @param e The evas to query information. | 1344 | * @param e The evas to query information. |
1340 | * @ingroup Evas_Canvas | 1345 | * @ingroup Evas_Canvas |
1341 | */ | 1346 | */ |
1342 | EAPI Eina_Bool evas_focus_state_get (const Evas *e) EINA_PURE; | 1347 | EAPI Eina_Bool evas_focus_state_get (const Evas *e); |
1343 | 1348 | ||
1344 | /** | 1349 | /** |
1345 | * Push the nochange flag up 1 | 1350 | * Push the nochange flag up 1 |
@@ -1380,7 +1385,7 @@ EAPI void evas_data_attach_set (Evas *e, void *data) E | |||
1380 | * @return The pointer attached | 1385 | * @return The pointer attached |
1381 | * @ingroup Evas_Canvas | 1386 | * @ingroup Evas_Canvas |
1382 | */ | 1387 | */ |
1383 | EAPI void *evas_data_attach_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 1388 | EAPI void *evas_data_attach_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
1384 | 1389 | ||
1385 | 1390 | ||
1386 | /** | 1391 | /** |
@@ -1747,7 +1752,7 @@ EAPI void evas_output_method_set (Evas *e, int render_me | |||
1747 | * returned if there is an error. | 1752 | * returned if there is an error. |
1748 | * @ingroup Evas_Output_Method | 1753 | * @ingroup Evas_Output_Method |
1749 | */ | 1754 | */ |
1750 | EAPI int evas_output_method_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 1755 | EAPI int evas_output_method_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
1751 | 1756 | ||
1752 | 1757 | ||
1753 | /** | 1758 | /** |
@@ -1764,7 +1769,7 @@ EAPI int evas_output_method_get (const Evas *e) EINA_WA | |||
1764 | * an engine has not yet been assigned. | 1769 | * an engine has not yet been assigned. |
1765 | * @ingroup Evas_Output_Method | 1770 | * @ingroup Evas_Output_Method |
1766 | */ | 1771 | */ |
1767 | EAPI Evas_Engine_Info *evas_engine_info_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 1772 | EAPI Evas_Engine_Info *evas_engine_info_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
1768 | 1773 | ||
1769 | /** | 1774 | /** |
1770 | * Applies the engine settings for the given evas from the given @c | 1775 | * Applies the engine settings for the given evas from the given @c |
@@ -1876,6 +1881,38 @@ EAPI void evas_output_viewport_set (Evas *e, Evas_Coord x, | |||
1876 | EAPI void evas_output_viewport_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1); | 1881 | EAPI void evas_output_viewport_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1); |
1877 | 1882 | ||
1878 | /** | 1883 | /** |
1884 | * Sets the output framespace size of the render engine of the given evas. | ||
1885 | * | ||
1886 | * The framespace size is used in the Wayland engines to denote space where | ||
1887 | * the output is not drawn. This is mainly used in ecore_evas to draw borders | ||
1888 | * | ||
1889 | * The units used for @p w and @p h depend on the engine used by the | ||
1890 | * evas. | ||
1891 | * | ||
1892 | * @param e The given evas. | ||
1893 | * @param x The left coordinate in output units, usually pixels. | ||
1894 | * @param y The top coordinate in output units, usually pixels. | ||
1895 | * @param w The width in output units, usually pixels. | ||
1896 | * @param h The height in output units, usually pixels. | ||
1897 | * @ingroup Evas_Output_Size | ||
1898 | * @since 1.1.0 | ||
1899 | */ | ||
1900 | EAPI void evas_output_framespace_set (Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h); | ||
1901 | |||
1902 | /** | ||
1903 | * Get the render engine's output framespace co-ordinates in canvas units. | ||
1904 | * | ||
1905 | * @param e The pointer to the Evas Canvas | ||
1906 | * @param x The pointer to a x variable to be filled in | ||
1907 | * @param y The pointer to a y variable to be filled in | ||
1908 | * @param w The pointer to a width variable to be filled in | ||
1909 | * @param h The pointer to a height variable to be filled in | ||
1910 | * @ingroup Evas_Output_Size | ||
1911 | * @since 1.1.0 | ||
1912 | */ | ||
1913 | EAPI void evas_output_framespace_get (const Evas *e, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h); | ||
1914 | |||
1915 | /** | ||
1879 | * @defgroup Evas_Coord_Mapping_Group Coordinate Mapping Functions | 1916 | * @defgroup Evas_Coord_Mapping_Group Coordinate Mapping Functions |
1880 | * | 1917 | * |
1881 | * Functions that are used to map coordinates from the canvas to the | 1918 | * Functions that are used to map coordinates from the canvas to the |
@@ -2342,6 +2379,33 @@ EAPI void evas_post_event_callback_remove_full (Evas *e, Evas_Objec | |||
2342 | */ | 2379 | */ |
2343 | 2380 | ||
2344 | /** | 2381 | /** |
2382 | * Set the default set of flags an event begins with | ||
2383 | * | ||
2384 | * @param e The canvas to set the default event flags of | ||
2385 | * @param flags The default flags to use | ||
2386 | * | ||
2387 | * Events in evas can have an event_flags member. This starts out with | ||
2388 | * and initial value (no flags). this lets you set the default flags that | ||
2389 | * an event begins with to be @p flags | ||
2390 | * | ||
2391 | * @since 1.2 | ||
2392 | */ | ||
2393 | EAPI void evas_event_default_flags_set (Evas *e, Evas_Event_Flags flags) EINA_ARG_NONNULL(1); | ||
2394 | |||
2395 | /** | ||
2396 | * Get the defaulty set of flags an event begins with | ||
2397 | * | ||
2398 | * @param e The canvas to get the default event flags from | ||
2399 | * @return The default event flags for that canvas | ||
2400 | * | ||
2401 | * This gets the default event flags events are produced with when fed in. | ||
2402 | * | ||
2403 | * @see evas_event_default_flags_set() | ||
2404 | * @since 1.2 | ||
2405 | */ | ||
2406 | EAPI Evas_Event_Flags evas_event_default_flags_get (const Evas *e) EINA_ARG_NONNULL(1); | ||
2407 | |||
2408 | /** | ||
2345 | * Freeze all input events processing. | 2409 | * Freeze all input events processing. |
2346 | * | 2410 | * |
2347 | * @param e The canvas to freeze input events processing on. | 2411 | * @param e The canvas to freeze input events processing on. |
@@ -2407,7 +2471,7 @@ EAPI void evas_event_thaw (Evas *e) EINA_ARG_NONN | |||
2407 | * @endcode | 2471 | * @endcode |
2408 | * | 2472 | * |
2409 | */ | 2473 | */ |
2410 | EAPI int evas_event_freeze_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2474 | EAPI int evas_event_freeze_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2411 | 2475 | ||
2412 | /** | 2476 | /** |
2413 | * After thaw of a canvas, re-evaluate the state of objects and call callbacks | 2477 | * After thaw of a canvas, re-evaluate the state of objects and call callbacks |
@@ -2448,6 +2512,16 @@ EAPI void evas_event_thaw_eval (Evas *e) EINA_ARG_NONN | |||
2448 | */ | 2512 | */ |
2449 | 2513 | ||
2450 | /** | 2514 | /** |
2515 | * Get the number of mouse or multi presses currently active | ||
2516 | * | ||
2517 | * @p e The given canvas pointer. | ||
2518 | * @return The numer of presses (0 if none active). | ||
2519 | * | ||
2520 | * @since 1.2 | ||
2521 | */ | ||
2522 | EAPI int evas_event_down_count_get (const Evas *e) EINA_ARG_NONNULL(1); | ||
2523 | |||
2524 | /** | ||
2451 | * Mouse down event feed. | 2525 | * Mouse down event feed. |
2452 | * | 2526 | * |
2453 | * @param e The given canvas pointer. | 2527 | * @param e The given canvas pointer. |
@@ -2679,7 +2753,7 @@ EAPI void evas_image_cache_set (Evas *e, int size) EIN | |||
2679 | * This function returns the image cache size of canvas in bytes. | 2753 | * This function returns the image cache size of canvas in bytes. |
2680 | * | 2754 | * |
2681 | */ | 2755 | */ |
2682 | EAPI int evas_image_cache_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2756 | EAPI int evas_image_cache_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2683 | 2757 | ||
2684 | /** | 2758 | /** |
2685 | * Get the maximum image size evas can possibly handle | 2759 | * Get the maximum image size evas can possibly handle |
@@ -2728,7 +2802,7 @@ EAPI void evas_font_hinting_set (Evas *e, Evas_Font_H | |||
2728 | * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. | 2802 | * #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. |
2729 | * @ingroup Evas_Font_Group | 2803 | * @ingroup Evas_Font_Group |
2730 | */ | 2804 | */ |
2731 | EAPI Evas_Font_Hinting_Flags evas_font_hinting_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2805 | EAPI Evas_Font_Hinting_Flags evas_font_hinting_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2732 | 2806 | ||
2733 | /** | 2807 | /** |
2734 | * Checks if the font hinting is supported by the given evas. | 2808 | * Checks if the font hinting is supported by the given evas. |
@@ -2739,7 +2813,7 @@ EAPI Evas_Font_Hinting_Flags evas_font_hinting_get (const Evas *e) EINA_ | |||
2739 | * @return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise. | 2813 | * @return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise. |
2740 | * @ingroup Evas_Font_Group | 2814 | * @ingroup Evas_Font_Group |
2741 | */ | 2815 | */ |
2742 | EAPI Eina_Bool evas_font_hinting_can_hint (const Evas *e, Evas_Font_Hinting_Flags hinting) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2816 | EAPI Eina_Bool evas_font_hinting_can_hint (const Evas *e, Evas_Font_Hinting_Flags hinting) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2743 | 2817 | ||
2744 | 2818 | ||
2745 | /** | 2819 | /** |
@@ -2768,7 +2842,7 @@ EAPI void evas_font_cache_set (Evas *e, int size) E | |||
2768 | * | 2842 | * |
2769 | * @ingroup Evas_Font_Group | 2843 | * @ingroup Evas_Font_Group |
2770 | */ | 2844 | */ |
2771 | EAPI int evas_font_cache_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2845 | EAPI int evas_font_cache_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2772 | 2846 | ||
2773 | 2847 | ||
2774 | /** | 2848 | /** |
@@ -2785,7 +2859,7 @@ EAPI int evas_font_cache_get (const Evas *e) EINA_ | |||
2785 | * | 2859 | * |
2786 | * @ingroup Evas_Font_Group | 2860 | * @ingroup Evas_Font_Group |
2787 | */ | 2861 | */ |
2788 | EAPI Eina_List *evas_font_available_list (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2862 | EAPI Eina_List *evas_font_available_list (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2789 | 2863 | ||
2790 | /** | 2864 | /** |
2791 | * Free list of font descriptions returned by evas_font_dir_available_list(). | 2865 | * Free list of font descriptions returned by evas_font_dir_available_list(). |
@@ -2834,7 +2908,7 @@ EAPI void evas_font_path_prepend (Evas *e, const char *p | |||
2834 | * @return The list of font paths used. | 2908 | * @return The list of font paths used. |
2835 | * @ingroup Evas_Font_Path_Group | 2909 | * @ingroup Evas_Font_Path_Group |
2836 | */ | 2910 | */ |
2837 | EAPI const Eina_List *evas_font_path_list (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 2911 | EAPI const Eina_List *evas_font_path_list (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2838 | 2912 | ||
2839 | /** | 2913 | /** |
2840 | * @defgroup Evas_Object_Group Generic Object Functions | 2914 | * @defgroup Evas_Object_Group Generic Object Functions |
@@ -2958,7 +3032,7 @@ EAPI void evas_object_clip_set (Evas_Object *obj, Evas | |||
2958 | * | 3032 | * |
2959 | * See the full @ref Example_Evas_Object_Manipulation "example". | 3033 | * See the full @ref Example_Evas_Object_Manipulation "example". |
2960 | */ | 3034 | */ |
2961 | EAPI Evas_Object *evas_object_clip_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3035 | EAPI Evas_Object *evas_object_clip_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
2962 | 3036 | ||
2963 | /** | 3037 | /** |
2964 | * Disable/cease clipping on a clipped @p obj object. | 3038 | * Disable/cease clipping on a clipped @p obj object. |
@@ -3015,7 +3089,7 @@ EAPI void evas_object_clip_unset (Evas_Object *obj); | |||
3015 | * } | 3089 | * } |
3016 | * @endcode | 3090 | * @endcode |
3017 | */ | 3091 | */ |
3018 | EAPI const Eina_List *evas_object_clipees_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3092 | EAPI const Eina_List *evas_object_clipees_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3019 | 3093 | ||
3020 | 3094 | ||
3021 | /** | 3095 | /** |
@@ -3068,7 +3142,7 @@ EAPI void evas_object_focus_set (Evas_Object *obj, Eina | |||
3068 | * @see evas_object_key_grab | 3142 | * @see evas_object_key_grab |
3069 | * @see evas_object_key_ungrab | 3143 | * @see evas_object_key_ungrab |
3070 | */ | 3144 | */ |
3071 | EAPI Eina_Bool evas_object_focus_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3145 | EAPI Eina_Bool evas_object_focus_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3072 | 3146 | ||
3073 | 3147 | ||
3074 | /** | 3148 | /** |
@@ -3104,7 +3178,7 @@ EAPI void evas_object_layer_set (Evas_Object *obj, shor | |||
3104 | * | 3178 | * |
3105 | * @see evas_object_layer_set() | 3179 | * @see evas_object_layer_set() |
3106 | */ | 3180 | */ |
3107 | EAPI short evas_object_layer_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3181 | EAPI short evas_object_layer_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3108 | 3182 | ||
3109 | 3183 | ||
3110 | /** | 3184 | /** |
@@ -3139,7 +3213,7 @@ EAPI void evas_object_name_set (Evas_Object *obj, cons | |||
3139 | * | 3213 | * |
3140 | * See the full @ref Example_Evas_Events "example". | 3214 | * See the full @ref Example_Evas_Events "example". |
3141 | */ | 3215 | */ |
3142 | EAPI const char *evas_object_name_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3216 | EAPI const char *evas_object_name_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3143 | 3217 | ||
3144 | 3218 | ||
3145 | /** | 3219 | /** |
@@ -3382,7 +3456,7 @@ EAPI void evas_object_hide (Evas_Object *obj) EINA | |||
3382 | * | 3456 | * |
3383 | * @ingroup Evas_Object_Group_Basic | 3457 | * @ingroup Evas_Object_Group_Basic |
3384 | */ | 3458 | */ |
3385 | EAPI Eina_Bool evas_object_visible_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3459 | EAPI Eina_Bool evas_object_visible_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3386 | 3460 | ||
3387 | 3461 | ||
3388 | /** | 3462 | /** |
@@ -3455,7 +3529,7 @@ EAPI void evas_object_color_get (const Evas_Object *obj | |||
3455 | * | 3529 | * |
3456 | * @ingroup Evas_Object_Group_Basic | 3530 | * @ingroup Evas_Object_Group_Basic |
3457 | */ | 3531 | */ |
3458 | EAPI Evas *evas_object_evas_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3532 | EAPI Evas *evas_object_evas_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3459 | 3533 | ||
3460 | /** | 3534 | /** |
3461 | * Retrieves the type of the given Evas object. | 3535 | * Retrieves the type of the given Evas object. |
@@ -3485,7 +3559,7 @@ EAPI Evas *evas_object_evas_get (const Evas_Object *obj | |||
3485 | * | 3559 | * |
3486 | * See the full @ref Example_Evas_Object_Manipulation "example". | 3560 | * See the full @ref Example_Evas_Object_Manipulation "example". |
3487 | */ | 3561 | */ |
3488 | EAPI const char *evas_object_type_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3562 | EAPI const char *evas_object_type_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3489 | 3563 | ||
3490 | /** | 3564 | /** |
3491 | * Raise @p obj to the top of its layer. | 3565 | * Raise @p obj to the top of its layer. |
@@ -3586,7 +3660,7 @@ EAPI void evas_object_stack_below (Evas_Object *obj, Evas | |||
3586 | * @see evas_object_below_get() | 3660 | * @see evas_object_below_get() |
3587 | * | 3661 | * |
3588 | */ | 3662 | */ |
3589 | EAPI Evas_Object *evas_object_above_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3663 | EAPI Evas_Object *evas_object_above_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3590 | 3664 | ||
3591 | /** | 3665 | /** |
3592 | * Get the Evas object stacked right below @p obj | 3666 | * Get the Evas object stacked right below @p obj |
@@ -3602,7 +3676,7 @@ EAPI Evas_Object *evas_object_above_get (const Evas_Object *obj | |||
3602 | * @see evas_object_layer_set() | 3676 | * @see evas_object_layer_set() |
3603 | * @see evas_object_below_get() | 3677 | * @see evas_object_below_get() |
3604 | */ | 3678 | */ |
3605 | EAPI Evas_Object *evas_object_below_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 3679 | EAPI Evas_Object *evas_object_below_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3606 | 3680 | ||
3607 | /** | 3681 | /** |
3608 | * @} | 3682 | * @} |
@@ -3946,7 +4020,7 @@ EAPI void evas_object_pass_events_set (Evas_Object *obj, Ein | |||
3946 | * @see evas_object_propagate_events_get() | 4020 | * @see evas_object_propagate_events_get() |
3947 | * @see evas_object_freeze_events_get() | 4021 | * @see evas_object_freeze_events_get() |
3948 | */ | 4022 | */ |
3949 | EAPI Eina_Bool evas_object_pass_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 4023 | EAPI Eina_Bool evas_object_pass_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3950 | 4024 | ||
3951 | /** | 4025 | /** |
3952 | * Set whether an Evas object is to repeat events. | 4026 | * Set whether an Evas object is to repeat events. |
@@ -3988,7 +4062,7 @@ EAPI void evas_object_repeat_events_set (Evas_Object *obj, Ein | |||
3988 | * @see evas_object_propagate_events_get() | 4062 | * @see evas_object_propagate_events_get() |
3989 | * @see evas_object_freeze_events_get() | 4063 | * @see evas_object_freeze_events_get() |
3990 | */ | 4064 | */ |
3991 | EAPI Eina_Bool evas_object_repeat_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 4065 | EAPI Eina_Bool evas_object_repeat_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
3992 | 4066 | ||
3993 | /** | 4067 | /** |
3994 | * Set whether events on a smart object's member should get propagated | 4068 | * Set whether events on a smart object's member should get propagated |
@@ -4026,7 +4100,7 @@ EAPI void evas_object_propagate_events_set (Evas_Object *obj, Ein | |||
4026 | * @see evas_object_pass_events_get() | 4100 | * @see evas_object_pass_events_get() |
4027 | * @see evas_object_freeze_events_get() | 4101 | * @see evas_object_freeze_events_get() |
4028 | */ | 4102 | */ |
4029 | EAPI Eina_Bool evas_object_propagate_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 4103 | EAPI Eina_Bool evas_object_propagate_events_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
4030 | 4104 | ||
4031 | /** | 4105 | /** |
4032 | * Set whether an Evas object is to freeze (discard) events. | 4106 | * Set whether an Evas object is to freeze (discard) events. |
@@ -4064,7 +4138,7 @@ EAPI void evas_object_freeze_events_set(Evas_Object *obj, Eina_Bool | |||
4064 | * @see evas_object_propagate_events_get() | 4138 | * @see evas_object_propagate_events_get() |
4065 | * @since 1.1.0 | 4139 | * @since 1.1.0 |
4066 | */ | 4140 | */ |
4067 | EAPI Eina_Bool evas_object_freeze_events_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 4141 | EAPI Eina_Bool evas_object_freeze_events_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
4068 | 4142 | ||
4069 | /** | 4143 | /** |
4070 | * @} | 4144 | * @} |
@@ -5028,7 +5102,7 @@ EAPI void evas_object_size_hint_min_get (const Evas_Object *obj | |||
5028 | * @skip evas_object_size_hint_min_set | 5102 | * @skip evas_object_size_hint_min_set |
5029 | * @until return | 5103 | * @until return |
5030 | * | 5104 | * |
5031 | * In this example the minimum size hints change de behavior of an | 5105 | * In this example the minimum size hints change the behavior of an |
5032 | * Evas box when layouting its children. See the full @ref | 5106 | * Evas box when layouting its children. See the full @ref |
5033 | * Example_Evas_Size_Hints "example". | 5107 | * Example_Evas_Size_Hints "example". |
5034 | * | 5108 | * |
@@ -5072,7 +5146,7 @@ EAPI void evas_object_size_hint_max_get (const Evas_Object *obj | |||
5072 | * @skip evas_object_size_hint_max_set | 5146 | * @skip evas_object_size_hint_max_set |
5073 | * @until return | 5147 | * @until return |
5074 | * | 5148 | * |
5075 | * In this example the maximum size hints change de behavior of an | 5149 | * In this example the maximum size hints change the behavior of an |
5076 | * Evas box when layouting its children. See the full @ref | 5150 | * Evas box when layouting its children. See the full @ref |
5077 | * Example_Evas_Size_Hints "example". | 5151 | * Example_Evas_Size_Hints "example". |
5078 | * | 5152 | * |
@@ -5247,7 +5321,7 @@ EAPI void evas_object_size_hint_align_get (const Evas_Object *obj | |||
5247 | * @skip evas_object_size_hint_align_set | 5321 | * @skip evas_object_size_hint_align_set |
5248 | * @until return | 5322 | * @until return |
5249 | * | 5323 | * |
5250 | * In this example the alignment hints change de behavior of an Evas | 5324 | * In this example the alignment hints change the behavior of an Evas |
5251 | * box when layouting its children. See the full @ref | 5325 | * box when layouting its children. See the full @ref |
5252 | * Example_Evas_Size_Hints "example". | 5326 | * Example_Evas_Size_Hints "example". |
5253 | * | 5327 | * |
@@ -5306,7 +5380,7 @@ EAPI void evas_object_size_hint_weight_get (const Evas_Object *obj | |||
5306 | * @skip evas_object_size_hint_weight_set | 5380 | * @skip evas_object_size_hint_weight_set |
5307 | * @until return | 5381 | * @until return |
5308 | * | 5382 | * |
5309 | * In this example the weight hints change de behavior of an Evas box | 5383 | * In this example the weight hints change the behavior of an Evas box |
5310 | * when layouting its children. See the full @ref | 5384 | * when layouting its children. See the full @ref |
5311 | * Example_Evas_Size_Hints "example". | 5385 | * Example_Evas_Size_Hints "example". |
5312 | * | 5386 | * |
@@ -5342,7 +5416,7 @@ EAPI void evas_object_size_hint_weight_set (Evas_Object *obj, doub | |||
5342 | * @skip evas_object_size_hint_padding_set | 5416 | * @skip evas_object_size_hint_padding_set |
5343 | * @until return | 5417 | * @until return |
5344 | * | 5418 | * |
5345 | * In this example the padding hints change de behavior of an Evas box | 5419 | * In this example the padding hints change the behavior of an Evas box |
5346 | * when layouting its children. See the full @ref | 5420 | * when layouting its children. See the full @ref |
5347 | * Example_Evas_Size_Hints "example". | 5421 | * Example_Evas_Size_Hints "example". |
5348 | * | 5422 | * |
@@ -5456,7 +5530,7 @@ EAPI void evas_object_data_set (Evas_Object *ob | |||
5456 | * else printf("No data was stored on the object\n"); | 5530 | * else printf("No data was stored on the object\n"); |
5457 | * @endcode | 5531 | * @endcode |
5458 | */ | 5532 | */ |
5459 | EAPI void *evas_object_data_get (const Evas_Object *obj, const char *key) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 5533 | EAPI void *evas_object_data_get (const Evas_Object *obj, const char *key) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
5460 | 5534 | ||
5461 | /** | 5535 | /** |
5462 | * Delete an attached data pointer from an object. | 5536 | * Delete an attached data pointer from an object. |
@@ -5510,7 +5584,7 @@ EAPI void evas_object_pointer_mode_set (Evas_Object *ob | |||
5510 | * @return pointer behavior. | 5584 | * @return pointer behavior. |
5511 | * @ingroup Evas_Object_Group_Extras | 5585 | * @ingroup Evas_Object_Group_Extras |
5512 | */ | 5586 | */ |
5513 | EAPI Evas_Object_Pointer_Mode evas_object_pointer_mode_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5587 | EAPI Evas_Object_Pointer_Mode evas_object_pointer_mode_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5514 | 5588 | ||
5515 | 5589 | ||
5516 | /** | 5590 | /** |
@@ -5528,7 +5602,7 @@ EAPI void evas_object_anti_alias_set (Evas_Object *ob | |||
5528 | * @return @c 1 if the object is to be anti_aliased. @c 0 otherwise. | 5602 | * @return @c 1 if the object is to be anti_aliased. @c 0 otherwise. |
5529 | * @ingroup Evas_Object_Group_Extras | 5603 | * @ingroup Evas_Object_Group_Extras |
5530 | */ | 5604 | */ |
5531 | EAPI Eina_Bool evas_object_anti_alias_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5605 | EAPI Eina_Bool evas_object_anti_alias_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5532 | 5606 | ||
5533 | 5607 | ||
5534 | /** | 5608 | /** |
@@ -5562,7 +5636,7 @@ EAPI void evas_object_scale_set (Evas_Object *ob | |||
5562 | * | 5636 | * |
5563 | * @see evas_object_scale_set() | 5637 | * @see evas_object_scale_set() |
5564 | */ | 5638 | */ |
5565 | EAPI double evas_object_scale_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5639 | EAPI double evas_object_scale_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5566 | 5640 | ||
5567 | 5641 | ||
5568 | /** | 5642 | /** |
@@ -5579,7 +5653,7 @@ EAPI void evas_object_render_op_set (Evas_Object *ob | |||
5579 | * @return one of the enumerated values in Evas_Render_Op. | 5653 | * @return one of the enumerated values in Evas_Render_Op. |
5580 | * @ingroup Evas_Object_Group_Extras | 5654 | * @ingroup Evas_Object_Group_Extras |
5581 | */ | 5655 | */ |
5582 | EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5656 | EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5583 | 5657 | ||
5584 | /** | 5658 | /** |
5585 | * Set whether to use precise (usually expensive) point collision | 5659 | * Set whether to use precise (usually expensive) point collision |
@@ -5621,7 +5695,7 @@ EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Obje | |||
5621 | * | 5695 | * |
5622 | * @ingroup Evas_Object_Group_Extras | 5696 | * @ingroup Evas_Object_Group_Extras |
5623 | */ | 5697 | */ |
5624 | EAPI Eina_Bool evas_object_precise_is_inside_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5698 | EAPI Eina_Bool evas_object_precise_is_inside_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5625 | 5699 | ||
5626 | /** | 5700 | /** |
5627 | * Set a hint flag on the given Evas object that it's used as a "static | 5701 | * Set a hint flag on the given Evas object that it's used as a "static |
@@ -5653,7 +5727,7 @@ EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Obje | |||
5653 | * | 5727 | * |
5654 | * @ingroup Evas_Object_Group_Extras | 5728 | * @ingroup Evas_Object_Group_Extras |
5655 | */ | 5729 | */ |
5656 | EAPI Eina_Bool evas_object_static_clip_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5730 | EAPI Eina_Bool evas_object_static_clip_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5657 | 5731 | ||
5658 | /** | 5732 | /** |
5659 | * @} | 5733 | * @} |
@@ -5710,7 +5784,7 @@ EAPI Evas_Render_Op evas_object_render_op_get (const Evas_Obje | |||
5710 | * | 5784 | * |
5711 | * @ingroup Evas_Object_Group_Find | 5785 | * @ingroup Evas_Object_Group_Find |
5712 | */ | 5786 | */ |
5713 | EAPI Evas_Object *evas_focus_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5787 | EAPI Evas_Object *evas_focus_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5714 | 5788 | ||
5715 | /** | 5789 | /** |
5716 | * Retrieves the object on the given evas with the given name. | 5790 | * Retrieves the object on the given evas with the given name. |
@@ -5718,9 +5792,36 @@ EAPI Evas_Object *evas_focus_get (const Evas *e) EINA_WA | |||
5718 | * @param name The given name. | 5792 | * @param name The given name. |
5719 | * @return If successful, the Evas object with the given name. Otherwise, | 5793 | * @return If successful, the Evas object with the given name. Otherwise, |
5720 | * @c NULL. | 5794 | * @c NULL. |
5795 | * | ||
5796 | * This looks for the evas object given a name by evas_object_name_set(). If | ||
5797 | * the name is not unique canvas-wide, then which one of the many objects | ||
5798 | * with that name is returned is undefined, so only use this if you can ensure | ||
5799 | * the object name is unique. | ||
5800 | * | ||
5801 | * @ingroup Evas_Object_Group_Find | ||
5802 | */ | ||
5803 | EAPI Evas_Object *evas_object_name_find (const Evas *e, const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); | ||
5804 | |||
5805 | /** | ||
5806 | * Retrieves the object from children of the given object with the given name. | ||
5807 | * @param obj The parent (smart) object whose children to search. | ||
5808 | * @param name The given name. | ||
5809 | * @param recurse Set to the number of child levels to recurse (0 == don't recurse, 1 == only look at the children of @p obj or their immediate children, but no further etc.). | ||
5810 | * @return If successful, the Evas object with the given name. Otherwise, | ||
5811 | * @c NULL. | ||
5812 | * | ||
5813 | * This looks for the evas object given a name by evas_object_name_set(), but | ||
5814 | * it ONLY looks at the children of the object *p obj, and will only recurse | ||
5815 | * into those children if @p recurse is greater than 0. If the name is not | ||
5816 | * unique within immediate children (or the whole child tree) then it is not | ||
5817 | * defined which child object will be returned. If @p recurse is set to -1 then | ||
5818 | * it will recurse without limit. | ||
5819 | * | ||
5820 | * @since 1.2 | ||
5821 | * | ||
5721 | * @ingroup Evas_Object_Group_Find | 5822 | * @ingroup Evas_Object_Group_Find |
5722 | */ | 5823 | */ |
5723 | EAPI Evas_Object *evas_object_name_find (const Evas *e, const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5824 | EAPI Evas_Object *evas_object_name_child_find (const Evas_Object *obj, const char *name, int recurse) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5724 | 5825 | ||
5725 | /** | 5826 | /** |
5726 | * Retrieve the Evas object stacked at the top of a given position in | 5827 | * Retrieve the Evas object stacked at the top of a given position in |
@@ -5745,7 +5846,7 @@ EAPI Evas_Object *evas_object_name_find (const Evas *e, const c | |||
5745 | * objects, acting only on the ones at the "top level", with regard to | 5846 | * objects, acting only on the ones at the "top level", with regard to |
5746 | * object parenting. | 5847 | * object parenting. |
5747 | */ | 5848 | */ |
5748 | EAPI Evas_Object *evas_object_top_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5849 | EAPI Evas_Object *evas_object_top_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5749 | 5850 | ||
5750 | /** | 5851 | /** |
5751 | * Retrieve the Evas object stacked at the top at the position of the | 5852 | * Retrieve the Evas object stacked at the top at the position of the |
@@ -5763,7 +5864,7 @@ EAPI Evas_Object *evas_object_top_at_xy_get (const Evas *e, Evas_Co | |||
5763 | * objects, acting only on the ones at the "top level", with regard to | 5864 | * objects, acting only on the ones at the "top level", with regard to |
5764 | * object parenting. | 5865 | * object parenting. |
5765 | */ | 5866 | */ |
5766 | EAPI Evas_Object *evas_object_top_at_pointer_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5867 | EAPI Evas_Object *evas_object_top_at_pointer_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5767 | 5868 | ||
5768 | /** | 5869 | /** |
5769 | * Retrieve the Evas object stacked at the top of a given rectangular | 5870 | * Retrieve the Evas object stacked at the top of a given rectangular |
@@ -5793,7 +5894,7 @@ EAPI Evas_Object *evas_object_top_at_pointer_get (const Evas *e) EINA_WA | |||
5793 | * objects, acting only on the ones at the "top level", with regard to | 5894 | * objects, acting only on the ones at the "top level", with regard to |
5794 | * object parenting. | 5895 | * object parenting. |
5795 | */ | 5896 | */ |
5796 | EAPI Evas_Object *evas_object_top_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5897 | EAPI Evas_Object *evas_object_top_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5797 | 5898 | ||
5798 | /** | 5899 | /** |
5799 | * Retrieve a list of Evas objects lying over a given position in | 5900 | * Retrieve a list of Evas objects lying over a given position in |
@@ -5818,8 +5919,8 @@ EAPI Evas_Object *evas_object_top_in_rectangle_get (const Evas *e, Evas_Co | |||
5818 | * objects, acting only on the ones at the "top level", with regard to | 5919 | * objects, acting only on the ones at the "top level", with regard to |
5819 | * object parenting. | 5920 | * object parenting. |
5820 | */ | 5921 | */ |
5821 | EAPI Eina_List *evas_objects_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5922 | EAPI Eina_List *evas_objects_at_xy_get (const Evas *e, Evas_Coord x, Evas_Coord y, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5822 | EAPI Eina_List *evas_objects_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5923 | EAPI Eina_List *evas_objects_in_rectangle_get (const Evas *e, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool include_pass_events_objects, Eina_Bool include_hidden_objects) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5823 | 5924 | ||
5824 | /** | 5925 | /** |
5825 | * Get the lowest (stacked) Evas object on the canvas @p | 5926 | * Get the lowest (stacked) Evas object on the canvas @p |
@@ -5840,7 +5941,7 @@ EAPI Eina_List *evas_objects_at_xy_get (const Evas *e, Evas_Co | |||
5840 | * objects, acting only on the ones at the "top level", with regard to | 5941 | * objects, acting only on the ones at the "top level", with regard to |
5841 | * object parenting. | 5942 | * object parenting. |
5842 | */ | 5943 | */ |
5843 | EAPI Evas_Object *evas_object_bottom_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5944 | EAPI Evas_Object *evas_object_bottom_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5844 | 5945 | ||
5845 | /** | 5946 | /** |
5846 | * Get the highest (stacked) Evas object on the canvas @p | 5947 | * Get the highest (stacked) Evas object on the canvas @p |
@@ -5862,7 +5963,7 @@ EAPI Evas_Object *evas_object_bottom_get (const Evas *e) EINA_WA | |||
5862 | * objects, acting only on the ones at the "top level", with regard to | 5963 | * objects, acting only on the ones at the "top level", with regard to |
5863 | * object parenting. | 5964 | * object parenting. |
5864 | */ | 5965 | */ |
5865 | EAPI Evas_Object *evas_object_top_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 5966 | EAPI Evas_Object *evas_object_top_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
5866 | 5967 | ||
5867 | /** | 5968 | /** |
5868 | * @} | 5969 | * @} |
@@ -6502,7 +6603,7 @@ EAPI void evas_object_image_border_center_fill_set (Evas_Obj | |||
6502 | * | 6603 | * |
6503 | * See @ref evas_object_image_fill_set() for more details. | 6604 | * See @ref evas_object_image_fill_set() for more details. |
6504 | */ | 6605 | */ |
6505 | EAPI Evas_Border_Fill_Mode evas_object_image_border_center_fill_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6606 | EAPI Evas_Border_Fill_Mode evas_object_image_border_center_fill_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6506 | 6607 | ||
6507 | /** | 6608 | /** |
6508 | * Set whether the image object's fill property should track the | 6609 | * Set whether the image object's fill property should track the |
@@ -6532,7 +6633,7 @@ EAPI void evas_object_image_filled_set (Evas_Obj | |||
6532 | * | 6633 | * |
6533 | * @see evas_object_image_filled_set() for more information | 6634 | * @see evas_object_image_filled_set() for more information |
6534 | */ | 6635 | */ |
6535 | EAPI Eina_Bool evas_object_image_filled_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6636 | EAPI Eina_Bool evas_object_image_filled_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6536 | 6637 | ||
6537 | /** | 6638 | /** |
6538 | * Sets the scaling factor (multiplier) for the borders of an image | 6639 | * Sets the scaling factor (multiplier) for the borders of an image |
@@ -6633,7 +6734,7 @@ EAPI void evas_object_image_fill_spread_set (Evas_Obj | |||
6633 | * @param obj The given evas image object. | 6734 | * @param obj The given evas image object. |
6634 | * @return The current spread mode of the image object. | 6735 | * @return The current spread mode of the image object. |
6635 | */ | 6736 | */ |
6636 | EAPI Evas_Fill_Spread evas_object_image_fill_spread_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6737 | EAPI Evas_Fill_Spread evas_object_image_fill_spread_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6637 | 6738 | ||
6638 | /** | 6739 | /** |
6639 | * Sets the size of the given image object. | 6740 | * Sets the size of the given image object. |
@@ -6670,7 +6771,7 @@ EAPI void evas_object_image_size_get (const Ev | |||
6670 | * The row stride is the number of bytes between the start of a row | 6771 | * The row stride is the number of bytes between the start of a row |
6671 | * and the start of the next row for image data. | 6772 | * and the start of the next row for image data. |
6672 | */ | 6773 | */ |
6673 | EAPI int evas_object_image_stride_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6774 | EAPI int evas_object_image_stride_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6674 | 6775 | ||
6675 | /** | 6776 | /** |
6676 | * Retrieves a number representing any error that occurred during the | 6777 | * Retrieves a number representing any error that occurred during the |
@@ -6681,7 +6782,7 @@ EAPI int evas_object_image_stride_get (const Ev | |||
6681 | * one of the #Evas_Load_Error values. #EVAS_LOAD_ERROR_NONE | 6782 | * one of the #Evas_Load_Error values. #EVAS_LOAD_ERROR_NONE |
6682 | * is returned if there was no error. | 6783 | * is returned if there was no error. |
6683 | */ | 6784 | */ |
6684 | EAPI Evas_Load_Error evas_object_image_load_error_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6785 | EAPI Evas_Load_Error evas_object_image_load_error_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6685 | 6786 | ||
6686 | /** | 6787 | /** |
6687 | * Sets the raw image data of the given image object. | 6788 | * Sets the raw image data of the given image object. |
@@ -6730,7 +6831,7 @@ EAPI void evas_object_image_data_set (Evas_Obj | |||
6730 | * | 6831 | * |
6731 | * @see evas_object_image_data_set() | 6832 | * @see evas_object_image_data_set() |
6732 | */ | 6833 | */ |
6733 | EAPI void *evas_object_image_data_get (const Evas_Object *obj, Eina_Bool for_writing) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6834 | EAPI void *evas_object_image_data_get (const Evas_Object *obj, Eina_Bool for_writing) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6734 | 6835 | ||
6735 | /** | 6836 | /** |
6736 | * Converts the raw image data of the given image object to the | 6837 | * Converts the raw image data of the given image object to the |
@@ -6748,7 +6849,7 @@ EAPI void *evas_object_image_data_get (const Ev | |||
6748 | * @param to_cspace The colorspace to which the image raw data will be converted. | 6849 | * @param to_cspace The colorspace to which the image raw data will be converted. |
6749 | * @return data A newly allocated data in the format specified by to_cspace. | 6850 | * @return data A newly allocated data in the format specified by to_cspace. |
6750 | */ | 6851 | */ |
6751 | EAPI void *evas_object_image_data_convert (Evas_Object *obj, Evas_Colorspace to_cspace) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6852 | EAPI void *evas_object_image_data_convert (Evas_Object *obj, Evas_Colorspace to_cspace) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6752 | 6853 | ||
6753 | /** | 6854 | /** |
6754 | * Replaces the raw image data of the given image object. | 6855 | * Replaces the raw image data of the given image object. |
@@ -6819,7 +6920,7 @@ EAPI void evas_object_image_alpha_set (Evas_Obj | |||
6819 | * | 6920 | * |
6820 | * See @ref evas_object_image_alpha_set() for more details. | 6921 | * See @ref evas_object_image_alpha_set() for more details. |
6821 | */ | 6922 | */ |
6822 | EAPI Eina_Bool evas_object_image_alpha_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6923 | EAPI Eina_Bool evas_object_image_alpha_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6823 | 6924 | ||
6824 | /** | 6925 | /** |
6825 | * Sets whether to use high-quality image scaling algorithm on the | 6926 | * Sets whether to use high-quality image scaling algorithm on the |
@@ -6849,7 +6950,7 @@ EAPI void evas_object_image_smooth_scale_set (Evas_Obj | |||
6849 | * | 6950 | * |
6850 | * See @ref evas_object_image_smooth_scale_set() for more details. | 6951 | * See @ref evas_object_image_smooth_scale_set() for more details. |
6851 | */ | 6952 | */ |
6852 | EAPI Eina_Bool evas_object_image_smooth_scale_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 6953 | EAPI Eina_Bool evas_object_image_smooth_scale_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6853 | 6954 | ||
6854 | /** | 6955 | /** |
6855 | * Preload an image object's image data in the background | 6956 | * Preload an image object's image data in the background |
@@ -6947,7 +7048,7 @@ EAPI void evas_object_image_pixels_dirty_set (Evas_Obj | |||
6947 | * @param obj The given image object. | 7048 | * @param obj The given image object. |
6948 | * @return Whether the image is dirty. | 7049 | * @return Whether the image is dirty. |
6949 | */ | 7050 | */ |
6950 | EAPI Eina_Bool evas_object_image_pixels_dirty_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7051 | EAPI Eina_Bool evas_object_image_pixels_dirty_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6951 | 7052 | ||
6952 | /** | 7053 | /** |
6953 | * Set the DPI resolution of an image object's source image. | 7054 | * Set the DPI resolution of an image object's source image. |
@@ -6972,7 +7073,7 @@ EAPI void evas_object_image_load_dpi_set (Evas_Obj | |||
6972 | * | 7073 | * |
6973 | * @see evas_object_image_load_dpi_set() for more details | 7074 | * @see evas_object_image_load_dpi_set() for more details |
6974 | */ | 7075 | */ |
6975 | EAPI double evas_object_image_load_dpi_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7076 | EAPI double evas_object_image_load_dpi_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
6976 | 7077 | ||
6977 | /** | 7078 | /** |
6978 | * Set the size of a given image object's source image, when loading | 7079 | * Set the size of a given image object's source image, when loading |
@@ -7026,7 +7127,7 @@ EAPI void evas_object_image_load_scale_down_set (Evas_Obj | |||
7026 | * | 7127 | * |
7027 | * @see evas_object_image_load_scale_down_set() for more details | 7128 | * @see evas_object_image_load_scale_down_set() for more details |
7028 | */ | 7129 | */ |
7029 | EAPI int evas_object_image_load_scale_down_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7130 | EAPI int evas_object_image_load_scale_down_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7030 | 7131 | ||
7031 | /** | 7132 | /** |
7032 | * Inform a given image object to load a selective region of its | 7133 | * Inform a given image object to load a selective region of its |
@@ -7103,7 +7204,18 @@ EAPI void evas_object_image_colorspace_set (Evas_Obj | |||
7103 | * This function returns the colorspace of given canvas image. | 7204 | * This function returns the colorspace of given canvas image. |
7104 | * | 7205 | * |
7105 | */ | 7206 | */ |
7106 | EAPI Evas_Colorspace evas_object_image_colorspace_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7207 | EAPI Evas_Colorspace evas_object_image_colorspace_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7208 | |||
7209 | /** | ||
7210 | * Get the support state of a given image | ||
7211 | * | ||
7212 | * @param obj The given image object pointer | ||
7213 | * @return The region support state | ||
7214 | * @since 1.2.0 | ||
7215 | * | ||
7216 | * This function returns the state of the region support of given image | ||
7217 | */ | ||
7218 | EAPI Eina_Bool evas_object_image_region_support_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); | ||
7107 | 7219 | ||
7108 | /** | 7220 | /** |
7109 | * Set the native surface of a given image of the canvas | 7221 | * Set the native surface of a given image of the canvas |
@@ -7125,7 +7237,7 @@ EAPI void evas_object_image_native_surface_set (Evas_Obj | |||
7125 | * This function returns the native surface of a given canvas image. | 7237 | * This function returns the native surface of a given canvas image. |
7126 | * | 7238 | * |
7127 | */ | 7239 | */ |
7128 | EAPI Evas_Native_Surface *evas_object_image_native_surface_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7240 | EAPI Evas_Native_Surface *evas_object_image_native_surface_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7129 | 7241 | ||
7130 | /** | 7242 | /** |
7131 | * Set the video surface linked to a given image of the canvas | 7243 | * Set the video surface linked to a given image of the canvas |
@@ -7149,7 +7261,7 @@ EAPI void evas_object_image_video_surface_set (Evas_Obj | |||
7149 | * This function returns the video surface linked to a given canvas image. | 7261 | * This function returns the video surface linked to a given canvas image. |
7150 | * | 7262 | * |
7151 | */ | 7263 | */ |
7152 | EAPI const Evas_Video_Surface *evas_object_image_video_surface_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7264 | EAPI const Evas_Video_Surface *evas_object_image_video_surface_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7153 | 7265 | ||
7154 | /** | 7266 | /** |
7155 | * Set the scale hint of a given image of the canvas. | 7267 | * Set the scale hint of a given image of the canvas. |
@@ -7178,7 +7290,7 @@ EAPI void evas_object_image_scale_hint_set (Evas_Obj | |||
7178 | * | 7290 | * |
7179 | * @see evas_object_image_scale_hint_set() for more details. | 7291 | * @see evas_object_image_scale_hint_set() for more details. |
7180 | */ | 7292 | */ |
7181 | EAPI Evas_Image_Scale_Hint evas_object_image_scale_hint_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7293 | EAPI Evas_Image_Scale_Hint evas_object_image_scale_hint_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7182 | 7294 | ||
7183 | /** | 7295 | /** |
7184 | * Set the content hint setting of a given image object of the canvas. | 7296 | * Set the content hint setting of a given image object of the canvas. |
@@ -7210,7 +7322,7 @@ EAPI void evas_object_image_content_hint_set (Evas_Obj | |||
7210 | * | 7322 | * |
7211 | * @see evas_object_image_content_hint_set() | 7323 | * @see evas_object_image_content_hint_set() |
7212 | */ | 7324 | */ |
7213 | EAPI Evas_Image_Content_Hint evas_object_image_content_hint_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7325 | EAPI Evas_Image_Content_Hint evas_object_image_content_hint_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7214 | 7326 | ||
7215 | 7327 | ||
7216 | /** | 7328 | /** |
@@ -7563,7 +7675,7 @@ EAPI void evas_object_text_font_source_set (Evas_Object *obj, cons | |||
7563 | * | 7675 | * |
7564 | * @see evas_object_text_font_get() for more details | 7676 | * @see evas_object_text_font_get() for more details |
7565 | */ | 7677 | */ |
7566 | EAPI const char *evas_object_text_font_source_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7678 | EAPI const char *evas_object_text_font_source_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7567 | 7679 | ||
7568 | /** | 7680 | /** |
7569 | * Set the font family and size on a given text object. | 7681 | * Set the font family and size on a given text object. |
@@ -7620,7 +7732,7 @@ EAPI void evas_object_text_text_set (Evas_Object *obj, cons | |||
7620 | * | 7732 | * |
7621 | * @see evas_object_text_text_set() | 7733 | * @see evas_object_text_text_set() |
7622 | */ | 7734 | */ |
7623 | EAPI const char *evas_object_text_text_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7735 | EAPI const char *evas_object_text_text_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7624 | 7736 | ||
7625 | /** | 7737 | /** |
7626 | * @brief Sets the BiDi delimiters used in the textblock. | 7738 | * @brief Sets the BiDi delimiters used in the textblock. |
@@ -7648,13 +7760,13 @@ EAPI void evas_object_text_bidi_delimiters_set(Evas_Object *obj, co | |||
7648 | */ | 7760 | */ |
7649 | EAPI const char *evas_object_text_bidi_delimiters_get(const Evas_Object *obj); | 7761 | EAPI const char *evas_object_text_bidi_delimiters_get(const Evas_Object *obj); |
7650 | 7762 | ||
7651 | EAPI Evas_Coord evas_object_text_ascent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7763 | EAPI Evas_Coord evas_object_text_ascent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7652 | EAPI Evas_Coord evas_object_text_descent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7764 | EAPI Evas_Coord evas_object_text_descent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7653 | EAPI Evas_Coord evas_object_text_max_ascent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7765 | EAPI Evas_Coord evas_object_text_max_ascent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7654 | EAPI Evas_Coord evas_object_text_max_descent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7766 | EAPI Evas_Coord evas_object_text_max_descent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7655 | EAPI Evas_Coord evas_object_text_horiz_advance_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7767 | EAPI Evas_Coord evas_object_text_horiz_advance_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7656 | EAPI Evas_Coord evas_object_text_vert_advance_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7768 | EAPI Evas_Coord evas_object_text_vert_advance_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7657 | EAPI Evas_Coord evas_object_text_inset_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7769 | EAPI Evas_Coord evas_object_text_inset_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7658 | 7770 | ||
7659 | /** | 7771 | /** |
7660 | * Retrieve position and dimension information of a character within a text @c Evas_Object. | 7772 | * Retrieve position and dimension information of a character within a text @c Evas_Object. |
@@ -7692,7 +7804,7 @@ EAPI int evas_object_text_last_up_to_pos (const Evas_Object *obj | |||
7692 | * | 7804 | * |
7693 | * @see evas_object_text_style_set() for more details. | 7805 | * @see evas_object_text_style_set() for more details. |
7694 | */ | 7806 | */ |
7695 | EAPI Evas_Text_Style_Type evas_object_text_style_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 7807 | EAPI Evas_Text_Style_Type evas_object_text_style_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
7696 | 7808 | ||
7697 | /** | 7809 | /** |
7698 | * Sets the style to apply on the given text object. | 7810 | * Sets the style to apply on the given text object. |
@@ -7742,7 +7854,7 @@ EAPI void evas_object_text_style_set (Evas_Object *obj, Evas | |||
7742 | * - #EVAS_TEXT_STYLE_SOFT_SHADOW | 7854 | * - #EVAS_TEXT_STYLE_SOFT_SHADOW |
7743 | * - #EVAS_TEXT_STYLE_FAR_SOFT_SHADOW | 7855 | * - #EVAS_TEXT_STYLE_FAR_SOFT_SHADOW |
7744 | * | 7856 | * |
7745 | * One can also change de direction the shadow grows to, with | 7857 | * One can also change the direction where the shadow grows to, with |
7746 | * evas_object_text_style_set(). | 7858 | * evas_object_text_style_set(). |
7747 | * | 7859 | * |
7748 | * @see evas_object_text_shadow_color_get() | 7860 | * @see evas_object_text_shadow_color_get() |
@@ -8081,7 +8193,7 @@ EAPI Evas_Object *evas_object_textblock_add(Evas *e) EINA_WARN_U | |||
8081 | * @param escape the string to be escaped | 8193 | * @param escape the string to be escaped |
8082 | * @return the unescaped version of escape | 8194 | * @return the unescaped version of escape |
8083 | */ | 8195 | */ |
8084 | EAPI const char *evas_textblock_escape_string_get(const char *escape) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8196 | EAPI const char *evas_textblock_escape_string_get(const char *escape) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8085 | 8197 | ||
8086 | /** | 8198 | /** |
8087 | * Returns the escaped version of the string. | 8199 | * Returns the escaped version of the string. |
@@ -8089,7 +8201,7 @@ EAPI const char *evas_textblock_escape_string_get(const char *e | |||
8089 | * @param len_ret the len of the part of the string that was used. | 8201 | * @param len_ret the len of the part of the string that was used. |
8090 | * @return the escaped string. | 8202 | * @return the escaped string. |
8091 | */ | 8203 | */ |
8092 | EAPI const char *evas_textblock_string_escape_get(const char *string, int *len_ret) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8204 | EAPI const char *evas_textblock_string_escape_get(const char *string, int *len_ret) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8093 | 8205 | ||
8094 | /** | 8206 | /** |
8095 | * Return the unescaped version of the string between start and end. | 8207 | * Return the unescaped version of the string between start and end. |
@@ -8098,8 +8210,35 @@ EAPI const char *evas_textblock_string_escape_get(const char *s | |||
8098 | * @param escape_end the end of the string. | 8210 | * @param escape_end the end of the string. |
8099 | * @return the unescaped version of the range | 8211 | * @return the unescaped version of the range |
8100 | */ | 8212 | */ |
8101 | EAPI const char *evas_textblock_escape_string_range_get(const char *escape_start, const char *escape_end) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 8213 | EAPI const char *evas_textblock_escape_string_range_get(const char *escape_start, const char *escape_end) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
8102 | 8214 | ||
8215 | /** | ||
8216 | * Return the plain version of the markup. | ||
8217 | * | ||
8218 | * Works as if you set the markup to a textblock and then retrieve the plain | ||
8219 | * version of the text. i.e: <br> and <\n> will be replaced with \n, &...; with | ||
8220 | * the actual char and etc. | ||
8221 | * | ||
8222 | * @param obj the textblock object to work with. (if NULL, tries the default) | ||
8223 | * @param text the markup text (if NULL, return NULL) | ||
8224 | * @return an allocated plain text version of the markup | ||
8225 | * @since 1.2.0 | ||
8226 | */ | ||
8227 | EAPI char *evas_textblock_text_markup_to_utf8(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC; | ||
8228 | |||
8229 | /** | ||
8230 | * Return the markup version of the plain text. | ||
8231 | * | ||
8232 | * Replaces \n -> <br/> \t -> <tab/> and etc. Generally needed before you pass | ||
8233 | * plain text to be set in a textblock. | ||
8234 | * | ||
8235 | * @param obj the textblock object to work with (if NULL, it just does the | ||
8236 | * default behaviour, i.e with no extra object information). | ||
8237 | * @param text the markup text (if NULL, return NULL) | ||
8238 | * @return an allocated plain text version of the markup | ||
8239 | * @since 1.2.0 | ||
8240 | */ | ||
8241 | EAPI char *evas_textblock_text_utf8_to_markup(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC; | ||
8103 | 8242 | ||
8104 | /** | 8243 | /** |
8105 | * Creates a new textblock style. | 8244 | * Creates a new textblock style. |
@@ -8128,7 +8267,7 @@ EAPI void evas_textblock_style_set(Evas_Textblock_Style | |||
8128 | * @param ts the style to get it's text. | 8267 | * @param ts the style to get it's text. |
8129 | * @return the text of the style or null on error. | 8268 | * @return the text of the style or null on error. |
8130 | */ | 8269 | */ |
8131 | EAPI const char *evas_textblock_style_get(const Evas_Textblock_Style *ts) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8270 | EAPI const char *evas_textblock_style_get(const Evas_Textblock_Style *ts) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8132 | 8271 | ||
8133 | 8272 | ||
8134 | /** | 8273 | /** |
@@ -8144,7 +8283,7 @@ EAPI void evas_object_textblock_style_set(Evas_Object *o | |||
8144 | * @param obj the object to get the style from. | 8283 | * @param obj the object to get the style from. |
8145 | * @return the style of the object. | 8284 | * @return the style of the object. |
8146 | */ | 8285 | */ |
8147 | EAPI const Evas_Textblock_Style *evas_object_textblock_style_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8286 | EAPI const Evas_Textblock_Style *evas_object_textblock_style_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8148 | 8287 | ||
8149 | /** | 8288 | /** |
8150 | * @brief Set the "replacement character" to use for the given textblock object. | 8289 | * @brief Set the "replacement character" to use for the given textblock object. |
@@ -8161,7 +8300,7 @@ EAPI void evas_object_textblock_replace_char_set(Evas_Ob | |||
8161 | * @param obj The given textblock object | 8300 | * @param obj The given textblock object |
8162 | * @return replacement character or @c NULL | 8301 | * @return replacement character or @c NULL |
8163 | */ | 8302 | */ |
8164 | EAPI const char *evas_object_textblock_replace_char_get(Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8303 | EAPI const char *evas_object_textblock_replace_char_get(Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8165 | 8304 | ||
8166 | /** | 8305 | /** |
8167 | * @brief Sets the vertical alignment of text within the textblock object | 8306 | * @brief Sets the vertical alignment of text within the textblock object |
@@ -8230,7 +8369,7 @@ EAPI void evas_object_textblock_legacy_newline_set(Evas_ | |||
8230 | * @return EINA_TRUE if in legacy mode, EINA_FALSE otherwise. | 8369 | * @return EINA_TRUE if in legacy mode, EINA_FALSE otherwise. |
8231 | * @since 1.1.0 | 8370 | * @since 1.1.0 |
8232 | */ | 8371 | */ |
8233 | EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8372 | EAPI Eina_Bool evas_object_textblock_legacy_newline_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8234 | 8373 | ||
8235 | 8374 | ||
8236 | /** | 8375 | /** |
@@ -8270,7 +8409,7 @@ EAPI const char *evas_object_textblock_text_markup_get(const Ev | |||
8270 | * @param obj the object. | 8409 | * @param obj the object. |
8271 | * @return the obj's main cursor. | 8410 | * @return the obj's main cursor. |
8272 | */ | 8411 | */ |
8273 | EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8412 | EAPI Evas_Textblock_Cursor *evas_object_textblock_cursor_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8274 | 8413 | ||
8275 | /** | 8414 | /** |
8276 | * Create a new cursor, associate it to the obj and init it to point | 8415 | * Create a new cursor, associate it to the obj and init it to point |
@@ -8421,7 +8560,7 @@ EAPI void evas_textblock_cursor_at_format_set(Evas_Textb | |||
8421 | * @return #EINA_TRUE if the cursor points to a visible format, #EINA_FALSE otherwise. | 8560 | * @return #EINA_TRUE if the cursor points to a visible format, #EINA_FALSE otherwise. |
8422 | * @see evas_textblock_cursor_format_get() | 8561 | * @see evas_textblock_cursor_format_get() |
8423 | */ | 8562 | */ |
8424 | EAPI Eina_Bool evas_textblock_cursor_format_is_visible_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8563 | EAPI Eina_Bool evas_textblock_cursor_format_is_visible_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8425 | 8564 | ||
8426 | /** | 8565 | /** |
8427 | * Advances to the next format node | 8566 | * Advances to the next format node |
@@ -8464,6 +8603,24 @@ EAPI Eina_Bool evas_textblock_cursor_char_next(Evas_Textblock | |||
8464 | EAPI Eina_Bool evas_textblock_cursor_char_prev(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); | 8603 | EAPI Eina_Bool evas_textblock_cursor_char_prev(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); |
8465 | 8604 | ||
8466 | /** | 8605 | /** |
8606 | * Moves the cursor to the start of the word under the cursor. | ||
8607 | * | ||
8608 | * @param cur the cursor to move. | ||
8609 | * @return #EINA_TRUE on success #EINA_FALSE otherwise. | ||
8610 | * @since 1.2.0 | ||
8611 | */ | ||
8612 | EAPI Eina_Bool evas_textblock_cursor_word_start(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); | ||
8613 | |||
8614 | /** | ||
8615 | * Moves the cursor to the end of the word under the cursor. | ||
8616 | * | ||
8617 | * @param cur the cursor to move. | ||
8618 | * @return #EINA_TRUE on success #EINA_FALSE otherwise. | ||
8619 | * @since 1.2.0 | ||
8620 | */ | ||
8621 | EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); | ||
8622 | |||
8623 | /** | ||
8467 | * Go to the first char in the node the cursor is pointing on. | 8624 | * Go to the first char in the node the cursor is pointing on. |
8468 | * | 8625 | * |
8469 | * @param cur the cursor to update. | 8626 | * @param cur the cursor to update. |
@@ -8501,7 +8658,7 @@ EAPI void evas_textblock_cursor_line_char_last(Evas_Text | |||
8501 | * @param cur the cursor to take the position from. | 8658 | * @param cur the cursor to take the position from. |
8502 | * @return the position or -1 on error | 8659 | * @return the position or -1 on error |
8503 | */ | 8660 | */ |
8504 | EAPI int evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8661 | EAPI int evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8505 | 8662 | ||
8506 | /** | 8663 | /** |
8507 | * Set the cursor pos. | 8664 | * Set the cursor pos. |
@@ -8527,7 +8684,7 @@ EAPI Eina_Bool evas_textblock_cursor_line_set(Evas_Textblock_ | |||
8527 | * @param cur2 the second cursor. | 8684 | * @param cur2 the second cursor. |
8528 | * @return -1 if cur1 < cur2, 0 if cur1 == cur2 and 1 otherwise. | 8685 | * @return -1 if cur1 < cur2, 0 if cur1 == cur2 and 1 otherwise. |
8529 | */ | 8686 | */ |
8530 | EAPI int evas_textblock_cursor_compare(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 8687 | EAPI int evas_textblock_cursor_compare(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
8531 | 8688 | ||
8532 | /** | 8689 | /** |
8533 | * Make cur_dest point to the same place as cur. Does not work if they don't | 8690 | * Make cur_dest point to the same place as cur. Does not work if they don't |
@@ -8630,7 +8787,7 @@ EAPI void evas_textblock_cursor_range_delete(Evas_Textbl | |||
8630 | * @param cur the cursor pointing to the paragraph. | 8787 | * @param cur the cursor pointing to the paragraph. |
8631 | * @return the text on success, NULL otherwise. | 8788 | * @return the text on success, NULL otherwise. |
8632 | */ | 8789 | */ |
8633 | EAPI const char *evas_textblock_cursor_paragraph_text_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8790 | EAPI const char *evas_textblock_cursor_paragraph_text_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8634 | 8791 | ||
8635 | /** | 8792 | /** |
8636 | * Return the length of the paragraph, cheaper the eina_unicode_strlen() | 8793 | * Return the length of the paragraph, cheaper the eina_unicode_strlen() |
@@ -8638,7 +8795,7 @@ EAPI const char *evas_textblock_cursor_paragraph_text_get(const | |||
8638 | * @param cur the position of the paragraph. | 8795 | * @param cur the position of the paragraph. |
8639 | * @return the length of the paragraph on success, -1 otehrwise. | 8796 | * @return the length of the paragraph on success, -1 otehrwise. |
8640 | */ | 8797 | */ |
8641 | EAPI int evas_textblock_cursor_paragraph_text_length_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8798 | EAPI int evas_textblock_cursor_paragraph_text_length_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8642 | 8799 | ||
8643 | /** | 8800 | /** |
8644 | * Return the currently visible range. | 8801 | * Return the currently visible range. |
@@ -8648,7 +8805,7 @@ EAPI int evas_textblock_cursor_paragraph_text_length_ge | |||
8648 | * @return EINA_TRUE on success. EINA_FALSE otherwise. | 8805 | * @return EINA_TRUE on success. EINA_FALSE otherwise. |
8649 | * @since 1.1.0 | 8806 | * @since 1.1.0 |
8650 | */ | 8807 | */ |
8651 | Eina_Bool evas_textblock_cursor_visible_range_get(Evas_Textblock_Cursor *start, Evas_Textblock_Cursor *end) EINA_ARG_NONNULL(1, 2); | 8808 | EAPI Eina_Bool evas_textblock_cursor_visible_range_get(Evas_Textblock_Cursor *start, Evas_Textblock_Cursor *end) EINA_ARG_NONNULL(1, 2); |
8652 | 8809 | ||
8653 | /** | 8810 | /** |
8654 | * Return the format nodes in the range between cur1 and cur2. | 8811 | * Return the format nodes in the range between cur1 and cur2. |
@@ -8658,7 +8815,7 @@ Eina_Bool evas_textblock_cursor_visible_range_get(Evas_T | |||
8658 | * @return the foramt nodes in the range. You have to free it. | 8815 | * @return the foramt nodes in the range. You have to free it. |
8659 | * @since 1.1.0 | 8816 | * @since 1.1.0 |
8660 | */ | 8817 | */ |
8661 | EAPI Eina_List * evas_textblock_cursor_range_formats_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 8818 | EAPI Eina_List * evas_textblock_cursor_range_formats_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
8662 | 8819 | ||
8663 | /** | 8820 | /** |
8664 | * Return the text in the range between cur1 and cur2 | 8821 | * Return the text in the range between cur1 and cur2 |
@@ -8669,13 +8826,15 @@ EAPI Eina_List * evas_textblock_cursor_range_formats_get(const E | |||
8669 | * @return the text in the range | 8826 | * @return the text in the range |
8670 | * @see elm_entry_markup_to_utf8() | 8827 | * @see elm_entry_markup_to_utf8() |
8671 | */ | 8828 | */ |
8672 | EAPI char *evas_textblock_cursor_range_text_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2, Evas_Textblock_Text_Type format) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 8829 | EAPI char *evas_textblock_cursor_range_text_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2, Evas_Textblock_Text_Type format) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
8673 | 8830 | ||
8674 | /** | 8831 | /** |
8675 | * Return the content of the cursor. | 8832 | * Return the content of the cursor. |
8676 | * | 8833 | * |
8834 | * Free the returned string pointer when done (if it is not NULL). | ||
8835 | * | ||
8677 | * @param cur the cursor | 8836 | * @param cur the cursor |
8678 | * @return the text in the range | 8837 | * @return the text in the range, terminated by a nul byte (may be utf8). |
8679 | */ | 8838 | */ |
8680 | EAPI char *evas_textblock_cursor_content_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; | 8839 | EAPI char *evas_textblock_cursor_content_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; |
8681 | 8840 | ||
@@ -8766,7 +8925,7 @@ EAPI int evas_textblock_cursor_line_coord_set(Evas_Text | |||
8766 | * @param cur2 other side of the range. | 8925 | * @param cur2 other side of the range. |
8767 | * @return a list of Rectangles representing the geometry of the range. | 8926 | * @return a list of Rectangles representing the geometry of the range. |
8768 | */ | 8927 | */ |
8769 | EAPI Eina_List *evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 8928 | EAPI Eina_List *evas_textblock_cursor_range_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
8770 | EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1); | 8929 | EAPI Eina_Bool evas_textblock_cursor_format_item_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1); |
8771 | 8930 | ||
8772 | 8931 | ||
@@ -8776,7 +8935,7 @@ EAPI Eina_List *evas_textblock_cursor_range_geometry_get(const | |||
8776 | * @param cur the cursor to check. | 8935 | * @param cur the cursor to check. |
8777 | * @return #EINA_TRUE if true, #EINA_FALSE otherwise. | 8936 | * @return #EINA_TRUE if true, #EINA_FALSE otherwise. |
8778 | */ | 8937 | */ |
8779 | EAPI Eina_Bool evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 8938 | EAPI Eina_Bool evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
8780 | 8939 | ||
8781 | 8940 | ||
8782 | /** | 8941 | /** |
@@ -8931,6 +9090,12 @@ EAPI void evas_object_polygon_points_clear (Evas_Object *obj) EINA | |||
8931 | * @} | 9090 | * @} |
8932 | */ | 9091 | */ |
8933 | 9092 | ||
9093 | /* @since 1.2.0 */ | ||
9094 | EAPI void evas_object_is_frame_object_set(Evas_Object *obj, Eina_Bool is_frame); | ||
9095 | |||
9096 | /* @since 1.2.0 */ | ||
9097 | EAPI Eina_Bool evas_object_is_frame_object_get(Evas_Object *obj); | ||
9098 | |||
8934 | /** | 9099 | /** |
8935 | * @defgroup Evas_Smart_Group Smart Functions | 9100 | * @defgroup Evas_Smart_Group Smart Functions |
8936 | * | 9101 | * |
@@ -9273,7 +9438,7 @@ EAPI Evas_Smart *evas_smart_class_new (const | |||
9273 | * @param s a valid #Evas_Smart pointer | 9438 | * @param s a valid #Evas_Smart pointer |
9274 | * @return the #Evas_Smart_Class in it | 9439 | * @return the #Evas_Smart_Class in it |
9275 | */ | 9440 | */ |
9276 | EAPI const Evas_Smart_Class *evas_smart_class_get (const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9441 | EAPI const Evas_Smart_Class *evas_smart_class_get (const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9277 | 9442 | ||
9278 | 9443 | ||
9279 | /** | 9444 | /** |
@@ -9284,7 +9449,7 @@ EAPI const Evas_Smart_Class *evas_smart_class_get (const | |||
9284 | * This data pointer is set as the data field in the #Evas_Smart_Class | 9449 | * This data pointer is set as the data field in the #Evas_Smart_Class |
9285 | * passed in to evas_smart_class_new(). | 9450 | * passed in to evas_smart_class_new(). |
9286 | */ | 9451 | */ |
9287 | EAPI void *evas_smart_data_get (const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9452 | EAPI void *evas_smart_data_get (const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9288 | 9453 | ||
9289 | /** | 9454 | /** |
9290 | * Get the smart callbacks known by this #Evas_Smart handle's smart | 9455 | * Get the smart callbacks known by this #Evas_Smart handle's smart |
@@ -9338,7 +9503,7 @@ EAPI const Evas_Smart_Cb_Description **evas_smart_callbacks_descriptions_get(con | |||
9338 | * | 9503 | * |
9339 | * @see evas_smart_callbacks_descriptions_get() | 9504 | * @see evas_smart_callbacks_descriptions_get() |
9340 | */ | 9505 | */ |
9341 | EAPI const Evas_Smart_Cb_Description *evas_smart_callback_description_find(const Evas_Smart *s, const char *name) EINA_ARG_NONNULL(1, 2) EINA_PURE; | 9506 | EAPI const Evas_Smart_Cb_Description *evas_smart_callback_description_find(const Evas_Smart *s, const char *name) EINA_ARG_NONNULL(1, 2); |
9342 | 9507 | ||
9343 | 9508 | ||
9344 | /** | 9509 | /** |
@@ -9507,7 +9672,7 @@ EAPI void evas_object_smart_member_del (Evas_Object *obj) EINA | |||
9507 | * @see evas_object_smart_member_add() | 9672 | * @see evas_object_smart_member_add() |
9508 | * @see evas_object_smart_member_del() | 9673 | * @see evas_object_smart_member_del() |
9509 | */ | 9674 | */ |
9510 | EAPI Eina_List *evas_object_smart_members_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9675 | EAPI Eina_List *evas_object_smart_members_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9511 | 9676 | ||
9512 | /** | 9677 | /** |
9513 | * Gets the parent smart object of a given Evas object, if it has one. | 9678 | * Gets the parent smart object of a given Evas object, if it has one. |
@@ -9519,7 +9684,7 @@ EAPI Eina_List *evas_object_smart_members_get (const Evas_Object *obj | |||
9519 | * | 9684 | * |
9520 | * @ingroup Evas_Smart_Object_Group | 9685 | * @ingroup Evas_Smart_Object_Group |
9521 | */ | 9686 | */ |
9522 | EAPI Evas_Object *evas_object_smart_parent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9687 | EAPI Evas_Object *evas_object_smart_parent_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9523 | 9688 | ||
9524 | /** | 9689 | /** |
9525 | * Checks whether a given smart object or any of its smart object | 9690 | * Checks whether a given smart object or any of its smart object |
@@ -9546,7 +9711,7 @@ EAPI Evas_Object *evas_object_smart_parent_get (const Evas_Object *obj | |||
9546 | * | 9711 | * |
9547 | * @ingroup Evas_Smart_Object_Group | 9712 | * @ingroup Evas_Smart_Object_Group |
9548 | */ | 9713 | */ |
9549 | EAPI Eina_Bool evas_object_smart_type_check (const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 9714 | EAPI Eina_Bool evas_object_smart_type_check (const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
9550 | 9715 | ||
9551 | /** | 9716 | /** |
9552 | * Checks whether a given smart object or any of its smart object | 9717 | * Checks whether a given smart object or any of its smart object |
@@ -9561,7 +9726,7 @@ EAPI Eina_Bool evas_object_smart_type_check (const Evas_Object *obj | |||
9561 | * | 9726 | * |
9562 | * @ingroup Evas_Smart_Object_Group | 9727 | * @ingroup Evas_Smart_Object_Group |
9563 | */ | 9728 | */ |
9564 | EAPI Eina_Bool evas_object_smart_type_check_ptr (const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 9729 | EAPI Eina_Bool evas_object_smart_type_check_ptr (const Evas_Object *obj, const char *type) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
9565 | 9730 | ||
9566 | /** | 9731 | /** |
9567 | * Get the #Evas_Smart from which @p obj smart object was created. | 9732 | * Get the #Evas_Smart from which @p obj smart object was created. |
@@ -9571,7 +9736,7 @@ EAPI Eina_Bool evas_object_smart_type_check_ptr (const Evas_Object *obj | |||
9571 | * | 9736 | * |
9572 | * @ingroup Evas_Smart_Object_Group | 9737 | * @ingroup Evas_Smart_Object_Group |
9573 | */ | 9738 | */ |
9574 | EAPI Evas_Smart *evas_object_smart_smart_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9739 | EAPI Evas_Smart *evas_object_smart_smart_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9575 | 9740 | ||
9576 | /** | 9741 | /** |
9577 | * Retrieve user data stored on a given smart object. | 9742 | * Retrieve user data stored on a given smart object. |
@@ -9585,7 +9750,7 @@ EAPI Evas_Smart *evas_object_smart_smart_get (const Evas_Object *obj | |||
9585 | * | 9750 | * |
9586 | * @ingroup Evas_Smart_Object_Group | 9751 | * @ingroup Evas_Smart_Object_Group |
9587 | */ | 9752 | */ |
9588 | EAPI void *evas_object_smart_data_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 9753 | EAPI void *evas_object_smart_data_get (const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9589 | 9754 | ||
9590 | /** | 9755 | /** |
9591 | * Store a pointer to user data for a given smart object. | 9756 | * Store a pointer to user data for a given smart object. |
@@ -9683,6 +9848,34 @@ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, | |||
9683 | EAPI void *evas_object_smart_callback_del (Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3); | 9848 | EAPI void *evas_object_smart_callback_del (Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3); |
9684 | 9849 | ||
9685 | /** | 9850 | /** |
9851 | * Delete (unregister) a callback function from the smart event | ||
9852 | * specified by @p event on the smart object @p obj. | ||
9853 | * | ||
9854 | * @param obj a smart object | ||
9855 | * @param event the event's name string | ||
9856 | * @param func the callback function | ||
9857 | * @param data the data pointer that was passed to the callback | ||
9858 | * @return the data pointer | ||
9859 | * | ||
9860 | * This function removes <b>the first</b> added smart callback on the | ||
9861 | * object @p obj matching the event name @p event, the registered | ||
9862 | * function pointer @p func and the callback data pointer @p data. If | ||
9863 | * the removal is successful it will also return the data pointer that | ||
9864 | * was passed to evas_object_smart_callback_add() (that will be the same | ||
9865 | * as the parameter) when the callback(s) was(were) added to the canvas. | ||
9866 | * If not successful @c NULL will be returned. A common use would be to | ||
9867 | * remove an exact match of a callback | ||
9868 | * | ||
9869 | * @see evas_object_smart_callback_add() for more details. | ||
9870 | * @since 1.2.0 | ||
9871 | * @ingroup Evas_Smart_Object_Group | ||
9872 | * | ||
9873 | * @note To delete all smart event callbacks which match @p type and @p func, | ||
9874 | * use evas_object_smart_callback_del(). | ||
9875 | */ | ||
9876 | EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3); | ||
9877 | |||
9878 | /** | ||
9686 | * Call a given smart callback on the smart object @p obj. | 9879 | * Call a given smart callback on the smart object @p obj. |
9687 | * | 9880 | * |
9688 | * @param obj the smart object | 9881 | * @param obj the smart object |
@@ -9856,7 +10049,7 @@ EAPI void evas_object_smart_need_recalculate_set(Evas_Object *obj, | |||
9856 | * | 10049 | * |
9857 | * @ingroup Evas_Smart_Object_Group | 10050 | * @ingroup Evas_Smart_Object_Group |
9858 | */ | 10051 | */ |
9859 | EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 10052 | EAPI Eina_Bool evas_object_smart_need_recalculate_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9860 | 10053 | ||
9861 | /** | 10054 | /** |
9862 | * Call the @b calculate() smart function immediataly on a given smart | 10055 | * Call the @b calculate() smart function immediataly on a given smart |
@@ -9977,7 +10170,7 @@ EAPI void evas_object_smart_move_children_relative(Evas_Objec | |||
9977 | * | 10170 | * |
9978 | * @see evas_object_smart_clipped_smart_add() | 10171 | * @see evas_object_smart_clipped_smart_add() |
9979 | */ | 10172 | */ |
9980 | EAPI Evas_Object *evas_object_smart_clipped_clipper_get (Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 10173 | EAPI Evas_Object *evas_object_smart_clipped_clipper_get (Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
9981 | 10174 | ||
9982 | /** | 10175 | /** |
9983 | * Set a given smart class' callbacks so it implements the <b>clipped smart | 10176 | * Set a given smart class' callbacks so it implements the <b>clipped smart |
@@ -10885,7 +11078,7 @@ EAPI Eina_List *evas_object_box_children_get | |||
10885 | * _Evas_Object_Box_Api::property_name_get smart class function of the | 11078 | * _Evas_Object_Box_Api::property_name_get smart class function of the |
10886 | * box, which is originally set to @c NULL. | 11079 | * box, which is originally set to @c NULL. |
10887 | */ | 11080 | */ |
10888 | EAPI const char *evas_object_box_option_property_name_get (Evas_Object *o, int property) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 11081 | EAPI const char *evas_object_box_option_property_name_get (Evas_Object *o, int property) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
10889 | 11082 | ||
10890 | /** | 11083 | /** |
10891 | * Get the numerical identifier of the property of the child elements | 11084 | * Get the numerical identifier of the property of the child elements |
@@ -10904,7 +11097,7 @@ EAPI const char *evas_object_box_option_property_name_get | |||
10904 | * _Evas_Object_Box_Api::property_id_get smart class function of the | 11097 | * _Evas_Object_Box_Api::property_id_get smart class function of the |
10905 | * box, which is originally set to @c NULL. | 11098 | * box, which is originally set to @c NULL. |
10906 | */ | 11099 | */ |
10907 | EAPI int evas_object_box_option_property_id_get (Evas_Object *o, const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 11100 | EAPI int evas_object_box_option_property_id_get (Evas_Object *o, const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
10908 | 11101 | ||
10909 | /** | 11102 | /** |
10910 | * Set a property value (by its given numerical identifier), on a | 11103 | * Set a property value (by its given numerical identifier), on a |
@@ -11081,7 +11274,7 @@ EAPI void evas_object_table_homogeneous_set (Evas | |||
11081 | * | 11274 | * |
11082 | * @see evas_object_table_homogeneous_set() | 11275 | * @see evas_object_table_homogeneous_set() |
11083 | */ | 11276 | */ |
11084 | EAPI Evas_Object_Table_Homogeneous_Mode evas_object_table_homogeneous_get (const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 11277 | EAPI Evas_Object_Table_Homogeneous_Mode evas_object_table_homogeneous_get (const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
11085 | 11278 | ||
11086 | /** | 11279 | /** |
11087 | * Set padding between cells. | 11280 | * Set padding between cells. |
@@ -11455,7 +11648,7 @@ EAPI Eina_List *evas_object_grid_children_get (const | |||
11455 | * @return @c EINA_TRUE if it wants, @c EINA_FALSE otherwise. | 11648 | * @return @c EINA_TRUE if it wants, @c EINA_FALSE otherwise. |
11456 | * @ingroup Evas_Cserve | 11649 | * @ingroup Evas_Cserve |
11457 | */ | 11650 | */ |
11458 | EAPI Eina_Bool evas_cserve_want_get (void) EINA_WARN_UNUSED_RESULT EINA_PURE; | 11651 | EAPI Eina_Bool evas_cserve_want_get (void) EINA_WARN_UNUSED_RESULT; |
11459 | 11652 | ||
11460 | /** | 11653 | /** |
11461 | * Retrieves if the system is connected to the server used to share | 11654 | * Retrieves if the system is connected to the server used to share |
@@ -11482,7 +11675,7 @@ EAPI Eina_Bool evas_cserve_stats_get (Evas_Cserve_Stats | |||
11482 | * | 11675 | * |
11483 | * @param cache A handle to the given images cache. | 11676 | * @param cache A handle to the given images cache. |
11484 | */ | 11677 | */ |
11485 | EAPI void evas_cserve_image_cache_contents_clean (Evas_Cserve_Image_Cache *cache) EINA_PURE; | 11678 | EAPI void evas_cserve_image_cache_contents_clean (Evas_Cserve_Image_Cache *cache); |
11486 | 11679 | ||
11487 | /** | 11680 | /** |
11488 | * Retrieves the current configuration of the Evas image caching | 11681 | * Retrieves the current configuration of the Evas image caching |
@@ -11501,7 +11694,7 @@ EAPI void evas_cserve_image_cache_contents_clean (Evas_Cserve_Image | |||
11501 | * | 11694 | * |
11502 | * @ingroup Evas_Cserve | 11695 | * @ingroup Evas_Cserve |
11503 | */ | 11696 | */ |
11504 | EAPI Eina_Bool evas_cserve_config_get (Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT EINA_PURE; | 11697 | EAPI Eina_Bool evas_cserve_config_get (Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; |
11505 | 11698 | ||
11506 | /** | 11699 | /** |
11507 | * Changes the configurations of the Evas image caching server. | 11700 | * Changes the configurations of the Evas image caching server. |
@@ -11515,7 +11708,7 @@ EAPI Eina_Bool evas_cserve_config_get (Evas_Cserve_Confi | |||
11515 | * | 11708 | * |
11516 | * @ingroup Evas_Cserve | 11709 | * @ingroup Evas_Cserve |
11517 | */ | 11710 | */ |
11518 | EAPI Eina_Bool evas_cserve_config_set (const Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT EINA_PURE; | 11711 | EAPI Eina_Bool evas_cserve_config_set (const Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; |
11519 | 11712 | ||
11520 | /** | 11713 | /** |
11521 | * Force the system to disconnect from the bitmap caching server. | 11714 | * Force the system to disconnect from the bitmap caching server. |
@@ -11711,7 +11904,7 @@ EAPI int evas_string_char_prev_get (const char *str, int p | |||
11711 | * @return The length in characters (not bytes) | 11904 | * @return The length in characters (not bytes) |
11712 | * @ingroup Evas_Utils | 11905 | * @ingroup Evas_Utils |
11713 | */ | 11906 | */ |
11714 | EAPI int evas_string_char_len_get (const char *str) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 11907 | EAPI int evas_string_char_len_get (const char *str) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
11715 | 11908 | ||
11716 | /** | 11909 | /** |
11717 | * @defgroup Evas_Keys Key Input Functions | 11910 | * @defgroup Evas_Keys Key Input Functions |
@@ -11769,7 +11962,7 @@ EAPI int evas_string_char_len_get (const char *str) EINA_ | |||
11769 | * @return An ::Evas_Modifier handle to query Evas' keys subsystem | 11962 | * @return An ::Evas_Modifier handle to query Evas' keys subsystem |
11770 | * with evas_key_modifier_is_set(), or @c NULL on error. | 11963 | * with evas_key_modifier_is_set(), or @c NULL on error. |
11771 | */ | 11964 | */ |
11772 | EAPI const Evas_Modifier *evas_key_modifier_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 11965 | EAPI const Evas_Modifier *evas_key_modifier_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
11773 | 11966 | ||
11774 | /** | 11967 | /** |
11775 | * Returns a handle to the list of lock keys registered in the canvas | 11968 | * Returns a handle to the list of lock keys registered in the canvas |
@@ -11787,7 +11980,7 @@ EAPI const Evas_Modifier *evas_key_modifier_get (const Evas *e) EINA_WA | |||
11787 | * @return An ::Evas_Lock handle to query Evas' keys subsystem with | 11980 | * @return An ::Evas_Lock handle to query Evas' keys subsystem with |
11788 | * evas_key_lock_is_set(), or @c NULL on error. | 11981 | * evas_key_lock_is_set(), or @c NULL on error. |
11789 | */ | 11982 | */ |
11790 | EAPI const Evas_Lock *evas_key_lock_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; | 11983 | EAPI const Evas_Lock *evas_key_lock_get (const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); |
11791 | 11984 | ||
11792 | 11985 | ||
11793 | /** | 11986 | /** |
@@ -11808,7 +12001,7 @@ EAPI const Evas_Lock *evas_key_lock_get (const Evas *e) EINA_WA | |||
11808 | * @see evas_key_modifier_on | 12001 | * @see evas_key_modifier_on |
11809 | * @see evas_key_modifier_off | 12002 | * @see evas_key_modifier_off |
11810 | */ | 12003 | */ |
11811 | EAPI Eina_Bool evas_key_modifier_is_set (const Evas_Modifier *m, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 12004 | EAPI Eina_Bool evas_key_modifier_is_set (const Evas_Modifier *m, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
11812 | 12005 | ||
11813 | 12006 | ||
11814 | /** | 12007 | /** |
@@ -11828,7 +12021,7 @@ EAPI Eina_Bool evas_key_modifier_is_set (const Evas_Modifier *m | |||
11828 | * @see evas_key_lock_on | 12021 | * @see evas_key_lock_on |
11829 | * @see evas_key_lock_off | 12022 | * @see evas_key_lock_off |
11830 | */ | 12023 | */ |
11831 | EAPI Eina_Bool evas_key_lock_is_set (const Evas_Lock *l, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 12024 | EAPI Eina_Bool evas_key_lock_is_set (const Evas_Lock *l, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
11832 | 12025 | ||
11833 | 12026 | ||
11834 | /** | 12027 | /** |
@@ -12012,7 +12205,7 @@ EAPI void evas_key_lock_off (Evas *e, const char *k | |||
12012 | * @see evas_object_key_grab | 12205 | * @see evas_object_key_grab |
12013 | * @see evas_object_key_ungrab | 12206 | * @see evas_object_key_ungrab |
12014 | */ | 12207 | */ |
12015 | EAPI Evas_Modifier_Mask evas_key_modifier_mask_get (const Evas *e, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; | 12208 | EAPI Evas_Modifier_Mask evas_key_modifier_mask_get (const Evas *e, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); |
12016 | 12209 | ||
12017 | 12210 | ||
12018 | /** | 12211 | /** |