From 9aab04951db1416bb7fde4488f7f058621b7bdad Mon Sep 17 00:00:00 2001 From: Jee-Yong Um Date: Fri, 30 Sep 2016 15:22:13 +0900 Subject: [PATCH] efl: tag @since_tizen info Signed-Off-By: Jee-Yong Um Change-Id: I468c0efe6f1f810fc645b22cf6401b8052ba19bb --- src/lib/ecore/Ecore_Common.h | 508 ++++++++++++++ src/lib/ecore/Ecore_Getopt.h | 32 + src/lib/ecore/Ecore_Legacy.h | 76 +++ src/lib/ecore/ecore_animator.eo | 4 +- src/lib/ecore/ecore_idle_enterer.eo | 4 +- src/lib/ecore/ecore_idle_exiter.eo | 2 +- src/lib/ecore/ecore_idler.eo | 2 +- src/lib/ecore/ecore_job.eo | 2 +- src/lib/ecore/ecore_poller.eo | 13 +- src/lib/ecore/ecore_timer.eo | 26 +- src/lib/ecore_audio/Ecore_Audio.h | 4 + src/lib/ecore_avahi/Ecore_Avahi.h | 6 + src/lib/ecore_buffer/Ecore_Buffer.h | 56 ++ src/lib/ecore_buffer/Ecore_Buffer_Queue.h | 72 ++ src/lib/ecore_con/Ecore_Con.h | 477 ++++++++++++- src/lib/ecore_con/Ecore_Con_Eet.h | 78 +++ src/lib/ecore_con/Ecore_Con_Legacy.h | 8 + src/lib/ecore_con/ecore_con_base.eo | 4 + src/lib/ecore_con/ecore_con_client.eo | 5 + src/lib/ecore_con/ecore_con_eet_base.eo | 7 +- src/lib/ecore_con/ecore_con_server.eo | 15 + src/lib/ecore_drm/Ecore_Drm.h | 108 +++ src/lib/ecore_evas/Ecore_Evas.h | 623 +++++++++++++++++ src/lib/ecore_file/ecore_file.c | 120 ++++ src/lib/ecore_file/ecore_file_download.c | 20 + src/lib/ecore_file/ecore_file_monitor.c | 12 + src/lib/ecore_file/ecore_file_path.c | 12 + src/lib/ecore_imf/Ecore_IMF.h | 328 +++++++++ src/lib/ecore_imf_evas/Ecore_IMF_Evas.h | 32 + src/lib/ecore_input/Ecore_Input.h | 32 + src/lib/ecore_ipc/ecore_ipc.c | 96 +++ src/lib/ecore_wayland/Ecore_Wayland.h | 108 +++ src/lib/ecore_x/Ecore_X.h | 92 ++- src/lib/edje/Edje_Common.h | 256 +++++++ src/lib/edje/Edje_Legacy.h | 38 ++ src/lib/edje/edje_object.eo | 1022 ++++++++++++++++++++++++---- src/lib/eet/Eet.h | 470 +++++++++++++ src/lib/eeze/Eeze.h | 62 ++ src/lib/eeze/Eeze_Disk.h | 80 +++ src/lib/eeze/Eeze_Sensor.h | 20 + src/lib/efreet/Efreet.h | 6 + src/lib/efreet/Efreet_Mime.h | 20 + src/lib/efreet/Efreet_Trash.h | 14 + src/lib/efreet/efreet_base.h | 30 + src/lib/efreet/efreet_desktop.h | 54 ++ src/lib/efreet/efreet_icon.h | 24 + src/lib/efreet/efreet_ini.h | 32 + src/lib/efreet/efreet_menu.h | 28 + src/lib/efreet/efreet_uri.h | 6 + src/lib/efreet/efreet_utils.h | 30 + src/lib/eina/eina_accessor.h | 27 + src/lib/eina/eina_array.h | 28 + src/lib/eina/eina_benchmark.h | 16 + src/lib/eina/eina_bezier.h | 32 + src/lib/eina/eina_binbuf.h | 62 ++ src/lib/eina/eina_binshare.h | 20 + src/lib/eina/eina_convert.h | 24 + src/lib/eina/eina_counter.h | 20 + src/lib/eina/eina_cow.h | 32 + src/lib/eina/eina_cpu.h | 16 + src/lib/eina/eina_error.h | 32 + src/lib/eina/eina_evlog.h | 8 + src/lib/eina/eina_file.h | 108 +++ src/lib/eina/eina_fp.h | 8 + src/lib/eina/eina_hamster.h | 4 + src/lib/eina/eina_hash.h | 140 ++++ src/lib/eina/eina_inarray.h | 104 +++ src/lib/eina/eina_inlist.h | 68 ++ src/lib/eina/eina_iterator.h | 24 + src/lib/eina/eina_lalloc.h | 12 + src/lib/eina/eina_list.h | 140 ++++ src/lib/eina/eina_lock.h | 4 + src/lib/eina/eina_log.h | 136 +++- src/lib/eina/eina_magic.h | 20 + src/lib/eina/eina_main.h | 24 + src/lib/eina/eina_matrix.h | 224 ++++++ src/lib/eina/eina_matrixsparse.h | 72 ++ src/lib/eina/eina_mempool.h | 31 + src/lib/eina/eina_mmap.h | 8 + src/lib/eina/eina_module.h | 60 ++ src/lib/eina/eina_prefix.h | 28 + src/lib/eina/eina_quad.h | 16 + src/lib/eina/eina_rbtree.h | 23 + src/lib/eina/eina_rectangle.h | 48 ++ src/lib/eina/eina_sched.h | 4 + src/lib/eina/eina_simple_xml_parser.h | 91 +++ src/lib/eina/eina_str.h | 56 ++ src/lib/eina/eina_strbuf.h | 128 ++++ src/lib/eina/eina_stringshare.h | 36 + src/lib/eina/eina_thread.h | 20 + src/lib/eina/eina_thread_queue.h | 48 ++ src/lib/eina/eina_tiler.h | 64 ++ src/lib/eina/eina_tmpstr.h | 20 + src/lib/eina/eina_unicode.h | 60 ++ src/lib/eina/eina_ustrbuf.h | 80 +++ src/lib/eina/eina_ustringshare.h | 24 + src/lib/eina/eina_util.h | 8 + src/lib/eina/eina_value.h | 140 ++++ src/lib/eina/eina_value_util.h | 8 + src/lib/eina/eina_xattr.h | 72 ++ src/lib/eio/Eio.h | 203 ++++++ src/lib/eldbus/Eldbus.h | 8 + src/lib/eldbus/eldbus_connection.h | 60 ++ src/lib/eldbus/eldbus_freedesktop.h | 92 +++ src/lib/eldbus/eldbus_message.h | 127 ++++ src/lib/eldbus/eldbus_message_eina_value.h | 12 + src/lib/eldbus/eldbus_message_helper.h | 4 + src/lib/eldbus/eldbus_object.h | 52 ++ src/lib/eldbus/eldbus_pending.h | 40 ++ src/lib/eldbus/eldbus_proxy.h | 72 ++ src/lib/eldbus/eldbus_service.h | 60 ++ src/lib/eldbus/eldbus_signal_handler.h | 32 + src/lib/embryo/Embryo.h | 70 ++ src/lib/emotion/Emotion.h | 114 ++++ src/lib/emotion/emotion_object.eo | 4 +- src/lib/eo/Eo.h | 46 ++ src/lib/evas/Evas_Common.h | 596 ++++++++++++++++ src/lib/evas/Evas_Legacy.h | 713 ++++++++++++++++++- src/lib/evas/canvas/efl_vg_base.eo | 53 +- src/lib/evas/canvas/efl_vg_shape.eo | 30 + src/lib/evas/canvas/evas_box.eo | 189 ++++- src/lib/evas/canvas/evas_canvas.eo | 412 ++++++++++- src/lib/evas/canvas/evas_grid.eo | 84 ++- src/lib/evas/canvas/evas_image.eo | 233 ++++++- src/lib/evas/canvas/evas_line.eo | 8 + src/lib/evas/canvas/evas_object.eo | 282 +++++++- src/lib/evas/canvas/evas_object_smart.eo | 77 ++- src/lib/evas/canvas/evas_out.eo | 13 +- src/lib/evas/canvas/evas_polygon.eo | 14 +- src/lib/evas/canvas/evas_table.eo | 110 ++- src/lib/evas/canvas/evas_text.eo | 135 +++- src/lib/evas/canvas/evas_textblock.eo | 139 +++- src/lib/evas/canvas/evas_textgrid.eo | 70 +- src/lib/evas/canvas/evas_vg.eo | 7 +- 134 files changed, 11506 insertions(+), 309 deletions(-) diff --git a/src/lib/ecore/Ecore_Common.h b/src/lib/ecore/Ecore_Common.h index 18be364..85f558a 100644 --- a/src/lib/ecore/Ecore_Common.h +++ b/src/lib/ecore/Ecore_Common.h @@ -32,6 +32,10 @@ extern "C" { * ecore_shutdown(); * } * @endcode + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_init(void); @@ -45,6 +49,10 @@ EAPI int ecore_init(void); * * Do not call this function from any callback that may be called from the main * loop, as the main loop will then fall over and not function properly. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_shutdown(void); @@ -131,6 +139,10 @@ typedef int (*Ecore_Select_Function)(int nfds, fd_set *readfds, fd_set *writefds * advice when He has trouble managing the Universe. * * @see ecore_main_loop_iterate_may_block() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_iterate(void); @@ -151,6 +163,10 @@ EAPI void ecore_main_loop_iterate(void); * * @return 1 if event exists, else 0. * @see ecore_main_loop_iterate() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_main_loop_iterate_may_block(int may_block); @@ -166,6 +182,10 @@ EAPI int ecore_main_loop_iterate_may_block(int may_block); * @warning you don't know how to use, don't even try to use it. * * @param func The function to be used. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_select_func_set(Ecore_Select_Function func); @@ -173,6 +193,9 @@ EAPI void ecore_main_loop_select_func_set(Ecore_Select_Function func); * Gets the select function set by ecore_select_func_set(), * or the native select function if none was set. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Select_Function ecore_main_loop_select_func_get(void); @@ -231,6 +254,10 @@ EAPI void ecore_main_awake_handler_del(Ecore_Awake_Cb func); * * @return @c EINA_TRUE on success of @c EINA_FALSE if it failed, * likely no GLib support in Ecore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_main_loop_glib_integrate(void); @@ -242,6 +269,10 @@ EAPI Eina_Bool ecore_main_loop_glib_integrate(void); * this before calling ecore_init() will disable the integration. * This is for apps that explicitly do not want this to happen for whatever * reasons they may have. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_glib_always_integrate_disable(void); @@ -266,6 +297,10 @@ EAPI void ecore_main_loop_glib_always_integrate_disable(void); * The function used to check for file descriptors, events, and that has a * timeout for the timers can be changed using * ecore_main_loop_select_func_set(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_begin(void); @@ -275,6 +310,10 @@ EAPI void ecore_main_loop_begin(void); * * This function returns immediately, but will mark the ecore_main_loop_begin() * function to return at the end of the current main loop iteration. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_quit(void); @@ -286,6 +325,10 @@ EAPI void ecore_main_loop_quit(void); * There should be little need for anyone to use this - ever. * * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_main_loop_animator_ticked_get(void); @@ -296,6 +339,10 @@ EAPI Eina_Bool ecore_main_loop_animator_ticked_get(void); * 0 if not running, > 0 if running * * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_main_loop_nested_get(void); @@ -324,6 +371,10 @@ typedef void *(*Ecore_Data_Cb)(void *data); * * @return EINA_TRUE on success, else EINA_FALSE. * @since 1.7 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_fork_reset_callback_add(Ecore_Cb func, const void *data); @@ -338,6 +389,10 @@ EAPI Eina_Bool ecore_fork_reset_callback_add(Ecore_Cb func, const void *data); * * @return EINA_TRUE on success, else EINA_FALSE. * @since 1.7 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_fork_reset_callback_del(Ecore_Cb func, const void *data); @@ -357,6 +412,10 @@ EAPI Eina_Bool ecore_fork_reset_callback_del(Ecore_Cb func, const void *data); * will cause possible misbehaviour. * * @since 1.7 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_fork_reset(void); @@ -374,6 +433,10 @@ EAPI void ecore_fork_reset(void); * Remember after that function call, you should never touch again the @p data * in the thread, it is owned by the main loop and your callback should take * care of freeing it if necessary. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_loop_thread_safe_call_async(Ecore_Cb callback, void *data); @@ -391,6 +454,10 @@ EAPI void ecore_main_loop_thread_safe_call_async(Ecore_Cb callback, void *data); * * Remember this function will block until the callback is executed in the * main loop. It can take time and you have no guaranty about the timeline. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_main_loop_thread_safe_call_sync(Ecore_Data_Cb callback, void *data); @@ -404,6 +471,10 @@ EAPI void *ecore_main_loop_thread_safe_call_sync(Ecore_Data_Cb callback, void *d * and will actually block the main loop until either a call * is triggered from a thread or the time specified by wait has * passed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_main_loop_thread_safe_call_wait(double wait); @@ -424,6 +495,10 @@ EAPI void ecore_main_loop_thread_safe_call_wait(double wait); * * We still advise you, when possible, to use ecore_main_loop_thread_safe_call_async() * as it will not block the thread nor the main loop. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_main_loop_begin(void); @@ -437,6 +512,10 @@ EAPI int ecore_thread_main_loop_begin(void); * * After a call to ecore_thread_main_loop_begin(), you need to absolutely * call ecore_thread_main_loop_end(), or you application will stay frozen. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_main_loop_end(void); @@ -647,6 +726,10 @@ struct _Ecore_Event_Signal_Realtime * ECORE_CALLBACK_DONE), it will cease processing handlers for that particular * event, so all handler set to handle that event type that have not already * been called, will not be. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Event_Handler *ecore_event_handler_add(int type, Ecore_Event_Handler_Cb func, const void *data); @@ -659,6 +742,10 @@ EAPI Ecore_Event_Handler *ecore_event_handler_add(int type, Ecore_Event_Handler_ * delete the event handler and return the pointer passed as @p data when the * handler was added by ecore_event_handler_add(). On failure @c NULL will be * returned. Once a handler is deleted it will no longer be called. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_handler_del(Ecore_Event_Handler *event_handler); @@ -676,6 +763,10 @@ EAPI void *ecore_event_handler_del(Ecore_Event_Handler *event_handler); * event is no longer needed, @a func_free will be called and passed @a ev for * cleaning up. If @p func_free is NULL, free() will be called with the private * structure pointer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Event *ecore_event_add(int type, void *ev, Ecore_End_Cb func_free, void *data); @@ -689,6 +780,10 @@ EAPI Ecore_Event *ecore_event_add(int type, void *ev, Ecore_End_Cb func_free, vo * does not immediately call the free function, and it may be called later on * cleanup, and so if the free function depends on the data pointer to work, * you should defer cleaning of this till the free function is called later. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_del(Ecore_Event *event); @@ -699,6 +794,10 @@ EAPI void *ecore_event_del(Ecore_Event *event); * * This function returns the data previously associated with @p eh by * ecore_event_handler_add(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_handler_data_get(Ecore_Event_Handler *eh); @@ -710,6 +809,10 @@ EAPI void *ecore_event_handler_data_get(Ecore_Event_Handler *eh); * * This function sets @p data to @p eh and returns the old data pointer * which was previously associated with @p eh by ecore_event_handler_add(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_handler_data_set(Ecore_Event_Handler *eh, const void *data); @@ -722,6 +825,10 @@ EAPI void *ecore_event_handler_data_set(Ecore_Event_Handler *eh, const void *dat * the program. There is no guarantee of the contents of this event ID, or how * it is calculated, except that the ID will be unique to the current instance * of the process. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_event_type_new(void); @@ -744,6 +851,10 @@ EAPI int ecore_event_type_new(void); * @c EINA_TRUE, the event is kept. When processing is finished @p func_end is * called and is passed the loop_data(returned by @c func_start) and @p data * pointer to clean up. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Event_Filter *ecore_event_filter_add(Ecore_Data_Cb func_start, Ecore_Filter_Cb func_filter, Ecore_End_Cb func_end, const void *data); @@ -753,6 +864,10 @@ EAPI Ecore_Event_Filter *ecore_event_filter_add(Ecore_Data_Cb func_start, Ecore_ * @return The data set for the filter on success, @c NULL otherwise. * * Delete a filter that has been added by its @p ef handle. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_filter_del(Ecore_Event_Filter *ef); @@ -769,6 +884,10 @@ EAPI void *ecore_event_filter_del(Ecore_Event_Filter *ef); * this extra information may be useful or needed and using this call can let * the program know if the event type being handled is one it wants to get more * information about. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_event_current_type_get(void); @@ -785,6 +904,10 @@ EAPI int ecore_event_current_type_get(void); * this extra information may be useful or needed and using this call can let * the program access the event data if the type of the event is handled by * the program. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_event_current_event_get(void); @@ -851,6 +974,10 @@ typedef enum _Ecore_Memory_State Ecore_Memory_State; * @brief Get the current status of memory on the system. * @return The current memory state for the system as a whole. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Memory_State ecore_memory_state_get(void); @@ -867,6 +994,10 @@ EAPI Ecore_Memory_State ecore_memory_state_get(void); * that is platform-specific. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_memory_state_set(Ecore_Memory_State state); @@ -890,6 +1021,10 @@ typedef enum _Ecore_Power_State Ecore_Power_State; * @brief Get the current power state. * @return The current power state for the system. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Power_State ecore_power_state_get(void); @@ -906,6 +1041,10 @@ EAPI Ecore_Power_State ecore_power_state_get(void); * that is platform-specific. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_power_state_set(Ecore_Power_State state); @@ -1056,6 +1195,10 @@ struct _Ecore_Exe_Event_Data * * @param pri value a Ecore_Exe_Win32_Priority value on Windows, -20 * to 19 or @ref ECORE_EXE_PRIORITY_INHERIT on other OS. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_run_priority_set(int pri); @@ -1067,6 +1210,10 @@ EAPI void ecore_exe_run_priority_set(int pri); * by this call. * * @return the value set by ecore_exe_run_priority_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_exe_run_priority_get(void); @@ -1082,6 +1229,10 @@ EAPI int ecore_exe_run_priority_get(void); * @param exe_cmd The command to run with @c /bin/sh. * @param data Data to attach to the returned process handle. * @return A process handle to the spawned process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Exe *ecore_exe_run(const char *exe_cmd, const void *data); @@ -1109,6 +1260,10 @@ EAPI Ecore_Exe *ecore_exe_run(const char *exe_cmd, const void *data); * @param flags The flag parameters for how to deal with inter-process I/O * @param data Data to attach to the returned process handle. * @return A process handle to the spawned process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Exe *ecore_exe_pipe_run(const char *exe_cmd, Ecore_Exe_Flags flags, const void *data); @@ -1124,6 +1279,10 @@ EAPI Ecore_Exe *ecore_exe_pipe_run(const char *exe_cmd, Ecore_Exe_Flags flags, c * * @param exe The child process to attach the pre_free function. * @param func The function to call before @a exe is freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_callback_pre_free_set(Ecore_Exe *exe, Ecore_Exe_Cb func); @@ -1138,6 +1297,10 @@ EAPI void ecore_exe_callback_pre_free_set(Ecore_Exe *exe, Ecore_Exe_Cb func); * @param data The data to send * @param size The size of the data to send, in bytes * @return @c EINA_TRUE if successful, @c EINA_FALSE on failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_exe_send(Ecore_Exe *exe, const void *data, int size); @@ -1145,6 +1308,10 @@ EAPI Eina_Bool ecore_exe_send(Ecore_Exe *exe, const void *data, int size); * The stdin of the given child process will close when the write buffer is empty. * * @param exe The child process + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_close_stdin(Ecore_Exe *exe); @@ -1157,6 +1324,10 @@ EAPI void ecore_exe_close_stdin(Ecore_Exe *exe); * @param end_bytes limit of bytes at end of output to buffer. * @param start_lines limit of lines at start of output to buffer. * @param end_lines limit of lines at end of output to buffer. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_auto_limits_set(Ecore_Exe *exe, int start_bytes, int end_bytes, int start_lines, int end_lines); @@ -1166,6 +1337,10 @@ EAPI void ecore_exe_auto_limits_set(Ecore_Exe *exe, int start_bytes, int end_byt * @param exe The given process handle. * @param flags Is this a ECORE_EXE_PIPE_READ or ECORE_EXE_PIPE_ERROR? * @return The event data. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Exe_Event_Data *ecore_exe_event_data_get(Ecore_Exe *exe, Ecore_Exe_Flags flags); @@ -1173,6 +1348,10 @@ EAPI Ecore_Exe_Event_Data *ecore_exe_event_data_get(Ecore_Exe *exe, Ecore_Exe_Fl * Frees the given event data. * * @param data The given event data. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_event_data_free(Ecore_Exe_Event_Data *data); @@ -1185,6 +1364,10 @@ EAPI void ecore_exe_event_data_free(Ecore_Exe_Event_Data *data); * @param exe The given process handle. * @return The data attached to the handle when @ref ecore_exe_run was * called. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *ecore_exe_free(Ecore_Exe *exe); @@ -1192,6 +1375,10 @@ EAPI void *ecore_exe_free(Ecore_Exe *exe); * Retrieves the process ID of the given spawned process. * @param exe Handle to the given spawned process. * @return The process ID on success. @c -1 otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI pid_t ecore_exe_pid_get(const Ecore_Exe *exe); @@ -1200,6 +1387,10 @@ EAPI pid_t ecore_exe_pid_get(const Ecore_Exe *exe); * * @param exe The given process handle. * @param tag The string tag to set on the process handle. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_tag_set(Ecore_Exe *exe, const char *tag); @@ -1213,6 +1404,10 @@ EAPI void ecore_exe_tag_set(Ecore_Exe *exe, const char *tag); * @return The string attached to @p exe. It is a handle to existing * internal string and should not be modified, use * ecore_exe_tag_set() to change it. It might be @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_exe_tag_get(const Ecore_Exe *exe); @@ -1222,6 +1417,10 @@ EAPI const char *ecore_exe_tag_get(const Ecore_Exe *exe); * @return The command on success, @c NULL otherwise. This string is the * pointer to the internal value and must not be modified in * any way. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_exe_cmd_get(const Ecore_Exe *exe); @@ -1230,6 +1429,10 @@ EAPI const char *ecore_exe_cmd_get(const Ecore_Exe *exe); * @param exe The given process handle. * @return The data pointer attached to @p exe Given to * ecore_exe_run() or ecore_exe_pipe_run() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *ecore_exe_data_get(const Ecore_Exe *exe); @@ -1240,6 +1443,10 @@ EAPI void *ecore_exe_data_get(const Ecore_Exe *exe); * @return The data pointer previously attached to @p exe with * ecore_exe_run(), ecore_exe_pipe_run(), or ecore_exe_data_set() * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *ecore_exe_data_set(Ecore_Exe *exe, void *data); @@ -1247,42 +1454,70 @@ EAPI void *ecore_exe_data_set(Ecore_Exe *exe, void *data); * Retrieves the flags attached to the given process handle. * @param exe The given process handle. * @return The flags attached to @p exe. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Exe_Flags ecore_exe_flags_get(const Ecore_Exe *exe); /** * Pauses the given process by sending it a @c SIGSTOP signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_pause(Ecore_Exe *exe); /** * Continues the given paused process by sending it a @c SIGCONT signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_continue(Ecore_Exe *exe); /** * Sends the given spawned process a interrupt (@c SIGINT) signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_interrupt(Ecore_Exe *exe); /** * Sends the given spawned process a quit (@c SIGQUIT) signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_quit(Ecore_Exe *exe); /** * Sends the given spawned process a terminate (@c SIGTERM) signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_terminate(Ecore_Exe *exe); /** * Kills the given spawned process by sending it a @c SIGKILL signal. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_kill(Ecore_Exe *exe); @@ -1291,12 +1526,20 @@ EAPI void ecore_exe_kill(Ecore_Exe *exe); * @param exe Process handle to the given process. * @param num The number user signal to send. Must be either 1 or 2, or * the signal will be ignored. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_signal(Ecore_Exe *exe, int num); /** * Sends a @c SIGHUP signal to the given spawned process. * @param exe Process handle to the given process. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_exe_hup(Ecore_Exe *exe); @@ -1410,6 +1653,9 @@ typedef Eina_Bool (*Ecore_Win32_Handle_Cb)(void *data, Ecore_Win32_Handler *wh); * * @warning This function should @b not be used for monitoring "normal" files, like text files. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Fd_Handler *ecore_main_fd_handler_add(int fd, Ecore_Fd_Handler_Flags flags, Ecore_Fd_Cb func, const void *data, Ecore_Fd_Cb buf_func, const void *buf_data); @@ -1432,6 +1678,10 @@ EAPI Ecore_Fd_Handler *ecore_main_fd_handler_add(int fd, Ecore_Fd_Handler_Flags * @warning Do not use this function unless you know what you are doing. * * @since 1.7 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Fd_Handler *ecore_main_fd_handler_file_add(int fd, Ecore_Fd_Handler_Flags flags, Ecore_Fd_Cb func, const void *data, Ecore_Fd_Cb buf_func, const void *buf_data); @@ -1450,6 +1700,10 @@ EAPI Ecore_Fd_Handler *ecore_main_fd_handler_file_add(int fd, Ecore_Fd_Handler_F * callback. * @note You probably don't need this function. It is only necessary for very * uncommon cases that need special behavior. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_fd_handler_prepare_callback_set(Ecore_Fd_Handler *fd_handler, Ecore_Fd_Prep_Cb func, const void *data); /** @@ -1464,12 +1718,20 @@ EAPI void ecore_main_fd_handler_prepare_callback_set(Ecore_Fd_Handler *fd_handle * main loop is using epoll internally, and also in some rare cases this may * cause crashes and instability. Remember to delete your fd handlers before the * fds they listen to are closed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_main_fd_handler_del(Ecore_Fd_Handler *fd_handler); /** * @brief Retrieves the file descriptor that the given handler is handling. * @param fd_handler The given FD handler. * @return The file descriptor the handler is watching. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_main_fd_handler_fd_get(Ecore_Fd_Handler *fd_handler); /** @@ -1479,16 +1741,26 @@ EAPI int ecore_main_fd_handler_fd_get(Ecore_Fd_Handler *fd_handler); * @c ECORE_FD_ERROR to query. * @return @c EINA_TRUE if any of the given flags are active, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_main_fd_handler_active_get(Ecore_Fd_Handler *fd_handler, Ecore_Fd_Handler_Flags flags); /** * @brief Set what active streams the given FD handler should be monitoring. * @param fd_handler The given FD handler. * @param flags The flags to be watching. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_main_fd_handler_active_set(Ecore_Fd_Handler *fd_handler, Ecore_Fd_Handler_Flags flags); /** + * @internal + * * @brief Create a Ecore_Win32_Handler object and add it to the win32_handlers list. * @param h The win32 handler. * @param func The function to add as a callback. @@ -1496,6 +1768,8 @@ EAPI void ecore_main_fd_handler_active_set(Ecore_Fd_Handler *fd_handler, Ecore_F */ EAPI Ecore_Win32_Handler *ecore_main_win32_handler_add(void *h, Ecore_Win32_Handle_Cb func, const void *data); /** + * @internal + * * @brief Set Ecore_Win32_Handler object to delete state. * The handler will be deleted in the _ecore_main_win32_handlers_cleanup function. * @@ -1532,6 +1806,10 @@ EAPI void *ecore_main_win32_handler_del(Ecore_Win32_Handler *win32_handler); * when the machine was booted, unix time, etc), all it is * defined is that it never goes backwards (unless you got big critical * messages when the application started). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_time_get(void); @@ -1542,6 +1820,10 @@ EAPI double ecore_time_get(void); * @see ecore_loop_time_get(). * * @return The number of seconds since 12.00AM 1st January 1970. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_time_unix_get(void); @@ -1565,10 +1847,16 @@ EAPI double ecore_time_unix_get(void); * when the machine was booted, unix time, etc), all it is * defined is that it never goes backwards (unless you got big critical * messages when the application started). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_loop_time_get(void); /** + * @internal + * * Set the loop time * * @param t The new loop time @@ -1756,6 +2044,10 @@ typedef void (*Ecore_Thread_Notify_Cb)(void *data, Ecore_Thread *thread, void *m * @see ecore_thread_cancel() * @see ecore_thread_reschedule() * @see ecore_thread_max_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Thread *ecore_thread_run(Ecore_Thread_Cb func_blocking, Ecore_Thread_Cb func_end, Ecore_Thread_Cb func_cancel, const void *data); @@ -1798,6 +2090,10 @@ EAPI Ecore_Thread *ecore_thread_run(Ecore_Thread_Cb func_blocking, Ecore_Thread_ * @see ecore_thread_cancel() * @see ecore_thread_reschedule() * @see ecore_thread_max_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Thread *ecore_thread_feedback_run(Ecore_Thread_Cb func_heavy, Ecore_Thread_Notify_Cb func_notify, Ecore_Thread_Cb func_end, Ecore_Thread_Cb func_cancel, @@ -1837,6 +2133,10 @@ EAPI Ecore_Thread *ecore_thread_feedback_run(Ecore_Thread_Cb func_heavy, Ecore_T * returns @c EINA_TRUE or after the @c func_cancel callback returns. * * @see ecore_thread_check() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_cancel(Ecore_Thread *thread); @@ -1847,6 +2147,10 @@ EAPI Eina_Bool ecore_thread_cancel(Ecore_Thread *thread); * @param thread The thread to wait on. * @param wait Maximum time to wait before exiting anyway. * @return EINA_TRUE if the thread execution is over. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_thread_wait(Ecore_Thread *thread, double wait); @@ -1868,6 +2172,10 @@ EAPI Eina_Bool ecore_thread_wait(Ecore_Thread *thread, double wait); * task. * * @see ecore_thread_cancel() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_check(Ecore_Thread *thread); @@ -1891,6 +2199,10 @@ EAPI Eina_Bool ecore_thread_check(Ecore_Thread *thread); * callback set when creating the thread. * * @see ecore_thread_feedback_run() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data); @@ -1916,6 +2228,10 @@ EAPI Eina_Bool ecore_thread_feedback(Ecore_Thread *thread, const void *msg_data) * called until the function in the thread returns without being rescheduled. * Similarly, if the @p thread is cancelled, the reschedule will not take * effect. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_reschedule(Ecore_Thread *thread); @@ -1931,6 +2247,10 @@ EAPI Eina_Bool ecore_thread_reschedule(Ecore_Thread *thread); * the @c try_no_queue parameter set to @c EINA_TRUE will not be accounted for * in the return of this function unless the thread creation fails and it * falls back to using one from the pool. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_active_get(void); @@ -1941,6 +2261,10 @@ EAPI int ecore_thread_active_get(void); * * This returns the number of tasks started with ecore_thread_run() that are * pending, waiting for a thread to become available to run them. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_pending_get(void); @@ -1951,6 +2275,10 @@ EAPI int ecore_thread_pending_get(void); * * This returns the number of tasks started with ecore_thread_feedback_run() * that are pending, waiting for a thread to become available to run them. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_pending_feedback_get(void); @@ -1961,6 +2289,10 @@ EAPI int ecore_thread_pending_feedback_get(void); * * Same as the sum of ecore_thread_pending_get() and *ecore_thread_pending_feedback_get(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_pending_total_get(void); @@ -1981,6 +2313,10 @@ EAPI int ecore_thread_pending_total_get(void); * * @see ecore_thread_max_set() * @see ecore_thread_max_reset() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_max_get(void); @@ -1995,6 +2331,10 @@ EAPI int ecore_thread_max_get(void); * * @see ecore_thread_max_get() * @see ecore_thread_max_reset() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_thread_max_set(int num); @@ -2006,6 +2346,10 @@ EAPI void ecore_thread_max_set(int num); * * @see ecore_thread_max_get() * @see ecore_thread_max_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_thread_max_reset(void); @@ -2019,6 +2363,10 @@ EAPI void ecore_thread_max_reset(void); * This function may return a negative number only in the case the user * changed the maximum number of running threads while other tasks are * running. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_thread_available_get(void); @@ -2105,6 +2453,10 @@ EAPI int ecore_thread_available_get(void); * @see ecore_thread_local_data_set() * @see ecore_thread_local_data_find() * @see ecore_thread_local_data_del() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_local_data_add(Ecore_Thread *thread, const char *key, void *value, Eina_Free_Cb cb, Eina_Bool direct); @@ -2135,6 +2487,10 @@ EAPI Eina_Bool ecore_thread_local_data_add(Ecore_Thread *thread, const char *key * @see ecore_thread_local_data_add() * @see ecore_thread_local_data_del() * @see ecore_thread_local_data_find() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_thread_local_data_set(Ecore_Thread *thread, const char *key, void *value, Eina_Free_Cb cb); @@ -2154,6 +2510,10 @@ EAPI void *ecore_thread_local_data_set(Ecore_Thread *thread, const char *key, vo * * @see ecore_thread_local_data_add() * @see ecore_thread_local_data_wait() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_thread_local_data_find(Ecore_Thread *thread, const char *key); @@ -2180,6 +2540,10 @@ EAPI void *ecore_thread_local_data_find(Ecore_Thread *thread, const char *key); * other than the one represented by @p thread. * * @see ecore_thread_local_data_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_local_data_del(Ecore_Thread *thread, const char *key); @@ -2220,6 +2584,10 @@ EAPI Eina_Bool ecore_thread_local_data_del(Ecore_Thread *thread, const char *key * @see ecore_thread_global_data_del() * @see ecore_thread_global_data_set() * @see ecore_thread_global_data_find() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_global_data_add(const char *key, void *value, Eina_Free_Cb cb, Eina_Bool direct); @@ -2243,6 +2611,10 @@ EAPI Eina_Bool ecore_thread_global_data_add(const char *key, void *value, Eina_F * @see ecore_thread_global_data_add() * @see ecore_thread_global_data_del() * @see ecore_thread_global_data_find() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_thread_global_data_set(const char *key, void *value, Eina_Free_Cb cb); @@ -2261,6 +2633,10 @@ EAPI void *ecore_thread_global_data_set(const char *key, void *value, Eina_Free_ * * @see ecore_thread_global_data_add() * @see ecore_thread_global_data_wait() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_thread_global_data_find(const char *key); @@ -2285,6 +2661,10 @@ EAPI void *ecore_thread_global_data_find(const char *key); * that possibility exists. * * @see ecore_thread_global_data_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_thread_global_data_del(const char *key); @@ -2314,6 +2694,10 @@ EAPI Eina_Bool ecore_thread_global_data_del(const char *key); * * @see ecore_thread_global_data_add() * @see ecore_thread_global_data_find() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_thread_global_data_wait(const char *key, double seconds); @@ -2360,6 +2744,10 @@ typedef void (*Ecore_Pipe_Cb)(void *data, void *buffer, unsigned int nbyte); * @param data Data to pass to @p handler when it is called. * @return A newly created Ecore_Pipe object if successful. * @c NULL otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Pipe *ecore_pipe_add(Ecore_Pipe_Cb handler, const void *data); @@ -2377,6 +2765,10 @@ EAPI Ecore_Pipe *ecore_pipe_add(Ecore_Pipe_Cb handler, const void *data); * * @return A pointer to the new Ecore_Pipe object on success, else NULL. * @see ecore_pipe_add() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Pipe *ecore_pipe_full_add(Ecore_Pipe_Cb handler, const void *data, @@ -2389,6 +2781,10 @@ EAPI Ecore_Pipe *ecore_pipe_full_add(Ecore_Pipe_Cb handler, * * @param p The Ecore_Pipe object to be freed. * @return The pointer to the private data + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_pipe_del(Ecore_Pipe *p); @@ -2399,6 +2795,10 @@ EAPI void *ecore_pipe_del(Ecore_Pipe *p); * @param buffer The data to write into the pipe. * @param nbytes The size of the @p buffer in bytes * @return @c EINA_TRUE on a successful write, @c EINA_FALSE on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_pipe_write(Ecore_Pipe *p, const void *buffer, unsigned int nbytes); @@ -2406,6 +2806,10 @@ EAPI Eina_Bool ecore_pipe_write(Ecore_Pipe *p, const void *buffer, unsigned int * Close the write end of an Ecore_Pipe object created with ecore_pipe_add(). * * @param p The Ecore_Pipe object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_pipe_write_close(Ecore_Pipe *p); @@ -2413,6 +2817,10 @@ EAPI void ecore_pipe_write_close(Ecore_Pipe *p); * Close the read end of an Ecore_Pipe object created with ecore_pipe_add(). * * @param p The Ecore_Pipe object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_pipe_read_close(Ecore_Pipe *p); @@ -2421,6 +2829,10 @@ EAPI void ecore_pipe_read_close(Ecore_Pipe *p); * * @param p The Ecore_Pipe object query. * @return The file descriptor or -1 if none + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_pipe_read_fd(Ecore_Pipe *p); @@ -2429,6 +2841,10 @@ EAPI int ecore_pipe_read_fd(Ecore_Pipe *p); * * @param p The Ecore_Pipe object query. * @return The file descriptor or -1 if none + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_pipe_write_fd(Ecore_Pipe *p); @@ -2439,6 +2855,10 @@ EAPI int ecore_pipe_write_fd(Ecore_Pipe *p); * * @param p The Ecore_Pipe object. * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_pipe_thaw(Ecore_Pipe *p); @@ -2448,6 +2868,10 @@ EAPI void ecore_pipe_thaw(Ecore_Pipe *p); * * @param p The Ecore_Pipe object. * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_pipe_freeze(Ecore_Pipe *p); @@ -2461,6 +2885,10 @@ EAPI void ecore_pipe_freeze(Ecore_Pipe *p); * @since 1.1 * * Negative value for @p wait means infite wait. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_pipe_wait(Ecore_Pipe *p, int message_count, double wait); @@ -2482,6 +2910,10 @@ EAPI int ecore_pipe_wait(Ecore_Pipe *p, int message_count, double wait); * * A call to this function will store the programs command-line arguments * for later use by ecore_app_restart() or ecore_app_args_get(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_app_args_set(int argc, const char **argv); @@ -2495,6 +2927,10 @@ EAPI void ecore_app_args_set(int argc, const char **argv); * the pointer is not NULL, and the string array pointer @p argv will be filled * also if the pointer is not NULL. The values they are filled with will be the * same set by ecore_app_args_set(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_app_args_get(int *argc, char ***argv); @@ -2505,6 +2941,10 @@ EAPI void ecore_app_args_get(int *argc, char ***argv); * using the command-line arguments stored by ecore_app_args_set(). This is * an easy way for a program to restart itself for cleanup purposes, * configuration reasons or in the event of a crash. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_app_restart(void); @@ -2521,6 +2961,10 @@ EAPI void ecore_app_restart(void); * useful for end-user applications. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_app_no_system_modules(void); @@ -2582,6 +3026,10 @@ EAPI void ecore_app_no_system_modules(void); * @endcode * * @param amount Amount (in seconds) to adjust by + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_throttle_adjust(double amount); @@ -2593,6 +3041,10 @@ EAPI void ecore_throttle_adjust(double amount); * ecore_throttle_adjust() for more information. * * @return The current throttle level + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_throttle_get(void); @@ -2659,6 +3111,10 @@ typedef Eo Ecore_Poller; /**< A handle for pollers */ * * This will adjust the time between ticks of the given timer type defined by * @p type to the time period defined by @p poll_time. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_poller_poll_interval_set(Ecore_Poller_Type type, double poll_time); @@ -2668,6 +3124,10 @@ EAPI void ecore_poller_poll_interval_set(Ecore_Poller_Type type, double poll_tim * @return The time in seconds between ticks of the poller timer. * * This will get the time between ticks of the specified poller timer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_poller_poll_interval_get(Ecore_Poller_Type type); @@ -2768,6 +3228,10 @@ typedef Eo Ecore_Animator; /**< A handle for animators */ * value may cause your animation to seem "jerky". * * @note The default @p frametime value is 1/30th of a second. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_frametime_set(double frametime); @@ -2779,6 +3243,10 @@ EAPI void ecore_animator_frametime_set(double frametime); * This function retrieves the time in seconds between animator ticks. * * @see ecore_animator_frametime_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_animator_frametime_get(void); @@ -2841,6 +3309,10 @@ EAPI double ecore_animator_frametime_get(void); * @see _Ecore_Pos_Map * * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_animator_pos_map(double pos, Ecore_Pos_Map map, double v1, double v2); @@ -2905,6 +3377,10 @@ EAPI double ecore_animator_pos_map(double pos, Ecore_Pos_Map map, double v1, dou * factor of 1.8. * * @see _Ecore_Pos_Map + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_animator_pos_map_n(double pos, Ecore_Pos_Map map, int v_size, double *v); @@ -2931,6 +3407,10 @@ EAPI double ecore_animator_pos_map_n(double pos, Ecore_Pos_Map map, int v_size, * over 1 frame. * * @see ecore_animator_source_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_source_set(Ecore_Animator_Source source); @@ -2942,6 +3422,10 @@ EAPI void ecore_animator_source_set(Ecore_Animator_Source source); * This gets the current animator source. * * @see ecore_animator_source_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Animator_Source ecore_animator_source_get(void); @@ -2965,6 +3449,10 @@ EAPI Ecore_Animator_Source ecore_animator_source_get(void); * @see ecore_animator_source_set() * @see ecore_animator_custom_source_tick_end_callback_set() * @see ecore_animator_custom_tick() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_custom_source_tick_begin_callback_set(Ecore_Cb func, const void *data); @@ -2985,6 +3473,10 @@ EAPI void ecore_animator_custom_source_tick_begin_callback_set(Ecore_Cb func, co * @see ecore_animator_source_set() * @see ecore_animator_custom_source_tick_begin_callback_set() * @see ecore_animator_custom_tick() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_custom_source_tick_end_callback_set(Ecore_Cb func, const void *data); @@ -3002,6 +3494,10 @@ EAPI void ecore_animator_custom_source_tick_end_callback_set(Ecore_Cb func, cons * @see ecore_animator_source_set() * @see ecore_animator_custom_source_tick_begin_callback_set * @see ecore_animator_custom_source_tick_end_callback_set()() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_custom_tick(void); @@ -3044,6 +3540,10 @@ typedef Eo Ecore_Timer; /**< A handle for timers */ * Retrieves the current precision used by timer infrastructure. * @return Current precision. * @see ecore_timer_precision_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double ecore_timer_precision_get(void); @@ -3071,6 +3571,10 @@ EAPI double ecore_timer_precision_get(void); * @note Ecore is smart enough to see if there are timers in the * precision range, if it does not, in our example if no second timer * in (T + precision) existed, then it would use the minimum timeout. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_timer_precision_set(double precision); @@ -3082,6 +3586,10 @@ EAPI void ecore_timer_precision_set(double precision); * * It only contains an useful implementation if EFL is built in debug build * profile, but it's safe to call it for any build profile. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *ecore_timer_dump(void); diff --git a/src/lib/ecore/Ecore_Getopt.h b/src/lib/ecore/Ecore_Getopt.h index a20cc98..dcf8995 100644 --- a/src/lib/ecore/Ecore_Getopt.h +++ b/src/lib/ecore/Ecore_Getopt.h @@ -1024,6 +1024,10 @@ struct _Ecore_Getopt * @param info The structure containing information about command line options. * * @see ecore_getopt_help_category() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info); @@ -1037,6 +1041,10 @@ EAPI void ecore_getopt_help(FILE *fp, const Ecore_Getopt *info); * @return @c EINA_TRUE when the category exists, @c EINA_FALSE otherwise. * * @see ecore_getopt_help() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, const char *category); @@ -1045,6 +1053,10 @@ EAPI Eina_Bool ecore_getopt_help_category(FILE *fp, const Ecore_Getopt *info, c * * @return @c EINA_TRUE if there are duplicates, @c EINA_FALSE otherwise. * @param parser The parser to be checked. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser); @@ -1109,6 +1121,10 @@ EAPI Eina_Bool ecore_getopt_parser_has_duplicates(const Ecore_Getopt *parser); * @return index of first non-option parameter or -1 on error. * * @see ecore_getopt_parse_positional() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv); @@ -1162,6 +1178,10 @@ EAPI int ecore_getopt_parse(const Ecore_Getopt *parser, Ecore_Getopt_Valu * @return index of first non-option parameter or -1 on error. If the * last positional argument is of action @c * ECORE_GETOPT_ACTION_APPEND then it will be the same as @a argc. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_getopt_parse_positional(const Ecore_Getopt *parser, Ecore_Getopt_Value *values, int argc, char **argv, int start); @@ -1171,6 +1191,10 @@ EAPI int ecore_getopt_parse_positional(const Ecore_Getopt *parser, Ecore_ * * @param list pointer to list to be freed. * @return always @c NULL, so you can easily make your list head @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List *ecore_getopt_list_free(Eina_List *list); @@ -1188,6 +1212,10 @@ EAPI Eina_List *ecore_getopt_list_free(Eina_List *list); * This is a helper functions to be used with ECORE_GETOPT_CALLBACK_*(). * * @c callback_data value is ignored, you can safely use @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage); @@ -1204,6 +1232,10 @@ EAPI Eina_Bool ecore_getopt_callback_geometry_parse(const Ecore_Getopt *parser, * @return @c EINA_TRUE on success, @c EINA_FALSE on incorrect size value. * * @c callback_data value is ignored, you can safely use @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_getopt_callback_size_parse(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage); diff --git a/src/lib/ecore/Ecore_Legacy.h b/src/lib/ecore/Ecore_Legacy.h index c39cbec..e359ab4 100644 --- a/src/lib/ecore/Ecore_Legacy.h +++ b/src/lib/ecore/Ecore_Legacy.h @@ -32,6 +32,10 @@ extern "C" { * returns 1, it will be called again at the next tick, or if it returns * 0 it will be deleted automatically making any references/handles for it * invalid. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Poller *ecore_poller_add(Ecore_Poller_Type type, int interval, Ecore_Task_Cb func, const void *data); @@ -43,6 +47,10 @@ EAPI Ecore_Poller *ecore_poller_add(Ecore_Poller_Type type, int interval, Ecore_ * * @note @a poller must be a valid handle. If the poller function has already * returned 0, the handle is no longer valid (and does not need to be deleted). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_poller_del(Ecore_Poller *poller); @@ -80,6 +88,10 @@ EAPI void *ecore_poller_del(Ecore_Poller *poller); * * @see ecore_animator_timeline_add() * @see ecore_animator_frametime_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data); @@ -109,6 +121,10 @@ EAPI Ecore_Animator *ecore_animator_add(Ecore_Task_Cb func, const void *data); * @see ecore_animator_add() * @see ecore_animator_pos_map() * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_Cb func, const void *data); @@ -124,6 +140,10 @@ EAPI Ecore_Animator *ecore_animator_timeline_add(double runtime, Ecore_Timeline_ * failure. After this call returns the specified animator object @p animator * is invalid and should not be used again. It will not get called again after * deletion. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_animator_del(Ecore_Animator *animator); @@ -140,6 +160,10 @@ EAPI void *ecore_animator_del(Ecore_Animator *animator); *ecore_animator_timeline_add() the @p pos argument given to the callback * will increase as if the animator hadn't been frozen and the animator may * have it's execution halted if @p runtime elapsed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_freeze(Ecore_Animator *animator); @@ -150,6 +174,10 @@ EAPI void ecore_animator_freeze(Ecore_Animator *animator); * * The specified @p animator will be put back in the set of animators that are * executed during main loop. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_animator_thaw(Ecore_Animator *animator); @@ -182,6 +210,10 @@ EAPI void ecore_animator_thaw(Ecore_Animator *animator); * If it returns 1, it will be called again at the next tick, or if it returns * 0 it will be deleted automatically making any references/handles for it * invalid. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *data); @@ -196,6 +228,10 @@ EAPI Ecore_Timer *ecore_timer_add(double in, Ecore_Task_Cb func, const void *dat * This is the same as ecore_timer_add(), but "now" is the time from * ecore_loop_time_get() not ecore_time_get() as ecore_timer_add() uses. See * ecore_timer_add() for more details. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void *data); @@ -207,6 +243,10 @@ EAPI Ecore_Timer *ecore_timer_loop_add(double in, Ecore_Task_Cb func, const void * * Note: @p timer must be a valid handle. If the timer function has already * returned 0, the handle is no longer valid (and does not need to be delete). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_timer_del(Ecore_Timer *timer); @@ -240,6 +280,10 @@ EAPI void ecore_timer_thaw(Ecore_Timer *timer); * (or ECORE_CALLBACK_CANCEL) deletes the idler. * * Idlers are useful for progressively prossessing data without blocking. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data); @@ -248,6 +292,10 @@ EAPI Ecore_Idler *ecore_idler_add(Ecore_Task_Cb func, const void *data); * @param idler The handle of the idler callback to delete * @return The data pointer passed to the idler callback on success, @c NULL * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_idler_del(Ecore_Idler *idler); @@ -260,6 +308,10 @@ EAPI void *ecore_idler_del(Ecore_Idler *idler); * @note The function func will be called every time the main loop is entering * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Idle_Enterer *ecore_idle_enterer_add(Ecore_Task_Cb func, const void *data); @@ -272,6 +324,10 @@ EAPI Ecore_Idle_Enterer *ecore_idle_enterer_add(Ecore_Task_Cb func, const void * * @note The function func will be called every time the main loop is entering * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 * (or ECORE_CALLBACK_CANCEL) deletes the idle enterer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Idle_Enterer *ecore_idle_enterer_before_add(Ecore_Task_Cb func, const void *data); @@ -280,6 +336,10 @@ EAPI Ecore_Idle_Enterer *ecore_idle_enterer_before_add(Ecore_Task_Cb func, const * @param idle_enterer The idle enterer to delete * @return The data pointer passed to the idler enterer callback on success. * NULL otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer); @@ -291,6 +351,10 @@ EAPI void *ecore_idle_enterer_del(Ecore_Idle_Enterer *idle_enterer); * @note The function func will be called every time the main loop is exiting * idle state, as long as it returns 1 (or ECORE_CALLBACK_RENEW). A return of 0 * (or ECORE_CALLBACK_CANCEL) deletes the idle exiter. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Idle_Exiter *ecore_idle_exiter_add(Ecore_Task_Cb func, const void *data); @@ -299,6 +363,10 @@ EAPI Ecore_Idle_Exiter *ecore_idle_exiter_add(Ecore_Task_Cb func, const void *da * @param idle_exiter The idle exiter to delete * @return The data pointer that was being being passed to the handler if * successful. NULL otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter); @@ -333,6 +401,10 @@ EAPI void *ecore_idle_exiter_del(Ecore_Idle_Exiter *idle_exiter); * @return The handle of the job. @c NULL is returned if the job could not be * added to the queue. * @note Once the job has been executed, the job handle is invalid. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data); @@ -340,6 +412,10 @@ EAPI Ecore_Job *ecore_job_add(Ecore_Cb func, const void *data); * Delete a queued job that has not yet been executed. * @param obj Handle of the job to delete. * @return The data pointer that was to be passed to the job. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_job_del(Ecore_Job *obj); diff --git a/src/lib/ecore/ecore_animator.eo b/src/lib/ecore/ecore_animator.eo index eb0e183..8a5c3b6 100644 --- a/src/lib/ecore/ecore_animator.eo +++ b/src/lib/ecore/ecore_animator.eo @@ -2,7 +2,7 @@ class Ecore.Animator (Eo.Base) { eo_prefix: ecore_animator; methods { - timeline_constructor { + timeline_constructor @internal { [[Constructor.]] legacy: null; params { @@ -11,7 +11,7 @@ class Ecore.Animator (Eo.Base) @in data: const(void)*; } } - constructor { + constructor @internal { [[Constructor.]] legacy: null; params { diff --git a/src/lib/ecore/ecore_idle_enterer.eo b/src/lib/ecore/ecore_idle_enterer.eo index 4f975ed..56950cc 100644 --- a/src/lib/ecore/ecore_idle_enterer.eo +++ b/src/lib/ecore/ecore_idle_enterer.eo @@ -2,7 +2,7 @@ class Ecore.Idle.Enterer (Eo.Base) { eo_prefix: ecore_idle_enterer; methods { - before_constructor { + before_constructor @internal { [[Contructor. Will insert the handler at the beginning of the list.]] legacy: null; params { @@ -10,7 +10,7 @@ class Ecore.Idle.Enterer (Eo.Base) @in data: const(void)*; } } - after_constructor { + after_constructor @internal { [[Contructor. Will insert the handler at the end of the list.]] legacy: null; params { diff --git a/src/lib/ecore/ecore_idle_exiter.eo b/src/lib/ecore/ecore_idle_exiter.eo index 8e79177..98e07b9 100644 --- a/src/lib/ecore/ecore_idle_exiter.eo +++ b/src/lib/ecore/ecore_idle_exiter.eo @@ -2,7 +2,7 @@ class Ecore.Idle.Exiter (Eo.Base) { eo_prefix: ecore_idle_exiter; methods { - constructor { + constructor @internal { [[Constructor.]] legacy: null; params { diff --git a/src/lib/ecore/ecore_idler.eo b/src/lib/ecore/ecore_idler.eo index 56ae811..4420957 100644 --- a/src/lib/ecore/ecore_idler.eo +++ b/src/lib/ecore/ecore_idler.eo @@ -2,7 +2,7 @@ class Ecore.Idler (Eo.Base) { eo_prefix: ecore_idler; methods { - constructor { + constructor @internal { [[Constructor.]] legacy: null; params { diff --git a/src/lib/ecore/ecore_job.eo b/src/lib/ecore/ecore_job.eo index e9c4cd8..3929586 100644 --- a/src/lib/ecore/ecore_job.eo +++ b/src/lib/ecore/ecore_job.eo @@ -2,7 +2,7 @@ class Ecore.Job (Eo.Base) { eo_prefix: ecore_job; methods { - constructor { + constructor @internal { [[Constructor.]] legacy: null; params { diff --git a/src/lib/ecore/ecore_poller.eo b/src/lib/ecore/ecore_poller.eo index 92fb30f..d3f4c0a 100644 --- a/src/lib/ecore/ecore_poller.eo +++ b/src/lib/ecore/ecore_poller.eo @@ -1,7 +1,7 @@ class Ecore.Poller (Eo.Base) { methods { - constructor { + constructor @internal { [[Constructor with parameters for Ecore Poller.]] legacy: null; params { @@ -18,12 +18,21 @@ class Ecore.Poller (Eo.Base) This allows the changing of a poller's polling interval. It is useful when you want to alter a poll rate without deleting and re-creating a poller. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] legacy: ecore_poller_poller_interval_set; return: bool; [[true on success, false on failure.]] } get { - [[Gets the polling interval rate of the poller.]] + [[Gets the polling interval rate of the poller. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] legacy: ecore_poller_poller_interval_get; } values { diff --git a/src/lib/ecore/ecore_timer.eo b/src/lib/ecore/ecore_timer.eo index b1cfee1..156d1e1 100644 --- a/src/lib/ecore/ecore_timer.eo +++ b/src/lib/ecore/ecore_timer.eo @@ -15,10 +15,19 @@ class Ecore.Timer (Eo.Base) set { [[Change the interval the timer ticks off. If set during a timer call, this will affect the next interval. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { - [[Get the interval the timer ticks on.]] + [[Get the interval the timer ticks on. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { in: double(-1); [[The new interval in seconds]] @@ -26,7 +35,12 @@ class Ecore.Timer (Eo.Base) } @property pending { get { - [[Get the pending time regarding a timer.]] + [[Get the pending time regarding a timer. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: double; } } @@ -64,12 +78,20 @@ class Ecore.Timer (Eo.Base) [[Reset a timer to its full interval. This effectively makes the timer start ticking off from zero now. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] } delay { [[Add some delay for the next occurrence of a timer. This doesn't affect the interval of a timer. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in add: double; [[The amount of time to delay the timer by in seconds]] diff --git a/src/lib/ecore_audio/Ecore_Audio.h b/src/lib/ecore_audio/Ecore_Audio.h index 1b66663..116ab68 100644 --- a/src/lib/ecore_audio/Ecore_Audio.h +++ b/src/lib/ecore_audio/Ecore_Audio.h @@ -171,6 +171,8 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio; /* Audio operations */ /** + * @internal + * * @brief Initialize the Ecore_Audio library. * * @return 1 or greater on success, 0 on error. @@ -187,6 +189,8 @@ typedef struct _Ecore_Audio_Vio Ecore_Audio_Vio; EAPI int ecore_audio_init(void); /** + * @internal + * * @brief Shut down the Ecore_Audio library. * * @return 0 when the library is completely shut down, 1 or diff --git a/src/lib/ecore_avahi/Ecore_Avahi.h b/src/lib/ecore_avahi/Ecore_Avahi.h index e5da795..3a7c8dd 100644 --- a/src/lib/ecore_avahi/Ecore_Avahi.h +++ b/src/lib/ecore_avahi/Ecore_Avahi.h @@ -52,6 +52,8 @@ extern "C" { typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */ /** + * @internal + * * @brief Create an AvahiPoll context and integrate it within Ecore main loop. * * @return A handler that reference the AvahiPoll context @@ -60,6 +62,8 @@ typedef struct _Ecore_Avahi Ecore_Avahi; /**< A handle for an Avahi instance. */ EAPI Ecore_Avahi *ecore_avahi_add(void); /** + * @internal + * * @brief Delete the specified handler of an AvahiPoll. * * @param handler The actual handler to destroy. @@ -71,6 +75,8 @@ EAPI Ecore_Avahi *ecore_avahi_add(void); EAPI void ecore_avahi_del(Ecore_Avahi *handler); /** + * @internal + * * @brief Get the AvahiPoll structure to integrate with Ecore main loop. * * @param handler The handler to get the AvahiPoll structure from. diff --git a/src/lib/ecore_buffer/Ecore_Buffer.h b/src/lib/ecore_buffer/Ecore_Buffer.h index 7a7c21e..eff8a5d 100644 --- a/src/lib/ecore_buffer/Ecore_Buffer.h +++ b/src/lib/ecore_buffer/Ecore_Buffer.h @@ -474,6 +474,10 @@ struct _Ecore_Buffer_Backend * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. * * @see ecore_buffer_shutdown() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_init(void); /** @@ -484,6 +488,10 @@ EAPI Eina_Bool ecore_buffer_init(void); * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. * * @see ecore_buffer_init() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_shutdown(void); /** @@ -494,6 +502,10 @@ EAPI Eina_Bool ecore_buffer_shutdown(void); * @param[in] be The backend * * @return @c EINA_TRUE if backend has been correctly registered, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_register(Ecore_Buffer_Backend *be); /** @@ -502,6 +514,10 @@ EAPI Eina_Bool ecore_buffer_register(Ecore_Buffer_Backend *be); * @since 1.15 * * @param[in] be The backend + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_unregister(Ecore_Buffer_Backend *be); /** @@ -516,6 +532,10 @@ EAPI void ecore_buffer_unregister(Ecore_Buffer_Backend *be); * @param[in] flags flags for Ecore_Buffer * * @return Newly allocated Ecore_Buffer instance, NULL otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsigned int height, Ecore_Buffer_Format format, unsigned int flags); /** @@ -528,6 +548,10 @@ EAPI Ecore_Buffer *ecore_buffer_new(const char *engine, unsigned int width, unsi * @param[in] flags the flags for Ecore_Buffer * * @return Newly allocated Ecore_Buffer instance based on tbm surface, NULL otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer *ecore_buffer_new_with_tbm_surface(const char *engine, void *tbm_surface, unsigned int flags); /** @@ -536,6 +560,10 @@ EAPI Ecore_Buffer *ecore_buffer_new_with_tbm_surface(const char *engine, void *t * @since 1.15 * * @param[in] buf The Ecore_Buffer to free + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_free(Ecore_Buffer *buf); /** @@ -551,6 +579,10 @@ EAPI void ecore_buffer_free(Ecore_Buffer *buf); * @p func to be called whenever @p buf is freed. * * @see ecore_buffer_free_callback_remove() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data); /** @@ -563,6 +595,10 @@ EAPI void ecore_buffer_free_callback_add(Ecore_Buffer *buf, Ecore_Buffe * @param[in] data A pointer to the user data to remove * * @see ecore_buffer_free_callback_add() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Buffer_Cb func, void *data); /** @@ -573,6 +609,10 @@ EAPI void ecore_buffer_free_callback_remove(Ecore_Buffer *buf, Ecore_Bu * @param[in] buf The Ecore_Buffer * * @return The Pixmap instance, 0 otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf); /** @@ -586,6 +626,10 @@ EAPI Ecore_Pixmap ecore_buffer_pixmap_get(Ecore_Buffer *buf); * * The tbm surface handle will be used for the API of libtbm. * The API is described in tbm_surface.h in libtbm. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf); /** @@ -598,6 +642,10 @@ EAPI void *ecore_buffer_tbm_surface_get(Ecore_Buffer *buf); * @param[out] height where to return the height value. May be @c NULL. * * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, unsigned int *height); /** @@ -610,6 +658,10 @@ EAPI Eina_Bool ecore_buffer_size_get(Ecore_Buffer *buf, unsigned int *width, * @return The format of given Ecore_Buffer. * * return value can be one of those pre-defined value such as ECORE_BUFFER_FORMAT_XRGB8888. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer_Format ecore_buffer_format_get(Ecore_Buffer *buf); /** @@ -622,6 +674,10 @@ EAPI Ecore_Buffer_Format ecore_buffer_format_get(Ecore_Buffer *buf); * @return The flags of given Ecore_Buffer. * * NOTE: Not Defined yet. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI unsigned int ecore_buffer_flags_get(Ecore_Buffer *buf); diff --git a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h index 23faa46..4cbeb38 100644 --- a/src/lib/ecore_buffer/Ecore_Buffer_Queue.h +++ b/src/lib/ecore_buffer/Ecore_Buffer_Queue.h @@ -182,6 +182,10 @@ typedef void (*Ecore_Buffer_Provider_Enqueue_Cb) (Ecore_Buffer_Provider *provide * Set up the connection of Buffer Queue deamon, and Init Ecore_Buffer_Queue libraries. * * @see ecore_buffer_queue_shutdown() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_buffer_queue_init(void); /** @@ -192,6 +196,10 @@ EAPI int ecore_buffer_queue_init(void); * this closes the connection of Buffer Queue deamon, and Shut down Ecore_Buffer_Queue libraries. * * @see ecore_buffer_queue_init() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_buffer_queue_shutdown(void); @@ -215,6 +223,10 @@ EAPI int ecore_buffer_queue_shutdown(void); * @param[in] h height of buffer recommended to provider. * * @return Ecore_Buffer_Consumer instance or @c NULL if creation failed. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32_t queue_size, int32_t w, int32_t h); /** @@ -225,6 +237,10 @@ EAPI Ecore_Buffer_Consumer *ecore_buffer_consumer_new(const char *name, int32 * @param[in] consumer The Ecore_Buffer_Consumer to free * * This frees up any memory used by the Ecore_Buffer_Consumer. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer *consumer); /** @@ -240,6 +256,10 @@ EAPI void ecore_buffer_consumer_free(Ecore_Buffer_Consumer * * Consumer can store Ecore_Buffer submitted by Provider as much as size of queue * which is passed as a argument of ecore_buffer_consumer_new(). + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer_Consumer *consumer); /** @@ -258,6 +278,10 @@ EAPI Ecore_Buffer *ecore_buffer_consumer_buffer_dequeue(Ecore_Buffer * By doing release, Ecore_Buffer will be used by provider again, * or freed internally if Ecore_Buffer is not necessary anymore. * If not, the resource of Ecore_Buffer is continually owned by consumer until released. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer_Consumer *consumer, Ecore_Buffer *buffer); /** @@ -268,6 +292,10 @@ EAPI Eina_Bool ecore_buffer_consumer_buffer_release(Ecore_Buffer * @param[in] consumer The Ecore_Buffer_Consumer to query * * @return @c EINA_TRUE means queue is empty, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer_Consumer *consumer); /** @@ -281,6 +309,10 @@ EAPI Eina_Bool ecore_buffer_consumer_queue_is_empty(Ecore_Buffer * * A call to this function will set a callback on an Ecore_Buffer_Consumer, causing * @p func to be called whenever @p consumer is connected with provider. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Add_Cb func, void *data); /** @@ -294,6 +326,10 @@ EAPI void ecore_buffer_consumer_provider_add_cb_set(Ecore_B * * A call to this function will set a callback on an Ecore_Buffer_Consumer, causing * @p func to be called whenever @p consumer is disconnected with provider. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Provider_Del_Cb func, void *data); /** @@ -309,6 +345,10 @@ EAPI void ecore_buffer_consumer_provider_del_cb_set(Ecore_B * @p func to be called whenever @p consumer has received buffer submitted from provider. * * You may success acuiqre Ecore_Buffer after this callback called. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecore_Buffer_Consumer *consumer, Ecore_Buffer_Consumer_Enqueue_Cb func, void *data); @@ -329,6 +369,10 @@ EAPI void ecore_buffer_consumer_buffer_enqueued_cb_set(Ecor * @param[in] name the name of Buffer_Queue. * * @return Ecore_Buffer_Provider instance or @c NULL if creation failed. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name); /** @@ -339,6 +383,10 @@ EAPI Ecore_Buffer_Provider *ecore_buffer_provider_new(const char *name); * @param[in] provider The Ecore_Buffer_Provider to free * * This frees up any memory used by the Ecore_Buffer_Provider. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider *provider); /** @@ -361,6 +409,10 @@ EAPI void ecore_buffer_provider_free(Ecore_Buffer_Provider * so, You may create new Ecore_Buffer, and then just enqueue the Ecore_Buffer. * * @see ecore_buffer_new(), ecore_buffer_provider_buffer_enqueue() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer_Provider *provider, Ecore_Buffer **ret_buf); /** @@ -378,6 +430,10 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquire(Ecore_Buffer * and new Ecore_Buffer after received return value of ECORE_BUFFER_RETURN_NEED_ALLOC by ecore_buffer_provider_buffer_acquire(). * * @see ecore_buffer_new(), ecore_buffer_provider_buffer_dequeue() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer_Provider *provider, Ecore_Buffer *buffer); /** @@ -394,6 +450,10 @@ EAPI Eina_Bool ecore_buffer_provider_buffer_enqueue(Ecore_Buffer * so, You may create new Ecore_Buffer, and then just enqueue the Ecore_Buffer. * * @return @c EINA_TRUE means queue is empty, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Ecore_Buffer_Provider *provider); /** @@ -407,6 +467,10 @@ EAPI Ecore_Buffer_Return ecore_buffer_provider_buffer_acquirable_check(Eco * * A call to this function will set a callback on an Ecore_Buffer_Provider, causing * @p func to be called whenever @p provider is connected with consumer. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Add_Cb func, void *data); /** @@ -420,6 +484,10 @@ EAPI void ecore_buffer_provider_consumer_add_cb_set(Ecore_B * * A call to this function will set a callback on an Ecore_Buffer_Provider, causing * @p func to be called whenever @p provider is disconnected with consumer. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_provider_consumer_del_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Consumer_Del_Cb func, void *data); /** @@ -435,6 +503,10 @@ EAPI void ecore_buffer_provider_consumer_del_cb_set(Ecore_B * @p func to be called whenever @p provider has received Ecore_Buffer released from provider. * * You may success dequeue the Ecore_Buffer after this callback called. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_buffer_provider_buffer_released_cb_set(Ecore_Buffer_Provider *provider, Ecore_Buffer_Provider_Enqueue_Cb func, void *data); diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h index 09363f7..3b987fd 100644 --- a/src/lib/ecore_con/Ecore_Con.h +++ b/src/lib/ecore_con/Ecore_Con.h @@ -653,51 +653,140 @@ struct _Ecore_Con_Event_Url_Progress } up; /**< upload info */ }; -/** A client has connected to the server */ +/** + * A client has connected to the serve + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_CLIENT_ADD; -/** A client has disconnected from the server */ +/** + * A client has disconnected from the serve + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_CLIENT_DEL; -/** A client experienced an error +/** + * A client experienced an error * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_CLIENT_ERROR; -/** A client connection has been upgraded to SSL +/** + * A client connection has been upgraded to SSL * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_CLIENT_UPGRADE; -/** A server was created */ +/** + * A server was create + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_SERVER_ADD; -/** A server connection was lost */ +/** + * A server connection was los + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_SERVER_DEL; -/** A server experienced an error +/** + * A server experienced an error * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_SERVER_ERROR; -/** A server connection has been upgraded to SSL +/** + * A server connection has been upgraded to SSL * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_SERVER_UPGRADE; -/** A server connection has sent data to its client +/** + * A server connection has sent data to its client * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_CLIENT_WRITE; -/** A server connection object has sent data +/** + * A server connection object has sent data * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_SERVER_WRITE; -/** A client connected to the server has sent data */ +/** + * A client connected to the server has sent dat + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_CLIENT_DATA; -/** A server connection object has data */ +/** + * A server connection object has dat + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_SERVER_DATA; -/** A server connection has successfully negotiated an ip:port binding +/** + * A server connection has successfully negotiated an ip:port binding * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern int ECORE_CON_EVENT_PROXY_BIND; -/** A URL object has data */ +/** + * A URL object has dat + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_URL_DATA; -/** A URL object has completed its transfer to and from the server and can be reused */ +/** + * A URL object has completed its transfer to and from the server and can be reuse + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_URL_COMPLETE; -/** A URL object has made progress in its transfer */ +/** + * A URL object has made progress in its transfe + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS; /** @@ -718,6 +807,10 @@ EAPI extern int ECORE_CON_EVENT_URL_PROGRESS; * * @note This function already calls ecore_init() internally, so you don't need * to call it explicitly. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_init(void); @@ -727,6 +820,10 @@ EAPI int ecore_con_init(void); * shut down. * @note This function already calls ecore_shutdown() internally, so you don't * need to call it explicitly unless you called ecore_init() explicitly too. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_shutdown(void); @@ -748,6 +845,10 @@ EAPI int ecore_con_shutdown(void); * @return 1 if SSL is available and provided by gnutls, * 2 if SSL is available and provided by openssl, * 0 if it is not available. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_ssl_available_get(void); @@ -760,6 +861,10 @@ EAPI int ecore_con_ssl_available_get(void); * @param svr The server object * @param cert The path to the certificate. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, const char *cert); @@ -772,6 +877,10 @@ EAPI Eina_Bool ecore_con_ssl_server_cert_add(Ecore_Con_Server *svr, cons * @param svr The server object * @param key_file The path to the key file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, const char *key_file); @@ -784,6 +893,10 @@ EAPI Eina_Bool ecore_con_ssl_server_privkey_add(Ecore_Con_Server *svr, c * @param svr The server object * @param crl_file The path to the CRL file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const char *crl_file); @@ -797,6 +910,10 @@ EAPI Eina_Bool ecore_con_ssl_server_crl_add(Ecore_Con_Server *svr, const * @param ca_file The path to the CA file. * @return @c EINA_FALSE if the file cannot be loaded, otherwise @c EINA_TRUE. * @note since 1.2, this function can load directores + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, const char *ca_file); @@ -806,6 +923,10 @@ EAPI Eina_Bool ecore_con_ssl_server_cafile_add(Ecore_Con_Server *svr, co * Call this function on a server object before main loop has started * to enable verification of certificates against loaded certificates. * @param svr The server object + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr); @@ -818,6 +939,10 @@ EAPI void ecore_con_ssl_server_verify(Ecore_Con_Server *svr); * @note This function has no effect when used on a listening server created by * ecore_con_server_add * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); @@ -833,6 +958,10 @@ EAPI void ecore_con_ssl_server_verify_basic(Ecore_Con_Server *svr); * @param svr The server object * @param name The hostname to verify against * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *svr, const char *name); @@ -845,6 +974,10 @@ EAPI void ecore_con_ssl_server_verify_name_set(Ecore_Con_Server *sv * @param svr The server object * @return The hostname which will be used * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *svr); @@ -860,6 +993,10 @@ EAPI const char *ecore_con_ssl_server_verify_name_get(Ecore_Con_Server *sv * @note This function is NEVER to be used on a server object created with ecore_con_server_add * @warning Setting a wrong value for @p compl_type WILL mess up your program. * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore_Con_Type compl_type); @@ -874,6 +1011,10 @@ EAPI Eina_Bool ecore_con_ssl_server_upgrade(Ecore_Con_Server *svr, Ecore * @return @c EINA_FALSE if the connection cannot be upgraded, otherwise @c EINA_TRUE. * @warning Setting a wrong value for @p compl_type WILL mess up your program. * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_Con_Type compl_type); @@ -898,6 +1039,10 @@ EAPI Eina_Bool ecore_con_ssl_client_upgrade(Ecore_Con_Client *cl, Ecore_ * @return An allocated proxy object, or NULL on failure * @note This object NEVER needs to be explicitly freed. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, const char *username); @@ -913,6 +1058,10 @@ EAPI Ecore_Con_Socks *ecore_con_socks4_remote_add(const char *ip, int port, cons * @note This function matches slightly more loosely than ecore_con_socks4_remote_add(), and * ecore_con_socks4_remote_add() should be used to return the actual object. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, const char *username); @@ -927,6 +1076,10 @@ EAPI Eina_Bool ecore_con_socks4_remote_exists(const char *ip, int port, c * @note This function matches in the same way as ecore_con_socks4_remote_exists(). * @warning Be aware that deleting a proxy which is being used WILL ruin your life. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks4_remote_del(const char *ip, int port, const char *username); @@ -942,6 +1095,10 @@ EAPI void ecore_con_socks4_remote_del(const char *ip, int port, cons * @return An allocated proxy object, or NULL on failure * @note This object NEVER needs to be explicitly freed. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, const char *username, const char *password); @@ -958,6 +1115,10 @@ EAPI Ecore_Con_Socks *ecore_con_socks5_remote_add(const char *ip, int port, cons * @note This function matches slightly more loosely than ecore_con_socks5_remote_add(), and * ecore_con_socks5_remote_add() should be used to return the actual object. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, const char *username, const char *password); @@ -973,6 +1134,10 @@ EAPI Eina_Bool ecore_con_socks5_remote_exists(const char *ip, int port, c * @note This function matches in the same way as ecore_con_socks4_remote_exists(). * @warning Be aware that deleting a proxy which is being used WILL ruin your life. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks5_remote_del(const char *ip, int port, const char *username, const char *password); @@ -988,6 +1153,10 @@ EAPI void ecore_con_socks5_remote_del(const char *ip, int port, cons * @param enable If true, the proxy will perform the dns lookup * @note By default, this setting is DISABLED. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool enable); @@ -1002,6 +1171,10 @@ EAPI void ecore_con_socks_lookup_set(Ecore_Con_Socks *ecs, Eina_Bool * @return If true, the proxy will perform the dns lookup * @note By default, this setting is DISABLED. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); @@ -1014,6 +1187,10 @@ EAPI Eina_Bool ecore_con_socks_lookup_get(Ecore_Con_Socks *ecs); * @param is_bind If true, the connection established will be a port binding * @warning Be aware that changing the operation mode of an active proxy may result in undefined behavior * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool is_bind); @@ -1025,6 +1202,10 @@ EAPI void ecore_con_socks_bind_set(Ecore_Con_Socks *ecs, Eina_Bool i * @param ecs The proxy object * @return If true, the connection established will be a port binding * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); @@ -1035,6 +1216,10 @@ EAPI Eina_Bool ecore_con_socks_bind_get(Ecore_Con_Socks *ecs); * @param ecs The proxy object * @return 0 on error, else 4/5 * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); @@ -1045,6 +1230,10 @@ EAPI unsigned int ecore_con_socks_version_get(Ecore_Con_Socks *ecs); * @param ecs The proxy object to delete * @warning Be aware that deleting a proxy which is being used WILL ruin your life. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); @@ -1056,6 +1245,10 @@ EAPI void ecore_con_socks_remote_del(Ecore_Con_Socks *ecs); * @param ecs The proxy object * @see ecore_con_socks_apply_always() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs); @@ -1073,6 +1266,10 @@ EAPI void ecore_con_socks_apply_once(Ecore_Con_Socks *ecs); * server is the IP_ADDRESS of the proxy server * port is the port to connect to on the proxy server * lookup is 1 if the proxy should perform all DNS lookups, otherwise 0 or omitted + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs); @@ -1184,6 +1381,10 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs); * * The @p data parameter can be fetched later using ecore_con_server_data_get() * or changed with ecore_con_server_data_set(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type, const char *name, int port, @@ -1234,6 +1435,10 @@ EAPI Ecore_Con_Server *ecore_con_server_add(Ecore_Con_Type type, * * The @p data parameter can be fetched later using ecore_con_server_data_get() * or changed with ecore_con_server_data_set(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type, const char *name, int port, @@ -1247,6 +1452,10 @@ EAPI Ecore_Con_Server *ecore_con_server_connect(Ecore_Con_Type type, * All the clients connected to this server will be disconnected. * * @see ecore_con_server_add, ecore_con_server_connect + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_server_del(Ecore_Con_Server *svr); @@ -1257,6 +1466,10 @@ EAPI void * ecore_con_server_del(Ecore_Con_Server *svr); * @return The associated data. * * @see ecore_con_server_data_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); /** @@ -1267,6 +1480,10 @@ EAPI void * ecore_con_server_data_get(Ecore_Con_Server *svr); * @return The previously associated data, if any. * * @see ecore_con_server_data_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, void *data); @@ -1275,6 +1492,10 @@ EAPI void * ecore_con_server_data_set(Ecore_Con_Server *svr, * * @param svr The given server. * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *svr); @@ -1285,6 +1506,10 @@ EAPI Eina_Bool ecore_con_server_connected_get(const Ecore_Con_Server *sv * @return The server port in use. * * The port where the server is listening for connections. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr); /** @@ -1296,6 +1521,10 @@ EAPI int ecore_con_server_port_get(const Ecore_Con_Server *svr); * * This function is used to find out the time that has been elapsed since * ecore_con_server_add() succeeded. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr); /** @@ -1314,6 +1543,10 @@ EAPI double ecore_con_server_uptime_get(const Ecore_Con_Server *svr); * * @see ecore_con_client_send() * @see ecore_con_server_flush() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_server_send(Ecore_Con_Server *svr, const void *data, @@ -1340,6 +1573,10 @@ EAPI int ecore_con_server_send(Ecore_Con_Server *svr, * already have pending CLIENT_ADD events in your event queue. Those * clients have already connected and will not be affected by this call. * Only clients subsequently trying to connect will be affected. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr, int client_limit, @@ -1353,6 +1590,10 @@ EAPI void ecore_con_server_client_limit_set(Ecore_Con_Server *svr, * This string should not be modified or trusted to stay valid after * deletion for the @p svr object. If no IP is known @c NULL is * returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); /** @@ -1364,6 +1605,10 @@ EAPI const char * ecore_con_server_ip_get(const Ecore_Con_Server *svr); * * @see ecore_con_server_send() * @see ecore_con_client_flush() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); /** @@ -1383,6 +1628,10 @@ EAPI void ecore_con_server_flush(Ecore_Con_Server *svr); * * @see ecore_con_server_timeout_get() * @see ecore_con_client_timeout_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, double timeout); /** @@ -1396,6 +1645,10 @@ EAPI void ecore_con_server_timeout_set(Ecore_Con_Server *svr, doubl * * @see ecore_con_server_timeout_set() * @see ecore_con_client_timeout_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr); @@ -1410,6 +1663,10 @@ EAPI double ecore_con_server_timeout_get(const Ecore_Con_Server *svr) * @note This function is only valid for servers created with ecore_con_server_connect() * @warning Seriously. Don't use this unless you know what you are doing. * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr); @@ -1422,6 +1679,10 @@ EAPI int ecore_con_server_fd_get(const Ecore_Con_Server *svr); * This function returns the fd which is used by the underlying client connection. * It should not be tampered with unless you REALLY know what you are doing. * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_client_fd_get(const Ecore_Con_Client *cl); /** @@ -1464,6 +1725,10 @@ EAPI int ecore_con_client_fd_get(const Ecore_Con_Client *cl); * * @see ecore_con_server_send() * @see ecore_con_client_flush() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_client_send(Ecore_Con_Client *cl, const void *data, @@ -1473,6 +1738,10 @@ EAPI int ecore_con_client_send(Ecore_Con_Client *cl, * * @param cl The given client. * @return Data associated with the client. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); /** @@ -1480,6 +1749,10 @@ EAPI void * ecore_con_client_del(Ecore_Con_Client *cl); * * @param cl The given client. * @param data What to set the data to. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, const void *data); @@ -1488,6 +1761,10 @@ EAPI void ecore_con_client_data_set(Ecore_Con_Client *cl, * * @param cl The given client. * @return The data associated with @p cl. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); @@ -1500,6 +1777,10 @@ EAPI void * ecore_con_client_data_get(Ecore_Con_Client *cl); * * The returned string should not be modified, freed or trusted to stay valid * after deletion for the @p cl object. If no IP is known @c NULL is returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); /** @@ -1511,6 +1792,10 @@ EAPI const char * ecore_con_client_ip_get(const Ecore_Con_Client *cl); * * @see ecore_con_client_send() * @see ecore_con_server_flush() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl); /** @@ -1521,6 +1806,10 @@ EAPI void ecore_con_client_flush(Ecore_Con_Client *cl); * the server * * This function is used to find out how long a client has been connected for. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); /** @@ -1534,6 +1823,10 @@ EAPI double ecore_con_client_uptime_get(const Ecore_Con_Client *cl); * means the idle timeout is disabled. * * @see ecore_con_client_timeout_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); /** @@ -1554,6 +1847,10 @@ EAPI double ecore_con_client_timeout_get(const Ecore_Con_Client *cl); * * @see ecore_con_client_timeout_get() * @see ecore_con_server_timeout_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double timeout); /** @@ -1561,6 +1858,10 @@ EAPI void ecore_con_client_timeout_set(Ecore_Con_Client *cl, double * * @param cl The given client. * @return @c EINA_TRUE if connected, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_client_connected_get(const Ecore_Con_Client *cl); /** @@ -1569,6 +1870,10 @@ EAPI Eina_Bool ecore_con_client_connected_get(const Ecore_Con_Client *cl * @param cl The client * @return The port that @p cl has connected to, or -1 on error * Use this function to return the port on which a given client has connected. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_client_port_get(const Ecore_Con_Client *cl); @@ -1696,6 +2001,10 @@ typedef enum _Ecore_Con_Url_Http_Version * @return @c EINA_TRUE on success, @c EINA_FALSE on failure to change version. * @since 1.2 * @see ecore_con_url_pipeline_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ecore_Con_Url_Http_Version version); @@ -1706,6 +2015,10 @@ EAPI Eina_Bool ecore_con_url_http_version_set(Ecore_Con_Url *url_con, Ec * * @note This function doesn't call ecore_con_init(). You still need to call it * explicitly before calling this one. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_url_init(void); @@ -1715,6 +2028,10 @@ EAPI int ecore_con_url_init(void); * * @note This function doesn't call ecore_con_shutdown(). You still need to call * it explicitly after calling this one. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_url_shutdown(void); @@ -1732,6 +2049,10 @@ EAPI int ecore_con_url_shutdown(void); * See http://en.wikipedia.org/wiki/HTTP_pipelining for more info. * * @see ecore_con_url_pipeline_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_pipeline_set(Eina_Bool enable); /** @@ -1739,6 +2060,10 @@ EAPI void ecore_con_url_pipeline_set(Eina_Bool enable); * @return @c EINA_TRUE if it is enable. * * @see ecore_con_url_pipeline_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_pipeline_get(void); @@ -1755,6 +2080,10 @@ EAPI Eina_Bool ecore_con_url_pipeline_get(void); * * @see ecore_con_url_custom_new() * @see ecore_con_url_url_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url); /** @@ -1771,6 +2100,10 @@ EAPI Ecore_Con_Url * ecore_con_url_new(const char *url); * * @see ecore_con_url_new() * @see ecore_con_url_url_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, const char *custom_request); @@ -1780,6 +2113,10 @@ EAPI Ecore_Con_Url * ecore_con_url_custom_new(const char *url, * @param url_con Connection object to free. * * @see ecore_con_url_new() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); @@ -1793,6 +2130,10 @@ EAPI void ecore_con_url_free(Ecore_Con_Url *url_con); * ecore_con_url_data_get()). * * @see ecore_con_url_data_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, void *data); @@ -1807,6 +2148,10 @@ EAPI void ecore_con_url_data_set(Ecore_Con_Url *url_con, * set with ecore_con_url_data_set()). * * @see ecore_con_url_data_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con); /** @@ -1825,6 +2170,10 @@ EAPI void * ecore_con_url_data_get(Ecore_Con_Url *url_con); * @see ecore_con_url_get() * @see ecore_con_url_post() * @see ecore_con_url_additional_headers_clear() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_con, const char *key, @@ -1840,6 +2189,10 @@ EAPI void ecore_con_url_additional_header_add(Ecore_Con_Url *url_co * @see ecore_con_url_additional_header_add() * @see ecore_con_url_get() * @see ecore_con_url_post() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url_con); /** @@ -1852,6 +2205,10 @@ EAPI void ecore_con_url_additional_headers_clear(Ecore_Con_Url *url * ready at that time). * * @return List of response headers. This list must not be modified by the user. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con); /** @@ -1867,6 +2224,10 @@ EAPI const Eina_List * ecore_con_url_response_headers_get(Ecore_Con_Url *url_con * * This call can be used to easily setup a file where the downloaded data will * be saved. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); /** @@ -1881,6 +2242,10 @@ EAPI void ecore_con_url_fd_set(Ecore_Con_Url *url_con, int fd); * * @see ecore_con_url_get() * @see ecore_con_url_post() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con); /** @@ -1896,6 +2261,10 @@ EAPI int ecore_con_url_received_bytes_get(Ecore_Con_Url *url_con); * * @attention Require libcurl >= 7.19.1 to work, otherwise will always return * @c 0. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, const char *username, @@ -1920,6 +2289,10 @@ EAPI Eina_Bool ecore_con_url_httpauth_set(Ecore_Con_Url *url_con, * @see ecore_con_url_response_headers_get() * @see ecore_con_url_time() * @see ecore_con_url_post() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); /** @@ -1940,6 +2313,10 @@ EAPI Eina_Bool ecore_con_url_get(Ecore_Con_Url *url_con); * @see ecore_con_url_time() * @see ecore_con_url_post() * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con); /** @@ -1969,6 +2346,10 @@ EAPI Eina_Bool ecore_con_url_head(Ecore_Con_Url *url_con); * @see ecore_con_url_response_headers_get() * @see ecore_con_url_time() * @see ecore_con_url_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con, const void *data, long length, @@ -1987,6 +2368,10 @@ EAPI Eina_Bool ecore_con_url_post(Ecore_Con_Url *url_con, * * @sa ecore_con_url_get() * @sa ecore_con_url_post() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con, Ecore_Con_Url_Time time_condition, @@ -2004,6 +2389,10 @@ EAPI void ecore_con_url_time(Ecore_Con_Url *url_con, * * Upload @p filename to an ftp server set in @p url_con using @p user * and @p pass to directory @p upload_dir + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con, const char *filename, @@ -2019,6 +2408,10 @@ EAPI Eina_Bool ecore_con_url_ftp_upload(Ecore_Con_Url *url_con, * If @p verbose is @c EINA_TRUE, libcurl will output a lot of verbose * information about its operations, which is useful for * debugging. The verbose information will be sent to stderr. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con, Eina_Bool verbose); @@ -2026,6 +2419,10 @@ EAPI void ecore_con_url_verbose_set(Ecore_Con_Url *url_con, * @brief Enable or disable EPSV extension * @param url_con The Ecore_Con_Url instance which will be acted upon. * @param use_epsv Boolean to enable/disable the EPSV extension. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con, Eina_Bool use_epsv); @@ -2041,6 +2438,10 @@ EAPI void ecore_con_url_ftp_use_epsv_set(Ecore_Con_Url *url_con, * * @note Even though this function is called @c ecore_con_url_cookies_init(), * there is no symmetrical shutdown operation. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); /** @@ -2062,6 +2463,10 @@ EAPI void ecore_con_url_cookies_init(Ecore_Con_Url *url_con); * will not be loaded. * * @see ecore_con_url_cookies_file_add() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Url *url_con, Eina_Bool ignore); @@ -2086,6 +2491,10 @@ EAPI void ecore_con_url_cookies_ignore_old_session_set(Ecore_Con_Ur * * @see ecore_con_url_cookies_session_clear() * @see ecore_con_url_cookies_ignore_old_session_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); /** @@ -2115,6 +2524,10 @@ EAPI void ecore_con_url_cookies_clear(Ecore_Con_Url *url_con); * * @see ecore_con_url_cookies_clear() * @see ecore_con_url_cookies_ignore_old_session_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_con); /** @@ -2142,6 +2555,10 @@ EAPI void ecore_con_url_cookies_session_clear(Ecore_Con_Url *url_co * * @see ecore_con_url_cookies_ignore_old_session_set() * @see ecore_con_url_cookies_jar_file_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, const char * const file_name); @@ -2165,6 +2582,10 @@ EAPI void ecore_con_url_cookies_file_add(Ecore_Con_Url *url_con, * initialized yet. * * @see ecore_con_url_cookies_jar_write() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con, const char * const cookiejar_file); @@ -2180,6 +2601,10 @@ EAPI Eina_Bool ecore_con_url_cookies_jar_file_set(Ecore_Con_Url *url_con * initialized yet. * * @see ecore_con_url_cookies_jar_file_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_cookies_jar_write(Ecore_Con_Url *url_con); @@ -2204,6 +2629,10 @@ EAPI int ecore_con_url_ssl_ca_set(Ecore_Con_Url *url_con, * * @return @c EINA_TRUE on success, @c EINA_FALSE on error. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy); @@ -2220,6 +2649,10 @@ EAPI Eina_Bool ecore_con_url_proxy_set(Ecore_Con_Url *url_con, const char *proxy * @see ecore_con_url_proxy_set() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const char *username); @@ -2236,6 +2669,10 @@ EAPI Eina_Bool ecore_con_url_proxy_username_set(Ecore_Con_Url *url_con, const ch * @see ecore_con_url_proxy_set() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const char *password); @@ -2253,6 +2690,10 @@ EAPI Eina_Bool ecore_con_url_proxy_password_set(Ecore_Con_Url *url_con, const ch * @see ecore_con_url_cookies_jar_file_set() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); @@ -2264,6 +2705,10 @@ EAPI void ecore_con_url_timeout_set(Ecore_Con_Url *url_con, double timeout); * @return A valid HTTP STATUS code, or 0 on failure * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_con_url_status_code_get(Ecore_Con_Url *url_con); /** diff --git a/src/lib/ecore_con/Ecore_Con_Eet.h b/src/lib/ecore_con/Ecore_Con_Eet.h index 4f1b7df..efac538 100644 --- a/src/lib/ecore_con/Ecore_Con_Eet.h +++ b/src/lib/ecore_con/Ecore_Con_Eet.h @@ -88,6 +88,10 @@ typedef Eina_Bool (*Ecore_Con_Eet_Server_Cb)(void *data, Ecore_Con_Reply *reply, * deleted. * * @return A new Ecore_Con_Eet server. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server); @@ -102,6 +106,10 @@ EAPI Ecore_Con_Eet *ecore_con_eet_server_new(Ecore_Con_Server *server); * deleted. * * @return A new Ecore_Con_Eet client. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server); @@ -112,6 +120,9 @@ EAPI Ecore_Con_Eet *ecore_con_eet_client_new(Ecore_Con_Server *server); * allocated by a @ref ecore_con_eet_server_new or @ref * ecore_con_eet_client_new. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece); @@ -123,6 +134,9 @@ EAPI void ecore_con_eet_server_free(Ecore_Con_Eet *ece); * @param edd A Eet data descriptor that describes the data organization * in the Eet stream. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_Descriptor *edd); @@ -135,6 +149,9 @@ EAPI void ecore_con_eet_register(Ecore_Con_Eet *ece, const char *name, Eet_Data_ * @param func The function to call as a callback. * @param data The data to pass to the callback. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Data_Cb func, const void *data); @@ -144,6 +161,9 @@ EAPI void ecore_con_eet_data_callback_add(Ecore_Con_Eet *ece, const char *name, * @param ece An Ecore_Con_Eet object. * @param name The name of the Eet stream to remove callback on. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name); @@ -156,6 +176,9 @@ EAPI void ecore_con_eet_data_callback_del(Ecore_Con_Eet *ece, const char *name); * @param func The function to call as a callback. * @param data The data to pass to the callback. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *name, Ecore_Con_Eet_Raw_Data_Cb func, const void *data); @@ -165,6 +188,9 @@ EAPI void ecore_con_eet_raw_data_callback_add(Ecore_Con_Eet *ece, const char *na * @param ece An Ecore_Con_Eet object. * @param name The name of the raw Eet stream to remove callback on. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *name); @@ -177,6 +203,10 @@ EAPI void ecore_con_eet_raw_data_callback_del(Ecore_Con_Eet *ece, const char *na * @param ece An Ecore_Con_Eet object. * @param func The function to call as a callback. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); @@ -186,6 +216,10 @@ EAPI void ecore_con_eet_client_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co * @param ece An Ecore_Con_Eet object. * @param func The callback to remove. * @param data The data passed to this function at the callback registration. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); @@ -198,6 +232,10 @@ EAPI void ecore_con_eet_client_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co * @param ece An Ecore_Con_Eet object. * @param func The function to call as a callback. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); @@ -207,6 +245,10 @@ EAPI void ecore_con_eet_client_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore * @param ece An Ecore_Con_Eet object. * @param func The callback to remove. * @param data The data passed to this function at the callback registration. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Client_Cb func, const void *data); @@ -219,6 +261,10 @@ EAPI void ecore_con_eet_client_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore * @param ece An Ecore_Con_Eet object. * @param func The function to call as a callback. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); @@ -228,6 +274,10 @@ EAPI void ecore_con_eet_server_connect_callback_add(Ecore_Con_Eet *ece, Ecore_Co * @param ece An Ecore_Con_Eet object. * @param func The callback to remove. * @param data The data passed to this function at the callback registration. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); @@ -240,6 +290,10 @@ EAPI void ecore_con_eet_server_connect_callback_del(Ecore_Con_Eet *ece, Ecore_Co * @param ece An Ecore_Con_Eet object. * @param func The function to call as a callback. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); @@ -249,6 +303,10 @@ EAPI void ecore_con_eet_server_disconnect_callback_add(Ecore_Con_Eet *ece, Ecore * @param ece An Ecore_Con_Eet object. * @param func The callback to remove. * @param data The data passed to this function at the callback registration. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore_Con_Eet_Server_Cb func, const void *data); @@ -257,6 +315,10 @@ EAPI void ecore_con_eet_server_disconnect_callback_del(Ecore_Con_Eet *ece, Ecore * * @param ece An Ecore_Con_Eet object. * @param data The data to attach to the Ecore_Con_Eet object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data); @@ -265,6 +327,10 @@ EAPI void ecore_con_eet_data_set(Ecore_Con_Eet *ece, const void *data); * * @param ece An Ecore_Con_Eet object. * @return The data attached to the Ecore_Con_Eet object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece); @@ -273,6 +339,10 @@ EAPI const void *ecore_con_eet_data_get(Ecore_Con_Eet *ece); * * @param reply An Ecore_Con_Reply object. * @return The corresponding Ecore_Con_Eet object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply); @@ -282,6 +352,10 @@ EAPI Ecore_Con_Eet *ecore_con_eet_reply(Ecore_Con_Reply *reply); * @param reply An Ecore_Con_Reply object. * @param protocol_name The protocol type to use. * @param value The data to send. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, void *value); @@ -293,6 +367,10 @@ EAPI void ecore_con_eet_send(Ecore_Con_Reply *reply, const char *protocol_name, * @param section The section to add to the protocol. * @param value The data to send. * @param length The data length. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_con_eet_raw_send(Ecore_Con_Reply *reply, const char *protocol_name, const char *section, void *value, unsigned int length); diff --git a/src/lib/ecore_con/Ecore_Con_Legacy.h b/src/lib/ecore_con/Ecore_Con_Legacy.h index 44de302..9ecb36c 100644 --- a/src/lib/ecore_con/Ecore_Con_Legacy.h +++ b/src/lib/ecore_con/Ecore_Con_Legacy.h @@ -21,11 +21,19 @@ typedef Eo Ecore_Con_Url; /** * * Controls the URL to send the request to. * @param[in] url The URL + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_con_url_url_set(Ecore_Con_Url *obj, const char *url); /** * * Controls the URL to send the request to. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_con_url_url_get(const Ecore_Con_Url *obj); diff --git a/src/lib/ecore_con/ecore_con_base.eo b/src/lib/ecore_con/ecore_con_base.eo index 01d1535..7d4597d 100644 --- a/src/lib/ecore_con/ecore_con_base.eo +++ b/src/lib/ecore_con/ecore_con_base.eo @@ -133,6 +133,10 @@ abstract Ecore.Con.Base (Eo.Base) { address, addr - a pointer to the socket address, addrlen - the length of the socket address, in bytes, data - the data pointer given as parameter. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { name: const(char)* @nonull; [[IP address or server name to translate.]] diff --git a/src/lib/ecore_con/ecore_con_client.eo b/src/lib/ecore_con/ecore_con_client.eo index db6859c..ed33a6b 100644 --- a/src/lib/ecore_con/ecore_con_client.eo +++ b/src/lib/ecore_con/ecore_con_client.eo @@ -5,6 +5,11 @@ class Ecore.Con.Client (Ecore.Con.Base) { [[Controls the server representing the socket the client has connected to.]] get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { svr: Ecore.Con.Server *; [[The server the client is connected to.]] diff --git a/src/lib/ecore_con/ecore_con_eet_base.eo b/src/lib/ecore_con/ecore_con_eet_base.eo index e0e53f6..c88efc8 100644 --- a/src/lib/ecore_con/ecore_con_eet_base.eo +++ b/src/lib/ecore_con/ecore_con_eet_base.eo @@ -50,7 +50,12 @@ class Ecore.Con.Eet.Base (Eo.Base) { } register { [[Function to register a \@ref Eet_Data_Descriptor to the - ecore_con_eet object.]] + ecore_con_eet object. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] legacy: ecore_con_eet; params { name: const (char) *; [[The name of the eet stream.]] diff --git a/src/lib/ecore_con/ecore_con_server.eo b/src/lib/ecore_con/ecore_con_server.eo index b1f975c..b0ad5d2 100644 --- a/src/lib/ecore_con/ecore_con_server.eo +++ b/src/lib/ecore_con/ecore_con_server.eo @@ -10,6 +10,11 @@ class Ecore.Con.Server (Ecore.Con.Base) { legacy: null; } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { name: const(char) *; [[The name of the server.]] @@ -26,6 +31,11 @@ class Ecore.Con.Server (Ecore.Con.Base) { Only clients subsequently trying to connect will be affected. ]] set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { legacy: null; @@ -54,6 +64,11 @@ class Ecore.Con.Server (Ecore.Con.Base) { when the server is deleted/freed. ]] get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { // FIXME: Ecore.Con.Client is needed, but that introduces a cycle diff --git a/src/lib/ecore_drm/Ecore_Drm.h b/src/lib/ecore_drm/Ecore_Drm.h index a75db8e..6c413a4 100644 --- a/src/lib/ecore_drm/Ecore_Drm.h +++ b/src/lib/ecore_drm/Ecore_Drm.h @@ -226,6 +226,8 @@ EAPI extern int ECORE_DRM_EVENT_OUTPUT; /**< @since 1.14 */ EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */ /** + * @internal + * * @file * @brief Ecore functions for dealing with drm, virtual terminals * @@ -248,6 +250,8 @@ EAPI int ecore_drm_init(void); EAPI int ecore_drm_shutdown(void); /** + * @internal + * * Find a drm device in the system. * * @param name The name of the device to find. If NULL, this function will @@ -262,6 +266,8 @@ EAPI int ecore_drm_shutdown(void); EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat); /** + * @internal + * * Free an Ecore_Drm_Device * * This function will cleanup and free any previously allocated Ecore_Drm_Device. @@ -273,6 +279,8 @@ EAPI Ecore_Drm_Device *ecore_drm_device_find(const char *name, const char *seat) EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev); /** + * @internal + * * Open an Ecore_Drm_Device * * This function will open an existing Ecore_Drm_Device for use. @@ -286,6 +294,8 @@ EAPI void ecore_drm_device_free(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev); /** + * @internal + * * Close an Ecore_Drm_Device * * This function will close a previously opened Ecore_Drm_Device @@ -299,6 +309,8 @@ EAPI Eina_Bool ecore_drm_device_open(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev); /** + * @internal + * * Get if a given Ecore_Drm_Device is master * * This function will check if the given drm device is set to master @@ -312,6 +324,8 @@ EAPI Eina_Bool ecore_drm_device_close(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev); /** + * @internal + * * Set a given Ecore_Drm_Device to master * * This function will attempt to set a given drm device to be master @@ -325,6 +339,8 @@ EAPI Eina_Bool ecore_drm_device_master_get(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev); /** + * @internal + * * Tell a given Ecore_Drm_Device to stop being master * * This function will attempt to ask a drm device to stop being master @@ -338,6 +354,8 @@ EAPI Eina_Bool ecore_drm_device_master_set(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev); /** + * @internal + * * Get the file descriptor of Ecore_Drm_Device * * This function will get the file descriptor of drm device @@ -352,6 +370,8 @@ EAPI Eina_Bool ecore_drm_device_master_drop(Ecore_Drm_Device *dev); EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev); /** + * @internal + * * Set the window of Ecore_Drm_Device * * This function will set the window for given drm device @@ -366,6 +386,8 @@ EAPI int ecore_drm_device_fd_get(Ecore_Drm_Device *dev); EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window); /** + * @internal + * * Get the name of the Ecore_Drm_Device * * This function will return the name of Ecore_Drm_Device @@ -381,6 +403,8 @@ EAPI void ecore_drm_device_window_set(Ecore_Drm_Device *dev, unsigned int window EAPI const char *ecore_drm_device_name_get(Ecore_Drm_Device *dev); /** + * @internal + * * Setup an Ecore_Drm_Device for software rendering * * This function will setup an Ecore_Drm_Device for software rendering @@ -437,6 +461,8 @@ EAPI void ecore_drm_device_keyboard_cached_context_set(struct xkb_context *ctx); EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map); /** + * @internal + * * Find an Ecore_Drm_Output at the given coordinates * * This function will loop all the existing outputs in Ecore_Drm_Device and @@ -454,6 +480,8 @@ EAPI void ecore_drm_device_keyboard_cached_keymap_set(struct xkb_keymap *map); EAPI Ecore_Drm_Output *ecore_drm_device_output_find(Ecore_Drm_Device *dev, int x, int y); /** + * @internal + * * Open a tty for use * * @param dev The Ecore_Drm_Device that this tty will belong to. @@ -467,6 +495,8 @@ EAPI Ecore_Drm_Output *ecore_drm_device_output_find(Ecore_Drm_Device *dev, int x EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name); /** + * @internal + * * Close an already opened tty * * @param dev The Ecore_Drm_Device which owns this tty. @@ -478,6 +508,8 @@ EAPI Eina_Bool ecore_drm_tty_open(Ecore_Drm_Device *dev, const char *name); EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev); /** + * @internal + * * Release a virtual terminal * * @param dev The Ecore_Drm_Device which owns this tty. @@ -489,6 +521,8 @@ EAPI Eina_Bool ecore_drm_tty_close(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev); /** + * @internal + * * Acquire a virtual terminal * * @param dev The Ecore_Drm_Device which owns this tty. @@ -500,6 +534,8 @@ EAPI Eina_Bool ecore_drm_tty_release(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev); /** + * @internal + * * Get the opened virtual terminal file descriptor * * @param dev The Ecore_Drm_Device which owns this tty. @@ -513,6 +549,8 @@ EAPI Eina_Bool ecore_drm_tty_acquire(Ecore_Drm_Device *dev); EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev); /** + * @internal + * * Create outputs for a drm device * * This function will create outputs for Ecore_Drm_Device @@ -527,6 +565,8 @@ EAPI int ecore_drm_tty_get(Ecore_Drm_Device *dev); EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev); /** + * @internal + * * Free an Ecore_Drm_Output * * This function will cleanup and free any previously allocated Ecore_Drm_Output @@ -538,6 +578,8 @@ EAPI Eina_Bool ecore_drm_outputs_create(Ecore_Drm_Device *dev); EAPI void ecore_drm_output_free(Ecore_Drm_Output *output); /** + * @internal + * * Set the cursor size for Ecore_Drm_Output * * This function will set the cursor size of Ecore_Drm_Output @@ -552,6 +594,8 @@ EAPI void ecore_drm_output_free(Ecore_Drm_Output *output); EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, int w, int h); /** + * @internal + * * Enable a Ecore_Drm_Output * * This function will enable an Ecore_Drm_Output @@ -564,6 +608,8 @@ EAPI void ecore_drm_output_cursor_size_set(Ecore_Drm_Output *output, int handle, EAPI Eina_Bool ecore_drm_output_enable(Ecore_Drm_Output *output); /** + * @internal + * * Disable a Ecore_Drm_Output * * This function will disable an Ecore_Drm_Output @@ -582,6 +628,8 @@ EAPI void ecore_drm_output_fb_release(Ecore_Drm_Output *output, Ecore_Drm_Fb *fb EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output); /** + * @internal + * * Get the output size of Ecore_Drm_Device * * This function will give the output size of Ecore_Drm_Device @@ -596,12 +644,16 @@ EAPI void ecore_drm_output_repaint(Ecore_Drm_Output *output); EAPI void ecore_drm_output_size_get(Ecore_Drm_Device *dev, int output, int *w, int *h); /** + * @internal + * * TODO: Doxy * @since 1.12 */ EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, int *w, int *h); /** + * @internal + * * Get the crtc id of an output * * This function will return the default crtc id for an output @@ -616,6 +668,8 @@ EAPI void ecore_drm_outputs_geometry_get(Ecore_Drm_Device *dev, int *x, int *y, EAPI unsigned int ecore_drm_output_crtc_id_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the crtc buffer of an output * * This function will return the default buffer id for an output @@ -630,6 +684,8 @@ EAPI unsigned int ecore_drm_output_crtc_id_get(Ecore_Drm_Output *output); EAPI unsigned int ecore_drm_output_crtc_buffer_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the connector id of an output * * This function will return the default connector id for an output @@ -660,6 +716,8 @@ EAPI Ecore_Drm_Fb *ecore_drm_fb_create(Ecore_Drm_Device *dev, int width, int hei EAPI void ecore_drm_fb_destroy(Ecore_Drm_Fb *fb); /** + * @internal + * * Mark an Ecore_Drm_Fb as dirty * * This function mark an Ecore_Drm_Fb as being dirty @@ -674,6 +732,8 @@ EAPI void ecore_drm_fb_destroy(Ecore_Drm_Fb *fb); EAPI void ecore_drm_fb_dirty(Ecore_Drm_Fb *fb, Eina_Rectangle *rects, unsigned int count); /** + * @internal + * * Set an Ecore_Drm_Fb as the current framebuffer * * This function will set the given Ecore_Drm_Fb as the framebuffer used @@ -688,6 +748,8 @@ EAPI void ecore_drm_fb_dirty(Ecore_Drm_Fb *fb, Eina_Rectangle *rects, unsigned i EAPI void ecore_drm_fb_set(Ecore_Drm_Device *dev, Ecore_Drm_Fb *fb); /** + * @internal + * * Send an Ecore_Drm_Fb to the Ecore_Drm_Device * * This function will call drmModePageFlip for the given device using the @@ -707,6 +769,8 @@ EAPI Eina_Bool ecore_drm_launcher_connect(Ecore_Drm_Device *dev); EAPI void ecore_drm_launcher_disconnect(Ecore_Drm_Device *dev); /** + * @internal + * * Get the output position of Ecore_Drm_Output * * This function will give the output position of Ecore_Drm_Output @@ -721,6 +785,8 @@ EAPI void ecore_drm_launcher_disconnect(Ecore_Drm_Device *dev); EAPI void ecore_drm_output_position_get(Ecore_Drm_Output *output, int *x, int *y); /** + * @internal + * * Get the current resolution of Ecore_Drm_Output * * This function will give the current resolution of Ecore_Drm_Output @@ -736,6 +802,8 @@ EAPI void ecore_drm_output_position_get(Ecore_Drm_Output *output, int *x, int *y EAPI void ecore_drm_output_current_resolution_get(Ecore_Drm_Output *output, int *w, int *h, unsigned int *refresh); /** + * @internal + * * Get the physical size of Ecore_Drm_Output * * This function will give the physical size (in mm) of Ecore_Drm_Output @@ -750,6 +818,8 @@ EAPI void ecore_drm_output_current_resolution_get(Ecore_Drm_Output *output, int EAPI void ecore_drm_output_physical_size_get(Ecore_Drm_Output *output, int *w, int *h); /** + * @internal + * * Get the subpixel order of Ecore_Drm_Output * * This function will give the subpixel order of Ecore_Drm_Output @@ -763,6 +833,8 @@ EAPI void ecore_drm_output_physical_size_get(Ecore_Drm_Output *output, int *w, i EAPI unsigned int ecore_drm_output_subpixel_order_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the model of Ecore_Drm_Output * * This function will give the model of Ecore_Drm_Output @@ -776,6 +848,8 @@ EAPI unsigned int ecore_drm_output_subpixel_order_get(Ecore_Drm_Output *output); EAPI Eina_Stringshare *ecore_drm_output_model_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the make of Ecore_Drm_Output * * This function will give the make of Ecore_Drm_Output @@ -789,6 +863,8 @@ EAPI Eina_Stringshare *ecore_drm_output_model_get(Ecore_Drm_Output *output); EAPI Eina_Stringshare *ecore_drm_output_make_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the name of Ecore_Drm_Output * * This function will give the name of Ecore_Drm_Output @@ -802,6 +878,8 @@ EAPI Eina_Stringshare *ecore_drm_output_make_get(Ecore_Drm_Output *output); EAPI char *ecore_drm_output_name_get(Ecore_Drm_Output *output); /** + * @internal + * * Set the dpms level of an Ecore_Drm_Output * * This function will set the DPMS level of an Ecore_Drm_Output @@ -815,6 +893,8 @@ EAPI char *ecore_drm_output_name_get(Ecore_Drm_Output *output); EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level); /** + * @internal + * * Set the gamma level of an Ecore_Drm_Output * * This function will set the gamma of an Ecore_Drm_Output @@ -831,6 +911,8 @@ EAPI void ecore_drm_output_dpms_set(Ecore_Drm_Output *output, int level); EAPI void ecore_drm_output_gamma_set(Ecore_Drm_Output *output, uint16_t size, uint16_t *r, uint16_t *g, uint16_t *b); /** + * @internal + * * Get the pointer position of Ecore_Drm_Device * * This function will give the pointer position of Ecore_Drm_Device @@ -859,6 +941,8 @@ EAPI void ecore_drm_device_pointer_xy_get(Ecore_Drm_Device *dev, int *x, int *y) EAPI void ecore_drm_device_pointer_warp(Ecore_Drm_Device *dev, int x, int y); /** + * @internal + * * Get the list of drm devices which are allocated. * * @return Eina_List of drm devices, NULL otherwise @@ -869,6 +953,8 @@ EAPI void ecore_drm_device_pointer_warp(Ecore_Drm_Device *dev, int x, int y); EAPI const Eina_List *ecore_drm_devices_get(void); /** + * @internal + * * Get the minimum and maximum screen size range * * @param dev The Ecore_Drm_Device to get screen size range from @@ -883,6 +969,8 @@ EAPI const Eina_List *ecore_drm_devices_get(void); EAPI void ecore_drm_screen_size_range_get(Ecore_Drm_Device *dev, int *minw, int *minh, int *maxw, int *maxh); /** + * @internal + * * Get if a given output is connected * * @param output The Ecore_Drm_Output to get the connected status of @@ -895,6 +983,8 @@ EAPI void ecore_drm_screen_size_range_get(Ecore_Drm_Device *dev, int *minw, int EAPI Eina_Bool ecore_drm_output_connected_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the connector type of a given Ecore_Drm_Output * * @param output The Ecore_Drm_Output to get the connector type of @@ -907,6 +997,8 @@ EAPI Eina_Bool ecore_drm_output_connected_get(Ecore_Drm_Output *output); EAPI unsigned int ecore_drm_output_connector_type_get(Ecore_Drm_Output *output); /** + * @internal + * * Get if a given output has a backlight * * @param output The Ecore_Drm_Output to get the backlight of @@ -919,6 +1011,8 @@ EAPI unsigned int ecore_drm_output_connector_type_get(Ecore_Drm_Output *output); EAPI Eina_Bool ecore_drm_output_backlight_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the edid of a given output * * @param output The Ecore_Drm_Output to get the backlight of @@ -931,6 +1025,8 @@ EAPI Eina_Bool ecore_drm_output_backlight_get(Ecore_Drm_Output *output); EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output); /** + * @internal + * * Get a list of the modes supported on a given output * * @param output The Ecore_Drm_Output to get the modes for @@ -945,6 +1041,8 @@ EAPI char *ecore_drm_output_edid_get(Ecore_Drm_Output *output); EAPI Eina_List *ecore_drm_output_modes_get(Ecore_Drm_Output *output); /** + * @internal + * * Get the output which is marked as primary * * @param dev The Ecore_Drm_Device to get the primary output from @@ -957,6 +1055,8 @@ EAPI Eina_List *ecore_drm_output_modes_get(Ecore_Drm_Output *output); EAPI Ecore_Drm_Output *ecore_drm_output_primary_get(Ecore_Drm_Device *dev); /** + * @internal + * * Set a given output as primary * * @param output The Ecore_Drm_Output to set as primary @@ -967,6 +1067,8 @@ EAPI Ecore_Drm_Output *ecore_drm_output_primary_get(Ecore_Drm_Device *dev); EAPI void ecore_drm_output_primary_set(Ecore_Drm_Output *output); /** + * @internal + * * Get the size of the crtc for a given output * * @param output The Ecore_Drm_Output to get the crtc size of @@ -979,6 +1081,8 @@ EAPI void ecore_drm_output_primary_set(Ecore_Drm_Output *output); EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, int *height); /** + * @internal + * * Find an Ecore_Drm_Output which has the given name * * This function will loop all the existing outputs in Ecore_Drm_Device and @@ -995,6 +1099,8 @@ EAPI void ecore_drm_output_crtc_size_get(Ecore_Drm_Output *output, int *width, i EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, const char *name); /** + * @internal + * * Get if an Ecore_Drm_Output can be used on a given crtc * * This function will loop the possible crtcs of an encoder to determine if @@ -1011,6 +1117,8 @@ EAPI Ecore_Drm_Output *ecore_drm_device_output_name_find(Ecore_Drm_Device *dev, EAPI Eina_Bool ecore_drm_output_possible_crtc_get(Ecore_Drm_Output *output, unsigned int crtc); /** + * @internal + * * Set a given mode to be used on an Ecore_Drm_Output * * This function will set the given mode to be used on a given Ecore_Drm_Output diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h index 92ea827..f14fcaa 100755 --- a/src/lib/ecore_evas/Ecore_Evas.h +++ b/src/lib/ecore_evas/Ecore_Evas.h @@ -181,6 +181,10 @@ EAPI int ecore_evas_engine_type_supported_get(Ecore_Evas_Engine_Type eng * Set up the Evas wrapper system. Init Evas and Ecore libraries. * * @see ecore_evas_shutdown() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_init(void); /** @@ -191,6 +195,10 @@ EAPI int ecore_evas_init(void); * This closes the Evas wrapper system down. Shut down Evas and Ecore libraries. * * @see ecore_evas_init() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_shutdown(void); @@ -198,6 +206,8 @@ EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync); EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); /** + * @internal + * * @brief Return a list of supported engines names. * * @return Newly allocated list with engines names. Engines names @@ -206,12 +216,16 @@ EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); */ EAPI Eina_List *ecore_evas_engines_get(void); /** + * @internal + * * @brief Free list returned by ecore_evas_engines_get() * * @param engines list with engines names */ EAPI void ecore_evas_engines_free(Eina_List *engines); /** + * @internal + * * @brief Create a new Ecore_Evas based on engine name and common parameters. * * @param engine_name engine name as returned by @@ -246,6 +260,10 @@ EAPI Ecore_Evas *ecore_evas_new(const char *engine_name, int x, int y, int w, in * it's transparent). * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); /** @@ -258,6 +276,10 @@ EAPI void ecore_evas_alpha_set(Ecore_Evas *ee, Eina_Bool alpha); * @c EINA_FALSE if it does not. * * @see ecore_evas_alpha_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); /** @@ -273,6 +295,10 @@ EAPI Eina_Bool ecore_evas_alpha_get(const Ecore_Evas *ee); * @warning Support for this depends on the underlying windowing system. * * @see ecore_evas_alpha_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparent); /** @@ -282,6 +308,10 @@ EAPI void ecore_evas_transparent_set(Ecore_Evas *ee, Eina_Bool transparen * @return @c EINA_TRUE if ee is transparent, @c EINA_FALSE if it isn't. * * @see ecore_evas_transparent_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); /** @@ -306,6 +336,10 @@ EAPI Eina_Bool ecore_evas_transparent_get(const Ecore_Evas *ee); * @see ecore_evas_resize() * @see ecore_evas_move() * @see ecore_evas_move_resize() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); /** @@ -331,6 +365,10 @@ EAPI void ecore_evas_geometry_get(const Ecore_Evas *ee, int *x, int *y, i * @endcode * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); /** @@ -343,6 +381,10 @@ EAPI void ecore_evas_request_geometry_get(const Ecore_Evas *ee, int *x, i * @p on is @c EINA_FALSE. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); /** @@ -352,6 +394,10 @@ EAPI void ecore_evas_focus_set(Ecore_Evas *ee, Eina_Bool on); * @return @c EINA_TRUE if @p ee if focused, @c EINA_FALSE if not. * * @see ecore_evas_focus_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee); /** @@ -366,6 +412,10 @@ EAPI Eina_Bool ecore_evas_focus_get(const Ecore_Evas *ee); * @note Iconify and minimize are synonyms. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); /** @@ -377,6 +427,10 @@ EAPI void ecore_evas_iconified_set(Ecore_Evas *ee, Eina_Bool on); * @note Iconify and minimize are synonyms. * * @see ecore_evas_iconified_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); /** @@ -389,6 +443,10 @@ EAPI Eina_Bool ecore_evas_iconified_get(const Ecore_Evas *ee); * if @p on is @c EINA_FALSE. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); /** @@ -398,6 +456,10 @@ EAPI void ecore_evas_borderless_set(Ecore_Evas *ee, Eina_Bool on); * @return @c EINA_TRUE if @p ee is borderless, @c EINA_FALSE if not. * * @see ecore_evas_borderless_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); /** @@ -410,6 +472,10 @@ EAPI Eina_Bool ecore_evas_borderless_get(const Ecore_Evas *ee); * not if @p on is @c EINA_FALSE. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); /** @@ -419,6 +485,10 @@ EAPI void ecore_evas_fullscreen_set(Ecore_Evas *ee, Eina_Bool on); * @return @c EINA_TRUE if @p ee is fullscreen, @c EINA_FALSE if not. * * @see ecore_evas_fullscreen_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); /** @@ -434,6 +504,10 @@ EAPI Eina_Bool ecore_evas_fullscreen_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *ee_group); /** @@ -446,6 +520,10 @@ EAPI void ecore_evas_window_group_set(Ecore_Evas *ee, const Ecore_Evas *e * * @see ecore_evas_window_group_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); /** @@ -458,6 +536,10 @@ EAPI const Ecore_Evas *ecore_evas_window_group_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); /** @@ -470,6 +552,10 @@ EAPI void ecore_evas_aspect_set(Ecore_Evas *ee, double aspect); * * @see ecore_evas_aspect_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); /** @@ -483,6 +569,10 @@ EAPI double ecore_evas_aspect_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); /** @@ -495,6 +585,10 @@ EAPI void ecore_evas_urgent_set(Ecore_Evas *ee, Eina_Bool urgent); * * @see ecore_evas_urgent_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); /** @@ -509,6 +603,10 @@ EAPI Eina_Bool ecore_evas_urgent_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); /** @@ -521,6 +619,10 @@ EAPI void ecore_evas_modal_set(Ecore_Evas *ee, Eina_Bool modal); * * @see ecore_evas_modal_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); /** @@ -534,6 +636,10 @@ EAPI Eina_Bool ecore_evas_modal_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool demand); /** @@ -546,6 +652,10 @@ EAPI void ecore_evas_demand_attention_set(Ecore_Evas *ee, Eina_Bool deman * * @see ecore_evas_demand_attention_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); /** @@ -561,6 +671,10 @@ EAPI Eina_Bool ecore_evas_demand_attention_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip); /** @@ -573,6 +687,10 @@ EAPI void ecore_evas_focus_skip_set(Ecore_Evas *ee, Eina_Bool skip); * * @see ecore_evas_focus_skip_set() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee); @@ -583,6 +701,10 @@ EAPI Eina_Bool ecore_evas_focus_skip_get(const Ecore_Evas *ee); * @param ignore The Ecore_Evas new ignore state. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); /** @@ -592,6 +714,10 @@ EAPI void ecore_evas_ignore_events_set(Ecore_Evas *ee, Eina_Bool ignore); * @return The Ecore_Evas window's ignore state. * * @see ecore_evas_ignore_events_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); /** @@ -604,6 +730,10 @@ EAPI Eina_Bool ecore_evas_ignore_events_get(const Ecore_Evas *ee); * * @see ecore_evas_show() * @see ecore_evas_hide() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); /** @@ -618,6 +748,10 @@ EAPI int ecore_evas_visibility_get(const Ecore_Evas *ee); * * @see ecore_evas_lower() * @see ecore_evas_raise() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); /** @@ -629,6 +763,10 @@ EAPI void ecore_evas_layer_set(Ecore_Evas *ee, int layer); * @see ecore_evas_layer_set() * @see ecore_evas_lower() * @see ecore_evas_raise() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); /** @@ -641,6 +779,10 @@ EAPI int ecore_evas_layer_get(const Ecore_Evas *ee); * if @p on is @c EINA_FALSE. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); /** @@ -650,6 +792,10 @@ EAPI void ecore_evas_maximized_set(Ecore_Evas *ee, Eina_Bool on); * @return @c EINA_TRUE if @p ee is maximized, @c EINA_FALSE if not. * * @see ecore_evas_maximized_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); /** @@ -660,6 +806,10 @@ EAPI Eina_Bool ecore_evas_maximized_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); /** @@ -670,6 +820,10 @@ EAPI Eina_Bool ecore_evas_window_profile_supported_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profile); /** @@ -680,6 +834,10 @@ EAPI void ecore_evas_window_profile_set(Ecore_Evas *ee, const char *profi * * @warning Support for this depends on the underlying windowing system. * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); /** @@ -691,6 +849,10 @@ EAPI const char *ecore_evas_window_profile_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const char **profiles, const unsigned int count); /** @@ -703,6 +865,10 @@ EAPI void ecore_evas_window_available_profiles_set(Ecore_Evas *ee, const * * @warning Support for this depends on the underlying windowing system. * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char ***profiles, unsigned int *count); /** @@ -713,6 +879,10 @@ EAPI Eina_Bool ecore_evas_window_available_profiles_get(Ecore_Evas *ee, char * * * @warning Support for this depends on the underlying windowing system. * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); /** @@ -723,6 +893,10 @@ EAPI Eina_Bool ecore_evas_wm_rotation_supported_get(const Ecore_Evas *ee); * * @warning Support for this depends on the underlying windowing system. * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, int rotation); /** @@ -733,6 +907,10 @@ EAPI void ecore_evas_wm_rotation_preferred_rotation_set(Ecore_Evas *ee, i * * @warning Support for this depends on the underlying windowing system. * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas *ee); /** @@ -744,6 +922,10 @@ EAPI int ecore_evas_wm_rotation_preferred_rotation_get(const Ecore_Evas * * @warning Support for this depends on the underlying windowing system. * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, const int *rotations, unsigned int count); /** @@ -756,6 +938,10 @@ EAPI void ecore_evas_wm_rotation_available_rotations_set(Ecore_Evas *ee, * * @warning Support for this depends on the underlying windowing system. * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas *ee, int **rotations, unsigned int *count); /** @@ -767,6 +953,10 @@ EAPI Eina_Bool ecore_evas_wm_rotation_available_rotations_get(const Ecore_Evas * If false, the manual rotation mode is disabled. * * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, Eina_Bool set); /** @@ -776,6 +966,10 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done_set(Ecore_Evas *ee, * @return If true, the manual rotation done mode is enabled * * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Evas *ee); /** @@ -784,6 +978,10 @@ EAPI Eina_Bool ecore_evas_wm_rotation_manual_rotation_done_get(const Ecore_Eva * @param ee The Ecore_Evas * * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); /** @@ -806,6 +1004,10 @@ EAPI void ecore_evas_wm_rotation_manual_rotation_done(Ecore_Evas *ee); * ID:HINT:VALUE,ID:HINT:VALUE,... * * @since 1.10.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); /** @@ -818,6 +1020,10 @@ EAPI const Eina_List *ecore_evas_aux_hints_supported_get(const Ecore_Evas *ee); * @warning Support for this depends on the underlying windowing system. * * @since 1.10.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); /** @@ -830,6 +1036,10 @@ EAPI Eina_List *ecore_evas_aux_hints_allowed_get(const Ecore_Evas *ee); * @warning Support for this depends on the underlying windowing system. * * @since 1.10.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, const char *val); /** @@ -841,6 +1051,10 @@ EAPI int ecore_evas_aux_hint_add(Ecore_Evas *ee, const char *hint, * @warning Support for this depends on the underlying windowing system. * * @since 1.10.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); /** @@ -853,6 +1067,10 @@ EAPI Eina_Bool ecore_evas_aux_hint_del(Ecore_Evas *ee, const int id); * @warning Support for this depends on the underlying windowing system. * * @since 1.10.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, const char *val); /** @@ -864,6 +1082,10 @@ EAPI Eina_Bool ecore_evas_aux_hint_val_set(Ecore_Evas *ee, const int id, * @warning Support for this depends on the underlying windowing system. * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id); /** @@ -875,6 +1097,10 @@ EAPI const char *ecore_evas_aux_hint_val_get(const Ecore_Evas *ee, int id); * @warning Support for this depends on the underlying windowing system. * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_aux_hint_id_get(const Ecore_Evas *ee, const char *hint); /** @@ -937,6 +1163,10 @@ EAPI Eina_Bool ecore_evas_obscured_get(const Ecore_Evas *ee); * This is a list of examples of these functions: * @li @ref ecore_evas_extn_socket_example * @li @ref ecore_evas_extn_plug_example + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); /** @@ -954,6 +1184,10 @@ EAPI void ecore_evas_msg_parent_send(Ecore_Evas *ee, int msg_domain, int msg_id, * @see ecore_evas_msg_parent_send() * @see ecore_evas_callback_msg_parent_handle_set() * @see eecore_evas_callback_msg_handle_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size); /** @@ -968,6 +1202,10 @@ EAPI void ecore_evas_msg_send(Ecore_Evas *ee, int msg_domain, int msg_id, void * * @see ecore_evas_msg_parent_send() * @see ecore_evas_msg_send() * @see eecore_evas_callback_msg_handle_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_parent_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)); /** @@ -982,6 +1220,10 @@ EAPI void ecore_evas_callback_msg_parent_handle_set(Ecore_Evas *ee, void (*func_ * @see ecore_evas_msg_parent_send() * @see ecore_evas_msg_send() * @see ecore_evas_callback_msg_parent_handle_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle)(Ecore_Evas *ee, int msg_domain, int msg_id, void *data, int size)); @@ -999,6 +1241,10 @@ EAPI void ecore_evas_callback_msg_handle_set(Ecore_Evas *ee, void (*func_handle) * @see ecore_evas_new() * @see ecore_evas_resize() * @see ecore_evas_move_resize() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); /** @@ -1015,6 +1261,10 @@ EAPI void ecore_evas_move(Ecore_Evas *ee, int x, int y); * @see ecore_evas_new() * @see ecore_evas_move() * @see ecore_evas_move_resize() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); /** @@ -1034,6 +1284,10 @@ EAPI void ecore_evas_resize(Ecore_Evas *ee, int w, int h); * @see ecore_evas_new() * @see ecore_evas_move() * @see ecore_evas_resize() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int h); /** @@ -1048,6 +1302,10 @@ EAPI void ecore_evas_move_resize(Ecore_Evas *ee, int x, int y, int w, int * @warning Support for this depends on the underlying windowing system. * * @see ecore_evas_rotation_with_resize_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); /** @@ -1062,6 +1320,10 @@ EAPI void ecore_evas_rotation_set(Ecore_Evas *ee, int rot); * @warning Support for this depends on the underlying windowing system. * * @see ecore_evas_rotation_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); /** @@ -1072,6 +1334,10 @@ EAPI void ecore_evas_rotation_with_resize_set(Ecore_Evas *ee, int rot); * * @see ecore_evas_rotation_set() * @see ecore_evas_rotation_with_resize_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); /** @@ -1085,6 +1351,10 @@ EAPI int ecore_evas_rotation_get(const Ecore_Evas *ee); * * @see ecore_evas_lower() * @see ecore_evas_layer_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_raise(Ecore_Evas *ee); /** @@ -1098,6 +1368,10 @@ EAPI void ecore_evas_raise(Ecore_Evas *ee); * * @see ecore_evas_raise() * @see ecore_evas_layer_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_lower(Ecore_Evas *ee); /** @@ -1109,6 +1383,10 @@ EAPI void ecore_evas_lower(Ecore_Evas *ee); * This function sets the title of @p ee to @p t. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); /** @@ -1120,6 +1398,10 @@ EAPI void ecore_evas_title_set(Ecore_Evas *ee, const char *t); * This function returns the title of @p ee. * * @see ecore_evas_title_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); /** @@ -1133,6 +1415,10 @@ EAPI const char *ecore_evas_title_get(const Ecore_Evas *ee); * meaning of @p name and @p class depends on the underlying windowing system. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const char *c); /** @@ -1145,6 +1431,10 @@ EAPI void ecore_evas_name_class_set(Ecore_Evas *ee, const char *n, const * @param n A pointer to a string to place the name in. * @param c A pointer to a string to place the class in. * @see ecore_evas_name_class_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, const char **c); /** @@ -1154,12 +1444,18 @@ EAPI void ecore_evas_name_class_get(const Ecore_Evas *ee, const char **n, * @return A pointer to the underlying window. * * @warning Support for this depends on the underlying windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); /* engine/target specific init calls */ /** + * @internal + * * @brief Create Ecore_Evas using software x11. * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned. * @param disp_name The name of the Ecore_Evas to be created. @@ -1173,6 +1469,8 @@ EAPI Ecore_Window ecore_evas_window_get(const Ecore_Evas *ee); EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Get the window from Ecore_Evas using software x11. * @note If ecore is not compiled with support for x11 or if @p ee was not * created with ecore_evas_software_x11_new() then nothing is done and @@ -1183,6 +1481,8 @@ EAPI Ecore_Evas *ecore_evas_software_x11_new(const char *disp_name, Ecore_X_ EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Set the direct_resize of Ecore_Evas using software x11. * @note If ecore is not compiled with support to x11 then nothing is done. * @param ee The Ecore_Evas in which to set direct resize. @@ -1191,6 +1491,8 @@ EAPI Ecore_X_Window ecore_evas_software_x11_window_get(const Ecore_Evas *ee); EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); /** + * @internal + * * @brief Get if the Ecore_Evas is being directly resized using software x11. * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned. * @param ee The Ecore_Evas from which to get direct resize. @@ -1199,6 +1501,8 @@ EAPI void ecore_evas_software_x11_direct_resize_set(Ecore_Evas *ee, E EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Add extra window on Ecore_Evas using software x11. * @note If ecore is not compiled with support to x11 then nothing is done. * @param ee The Ecore_Evas on which to add the window. @@ -1207,6 +1511,8 @@ EAPI Eina_Bool ecore_evas_software_x11_direct_resize_get(const Ecore_Evas EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); /** + * @internal + * * @brief Create a new Ecore_Evas which does not contain an XWindow. It will * only contain an XPixmap to render to * @@ -1219,6 +1525,8 @@ EAPI void ecore_evas_software_x11_extra_event_window_add(Ecore_Evas * EAPI Ecore_Evas *ecore_evas_software_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas * * @param ee The Ecore_Evas whose pixmap is desired. @@ -1250,6 +1558,8 @@ EAPI Ecore_X_Pixmap ecore_evas_software_x11_pixmap_get(const Ecore_Evas *ee); #define ECORE_EVAS_GL_X11_SWAP_MODE_TRIPLE ECORE_EVAS_SWAP_MODE_TRIPLE /** + * @internal + * * @brief Create Ecore_Evas using opengl x11. * @note If ecore is not compiled with support to x11 then nothing is done and NULL is returned. * @param disp_name The name of the display of the Ecore_Evas to be created. @@ -1264,6 +1574,8 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_new(const char *disp_name, Ecore_X_Window EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h, const int *opt); /** + * @internal + * * @brief Get the window from Ecore_Evas using opengl x11. * @note If ecore is not compiled with support for x11 or if @p ee was not * created with ecore_evas_gl_x11_new() then nothing is done and @@ -1274,6 +1586,8 @@ EAPI Ecore_Evas *ecore_evas_gl_x11_options_new(const char *disp_name, Ecore_ EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Set direct_resize for Ecore_Evas using opengl x11. * @note If ecore is not compiled with support to x11 then nothing is done. * @param ee The Ecore_Evas in which to set direct resize. @@ -1282,6 +1596,8 @@ EAPI Ecore_X_Window ecore_evas_gl_x11_window_get(const Ecore_Evas *ee); EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bool on); /** + * @internal + * * @brief Get if the Ecore_Evas is being directly resized using opengl x11. * @note If ecore is not compiled with support to x11 then nothing is done and EINA_FALSE is returned. * @param ee The Ecore_Evas from which to get direct resize. @@ -1290,6 +1606,8 @@ EAPI void ecore_evas_gl_x11_direct_resize_set(Ecore_Evas *ee, Eina_Bo EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Add extra window on Ecore_Evas using opengl x11. * @note If ecore is not compiled with support to x11 then nothing is done. * @param ee The Ecore_Evas for which to add the window. @@ -1298,6 +1616,8 @@ EAPI Eina_Bool ecore_evas_gl_x11_direct_resize_get(const Ecore_Evas *ee); EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win); /** + * @internal + * * @brief Set the functions to be used before and after the swap callback. * @note If ecore is not compiled with support to x11 then nothing is done and the function is returned. * @param ee The Ecore_Evas for which to set the swap callback. @@ -1308,6 +1628,8 @@ EAPI void ecore_evas_gl_x11_extra_event_window_add(Ecore_Evas *ee, Ec EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Evas *ee, void *data, void (*pre_cb) (void *data, Evas *e), void (*post_cb) (void *data, Evas *e)); /** + * @internal + * * @brief Create a new Ecore_Evas which does not contain an XWindow. It will * only contain an XPixmap to render to * @@ -1320,6 +1642,8 @@ EAPI void ecore_evas_gl_x11_pre_post_swap_callback_set(const Ecore_Ev EAPI Ecore_Evas *ecore_evas_gl_x11_pixmap_new(const char *disp_name, Ecore_X_Window parent, int x, int y, int w, int h); /** + * @internal + * * @brief Return the underlying Ecore_X_Pixmap used in the Ecore_Evas * * @param ee The Ecore_Evas whose pixmap is desired. @@ -1355,6 +1679,8 @@ EAPI Eina_Bool ecore_evas_software_x11_16_direct_resize_get(const Ecore_Ev EAPI void ecore_evas_software_x11_16_extra_event_window_add(Ecore_Evas *ee, Ecore_X_Window win) EINA_DEPRECATED; /** + * @internal + * * @brief Create Ecore_Evas using fb backend. * @param disp_name The name of the display to be used. * @param rotation The rotation to be used. @@ -1410,6 +1736,10 @@ EAPI void ecore_evas_tbm_pixels_release(Ecore_Evas *ee); * arguments and canonical @c malloc() and @c free() to the memory * allocation and freeing functions. See that function's documentation * for more details. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h); @@ -1446,6 +1776,10 @@ EAPI Ecore_Evas *ecore_evas_buffer_new(int w, int h); * they'll be interpreted as 1, exactly. * * @see ecore_evas_buffer_new() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc_func) (void *data, int size), void (*free_func) (void *data, void *pix), const void *data); @@ -1464,6 +1798,10 @@ EAPI Ecore_Evas *ecore_evas_buffer_allocfunc_new(int w, int h, void *(*alloc * @b another canvas, to have as data @p ee's contents, thus * snapshoting the canvas. For that case, one can also use the * ecore_evas_object_image_new() helper function. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee); @@ -1478,10 +1816,16 @@ EAPI const void *ecore_evas_buffer_pixels_get(Ecore_Evas *ee); * it, we need to retrieve information from the Ecore_Evas parents. * * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Evas *ecore_evas_buffer_ecore_evas_parent_get(Ecore_Evas *ee); /** + * @internal + * * @brief Create a new @c Ecore_Evas canvas bound to the Evas * @b ews (Ecore + Evas Single Process Windowing System) engine * @@ -1510,6 +1854,8 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); /** + * @internal + * * @brief Return the backing store image object that represents the given * window in EWS. * @return The evas object of EWS backing store. @@ -1526,6 +1872,8 @@ EAPI Ecore_Evas *ecore_evas_ews_new(int x, int y, int w, int h); EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Call the window to be deleted (freed), but can let user decide to * forbid it by using ecore_evas_callback_delete_request_set() * @@ -1535,6 +1883,8 @@ EAPI Evas_Object *ecore_evas_ews_backing_store_get(const Ecore_Evas *ee); EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); /** + * @internal + * * @brief Create an Evas image object with image data bound to an * own, internal @c Ecore_Evas canvas wrapper * @@ -1580,6 +1930,8 @@ EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee); EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target); /** + * @internal + * * @brief Retrieve the internal @c Ecore_Evas handle of an image * object created via ecore_evas_object_image_new() * @@ -1590,6 +1942,8 @@ EAPI Evas_Object *ecore_evas_object_image_new(Ecore_Evas *ee_target); EAPI Ecore_Evas *ecore_evas_object_ecore_evas_get(Evas_Object *obj); /** + * @internal + * * @brief Retrieve the canvas bound to the internal @c Ecore_Evas * handle of an image object created via ecore_evas_object_image_new() * @@ -1678,6 +2032,8 @@ EAPI Ecore_Evas *ecore_evas_psl1ght_new(const char* name, int w, int h); /* generic manipulation calls */ /** + * @internal + * * @brief Get the engine name used by this Ecore_Evas(window). * * @param ee Ecore_Evas whose engine's name is desired. @@ -1693,6 +2049,10 @@ EAPI const char *ecore_evas_engine_name_get(const Ecore_Evas *ee); * @return The Ecore_Evas that holds this Evas, or @c NULL if not held by one. * * @warning Only use on Evas' created with ecore evas! + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); /** @@ -1701,6 +2061,10 @@ EAPI Ecore_Evas *ecore_evas_ecore_evas_get(const Evas *e); * @param ee The Ecore_Evas to free * * This frees up any memory used by the Ecore_Evas. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_free(Ecore_Evas *ee); /** @@ -1716,6 +2080,10 @@ EAPI void ecore_evas_free(Ecore_Evas *ee); * success. * * @see ecore_evas_data_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); /** @@ -1734,6 +2102,10 @@ EAPI void *ecore_evas_data_get(const Ecore_Evas *ee, const char *key); * @see ecore_evas_callback_pre_free_set() * @see ecore_evas_free() * @see ecore_evas_data_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void *data); /** @@ -1746,6 +2118,10 @@ EAPI void ecore_evas_data_set(Ecore_Evas *ee, const char *key, const void * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1758,6 +2134,10 @@ EAPI void ecore_evas_callback_resize_set(Ecore_Evas *ee, Ecore_Evas_Event * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1770,6 +2150,10 @@ EAPI void ecore_evas_callback_move_set(Ecore_Evas *ee, Ecore_Evas_Event_C * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1782,6 +2166,10 @@ EAPI void ecore_evas_callback_show_set(Ecore_Evas *ee, Ecore_Evas_Event_C * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1794,6 +2182,10 @@ EAPI void ecore_evas_callback_hide_set(Ecore_Evas *ee, Ecore_Evas_Event_C * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1806,6 +2198,10 @@ EAPI void ecore_evas_callback_delete_request_set(Ecore_Evas *ee, Ecore_Ev * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1818,6 +2214,10 @@ EAPI void ecore_evas_callback_destroy_set(Ecore_Evas *ee, Ecore_Evas_Even * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1830,6 +2230,10 @@ EAPI void ecore_evas_callback_focus_in_set(Ecore_Evas *ee, Ecore_Evas_Eve * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1842,6 +2246,10 @@ EAPI void ecore_evas_callback_focus_out_set(Ecore_Evas *ee, Ecore_Evas_Ev * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1854,6 +2262,10 @@ EAPI void ecore_evas_callback_sticky_set(Ecore_Evas *ee, Ecore_Evas_Event * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1866,6 +2278,10 @@ EAPI void ecore_evas_callback_unsticky_set(Ecore_Evas *ee, Ecore_Evas_Eve * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1878,6 +2294,10 @@ EAPI void ecore_evas_callback_mouse_in_set(Ecore_Evas *ee, Ecore_Evas_Eve * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1890,6 +2310,10 @@ EAPI void ecore_evas_callback_mouse_out_set(Ecore_Evas *ee, Ecore_Evas_Ev * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1902,6 +2326,10 @@ EAPI void ecore_evas_callback_pre_render_set(Ecore_Evas *ee, Ecore_Evas_E * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1914,6 +2342,10 @@ EAPI void ecore_evas_callback_post_render_set(Ecore_Evas *ee, Ecore_Evas_ * * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); /** @@ -1927,6 +2359,10 @@ EAPI void ecore_evas_callback_pre_free_set(Ecore_Evas *ee, Ecore_Evas_Eve * @since 1.2 * @warning If and when this function is called depends on the underlying * windowing system. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas_Event_Cb func); @@ -1936,6 +2372,10 @@ EAPI void ecore_evas_callback_state_change_set(Ecore_Evas *ee, Ecore_Evas * @return The Evas wrapped by @p ee * * This function returns the Evas contained within @p ee. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); @@ -1946,6 +2386,10 @@ EAPI Evas *ecore_evas_get(const Ecore_Evas *ee); * @param y The y coordinate to set as the managed location * * This sets the managed geometry position of the @p ee to (@p x, @p y) + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y); @@ -1961,6 +2405,10 @@ EAPI void ecore_evas_managed_move(Ecore_Evas *ee, int x, int y); * will be rectangular, and parts with no data will show random framebuffer * artifacting. For non-shaped Ecore_Evases, it is recommended to cover the * entire evas with a background object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped); @@ -1971,6 +2419,10 @@ EAPI void ecore_evas_shaped_set(Ecore_Evas *ee, Eina_Bool shaped); * @return @c EINA_TRUE if shaped, @c EINA_FALSE if not. * * This function returns @c EINA_TRUE if @p ee is shaped, and @c EINA_FALSE if not. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); /** @@ -1979,6 +2431,10 @@ EAPI Eina_Bool ecore_evas_shaped_get(const Ecore_Evas *ee); * @param ee The Ecore_Evas to show. * * This function makes @p ee visible. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_show(Ecore_Evas *ee); /** @@ -1987,6 +2443,10 @@ EAPI void ecore_evas_show(Ecore_Evas *ee); * @param ee The Ecore_Evas to hide. * * This function makes @p ee hidden(not visible). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_hide(Ecore_Evas *ee); @@ -1995,6 +2455,10 @@ EAPI void ecore_evas_hide(Ecore_Evas *ee); * @param ee The Ecore_Evas to activate. * * This functions activates the Ecore_Evas. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_activate(Ecore_Evas *ee); @@ -2015,6 +2479,10 @@ EAPI void ecore_evas_activate(Ecore_Evas *ee); * those set by this function. * * @see ecore_evas_size_min_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h); @@ -2029,6 +2497,10 @@ EAPI void ecore_evas_size_min_set(Ecore_Evas *ee, int w, int h); * interested in: they'll be ignored by the function. * * @see ecore_evas_size_min_set() for more details + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h); @@ -2044,6 +2516,10 @@ EAPI void ecore_evas_size_min_get(const Ecore_Evas *ee, int *w, int *h); * the ones set. * * @see ecore_evas_size_max_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h); @@ -2058,6 +2534,10 @@ EAPI void ecore_evas_size_max_set(Ecore_Evas *ee, int w, int h); * interested in: they'll be ignored by the function. * * @see ecore_evas_size_max_set() for more details + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h); @@ -2073,6 +2553,10 @@ EAPI void ecore_evas_size_max_get(const Ecore_Evas *ee, int *w, int *h); * @b minimum size, instead of those set by ecore_evas_size_min_get(). * * @see ecore_evas_size_base_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h); @@ -2087,6 +2571,10 @@ EAPI void ecore_evas_size_base_set(Ecore_Evas *ee, int w, int h); * interested in: they'll be ignored by the function. * * @see ecore_evas_size_base_set() for more details + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h); @@ -2100,6 +2588,10 @@ EAPI void ecore_evas_size_base_get(const Ecore_Evas *ee, int *w, int *h); * This function sets the size steps of @p ee to be @p w x @p h. This * limits the size of this @c Ecore_Evas window to be @b always an * integer multiple of the step size, for each axis. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h); @@ -2114,6 +2606,10 @@ EAPI void ecore_evas_size_step_set(Ecore_Evas *ee, int w, int h); * interested in: they'll be ignored by the function. * * @see ecore_evas_size_base_set() for more details + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h); @@ -2138,6 +2634,10 @@ EAPI void ecore_evas_size_step_get(const Ecore_Evas *ee, int *w, int *h); * * @see ecore_evas_object_cursor_set() * @see ecore_evas_cursor_unset() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int layer, int hot_x, int hot_y); /** @@ -2154,10 +2654,16 @@ EAPI void ecore_evas_cursor_set(Ecore_Evas *ee, const char *file, int lay * @see ecore_evas_cursor_set() * @see ecore_evas_object_cursor_set() * @see ecore_evas_cursor_unset() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_cursor_get(const Ecore_Evas *ee, Evas_Object **obj, int *layer, int *hot_x, int *hot_y); /** + * @internal + * * @brief Set the cursor of an Ecore_Evas * * @param ee The Ecore_Evas @@ -2189,6 +2695,10 @@ EAPI void ecore_evas_object_cursor_set(Ecore_Evas *ee, Evas_Object *obj, * @see ecore_evas_cursor_set() * @see ecore_evas_object_cursor_set() * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee); @@ -2200,6 +2710,10 @@ EAPI Evas_Object* ecore_evas_cursor_unset(Ecore_Evas *ee); * * This function causes the window manager to ignore @p ee if @p on is * @c EINA_TRUE, or not ignore @p ee if @p on is @c EINA_FALSE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on); @@ -2208,6 +2722,10 @@ EAPI void ecore_evas_override_set(Ecore_Evas *ee, Eina_Bool on); * * @param ee The Ecore_Evas to set. * @return @c EINA_TRUE if @p ee is overridden, @c EINA_FALSE if not. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee); @@ -2236,6 +2754,10 @@ EAPI Eina_Bool ecore_evas_override_get(const Ecore_Evas *ee); * anything, but would stay stored on the pixmap, so there's no need to render * things again on expose events. This option can be faster than the previous * one, but may lead to artifacts during resize of the window. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Damage_Type on); @@ -2244,6 +2766,9 @@ EAPI void ecore_evas_avoid_damage_set(Ecore_Evas *ee, Ecore_Evas_Avoid_Da * @param ee The Ecore_Evas to set * @return The type of the damage management * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas *ee); @@ -2252,6 +2777,9 @@ EAPI Ecore_Evas_Avoid_Damage_Type ecore_evas_avoid_damage_get(const Ecore_Evas * * @param ee The Ecore_Evas whose window's withdrawn state is set. * @param withdrawn The Ecore_Evas window's new withdrawn state. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); @@ -2260,6 +2788,9 @@ EAPI void ecore_evas_withdrawn_set(Ecore_Evas *ee, Eina_Bool withdrawn); * @param ee The Ecore_Evas whose window's withdrawn state is returned. * @return The Ecore_Evas window's withdrawn state. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); @@ -2269,6 +2800,9 @@ EAPI Eina_Bool ecore_evas_withdrawn_get(const Ecore_Evas *ee); * @param ee The Ecore_Evas whose window's sticky state is set. * @param sticky The Ecore_Evas window's new sticky state. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); @@ -2278,6 +2812,9 @@ EAPI void ecore_evas_sticky_set(Ecore_Evas *ee, Eina_Bool sticky); * @param ee The Ecore_Evas whose window's sticky state is returned. * @return The Ecore_Evas window's sticky state. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee); @@ -2297,6 +2834,10 @@ EAPI Eina_Bool ecore_evas_sticky_get(const Ecore_Evas *ee); * * @see ecore_evas_manual_render_get() * @see ecore_evas_manual_render() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_render); @@ -2309,6 +2850,10 @@ EAPI void ecore_evas_manual_render_set(Ecore_Evas *ee, Eina_Bool manual_r * * @see ecore_evas_manual_render_set() * @see ecore_evas_manual_render() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee); @@ -2323,6 +2868,10 @@ EAPI Eina_Bool ecore_evas_manual_render_get(const Ecore_Evas *ee); * * @see ecore_evas_input_event_unregister() * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_input_event_register(Ecore_Evas *ee); @@ -2349,6 +2898,10 @@ EAPI void ecore_evas_input_event_register_with_multi(Ecore_Evas *ee); * * @see ecore_evas_input_event_register() * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee); @@ -2359,6 +2912,10 @@ EAPI void ecore_evas_input_event_unregister(Ecore_Evas *ee); * * Use this call to forcefully flush the @p ee's canvas rendering * pipeline, thus bring its window to an up to date state. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_manual_render(Ecore_Evas *ee); EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); @@ -2374,6 +2931,10 @@ EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); * @param h where to return the height value. May be @c NULL. * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, int *y, int *w, int *h); @@ -2385,6 +2946,10 @@ EAPI void ecore_evas_screen_geometry_get(const Ecore_Evas *ee, int *x, in * @param ydpi Pointer to integer to store vertical DPI. May be @c NULL. * * @since 1.7 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_screen_dpi_get(const Ecore_Evas *ee, int *xdpi, int *ydpi); @@ -2392,6 +2957,8 @@ EAPI void ecore_evas_draw_frame_set(Ecore_Evas *ee, Eina_Bool draw_frame) EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Associate the given object to this ecore evas. * * @param ee The Ecore_Evas to associate to @a obj @@ -2434,6 +3001,8 @@ EAPI Eina_Bool ecore_evas_draw_frame_get(const Ecore_Evas *ee); */ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, Ecore_Evas_Object_Associate_Flags flags); /** + * @internal + * * @brief Cancel the association set with ecore_evas_object_associate(). * * @param ee The Ecore_Evas to dissociate from @a obj @@ -2442,6 +3011,8 @@ EAPI Eina_Bool ecore_evas_object_associate(Ecore_Evas *ee, Evas_Object *obj, */ EAPI Eina_Bool ecore_evas_object_dissociate(Ecore_Evas *ee, Evas_Object *obj); /** + * @internal + * * @brief Get the object associated with @p ee * * @param ee The Ecore_Evas to get the object from. @@ -2453,6 +3024,8 @@ EAPI Evas_Object *ecore_evas_object_associate_get(const Ecore_Evas *ee); EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Getopt *parser, const Ecore_Getopt_Desc *desc, const char *str, void *data, Ecore_Getopt_Value *storage); /** + * @internal + * * @brief Get a list of all the ecore_evases. * * @return A list of ecore_evases. @@ -2463,6 +3036,8 @@ EAPI unsigned char ecore_getopt_callback_ecore_evas_list_engines(const Ecore_Get */ EAPI Eina_List *ecore_evas_ecore_evas_list_get(void); /** + * @internal + * * @brief Get a list of all the sub ecore_evases. * * @param ee Ecore_Evas to get the list from. @@ -2493,6 +3068,8 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee); */ /** + * @internal + * * @brief Set the engine to be used by the backing store engine. * * @param engine The engine to be set. @@ -2503,6 +3080,8 @@ EAPI void ecore_evas_x11_shape_input_apply(Ecore_Evas *ee); EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options); /** + * @internal + * * @brief Reconfigure the backing store used. * * @param x The X coordinate to be used. @@ -2515,6 +3094,8 @@ EAPI Eina_Bool ecore_evas_ews_engine_set(const char *engine, const char *options EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); /** + * @internal + * * @brief Return the internal backing store in use. * * @return The internal backing store in use. @@ -2527,6 +3108,8 @@ EAPI Eina_Bool ecore_evas_ews_setup(int x, int y, int w, int h); EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); /** + * @internal + * * @brief Return the internal backing store in use. * * @return The internal backing store in use. @@ -2539,11 +3122,15 @@ EAPI Ecore_Evas *ecore_evas_ews_ecore_evas_get(void); EAPI Evas *ecore_evas_ews_evas_get(void); /** + * @internal + * * @brief Get the current background. */ EAPI Evas_Object *ecore_evas_ews_background_get(void); /** + * @internal + * * @brief Set the current background, must be created at evas ecore_evas_ews_evas_get() * * It will be kept at lowest layer (EVAS_LAYER_MIN) and below @@ -2556,6 +3143,8 @@ EAPI Evas_Object *ecore_evas_ews_background_get(void); EAPI void ecore_evas_ews_background_set(Evas_Object *o); /** + * @internal + * * @brief Return all Ecore_Evas* created by EWS. * * @return An eina list of Ecore_evases. @@ -2565,6 +3154,8 @@ EAPI void ecore_evas_ews_background_set(Evas_Object *o); EAPI const Eina_List *ecore_evas_ews_children_get(void); /** + * @internal + * * @brief Set the identifier of the manager taking care of internal windows. * * The ECORE_EVAS_EWS_EVENT_MANAGER_CHANGE event is issued. Consider @@ -2579,6 +3170,8 @@ EAPI const Eina_List *ecore_evas_ews_children_get(void); EAPI void ecore_evas_ews_manager_set(const void *manager); /** + * @internal + * * @brief Get the identifier of the manager taking care of internal windows. * * @return the value set by ecore_evas_ews_manager_set() @@ -2628,6 +3221,8 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_ADD; /**< this event is received when a p EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a plug has disconnected from an extn socket @since 1.2 */ /** + * @internal + * * @brief Create a new Ecore_Evas canvas for the new external ecore evas socket * * @param w The width of the canvas, in pixels @@ -2710,6 +3305,8 @@ EAPI extern int ECORE_EVAS_EXTN_CLIENT_DEL; /**< this event is received when a p EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); /** + * @internal + * * @brief Create a socket to provide the service for external ecore evas * socket. * @@ -2738,6 +3335,8 @@ EAPI Ecore_Evas *ecore_evas_extn_socket_new(int w, int h); EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname, int svcnum, Eina_Bool svcsys); /** + * @internal + * * @brief Set the blocking about mouse events to Ecore Evas. * * @param ee The Ecore_Evas. @@ -2750,6 +3349,8 @@ EAPI Eina_Bool ecore_evas_extn_socket_listen(Ecore_Evas *ee, const char *svcname EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool events_block); /** + * @internal + * * @brief Get the blocking about mouse events to Ecore Evas. * * @param ee The Ecore_Evas. @@ -2763,6 +3364,8 @@ EAPI void ecore_evas_extn_socket_events_block_set(Ecore_Evas *ee, Eina_Bool even EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee); /** + * @internal + * * @brief Lock the pixel data so the socket cannot change it * * @param obj The image object returned by ecore_evas_extn_plug_new() to lock @@ -2787,6 +3390,8 @@ EAPI Eina_Bool ecore_evas_extn_socket_events_block_get(Ecore_Evas *ee); EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj); /** + * @internal + * * @brief Unlock the pixel data so the socket can change it again. * * @param obj The image object returned by ecore_evas_extn_plug_new() to unlock @@ -2802,6 +3407,8 @@ EAPI void ecore_evas_extn_plug_object_data_lock(Evas_Object *obj); EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj); /** + * @internal + * * @brief Create a new external ecore evas plug * * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live. @@ -2833,6 +3440,8 @@ EAPI void ecore_evas_extn_plug_object_data_unlock(Evas_Object *obj); EAPI Evas_Object *ecore_evas_extn_plug_new(Ecore_Evas *ee_target); /** + * @internal + * * @brief Connect an external ecore evas plug to service provided by external * ecore evas socket. * @@ -2859,6 +3468,10 @@ EAPI Eina_Bool ecore_evas_extn_plug_connect(Evas_Object *obj, const char *svcnam * @param y Pointer to integer to store vertical coordinate. May be @c NULL. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Coord *y); @@ -2872,10 +3485,16 @@ EAPI void ecore_evas_pointer_xy_get(const Ecore_Evas *ee, Evas_Coord *x, Evas_Co * @return @c EINA_TRUE on success, EINA_FALSE on failure. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_Coord y); /** + * @internal + * * @brief Retrieve the Visual used for pixmap creation * * @param ee The Ecore_Evas containing the pixmap @@ -2891,6 +3510,8 @@ EAPI Eina_Bool ecore_evas_pointer_warp(const Ecore_Evas *ee, Evas_Coord x, Evas_ EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Retrieve the Colormap used for pixmap creation * * @param ee The Ecore_Evas containing the pixmap @@ -2906,6 +3527,8 @@ EAPI void *ecore_evas_pixmap_visual_get(const Ecore_Evas *ee); EAPI unsigned long ecore_evas_pixmap_colormap_get(const Ecore_Evas *ee); /** + * @internal + * * @brief Retrieve the depth used for pixmap creation * * @param ee The Ecore_Evas containing the pixmap diff --git a/src/lib/ecore_file/ecore_file.c b/src/lib/ecore_file/ecore_file.c index cc17f2f..0872f38 100644 --- a/src/lib/ecore_file/ecore_file.c +++ b/src/lib/ecore_file/ecore_file.c @@ -104,6 +104,10 @@ _ecore_file_stat(const char *file, * * When Ecore_File is not used anymore, call ecore_file_shutdown() * to shut down the Ecore_File library. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_init() @@ -167,6 +171,10 @@ ecore_file_init() * This function shuts down the Ecore_File library. It returns 0 when it has * been called the same number of times than ecore_file_init(). In that case * it shuts down all the services it uses. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_shutdown() @@ -200,6 +208,10 @@ ecore_file_shutdown() * * This function returns the time of the last modification of * @p file. On failure, it returns 0. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI long long ecore_file_mod_time(const char *file) @@ -220,6 +232,10 @@ ecore_file_mod_time(const char *file) * * This function returns the size of @p file in bytes. On failure, it * returns 0. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI long long ecore_file_size(const char *file) @@ -240,6 +256,10 @@ ecore_file_size(const char *file) * * This function returns @c EINA_TRUE if @p file exists on local filesystem, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_exists(const char *file) @@ -266,6 +286,10 @@ ecore_file_exists(const char *file) * * This function returns @c EINA_TRUE if @p file exists exists and is a * directory on local filesystem, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_is_dir(const char *file) @@ -290,6 +314,10 @@ static mode_t default_mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S * S_IWUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH on UNIX * (mode is unsued on Windows). On success, it returns @c EINA_TRUE, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_mkdir(const char *dir) @@ -309,6 +337,10 @@ ecore_file_mkdir(const char *dir) * and call ecore_file_mkdir(). This function returns -1 if @p dirs is * @c NULL, otherwise if returns the number of suceesfully created * directories. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_mkdirs(const char **dirs) @@ -340,6 +372,10 @@ ecore_file_mkdirs(const char **dirs) * empty ("\0"). It returns 0 is @p base is not a directory or * invalid, or if it can't be created. Otherwise if returns the number * of suceesfully created directories. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_mksubdirs(const char *base, const char **subdirs) @@ -431,6 +467,10 @@ ecore_file_mksubdirs(const char *base, const char **subdirs) * * This function deletes @p dir. It returns @c EINA_TRUE on success, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_rmdir(const char *dir) @@ -447,6 +487,10 @@ ecore_file_rmdir(const char *dir) * * This function deletes @p file. It returns @c EINA_TRUE on success, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_unlink(const char *file) @@ -463,6 +507,10 @@ ecore_file_unlink(const char *file) * * This function removes @p file. It returns @c EINA_TRUE on success, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_remove(const char *file) @@ -480,6 +528,10 @@ ecore_file_remove(const char *file) * This function delete @p dir and all its contents. If @p dir is a * link only the link is removed. It returns @c EINA_TRUE on success, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_recursive_rm(const char *dir) @@ -561,6 +613,10 @@ _ecore_file_mkpath_if_not_exists(const char *path) * contains. The separator is '/' or '\'. If @p path exists, this * function returns @c EINA_TRUE immediately. It returns @c EINA_TRUE on * success, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_mkpath(const char *path) @@ -599,6 +655,10 @@ ecore_file_mkpath(const char *path) * replaced by '/' before calling that function. This function * returns -1 if @p paths is @c NULL. Otherwise if returns the number * of suceesfully created directories. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_mkpaths(const char **paths) @@ -624,6 +684,10 @@ ecore_file_mkpaths(const char **paths) * @p src and @p dst can not be computed, or if they are equal, or if * the copy fails, the function returns @c EINA_FALSE, otherwise it * returns @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_cp(const char *src, const char *dst) @@ -663,6 +727,10 @@ ecore_file_cp(const char *src, const char *dst) * * This function moves @p src to @p dst. It returns @c EINA_TRUE on * success, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_mv(const char *src, const char *dst) @@ -740,6 +808,10 @@ FAIL: * This function create the symbolic link @p dest of @p src. This * function does not work on Windows. It returns @c EINA_TRUE on success, * @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_symlink(const char *src, const char *dest) @@ -760,6 +832,10 @@ ecore_file_symlink(const char *src, const char *dest) * allocated string. If @p file is @c NULL, or on error, this function * returns an empty string. Otherwise, it returns the absolute path * name. When not needed anymore, the returned value must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_realpath(const char *file) @@ -784,6 +860,10 @@ ecore_file_realpath(const char *file) * * This function returns the file name of @p path. If @p path is * @c NULL, the functions returns @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_file_file_get(const char *path) @@ -816,6 +896,10 @@ ecore_file_file_get(const char *path) * allocated string. If @p file is @c NULL or on error, this function * returns @c NULL. When not needed anymore, the returned value must * be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_dir_get(const char *file) @@ -838,6 +922,10 @@ ecore_file_dir_get(const char *file) * * This function returns @c EINA_TRUE if @p file can be read, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_can_read(const char *file) @@ -855,6 +943,10 @@ ecore_file_can_read(const char *file) * * This function returns @c EINA_TRUE if @p file can be written, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_can_write(const char *file) @@ -873,6 +965,10 @@ ecore_file_can_write(const char *file) * * This function returns @c EINA_TRUE if @p file can be executed, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_can_exec(const char *file) @@ -892,6 +988,10 @@ ecore_file_can_exec(const char *file) * allocated string. This function does not work on Windows. On * failure, the function returns @c NULL. When not needed anymore, the * returned value must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_readlink(const char *lnk) @@ -920,6 +1020,10 @@ ecore_file_readlink(const char *lnk) * and setlocale. The list will not contain the directory entries for * '.' and '..'. On failure, @c NULL is returned. When not needed * anymore, the list elements must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List * ecore_file_ls(const char *dir) @@ -953,6 +1057,10 @@ ecore_file_ls(const char *dir) * are removed and escape characters are handled. If @p app is @c NULL, or * on failure, the function returns @c NULL. When not needed anymore, the * returned value must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_app_exe_get(const char *app) @@ -1027,6 +1135,10 @@ ecore_file_app_exe_get(const char *app) * length of the returned string is longer than PATH_MAX, or on * failure, @c NULL is returned. When not needed anymore, the returned * value must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_escape_name(const char *filename) @@ -1097,6 +1209,10 @@ ecore_file_escape_name(const char *filename) * result as a newly allocated string. If @p path is @c NULL, or on * failure, the function returns @c NULL. When not needed anymore, the * returned value must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * ecore_file_strip_ext(const char *path) @@ -1132,6 +1248,10 @@ ecore_file_strip_ext(const char *path) * This functions checks if @p dir is empty. The '.' and '..' files * will be ignored. If @p dir is empty, 1 is returned, if it contains * at least one file, @c 0 is returned. On failure, @c -1 is returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_file_dir_is_empty(const char *dir) diff --git a/src/lib/ecore_file/ecore_file_download.c b/src/lib/ecore_file/ecore_file_download.c index 83c5884..f6b9895 100644 --- a/src/lib/ecore_file/ecore_file_download.c +++ b/src/lib/ecore_file/ecore_file_download.c @@ -181,6 +181,10 @@ _ecore_file_download(const char *url, * that download job. Similarly ecore_file_download_abort_all() can be used to * abort all download operations. This function returns @c EINA_TRUE if the * download starts, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_download(const char *url, @@ -204,6 +208,10 @@ ecore_file_download(const char *url, * @param job_ret Job used to abort the download. * @param headers pointer of header lists. * @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_download_full(const char *url, @@ -227,6 +235,10 @@ ecore_file_download_full(const char *url, * @c EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or * 'file://'. Ecore_FILE must be compiled with CURL to handle http and * ftp protocols. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_download_protocol_available(const char *protocol) @@ -359,6 +371,10 @@ _ecore_file_download_curl(const char *url, const char *dst, * structure filled by ecore_file_download(). If it is @c NULL, this * function does nothing. To abort all the currently downloading * operations, call ecore_file_download_abort_all(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job) @@ -382,6 +398,10 @@ ecore_file_download_abort(Ecore_File_Download_Job *job) * ecore_file_download(). It loops over the started downloads and call * ecore_file_download_abort() for each of them. To abort only one * specific download operation, call ecore_file_download_abort(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_file_download_abort_all(void) diff --git a/src/lib/ecore_file/ecore_file_monitor.c b/src/lib/ecore_file/ecore_file_monitor.c index 7b4f625..4007207 100644 --- a/src/lib/ecore_file/ecore_file_monitor.c +++ b/src/lib/ecore_file/ecore_file_monitor.c @@ -40,6 +40,10 @@ ecore_file_monitor_shutdown(void) * When one of the Ecore_File_Event event is notified, @p func is called * and @p data is passed to @p func.Call ecore_file_monitor_del() to * stop the monitoring. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_File_Monitor * ecore_file_monitor_add(const char *path, @@ -63,6 +67,10 @@ ecore_file_monitor_add(const char *path, * returned by ecore_file_monitor_add(). If @p em is @c NULL, or none * of the notify methods (Inotify, Windows notification or polling) is * availablethis function does nothing. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_file_monitor_del(Ecore_File_Monitor *em) @@ -82,6 +90,10 @@ ecore_file_monitor_del(Ecore_File_Monitor *em) * monitored by ecore_file_monitor_add(). @p em must be the value * returned by ecore_file_monitor_add(). If @p em is @c NULL, the * function returns @c NULL. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_file_monitor_path_get(Ecore_File_Monitor *em) diff --git a/src/lib/ecore_file/ecore_file_path.c b/src/lib/ecore_file/ecore_file_path.c index 71fdb68..3b73feb 100644 --- a/src/lib/ecore_file/ecore_file_path.c +++ b/src/lib/ecore_file/ecore_file_path.c @@ -84,6 +84,10 @@ _ecore_file_path_from_env(const char *env) * PATH. If @p in_dir is @c NULL, or if PATH is empty, or @p in_dir is * not in PATH, the function returns @c EINA_FALSE, otherwise it returns * @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_path_dir_exists(const char *in_dir) @@ -114,6 +118,10 @@ ecore_file_path_dir_exists(const char *in_dir) * This function checks if @p exe exists in PATH and is executable. If * @p exe is @c NULL or is not executable, the function returns * @c EINA_FALSE, otherwise it returns @c EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_file_app_installed(const char *exe) @@ -145,6 +153,10 @@ ecore_file_app_installed(const char *exe) * executable files. If no files are found, the function returns * @c NULL. When not needed anymore, the element of the list must be * freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List * ecore_file_app_list(void) diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h index ad44f5b..fb5b321 100644 --- a/src/lib/ecore_imf/Ecore_IMF.h +++ b/src/lib/ecore_imf/Ecore_IMF.h @@ -736,6 +736,10 @@ struct _Ecore_IMF_Context_Info * @return Number of times the library has been initialised without being * shut down. * @ingroup Ecore_IMF_Lib_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_imf_init(void); @@ -744,6 +748,10 @@ EAPI int ecore_imf_init(void); * @return Number of times the library has been initialised without being * shut down. * @ingroup Ecore_IMF_Lib_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_imf_shutdown(void); @@ -755,6 +763,10 @@ EAPI int ecore_imf_shutdown(void); * @param imf_module_exit A function to call when exiting * * @ingroup Ecore_IMF_Lib_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_module_register(const Ecore_IMF_Context_Info *info, Ecore_IMF_Context *(*imf_module_create)(void), Ecore_IMF_Context *(*imf_module_exit)(void)); @@ -764,6 +776,10 @@ EAPI void ecore_imf_module_register(const Ecore_IMF_Con EINA_FALSE if the input panel is already in hidden state * @ingroup Ecore_IMF_Lib_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_input_panel_hide(void); @@ -776,6 +792,10 @@ EAPI Eina_Bool ecore_imf_input_panel_hide(void); * @return Return an Eina_List of strings; * on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *ecore_imf_context_available_ids_get(void); @@ -789,6 +809,10 @@ EAPI Eina_List *ecore_imf_context_available_ids_get(void); * @return Return an Eina_List of strings; * on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type); @@ -800,6 +824,10 @@ EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_typ * @return Return a string containing the id of the default Input * Method Context; on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *ecore_imf_context_default_id_get(void); @@ -813,6 +841,10 @@ EAPI const char *ecore_imf_context_default_id_get(void); * @return Return a string containing the id of the default Input * Method Context; on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type); @@ -849,6 +881,10 @@ EAPI const char *ecore_imf_context_default_id_by_canvas_type_g * } * } * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id); @@ -859,6 +895,10 @@ EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char * * @return A newly allocated Input Method Context; * on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id); @@ -869,6 +909,10 @@ EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id); * @return Return a #Ecore_IMF_Context_Info for the given Input Method Context; * on failure it returns NULL. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx); @@ -877,6 +921,10 @@ EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx); @@ -890,6 +938,10 @@ EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx) * @param window The client window. This may be @c NULL to indicate * that the previous client window no longer exists. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window); @@ -902,6 +954,10 @@ EAPI void ecore_imf_context_client_window_set(Ecore_IMF * @return Return the client window. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx); @@ -917,6 +973,10 @@ EAPI void *ecore_imf_context_client_window_get(Ecore_IMF * @param canvas The client canvas. This may be @c NULL to indicate * that the previous client canvas no longer exists. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas); @@ -929,6 +989,10 @@ EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF * @return Return the client canvas. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx); @@ -937,6 +1001,10 @@ EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx); @@ -945,6 +1013,10 @@ EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx); @@ -958,6 +1030,10 @@ EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx * @param cursor_pos Location to store position of cursor (in characters) * within the preedit string. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos); @@ -1013,6 +1089,10 @@ EAPI void ecore_imf_context_preedit_string_get(Ecore_IM * free(preedit_string); * @endcode * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos); @@ -1034,6 +1114,10 @@ EAPI void ecore_imf_context_preedit_string_with_attribu * * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_IN, _focus_in_cb, imf_context); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context *ctx); @@ -1056,6 +1140,10 @@ EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context * * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_OUT, _focus_out_cb, ed); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context *ctx); @@ -1086,6 +1174,10 @@ EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context * * evas_object_event_callback_add(obj, EVAS_CALLBACK_FOCUS_OUT, _focus_out_cb, imf_context); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ctx); @@ -1101,6 +1193,10 @@ EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ct * @param ctx An #Ecore_IMF_Context. * @param cursor_pos New cursor position in characters. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos); @@ -1117,6 +1213,10 @@ EAPI void ecore_imf_context_cursor_position_set(Ecore_I * @param h cursor height. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h); @@ -1129,6 +1229,10 @@ EAPI void ecore_imf_context_cursor_location_set(Ecore_I * @param ctx An #Ecore_IMF_Context. * @param use_preedit Whether the IM context should use the preedit string. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit); @@ -1144,6 +1248,10 @@ EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_C * @param func The callback to be called. * @param data The data pointer to be passed to @p func * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_retrieve_surrounding_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text, int *cursor_pos), const void *data); @@ -1158,6 +1266,10 @@ EAPI void ecore_imf_context_retrieve_surrounding_callba * @param data The data pointer to be passed to @p func * @ingroup Ecore_IMF_Context_Group * @since 1.9.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_retrieve_selection_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text), const void *data); @@ -1171,6 +1283,10 @@ EAPI void ecore_imf_context_retrieve_selection_callback * @param ctx An #Ecore_IMF_Context. * @param input_mode The input mode to be used by @p ctx. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode); @@ -1182,6 +1298,10 @@ EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Co * @param ctx An #Ecore_IMF_Context. * @return The input mode being used by @p ctx. * @ingroup Ecore_IMF_Context_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx); @@ -1221,6 +1341,10 @@ EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Co * * evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN, _key_down_cb, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_filter_event(Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event); @@ -1242,6 +1366,10 @@ EAPI Eina_Bool ecore_imf_context_filter_event(Ecore_IMF_Cont * @param ctxc An #Ecore_IMF_Context_Class. * @return A new #Ecore_IMF_Context; on failure it returns NULL. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc); @@ -1256,6 +1384,10 @@ EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context * @param data The Input Method Context specific data. * @return A new #Ecore_IMF_Context; on failure it returns NULL. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data); @@ -1267,6 +1399,10 @@ EAPI void ecore_imf_context_data_set(Ecore_IMF_Context * @param ctx An #Ecore_IMF_Context. * @return The Input Method Context specific data. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx); @@ -1294,6 +1430,10 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context * @return @c EINA_TRUE if surrounding text was provided; otherwise * @c EINA_FALSE. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos); @@ -1316,6 +1456,10 @@ EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_C * @c EINA_FALSE. * @ingroup Ecore_IMF_Context_Module_Group * @since 1.9.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_selection_get(Ecore_IMF_Context *ctx, char **text); @@ -1328,6 +1472,10 @@ EAPI Eina_Bool ecore_imf_context_selection_get(Ecore_IMF_Con * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx); @@ -1340,6 +1488,10 @@ EAPI void ecore_imf_context_preedit_start_event_add(Eco * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx); @@ -1351,6 +1503,10 @@ EAPI void ecore_imf_context_preedit_end_event_add(Ecore * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx); @@ -1363,6 +1519,10 @@ EAPI void ecore_imf_context_preedit_changed_event_add(E * @param ctx An #Ecore_IMF_Context. * @param str The committed string. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str); @@ -1380,6 +1540,10 @@ EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_ * @param offset The start offset of surrounding to be deleted. * @param n_chars The number of characters to be deleted. * @ingroup Ecore_IMF_Context_Module_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars); @@ -1414,6 +1578,10 @@ EAPI void ecore_imf_context_delete_surrounding_event_ad * * ecore_imf_context_event_callback_add(en->imf_context, ECORE_IMF_CALLBACK_COMMIT, _imf_event_commit_cb, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data); @@ -1433,6 +1601,10 @@ EAPI void ecore_imf_context_event_callback_add(Ecore_IM * @return the data pointer * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func); @@ -1452,6 +1624,10 @@ EAPI void *ecore_imf_context_event_callback_del(Ecore_IM * pass to the callback functions registered on this event * @ingroup Ecore_IMF_Context_Module_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info); @@ -1465,6 +1641,10 @@ EAPI void ecore_imf_context_event_callback_call(Ecore_I * @note Default value is EINA_TRUE. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction); @@ -1476,6 +1656,10 @@ EAPI void ecore_imf_context_prediction_allow_set(Ecore_ * @c EINA_FALSE. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx); @@ -1487,6 +1671,10 @@ EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_ * @note Default type is ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type); @@ -1497,6 +1685,10 @@ EAPI void ecore_imf_context_autocapital_type_set(Ecore_ * @return The autocapital type being used by @p ctx. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx); @@ -1508,6 +1700,10 @@ EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_ * @note The default input hint is @c ECORE_IMF_INPUT_HINT_AUTO_COMPLETE. * @ingroup Ecore_IMF_Context_Group * @since 1.12 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_hint_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints hints); @@ -1518,6 +1714,10 @@ EAPI void ecore_imf_context_input_hint_set(Ecore_IMF_Co * @return The value of input hint * @ingroup Ecore_IMF_Context_Group * @since 1.12 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Hints ecore_imf_context_input_hint_get(Ecore_IMF_Context *ctx); @@ -1527,6 +1727,10 @@ EAPI Ecore_IMF_Input_Hints ecore_imf_context_input_hint_get(Ecore_IMF_Co * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx); @@ -1536,6 +1740,10 @@ EAPI void ecore_imf_context_control_panel_show(Ecore_IM * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx); @@ -1545,6 +1753,10 @@ EAPI void ecore_imf_context_control_panel_hide(Ecore_IM * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx); @@ -1554,6 +1766,10 @@ EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_ * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx); @@ -1565,6 +1781,10 @@ EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_ * @note Default layout type is ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout); @@ -1575,6 +1795,10 @@ EAPI void ecore_imf_context_input_panel_layout_set(Ecor * @return layout see #Ecore_IMF_Input_Panel_Layout * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx); @@ -1586,6 +1810,10 @@ EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecor * @note Default layout variation type is NORMAL. * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_layout_variation_set(Ecore_IMF_Context *ctx, int variation); @@ -1596,6 +1824,10 @@ EAPI void ecore_imf_context_input_panel_layout_variatio * @return the layout variation * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int ecore_imf_context_input_panel_layout_variation_get(Ecore_IMF_Context *ctx); @@ -1607,6 +1839,10 @@ EAPI int ecore_imf_context_input_panel_layout_variatio * @param lang the language to be set to the input panel. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang); @@ -1619,6 +1855,10 @@ EAPI void ecore_imf_context_input_panel_language_set(Ec * @return Ecore_IMF_Input_Panel_Lang * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx); @@ -1630,6 +1870,10 @@ EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ec * @param enabled If true, the input panel will be shown when the widget is clicked or has focus. * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enabled); @@ -1640,6 +1884,10 @@ EAPI void ecore_imf_context_input_panel_enabled_set(Eco * @return Return the attribute to show the input panel automatically * @ingroup Ecore_IMF_Context_Group * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx); @@ -1654,6 +1902,10 @@ EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Eco * @param len the length of data, in bytes, to send to the input panel * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len); @@ -1665,6 +1917,10 @@ EAPI void ecore_imf_context_input_panel_imdata_set(Ecor * @param len The length of data * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len); @@ -1679,6 +1935,10 @@ EAPI void ecore_imf_context_input_panel_imdata_get(Ecor * @note Default type is ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT. * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type); @@ -1691,6 +1951,10 @@ EAPI void ecore_imf_context_input_panel_return_key_type * @return The type of "return" key on the input panel * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx); @@ -1701,6 +1965,10 @@ EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_ * @param disabled The state * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled); @@ -1711,6 +1979,10 @@ EAPI void ecore_imf_context_input_panel_return_key_disa * @return @c EINA_TRUE if it should be disabled. * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx); @@ -1721,6 +1993,10 @@ EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disa * @param mode Turn on caps lock on the input panel if @c EINA_TRUE. * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode); @@ -1731,6 +2007,10 @@ EAPI void ecore_imf_context_input_panel_caps_lock_mode_ * @return @c EINA_TRUE if the caps lock is turned on. * @ingroup Ecore_IMF_Context_Group * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx); @@ -1744,6 +2024,10 @@ EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_ * @param h height of the input panel * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h); @@ -1754,6 +2038,10 @@ EAPI void ecore_imf_context_input_panel_geometry_get(Ec * @return The state of input panel. * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx); @@ -1768,6 +2056,10 @@ EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore * @param data application-input panel specific data. * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), const void *data); @@ -1779,6 +2071,10 @@ EAPI void ecore_imf_context_input_panel_event_callback_ * @param func the callback function * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value)); @@ -1790,6 +2086,10 @@ EAPI void ecore_imf_context_input_panel_event_callback_ * @param value the event value * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, int value); @@ -1801,6 +2101,10 @@ EAPI void ecore_imf_context_input_panel_event_callback_ * @param ctx Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_event_callback_clear(Ecore_IMF_Context *ctx); @@ -1814,6 +2118,10 @@ EAPI void ecore_imf_context_input_panel_event_callback_ * string retrieved must be freed with free(). * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang); @@ -1827,6 +2135,10 @@ EAPI void ecore_imf_context_input_panel_language_locale * @param h height of the candidate panel * @ingroup Ecore_IMF_Context_Group * @since 1.3 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h); @@ -1838,6 +2150,10 @@ EAPI void ecore_imf_context_candidate_panel_geometry_ge * @param ondemand If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_input_panel_show_on_demand_set(Ecore_IMF_Context *ctx, Eina_Bool ondemand); @@ -1848,6 +2164,10 @@ EAPI void ecore_imf_context_input_panel_show_on_demand_ * @return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event. * @ingroup Ecore_IMF_Context_Group * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_get(Ecore_IMF_Context *ctx); @@ -1859,6 +2179,10 @@ EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_ * * @param[in] ctx An #Ecore_IMF_Context * @param[in] direction the direction mode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_context_bidi_direction_set(Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction); @@ -1870,6 +2194,10 @@ EAPI void ecore_imf_context_bidi_direction_set(Ecore_IM * * @param[in] ctx An #Ecore_IMF_Context * @return the direction mode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx); diff --git a/src/lib/ecore_imf_evas/Ecore_IMF_Evas.h b/src/lib/ecore_imf_evas/Ecore_IMF_Evas.h index 61005be..6effb9a 100644 --- a/src/lib/ecore_imf_evas/Ecore_IMF_Evas.h +++ b/src/lib/ecore_imf_evas/Ecore_IMF_Evas.h @@ -51,6 +51,10 @@ extern "C" { * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_in_wrap(Evas_Event_Mouse_In *evas_event, Ecore_IMF_Event_Mouse_In *imf_event); @@ -60,6 +64,10 @@ EAPI void ecore_imf_evas_event_mouse_in_wrap(Evas_Event_Mouse_In *evas_event, Ec * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_out_wrap(Evas_Event_Mouse_Out *evas_event, Ecore_IMF_Event_Mouse_Out *imf_event); @@ -69,6 +77,10 @@ EAPI void ecore_imf_evas_event_mouse_out_wrap(Evas_Event_Mouse_Out *evas_event, * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_move_wrap(Evas_Event_Mouse_Move *evas_event, Ecore_IMF_Event_Mouse_Move *imf_event); @@ -78,6 +90,10 @@ EAPI void ecore_imf_evas_event_mouse_move_wrap(Evas_Event_Mouse_Move *evas_event * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_down_wrap(Evas_Event_Mouse_Down *evas_event, Ecore_IMF_Event_Mouse_Down *imf_event); @@ -87,6 +103,10 @@ EAPI void ecore_imf_evas_event_mouse_down_wrap(Evas_Event_Mouse_Down *evas_event * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_up_wrap(Evas_Event_Mouse_Up *evas_event, Ecore_IMF_Event_Mouse_Up *imf_event); @@ -96,6 +116,10 @@ EAPI void ecore_imf_evas_event_mouse_up_wrap(Evas_Event_Mouse_Up *evas_event, Ec * @param evas_event The received Evas event. * @param imf_event The location to store the converted Ecore_IMF event. * @ingroup Ecore_IMF_Evas_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_mouse_wheel_wrap(Evas_Event_Mouse_Wheel *evas_event, Ecore_IMF_Event_Mouse_Wheel *imf_event); @@ -127,6 +151,10 @@ EAPI void ecore_imf_evas_event_mouse_wheel_wrap(Evas_Event_Mouse_Wheel *evas_eve * * evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_DOWN, _key_down_cb, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_key_down_wrap(Evas_Event_Key_Down *evas_event, Ecore_IMF_Event_Key_Down *imf_event); @@ -158,6 +186,10 @@ EAPI void ecore_imf_evas_event_key_down_wrap(Evas_Event_Key_Down *evas_event, Ec * * evas_object_event_callback_add(obj, EVAS_CALLBACK_KEY_UP, _key_up_cb, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void ecore_imf_evas_event_key_up_wrap(Evas_Event_Key_Up *evas_event, Ecore_IMF_Event_Key_Up *imf_event); diff --git a/src/lib/ecore_input/Ecore_Input.h b/src/lib/ecore_input/Ecore_Input.h index b44d07e..3036ab0 100644 --- a/src/lib/ecore_input/Ecore_Input.h +++ b/src/lib/ecore_input/Ecore_Input.h @@ -45,6 +45,10 @@ extern "C" { * @ingroup Ecore * *@{ + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern int ECORE_EVENT_KEY_DOWN; EAPI extern int ECORE_EVENT_KEY_UP; @@ -427,10 +431,18 @@ extern "C" { /** * Initialises the Ecore Event system. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_event_init(void); /** * Shutdowns the Ecore Event system. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_event_shutdown(void); @@ -441,6 +453,10 @@ extern "C" { * @param modifier A Ecore_Event_Modifier event. * @return A event_modifier integer that matches with the provided modifier * event. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI unsigned int ecore_event_modifier_mask(Ecore_Event_Modifier modifier); @@ -453,6 +469,10 @@ extern "C" { * * @return ECORE_NONE if the key does not match with an existing one, else * the corresponding Ecore_Event_Modifier. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Event_Modifier ecore_event_update_modifier(const char *key, Ecore_Event_Modifiers *modifiers, int inc); @@ -465,6 +485,10 @@ extern "C" { * @param seq The sequence of key symbols in a Eina_List. * @param seqstr_ret The final compose string. * @return The status of the composition. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Compose_State ecore_compose_get(const Eina_List *seq, char **seqstr_ret); //TIZEN_ONLY(20160627) - Initial version of ecore joystick event @@ -473,11 +497,19 @@ extern "C" { /** * Initialises the Ecore Input Joystick system. * @since 1.15 + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_input_joystick_init(void); /** * Shutdowns the Ecore Input Joystick system. * @since 1.15 + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_input_joystick_shutdown(void); #endif diff --git a/src/lib/ecore_ipc/ecore_ipc.c b/src/lib/ecore_ipc/ecore_ipc.c index 56de0ab..becb011 100644 --- a/src/lib/ecore_ipc/ecore_ipc.c +++ b/src/lib/ecore_ipc/ecore_ipc.c @@ -243,6 +243,10 @@ static Ecore_Event_Handler *handler[6]; * @return Number of times the library has been initialised without * being shut down. * @ingroup Ecore_IPC_Library_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_init(void) @@ -288,6 +292,10 @@ ecore_ipc_init(void) * @return Number of times the library has been initialised without being * shut down. * @ingroup Ecore_IPC_Library_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_shutdown(void) @@ -331,6 +339,10 @@ ecore_ipc_shutdown(void) * @return New IPC server. If there is an error, @c NULL is returned. * @ingroup Ecore_IPC_Server_Group * @todo Need to add protocol type parameter to this function. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Ipc_Server * ecore_ipc_server_add(Ecore_Ipc_Type compl_type, const char *name, int port, const void *data) @@ -389,6 +401,10 @@ ecore_ipc_server_add(Ecore_Ipc_Type compl_type, const char *name, int port, cons * @return A new IPC server. @c NULL is returned on error. * @ingroup Ecore_IPC_Server_Group * @todo Need to add protocol type parameter. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Ipc_Server * ecore_ipc_server_connect(Ecore_Ipc_Type compl_type, char *name, int port, const void *data) @@ -438,6 +454,10 @@ ecore_ipc_server_connect(Ecore_Ipc_Type compl_type, char *name, int port, const * @param svr The given IPC server. * @return The data associated with the server when it was created. * @ingroup Ecore_IPC_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_ipc_server_del(Ecore_Ipc_Server *svr) @@ -477,6 +497,10 @@ ecore_ipc_server_del(Ecore_Ipc_Server *svr) * @param svr The given IPC server. * @return The associated data. * @ingroup Ecore_IPC_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_ipc_server_data_get(Ecore_Ipc_Server *svr) @@ -495,6 +519,10 @@ ecore_ipc_server_data_get(Ecore_Ipc_Server *svr) * @param svr The given IPC server. * @return @c EINA_TRUE if the server is connected, @c EINA_FALSE otherwise. * @ingroup Ecore_IPC_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr) @@ -513,6 +541,10 @@ ecore_ipc_server_connected_get(Ecore_Ipc_Server *svr) * @param svr The given IPC server. * @return An Eina_List with the clients. * @ingroup Ecore_IPC_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List * ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr) @@ -576,6 +608,10 @@ ecore_ipc_server_clients_get(Ecore_Ipc_Server *svr) * @ingroup Ecore_IPC_Server_Group * @todo This function needs to become an IPC message. * @todo Fix up the documentation: Make sure what ref_to and response are. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int ref_to, int response, const void *data, int size) @@ -640,6 +676,10 @@ ecore_ipc_server_send(Ecore_Ipc_Server *svr, int major, int minor, int ref, int * connections (or your kernel's limit, whichever is * lower). * @ingroup Ecore_Ipc_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char reject_excess_clients) @@ -659,6 +699,10 @@ ecore_ipc_server_client_limit_set(Ecore_Ipc_Server *svr, int client_limit, char * @param svr The given server. * @param size The maximum data payload size in bytes. * @ingroup Ecore_Ipc_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *svr, int size) @@ -678,6 +722,10 @@ ecore_ipc_server_data_size_max_set(Ecore_Ipc_Server *svr, int size) * @param svr The given server. * @return The maximum data payload in bytes. * @ingroup Ecore_Ipc_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *svr) @@ -700,6 +748,10 @@ ecore_ipc_server_data_size_max_get(Ecore_Ipc_Server *svr) * This string should not be modified or trusted to stay valid after * deletion for the @p svr object. If no IP is known NULL is returned. * @ingroup Ecore_Ipc_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr) @@ -718,6 +770,10 @@ ecore_ipc_server_ip_get(Ecore_Ipc_Server *svr) * * @param svr The given server. * @ingroup Ecore_Ipc_Server_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_server_flush(Ecore_Ipc_Server *svr) @@ -785,6 +841,10 @@ ecore_ipc_server_flush(Ecore_Ipc_Server *svr) * @ingroup Ecore_IPC_Client_Group * @todo This function needs to become an IPC message. * @todo Make sure ref_to and response parameters are described correctly. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size) @@ -835,6 +895,10 @@ ecore_ipc_client_send(Ecore_Ipc_Client *cl, int major, int minor, int ref, int r * @param cl The given IPC client. * @return The IPC server the IPC client is connected to. * @ingroup Ecore_IPC_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Ecore_Ipc_Server * ecore_ipc_client_server_get(Ecore_Ipc_Client *cl) @@ -854,6 +918,10 @@ ecore_ipc_client_server_get(Ecore_Ipc_Client *cl) * @param cl The given client. * @return Data associated with the client. * @ingroup Ecore_IPC_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_ipc_client_del(Ecore_Ipc_Client *cl) @@ -888,6 +956,10 @@ ecore_ipc_client_del(Ecore_Ipc_Client *cl) * @param cl The given IPC client. * @param data The data to associate with the IPC client. * @ingroup Ecore_IPC_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data) @@ -906,6 +978,10 @@ ecore_ipc_client_data_set(Ecore_Ipc_Client *cl, const void *data) * @param cl The given client. * @return The data associated with the IPC client. * @ingroup Ecore_IPC_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * ecore_ipc_client_data_get(Ecore_Ipc_Client *cl) @@ -925,6 +1001,10 @@ ecore_ipc_client_data_get(Ecore_Ipc_Client *cl) * @param cl The given client. * @param size The maximum data payload size in bytes. * @ingroup Ecore_Ipc_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size) @@ -944,6 +1024,10 @@ ecore_ipc_client_data_size_max_set(Ecore_Ipc_Client *cl, int size) * @param cl The given client. * @return The maximum data payload size in bytes on success, @c -1 on failure. * @ingroup Ecore_Ipc_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl) @@ -967,6 +1051,10 @@ ecore_ipc_client_data_size_max_get(Ecore_Ipc_Client *cl) * deletion for the @p cl object. If no IP is known @c NULL is * returned. * @ingroup Ecore_Ipc_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl) @@ -985,6 +1073,10 @@ ecore_ipc_client_ip_get(Ecore_Ipc_Client *cl) * * @param cl The given client. * @ingroup Ecore_Ipc_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void ecore_ipc_client_flush(Ecore_Ipc_Client *cl) @@ -1002,6 +1094,10 @@ ecore_ipc_client_flush(Ecore_Ipc_Client *cl) * Returns if SSL support is available * @return 1 if SSL is available, 0 if it is not. * @ingroup Ecore_Con_Client_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int ecore_ipc_ssl_available_get(void) diff --git a/src/lib/ecore_wayland/Ecore_Wayland.h b/src/lib/ecore_wayland/Ecore_Wayland.h index b6d6e40..91d232f 100644 --- a/src/lib/ecore_wayland/Ecore_Wayland.h +++ b/src/lib/ecore_wayland/Ecore_Wayland.h @@ -443,6 +443,8 @@ struct _Ecore_Wl_Event_Indicator_Flick /** * @internal * + * @internal + * * @file * @brief Ecore functions for dealing with the Wayland window system * @@ -508,6 +510,8 @@ EAPI extern int ECORE_WL_EVENT_INDICATOR_FLICK; /** * @internal * + * @internal + * * Initialize the Wayland display connection to the given display. * * @param name Display target name. if @c NULL, the default display is @@ -522,6 +526,8 @@ EAPI int ecore_wl_init(const char *name); /** * @internal * + * @internal + * * Shuts down the Ecore Wayland Library * * In shutting down the library, the Wayland display connection is terminated @@ -547,6 +553,8 @@ EAPI int ecore_wl_shutdown(void); /** * @internal * + * @internal + * * Sends all Wayland commands to the Wayland Display. * * @ingroup Ecore_Wl_Flush_Group @@ -557,6 +565,8 @@ EAPI void ecore_wl_flush(void); /** * @internal * + * @internal + * * Flushes the command buffer and waits until all requests have been * processed by the server. * @@ -577,6 +587,8 @@ EAPI void ecore_wl_sync(void); /** * @internal * + * @internal + * * Retrieves the Wayland Shm Interface used for the current Wayland connection. * * @return The current wayland shm interface, or NULL on error @@ -589,6 +601,8 @@ EAPI struct wl_shm *ecore_wl_shm_get(void); /** * @internal * + * @internal + * * Retrieves the Wayland Display Interface used for the current Wayland connection. * * @return The current wayland display interface, or NULL on error @@ -611,6 +625,8 @@ EAPI struct wl_display *ecore_wl_display_get(void); /** * @internal * + * @internal + * * Retrieves the size of the current screen. * * @param w where to return the width. May be NULL. Returns 0 on error. @@ -624,6 +640,8 @@ EAPI void ecore_wl_screen_size_get(int *w, int *h); /** * @internal * + * @internal + * * Retrieves the position of the current screen. * * @param x where to return the horizontal position. May be NULL. Returns 0 on error. @@ -637,6 +655,8 @@ EAPI void ecore_wl_pointer_xy_get(int *x, int *y); /** * @internal * + * @internal + * * Return the screen DPI * * This is a simplistic call to get DPI. It does not account for differing @@ -652,6 +672,8 @@ EAPI int ecore_wl_dpi_get(void); /** * @internal * + * @internal + * * Dispatch Wayland events * * Dispatches any events queued on the default queue. Wayland will attempt @@ -669,6 +691,8 @@ EAPI Eina_Bool ecore_wl_animator_source_set(Ecore_Animator_Source source); /** * @internal * + * @internal + * * Retrieves the requested cursor from the cursor theme * * @param cursor_name The desired cursor name to be looked up in the theme @@ -690,6 +714,8 @@ EAPI struct wl_cursor *ecore_wl_cursor_get(const char *cursor_name); /** * @internal * + * @internal + * * @ingroup Ecore_Wl_Input_Group * @since 1.8 */ @@ -706,6 +732,8 @@ EAPI Eina_Inlist *ecore_wl_outputs_get(void); /** * @internal * + * @internal + * * @ingroup Ecore_Wl_Input_Group * @since 1.12 */ @@ -722,6 +750,8 @@ EAPI struct xkb_keymap *ecore_wl_input_keymap_get(Ecore_Wl_Input *input); /** * @internal * + * @internal + * * Retrieves the Wayland Globals Interface list used for the current Wayland connection. * * This call, if done after the ECORE_WL_EVENT_INTERFACES_BOUND event was @@ -743,6 +773,8 @@ EAPI Eina_Inlist *ecore_wl_globals_get(void); /** * @internal * + * @internal + * * Retrieves the Wayland Registry used for the current Wayland connection. * * @return The current wayland registry, or NULL on error @@ -764,6 +796,8 @@ EAPI struct wl_registry *ecore_wl_registry_get(void); /** * @internal * + * @internal + * * Creates a new window * * @param parent The parent window to use. If @p parent is @c 0, the root window @@ -784,6 +818,8 @@ EAPI Ecore_Wl_Window *ecore_wl_window_new(Ecore_Wl_Window *parent, int x, int y, /** * @internal * + * @internal + * * Deletes the given window * * @param win The given window @@ -796,6 +832,8 @@ EAPI void ecore_wl_window_free(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Signals for Wayland to initiate a window move. * * The position requested (@p x, @p y) is not honored by Wayland because @@ -813,6 +851,8 @@ EAPI void ecore_wl_window_move(Ecore_Wl_Window *win, int x, int y); /** * @internal * + * @internal + * * Signals for Wayland to initiate a window resize. * * The size requested (@p w, @p h) is not honored by Wayland because @@ -837,6 +877,8 @@ EAPI void ecore_wl_window_commit(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Shows a window * * Synonymous to "mapping" a window in Wayland System terminology. @@ -851,6 +893,8 @@ EAPI void ecore_wl_window_show(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Hides a window * * Synonymous to "unmapping" a window in Wayland System terminology. @@ -865,6 +909,8 @@ EAPI void ecore_wl_window_hide(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Raises a window * * @param win The window to raise. @@ -902,6 +948,8 @@ EAPI int ecore_wl_window_active_angle_get(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Iconify a window * * @param win The window to iconifiy @@ -926,6 +974,8 @@ EAPI void ecore_wl_window_stack_mode_set(Ecore_Wl_Window *win, Ecore_Wl_Window_S /** * @internal * + * @internal + * * Returns a wl_surface with no association to any wl_shell_surface. * * @param win The window which will use this newly created surface. @@ -942,6 +992,8 @@ EAPI Eina_Bool ecore_wl_window_alpha_get(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Returns the Ecore_Wl_Window from a wl_surface * * @param surface The surface for which to find the Ecore_Wl_Window from @@ -990,6 +1042,8 @@ EAPI void ecore_wl_window_input_rect_subtract(Ecore_Wl_Window *win, Eina_Rectang /** * @internal * + * @internal + * * Set the input region of the Ecore_Wl_Window. * * To set an empty region, pass width and height as 0. @@ -1010,6 +1064,8 @@ EAPI void ecore_wl_window_input_region_set(Ecore_Wl_Window *win, int x, int y, i /** * @internal * + * @internal + * * Set the opaque region of the Ecore_Wl_Window * * @param win The window @@ -1026,6 +1082,8 @@ EAPI void ecore_wl_window_opaque_region_set(Ecore_Wl_Window *win, int x, int y, /** * @internal * + * @internal + * * Set the rotation of the Ecore_Wl_Window * * @param win The window @@ -1039,6 +1097,8 @@ EAPI void ecore_wl_window_rotation_set(Ecore_Wl_Window *win, int rotation); /** * @internal * + * @internal + * * Get the rotation of the Ecore_Wl_Window * * @param win The window @@ -1061,6 +1121,8 @@ EAPI int ecore_wl_window_rotation_get(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * @deprecated use ecore_wl_dnd_selection_set * @since 1.7 */ @@ -1069,6 +1131,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_set_selection(Ecore_Wl_Dnd *dnd, con /** * @internal * + * @internal + * * @deprecated use ecore_wl_dnd_selection_get * @since 1.7 */ @@ -1077,6 +1141,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_get_selection(Ecore_Wl_Dnd *dnd, con /** * @internal * + * @internal + * * @deprecated Do Not Use * @since 1.7 */ @@ -1085,6 +1151,8 @@ EINA_DEPRECATED EAPI Ecore_Wl_Dnd *ecore_wl_dnd_get(void); /** * @internal * + * @internal + * * @deprecated use ecore_wl_dnd_drag_start * @since 1.7 */ @@ -1093,6 +1161,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_start_drag(Ecore_Wl_Dnd *dnd); /** * @internal * + * @internal + * * @deprecated use ecore_wl_dnd_selection_owner_has * @since 1.7 */ @@ -1101,6 +1171,8 @@ EINA_DEPRECATED EAPI Eina_Bool ecore_wl_dnd_selection_has_owner(Ecore_Wl_Dnd *dn /** * @internal * + * @internal + * * @return false on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1111,6 +1183,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_set(Ecore_Wl_Input *input, const char **ty /** * @internal * + * @internal + * * @return false if type not found or on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1121,6 +1195,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_get(Ecore_Wl_Input *input, const char *typ /** * @internal * + * @internal + * * @return true if input has a selection source, false otherwise or on error * * @ingroup Ecore_Wl_Dnd_Group @@ -1131,6 +1207,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_owner_has(Ecore_Wl_Input *input); /** * @internal * + * @internal + * * @return false on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1141,6 +1219,8 @@ EAPI Eina_Bool ecore_wl_dnd_selection_clear(Ecore_Wl_Input *input); /** * @internal * + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ @@ -1149,6 +1229,8 @@ EAPI void ecore_wl_dnd_drag_start(Ecore_Wl_Input *input, Ecore_Wl_Window *win, E /** * @internal * + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ @@ -1157,6 +1239,8 @@ EAPI void ecore_wl_dnd_drag_end(Ecore_Wl_Input *input); /** * @internal * + * @internal + * * @return false if type not found or on error, true otherwise * * @ingroup Ecore_Wl_Dnd_Group @@ -1167,6 +1251,8 @@ EAPI Eina_Bool ecore_wl_dnd_drag_get(Ecore_Wl_Input *input, const char *type); /** * @internal * + * @internal + * * @ingroup Ecore_Wl_Dnd_Group * @since 1.8 */ @@ -1175,6 +1261,8 @@ EAPI void ecore_wl_dnd_drag_types_set(Ecore_Wl_Input *input, const char **types_ /** * @internal * + * @internal + * * @return the data types being offered for drag-and-drop, or NULL on error * * @ingroup Ecore_Wl_Dnd_Group @@ -1191,6 +1279,8 @@ EAPI struct wl_array *ecore_wl_dnd_drag_types_get(Ecore_Wl_Input *input); /** * @internal * + * @internal + * * Enable/disable server mode. * * With this enabled, the compositor acts as a Wayland server, iterating @@ -1220,6 +1310,8 @@ EAPI Eina_Bool ecore_wl_server_mode_get(void); /** * @internal * + * @internal + * * Create and return a new subsurface. * * Create a new surface (and subsurface interface), with the parent surface @@ -1239,6 +1331,8 @@ EAPI Ecore_Wl_Subsurf *ecore_wl_subsurf_create(Ecore_Wl_Window *win); /** * @internal * + * @internal + * * Destroy the given subsurface, as well as the surface associated with it. * * @param ess the subsurface @@ -1251,6 +1345,8 @@ EAPI void ecore_wl_subsurf_del(Ecore_Wl_Subsurf *ess); /** * @internal * + * @internal + * * Get the wl_surface for this subsurface * * @param ess the subsurface @@ -1264,6 +1360,8 @@ EAPI struct wl_surface *ecore_wl_subsurf_surface_get(Ecore_Wl_Subsurf *ess); /** * @internal * + * @internal + * * Set the position of this subsurface, relative to its parent surface. * If ess is defined and the x, y coordinates differ from the currently * tracked position, this also schedules a sub-surface position change. @@ -1280,6 +1378,8 @@ EAPI void ecore_wl_subsurf_position_set(Ecore_Wl_Subsurf *ess, int x, int y); /** * @internal * + * @internal + * * Get the position of this subsurface, relative to its parent surface. * Coordinates will be returned in x and y if non-NULL. * @@ -1295,6 +1395,8 @@ EAPI void ecore_wl_subsurf_position_get(Ecore_Wl_Subsurf *ess, int *x, int *y); /** * @internal * + * @internal + * * Place subsurface on layer above a reference surface * * Moves the @param ess subsurface to just above the reference @param @@ -1313,6 +1415,8 @@ EAPI void ecore_wl_subsurf_place_above(Ecore_Wl_Subsurf *ess, struct wl_surface /** * @internal * + * @internal + * * Place subsurface on layer below a reference surface * * See ecore_wl_subsurf_place_above. @@ -1328,6 +1432,8 @@ EAPI void ecore_wl_subsurf_place_below(Ecore_Wl_Subsurf *ess, struct wl_surface /** * @internal * + * @internal + * * Enables or disables sub-surface synchronization * * When synchronization is enabled, surface commits on the subsurface @@ -1358,6 +1464,8 @@ EAPI void ecore_wl_subsurf_sync_set(Ecore_Wl_Subsurf *ess, Eina_Bool val); /** * @internal * + * @internal + * * Set an opaque region for the given subsurface. * * This is an optimization hint to the compositor to allow it avoid diff --git a/src/lib/ecore_x/Ecore_X.h b/src/lib/ecore_x/Ecore_X.h index 7d051f1..5bc8602 100644 --- a/src/lib/ecore_x/Ecore_X.h +++ b/src/lib/ecore_x/Ecore_X.h @@ -1846,6 +1846,8 @@ EAPI void ecore_x_e_comp_pixmap_set(Ecore_X_Window wi EAPI Ecore_X_Pixmap ecore_x_e_comp_pixmap_get(Ecore_X_Window win); /** + * @internal + * * @brief Get the window profile * * @param win The client x window @@ -1853,6 +1855,8 @@ EAPI Ecore_X_Pixmap ecore_x_e_comp_pixmap_get(Ecore_X_Window wi */ EAPI char *ecore_x_e_window_profile_get(Ecore_X_Window win); /** + * @internal + * * @brief Set the window profile * * @param win The client x window @@ -1860,6 +1864,8 @@ EAPI char *ecore_x_e_window_profile_get(Ecore_X_Windo */ EAPI void ecore_x_e_window_profile_set(Ecore_X_Window win, const char *profile); /** + * @internal + * * @brief Set the array of window profiles * * @param win The client x window @@ -1870,6 +1876,8 @@ EAPI void ecore_x_e_window_profile_set(Ecore_X_Windo */ EAPI void ecore_x_e_window_profile_list_set(Ecore_X_Window win, const char **profiles, unsigned int num_profiles); /** + * @internal + * * @brief Get the array of window profiles * * @param win The client x window @@ -1881,6 +1889,8 @@ EAPI void ecore_x_e_window_profile_list_set(Ecore_X_ */ EAPI Eina_Bool ecore_x_e_window_profile_list_get(Ecore_X_Window win, const char ***profiles, int *ret_num); /** + * @internal + * * @brief Set the status for the window profile support * * @param root The root window @@ -1890,6 +1900,8 @@ EAPI Eina_Bool ecore_x_e_window_profile_list_get(Ecore_X_ */ EAPI void ecore_x_e_window_profile_supported_set(Ecore_X_Window root, Eina_Bool enabled); /** + * @internal + * * @brief Query if the window profile is supported * * @param root The root window @@ -1899,6 +1911,8 @@ EAPI void ecore_x_e_window_profile_supported_set(Eco */ EAPI Eina_Bool ecore_x_e_window_profile_supported_get(Ecore_X_Window root); /** + * @internal + * * @brief Set the array of available window profiles * * @param win The client x window @@ -1909,6 +1923,8 @@ EAPI Eina_Bool ecore_x_e_window_profile_supported_get(Eco */ EAPI void ecore_x_e_window_available_profiles_set(Ecore_X_Window win, const char **profiles, unsigned int count); /** + * @internal + * * @brief Get the array of avaialbe window profiles * * @param win The client x window @@ -1920,6 +1936,8 @@ EAPI void ecore_x_e_window_available_profiles_set(Ec */ EAPI Eina_Bool ecore_x_e_window_available_profiles_get(Ecore_X_Window win, const char ***profiles, int *count); /** + * @internal + * * @brief Send a profile change event to the window manager * * This function sends a request to the window manager to change the profile. @@ -1935,6 +1953,8 @@ EAPI Eina_Bool ecore_x_e_window_available_profiles_get(Ec */ EAPI void ecore_x_e_window_profile_change_send(Ecore_X_Window root, Ecore_X_Window win, const char *profile); /** + * @internal + * * @brief Send a profile change request event to the client * * This function sends a request to the client to change the profile. @@ -1948,6 +1968,8 @@ EAPI void ecore_x_e_window_profile_change_send(Ecore */ EAPI void ecore_x_e_window_profile_change_request_send(Ecore_X_Window win, const char *profile); /** + * @internal + * * @brief Send a profile change done event to the window manager * * This function sends a profile change done event to the window manager. @@ -2118,6 +2140,8 @@ EAPI Eina_Bool ecore_x_randr_screen_primary_outp EAPI Ecore_X_Randr_Screen_Size_MM *ecore_x_randr_screen_primary_output_sizes_get(Ecore_X_Window root, int *num); /** + * @internal + * * @brief get the current set size of a given screen's primary output * @param root window which's primary output will be queried * @param w the current size's width @@ -2188,6 +2212,8 @@ EAPI Ecore_X_Randr_Crtc_Gamma_Info *ecore_x_randr_crtc_gamma_get(Ecor EAPI Eina_Bool ecore_x_randr_crtc_gamma_set(Ecore_X_Randr_Crtc crtc, const Ecore_X_Randr_Crtc_Gamma_Info *gamma); /**< @since 1.8 */ /** + * @internal + * * @brief Validates the header from raw EDID data. * * @param edid The edid structure. @@ -2197,6 +2223,8 @@ EAPI Eina_Bool ecore_x_randr_crtc_gamma_set(Ecor EAPI Eina_Bool ecore_x_randr_edid_has_valid_header(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Checks whether a display's EDID has a valid checksum. * * @param edid The edid structure. @@ -2206,6 +2234,8 @@ EAPI Eina_Bool ecore_x_randr_edid_has_valid_head EAPI Eina_Bool ecore_x_randr_edid_info_has_valid_checksum(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded version from raw EDID data. * * The return value has the minor version in the lowest 8 bits, and the major @@ -2221,6 +2251,8 @@ EAPI Eina_Bool ecore_x_randr_edid_info_has_valid EAPI int ecore_x_randr_edid_version_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded manufacturer from raw EDID data. * * @param edid the edid structure @@ -2230,6 +2262,8 @@ EAPI int ecore_x_randr_edid_version_get(un EAPI char *ecore_x_randr_edid_manufacturer_name_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded name from raw EDID data. * * @param edid the edid structure @@ -2239,6 +2273,8 @@ EAPI char *ecore_x_randr_edid_manufacturer_n EAPI char *ecore_x_randr_edid_display_name_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded ASCII from raw EDID data. * * @param edid the edid structure @@ -2248,6 +2284,8 @@ EAPI char *ecore_x_randr_edid_display_name_g EAPI char *ecore_x_randr_edid_display_ascii_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded serial identifier from raw EDID data. * * @param edid the edid structure @@ -2257,6 +2295,8 @@ EAPI char *ecore_x_randr_edid_display_ascii_ EAPI char *ecore_x_randr_edid_display_serial_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the encoded model number from raw EDID data. * * The manufacturer ID table is necessary for a useful description. @@ -2268,6 +2308,8 @@ EAPI char *ecore_x_randr_edid_display_serial EAPI int ecore_x_randr_edid_model_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the manufacturer serial number from raw EDID data. * * @param edid the edid structure @@ -2277,6 +2319,8 @@ EAPI int ecore_x_randr_edid_model_get(unsi EAPI int ecore_x_randr_edid_manufacturer_serial_number_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the manufacturer model number from raw EDID data. * * @param edid the edid structure @@ -2286,6 +2330,8 @@ EAPI int ecore_x_randr_edid_manufacturer_s EAPI int ecore_x_randr_edid_manufacturer_model_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Looks up the DPMS support from raw EDID data. * * @param edid The edid structure. @@ -2296,6 +2342,8 @@ EAPI int ecore_x_randr_edid_manufacturer_m EAPI Eina_Bool ecore_x_randr_edid_dpms_available_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Looks up the DPMS Standby support from raw EDID data. * * @param edid The edid structure. @@ -2305,6 +2353,8 @@ EAPI Eina_Bool ecore_x_randr_edid_dpms_available EAPI Eina_Bool ecore_x_randr_edid_dpms_standby_available_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Looks up the DPMS Suspend support from raw EDID data. * * @param edid The edid structure. @@ -2314,6 +2364,8 @@ EAPI Eina_Bool ecore_x_randr_edid_dpms_standby_a EAPI Eina_Bool ecore_x_randr_edid_dpms_suspend_available_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Looks up the DPMS Off support from raw EDID data. * * @param edid The edid structure. @@ -2323,6 +2375,8 @@ EAPI Eina_Bool ecore_x_randr_edid_dpms_suspend_a EAPI Eina_Bool ecore_x_randr_edid_dpms_off_available_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the preferred aspect ratio from raw EDID data. * * @param edid the edid structure @@ -2332,6 +2386,8 @@ EAPI Eina_Bool ecore_x_randr_edid_dpms_off_avail EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect_ratio_preferred_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the supported aspect ratios from raw EDID data. * * @param edid the edid structure @@ -2341,6 +2397,8 @@ EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect_ratios_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the supported colorschemes from raw EDID data. * * @param edid the edid structure @@ -2350,6 +2408,8 @@ EAPI Ecore_X_Randr_Edid_Aspect_Ratio ecore_x_randr_edid_display_aspect EAPI Ecore_X_Randr_Edid_Display_Colorscheme ecore_x_randr_edid_display_colorscheme_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the display type from raw EDID data. * * @param edid The edid structure. @@ -2360,6 +2420,8 @@ EAPI Ecore_X_Randr_Edid_Display_Colorscheme ecore_x_randr_edid_display_colors EAPI Eina_Bool ecore_x_randr_edid_display_type_digital_get(unsigned char *edid, unsigned long edid_length); /** + * @internal + * * @brief Get the display interface type from raw EDID data. * * @param edid the edid structure @@ -2423,6 +2485,8 @@ EAPI void ecore_x_region_window_shape_set(Ecore_X_Region region, E EAPI void ecore_x_region_picture_clip_set(Ecore_X_Region region, Ecore_X_Picture picture, int x_origin, int y_origin); /** + * @internal + * * xfixes selection notification request. * * This lets you choose which selections you want to get notifications for. @@ -2445,17 +2509,33 @@ EAPI Ecore_X_Window ecore_x_composite_render_window_enable(Ecore_X_Window ro EAPI void ecore_x_composite_render_window_disable(Ecore_X_Window root); /* XPresent Extension Support */ -/** @since 1.9 */ +/** + * @internal + * + * @since 1. + */ EAPI void ecore_x_present_select_events(Ecore_X_Window win, unsigned int events); -/** @since 1.9 */ +/** + * @internal + * + * @since 1. + */ EAPI void ecore_x_present_notify_msc(Ecore_X_Window win, unsigned int serial, unsigned long long target_msc, unsigned long long divisor, unsigned long long remainder); -/** @since 1.9 */ +/** + * @internal + * + * @since 1. + */ EAPI void ecore_x_present_pixmap(Ecore_X_Window win, Ecore_X_Pixmap pixmap, unsigned int serial, Ecore_X_Region valid, Ecore_X_Region update, int x_off, int y_off, Ecore_X_Randr_Crtc target_crtc, Ecore_X_Sync_Fence wait_fence, Ecore_X_Sync_Fence idle_fence, unsigned int options, unsigned long long target_msc, unsigned long long divisor, unsigned long long remainder, Ecore_X_Present *notifies, int num_notifies); -/** @since 1.9 */ +/** + * @internal + * + * @since 1. + */ EAPI Eina_Bool ecore_x_present_exists(void); /* XDamage Extension Support */ @@ -2516,6 +2596,8 @@ EAPI Eina_Bool ecore_x_test_fake_key_press(const char *key); EAPI const char *ecore_x_keysym_string_get(int keysym); /** + * @internal + * * Given a keyname, return the keycode representing that key * @param keyname The key from which to get the keycode. * @return The keycode of the key. @@ -2525,6 +2607,8 @@ EAPI const char *ecore_x_keysym_string_get(int keysym); EAPI int ecore_x_keysym_keycode_get(const char *keyname); /** + * @internal + * * Return the X-specific keysym for a given key string * @param string The key to get the keysym for * @return the keysym value diff --git a/src/lib/edje/Edje_Common.h b/src/lib/edje/Edje_Common.h index 0d70053..96fac12 100644 --- a/src/lib/edje/Edje_Common.h +++ b/src/lib/edje/Edje_Common.h @@ -70,6 +70,10 @@ typedef void (*Edje_Signal_Cb) (void *data, Evas_Object *obj, c * * @see edje_object_signal_callback_add() for more on Edje signals. * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void * edje_object_signal_callback_extra_data_get(void); @@ -108,6 +112,9 @@ EAPI void * edje_object_signal_callback_extra_data_get(void); * @see embryo_init() * @see eet_init() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int edje_init (void); @@ -129,6 +136,9 @@ EAPI int edje_init (void); * @see embryo_shutdown() * @see eet_shutdown() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int edje_shutdown (void); @@ -139,6 +149,9 @@ EAPI int edje_shutdown (void); * * This function sets the edje append fontset. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_fontset_append_set (const char *fonts); @@ -158,6 +171,10 @@ EAPI void edje_fontset_append_set (const char *fonts); * collections { ... } * * Then, edje_file_data_get("test.edj", "key1") will return "value1" + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char *edje_mmap_data_get(const Eina_File *f, const char *key); @@ -179,6 +196,10 @@ EAPI char *edje_mmap_data_get(const Eina_File *f, const char *key); * Then, edje_file_data_get("test.edj", "key1") will return "value1" * * @see edje_mmap_data_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *edje_file_data_get (const char *file, const char *key); @@ -190,6 +211,9 @@ EAPI char *edje_file_data_get (const char *file, const char * Modules are used to add functionality to Edje. * So, when a module is loaded, its functionality should be available for use. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_module_load (const char *module); @@ -201,6 +225,9 @@ EAPI Eina_Bool edje_module_load (const char *module * * @see edje_module_load(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_List *edje_available_modules_get (void); @@ -214,6 +241,9 @@ EAPI const Eina_List *edje_available_modules_get (void); * * @see edje_fontset_append_set(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *edje_fontset_append_get (void); @@ -229,6 +259,9 @@ EAPI const char *edje_fontset_append_get (void); * @see edje_file_cache_get() * @see edje_file_cache_flush() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_file_cache_set (int count); @@ -243,6 +276,9 @@ EAPI void edje_file_cache_set (int count); * @see edje_file_cache_set() * @see edje_file_cache_flush() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int edje_file_cache_get (void); @@ -255,6 +291,9 @@ EAPI int edje_file_cache_get (void); * @see edje_file_cache_set() * @see edje_file_cache_get() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_file_cache_flush (void); @@ -271,6 +310,9 @@ EAPI void edje_file_cache_flush (void); * @see edje_collection_cache_get() * @see edje_collection_cache_flush() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_collection_cache_set (int count); @@ -285,6 +327,9 @@ EAPI void edje_collection_cache_set (int count); * @see edje_collection_cache_set() * @see edje_collection_cache_flush() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int edje_collection_cache_get (void); @@ -297,6 +342,9 @@ EAPI int edje_collection_cache_get (void); * @see edje_collection_cache_set() * @see edje_collection_cache_get() * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_collection_cache_flush (void); @@ -344,6 +392,10 @@ typedef enum _Edje_External_Param_Flags * * @param type the identifier to convert. * @return the string with the string representation, or @c "(unknown)". + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *edje_external_param_type_str(Edje_External_Param_Type type) EINA_PURE; @@ -587,6 +639,10 @@ typedef struct _Edje_External_Type_Info Edje_External_Type_Info; * type already registered). * * @see edje_external_type_array_register() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_type_register (const char *type_name, const Edje_External_Type *type_info); @@ -600,6 +656,10 @@ EAPI Eina_Bool edje_external_type_register (const char *type_name * type_name did not exist). * * @see edje_external_type_array_unregister() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_type_unregister (const char *type_name); @@ -625,6 +685,10 @@ EAPI Eina_Bool edje_external_type_unregister (const char *type_name * type already registered). * * @see edje_external_type_register() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_external_type_array_register (const Edje_External_Type_Info *array); @@ -635,6 +699,10 @@ EAPI void edje_external_type_array_register (const Edje_External_T * one used to register with edje_external_type_array_register() * * @see edje_external_type_unregister() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_external_type_array_unregister (const Edje_External_Type_Info *array); @@ -656,6 +724,10 @@ EAPI void edje_external_type_array_unregister (const Edje_External_T * * @return The external ABI version the Edje library was compiled with. That * is, the value #EDJE_EXTERNAL_TYPE_ABI_VERSION had at that moment. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI unsigned int edje_external_type_abi_version_get (void) EINA_CONST; @@ -701,6 +773,10 @@ EAPI unsigned int edje_external_type_abi_version_get (void) EINA_CONST; * } * * @endcode + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *edje_external_iterator_get (void); @@ -711,6 +787,10 @@ EAPI Eina_Iterator *edje_external_iterator_get (void); * @param key The parameter to look for * * @return The matching #Edje_External_Param or NULL if it's not found. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Edje_External_Param *edje_external_param_find (const Eina_List *params, const char *key); @@ -729,6 +809,10 @@ EAPI Edje_External_Param *edje_external_param_find (const Eina_ * * @return EINA_TRUE if the parameter was found and is of integer type, * EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_param_int_get (const Eina_List *params, const char *key, int *ret); @@ -747,6 +831,10 @@ EAPI Eina_Bool edje_external_param_int_get (const Eina_ * * @return EINA_TRUE if the parameter was found and is of double type, * EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_param_double_get (const Eina_List *params, const char *key, double *ret); @@ -767,6 +855,10 @@ EAPI Eina_Bool edje_external_param_double_get (const Eina_ * * @return EINA_TRUE if the parameter was found and is of string type, * EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_param_string_get (const Eina_List *params, const char *key, const char **ret); @@ -785,6 +877,10 @@ EAPI Eina_Bool edje_external_param_string_get (const Eina_ * * @return EINA_TRUE if the parameter was found and is of boolean type, * EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_param_bool_get (const Eina_List *params, const char *key, Eina_Bool *ret); @@ -805,6 +901,10 @@ EAPI Eina_Bool edje_external_param_bool_get (const Eina_ * * @return EINA_TRUE if the parameter was found and is of integer type, * EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_external_param_choice_get (const Eina_List *params, const char *key, const char **ret); @@ -821,12 +921,20 @@ EAPI Eina_Bool edje_external_param_choice_get (const Eina_ * it does not have any parameter information. * * @see edje_external_type_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Edje_External_Param_Info *edje_external_param_info_get (const char *type_name); /** * Get the #Edje_External_Type that defines an EXTERNAL type registered with * the name @p type_name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Edje_External_Type *edje_external_type_get (const char *type_name); @@ -888,6 +996,10 @@ EAPI const Edje_External_Type *edje_external_type_get (const char * complete @ref edcref "syntax reference" for EDC files. * * @see edje_scale_get(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_scale_set (double scale); @@ -900,6 +1012,9 @@ EAPI void edje_scale_set (double scale); * * @see edje_scale_set() for more details * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double edje_scale_get (void); @@ -1022,6 +1137,10 @@ typedef Evas_Object *(*Edje_Item_Provider_Cb) (void *data, Evas_Object *obj, c * The time out value is obtained by edje_password_show_last_timeout_set function. * * @see edje_password_show_last_timeout_set(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_password_show_last_set(Eina_Bool password_show_last); @@ -1037,6 +1156,9 @@ EAPI void edje_password_show_last_set(Eina_Bool password_show_last); * * @see edje_password_show_last_set(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_password_show_last_timeout_set(double password_show_last_timeout); @@ -1100,6 +1222,10 @@ EAPI void edje_password_show_last_timeout_set(double password_show_last_timeout) * half-transparent white is 255 255 255 128. * * @return Eina_Bool, EINA_TRUE on success and EINA_FALSE on failure. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_color_class_set (const char *color_class, int r, int g, int b, int a, int r2, int g2, int b2, int a2, int r3, int g3, int b3, int a3); @@ -1136,6 +1262,10 @@ EAPI Eina_Bool edje_color_class_set (const char *color_class, int * * @note unlike Evas, Edje colors are @b not pre-multiplied. That is, * half-transparent white is 255 255 255 128. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_color_class_get (const char *color_class, int *r, int *g, int *b, int *a, int *r2, int *g2, int *b2, int *a2, int *r3, int *g3, int *b3, int *a3); @@ -1151,6 +1281,10 @@ EAPI Eina_Bool edje_color_class_get (const char *color_class, int * * Deleting the color class will emit the signal "color_class,del" * to all the Edje objects in the running program. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_color_class_del (const char *color_class); @@ -1163,6 +1297,9 @@ EAPI void edje_color_class_del (const char *color_class); * This function lists all color classes known about by the current * process. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *edje_color_class_list (void); @@ -1175,6 +1312,10 @@ EAPI Eina_List *edje_color_class_list (void); * an application. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *edje_color_class_active_iterator_new(void); @@ -1184,6 +1325,10 @@ EAPI Eina_Iterator *edje_color_class_active_iterator_new(void); * @return an iterator of Edje_Color_Class provided by the Edje file. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *edje_mmap_color_class_iterator_new(Eina_File *f); @@ -1467,6 +1612,10 @@ typedef enum _Edje_Aspect_Control * function passed to func. layout_data_get will be called with data * as its parameter, and this one will be freed by free_data whenever * the layout is unregistered from Edje. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_box_layout_register (const char *name, Evas_Object_Box_Layout func, void *(*layout_data_get)(void *), void (*layout_data_free)(void *), void (*free_data)(void *), void *data); @@ -1542,6 +1691,9 @@ typedef enum _Edje_Object_Table_Homogeneous_Mode * * @see edje_text_class_get(). * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_text_class_set (const char *text_class, const char *font, Evas_Font_Size size); @@ -1560,6 +1712,10 @@ EAPI Eina_Bool edje_text_class_set (const char *text_class, const * @see edje_text_class_set(). * * @since 1.14 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_text_class_get (const char *text_class, const char **font, Evas_Font_Size *size); @@ -1571,6 +1727,9 @@ EAPI Eina_Bool edje_text_class_get (const char *text_class, const * This function deletes any values at the process level for the * specified text class. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_text_class_del (const char *text_class); @@ -1583,6 +1742,9 @@ EAPI void edje_text_class_del (const char *text_class); * This function lists all text classes known about by the current * process. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *edje_text_class_list (void); @@ -1618,6 +1780,10 @@ EAPI Eina_List *edje_text_class_list (void); * * Note: the list must be freed using edje_mmap_collection_list_free() * when you are done with it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List *edje_mmap_collection_list(Eina_File *f); @@ -1626,6 +1792,10 @@ EAPI Eina_List *edje_mmap_collection_list(Eina_File *f); * @param lst The Eina_List of groups * * Frees the list returned by edje_mmap_collection_list(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_mmap_collection_list_free(Eina_List *lst); @@ -1635,6 +1805,10 @@ EAPI void edje_mmap_collection_list_free(Eina_List *lst); * @param glob A glob to match on * * @return 1 if a match is found, 0 otherwise + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_mmap_group_exists(Eina_File *f, const char *glob); @@ -1644,6 +1818,10 @@ EAPI Eina_Bool edje_mmap_group_exists(Eina_File *f, const char *glob); * @return an iterator of Eina_File currently opened Edje file. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *edje_file_iterator_new(void); @@ -1658,6 +1836,10 @@ EAPI Eina_Iterator *edje_file_iterator_new(void); * when you are done with it. * * @see edje_mmap_group_exists() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *edje_file_collection_list (const char *file); @@ -1666,6 +1848,10 @@ EAPI Eina_List *edje_file_collection_list (const char *file); * @param lst The Eina_List of groups * * Frees the list returned by edje_file_collection_list(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_file_collection_list_free (Eina_List *lst); @@ -1675,6 +1861,10 @@ EAPI void edje_file_collection_list_free (Eina_List *lst); * @param glob A glob to match on * * @return 1 if a match is found, 0 otherwise + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_file_group_exists (const char *file, const char *glob); @@ -1691,6 +1881,10 @@ EAPI Eina_Bool edje_file_group_exists (const char *file, const char * edje_object_load_error_get(). The function in question is meant * to be used in conjunction with the latter, for pretty-printing any * possible error cause. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *edje_load_error_str (Edje_Load_Error error); @@ -1795,6 +1989,9 @@ typedef enum _Edje_Action_Type * * @see edje_frametime_get() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_frametime_set (double t); @@ -1808,6 +2005,9 @@ EAPI void edje_frametime_set (double t); * * @see edje_frametime_set() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI double edje_frametime_get (void); @@ -1820,6 +2020,9 @@ EAPI double edje_frametime_get (void); * * @see edje_thaw() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_freeze (void); @@ -1832,6 +2035,9 @@ EAPI void edje_freeze (void); * * @see edje_freeze() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_thaw (void); @@ -1843,6 +2049,10 @@ EAPI void edje_thaw (void); * @note: emits signal edje,language,"locale". * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_language_set (const char *locale); @@ -1866,6 +2076,10 @@ EAPI void edje_language_set (const char *locale); * @see edje_transition_duration_factor_get() * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_transition_duration_factor_set (double scale); @@ -1880,6 +2094,9 @@ EAPI void edje_transition_duration_factor_set (double scale); * * @since 1.15 * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double edje_transition_duration_factor_get (void); @@ -1986,6 +2203,9 @@ typedef void (*Edje_Message_Handler_Cb) (void *data, Evas_Object *obj, E * This function triggers the processing of messages addressed to any * (alive) edje objects. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_message_signal_process (void); @@ -2023,6 +2243,10 @@ EAPI void edje_message_signal_process (void); * * @see edje_perspective_set() * @see edje_perspective_free() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Edje_Perspective *edje_perspective_new (Evas *e); /** @@ -2035,6 +2259,10 @@ EAPI Edje_Perspective *edje_perspective_new (Evas *e); * applied anymore. * * @see edje_perspective_new() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_perspective_free (Edje_Perspective *ps); /** @@ -2058,6 +2286,10 @@ EAPI void edje_perspective_free (Edje_Perspective * * @param py The perspective distance Y coordinate * @param z0 The "0" z plane value * @param foc The focal distance + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_perspective_set (Edje_Perspective *ps, Evas_Coord px, Evas_Coord py, Evas_Coord z0, Evas_Coord foc); /** @@ -2082,6 +2314,10 @@ EAPI void edje_perspective_set (Edje_Perspective * * @see edje_object_perspective_set() * @see edje_perspective_global_get() * @see edje_perspective_new() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_perspective_global_set (Edje_Perspective *ps, Eina_Bool global); /** @@ -2092,6 +2328,10 @@ EAPI void edje_perspective_global_set (Edje_Perspective * * otherwise. * * @see edje_perspective_global_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_perspective_global_get (const Edje_Perspective *ps); /** @@ -2106,6 +2346,10 @@ EAPI Eina_Bool edje_perspective_global_get (const Edje_Perspec * * @see edje_perspective_global_set() * @see edje_perspective_global_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Edje_Perspective *edje_evas_global_perspective_get(const Evas *e); /** @@ -2163,6 +2407,10 @@ typedef enum _Edje_Channel * @see edje_audio_channel_mute_get() * * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void edje_audio_channel_mute_set(Edje_Channel channel, Eina_Bool mute); @@ -2175,6 +2423,10 @@ EAPI void edje_audio_channel_mute_set(Edje_Channel channel, Eina_Bool mute); * @see edje_audio_channel_mute_set() * * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_audio_channel_mute_get(Edje_Channel channel); @@ -2185,6 +2437,10 @@ EAPI Eina_Bool edje_audio_channel_mute_get(Edje_Channel channel); * @note If this function returns @c NULL, @p obj was not an Edje part object * @see edje_object_part_object_get() * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *edje_object_part_object_name_get(const Evas_Object *obj); diff --git a/src/lib/edje/Edje_Legacy.h b/src/lib/edje/Edje_Legacy.h index d9a4809..9ec000b 100644 --- a/src/lib/edje/Edje_Legacy.h +++ b/src/lib/edje/Edje_Legacy.h @@ -48,6 +48,10 @@ * @note Before creating the first Edje object in your code, remember * to initialize the library, with edje_init(), or unexpected behavior * might occur. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *edje_object_add (Evas *evas); @@ -69,6 +73,9 @@ EAPI Evas_Object *edje_object_add (Evas *evas); * @see edje_object_signal_callback_add(). * @see edje_object_signal_callback_del_full(). * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *edje_object_signal_callback_del (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func); @@ -94,6 +101,9 @@ EAPI void *edje_object_signal_callback_del (Evas_Object *obj, const char * @see edje_object_signal_callback_add(). * @see edje_object_signal_callback_del(). * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *edje_object_signal_callback_del_full(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data); @@ -111,6 +121,10 @@ EAPI void *edje_object_signal_callback_del_full(Evas_Object *obj, const c * * Deleting the color class will emit the signal "color_class,del" * for the given Edje object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_object_color_class_del (Evas_Object *obj, const char *color_class); @@ -123,6 +137,10 @@ EAPI void *edje_object_signal_callback_del_full(Evas_Object *obj, const c * @param minh The minimum height * * This sets the minimum size restriction for the object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void edje_extern_object_min_size_set (Evas_Object *obj, Evas_Coord minw, Evas_Coord minh); @@ -135,6 +153,10 @@ EINA_DEPRECATED EAPI void edje_extern_object_min_size_set (Evas_Object * * @param maxh The maximum height * * This sets the maximum size restriction for the object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void edje_extern_object_max_size_set (Evas_Object *obj, Evas_Coord maxw, Evas_Coord maxh); @@ -151,6 +173,10 @@ EINA_DEPRECATED EAPI void edje_extern_object_max_size_set (Evas_Object * * swallowed by Edje. The width and height define a preferred size * ASPECT and the object may be scaled to be larger or smaller, but * retaining the relative scale of both aspect width and height. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void edje_extern_object_aspect_set (Evas_Object *obj, Edje_Aspect_Control aspect, Evas_Coord aw, Evas_Coord ah); @@ -184,6 +210,10 @@ EINA_DEPRECATED EAPI void edje_extern_object_aspect_set (Evas_Object * * @param[in] file The path to the EDJ file to load @p from * @param[in] group The name of the group, in @p file, which implements an Edje object + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool edje_object_file_set(Edje_Object *obj, const char *file, const char *group); @@ -204,6 +234,10 @@ EAPI Eina_Bool edje_object_file_set(Edje_Object *obj, const char *file, const ch * @param[out] file The path to the EDJ file to load @p from * @param[out] group The name of the group, in @p file, which implements an Edje object + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void edje_object_file_get(const Edje_Object *obj, const char **file, const char **group); @@ -239,6 +273,10 @@ EAPI void edje_object_file_get(const Edje_Object *obj, const char **file, const * @param[in] file The Eina.File pointing to the EDJ file to load @p from * @param[in] group The name of the group, in @p file, which implements an Edje object + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool edje_object_mmap_set(Edje_Object *obj, const Eina_File *file, const char *group); diff --git a/src/lib/edje/edje_object.eo b/src/lib/edje/edje_object.eo index 097b8c4..a1a0aaa 100644 --- a/src/lib/edje/edje_object.eo +++ b/src/lib/edje/edje_object.eo @@ -13,10 +13,20 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) By default edje doesn't set size hints on itself. With this function call, it will do so if update is true. Be carefully, it cost a lot to trigger this feature as it will recalc the object every time it make - sense to be sure that's its minimal size hint is always accurate.]] + sense to be sure that's its minimal size hint is always accurate. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { - [[Whether or not Edje will update size hints on itself.]] + [[Whether or not Edje will update size hints on itself. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { update: bool; [[Whether or not update the size hints.]] @@ -26,14 +36,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) set { [[Set the RTL orientation for this object. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] } get { [[Get the RTL orientation for this object. You can RTL orientation explicitly with edje_object_mirrored_set. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] } values { rtl: bool; [[new value of flag true/false]] @@ -43,12 +63,22 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) set { [[Set the language for this object. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] } get { [[Get the language for this object. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] } values { language: const(char)*; [[The language value]] @@ -62,7 +92,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) information if it's stopped can be retrieved by edje_object_animation_get(). - See also @.animation.get()]] + See also @.animation.get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Get the Edje object's animation state. @@ -70,7 +105,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns if the animation is stopped or not. The animation state is set by edje_object_animation_set(). - See also @.animation.set().]] + See also @.animation.set(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { on: bool; [[The animation state. $true to starts or @@ -85,7 +125,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) states, depending on the parameter play. This has no effect if the object was already at that state. - See also @.play.get().]] + See also @.play.get(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Get the Edje object's state. @@ -93,7 +138,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function tells if an Edje object is playing or not. This state is set by edje_object_play_set(). - See also @.play.set().]] + See also @.play.set(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { play: bool; [[Object state ($true to playing, @@ -116,7 +166,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) \@ref edje_object_perspective_new() See also @.perspective.get() - \@ref edje_perspective_set()]] + \@ref edje_perspective_set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] values { ps: Edje.Perspective*; [[The perspective object that will be used.]] } @@ -124,7 +179,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) get { [[Get the current perspective used on this Edje object. - See also @.perspective.set()]] + See also @.perspective.set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] values { ps: const(Edje.Perspective)*; [[The perspective object that will be used.]] } @@ -146,7 +206,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) complete \@ref edcref "syntax reference" for EDC files. See also @.scale.get() - \@ref edje_scale_get() for more details]] + \@ref edje_scale_get() for more details + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; } get { @@ -155,7 +220,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns the individual scaling factor set on the obj Edje object. - See also @.scale.set() for more details]] + See also @.scale.set() for more details + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { scale: double; [[The scaling factor (the default value is @0.0, @@ -169,7 +239,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns the base_scale factor set on the obj Edje object. The base_scale can be set in the collection of edc. - If it isn't set, the default value is 1.0]] + If it isn't set, the default value is 1.0 + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { base_scale: double(1.0); [[The base_scale factor (the default value is @ 1.0, @@ -180,7 +255,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) set { [[Set the object text callback. - This function sets the callback to be called when the text changes.]] + This function sets the callback to be called when the text changes. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { func: Edje.Text.Change_Cb; [[The callback function to handle the text change]] @@ -190,7 +270,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) @property part_text_cursor_begin { set { [[Moves the cursor to the beginning of the text part - \@ref evas_textblock_cursor_paragraph_first]] + \@ref evas_textblock_cursor_paragraph_first + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { part: const(char)*; [[The part name]] @@ -200,7 +285,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) @property part_text_cursor_line_end { set { [[Move the cursor to the end of the line. - \@ref evas_textblock_cursor_line_char_last]] + \@ref evas_textblock_cursor_line_char_last + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { part: const(char)*; [[The part name]] @@ -211,7 +301,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) set { [[Sets Edje text class. - This function sets the text class for the Edje.]] + This function sets the text class for the Edje. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true, on success or $false, on error]] } values { @@ -224,7 +319,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) set { [[Position the given cursor to a X,Y position. - This is frequently used with the user cursor.]] + This is frequently used with the user cursor. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; [[True on success, false on error.]] } @@ -238,7 +338,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) @property part_text_cursor_end { set { [[Moves the cursor to the end of the text part. - \@ref evas_textblock_cursor_paragraph_last]] + \@ref evas_textblock_cursor_paragraph_last + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { part: const(char)*; [[The part name]] @@ -253,7 +358,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) style escapes like "&" and "©" etc. IF the part is of type TEXT, as opposed to TEXTBLOCK. - @since 1.2]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.2 + ]] return: bool; [[$true on success, $false otherwise]] } values { @@ -266,7 +376,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Set the function that provides item objects for named items in an edje entry text Item objects may be deleted any time by Edje, and will be deleted when the - Edje object is deleted (or file is set to a new file).]] + Edje object is deleted (or file is set to a new file). + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { func: Edje.Item_Provider_Cb; [[The function to call (or $null to disable) to get item objects]] @@ -276,7 +391,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) @property part_text_cursor_line_begin { set { [[Move the cursor to the beginning of the line. - \@ref evas_textblock_cursor_line_char_first]] + \@ref evas_textblock_cursor_line_char_first + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { part: const(char)*; [[The part name]] @@ -295,7 +415,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function associates a message handler function and the attached data pointer to the object obj. - See also @.message_send()]] + See also @.message_send() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { func: Edje.Message_Handler_Cb; [[The function to handle messages coming from obj]] @@ -316,7 +441,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note: On failure, this function will make all non-$null size pointers' pointed variables be set to zero. - See also @.size_max.get()]] + See also @.size_max.get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] /* FIXME-doc * Minimum size of groups have the following syntax * @code @@ -346,7 +476,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) get { [[Retrieve a list all accessibility part names - @since 1.7.0]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.7.0 + ]] return: list *; [[A list all accessibility part names on obj]] } } @@ -359,7 +494,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) function. If that function does not return $true, one should check for the reason of failure with this one. - \@ref edje_load_error_str()]] + \@ref edje_load_error_str() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Edje.Load_Error; [[The Edje loading error, one of: - #EDJE_LOAD_ERROR_NONE - #EDJE_LOAD_ERROR_GENERIC @@ -389,7 +529,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note: On failure, this function will make all non-$null size pointers' pointed variables be set to zero. - See also @.size_min.get()]] + See also @.size_min.get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] /* FIXME-doc * Maximum size of groups have the following syntax * @code @@ -419,7 +564,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Removes all object from the table. Removes all object from the table indicated by part, except the - internal ones set from the theme.]] + internal ones set from the theme. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true clear the table, $false on failure]] params { @@ -428,7 +578,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_external_param_type_get @const { - [[Facility to query the type of the given parameter of the given part.]] + [[Facility to query the type of the given parameter of the given part. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: Edje.External.Param_Type; [[#EDJE_EXTERNAL_PARAM_TYPE_MAX on errors, or another value from #Edje_External_Param_Type on success.]] @@ -443,14 +598,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) The default is to not allow selection. This function only affects user selection, functions such as edje_object_part_text_select_all() and - edje_object_part_text_select_none() are not affected.]] + edje_object_part_text_select_none() are not affected. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] @in allow: bool; [[true to enable, false otherwise]] } } part_state_get @const { - [[Returns the state of the Edje part.]] + [[Returns the state of the Edje part. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(char)*; [[The part state: "default" for the default state @@ -469,7 +634,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.text_markup_filter_callback_add and @.text_markup_filter_callback_del - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: void *; [[The same data pointer if successful, or $null otherwise]] params { @@ -487,7 +657,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) representing the relative size of the dragable area on that axis by which the part will be moved. - See also @.part_drag_step_get()]] + See also @.part_drag_step_get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -501,7 +676,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Gets the x and y step increments for the dragable object. - See also @.part_drag_step_set()]] + See also @.part_drag_step_set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The part]] @@ -515,14 +695,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) If ecore_imf was not available when edje was compiled, this function returns $null otherwise, the returned pointer is an Ecore_IMF - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: void *; [[The input method context (Ecore_IMF_Context *) in entry]] params { @in part: const(char)*; [[The part name]] } } part_text_select_begin @const { - [[Starts selecting at current cursor position]] + [[Starts selecting at current cursor position + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] } @@ -532,7 +722,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns the style associated with the textblock part. - @since 1.2.0]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.2.0 + ]] return: const(char)*; [[The text string]] params { @in part: const(char)*; [[The part name]] @@ -561,7 +756,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } part_text_cursor_next { [[Advances the cursor to the next cursor position. - \@ref evas_textblock_cursor_char_next]] + \@ref evas_textblock_cursor_char_next + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; params { @@ -574,7 +774,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function sets the style associated with the textblock part. - @since 1.2.0]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -587,7 +792,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function inserts the text for an object part at the end; It does not move the cursor. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] params { @in part: const(char)*; [[The part name]] @@ -606,7 +816,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) interested in: they'll be ignored by the function. Note: On failure, this function will make all non-$null geometry - pointers' pointed variables be set to zero.]] + pointers' pointed variables be set to zero. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The Edje part's name]] @@ -625,7 +840,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note that input panel is shown or hidden automatically according to the focus state. This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] } @@ -634,7 +854,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Return item geometry. This function return a list of Evas_Textblock_Rectangle item - rectangles.]] + rectangles. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[1 if item exists, 0 if not]] params { @in part: const(char)*; [[The part name]] @@ -648,7 +873,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_table_unpack { [[Removes an object from the table. - Removes an object from the table indicated by part.]] + Removes an object from the table indicated by part. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true object removed, $false on failure]] params { @@ -657,7 +887,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_text_select_abort @const { - [[Aborts any selection action on a part.]] + [[Aborts any selection action on a part. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] } @@ -669,7 +904,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) in part. Returns the user data pointer given when added. - See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del]] + See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: void *; [[The same data pointer if successful, or $null otherwise]] params { @@ -681,7 +921,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_style_user_pop { [[Delete the top style form the user style stack. - @since 1.2.0]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -694,7 +939,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) The data format MUST be negotiated by both application and the input panel. The size and format of data are defined by the input panel. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -705,7 +955,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_panel_imdata_get @const { [[Get the specific data of the current active input panel. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @in data: void *; [[The specific data to be got from the input panel]] @@ -716,7 +971,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Insert text for an object part. This function inserts the text for an object part just before the - cursor position.]] + cursor position. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in part: const(char)*; [[The part name]] @@ -729,7 +989,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Removes from the box indicated by part, the object in the position pos. - See also @.part_box_remove() and @.part_box_remove_all()]] + See also @.part_box_remove() and @.part_box_remove_all() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object *; [[Pointer to the object removed, or $null.]] params { @@ -738,7 +1003,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_text_cursor_copy { - [[Copy the cursor to another cursor.]] + [[Copy the cursor to another cursor. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] @@ -761,7 +1031,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) interested in: they'll be ignored by the function. Note: On failure, this function will make all non-$null geometry - pointers' pointed variables be set to zero.]] + pointers' pointed variables be set to zero. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -790,7 +1065,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) For the horizontal axis, 0.0 means left if the first parameter of $x in the dragable part theme is 1, and right if it is -1. - See also @.part_drag_value_get()]] + See also @.part_drag_value_get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -807,7 +1087,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.part_drag_value_set() - Gets the drag location values.]] + Gets the drag location values. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The part name]] @@ -819,13 +1104,23 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Force a Size/Geometry calculation. Forces the object obj to recalculation layout regardless of - freeze/thaw.]] + freeze/thaw. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } part_text_cursor_pos_set { [[Sets the cursor position to the given value - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -836,7 +1131,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_cursor_pos_get @const { [[Retrieves the current position of the cursor - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] return: int; [[The cursor position]] params { @in part: const(char)*; [[The part name]] @@ -849,7 +1149,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function puts all changes on hold. Successive freezes will nest, requiring an equal number of thaws. - See also @.thaw()]] + See also @.thaw() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: int; [[The frozen state or 0 on Error]] } @@ -857,7 +1162,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Returns the content (char) at the cursor position. \@ref evas_textblock_cursor_content_get - You must free the return (if not $null) after you are done with it.]] + You must free the return (if not $null) after you are done with it. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: char *; [[The character string pointed to (may be a multi-byte utf8 sequence) terminated by a nul byte.]] params { @@ -873,7 +1183,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) are expecting to enter and thus have the input panel automatically come up with the right mode. - @since 1.1]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1 + ]] params { @in part: const(char)*; [[The part name]] @@ -885,7 +1200,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.part_text_input_panel_layout_set - @since 1.1]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1 + ]] return: Edje.Input_Panel.Layout; [[Layout type of the input panel]] params { @in part: const(char)*; [[The part name]] @@ -894,7 +1214,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_table_pack { [[Packs an object into the table. - Packs an object into the table indicated by part.]] + Packs an object into the table indicated by part. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true object was added, $false on failure]] params { @@ -911,7 +1236,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This API can be used if you want to show the Alphabet keyboard. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -923,7 +1253,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.part_text_input_panel_language_set for more details. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: Edje.Input_Panel.Lang; [[input panel language type]] params { @in part: const(char)*; [[The part name]] @@ -932,7 +1267,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_table_col_row_size_get @const { [[Gets the number of columns and rows the table has. - Retrieves the size of the table in number of columns and rows.]] + Retrieves the size of the table in number of columns and rows. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true get some data, $false on failure]] params { @in part: const(char)*; [[The part name]] @@ -952,7 +1292,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note: Almost all swallow rules apply: you should not move, resize, hide, show, set the color or clipper of such part. It's a bit - more restrictive as one must never delete this object!]] + more restrictive as one must never delete this object! + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: Evas.Object *; [[The externally created object, or $null if there is none or part is not an external.]] params { @@ -963,7 +1308,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Get an object contained in an part of type EXTERNAL The content string must not be $null. Its actual value depends on the - code providing the EXTERNAL.]] + code providing the EXTERNAL. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: Evas.Object *; params { @in part: const(char)*; [[The name of the part holding the EXTERNAL]] @@ -979,7 +1329,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) It emits a signal "preload,done" when finished. Note: Use $true on scenarios where you don't need - the image data preloaded anymore.]] + the image data preloaded anymore. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$false if obj was not a valid Edje object otherwise $true]] @@ -991,7 +1346,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_panel_enabled_set { [[Sets the attribute to show the input panel automatically. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1002,14 +1362,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Retrieve the attribute to show the input panel automatically. See also @.part_text_input_panel_enabled_set - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] return: bool; [[true if it supports or false otherwise]] params { @in part: const(char)*; [[The part name]] } } part_text_select_extend @const { - [[Extends the current selection to the current cursor position]] + [[Extends the current selection to the current cursor position + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] } @@ -1020,7 +1390,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Adds child to the box indicated by part, in the position given by pos. - See also @.part_box_append(), @.part_box_prepend() and @.part_box_insert_before()]] + See also @.part_box_append(), @.part_box_prepend() and @.part_box_insert_before() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true: Successfully added. $false: An error occurred.]] @@ -1034,7 +1409,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Return a list of Evas_Textblock_Rectangle anchor rectangles. This function return a list of Evas_Textblock_Rectangle anchor - rectangles.]] + rectangles. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(list)*; [[The list of anchor rects (const Evas_Textblock_Rectangle *), do not modify! Geometry is relative to entry part.]] params { @@ -1043,7 +1423,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_text_cursor_down { - [[Moves the cursor to the char below the current cursor position.]] + [[Moves the cursor to the char below the current cursor position. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; params { @@ -1060,7 +1445,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) representing the relative size of the dragable area on that axis by which the part will be moved. - See also @.part_drag_page_get()]] + See also @.part_drag_page_get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1074,7 +1464,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Gets the x,y page step increments for the dragable object. - See also @.part_drag_page_set()]] + See also @.part_drag_page_set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The part name]] @@ -1087,7 +1482,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Prepends child to the box indicated by part. - See also @.part_box_append(), @.part_box_insert_before() and @.part_box_insert_at()]] + See also @.part_box_append(), @.part_box_insert_before() and @.part_box_insert_at() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true: Successfully added. $false: An error occurred.]] @@ -1104,7 +1504,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) having declared matching @'signal' and @'source' fields on its block (see \@ref edcref "the syntax" for EDC files). - See also @.signal_callback_add() for more on Edje signals.]] + See also @.signal_callback_add() for more on Edje signals. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] /* FIXME-doc * @code * program @@ -1129,7 +1534,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) are expecting to enter and thus have the input panel automatically come up with the right mode. - @since 1.8]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.8 + ]] params { @in part: const(char)*; [[The part name]] @@ -1141,7 +1551,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.part_text_input_panel_layout_variation_set - @since 1.8]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.8 + ]] return: int; [[Layout variation type of the input panel]] params { @in part: const(char)*; [[The part name]] @@ -1162,7 +1577,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) context). The function to handle messages arriving from obj is set with - edje_object_message_handler_set().]] + edje_object_message_handler_set(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in type: Edje.Message_Type; [[The type of message to send to obj]] @@ -1173,7 +1593,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_select_none @const { [[Set the selection to be none. - This function sets the selection text to be none.]] + This function sets the selection text to be none. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] } @@ -1190,7 +1615,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) because it's meant to be managed by Edje, solely. You are safe to query information about its current state (with evas_object_visible_get() or \@ref evas_object_color_get() for - example), though.]] + example), though. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(Evas.Object)*; [[A pointer to the Evas object implementing the given part, or $null on failure (e.g. the given part doesn't exist)]] params { @@ -1205,7 +1635,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Sets the size of the dragable object. - See also @.part_drag_size_get()]] + See also @.part_drag_size_get() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1219,7 +1654,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Gets the dragable object size. - See also @.part_drag_size_set()]] + See also @.part_drag_size_set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The part name]] @@ -1233,7 +1673,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Delete the given func filter from the list in part. Returns the user data pointer given when added. - See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del_full]] + See also @.text_insert_filter_callback_add and @.text_insert_filter_callback_del_full + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: void *; [[The user data pointer if successful, or $null otherwise]] params { @@ -1246,7 +1691,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) The dragable directions are defined in the EDC file, inside the \@ref dragable section, by the attributes $x and $y. See the \@ref edcref for more - information.]] + information. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Edje.Drag_Dir; [[#EDJE_DRAG_DIR_NONE: Not dragable #EDJE_DRAG_DIR_X: Dragable in X direction @@ -1262,7 +1712,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function will not do escape for you if it is a TEXTBLOCK part, that is, if text contain tags, these tags will not be interpreted/parsed by TEXTBLOCK. - See also @.part_text_unescaped_get().]] + See also @.part_text_unescaped_get(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1278,7 +1733,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) result is newly allocated memory and should be released with free() when done. - See also @.part_text_unescaped_set().]] + See also @.part_text_unescaped_set(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: char *; [[The allocated text string without escaping, or $null on problems.]] params { @@ -1323,7 +1783,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note: See \@ref edcref "the syntax" for EDC files See also @.signal_emit() on how to emits Edje signals from code to a an object - \@ref edje_object_signal_callback_del_full()]] + \@ref edje_object_signal_callback_del_full() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] /* FIXME-doc * This function adds a callback function to a signal emitted by obj, to * be issued every time an EDC program like the following @@ -1349,7 +1814,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_select_all @const { [[Set the selection to be everything. - This function selects all text of the object of the part.]] + This function selects all text of the object of the part. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] } @@ -1357,7 +1827,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_panel_return_key_disabled_set { [[Set the return key on the input panel to be disabled. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1367,7 +1842,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_panel_return_key_disabled_get @const { [[Get whether the return key on the input panel should be disabled or not. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: bool; [[true if it should be disabled]] params { @in part: const(char)*; [[The part name]] @@ -1376,7 +1856,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_autocapital_type_set { [[Set the autocapitalization type on the immodule. - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1386,7 +1871,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_autocapital_type_get @const { [[Retrieves the autocapitalization type - @since 1.1.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.1.0 + ]] return: Edje.Text.Autocapital_Type; [[The autocapitalization type]] params { @in part: const(char)*; [[The part name]] @@ -1399,7 +1889,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note: obj_swallow will not be deleted or hidden. Note: obj_swallow may appear shown on the evas depending on its state when - it got unswallowed. Make sure you delete it or hide it if you do not want it to.]] + it got unswallowed. Make sure you delete it or hide it if you do not want it to. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in obj_swallow: Evas.Object *; [[The swallowed object]] @@ -1408,7 +1903,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_prediction_allow_set { [[Set whether the prediction is allowed or not. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1418,7 +1918,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_prediction_allow_get @const { [[Get whether the prediction is allowed or not. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: bool; [[true if prediction feature is allowed.]] params { @in part: const(char)*; [[The part name]] @@ -1439,7 +1944,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Warning: Do not confuse this call with edje_file_data_get(), which queries for a global EDC data field on an EDC declaration file. - \@ref edje_object_file_set()]] + \@ref edje_object_file_set() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] /* FIXME-doc * They look like the following: * @code @@ -1486,7 +1996,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.text_markup_filter_callback_del, @.text_markup_filter_callback_del_full and @.text_insert_filter_callback_add - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1499,7 +2014,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function goes through the object message queue processing the pending messages for this specific Edje object. Normally they'd - be processed only at idle time.]] + be processed only at idle time. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } part_box_remove { @@ -1507,7 +2027,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Removes child from the box indicated by part. - See also @.part_box_remove_at() and @.part_box_remove_all()]] + See also @.part_box_remove_at() and @.part_box_remove_all() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object *; [[Pointer to the object removed, or $null.]] params { @@ -1523,12 +2048,22 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note:: If sucessives freezes were done, an equal number of thaws will be required. - See also @.freeze()]] + See also @.freeze() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: int; [[The frozen state or 0 if the object is not frozen or on error.]] } part_swallow_get @const { - [[Get the object currently swallowed by a part.]] + [[Get the object currently swallowed by a part. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object *; [[The swallowed object, or $null if there is none.]] params { @@ -1540,7 +2075,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This can be necessary in the case where modifying the buffer would confuse on-going input method behavior - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] } @@ -1550,7 +2090,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) An input panel displays the string or icon associated with this type - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1562,14 +2107,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.part_text_input_panel_return_key_type_set() for more details - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: Edje.Input_Panel.Return_Key_Type; [[The type of "return" key on the input panel]] params { @in part: const(char)*; [[The part name]] } } part_table_child_get @const { - [[Retrieve a child from a table]] + [[Retrieve a child from a table + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object *; [[The child Evas.Object]] params { @@ -1584,7 +2139,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Inserts child in the box given by part, in the position marked by reference. - See also @.part_box_append(), @.part_box_prepend() and @.part_box_insert_at()]] + See also @.part_box_append(), @.part_box_prepend() and @.part_box_insert_at() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true: Successfully added. $false: An error occurred.]] @@ -1611,7 +2171,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) using #Edje_External_Param_Info minimum, maximum, valid choices and others. However these should be checked by the underlying implementation provided by the external - plugin. This is done for performance reasons.]] + plugin. This is done for performance reasons. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; [[$true if everything went fine, $false on errors.]] params { @@ -1636,7 +2201,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) functions. This function asks the external plugin what is the current value, - independent on how it was set.]] + independent on how it was set. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; [[$true if everything went fine and param members are filled with information, $false on errors and @@ -1656,7 +2226,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This call works exactly as edje_object_size_min_restricted_calc(), with the last two arguments set to 0. Please refer to its - documentation, then.]] + documentation, then. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @out minw: Evas.Coord; [[Pointer to a variable where to store the minimum @@ -1671,7 +2246,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Appends child to the box indicated by part. See also @.part_box_prepend(), @.part_box_insert_before() - and @.part_box_insert_at()]] + and @.part_box_insert_at() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true: Successfully added. $false: An error occurred.]] @@ -1695,7 +2275,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) sizes. The caller is the one up to change its geometry or not. Warning: Be advised that invisible parts in obj will be taken - into account in this calculation.]] + into account in this calculation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @out minw: Evas.Coord; [[Pointer to a variable where to store the minimum @@ -1714,7 +2299,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Removes all the external objects from the box indicated by part. Elements created from the theme will not be removed. - See also @.part_box_remove() and @.part_box_remove_at()]] + See also @.part_box_remove() and @.part_box_remove_at() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[1: Successfully cleared. 0: An error occurred.]] @@ -1733,7 +2323,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Warning: Paging is bugged! - See also @.part_drag_step()]] + See also @.part_drag_step() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1743,7 +2338,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_text_set { - [[Sets the text for an object part]] + [[Sets the text for an object part + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false otherwise]] params { @@ -1756,7 +2356,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns the text associated to the object part. - See also @.part_text_set().]] + See also @.part_text_set(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(char)*; [[The text string]] params { @in part: const(char)*; [[The part name]] @@ -1766,7 +2371,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) [[Set the attribute to show the input panel in case of only an user's explicit Mouse Up event. It doesn't request to show the input panel even though it has focus. - @since 1.9.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.9.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1776,7 +2386,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_panel_show_on_demand_get @const { [[Get the attribute to show the input panel in case of only an user's explicit Mouse Up event. - @since 1.9.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.9.0 + ]] return: bool; [[$true if the input panel will be shown in case of only Mouse up event.]] params { @in part: const(char)*; [[The part name]] @@ -1785,7 +2400,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_hint_set { [[Sets the input hint which allows input methods to fine-tune their behavior. - @since 1.12.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.12.0 + ]] params { @in part: const(char)*; [[The part name]] @@ -1795,7 +2415,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_input_hint_get @const { [[Gets the value of input hint - @since 1.12.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.12.0 + ]] return: Edje.Input_Hints; [[The value of input hint]] params { @in part: const(char)*; [[The part name]] @@ -1806,7 +2431,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function returns selection text of the object part. - See also @.part_text_select_all() and @.part_text_select_none()]] + See also @.part_text_select_all() and @.part_text_select_none() + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: const(char)*; [[The text string]] params { @in part: const(char)*; [[The part name]] @@ -1814,7 +2444,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } part_text_cursor_is_format_get @const { [[Returns whether the cursor points to a format. - \@ref evas_textblock_cursor_is_format]] + \@ref evas_textblock_cursor_is_format + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; [[true if it's true, false otherwise.]] params { @@ -1827,7 +2462,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This function gets the font and the font size from the object text class. The font string will only be valid until the text - class is changed or the edje object is deleted.]] + class is changed or the edje object is deleted. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true, on success or $false, on error]] params { @in text_class: const(char)*; [[The text class name]] @@ -1851,7 +2491,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) the given color. Note: unlike Evas, Edje colors are not pre-multiplied. That is, - half-transparent white is 255 255 255 128.]] + half-transparent white is 255 255 255 128. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1882,7 +2527,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) to text parts). Note: unlike Evas, Edje colors are not pre-multiplied. That is, - half-transparent white is 255 255 255 128.]] + half-transparent white is 255 255 255 128. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[true if found or false if not found and all values are zeroed.]] params { @@ -1904,7 +2554,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) color_class_description_get @const { [[Gets the description of an object color class. - This function gets the description of a color class in use by an object.]] + This function gets the description of a color class in use by an object. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: const(char)*; [[The description of the target color class or $null if not found]] params { @in color_class: const(char)*; @@ -1924,7 +2579,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Values for dx and dy are real numbers that range from 0 to 1. - See also @.part_drag_page()]] + See also @.part_drag_page() + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -1934,7 +2594,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } } part_text_cursor_up { - [[Move the cursor to the char above the current cursor position.]] + [[Move the cursor to the char above the current cursor position. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; params { @@ -1944,7 +2609,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } part_text_cursor_geometry_get @const { [[Returns the cursor geometry of the part relative to the edje - object.]] + object. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] @out x: Evas.Coord; [[Cursor X position]] @@ -1956,7 +2626,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_anchor_list_get @const { [[Return a list of char anchor names. - This function returns a list of char anchor names.]] + This function returns a list of char anchor names. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(list)*; [[The list of anchors (const char *), do not modify!]] params { @in part: const(char)*; [[The part name]] @@ -1990,7 +2665,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) will be executed, and then filtered text will be inserted. See also @.text_insert_filter_callback_del, @.text_insert_filter_callback_del_full - and @.text_markup_filter_callback_add]] + and @.text_markup_filter_callback_add + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in part: const(char)*; [[The part name]] @@ -2004,7 +2684,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) Note that input panel is shown or hidden automatically according to the focus state. This API can be used in the case of manually controlling by using edje_object_part_text_input_panel_enabled_set. - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] } @@ -2017,7 +2702,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) bound to object obj (with edje_object_file_set()). This call is useful, for example, when one could expect or not a - given GUI element, depending on the theme applied to obj.]] + given GUI element, depending on the theme applied to obj. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true, if the Edje part exists in obj's group or $false, otherwise (and on errors)]] params { @@ -2033,7 +2723,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) See also @.text_markup_filter_callback_add and @.text_markup_filter_callback_del_full - @since 1.2.0]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2.0 + ]] return: void *; [[The user data pointer if successful, or $null otherwise]] params { @@ -2044,7 +2739,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_cursor_is_visible_format_get @const { [[Return true if the cursor points to a visible format For example \\t, \\n, item and etc. - @ evas_textblock_cursor_format_is_visible_get]] + @ evas_textblock_cursor_format_is_visible_get + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; params { @in part: const(char)*; [[The part name]] @@ -2057,7 +2757,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This means it actually registers as a change and emits signals, triggers callbacks as appropriate. - @since 1.2.0]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.2.0 + ]] params { @in part: const(char)*; [[The part name]] @in text: const(char)*; [[The text string]] @@ -2065,7 +2770,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) } part_text_cursor_prev { [[Moves the cursor to the previous char - \@ref evas_textblock_cursor_char_prev]] + \@ref evas_textblock_cursor_char_prev + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: bool; params { @@ -2076,7 +2786,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) part_text_item_list_get @const { [[Return a list of char item names. - This function returns a list of char item names.]] + This function returns a list of char item names. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(list)*; [[The list of items (const char *), do not modify!]] params { @in part: const(char)*; [[The part name]] @@ -2112,7 +2827,12 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) deleted -- obj_swallow will get to an unparented state again. For more details on EDC $SWALLOW parts, see \@ref edcref "syntax - reference".]] + reference". + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; params { @@ -2126,14 +2846,24 @@ class Edje.Object (Evas.Smart_Clipped, Efl.File) This define the transition duration factor on this specific object. By default all animation are run at a speed - factor of 1.0.]] + factor of 1.0. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { [[Get transition duration factor. This define the transition duration factor on this specific object. By default all animation are run at a speed - factor of 1.0.]] + factor of 1.0. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { scale: double; [[The transition duration factor]] diff --git a/src/lib/eet/Eet.h b/src/lib/eet/Eet.h index 62074fd..b5c1ccd 100644 --- a/src/lib/eet/Eet.h +++ b/src/lib/eet/Eet.h @@ -266,6 +266,10 @@ typedef enum _Eet_Compression * * @since 1.0.0 * @ingroup Eet_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_init(void); @@ -282,6 +286,10 @@ eet_init(void); * * @since 1.0.0 * @ingroup Eet_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_shutdown(void); @@ -301,6 +309,10 @@ eet_shutdown(void); * * @since 1.0.0 * @ingroup Eet_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_clearcache(void); @@ -586,6 +598,10 @@ struct _Eet_Entry * returned instead. * * @since 1.0.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_File * eet_open(const char *file, @@ -612,6 +628,10 @@ eet_open(const char *file, * maintain correct reference counts. * * @since 1.8.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_File * eet_mmap(const Eina_File *file); @@ -629,6 +649,10 @@ eet_mmap(const Eina_File *file); * * @since 1.1.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_File * eet_memopen_read(const void *data, @@ -641,6 +665,10 @@ eet_memopen_read(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_File_Mode eet_mode_get(Eet_File *ef); @@ -662,6 +690,10 @@ eet_mode_get(Eet_File *ef); * @ingroup Eet_File_Group * * @see eet_clearcache() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Error eet_close(Eet_File *ef); @@ -678,6 +710,10 @@ eet_close(Eet_File *ef); * * @since 1.2.4 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Error eet_sync(Eet_File *ef); @@ -697,6 +733,10 @@ eet_sync(Eet_File *ef); * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Dictionary * eet_dictionary_get(Eet_File *ef); @@ -714,6 +754,10 @@ eet_dictionary_get(Eet_File *ef); * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_dictionary_string_check(Eet_Dictionary *ed, @@ -726,6 +770,10 @@ eet_dictionary_string_check(Eet_Dictionary *ed, * * @since 1.6.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_dictionary_count(const Eet_Dictionary *ed); @@ -751,6 +799,10 @@ eet_dictionary_count(const Eet_Dictionary *ed); * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_read(Eet_File *ef, @@ -776,6 +828,10 @@ eet_read(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void * eet_read_direct(Eet_File *ef, @@ -809,6 +865,10 @@ eet_read_direct(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_write(Eet_File *ef, @@ -834,6 +894,10 @@ eet_write(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_delete(Eet_File *ef, @@ -853,6 +917,10 @@ eet_delete(Eet_File *ef, * * @since 1.3.3 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_alias(Eet_File *ef, @@ -869,6 +937,10 @@ eet_alias(Eet_File *ef, * * @since 1.6 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * eet_file_get(Eet_File *ef); @@ -883,6 +955,10 @@ eet_file_get(Eet_File *ef); * * @since 1.5 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char * eet_alias_get(Eet_File *ef, @@ -917,6 +993,10 @@ eet_alias_get(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char ** eet_list(Eet_File *ef, @@ -930,6 +1010,10 @@ eet_list(Eet_File *ef, * * @since 1.8.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eet_list_entries(Eet_File *ef); @@ -942,6 +1026,10 @@ EAPI Eina_Iterator *eet_list_entries(Eet_File *ef); * * @since 1.0.0 * @ingroup Eet_File_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_num_entries(Eet_File *ef); @@ -979,6 +1067,10 @@ eet_num_entries(Eet_File *ef); * * @since 1.0.0 * @ingroup Eet_File_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_read_cipher(Eet_File *ef, @@ -1014,6 +1106,10 @@ eet_read_cipher(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_write_cipher(Eet_File *ef, @@ -1078,6 +1174,10 @@ eet_write_cipher(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_header_read(Eet_File *ef, @@ -1123,6 +1223,10 @@ eet_data_image_header_read(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_read(Eet_File *ef, @@ -1181,6 +1285,10 @@ eet_data_image_read(Eet_File *ef, * * @since 1.0.2 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_read_to_surface(Eet_File *ef, @@ -1232,6 +1340,10 @@ eet_data_image_read_to_surface(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_write(Eet_File *ef, @@ -1268,6 +1380,10 @@ eet_data_image_write(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_header_decode(const void *data, @@ -1308,6 +1424,10 @@ eet_data_image_header_decode(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_decode(const void *data, @@ -1346,6 +1466,10 @@ eet_data_image_decode(const void *data, * * @since 1.0.2 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_decode_to_surface(const void *data, @@ -1390,6 +1514,10 @@ eet_data_image_decode_to_surface(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_encode(const void *data, @@ -1448,6 +1576,10 @@ eet_data_image_encode(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_header_read_cipher(Eet_File *ef, @@ -1471,6 +1603,10 @@ eet_data_image_header_read_cipher(Eet_File *ef, * * @since 1.10.0 * @ingroup Eet_File_Image_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_colorspace_get(Eet_File *ef, @@ -1516,6 +1652,10 @@ eet_data_image_colorspace_get(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_read_cipher(Eet_File *ef, @@ -1570,6 +1710,10 @@ eet_data_image_read_cipher(Eet_File *ef, * * @since 1.0.2 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_read_to_surface_cipher(Eet_File *ef, @@ -1631,6 +1775,10 @@ eet_data_image_read_to_surface_cipher(Eet_File *ef, * * @since 1.10.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef, @@ -1692,6 +1840,10 @@ eet_data_image_read_to_cspace_surface_cipher(Eet_File *ef, * * @since 1.10.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int @@ -1745,6 +1897,10 @@ eet_data_image_decode_to_cspace_surface_cipher(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_write_cipher(Eet_File *ef, @@ -1794,6 +1950,10 @@ eet_data_image_write_cipher(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_header_decode_cipher(const void *data, @@ -1844,6 +2004,10 @@ eet_data_image_header_decode_cipher(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_decode_cipher(const void *data, @@ -1896,6 +2060,10 @@ eet_data_image_decode_cipher(const void *data, * * @since 1.0.2 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_image_decode_to_surface_cipher(const void *data, @@ -1946,6 +2114,10 @@ eet_data_image_decode_to_surface_cipher(const void *data, * * @since 1.0.0 * @ingroup Eet_File_Image_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_image_encode_cipher(const void *data, @@ -2014,6 +2186,10 @@ typedef int (*Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, voi * @warning You need to compile signature support in EET. * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Key * eet_identity_open(const char *certificate_file, @@ -2029,6 +2205,10 @@ eet_identity_open(const char *certificate_file, * * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_identity_close(Eet_Key *key); @@ -2043,6 +2223,10 @@ eet_identity_close(Eet_Key *key); * * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Error eet_identity_set(Eet_File *ef, @@ -2057,6 +2241,10 @@ eet_identity_set(Eet_File *ef, * @warning You need to compile signature support in EET. * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_identity_print(Eet_Key *key, @@ -2080,6 +2268,10 @@ eet_identity_print(Eet_Key *key, * @warning You need to compile signature support in EET. * @since 1.13 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_identity_verify(Eet_File *ef, @@ -2095,6 +2287,10 @@ eet_identity_verify(Eet_File *ef, * * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void * eet_identity_x509(Eet_File *ef, @@ -2109,6 +2305,10 @@ eet_identity_x509(Eet_File *ef, * @return the raw signature or @c NULL on error. * * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void * eet_identity_signature(Eet_File *ef, @@ -2125,6 +2325,10 @@ eet_identity_signature(Eet_File *ef, * * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void * eet_identity_sha1(Eet_File *ef, @@ -2140,6 +2344,10 @@ eet_identity_sha1(Eet_File *ef, * @warning You need to compile signature support in EET. * @since 1.2.0 * @ingroup Eet_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_identity_certificate_print(const unsigned char *certificate, @@ -2847,6 +3055,8 @@ struct _Eet_Data_Descriptor_Class */ /** + * @internal + * * Create a new empty data structure descriptor. * @param name The string name of this data structure (most be a * global constant and never change). @@ -2929,6 +3139,10 @@ EINA_DEPRECATED EAPI Eet_Data_Descriptor * * * @since 1.2.3 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Data_Descriptor * eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc); @@ -2979,6 +3193,10 @@ eet_data_descriptor_stream_new(const Eet_Data_Descriptor_Class *eddc); * * @since 1.2.3 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Data_Descriptor * eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc); @@ -3000,6 +3218,10 @@ eet_data_descriptor_file_new(const Eet_Data_Descriptor_Class *eddc); * * @since 1.2.3 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, @@ -3041,6 +3263,10 @@ eet_eina_stream_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, * * @since 1.2.3 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, @@ -3075,6 +3301,10 @@ eet_eina_file_data_descriptor_class_set(Eet_Data_Descriptor_Class *eddc, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_data_descriptor_free(Eet_Data_Descriptor *edd); @@ -3084,6 +3314,10 @@ eet_data_descriptor_free(Eet_Data_Descriptor *edd); * * @since 1.8.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd); @@ -3112,6 +3346,10 @@ EAPI const char *eet_data_descriptor_name_get(const Eet_Data_Descriptor *edd); * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_data_descriptor_element_add(Eet_Data_Descriptor *edd, @@ -3150,6 +3388,10 @@ eet_data_descriptor_element_add(Eet_Data_Descriptor *edd, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_read(Eet_File *ef, @@ -3174,6 +3416,10 @@ eet_data_read(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_write(Eet_File *ef, @@ -3239,6 +3485,10 @@ typedef void (*Eet_Dump_Callback)(void *data, const char *str); * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_text_dump(const void *data_in, @@ -3264,6 +3514,10 @@ eet_data_text_dump(const void *data_in, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_text_undump(const char *text, @@ -3292,6 +3546,10 @@ eet_data_text_undump(const char *text, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_dump(Eet_File *ef, @@ -3320,6 +3578,10 @@ eet_data_dump(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_undump(Eet_File *ef, @@ -3354,6 +3616,10 @@ eet_data_undump(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_descriptor_decode(Eet_Data_Descriptor *edd, @@ -3388,6 +3654,10 @@ eet_data_descriptor_decode(Eet_Data_Descriptor *edd, * * @since 1.0.0 * @ingroup Eet_Data_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_descriptor_encode(Eet_Data_Descriptor *edd, @@ -3874,6 +4144,10 @@ eet_data_descriptor_encode(Eet_Data_Descriptor *edd, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_read_cipher(Eet_File *ef, @@ -3910,6 +4184,10 @@ eet_data_read_cipher(Eet_File *ef, * * @since 1.10.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_read_cipher_buffer(Eet_File *ef, @@ -3941,6 +4219,10 @@ eet_data_read_cipher_buffer(Eet_File *ef, * * @since 1.5.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_xattr_cipher_get(const char *filename, @@ -3964,6 +4246,10 @@ eet_data_xattr_cipher_get(const char *filename, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_write_cipher(Eet_File *ef, @@ -3989,6 +4275,10 @@ eet_data_write_cipher(Eet_File *ef, * * @since 1.5.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_data_xattr_cipher_set(const char *filename, @@ -4045,6 +4335,10 @@ eet_data_xattr_cipher_set(const char *filename, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_text_dump_cipher(const void *data_in, @@ -4073,6 +4367,10 @@ eet_data_text_dump_cipher(const void *data_in, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_text_undump_cipher(const char *text, @@ -4104,6 +4402,10 @@ eet_data_text_undump_cipher(const char *text, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_dump_cipher(Eet_File *ef, @@ -4135,6 +4437,10 @@ eet_data_dump_cipher(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_undump_cipher(Eet_File *ef, @@ -4172,6 +4478,10 @@ eet_data_undump_cipher(Eet_File *ef, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd, @@ -4209,6 +4519,10 @@ eet_data_descriptor_decode_cipher(Eet_Data_Descriptor *edd, * * @since 1.0.0 * @ingroup Eet_Data_Cipher_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_descriptor_encode_cipher(Eet_Data_Descriptor *edd, @@ -4269,6 +4583,10 @@ struct _Eet_Node_Data * @param c Character value. * @return A new character node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_char_new(const char *name, @@ -4280,6 +4598,10 @@ eet_node_char_new(const char *name, * @param s short value. * @return A new short node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_short_new(const char *name, @@ -4291,6 +4613,10 @@ eet_node_short_new(const char *name, * @param i integer value. * @return A new integer node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_int_new(const char *name, @@ -4302,6 +4628,10 @@ eet_node_int_new(const char *name, * @param l long long integer value. * @return A new long long integer node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_long_long_new(const char *name, @@ -4313,6 +4643,10 @@ eet_node_long_long_new(const char *name, * @param f float value. * @return A new float node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_float_new(const char *name, @@ -4324,6 +4658,10 @@ eet_node_float_new(const char *name, * @param d double value. * @return A new double node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_double_new(const char *name, @@ -4335,6 +4673,10 @@ eet_node_double_new(const char *name, * @param uc unsigned char value. * @return A new unsigned char node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_unsigned_char_new(const char *name, @@ -4346,6 +4688,10 @@ eet_node_unsigned_char_new(const char *name, * @param us unsigned short value. * @return A new unsigned short node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_unsigned_short_new(const char *name, @@ -4357,6 +4703,10 @@ eet_node_unsigned_short_new(const char *name, * @param ui unsigned integer value. * @return A new unsigned integer node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_unsigned_int_new(const char *name, @@ -4368,6 +4718,10 @@ eet_node_unsigned_int_new(const char *name, * @param l unsigned long long integer value. * @return A new unsigned long long integer node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_unsigned_long_long_new(const char *name, @@ -4379,6 +4733,10 @@ eet_node_unsigned_long_long_new(const char *name, * @param str string value. * @return A new string node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_string_new(const char *name, @@ -4390,6 +4748,10 @@ eet_node_string_new(const char *name, * @param str string value. * @return A new inlined string node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_inlined_string_new(const char *name, @@ -4400,6 +4762,10 @@ eet_node_inlined_string_new(const char *name, * @param name Name of the node. * @return A new empty node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_null_new(const char *name); @@ -4410,6 +4776,10 @@ eet_node_null_new(const char *name); * @param nodes list of nodes. * @return A new list node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_list_new(const char *name, @@ -4422,6 +4792,10 @@ eet_node_list_new(const char *name, * @param nodes list of nodes. * @return A new array node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_array_new(const char *name, @@ -4434,6 +4808,10 @@ eet_node_array_new(const char *name, * @param nodes list of nodes. * @return A new variable array node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_var_array_new(const char *name, @@ -4449,6 +4827,10 @@ eet_node_var_array_new(const char *name, * @param s short value. * @return A new short node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_hash_new(const char *name, @@ -4461,6 +4843,10 @@ eet_node_hash_new(const char *name, * @param nodes list of nodes. * @return A new struct node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_struct_new(const char *name, @@ -4476,6 +4862,10 @@ eet_node_struct_new(const char *name, * @param s short value. * @return A new short node. * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_struct_child_new(const char *parent, @@ -4487,6 +4877,10 @@ eet_node_struct_child_new(const char *parent, * @return The first child node which contains a pointer to the * next child node and the parent. * @since 1.5 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_children_get(Eet_Node *node); @@ -4497,6 +4891,10 @@ eet_node_children_get(Eet_Node *node); * @return A node which contains a pointer to the * next child node and the parent. * @since 1.5 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_next_get(Eet_Node *node); @@ -4506,6 +4904,10 @@ eet_node_next_get(Eet_Node *node); * @param node The node * @return The parent node of @p node * @since 1.5 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_node_parent_get(Eet_Node *node); @@ -4513,6 +4915,10 @@ eet_node_parent_get(Eet_Node *node); /** * @brief Append a "list" node TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_node_list_append(Eet_Node *parent, @@ -4522,6 +4928,10 @@ eet_node_list_append(Eet_Node *parent, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_node_struct_append(Eet_Node *parent, @@ -4531,6 +4941,10 @@ eet_node_struct_append(Eet_Node *parent, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_node_hash_add(Eet_Node *parent, @@ -4541,6 +4955,10 @@ eet_node_hash_add(Eet_Node *parent, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_node_dump(Eet_Node *n, @@ -4553,6 +4971,10 @@ eet_node_dump(Eet_Node *n, * @param node The node * @return The node's type (EET_T_$TYPE) * @since 1.5 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_node_type_get(Eet_Node *node); @@ -4562,6 +4984,10 @@ eet_node_type_get(Eet_Node *node); * @param node The node * @return The data contained in the node * @since 1.5 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node_Data * eet_node_value_get(Eet_Node *node); @@ -4569,6 +4995,10 @@ eet_node_value_get(Eet_Node *node); /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eet_node_del(Eet_Node *n); @@ -4576,6 +5006,10 @@ eet_node_del(Eet_Node *n); /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_data_node_encode_cipher(Eet_Node *node, @@ -4585,6 +5019,10 @@ eet_data_node_encode_cipher(Eet_Node *node, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_data_node_decode_cipher(const void *data_in, @@ -4594,6 +5032,10 @@ eet_data_node_decode_cipher(const void *data_in, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Node * eet_data_node_read_cipher(Eet_File *ef, @@ -4603,6 +5045,10 @@ eet_data_node_read_cipher(Eet_File *ef, /** * TODO FIX ME * @ingroup Eet_Node_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_data_node_write_cipher(Eet_File *ef, @@ -4724,6 +5170,10 @@ typedef Eina_Bool Eet_Write_Cb (const void *data, size_t size, void *user_data); * * @since 1.2.4 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eet_Connection * eet_connection_new(Eet_Read_Cb *eet_read_cb, @@ -4743,6 +5193,10 @@ eet_connection_new(Eet_Read_Cb *eet_read_cb, * * @since 1.2.4 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eet_connection_received(Eet_Connection *conn, @@ -4760,6 +5214,10 @@ eet_connection_received(Eet_Connection *conn, * * @since 1.7 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn); @@ -4779,6 +5237,10 @@ EAPI Eina_Bool eet_connection_empty(Eet_Connection *conn); * * @since 1.2.4 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_connection_send(Eet_Connection *conn, @@ -4801,6 +5263,10 @@ eet_connection_send(Eet_Connection *conn, * * @since 1.2.4 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eet_connection_node_send(Eet_Connection *conn, @@ -4815,6 +5281,10 @@ eet_connection_node_send(Eet_Connection *conn, * * @since 1.2.4 * @ingroup Eet_Connection_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eet_connection_close(Eet_Connection *conn, diff --git a/src/lib/eeze/Eeze.h b/src/lib/eeze/Eeze.h index 93f9a5f..b258a4d 100644 --- a/src/lib/eeze/Eeze.h +++ b/src/lib/eeze/Eeze.h @@ -319,6 +319,8 @@ typedef void(*Eeze_Udev_Watch_Cb)(const char *, Eeze_Udev_Event, void *, Eeze_Ud /** + * @internal + * * Initialize the eeze library. * @return The number of times the function has been called, or -1 on failure. * @@ -330,6 +332,8 @@ typedef void(*Eeze_Udev_Watch_Cb)(const char *, Eeze_Udev_Event, void *, Eeze_Ud EAPI int eeze_init(void); /** + * @internal + * * Shut down the eeze library. * @return The number of times the eeze_init has been called, or -1 when * all occurrences of eeze have been shut down. @@ -341,6 +345,8 @@ EAPI int eeze_init(void); EAPI int eeze_shutdown(void); /** + * @internal + * * @return the main udev context used by the library * This allows for external reuse of the udev context, reducing direct dependency * on libudev. @@ -362,6 +368,8 @@ EAPI void *eeze_udev_get(void); */ /** + * @internal + * * Returns a stringshared list of all syspaths that are (or should be) the same * device as the device pointed at by @p syspath. * @@ -371,6 +379,8 @@ EAPI void *eeze_udev_get(void); EAPI Eina_List *eeze_udev_find_similar_from_syspath(const char *syspath); /** + * @internal + * * Updates a list of all syspaths that are (or should be) the same * device. * @@ -386,6 +396,8 @@ EAPI Eina_List *eeze_udev_find_similar_from_syspath(const char *syspath); EAPI Eina_List *eeze_udev_find_unlisted_similar(Eina_List *list); /** + * @internal + * * Find a list of devices by a sysattr (and, optionally, a value of that sysattr). * * @param sysattr The attribute to find @@ -398,6 +410,8 @@ EAPI Eina_List *eeze_udev_find_unlisted_similar(Eina_List *list); EAPI Eina_List *eeze_udev_find_by_sysattr(const char *sysattr, const char *value); /** + * @internal + * * Find devices using an #Eeze_Udev_Type and/or a name. * * @param type An #Eeze_Udev_Type or 0 @@ -409,6 +423,8 @@ EAPI Eina_List *eeze_udev_find_by_sysattr(const char *sysattr, const char EAPI Eina_List *eeze_udev_find_by_type(Eeze_Udev_Type type, const char *name); /** + * @internal + * * A more advanced find, allows finds using udev properties. * * @param subsystem The udev subsystem to filter by, or @c NULL @@ -422,6 +438,8 @@ EAPI Eina_List *eeze_udev_find_by_type(Eeze_Udev_Type type, const char *na EAPI Eina_List *eeze_udev_find_by_filter(const char *subsystem, const char *type, const char *name); /** + * @internal + * * A more advanced find, allows finds using udev subsystem and sysname * * @param subsystem The udev subsystem to filter by, or @c NULL @@ -452,6 +470,8 @@ EAPI Eina_List *eeze_udev_find_by_subsystem_sysname(const char *subsystem, */ /** + * @internal + * * Get the syspath of a device from the /dev/ path. * * @param devpath The /dev/ path of the device @@ -462,6 +482,8 @@ EAPI Eina_List *eeze_udev_find_by_subsystem_sysname(const char *subsystem, EAPI const char *eeze_udev_devpath_get_syspath(const char *devpath); /** + * @internal + * * Find the root device of a device from its syspath. * * @param syspath The syspath of a device, with or without "/sys/" @@ -472,6 +494,8 @@ EAPI const char *eeze_udev_devpath_get_syspath(const char *devpath); EAPI const char *eeze_udev_syspath_get_parent(const char *syspath); /** + * @internal + * * Find the parent device of a device from its syspath with a filter applied. * * @param syspath The syspath of a device, with or without "/sys/" @@ -485,6 +509,8 @@ EAPI const char *eeze_udev_syspath_get_parent(const char *syspath); EAPI Eina_Stringshare *eeze_udev_syspath_get_parent_filtered(const char *syspath, const char *subsystem, const char *devtype); /** + * @internal + * * Returns a list of all parent device syspaths for @p syspath. * * @param syspath The device to find parents of @@ -493,6 +519,8 @@ EAPI Eina_Stringshare *eeze_udev_syspath_get_parent_filtered(const char *syspath EAPI Eina_List *eeze_udev_syspath_get_parents(const char *syspath); /** + * @internal + * * Get the /dev/ path from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -503,6 +531,8 @@ EAPI Eina_List *eeze_udev_syspath_get_parents(const char *syspath); EAPI const char *eeze_udev_syspath_get_devpath(const char *syspath); /** + * @internal + * * Get the /dev/ name from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -513,6 +543,8 @@ EAPI const char *eeze_udev_syspath_get_devpath(const char *syspath); EAPI const char *eeze_udev_syspath_get_devname(const char *syspath); /** + * @internal + * * Get the subsystem of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -524,6 +556,8 @@ EAPI const char *eeze_udev_syspath_get_devname(const char *syspath); EAPI const char *eeze_udev_syspath_get_subsystem(const char *syspath); /** + * @internal + * * Check the property value of a device from the /sys/ path against a provided value. * * @param syspath The /sys/ path with or without the /sys/ @@ -535,6 +569,8 @@ EAPI const char *eeze_udev_syspath_get_subsystem(const char *syspath); EAPI Eina_Bool eeze_udev_syspath_check_property(const char *syspath, const char *property, const char *value); /** + * @internal + * * Get the property value of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -544,6 +580,8 @@ EAPI Eina_Bool eeze_udev_syspath_check_property(const char *syspath, const char EAPI const char *eeze_udev_syspath_get_property(const char *syspath, const char *property); /** + * @internal + * * Get the sysattr value of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -553,6 +591,8 @@ EAPI const char *eeze_udev_syspath_get_property(const char *syspath, const EAPI const char *eeze_udev_syspath_get_sysattr(const char *syspath, const char *sysattr); /** + * @internal + * * Check the sysattr value of a device from the /sys/ path against a provided value. * * @param syspath The /sys/ path with or without the /sys/ @@ -564,6 +604,8 @@ EAPI const char *eeze_udev_syspath_get_sysattr(const char *syspath, const c EAPI Eina_Bool eeze_udev_syspath_check_sysattr(const char *syspath, const char *sysattr, const char *value); /** + * @internal + * * Set the sysattr value of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -575,6 +617,8 @@ EAPI Eina_Bool eeze_udev_syspath_check_sysattr(const char *syspath, const char * EAPI Eina_Bool eeze_udev_syspath_set_sysattr(const char *syspath, const char *sysattr, double value); /** + * @internal + * * Get the sysattr list of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -584,6 +628,8 @@ EAPI Eina_Bool eeze_udev_syspath_set_sysattr(const char *syspath, const char *sy EAPI Eina_List *eeze_udev_syspath_get_sysattr_list(const char *syspath); /** + * @internal + * * Checks whether the device is a mouse. * * @param syspath The /sys/ path with or without the /sys/ @@ -592,6 +638,8 @@ EAPI Eina_List *eeze_udev_syspath_get_sysattr_list(const char *syspath); EAPI Eina_Bool eeze_udev_syspath_is_mouse(const char *syspath); /** + * @internal + * * Checks whether the device is a keyboard. * * @param syspath The /sys/ path with or without the /sys/ @@ -600,6 +648,8 @@ EAPI Eina_Bool eeze_udev_syspath_is_mouse(const char *syspath); EAPI Eina_Bool eeze_udev_syspath_is_kbd(const char *syspath); /** + * @internal + * * Checks whether the device is a touchpad. * * @param syspath The /sys/ path with or without the /sys/ @@ -608,6 +658,8 @@ EAPI Eina_Bool eeze_udev_syspath_is_kbd(const char *syspath); EAPI Eina_Bool eeze_udev_syspath_is_touchpad(const char *syspath); /** + * @internal + * * Checks whether the device is a joystick. * * @param syspath The /sys/ path with or without the /sys/ @@ -617,6 +669,8 @@ EAPI Eina_Bool eeze_udev_syspath_is_touchpad(const char *syspath); EAPI Eina_Bool eeze_udev_syspath_is_joystick(const char *syspath); /** + * @internal + * * Get the sysnum value of a device from the /sys/ path. * * @param syspath The /sys/ path with or without the /sys/ @@ -642,6 +696,8 @@ EAPI int eeze_udev_syspath_get_sysnum(const char *syspath); */ /** + * @internal + * * Walks up the device chain starting at @p syspath, * checking each device for @p sysattr with (optional) @p value. * @@ -654,6 +710,8 @@ EAPI int eeze_udev_syspath_get_sysnum(const char *syspath); EAPI Eina_Bool eeze_udev_walk_check_sysattr(const char *syspath, const char *sysattr, const char *value); /** + * @internal + * * Walks up the device chain starting at @p syspath, * checking each device for @p sysattr, and returns the value if found. * @@ -684,6 +742,8 @@ EAPI const char *eeze_udev_walk_get_sysattr(const char *syspath, const char */ /** + * @internal + * * Add a watch for a device type * * @param type The #Eeze_Udev_Type to watch @@ -700,6 +760,8 @@ EAPI const char *eeze_udev_walk_get_sysattr(const char *syspath, const char EAPI Eeze_Udev_Watch *eeze_udev_watch_add(Eeze_Udev_Type type, int event, Eeze_Udev_Watch_Cb cb, void *user_data); /** + * @internal + * * Deletes a watch. * * @param watch An Eeze_Udev_Watch object diff --git a/src/lib/eeze/Eeze_Disk.h b/src/lib/eeze/Eeze_Disk.h index 380324d..2f1927b 100644 --- a/src/lib/eeze/Eeze_Disk.h +++ b/src/lib/eeze/Eeze_Disk.h @@ -110,6 +110,8 @@ struct _Eeze_Event_Disk_Error }; /** + * @internal + * * @brief Use this function to determine whether your eeze is disk-capable * * Since applications will die if they run/compile against a function that doesn't exist, @@ -119,6 +121,8 @@ struct _Eeze_Event_Disk_Error EAPI void eeze_disk_function(void); /** + * @internal + * * @brief Return whether mount support is available in eeze * * Use this function to determine whether your Eeze library was compiled with a mount @@ -128,6 +132,8 @@ EAPI void eeze_disk_function(void); EAPI Eina_Bool eeze_disk_can_mount(void); /** + * @internal + * * @brief Return whether unmount support is available in eeze * * Use this function to determine whether your Eeze library was compiled with an unmount @@ -137,6 +143,8 @@ EAPI Eina_Bool eeze_disk_can_mount(void); EAPI Eina_Bool eeze_disk_can_unmount(void); /** + * @internal + * * @brief Return whether eject support is available in eeze * * Use this function to determine whether your Eeze library was compiled with an eject @@ -146,6 +154,8 @@ EAPI Eina_Bool eeze_disk_can_unmount(void); EAPI Eina_Bool eeze_disk_can_eject(void); /** + * @internal + * * @brief Create a new disk object from a /sys/ path or /dev/ path * @param path The /sys/ or /dev path of the disk; CANNOT be @c NULL. * @return The new disk object @@ -158,6 +168,8 @@ EAPI Eina_Bool eeze_disk_can_eject(void); EAPI Eeze_Disk *eeze_disk_new(const char *path); /** + * @internal + * * @brief Create a new disk object from a mount point * @param mount_point The mount point of the disk; CANNOT be @c NULL * @return The new disk object @@ -171,6 +183,8 @@ EAPI Eeze_Disk *eeze_disk_new(const char *path); EAPI Eeze_Disk *eeze_disk_new_from_mount(const char *mount_point); /** + * @internal + * * @brief Frees a disk object * @param disk The disk object to free * @@ -180,6 +194,8 @@ EAPI Eeze_Disk *eeze_disk_new_from_mount(const char *mount_point); EAPI void eeze_disk_free(Eeze_Disk *disk); /** + * @internal + * * @brief Retrieve all disk information * @param disk * @@ -191,6 +207,8 @@ EAPI void eeze_disk_free(Eeze_Disk *disk); EAPI void eeze_disk_scan(Eeze_Disk *disk); /** + * @internal + * * @brief Associate data with a disk * @param disk The disk * @param data The data @@ -202,6 +220,8 @@ EAPI void eeze_disk_scan(Eeze_Disk *disk); EAPI void eeze_disk_data_set(Eeze_Disk *disk, void *data); /** + * @internal + * * @brief Retrieve data previously associated with a disk * @param disk The disk * @return The data @@ -214,6 +234,8 @@ EAPI void eeze_disk_data_set(Eeze_Disk *disk, void *data); EAPI void *eeze_disk_data_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the /sys/ path of a disk * @param disk The disk * @return The /sys/ path @@ -224,6 +246,8 @@ EAPI void *eeze_disk_data_get(Eeze_Disk *disk); EAPI const char *eeze_disk_syspath_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the /dev/ path of a disk * @param disk The disk * @return The /dev/ path @@ -234,6 +258,8 @@ EAPI const char *eeze_disk_syspath_get(Eeze_Disk *disk); EAPI const char *eeze_disk_devpath_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the filesystem of the disk (if known) * @param disk The disk * @return The filesystem type @@ -244,6 +270,8 @@ EAPI const char *eeze_disk_devpath_get(Eeze_Disk *disk); EAPI const char *eeze_disk_fstype_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the manufacturing vendor of the disk * @param disk The disk * @return The vendor @@ -254,6 +282,8 @@ EAPI const char *eeze_disk_fstype_get(Eeze_Disk *disk); EAPI const char *eeze_disk_vendor_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the model of the disk * @param disk The disk * @return The model @@ -264,6 +294,8 @@ EAPI const char *eeze_disk_vendor_get(Eeze_Disk *disk); EAPI const char *eeze_disk_model_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the serial number of the disk * @param disk The disk * @return The serial number @@ -274,6 +306,8 @@ EAPI const char *eeze_disk_model_get(Eeze_Disk *disk); EAPI const char *eeze_disk_serial_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the UUID of the disk * @param disk The disk * @return The UUID @@ -286,6 +320,8 @@ EAPI const char *eeze_disk_serial_get(Eeze_Disk *disk); EAPI const char *eeze_disk_uuid_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the label of the disk * @param disk The disk * @return The label @@ -296,6 +332,8 @@ EAPI const char *eeze_disk_uuid_get(Eeze_Disk *disk); EAPI const char *eeze_disk_label_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the #Eeze_Disk_Type of the disk * @param disk The disk * @return The type @@ -307,6 +345,8 @@ EAPI const char *eeze_disk_label_get(Eeze_Disk *disk); EAPI Eeze_Disk_Type eeze_disk_type_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return whether the disk is removable * @param disk The disk * @return @c EINA_TRUE if removable, @c EINA_FALSE otherwise. @@ -316,6 +356,8 @@ EAPI Eina_Bool eeze_disk_removable_get(Eeze_Disk *disk); /** + * @internal + * * @brief Return the mount state of a disk * @param disk The disk * @return The mount state @@ -327,6 +369,8 @@ EAPI Eina_Bool eeze_disk_removable_get(Eeze_Disk *disk); EAPI Eina_Bool eeze_disk_mounted_get(Eeze_Disk *disk); /** + * @internal + * * @brief Get the previously set mount wrapper for a disk * @param disk The disk * @return The wrapper, or @c NULL on failure. @@ -337,6 +381,8 @@ EAPI Eina_Bool eeze_disk_mounted_get(Eeze_Disk *disk); EAPI const char *eeze_disk_mount_wrapper_get(Eeze_Disk *disk); /** + * @internal + * * @brief Set a wrapper to run mount commands with * @param disk The disk to wrap mount commands for * @param wrapper The wrapper executable @@ -350,6 +396,8 @@ EAPI const char *eeze_disk_mount_wrapper_get(Eeze_Disk *disk); EAPI Eina_Bool eeze_disk_mount_wrapper_set(Eeze_Disk *disk, const char *wrapper); /** + * @internal + * * @brief Begin a mount operation on the disk * @param disk The disk * @return @c EINA_TRUE if the operation was started, @c EINA_FALSE otherwise. @@ -366,6 +414,8 @@ EAPI Eina_Bool eeze_disk_mount_wrapper_set(Eeze_Disk *disk, const char *wra EAPI Eina_Bool eeze_disk_mount(Eeze_Disk *disk); /** + * @internal + * * @brief Begin an unmount operation on the disk * @param disk The disk * @return @c EINA_TRUE if the operation was started, @c EINA_FALSE otherwise. @@ -382,6 +432,8 @@ EAPI Eina_Bool eeze_disk_mount(Eeze_Disk *disk); EAPI Eina_Bool eeze_disk_unmount(Eeze_Disk *disk); /** + * @internal + * * @brief Begin an eject operation on the disk * @param disk The disk * @return @c EINA_TRUE if the operation was started, @c EINA_FALSE otherwise. @@ -397,6 +449,8 @@ EAPI Eina_Bool eeze_disk_unmount(Eeze_Disk *disk); */ EAPI Eina_Bool eeze_disk_eject(Eeze_Disk *disk); /** + * @internal + * * @brief Cancel a pending operation on the disk * @param disk The disk * @@ -407,6 +461,8 @@ EAPI Eina_Bool eeze_disk_eject(Eeze_Disk *disk); EAPI void eeze_disk_cancel(Eeze_Disk *disk); /** + * @internal + * * @brief Return the mount point of a disk * @param disk The disk * @return The mount point @@ -418,6 +474,8 @@ EAPI void eeze_disk_cancel(Eeze_Disk *disk); EAPI const char *eeze_disk_mount_point_get(Eeze_Disk *disk); /** + * @internal + * * @brief Set the mount point of a disk * @param disk The disk * @param mount_point The mount point @@ -431,6 +489,8 @@ EAPI const char *eeze_disk_mount_point_get(Eeze_Disk *disk); EAPI Eina_Bool eeze_disk_mount_point_set(Eeze_Disk *disk, const char *mount_point); /** + * @internal + * * @brief Set the mount options using flags * @param disk The disk * @param opts An ORed set of #Eeze_Mount_Opts @@ -442,6 +502,8 @@ EAPI Eina_Bool eeze_disk_mount_point_set(Eeze_Disk *disk, const char *mount EAPI Eina_Bool eeze_disk_mountopts_set(Eeze_Disk *disk, unsigned long opts); /** + * @internal + * * @brief Get the flags of a disk's current mount options * @param disk The disk * @return An ORed set of #Eeze_Mount_Opts, 0 on failure @@ -453,6 +515,8 @@ EAPI unsigned long eeze_disk_mountopts_get(Eeze_Disk *disk); /** + * @internal + * * @brief Begin watching mtab and fstab * @return @c EINA_TRUE if watching was started, @c EINA_FALSE otherwise. * @@ -466,6 +530,8 @@ EAPI unsigned long eeze_disk_mountopts_get(Eeze_Disk *disk); EAPI Eina_Bool eeze_mount_tabs_watch(void); /** + * @internal + * * @brief Stop watching /etc/fstab and /etc/mtab * * This function stops watching fstab and mtab. Data obtained previously will be saved. @@ -474,6 +540,8 @@ EAPI Eina_Bool eeze_mount_tabs_watch(void); EAPI void eeze_mount_tabs_unwatch(void); /** + * @internal + * * @brief Scan /etc/mtab a single time * @return @c EINA_TRUE if mtab could be scanned, @c EINA_FALSE otherwise. * @@ -489,6 +557,8 @@ EAPI void eeze_mount_tabs_unwatch(void); EAPI Eina_Bool eeze_mount_mtab_scan(void); /** + * @internal + * * @brief Scan /etc/fstab a single time * @return @c EINA_TRUE if mtab could be scanned, @c EINA_FALSE otherwise. * @@ -504,6 +574,8 @@ EAPI Eina_Bool eeze_mount_mtab_scan(void); EAPI Eina_Bool eeze_mount_fstab_scan(void); /** + * @internal + * * @brief Get the property value of a disk * * @param disk The disk @@ -515,6 +587,8 @@ EAPI Eina_Bool eeze_mount_fstab_scan(void); EAPI const char *eeze_disk_udev_get_property(Eeze_Disk *disk, const char *property); /** + * @internal + * * @brief Get the sysattr value of a disk. * * @param disk The disk @@ -526,6 +600,8 @@ EAPI const char *eeze_disk_udev_get_property(Eeze_Disk *disk, const char *pro EAPI const char *eeze_disk_udev_get_sysattr(Eeze_Disk *disk, const char *sysattr); /** + * @internal + * * Find the root device of a disk. * * @param disk The disk @@ -537,6 +613,8 @@ EAPI const char *eeze_disk_udev_get_sysattr(Eeze_Disk *disk, const char *sysa EAPI const char *eeze_disk_udev_get_parent(Eeze_Disk *disk); /** + * @internal + * * Walks up the device chain using the device from @p disk, * checking each device for @p sysattr with (optional) @p value. * @@ -551,6 +629,8 @@ EAPI const char *eeze_disk_udev_get_parent(Eeze_Disk *disk); EAPI Eina_Bool eeze_disk_udev_walk_check_sysattr(Eeze_Disk *disk, const char *sysattr, const char *value); /** + * @internal + * * @brief Walks up the device chain of @p disk * checking each device for @p sysattr and returns the value if found. * diff --git a/src/lib/eeze/Eeze_Sensor.h b/src/lib/eeze/Eeze_Sensor.h index d5fd34d..0b29098 100644 --- a/src/lib/eeze/Eeze_Sensor.h +++ b/src/lib/eeze/Eeze_Sensor.h @@ -92,6 +92,8 @@ typedef enum /** * @internal + * + * @internal * @defgroup Eeze_Sensor_Events Available eeze sensor events * @brief Sensor events that are emitted from the library as ecore events * @ingroup Eeze @@ -158,6 +160,8 @@ extern "C" { #endif /** + * @internal + * * @brief Create sensor object to operate on. * @param type Sensor type to create object from. * @return Sensor object for the given type. @@ -180,6 +184,8 @@ extern "C" { EAPI Eeze_Sensor_Obj *eeze_sensor_new(Eeze_Sensor_Type type); /** + * @internal + * * @brief Free a sensor object. * @param sens Sensor object to operate on. * @@ -191,6 +197,8 @@ EAPI Eeze_Sensor_Obj *eeze_sensor_new(Eeze_Sensor_Type type); EAPI void eeze_sensor_free(Eeze_Sensor_Obj *sens); /** + * @internal + * * @brief Get accuracy from sensor object. * @param sens Sensor object to operate on. * @param accuracy Pointer to write accuracy value into. @@ -209,6 +217,8 @@ EAPI void eeze_sensor_free(Eeze_Sensor_Obj *sens); EAPI Eina_Bool eeze_sensor_accuracy_get(Eeze_Sensor_Obj *sens, int *accuracy); /** + * @internal + * * @brief Get data from all three data properties * @param sens Sensor object to operate on. * @param x Pointer to write first data property value into. @@ -225,6 +235,8 @@ EAPI Eina_Bool eeze_sensor_accuracy_get(Eeze_Sensor_Obj *sens, int *accuracy); EAPI Eina_Bool eeze_sensor_xyz_get(Eeze_Sensor_Obj *sens, float *x, float *y, float *z); /** + * @internal + * * @brief Get data from first two data properties * @param sens Sensor object to operate on. * @param x Pointer to write first data property value into. @@ -239,6 +251,8 @@ EAPI Eina_Bool eeze_sensor_xyz_get(Eeze_Sensor_Obj *sens, float *x, float *y, fl EAPI Eina_Bool eeze_sensor_xy_get(Eeze_Sensor_Obj *sens, float *x, float *y); /** + * @internal + * * @brief Get the data from first data property * @param sens Sensor object to operate on. * @param x Pointer to write first data property value into. @@ -252,6 +266,8 @@ EAPI Eina_Bool eeze_sensor_xy_get(Eeze_Sensor_Obj *sens, float *x, float *y); EAPI Eina_Bool eeze_sensor_x_get(Eeze_Sensor_Obj *sens, float *x); /** + * @internal + * * @brief Get timestamp from sensor object. * @param sens Sensor object to operate on. * @param timestamp Pointer to write timestamp value into. @@ -266,6 +282,8 @@ EAPI Eina_Bool eeze_sensor_x_get(Eeze_Sensor_Obj *sens, float *x); EAPI Eina_Bool eeze_sensor_timestamp_get(Eeze_Sensor_Obj *sens, double *timestamp); /** + * @internal + * * @brief Read out sensor data * @param sens Sensor object to operate on. * @return EINA_TRUE for success and EINA_FALSE for failure @@ -283,6 +301,8 @@ EAPI Eina_Bool eeze_sensor_timestamp_get(Eeze_Sensor_Obj *sens, double *timestam EAPI Eina_Bool eeze_sensor_read(Eeze_Sensor_Obj *sens); /** + * @internal + * * @brief Asynchronous read out sensor data * @param sens Sensor object to operate on. * @param user_data Data to pass to the callback function. diff --git a/src/lib/efreet/Efreet.h b/src/lib/efreet/Efreet.h index e83784d..23e22a8 100644 --- a/src/lib/efreet/Efreet.h +++ b/src/lib/efreet/Efreet.h @@ -129,12 +129,16 @@ extern "C" { #include "efreet_uri.h" /** + * @internal + * * @return Value > @c 0 if the initialization was successful, @c 0 otherwise. * @brief Initializes the Efreet system */ EAPI int efreet_init(void); /** + * @internal + * * @return The number of times the init function has been called minus the * corresponding init call. * @brief Shuts down Efreet if a balanced number of init/shutdown calls have @@ -143,6 +147,8 @@ EAPI int efreet_init(void); EAPI int efreet_shutdown(void); /** + * @internal + * * @brief Resets language dependent variables and resets language dependent * caches This must be called whenever the locale is changed. * @since 1.7 diff --git a/src/lib/efreet/Efreet_Mime.h b/src/lib/efreet/Efreet_Mime.h index b799952..65740f0 100644 --- a/src/lib/efreet/Efreet_Mime.h +++ b/src/lib/efreet/Efreet_Mime.h @@ -47,12 +47,16 @@ extern "C" { /** + * @internal + * * @return @c 1 on success or @c 0 on failure. * @brief Initializes the efreet mime settings */ EAPI int efreet_mime_init(void); /** + * @internal + * * @return The number of times the init function has been called minus the * corresponding init call. * @brief Shuts down Efreet mime settings system if a balanced number of @@ -61,6 +65,8 @@ EAPI int efreet_mime_init(void); EAPI int efreet_mime_shutdown(void); /** + * @internal + * * @param file The file to find the mime type * @return Mime type as a string. * @brief Retrieve the mime type of a file @@ -68,6 +74,8 @@ EAPI int efreet_mime_shutdown(void); EAPI const char *efreet_mime_type_get(const char *file); /** + * @internal + * * @param file The file to check the mime type * @return Mime type as a string. * @brief Retrieve the mime type of a file using magic @@ -75,6 +83,8 @@ EAPI const char *efreet_mime_type_get(const char *file); EAPI const char *efreet_mime_magic_type_get(const char *file); /** + * @internal + * * @param file The file to check the mime type * @return Mime type as a string. * @brief Retrieve the mime type of a file using globs @@ -82,6 +92,8 @@ EAPI const char *efreet_mime_magic_type_get(const char *file); EAPI const char *efreet_mime_globs_type_get(const char *file); /** + * @internal + * * @param file The file to check the mime type * @return Mime type as a string. * @brief Retrieve the special mime type of a file @@ -89,6 +101,8 @@ EAPI const char *efreet_mime_globs_type_get(const char *file); EAPI const char *efreet_mime_special_type_get(const char *file); /** + * @internal + * * @param file The file to check the mime type * @return Mime type as a string. * @brief Retrieve the fallback mime type of a file. @@ -97,6 +111,8 @@ EAPI const char *efreet_mime_fallback_type_get(const char *file); /** + * @internal + * * @param mime The name of the mime type * @param theme The name of the theme to search icons in * @param size The wanted size of the icon @@ -107,11 +123,15 @@ EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme, unsigned int size); /** + * @internal + * * @brief Clear mime icons mapping cache */ EAPI void efreet_mime_type_cache_clear(void); /** + * @internal + * * @brief Flush mime icons mapping cache * * Flush timeout is defined at compile time by diff --git a/src/lib/efreet/Efreet_Trash.h b/src/lib/efreet/Efreet_Trash.h index c5d796b..c7a5413 100644 --- a/src/lib/efreet/Efreet_Trash.h +++ b/src/lib/efreet/Efreet_Trash.h @@ -44,18 +44,24 @@ extern "C" { */ /** + * @internal + * * @return @c 1 on success or @c 0 on failure. * @brief Initializes the efreet trash system */ EAPI int efreet_trash_init(void); /** + * @internal + * * @return No value. * @brief Cleans up the efreet trash system */ EAPI int efreet_trash_shutdown(void); /** + * @internal + * * @return The XDG Trash local directory or @c NULL on errors. * Return value must be freed with eina_stringshare_del. * @brief Retrieves the XDG Trash local directory @@ -63,6 +69,8 @@ EAPI int efreet_trash_shutdown(void); EAPI const char *efreet_trash_dir_get(const char *for_file); /** + * @internal + * * @param uri The local uri to move in the trash * @param force_delete If you set this to @c 1 than files on different filesystems * will be deleted permanently @@ -76,6 +84,8 @@ EAPI const char *efreet_trash_dir_get(const char *for_file); EAPI int efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete); /** + * @internal + * * @return A list of strings with filename (remember to free the list * when you don't need anymore). * @brief List all the files and directory currently inside the trash. @@ -83,12 +93,16 @@ EAPI int efreet_trash_delete_uri(Efreet_Uri *uri, int force_delete); EAPI Eina_List *efreet_trash_ls(void); /** + * @internal + * * @return @c 1 if the trash is empty or @c 0 if some file are in. * @brief Check if the trash is currently empty */ EAPI int efreet_trash_is_empty(void); /** + * @internal + * * @return @c 1 on success or @c 0 on failure. * @brief Delete all the files inside the trash. */ diff --git a/src/lib/efreet/efreet_base.h b/src/lib/efreet/efreet_base.h index ecc927c..9411c7a 100644 --- a/src/lib/efreet/efreet_base.h +++ b/src/lib/efreet/efreet_base.h @@ -17,6 +17,8 @@ /** + * @internal + * * @return Returns the XDG Data Home directory * @brief Retrieves the XDG Data Home directory * @@ -26,6 +28,8 @@ EAPI const char *efreet_data_home_get(void); /** + * @internal + * * @return Returns the Eina_List of preference ordered extra data directories * @brief Returns the Eina_List of preference ordered extra data directories * @@ -40,6 +44,8 @@ EAPI Eina_List *efreet_data_dirs_get(void); /** + * @internal + * * @return Returns the XDG Config Home directory * @brief Retrieves the XDG Config Home directory * @@ -49,6 +55,8 @@ EAPI Eina_List *efreet_data_dirs_get(void); EAPI const char *efreet_config_home_get(void); /** + * @internal + * * @return Returns the XDG Desktop directory * @brief Retrieves the XDG Desktop directory * @@ -61,6 +69,8 @@ EAPI const char *efreet_config_home_get(void); EAPI const char *efreet_desktop_dir_get(void); /** + * @internal + * * @return Returns the XDG Download directory * @brief Retrieves the XDG Download directory * @@ -81,6 +91,8 @@ EAPI const char *efreet_desktop_dir_get(void); EAPI const char *efreet_download_dir_get(void); /** + * @internal + * * @return Returns the XDG Templates directory * @brief Retrieves the XDG Templates directory * @@ -98,6 +110,8 @@ EAPI const char *efreet_download_dir_get(void); EAPI const char *efreet_templates_dir_get(void); /** + * @internal + * * @return Returns the XDG Public Share directory * @brief Retrieves the XDG Public Share directory * @@ -112,6 +126,8 @@ EAPI const char *efreet_templates_dir_get(void); EAPI const char *efreet_public_share_dir_get(void); /** + * @internal + * * @return Returns the XDG Documents directory * @brief Retrieves the XDG Documents directory * @@ -129,6 +145,8 @@ EAPI const char *efreet_public_share_dir_get(void); EAPI const char *efreet_documents_dir_get(void); /** + * @internal + * * @return Returns the XDG Music directory * @brief Retrieves the XDG Music directory * @@ -146,6 +164,8 @@ EAPI const char *efreet_documents_dir_get(void); EAPI const char *efreet_music_dir_get(void); /** + * @internal + * * @return Returns the XDG Pictures directory * @brief Retrieves the XDG Pictures directory * @@ -163,6 +183,8 @@ EAPI const char *efreet_music_dir_get(void); EAPI const char *efreet_pictures_dir_get(void); /** + * @internal + * * @return Returns the XDG Videos directory * @brief Retrieves the XDG Videos directory * @@ -180,6 +202,8 @@ EAPI const char *efreet_pictures_dir_get(void); EAPI const char *efreet_videos_dir_get(void); /** + * @internal + * * @return Returns the Eina_List of preference ordered extra config directories * @brief Returns the Eina_List of preference ordered extra config * directories @@ -195,6 +219,8 @@ EAPI Eina_List *efreet_config_dirs_get(void); /** + * @internal + * * @return Returns the XDG Cache Home directory * @brief Retrieves the XDG Cache Home directory * @@ -209,6 +235,8 @@ EAPI Eina_List *efreet_config_dirs_get(void); EAPI const char *efreet_cache_home_get(void); /** + * @internal + * * @return Returns the XDG User Runtime directory. * @brief Retrieves the XDG User Runtime directory. * @@ -256,6 +284,8 @@ EAPI const char *efreet_cache_home_get(void); EAPI const char *efreet_runtime_dir_get(void); /** + * @internal + * * @return Returns the current hostname * @brief Returns the current hostname or empty string if not found */ diff --git a/src/lib/efreet/efreet_desktop.h b/src/lib/efreet/efreet_desktop.h index d0f42a4..2283a89 100644 --- a/src/lib/efreet/efreet_desktop.h +++ b/src/lib/efreet/efreet_desktop.h @@ -19,12 +19,16 @@ EAPI extern int EFREET_DESKTOP_TYPE_LINK; EAPI extern int EFREET_DESKTOP_TYPE_DIRECTORY; /** + * @internal + * * Event id for cache update. All users of efreet_desktop_get must listen to * this event and refetch. The old eet cache will be closed and mem will * be invalidated. */ EAPI extern int EFREET_EVENT_DESKTOP_CACHE_UPDATE; /** + * @internal + * * Event id for cache build complete. * @since 1.1.0 */ @@ -133,6 +137,8 @@ struct _Efreet_Desktop /** + * @internal + * * @param file The file to get the Efreet_Desktop from * @return Returns a reference to a cached Efreet_Desktop on success, NULL * on failure @@ -150,6 +156,8 @@ struct _Efreet_Desktop EAPI Efreet_Desktop *efreet_desktop_get(const char *file); /** + * @internal + * * @param desktop The Efreet_Desktop to ref * @return Returns the new reference count * @brief Increases reference count on desktop @@ -157,6 +165,8 @@ EAPI Efreet_Desktop *efreet_desktop_get(const char *file); EAPI int efreet_desktop_ref(Efreet_Desktop *desktop); /** + * @internal + * * @param file The file to create the Efreet_Desktop from * @return Returns a new empty_Efreet_Desktop on success, NULL on failure * @brief Creates a new empty Efreet_Desktop structure or NULL on failure @@ -164,6 +174,8 @@ EAPI int efreet_desktop_ref(Efreet_Desktop *desktop); EAPI Efreet_Desktop *efreet_desktop_empty_new(const char *file); /** + * @internal + * * @param file The file to get the Efreet_Desktop from * @return Returns a reference to a cached Efreet_Desktop on success, NULL * on failure @@ -178,6 +190,8 @@ EAPI Efreet_Desktop *efreet_desktop_empty_new(const char *file); EAPI Efreet_Desktop *efreet_desktop_new(const char *file); /** + * @internal + * * @param file The file to create the Efreet_Desktop from * @return Returns a new Efreet_Desktop on success, NULL on failure * @brief Creates a new Efreet_Desktop structure initialized from the @@ -192,6 +206,8 @@ EAPI Efreet_Desktop *efreet_desktop_new(const char *file); EAPI Efreet_Desktop *efreet_desktop_uncached_new(const char *file); /** + * @internal + * * @param desktop The Efreet_Desktop to work with * @return Returns no value * @brief Frees the Efreet_Desktop structure and all of it's data @@ -206,6 +222,8 @@ EAPI void efreet_desktop_free(Efreet_Desktop *desktop); /** + * @internal + * * @param desktop The desktop file to save * @return Returns 1 on success or 0 on failure * @brief Saves any changes made to @a desktop back to the file on the @@ -214,6 +232,8 @@ EAPI void efreet_desktop_free(Efreet_Desktop *desktop); EAPI int efreet_desktop_save(Efreet_Desktop *desktop); /** + * @internal + * * @param desktop The desktop file to save * @param file The filename to save as * @return Returns 1 on success or 0 on failure @@ -227,6 +247,8 @@ EAPI int efreet_desktop_save_as(Efreet_Desktop *desktop, /** + * @internal + * * @param desktop The desktop file to work with * @param files The files to be substituted into the exec line * @param data The data pointer to pass @@ -237,12 +259,16 @@ EAPI void efreet_desktop_exec(Efreet_Desktop *desktop, /** + * @internal + * * @param environment the environment name * @brief sets the global desktop environment name */ EAPI void efreet_desktop_environment_set(const char *environment); /** + * @internal + * * @return environment the environment name * @brief gets the global desktop environment name * (e.g. "Enlightenment" or "Gnome") @@ -250,6 +276,8 @@ EAPI void efreet_desktop_environment_set(const char *environment); EAPI const char *efreet_desktop_environment_get(void); /** + * @internal + * * @param desktop the desktop entry * @param files an eina list of file names to execute, as either absolute paths, * relative paths, or uris @@ -266,6 +294,8 @@ EAPI void *efreet_desktop_command_progress_get(Efreet_Desktop *deskt Efreet_Desktop_Progress_Cb cb_prog, void *data); /** + * @internal + * * @param desktop the desktop entry * @param files an eina list of file names to execute, as either absolute paths, * relative paths, or uris @@ -280,6 +310,8 @@ EAPI void *efreet_desktop_command_get(Efreet_Desktop *desktop, void *data); /** + * @internal + * * @param desktop the desktop entry * @param files an eina list of local files, as absolute paths, local paths, or file// uris (or NULL to get exec string with no files appended) * @return Returns an eina list of exec strings @@ -292,6 +324,8 @@ EAPI Eina_List * efreet_desktop_command_local_get(Efreet_Desktop *desktop, /** + * @internal + * * @param desktop The desktop to work with * @return Returns the number of categories assigned to this desktop * @brief Retrieves the number of categories the given @a desktop belongs @@ -300,6 +334,8 @@ EAPI Eina_List * efreet_desktop_command_local_get(Efreet_Desktop *desktop, EAPI unsigned int efreet_desktop_category_count_get(Efreet_Desktop *desktop); /** + * @internal + * * @param desktop the desktop * @param category the category name * @brief add a category to a desktop @@ -308,6 +344,8 @@ EAPI void efreet_desktop_category_add(Efreet_Desktop *desktop, const char *category); /** + * @internal + * * @param desktop the desktop * @param category the category name * @brief removes a category from a desktop @@ -318,6 +356,8 @@ EAPI int efreet_desktop_category_del(Efreet_Desktop *desktop, /** + * @internal + * * @param type The type to add to the list of matching types * @param parse_func a function to parse out custom fields * @param save_func a function to save data returned from @a parse_func @@ -331,6 +371,8 @@ EAPI int efreet_desktop_type_add(const char *type, Efreet_Desktop_Type_Free_Cb free_func); /** + * @internal + * * @brief Add an alias for an existing desktop type. * @param from_type the type to alias (e.g. EFREE_DESKTOP_TYPE_APPLICATION) * @param alias the alias @@ -342,6 +384,8 @@ EAPI int efreet_desktop_type_alias (int from_type, const char *alias); /** + * @internal + * * @brief get type specific data for custom desktop types * @param desktop the desktop * @return type specific data, or NULL if there is none @@ -350,6 +394,8 @@ EAPI void *efreet_desktop_type_data_get(Efreet_Desktop *desktop); /** + * @internal + * * @param string the raw string list * @return an Eina_List of ecore string's * @brief Parse ';' separate list of strings according to the desktop spec @@ -357,6 +403,8 @@ EAPI void *efreet_desktop_type_data_get(Efreet_Desktop *desktop); EAPI Eina_List *efreet_desktop_string_list_parse(const char *string); /** + * @internal + * * @param list Eina_List with strings * @return a raw string list * @brief Create a ';' separate list of strings according to the desktop spec @@ -365,6 +413,8 @@ EAPI char *efreet_desktop_string_list_join(Eina_List *list); /** + * @internal + * * @brief Set the value for a X- field (Non spec) in the structure * @param desktop the desktop * @param key the key name to set @@ -376,6 +426,8 @@ EAPI char *efreet_desktop_string_list_join(Eina_List *list); EAPI Eina_Bool efreet_desktop_x_field_set(Efreet_Desktop *desktop, const char *key, const char *data); /** + * @internal + * * @brief Get the value for a X- field (Non spec) in the structure * @param desktop the desktop * @param key the key @@ -384,6 +436,8 @@ EAPI Eina_Bool efreet_desktop_x_field_set(Efreet_Desktop *desktop, const EAPI const char * efreet_desktop_x_field_get(Efreet_Desktop *desktop, const char *key); /** + * @internal + * * @brief Delete the key and value for a X- field (Non spec) in the structure * @param desktop the desktop * @param key the key diff --git a/src/lib/efreet/efreet_icon.h b/src/lib/efreet/efreet_icon.h index e4e74ad..9db40a7 100644 --- a/src/lib/efreet/efreet_icon.h +++ b/src/lib/efreet/efreet_icon.h @@ -15,6 +15,8 @@ /** + * @internal + * * Event id for cache update. */ EAPI extern int EFREET_EVENT_ICON_CACHE_UPDATE; @@ -142,18 +144,24 @@ struct Efreet_Icon_Point }; /** + * @internal + * * @return Returns the user icon directory * @brief Returns the user icon directory */ EAPI const char *efreet_icon_user_dir_get(void); /** + * @internal + * * @return Returns the deprecated user icon directory * @brief Returns the deprecated user icon directory */ EAPI const char *efreet_icon_deprecated_user_dir_get(void); /** + * @internal + * * @param ext The extension to add to the list of checked extensions * @return Returns no value. * @brief Adds the given extension to the list of possible icon extensions @@ -162,6 +170,8 @@ EAPI void efreet_icon_extension_add(const char *ext); /** + * @internal + * * @return Returns a list of strings that are paths to other icon directories * @brief Gets the list of all extra directories to look for icons. These * directories are used to look for icons after looking in the user icon dir @@ -172,12 +182,16 @@ EAPI void efreet_icon_extension_add(const char *ext); EAPI Eina_List **efreet_icon_extra_list_get(void); /** + * @internal + * * @return Returns a list of strings that are icon extensions to look for * @brief Gets the list of all icon extensions to look for */ EAPI Eina_List *efreet_icon_extensions_list_get(void); /** + * @internal + * * @return Returns a list of Efreet_Icon structs for all the non-hidden icon * themes * @brief Retrieves all of the non-hidden icon themes available on the system. @@ -186,6 +200,8 @@ EAPI Eina_List *efreet_icon_extensions_list_get(void); EAPI Eina_List *efreet_icon_theme_list_get(void); /** + * @internal + * * @param theme_name The theme to look for * @return Returns the icon theme related to the given theme name or NULL if * none exists. @@ -194,6 +210,8 @@ EAPI Eina_List *efreet_icon_theme_list_get(void); EAPI Efreet_Icon_Theme *efreet_icon_theme_find(const char *theme_name); /** + * @internal + * * @param theme_name The icon theme to look for * @param icon The icon to look for * @param size The icon size to look for @@ -206,6 +224,8 @@ EAPI Efreet_Icon *efreet_icon_find(const char *theme_name, unsigned int size); /** + * @internal + * * @param theme_name The icon theme to look for * @param icons List of icons to look for * @param size; The icon size to look for @@ -224,6 +244,8 @@ EAPI const char *efreet_icon_list_find(const char *theme_name, unsigned int size); /** + * @internal + * * @param theme_name The icon theme to look for * @param icon The icon to look for * @param size; The icon size to look for @@ -238,6 +260,8 @@ EAPI const char *efreet_icon_path_find(const char *theme_name, unsigned int size); /** + * @internal + * * @param icon The Efreet_Icon to cleanup * @return Returns no value. * @brief Free's the given icon and all its internal data. diff --git a/src/lib/efreet/efreet_ini.h b/src/lib/efreet/efreet_ini.h index 2dec08a..5ea21a6 100644 --- a/src/lib/efreet/efreet_ini.h +++ b/src/lib/efreet/efreet_ini.h @@ -28,6 +28,8 @@ struct Efreet_Ini /** + * @internal + * * @param file The file to parse * @return Returns a new Efreet_Ini structure initialized with the contents * of @a file, or NULL on memory allocation failure @@ -37,6 +39,8 @@ struct Efreet_Ini EAPI Efreet_Ini *efreet_ini_new(const char *file); /** + * @internal + * * @param ini The Efreet_Ini to work with * @return Returns no value * @brief Frees the given Efree_Ini structure. @@ -44,6 +48,8 @@ EAPI Efreet_Ini *efreet_ini_new(const char *file); EAPI void efreet_ini_free(Efreet_Ini *ini); /** + * @internal + * * @param ini The Efreet_Ini to work with * @param file The file to load * @return Returns no value @@ -53,6 +59,8 @@ EAPI int efreet_ini_save(Efreet_Ini *ini, const char *path); /** + * @internal + * * @param ini The Efreet_Ini to work with * @param section The section of the ini file we want to get values from * @return Returns 1 if the section exists, otherwise 0 @@ -61,6 +69,8 @@ EAPI int efreet_ini_save(Efreet_Ini *ini, const char *path); EAPI int efreet_ini_section_set(Efreet_Ini *ini, const char *section); /** + * @internal + * * @param ini The Efreet_Ini to work with * @param section The section of the ini file we want to add * @return Returns no value @@ -70,6 +80,8 @@ EAPI void efreet_ini_section_add(Efreet_Ini *ini, const char *section); /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to lookup * @return Returns the string associated with the given key or NULL if not @@ -79,6 +91,8 @@ EAPI void efreet_ini_section_add(Efreet_Ini *ini, const char *section); EAPI const char *efreet_ini_string_get(Efreet_Ini *ini, const char *key); /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to use * @param value The value to set @@ -90,6 +104,8 @@ EAPI void efreet_ini_string_set(Efreet_Ini *ini, const char *key, /** + * @internal + * * @param ini The ini struct to work with * @param key The key to search for * @return Returns the utf8 encoded string associated with @a key, or NULL @@ -99,6 +115,8 @@ EAPI void efreet_ini_string_set(Efreet_Ini *ini, const char *key, EAPI const char *efreet_ini_localestring_get(Efreet_Ini *ini, const char *key); /** + * @internal + * * @param ini The ini struct to work with * @param key The key to use * @param value The value to set @@ -110,6 +128,8 @@ EAPI void efreet_ini_localestring_set(Efreet_Ini *ini, const char *key, /** + * @internal + * * @param ini The ini struct to work with * @param key The key to search for * @return Returns 1 if the boolean is true, 0 otherwise @@ -118,6 +138,8 @@ EAPI void efreet_ini_localestring_set(Efreet_Ini *ini, const char *key, EAPI unsigned int efreet_ini_boolean_get(Efreet_Ini *ini, const char *key); /** + * @internal + * * @param ini The ini struct to work with * @param key The key to use * @param value The value to set @@ -129,6 +151,8 @@ EAPI void efreet_ini_boolean_set(Efreet_Ini *ini, const char *key, /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to lookup * @return Returns the integer associated with the given key or -1 if not @@ -138,6 +162,8 @@ EAPI void efreet_ini_boolean_set(Efreet_Ini *ini, const char *key, EAPI int efreet_ini_int_get(Efreet_Ini *ini, const char *key); /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to use * @param value The value to set @@ -148,6 +174,8 @@ EAPI void efreet_ini_int_set(Efreet_Ini *ini, const char *key, int value /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to lookup * @return Returns the double associated with the given key or -1 if not @@ -157,6 +185,8 @@ EAPI void efreet_ini_int_set(Efreet_Ini *ini, const char *key, int value EAPI double efreet_ini_double_get(Efreet_Ini *ini, const char *key); /** + * @internal + * * @param ini The Efree_Ini to work with * @param key The key to use * @param value The value to set @@ -168,6 +198,8 @@ EAPI void efreet_ini_double_set(Efreet_Ini *ini, const char *key, /** + * @internal + * * @param ini The ini struct to work with * @param key The key to remove * @return Returns no value diff --git a/src/lib/efreet/efreet_menu.h b/src/lib/efreet/efreet_menu.h index fe38d04..3276b46 100644 --- a/src/lib/efreet/efreet_menu.h +++ b/src/lib/efreet/efreet_menu.h @@ -54,6 +54,8 @@ struct Efreet_Menu typedef void (*Efreet_Menu_Cb) (void *data, Efreet_Menu *menu); /** + * @internal + * * @return Returns no value * @brief Initialize legacy kde support. This function blocks while * the kde-config script is run. @@ -61,6 +63,8 @@ typedef void (*Efreet_Menu_Cb) (void *data, Efreet_Menu *menu); EAPI int efreet_menu_kde_legacy_init(void); /** + * @internal + * * @param name The internal name of the menu * @return Returns the Efreet_Menu on success or * NULL on failure @@ -69,6 +73,8 @@ EAPI int efreet_menu_kde_legacy_init(void); EAPI Efreet_Menu *efreet_menu_new(const char *name); /** + * @internal + * * @brief Override which file is used for menu creation * @param file The file to use for menu creation * @@ -78,6 +84,8 @@ EAPI Efreet_Menu *efreet_menu_new(const char *name); EAPI void efreet_menu_file_set(const char *file); /** + * @internal + * * Creates the Efreet_Menu representation of the default menu or * NULL if none found and returns it in the callback. * @param func function to call when menu is created @@ -88,6 +96,8 @@ EAPI void efreet_menu_file_set(const char *file); EAPI void efreet_menu_async_get(Efreet_Menu_Cb func, const void *data); /** + * @internal + * * @return Returns the Efreet_Menu representation of the default menu or * NULL if none found * @brief Creates the default menu representation @@ -95,6 +105,8 @@ EAPI void efreet_menu_async_get(Efreet_Menu_Cb func, const void *dat EAPI Efreet_Menu *efreet_menu_get(void); /** + * @internal + * * Parses the given .menu file and creates the menu representation, and * returns it in the callback * @param path The path of the menu to load @@ -106,6 +118,8 @@ EAPI Efreet_Menu *efreet_menu_get(void); EAPI void efreet_menu_async_parse(const char *path, Efreet_Menu_Cb func, const void *data); /** + * @internal + * * @param path The path of the menu to load * @return Returns the Efreet_Menu representation on success or NULL on * failure @@ -114,6 +128,8 @@ EAPI void efreet_menu_async_parse(const char *path, Efreet_Menu_Cb f EAPI Efreet_Menu *efreet_menu_parse(const char *path); /** + * @internal + * * @param menu The menu to work with * @param path The path where the menu should be saved * @return Returns 1 on success, 0 on failure @@ -122,6 +138,8 @@ EAPI Efreet_Menu *efreet_menu_parse(const char *path); EAPI int efreet_menu_save(Efreet_Menu *menu, const char *path); /** + * @internal + * * @param menu The Efreet_Menu to free * @return Returns no value * @brief Frees the given structure (if refcount at 1 at the time of this call) @@ -129,6 +147,8 @@ EAPI int efreet_menu_save(Efreet_Menu *menu, const char *path); EAPI void efreet_menu_free(Efreet_Menu *menu); /** + * @internal + * * @param menu The Efreet_Menu to reference * @return Returns no value * @brief Incriments refcount for the menu @@ -138,6 +158,8 @@ EAPI void efreet_menu_ref(Efreet_Menu *menu); /** + * @internal + * * @param menu The Efreet_Menu to unreference * @return Returns no value * @brief Decrements refcount for the menu, and on 0 frees @@ -147,6 +169,8 @@ EAPI void efreet_menu_unref(Efreet_Menu *menu); /** + * @internal + * * @param menu The menu to work with * @param desktop The desktop to insert * @param pos The position to place the new desktop @@ -159,6 +183,8 @@ EAPI int efreet_menu_desktop_insert(Efreet_Menu *menu, int pos); /** + * @internal + * * @param menu The menu to work with * @param desktop The desktop to remove * @return Returns 1 on success, 0 on failure @@ -170,6 +196,8 @@ EAPI int efreet_menu_desktop_remove(Efreet_Menu *menu, /** + * @internal + * * @param menu The menu to work with * @param menu The menu to work with * @param indent The indent level to print the menu at diff --git a/src/lib/efreet/efreet_uri.h b/src/lib/efreet/efreet_uri.h index 7cfdaf9..081d965 100644 --- a/src/lib/efreet/efreet_uri.h +++ b/src/lib/efreet/efreet_uri.h @@ -31,6 +31,8 @@ struct Efreet_Uri /** + * @internal + * * @param uri Create an URI string from an Efreet_Uri struct * @return The string rapresentation of uri (ex: 'file:///home/my%20name') * @brief Get the string rapresentation of the given uri struct escaping @@ -42,6 +44,8 @@ struct Efreet_Uri EAPI const char *efreet_uri_encode(Efreet_Uri *uri); /** + * @internal + * * @param val a valid uri string to parse * @return Return The corresponding Efreet_Uri structure. Or NULL on errors. * @brief Read a single uri and return an Efreet_Uri struct. If there's no @@ -51,6 +55,8 @@ EAPI const char *efreet_uri_encode(Efreet_Uri *uri); EAPI Efreet_Uri *efreet_uri_decode(const char *val); /** + * @internal + * * @param uri The uri to free * @brief Free the given uri structure. */ diff --git a/src/lib/efreet/efreet_utils.h b/src/lib/efreet/efreet_utils.h index 68423ff..832c4df 100644 --- a/src/lib/efreet/efreet_utils.h +++ b/src/lib/efreet/efreet_utils.h @@ -14,6 +14,8 @@ /** + * @internal + * * Returns the fdo file id for a given path. If the file isn't inside * a default fdo path it will return NULL. * @@ -25,6 +27,8 @@ EAPI const char *efreet_util_path_to_file_id(const char *path); /** + * @internal + * * Find all desktops for a given mime type * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -36,6 +40,8 @@ EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime); /** + * @internal + * * Find all desktops for a given wm class * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -47,6 +53,8 @@ EAPI Eina_List *efreet_util_desktop_mime_list(const char *mime); EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const char *wmclass); /** + * @internal + * * Find a desktop by file id * * return value must be freed by efreet_desktop_free @@ -57,6 +65,8 @@ EAPI Efreet_Desktop *efreet_util_desktop_wm_class_find(const char *wmname, const EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id); /** + * @internal + * * Find a desktop by exec * * return value must be freed by efreet_desktop_free @@ -67,6 +77,8 @@ EAPI Efreet_Desktop *efreet_util_desktop_file_id_find(const char *file_id); EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec); /** + * @internal + * * Find a desktop by name * * return value must be freed by efreet_desktop_free @@ -77,6 +89,8 @@ EAPI Efreet_Desktop *efreet_util_desktop_exec_find(const char *exec); EAPI Efreet_Desktop *efreet_util_desktop_name_find(const char *name); /** + * @internal + * * Find a desktop by generic name * * return value must be freed by efreet_desktop_free @@ -88,6 +102,8 @@ EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_n /** + * @internal + * * Find all desktops where name matches a glob pattern * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -98,6 +114,8 @@ EAPI Efreet_Desktop *efreet_util_desktop_generic_name_find(const char *generic_n EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob); /** + * @internal + * * Find all desktops where exec matches a glob pattern * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -108,6 +126,8 @@ EAPI Eina_List *efreet_util_desktop_name_glob_list(const char *glob); EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob); /** + * @internal + * * Find all desktops where generic name matches a glob pattern * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -118,6 +138,8 @@ EAPI Eina_List *efreet_util_desktop_exec_glob_list(const char *glob); EAPI Eina_List *efreet_util_desktop_generic_name_glob_list(const char *glob); /** + * @internal + * * Find all desktops where comment matches a glob pattern * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -129,6 +151,8 @@ EAPI Eina_List *efreet_util_desktop_comment_glob_list(const char *glob); /** + * @internal + * * Find all desktop categories * This list must be freed using EINA_LIST_FREE * @@ -137,6 +161,8 @@ EAPI Eina_List *efreet_util_desktop_comment_glob_list(const char *glob); EAPI Eina_List *efreet_util_desktop_categories_list(void); /** + * @internal + * * Find all desktops in a given category * * This list must be freed using EINA_LIST_FREE / efreet_desktop_free @@ -148,12 +174,16 @@ EAPI Eina_List *efreet_util_desktop_category_list(const char *category); /** + * @internal + * * Returns a list of .menu files found in the various config dirs. * @return An eina list of menu file paths (const char *). This must be freed with EINA_LIST_FREE. */ EAPI Eina_List *efreet_util_menus_find(void); /** + * @internal + * * Find all known desktop environments * This list must be freed using EINA_LIST_FREE * @since 1.12 diff --git a/src/lib/eina/eina_accessor.h b/src/lib/eina/eina_accessor.h index 2ff47b3..91efb95 100644 --- a/src/lib/eina/eina_accessor.h +++ b/src/lib/eina/eina_accessor.h @@ -205,6 +205,10 @@ struct _Eina_Accessor * @param[in] accessor The accessor to free * * @details This function frees @a accessor if it is not @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_accessor_free(Eina_Accessor *accessor); @@ -221,6 +225,9 @@ EAPI void eina_accessor_free(Eina_Accessor *accessor); * @p data. If @p accessor is @c NULL or if an error occurs, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor, unsigned int position, @@ -234,6 +241,10 @@ EAPI Eina_Bool eina_accessor_data_get(Eina_Accessor *accessor, * * @details This function returns the container that created @p accessor. If * @p accessor is @c NULL, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_accessor_container_get(Eina_Accessor *accessor) EINA_ARG_NONNULL(1) EINA_PURE; @@ -252,6 +263,10 @@ EAPI void *eina_accessor_container_get(Eina_Accessor *accessor) EINA_ARG_NONNULL * @p cb is called with the data @p fdata. If @p accessor is @c NULL * or if @p start is greater than or equal to @p end, the function returns * immediately. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_accessor_over(Eina_Accessor *accessor, Eina_Each_Cb cb, @@ -272,6 +287,10 @@ EAPI void eina_accessor_over(Eina_Accessor *accessor, * lockable, it returns #EINA_TRUE. * * @warnning None of the existing eina data structures are lockable. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_accessor_lock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1); @@ -281,6 +300,10 @@ EAPI Eina_Bool eina_accessor_lock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1); * @param[in] accessor The accessor. * @return Another accessor * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Accessor* eina_accessor_clone(Eina_Accessor *accessor) EINA_ARG_NONNULL(1); @@ -296,6 +319,10 @@ EAPI Eina_Accessor* eina_accessor_clone(Eina_Accessor *accessor) EINA_ARG_NONNUL * is returned. If the container is not lockable, it returns #EINA_TRUE. * * @warning None of the existing eina data structures are lockable. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_accessor_unlock(Eina_Accessor *accessor) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_array.h b/src/lib/eina/eina_array.h index cb9a6ad..8a0871c 100644 --- a/src/lib/eina/eina_array.h +++ b/src/lib/eina/eina_array.h @@ -253,6 +253,10 @@ struct _Eina_Array * * This function return a valid array on success, or @c NULL if memory * allocation fails. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -266,6 +270,10 @@ EAPI Eina_Array *eina_array_new(unsigned int step) EINA_WARN_UNUSED_RESULT EINA_ * allocated for the elements of @p array. To free them, walk the array with * #EINA_ARRAY_ITER_NEXT. For performance reasons, there is no check * of @p array. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_array_free(Eina_Array *array) EINA_ARG_NONNULL(1); @@ -281,6 +289,10 @@ EAPI void eina_array_free(Eina_Array *array) EINA_ARG_NONNULL(1); * invalid, the program may crash. * * @warning This function can @b only be called on uninitialized arrays. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_array_step_set(Eina_Array *array, unsigned int sizeof_eina_array, @@ -306,6 +318,10 @@ static inline void eina_array_clean(Eina_Array *array) EINA_ARG_NONNULL(1); * frees and set to NULL its data member. For performance reasons, * there is no check of @p array. If it is @c NULL or invalid, the * program may crash. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1); @@ -324,6 +340,10 @@ EAPI void eina_array_flush(Eina_Array *array) EINA_ARG_NONNULL(1); * * If it wasn't able to remove items due to an allocation failure, it will * return #EINA_FALSE. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_array_remove(Eina_Array * array, Eina_Bool (*keep)(void *data, void *gdata), @@ -423,6 +443,10 @@ static inline unsigned int eina_array_count(const Eina_Array *array) EINA_ARG_NO * @p array. If @p array is @c NULL or the count member of @p array is * less or equal than 0, this function returns @c NULL. If the memory can * not be allocated, @c NULL is returned. Otherwise, a valid iterator is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -437,6 +461,10 @@ EAPI Eina_Iterator *eina_array_iterator_new(const Eina_Array *array) EINA * less or equal than 0, this function returns @c NULL. If the memory can * not be allocated, @c NULL is returned. Otherwise, a valid accessor is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Accessor *eina_array_accessor_new(const Eina_Array *array) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; /** diff --git a/src/lib/eina/eina_benchmark.h b/src/lib/eina/eina_benchmark.h index 8c0c598..153f7c8 100644 --- a/src/lib/eina/eina_benchmark.h +++ b/src/lib/eina/eina_benchmark.h @@ -369,6 +369,10 @@ typedef void (*Eina_Benchmark_Specimens)(int request); * * When the new module is not needed anymore, use * eina_benchmark_free() to free the allocated memory. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Benchmark *eina_benchmark_new(const char *name, const char *run); @@ -381,6 +385,10 @@ EAPI Eina_Benchmark *eina_benchmark_new(const char *name, * This function removes all the benchmark tests that have been * registered and frees @p bench. If @p bench is @c NULL, this * function returns immediately. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_benchmark_free(Eina_Benchmark *bench); @@ -404,6 +412,10 @@ EAPI void eina_benchmark_free(Eina_Benchmark *bench); * * If @p bench is @c NULL, this function returns immediately. * This function returns #EINA_FALSE on failure, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench, const char *name, @@ -436,6 +448,10 @@ EAPI Eina_Bool eina_benchmark_register(Eina_Benchmark *bench, * If @p bench is @c NULL, this functions returns @c NULL * immediately. Otherwise, it returns the list of the names of each * test. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Array *eina_benchmark_run(Eina_Benchmark *bench); diff --git a/src/lib/eina/eina_bezier.h b/src/lib/eina/eina_bezier.h index e8d1a7b..1713215 100644 --- a/src/lib/eina/eina_bezier.h +++ b/src/lib/eina/eina_bezier.h @@ -63,6 +63,10 @@ struct _Eina_Bezier * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_bezier_values_set(Eina_Bezier *b, double start_x, double start_y, double ctrl_start_x, double ctrl_start_y, double ctrl_end_x, double ctrl_end_y, double end_x, double end_y) EINA_ARG_NONNULL(1); @@ -82,6 +86,10 @@ EAPI void eina_bezier_values_set(Eina_Bezier *b, double start_x, double start_y, * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_bezier_values_get(const Eina_Bezier *b, double *start_x, double *start_y, double *ctrl_start_x, double *ctrl_start_y, double *ctrl_end_x, double *ctrl_end_y, double *end_x, double *end_y) EINA_ARG_NONNULL(1); @@ -93,6 +101,10 @@ EAPI void eina_bezier_values_get(const Eina_Bezier *b, double *start_x, double * * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double eina_bezier_length_get(const Eina_Bezier *b) EINA_ARG_NONNULL(1); @@ -105,6 +117,10 @@ EAPI double eina_bezier_length_get(const Eina_Bezier *b) EINA_ARG_NONNULL(1); * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double eina_bezier_t_at(const Eina_Bezier *b, double len) EINA_ARG_NONNULL(1); @@ -117,6 +133,10 @@ EAPI double eina_bezier_t_at(const Eina_Bezier *b, double len) EINA_ARG_NONNULL( * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_bezier_point_at(const Eina_Bezier *b, double t, double *px, double *py) EINA_ARG_NONNULL(1); @@ -129,6 +149,10 @@ EAPI void eina_bezier_point_at(const Eina_Bezier *b, double t, double *px, doubl * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNULL(1); @@ -140,6 +164,10 @@ EAPI double eina_bezier_angle_at(const Eina_Bezier *b, double t) EINA_ARG_NONNUL * * @p b. No check is done on @p b. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bezier *left, Eina_Bezier *right) EINA_ARG_NONNULL(1); @@ -154,6 +182,10 @@ EAPI void eina_bezier_split_at_length(const Eina_Bezier *b, double len, Eina_Bez * * @p b. No check is done on @p b. * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_bezier_bounds_get(const Eina_Bezier *b, double *x, double *y, double *w, double *h) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_binbuf.h b/src/lib/eina/eina_binbuf.h index 3c68ff6..c12106f 100644 --- a/src/lib/eina/eina_binbuf.h +++ b/src/lib/eina/eina_binbuf.h @@ -44,6 +44,10 @@ typedef struct _Eina_Strbuf Eina_Binbuf; * @see eina_binbuf_free() * @see eina_binbuf_append() * @see eina_binbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -61,6 +65,10 @@ EAPI Eina_Binbuf *eina_binbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; * * @see eina_binbuf_manage_new() * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_DEPRECATED; @@ -86,10 +94,16 @@ EAPI Eina_Binbuf *eina_binbuf_manage_new_length(unsigned char *str, size_t lengt * @see eina_binbuf_manage_read_only_new_length() * * @since 1.14.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Binbuf *eina_binbuf_manage_new(const unsigned char *str, size_t length, Eina_Bool ro) EINA_MALLOC EINA_WARN_UNUSED_RESULT; /** + * @internal + * * @brief Create a new string buffer using the passed string. The passed * string is used directly as the buffer, it's somehow the opposite function of * @ref eina_binbuf_string_steal . The passed string will not be touched. @@ -116,6 +130,10 @@ EAPI Eina_Binbuf *eina_binbuf_manage_read_only_new_length(const unsigned char *s * * This function frees the memory of @p buf. @p buf must have been * created by eina_binbuf_new(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); @@ -126,6 +144,10 @@ EAPI void eina_binbuf_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); * * This function reset @p buf: the buffer len is set to 0, and the * string is set to '\\0'. No memory is free'd. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); @@ -147,6 +169,10 @@ EAPI void eina_binbuf_reset(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); * @see eina_stringshare_length() * @see eina_binbuf_append() * @see eina_binbuf_append_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char *str, size_t length) EINA_ARG_NONNULL(1, 2); @@ -166,6 +192,10 @@ EAPI Eina_Bool eina_binbuf_append_length(Eina_Binbuf *buf, const unsigned char * * @see eina_binbuf_append_n() * @see eina_binbuf_append_length() * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *data) EINA_ARG_NONNULL(1, 2); @@ -179,6 +209,10 @@ EAPI Eina_Bool eina_binbuf_append_buffer(Eina_Binbuf *buf, const Eina_Binbuf *da * * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_ARG_NONNULL(1); @@ -201,6 +235,10 @@ EAPI Eina_Bool eina_binbuf_append_char(Eina_Binbuf *buf, unsigned char c) EINA_A * @see eina_stringshare_length() * @see eina_binbuf_insert() * @see eina_binbuf_insert_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -216,6 +254,10 @@ EAPI Eina_Bool eina_binbuf_insert_length(Eina_Binbuf *buf, const unsigned char * * This function inserts @p c to @p buf at position @p pos. If @p buf * can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t pos) EINA_ARG_NONNULL(1); @@ -232,6 +274,10 @@ EAPI Eina_Bool eina_binbuf_insert_char(Eina_Binbuf *buf, unsigned char c, size_t * This function removes a slice of @p buf, starting at @p start * (inclusive) and ending at @p end (non-inclusive). Both values are * in bytes. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1); @@ -248,6 +294,10 @@ EAPI Eina_Bool eina_binbuf_remove(Eina_Binbuf *buf, size_t start, size_t end) EI * make that pointer invalid. * * @see eina_binbuf_string_steal() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -263,6 +313,10 @@ EAPI const unsigned char *eina_binbuf_string_get(const Eina_Binbuf *buf) EINA_AR * free(). * * @see eina_binbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -273,6 +327,10 @@ EAPI unsigned char *eina_binbuf_string_steal(Eina_Binbuf *buf) EINA_MALLOC EINA_ * * This function frees the string contained in @p buf without freeing * @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); @@ -283,6 +341,10 @@ EAPI void eina_binbuf_string_free(Eina_Binbuf *buf) EINA_ARG_NONNULL(1); * @return The current length of the string, in bytes. * * This function returns the length of @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_binbuf_length_get(const Eina_Binbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; diff --git a/src/lib/eina/eina_binshare.h b/src/lib/eina/eina_binshare.h index 9015c78..5dd63e2 100644 --- a/src/lib/eina/eina_binshare.h +++ b/src/lib/eina/eina_binshare.h @@ -92,6 +92,10 @@ * object or subobject. * * @see eina_binshare_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const void *eina_binshare_add_length(const void *obj, unsigned int olen) EINA_WARN_UNUSED_RESULT; @@ -109,6 +113,10 @@ EAPI const void *eina_binshare_add_length(const void *obj, * eina_binshare_add(). * * @note There is no unref since this is the work of eina_binshare_del(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const void *eina_binshare_ref(const void *obj); @@ -124,6 +132,10 @@ EAPI const void *eina_binshare_ref(const void *obj); * * @warning If the given pointer is not shared, bad things happen, mostly a * segmentation fault. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_binshare_del(const void *obj); @@ -139,6 +151,10 @@ EAPI void eina_binshare_del(const void *obj); * * @warning If the given pointer is not shared, bad things happen, mostly a * segmentation fault. If in doubt, try strlen(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT EINA_PURE; @@ -147,6 +163,10 @@ EAPI int eina_binshare_length(const void *obj) EINA_WARN_UNUSED_RESULT E * * @details This function dumps all the objects from share_common to stdout with a * DDD: prefix per line and a memory usage summary. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_binshare_dump(void); diff --git a/src/lib/eina/eina_convert.h b/src/lib/eina/eina_convert.h index be65cc4..0012918 100644 --- a/src/lib/eina/eina_convert.h +++ b/src/lib/eina/eina_convert.h @@ -176,6 +176,10 @@ EAPI extern Eina_Error EINA_ERROR_CONVERT_OUTRUN_STRING_LENGTH; /**< Not used, p * * The returned value is the length of the string, including the nul * terminated character. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2); @@ -194,6 +198,10 @@ EAPI int eina_convert_itoa(int n, char *s) EINA_ARG_NONNULL(2); * * The returned value is the length of the string, including the nul * terminated character. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2); @@ -219,6 +227,10 @@ EAPI int eina_convert_xtoa(unsigned int n, char *s) EINA_ARG_NONNULL(2); * * The returned value is the length of the string, including the nul * character. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2); @@ -256,6 +268,10 @@ EAPI int eina_convert_dtoa(double d, char *des) EINA_ARG_NONNULL(2); * * If the string is invalid #EINA_FALSE is returned, otherwise #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_convert_atod(const char *src, int length, @@ -289,6 +305,10 @@ EAPI Eina_Bool eina_convert_atod(const char *src, * @note The code is the same than eina_convert_dtoa() except that it * implements the frexp() function for fixed point numbers and does * some optimisations. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_convert_fptoa(Eina_F32p32 fp, char *des) EINA_ARG_NONNULL(2); @@ -329,6 +349,10 @@ EAPI int eina_convert_fptoa(Eina_F32p32 fp, * * @note The code uses eina_convert_atod() and do the correct bit * shift to compute the fixed point number. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_convert_atofp(const char *src, int length, diff --git a/src/lib/eina/eina_counter.h b/src/lib/eina/eina_counter.h index 7c58ec1..7e31ae9 100644 --- a/src/lib/eina/eina_counter.h +++ b/src/lib/eina/eina_counter.h @@ -124,6 +124,10 @@ typedef struct _Eina_Counter Eina_Counter; * * @note Whe the new counter is not needed anymore, use eina_counter_free() to * free the allocated memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -136,6 +140,10 @@ EAPI Eina_Counter *eina_counter_new(const char *name) EINA_WARN_UNUSED_RESULT EI * (see eina_counter_start()) and frees the memory allocated for * @p counter. If @p counter is @c NULL, the function returns * immediately. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1); @@ -154,6 +162,10 @@ EAPI void eina_counter_free(Eina_Counter *counter) EINA_ARG_NONNULL(1); * * @note To stop the timing, eina_counter_stop() must be called with the * same counter. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1); @@ -168,6 +180,10 @@ EAPI void eina_counter_start(Eina_Counter *counter) EINA_ARG_NONNULL(1) * with eina_counter_start(). @p specimen is the number of the * test. If @p counter or its associated clock is @c NULL, or if the * time can't be retrieved the function exits. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_counter_stop(Eina_Counter *counter, int specimen) EINA_ARG_NONNULL(1); @@ -189,6 +205,10 @@ EAPI void eina_counter_stop(Eina_Counter *counter, * @endverbatim * * @note The unit of time is nanoseconds. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *eina_counter_dump(Eina_Counter *counter) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_cow.h b/src/lib/eina/eina_cow.h index 400cfe4..b03a9c9 100644 --- a/src/lib/eina/eina_cow.h +++ b/src/lib/eina/eina_cow.h @@ -60,6 +60,10 @@ typedef void Eina_Cow_Data; * @param default_value The default value returned by this pool. * @param gc Is it possible to run garbage collection on this pool. * @return a valid new Eina_Cow or @c NULL on error. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Cow *eina_cow_add(const char *name, unsigned int struct_size, unsigned int step, const void *default_value, Eina_Bool gc) EINA_WARN_UNUSED_RESULT; @@ -67,6 +71,10 @@ EAPI Eina_Cow *eina_cow_add(const char *name, unsigned int struct_size, unsigned * @brief Destroy an Eina_Cow pool and all the allocated memory * * @param cow The pool to destroy + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_cow_del(Eina_Cow *cow); @@ -74,6 +82,10 @@ EAPI void eina_cow_del(Eina_Cow *cow); * @brief Return an initialized pointer from the pool. * @param cow The pool to take things from. * @return A pointer to the new pool instance + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_Cow_Data *eina_cow_alloc(Eina_Cow *cow) EINA_WARN_UNUSED_RESULT; @@ -84,6 +96,10 @@ EAPI const Eina_Cow_Data *eina_cow_alloc(Eina_Cow *cow) EINA_WARN_UNUSED_RESULT; * * @note To simplify the caller code *data will point to the default * read only state after the call to this function. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data); @@ -93,6 +109,10 @@ EAPI void eina_cow_free(Eina_Cow *cow, const Eina_Cow_Data **data); * @param src The pointer you want to write to. * * NOTE: this function is not thread safe, be careful. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_cow_write(Eina_Cow *cow, const Eina_Cow_Data * const *src) EINA_WARN_UNUSED_RESULT; @@ -104,6 +124,10 @@ EAPI void *eina_cow_write(Eina_Cow *cow, * @param needed_gc Does this pool need to be garbage collected? * * NOTE: this function is not thread safe, be careful. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_cow_done(Eina_Cow *cow, const Eina_Cow_Data * const *dst, @@ -114,6 +138,10 @@ EAPI void eina_cow_done(Eina_Cow *cow, * @param cow The pool the pointers come from. * @param dst The destination to update. * @param src The source of information to copy. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_cow_memcpy(Eina_Cow *cow, const Eina_Cow_Data * const *dst, @@ -127,6 +155,10 @@ EAPI void eina_cow_memcpy(Eina_Cow *cow, * There is no guaranty in the time it will require, but should remain low. * It does run a hash function on all possible common structures trying to * find the one that match and merge them into one pointer. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_cow_gc(Eina_Cow *cow); diff --git a/src/lib/eina/eina_cpu.h b/src/lib/eina/eina_cpu.h index bb7082b..d67a5bf 100644 --- a/src/lib/eina/eina_cpu.h +++ b/src/lib/eina/eina_cpu.h @@ -62,6 +62,10 @@ typedef enum _Eina_Cpu_Features * @brief Global hardware architecture handler * * @return the current cpu features + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI extern Eina_Cpu_Features eina_cpu_features; @@ -69,6 +73,10 @@ EAPI extern Eina_Cpu_Features eina_cpu_features; * @brief Cpu features accessor * * @return the current cpu features + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Cpu_Features eina_cpu_features_get(void); @@ -77,6 +85,10 @@ EAPI Eina_Cpu_Features eina_cpu_features_get(void); * * @return the number of processors that are online, that * is available when the function is called. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_cpu_count(void); @@ -86,6 +98,10 @@ EAPI int eina_cpu_count(void); * @return the fixed length that represents the smallest unit of data for memory * allocation performed by the operating system on behalf of the program, and * for transfers between the main memory and any other auxiliary store. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_cpu_page_size(void); diff --git a/src/lib/eina/eina_error.h b/src/lib/eina/eina_error.h index a49aea5..8c95f2b 100644 --- a/src/lib/eina/eina_error.h +++ b/src/lib/eina/eina_error.h @@ -77,6 +77,10 @@ typedef int Eina_Error; /** * @var EINA_ERROR_OUT_OF_MEMORY * @brief The error identifier corresponding to lack of memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern Eina_Error EINA_ERROR_OUT_OF_MEMORY; @@ -93,6 +97,10 @@ EAPI extern Eina_Error EINA_ERROR_OUT_OF_MEMORY; * the returned value to eina_error_msg_get(). * * @see eina_error_msg_static_register() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Error eina_error_msg_register(const char *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -110,6 +118,10 @@ EAPI Eina_Error eina_error_msg_register(const char *msg) EINA_ARG_NONNULL(1) EI * the returned value to eina_error_msg_get(). * * @see eina_error_msg_register() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Error eina_error_msg_static_register(const char *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -128,6 +140,10 @@ EAPI Eina_Error eina_error_msg_static_register(const char *msg) EINA_ARG_NONNUL * is unrefed and @p msg is copied. * * @see eina_error_msg_register() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_error_msg_modify(Eina_Error error, const char *msg) EINA_ARG_NONNULL(2); @@ -141,6 +157,10 @@ EAPI Eina_Bool eina_error_msg_modify(Eina_Error error, * description of the message is returned by eina_error_msg_get(). * * @note This function is thread safe @since 1.10, but slower to use. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Error eina_error_get(void); @@ -156,6 +176,10 @@ EAPI Eina_Error eina_error_get(void); * be @c 0. * * @note This function is thread safe @since 1.10, but slower to use. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_error_set(Eina_Error err); @@ -168,6 +192,10 @@ EAPI void eina_error_set(Eina_Error err); * @details This function returns the description of an error that has been * registered by eina_error_msg_register(). If an incorrect error is * given, then @c NULL is returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_error_msg_get(Eina_Error error) EINA_PURE; @@ -179,6 +207,10 @@ EAPI const char *eina_error_msg_get(Eina_Error error) EINA_PURE; * * @details This function attempts to match @p msg with its corresponding #Eina_Error value. * If no such value is found, @c 0 is returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Error eina_error_find(const char *msg) EINA_ARG_NONNULL(1) EINA_PURE; diff --git a/src/lib/eina/eina_evlog.h b/src/lib/eina/eina_evlog.h index 9727863..e3c956f 100644 --- a/src/lib/eina/eina_evlog.h +++ b/src/lib/eina/eina_evlog.h @@ -56,6 +56,8 @@ struct _Eina_Evlog_Buf }; /** + * @internal + * * @brief Log an event in our event log for profiling data * * Log some interesting event inside of EFL, eg a wakeup (and why etc.). @@ -117,6 +119,8 @@ EAPI void eina_evlog(const char *event, void *obj, double srctime, const char *detail); /** + * @internal + * * @brief Steal an event log buffer from the evlog core * * Only one buffer can be stolen at any time. If you steal a new buffer, the @@ -130,6 +134,8 @@ EAPI Eina_Evlog_Buf * eina_evlog_steal(void); /** + * @internal + * * @brief Begin logging - until now eina_evlog is a NOOP * * @since 1.15 @@ -138,6 +144,8 @@ EAPI void eina_evlog_start(void); /** + * @internal + * * @brief Stop logging * * You must not be using any evlog buffers stolen by eina_evlog_steal() by diff --git a/src/lib/eina/eina_file.h b/src/lib/eina/eina_file.h index 2f37acb..99524d3 100644 --- a/src/lib/eina/eina_file.h +++ b/src/lib/eina/eina_file.h @@ -265,6 +265,10 @@ struct _Eina_File_Line * If @p cb or @p dir is @c NULL or if @p dir is a string of size 0, * or if @p dir cannot be opened, this function returns #EINA_FALSE * immediately. Otherwise, it returns #EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_dir_list(const char *dir, Eina_Bool recursive, @@ -281,6 +285,10 @@ EAPI Eina_Bool eina_file_dir_list(const char *dir, * filesystem. If @p path is @c NULL or if the array cannot be * created, @c NULL is returned, otherwise an array with each part of @p path * is returned. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Array *eina_file_split(char *path) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -302,6 +310,10 @@ EAPI Eina_Array *eina_file_split(char *path) EINA_WARN_UNUSED_RESULT EINA_ARG * @note The iterator walks over '.' and '..' without returning them. * * @see eina_file_direct_ls() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -330,6 +342,10 @@ EAPI Eina_Iterator *eina_file_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_A * possible performance penalty. * * @see eina_file_direct_ls() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_stat_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -349,6 +365,10 @@ EAPI Eina_Iterator *eina_file_stat_ls(const char *dir) EINA_WARN_UNUSED_RESULT E * @see eina_file_stat_ls() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_file_statat(void *container, Eina_File_Direct_Info *info, Eina_Stat *buf) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2, 3); @@ -381,6 +401,10 @@ EAPI int eina_file_statat(void *container, Eina_File_Direct_Info *info, Eina_Sta * * @see eina_file_mkdtemp() * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_file_mkstemp(const char *templatename, Eina_Tmpstr **path) EINA_ARG_NONNULL(1); @@ -406,6 +430,10 @@ EAPI int eina_file_mkstemp(const char *templatename, Eina_Tmpstr **path) EINA_AR * * @see eina_file_mkstemp() * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_mkdtemp(const char *templatename, Eina_Tmpstr **path) EINA_ARG_NONNULL(1,2); @@ -436,6 +464,10 @@ EAPI Eina_Bool eina_file_mkdtemp(const char *templatename, Eina_Tmpstr **path) E * faster. * * @see eina_file_ls() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_direct_ls(const char *dir) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -451,6 +483,10 @@ EAPI Eina_Iterator *eina_file_direct_ls(const char *dir) EINA_WARN_UNUSED_RESULT * path. * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char *eina_file_path_sanitize(const char *path); @@ -489,6 +525,10 @@ typedef enum { * until the whole file is copied or it fails. * * @note During the progress it may call back @p cb with the progress summary. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_copy(const char *src, const char *dst, Eina_File_Copy_Flags flags, Eina_File_Copy_Progress cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); @@ -505,6 +545,10 @@ EAPI Eina_Bool eina_file_copy(const char *src, const char *dst, Eina_File_Copy_F * is #EINA_TRUE, otherwise. * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_File *eina_file_open(const char *name, Eina_Bool shared) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -518,6 +562,10 @@ EAPI Eina_File *eina_file_open(const char *name, Eina_Bool shared) EINA_WARN_UNU * @return #Eina_File handle to the file * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_File * eina_file_virtualize(const char *virtual_name, const void *data, unsigned long long length, Eina_Bool copy) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -529,6 +577,10 @@ eina_file_virtualize(const char *virtual_name, const void *data, unsigned long l * @return #EINA_TRUE if the file is a virtual file * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -543,6 +595,10 @@ eina_file_virtual(Eina_File *file) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); * and recreate them to have the new correct mapping. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_refresh(Eina_File *file); @@ -555,6 +611,10 @@ EAPI Eina_Bool eina_file_refresh(Eina_File *file); * @note Opens a file in read-only mode. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_File * eina_file_dup(const Eina_File *file); @@ -566,6 +626,10 @@ EAPI Eina_File * eina_file_dup(const Eina_File *file); * @details This decrements the file's reference count and if it reaches zero it closes the file. * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_file_close(Eina_File *file); @@ -576,6 +640,10 @@ EAPI void eina_file_close(Eina_File *file); * @return The length of the file * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI size_t eina_file_size_get(const Eina_File *file); @@ -586,6 +654,10 @@ EAPI size_t eina_file_size_get(const Eina_File *file); * @return The last modification time * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI time_t eina_file_mtime_get(const Eina_File *file); @@ -596,6 +668,10 @@ EAPI time_t eina_file_mtime_get(const Eina_File *file); * @return The stringshared filename of the file * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_file_filename_get(const Eina_File *file); @@ -609,6 +685,10 @@ EAPI const char *eina_file_filename_get(const Eina_File *file); * them, so you need to copy them yourself if needed. * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_xattr_get(Eina_File *file); @@ -623,6 +703,10 @@ EAPI Eina_Iterator *eina_file_xattr_get(Eina_File *file); * Eina_Xattr structure. * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_xattr_value_get(Eina_File *file); @@ -635,6 +719,10 @@ EAPI Eina_Iterator *eina_file_xattr_value_get(Eina_File *file); * @c NULL if it fails * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_file_map_all(Eina_File *file, Eina_File_Populate rule); @@ -651,6 +739,10 @@ EAPI void *eina_file_map_all(Eina_File *file, Eina_File_Populate rule); * @note This does handle reference counting so it can share the same memory area. * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_file_map_new(Eina_File *file, Eina_File_Populate rule, unsigned long int offset, unsigned long int length); @@ -662,6 +754,10 @@ EAPI void *eina_file_map_new(Eina_File *file, Eina_File_Populate rule, * @param[in] map The memory map to unref and unmap * * @since 1.1 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_file_map_free(Eina_File *file, void *map); @@ -679,6 +775,10 @@ EAPI void eina_file_map_free(Eina_File *file, void *map); * be honored if the system chooses to ignore the request. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_file_map_populate(Eina_File *file, Eina_File_Populate rule, const void *map, @@ -695,6 +795,10 @@ eina_file_map_populate(Eina_File *file, Eina_File_Populate rule, const void *map * nothing can guarantee that the memory is still going to be mapped. * * @since 1.3 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file); @@ -706,6 +810,10 @@ EAPI Eina_Iterator *eina_file_map_lines(Eina_File *file); * @return #EINA_TRUE if there has been an IO error, otherwise #EINA_FALSE * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_file_map_faulted(Eina_File *file, void *map); diff --git a/src/lib/eina/eina_fp.h b/src/lib/eina/eina_fp.h index 7a169a2..7af6c55 100644 --- a/src/lib/eina/eina_fp.h +++ b/src/lib/eina/eina_fp.h @@ -193,6 +193,10 @@ static inline unsigned int eina_f32p32_fracc_get(Eina_F32p32 v); * * @param a The angle in radians to calculate the cosinus from. * @return The cosinus value of the angle @p a + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a); @@ -201,6 +205,10 @@ EAPI Eina_F32p32 eina_f32p32_cos(Eina_F32p32 a); * * @param a The angle in radians to calculate the sinus from. * @return The cosinus value of the angle @p a + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_F32p32 eina_f32p32_sin(Eina_F32p32 a); diff --git a/src/lib/eina/eina_hamster.h b/src/lib/eina/eina_hamster.h index bea759d..04f5e44 100644 --- a/src/lib/eina/eina_hamster.h +++ b/src/lib/eina/eina_hamster.h @@ -44,6 +44,10 @@ * @return The number of available hamsters. * * This function returns how many hamsters you have. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_hamster_count(void); diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h index 5f953bf..f1f05e3 100644 --- a/src/lib/eina/eina_hash.h +++ b/src/lib/eina/eina_hash.h @@ -373,6 +373,10 @@ typedef Eina_Bool (*Eina_Hash_Foreach)(const Eina_Hash *hash, const void *key * eina_hash_string_small_new(), eina_hash_int32_new(), * eina_hash_int64_new(), eina_hash_pointer_new() and * eina_hash_stringshared_new(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_new(Eina_Key_Length key_length_cb, Eina_Key_Cmp key_cmp_cb, @@ -393,6 +397,10 @@ EAPI Eina_Hash *eina_hash_new(Eina_Key_Length key_length_cb, * * @since 1.1 * @see eina_hash_new. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_hash_free_cb_set(Eina_Hash *hash, Eina_Free_Cb data_free_cb) EINA_ARG_NONNULL(1); @@ -408,6 +416,10 @@ EAPI void eina_hash_free_cb_set(Eina_Hash *hash, Eina_Free_Cb data_free_cb) EINA * table management and strcmp() to compare the keys. Values can then * be looked up with pointers other than the original key pointer that * was used to add values. On failure, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb); @@ -427,6 +439,10 @@ EAPI Eina_Hash *eina_hash_string_djb2_new(Eina_Free_Cb data_free_cb); * * NOTE: don't use this kind of hash when their is a possibility to remotely * request and push data in it. This hash is subject to denial of service. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb); @@ -445,6 +461,10 @@ EAPI Eina_Hash *eina_hash_string_superfast_new(Eina_Free_Cb data_free_cb); * table. Values can then be looked up with pointers other than the * original key pointer that was used to add values. On failure, this * function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_string_small_new(Eina_Free_Cb data_free_cb); @@ -464,6 +484,10 @@ EAPI Eina_Hash *eina_hash_string_small_new(Eina_Free_Cb data_free_cb); * used to add values. This method is not suitable to match string keys as * it would only match the first character. * On failure, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_int32_new(Eina_Free_Cb data_free_cb); @@ -482,6 +506,10 @@ EAPI Eina_Hash *eina_hash_int32_new(Eina_Free_Cb data_free_cb); * used to add values. This method is not suitable to match string keys as * it would only match the first character. * On failure, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb); @@ -508,6 +536,10 @@ EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb); * if (!eina_hash_find(hash, &data)) * eina_hash_add(hash, &data, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb); @@ -534,6 +566,10 @@ EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb); * eina_hash_add(hash, a, value); * eina_hash_find(hash, "key"); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb); @@ -557,6 +593,10 @@ EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb); * with eina_hash_find(), and removed with eina_hash_del(). Key * strings are case sensitive. This function returns #EINA_FALSE if an error * occurred, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_add(Eina_Hash *hash, const void *key, @@ -585,6 +625,10 @@ EAPI Eina_Bool eina_hash_add(Eina_Hash *hash, * constant or stored elsewhere ( in the object being added). Key * strings are case sensitive. This function returns #EINA_FALSE if an error * occurred, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash, const void *key, @@ -612,6 +656,10 @@ EAPI Eina_Bool eina_hash_direct_add(Eina_Hash *hash, * eina_hash_del_by_key() or eina_hash_del_by_key_hash(). If you * know you don't have the key, use eina_hash_del_by_data() * directly. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_del(Eina_Hash *hash, const void *key, @@ -629,6 +677,10 @@ EAPI Eina_Bool eina_hash_del(Eina_Hash *hash, * @p hash. If @p hash is @c NULL, this function returns immediately * @c NULL. This function returns the data pointer on success, @c NULL * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_hash_find(const Eina_Hash *hash, const void *key) EINA_ARG_NONNULL(2); @@ -645,6 +697,10 @@ EAPI void *eina_hash_find(const Eina_Hash *hash, * This function modifies the data of @p key with @p data in @p * hash. If no entry is found, nothing is added to @p hash. On success * this function returns the old entry, otherwise it returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_hash_modify(Eina_Hash *hash, const void *key, @@ -664,6 +720,10 @@ EAPI void *eina_hash_modify(Eina_Hash *hash, * hash. If no entry is found, @p data is added to @p hash with the * key @p key. On success this function returns the old entry, * otherwise it returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_hash_set(Eina_Hash *hash, const void *key, @@ -681,6 +741,10 @@ EAPI void *eina_hash_set(Eina_Hash *hash, * This function allows for the move of data from one key to another, * but does not call the Eina_Free_Cb associated with the hash table * when destroying the old key. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_move(Eina_Hash *hash, const void *old_key, @@ -707,6 +771,10 @@ EAPI Eina_Bool eina_hash_move(Eina_Hash *hash, * eina_hash_free(hash); * hash = NULL; * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1); @@ -721,6 +789,10 @@ EAPI void eina_hash_free(Eina_Hash *hash) EINA_ARG_NONNULL(1); * then frees the buckets. If no free callback has been passed, no * buckets value will be freed. If @p hash is @c NULL, the function * returns immediately. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_hash_free_buckets(Eina_Hash *hash) EINA_ARG_NONNULL(1); @@ -732,6 +804,10 @@ EAPI void eina_hash_free_buckets(Eina_Hash *hash) EINA_ARG_NONNULL(1); * * This function returns the number of entries in @p hash, or 0 on * error. If @p hash is @c NULL, @c 0 is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1); @@ -758,6 +834,10 @@ EAPI int eina_hash_population(const Eina_Hash *hash) EINA_ARG_NONNULL(1); * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. * * @see eina_hash_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_add_by_hash(Eina_Hash *hash, const void *key, @@ -792,6 +872,10 @@ EAPI Eina_Bool eina_hash_add_by_hash(Eina_Hash *hash, * returns #EINA_FALSE if an error occurred, #EINA_TRUE otherwise. * * @see eina_hash_direct_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash, const void *key, @@ -819,6 +903,10 @@ EAPI Eina_Bool eina_hash_direct_add_by_hash(Eina_Hash *hash, * * @note if you don't have the key_hash, use eina_hash_del_by_key() instead. * @note if you don't have the key, use eina_hash_del_by_data() instead. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash, const void *key, @@ -846,6 +934,10 @@ EAPI Eina_Bool eina_hash_del_by_key_hash(Eina_Hash *hash, * @note if you already have the key_hash, use eina_hash_del_by_key_hash() * instead. * @note if you don't have the key, use eina_hash_del_by_data() instead. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash, const void *key) EINA_ARG_NONNULL(1, 2); @@ -869,6 +961,10 @@ EAPI Eina_Bool eina_hash_del_by_key(Eina_Hash *hash, * * @note if you already have the key, use eina_hash_del_by_key() or * eina_hash_del_by_key_hash() instead. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash, const void *data) EINA_ARG_NONNULL(1, 2); @@ -901,6 +997,10 @@ EAPI Eina_Bool eina_hash_del_by_data(Eina_Hash *hash, * @note if you know you already have the key, use eina_hash_del_by_key_hash(), * if you know you don't have the key, use eina_hash_del_by_data() * directly. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash, const void *key, @@ -924,6 +1024,10 @@ EAPI Eina_Bool eina_hash_del_by_hash(Eina_Hash *hash, * '\\0' for string when setting the value of @p key_length. If * @p hash is @c NULL, this function returns immediately @c NULL. This * function returns the data pointer on success, @c NULL otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_hash_find_by_hash(const Eina_Hash *hash, const void *key, @@ -944,6 +1048,10 @@ EAPI void *eina_hash_find_by_hash(const Eina_Hash *hash, * @return The data pointer for the old stored entry, or @c NULL if not * found. If an existing entry is not found, nothing is added to the * hash. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_hash_modify_by_hash(Eina_Hash *hash, const void *key, @@ -968,6 +1076,10 @@ EAPI void *eina_hash_modify_by_hash(Eina_Hash *hash, * @warning if the hash structure changes then the iterator becomes * invalid! That is, if you add or remove items this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -988,6 +1100,10 @@ EAPI Eina_Iterator *eina_hash_iterator_key_new(const Eina_Hash *hash) EINA_MALLO * @warning if the hash structure changes then the iterator becomes * invalid. That is, if you add or remove items this iterator behavior * is undefined and your program may crash. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -1011,6 +1127,10 @@ EAPI Eina_Iterator *eina_hash_iterator_data_new(const Eina_Hash *hash) EINA_MALL * @warning if the hash structure changes then the iterator becomes * invalid! That is, if you add or remove items this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -1048,6 +1168,10 @@ EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MAL * free(hash_fn_data); * } * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_hash_foreach(const Eina_Hash *hash, Eina_Hash_Foreach func, @@ -1064,6 +1188,10 @@ EAPI void eina_hash_foreach(const Eina_Hash *hash, * @param key The key associated with the data * @param data The data to append to the list * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); /** @@ -1076,6 +1204,10 @@ EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *da * @param key The key associated with the data * @param data The data to prepend to the list * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_hash_list_prepend(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); /** @@ -1088,6 +1220,10 @@ EAPI void eina_hash_list_prepend(Eina_Hash *hash, const void *key, const void *d * @param key The key associated with the data * @param data The data to remove from the list * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_hash_list_remove(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -1098,6 +1234,10 @@ EAPI void eina_hash_list_remove(Eina_Hash *hash, const void *key, const void *da * @param key The key to hash * @param len The length of the key * @return The hash value + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_hash_superfast(const char *key, int len) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_inarray.h b/src/lib/eina/eina_inarray.h index 2f95665..da7a63d 100644 --- a/src/lib/eina/eina_inarray.h +++ b/src/lib/eina/eina_inarray.h @@ -252,6 +252,10 @@ struct _Eina_Inarray * @see eina_inarray_free() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inarray *eina_inarray_new(unsigned int member_size, unsigned int step) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -264,6 +268,10 @@ EAPI Eina_Inarray *eina_inarray_new(unsigned int member_size, * @see eina_inarray_flush() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inarray_free(Eina_Inarray *array) EINA_ARG_NONNULL(1); @@ -285,6 +293,10 @@ EAPI void eina_inarray_free(Eina_Inarray *array) EINA_ARG_NONNULL(1); * @see eina_inarray_flush() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inarray_step_set(Eina_Inarray *array, unsigned int sizeof_eina_inarray, @@ -298,6 +310,10 @@ EAPI void eina_inarray_step_set(Eina_Inarray *array, * @param[in] array The array object * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inarray_flush(Eina_Inarray *array) EINA_ARG_NONNULL(1); @@ -315,6 +331,10 @@ EAPI void eina_inarray_flush(Eina_Inarray *array) EINA_ARG_NONNULL(1); * @see eina_inarray_insert_at() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_push(Eina_Inarray *array, const void *data) EINA_ARG_NONNULL(1, 2); @@ -329,6 +349,10 @@ EAPI int eina_inarray_push(Eina_Inarray *array, * function. * * @since 1.8 + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_inarray_grow(Eina_Inarray *array, unsigned int size); @@ -353,6 +377,10 @@ EAPI void *eina_inarray_grow(Eina_Inarray *array, unsigned int size); * @see eina_inarray_push() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_insert(Eina_Inarray *array, const void *data, @@ -380,6 +408,10 @@ EAPI int eina_inarray_insert(Eina_Inarray *array, * @see eina_inarray_sort() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_insert_sorted(Eina_Inarray *array, const void *data, @@ -400,6 +432,10 @@ EAPI int eina_inarray_insert_sorted(Eina_Inarray *array, * @see eina_inarray_remove_at() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_remove(Eina_Inarray *array, const void *data) EINA_ARG_NONNULL(1, 2); @@ -413,6 +449,10 @@ EAPI int eina_inarray_remove(Eina_Inarray *array, * @note The data could be considered valid only until any other operation touched the Inarray. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_inarray_pop(Eina_Inarray *array) EINA_ARG_NONNULL(1); @@ -432,6 +472,10 @@ EAPI void *eina_inarray_pop(Eina_Inarray *array) EINA_ARG_NONNULL(1); * @see eina_inarray_lookup_sorted() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_inarray_nth(const Eina_Inarray *array, unsigned int position) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -458,6 +502,10 @@ EAPI void *eina_inarray_nth(const Eina_Inarray *array, * @note If @a position is bigger than the array length, it fails. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_inarray_insert_at(Eina_Inarray *array, unsigned int position, @@ -488,6 +536,10 @@ EAPI Eina_Bool eina_inarray_insert_at(Eina_Inarray *array, * @note If @a position is bigger than the array length, it fails. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_inarray_alloc_at(Eina_Inarray *array, unsigned int position, @@ -509,6 +561,10 @@ EAPI void *eina_inarray_alloc_at(Eina_Inarray *array, * @note If @p position does not exist, it fails. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_inarray_replace_at(Eina_Inarray *array, unsigned int position, @@ -528,6 +584,10 @@ EAPI Eina_Bool eina_inarray_replace_at(Eina_Inarray *array, * @see eina_inarray_remove() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_inarray_remove_at(Eina_Inarray *array, unsigned int position) EINA_ARG_NONNULL(1); @@ -543,6 +603,10 @@ EAPI Eina_Bool eina_inarray_remove_at(Eina_Inarray *array, * @see EINA_INARRAY_REVERSE_FOREACH() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inarray_reverse(Eina_Inarray *array) EINA_ARG_NONNULL(1); @@ -560,6 +624,10 @@ EAPI void eina_inarray_reverse(Eina_Inarray *array) EINA_ARG_NONNULL(1); * @see eina_inarray_insert_sorted() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inarray_sort(Eina_Inarray *array, Eina_Compare_Cb compare) EINA_ARG_NONNULL(1, 2); @@ -581,6 +649,10 @@ EAPI void eina_inarray_sort(Eina_Inarray *array, * @see eina_inarray_lookup_sorted() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_search(const Eina_Inarray *array, const void *data, @@ -600,6 +672,10 @@ EAPI int eina_inarray_search(const Eina_Inarray *array, * memory itself, do no change it. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_search_sorted(const Eina_Inarray *array, const void *data, @@ -624,6 +700,10 @@ EAPI int eina_inarray_search_sorted(const Eina_Inarray *array, * @see EINA_INARRAY_FOREACH() * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_inarray_foreach(const Eina_Inarray *array, Eina_Each_Cb function, @@ -641,6 +721,10 @@ EAPI Eina_Bool eina_inarray_foreach(const Eina_Inarray *array, * returns #EINA_TRUE. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inarray_foreach_remove(Eina_Inarray *array, Eina_Each_Cb match, @@ -654,6 +738,10 @@ EAPI int eina_inarray_foreach_remove(Eina_Inarray *array, * @return #EINA_TRUE if it resized the array successfully. * * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_inarray_resize(Eina_Inarray *array, unsigned int new_size); @@ -664,6 +752,10 @@ EAPI Eina_Bool eina_inarray_resize(Eina_Inarray *array, unsigned int new_size); * @return The number of members in the array * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI unsigned int eina_inarray_count(const Eina_Inarray *array) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -684,6 +776,10 @@ EAPI unsigned int eina_inarray_count(const Eina_Inarray *array) EINA_ARG_NONNULL * iterator's behavior is undefined and your program may crash. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_inarray_iterator_new(const Eina_Inarray *array) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -706,6 +802,10 @@ EAPI Eina_Iterator *eina_inarray_iterator_new(const Eina_Inarray *array) EINA_MA * behavior is undefined and your program may crash. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_inarray_iterator_reversed_new(const Eina_Inarray *array) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -722,6 +822,10 @@ EAPI Eina_Iterator *eina_inarray_iterator_reversed_new(const Eina_Inarray *array * Otherwise, a valid accessor is returned. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Accessor *eina_inarray_accessor_new(const Eina_Inarray *array) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h index 09cec16..4826617 100644 --- a/src/lib/eina/eina_inlist.h +++ b/src/lib/eina/eina_inlist.h @@ -434,6 +434,10 @@ struct _Eina_Inlist * @param in_item new list node, must not be @c NULL. * * @return the new list head. Use it and not @a in_list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -453,6 +457,10 @@ EAPI Eina_Inlist *eina_inlist_append(Eina_Inlist *in_list, * @param in_item new list node, must not be @c NULL. * * @return the new list head. Use it and not @a in_list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -478,6 +486,10 @@ EAPI Eina_Inlist *eina_inlist_prepend(Eina_Inlist *in_list, * @param in_relative reference node, @a in_item will be added after it. * * @return the new list head. Use it and not @a list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list, Eina_Inlist *in_item, @@ -504,6 +516,10 @@ EAPI Eina_Inlist *eina_inlist_append_relative(Eina_Inlist *in_list, * @param in_relative reference node, @a in_item will be added before it. * * @return the new list head. Use it and not @a in_list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list, Eina_Inlist *in_item, @@ -525,6 +541,10 @@ EAPI Eina_Inlist *eina_inlist_prepend_relative(Eina_Inlist *in_list, * @param in_item existing list node, must not be @c NULL. * * @return the new list head. Use it and not @a list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -539,6 +559,10 @@ EAPI Eina_Inlist *eina_inlist_remove(Eina_Inlist *in_list, * @param in_item what to search for, must not be @c NULL. * * @return @a in_item if found, @c NULL if not. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_find(Eina_Inlist *in_list, Eina_Inlist *in_item) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -557,6 +581,10 @@ EAPI Eina_Inlist *eina_inlist_find(Eina_Inlist *in_list, * @param item list node to move to beginning (head), must not be @c NULL. * * @return the new list head. Use it and not @a list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_promote(Eina_Inlist *list, Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -575,6 +603,10 @@ EAPI Eina_Inlist *eina_inlist_promote(Eina_Inlist *list, * @param item list node to move to end (tail), must not be @c NULL. * * @return the new list head. Use it and not @a list anymore. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_demote(Eina_Inlist *list, Eina_Inlist *item) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -623,6 +655,10 @@ static inline Eina_Inlist *eina_inlist_last(const Eina_Inlist *list) EINA_PURE E * @warning This is an order-N operation and so the time will depend * on the number of elements on the list, so, it might become * slow for big lists! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_RESULT; @@ -645,6 +681,10 @@ EAPI unsigned int eina_inlist_count(const Eina_Inlist *list) EINA_WARN_UNUSED_ * @warning if the list structure changes then the iterator becomes * invalid, and if you add or remove nodes iterator * behavior is undefined, and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_inlist_iterator_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -659,6 +699,10 @@ EAPI Eina_Iterator *eina_inlist_iterator_new(const Eina_Inlist *in_list) EINA_MA * less or equal than @c 0, this function returns @c NULL. If the memory can * not be allocated, @c NULL is returned and Otherwise, a valid accessor is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -682,6 +726,10 @@ EAPI Eina_Accessor *eina_inlist_accessor_new(const Eina_Inlist *in_list) EINA_MA * lists do not have O(1) access time, so walking to the correct node * can be costly, consider worst case to be almost O(n) pointer * dereference (list walk). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_sorted_insert(Eina_Inlist *list, Eina_Inlist *item, Eina_Compare_Cb func) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; @@ -692,6 +740,10 @@ EAPI Eina_Inlist *eina_inlist_sorted_insert(Eina_Inlist *list, Eina_Inlist *item * @since 1.1.0 * * See eina_inlist_sorted_state_insert() for more information. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist_Sorted_State *eina_inlist_sorted_state_new(void); @@ -706,6 +758,10 @@ EAPI Eina_Inlist_Sorted_State *eina_inlist_sorted_state_new(void); * See eina_inlist_sorted_state_insert() for more information. This function is * useful if you didn't use eina_inlist_sorted_state_insert() at some point, but * still think you have a sorted list. It will only correctly work on a sorted list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_inlist_sorted_state_init(Eina_Inlist_Sorted_State *state, Eina_Inlist *list); @@ -716,6 +772,10 @@ EAPI int eina_inlist_sorted_state_init(Eina_Inlist_Sorted_State *state, Eina_Inl * @since 1.1.0 * * See eina_inlist_sorted_state_insert() for more information. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state); @@ -746,6 +806,10 @@ EAPI void eina_inlist_sorted_state_free(Eina_Inlist_Sorted_State *state); * O(log2(n)) for number small number. After n == 256, it start to add a * linear cost again. Consider worst case to be almost O(n) pointer * dereference (list walk). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_sorted_state_insert(Eina_Inlist *list, Eina_Inlist *item, @@ -794,6 +858,10 @@ EAPI Eina_Inlist *eina_inlist_sorted_state_insert(Eina_Inlist *list, * * list = eina_inlist_sort(list, sort_cb); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Inlist *eina_inlist_sort(Eina_Inlist *head, Eina_Compare_Cb func); diff --git a/src/lib/eina/eina_iterator.h b/src/lib/eina/eina_iterator.h index 980dbfc..fbba86d 100644 --- a/src/lib/eina/eina_iterator.h +++ b/src/lib/eina/eina_iterator.h @@ -202,6 +202,10 @@ struct _Eina_Iterator * @param iterator The iterator to free. * * This function frees @p iterator if it is not @c NULL; + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_iterator_free(Eina_Iterator *iterator); @@ -214,6 +218,10 @@ EAPI void eina_iterator_free(Eina_Iterator *iterator); * * This function returns the container which created @p iterator. If * @p iterator is @c NULL, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_iterator_container_get(Eina_Iterator *iterator) EINA_ARG_NONNULL(1) EINA_PURE; @@ -228,6 +236,10 @@ EAPI void *eina_iterator_container_get(Eina_Iterator *iterator) EINA_ARG_NON * @p iterator in @p data, then goes to the next element. If @p * iterator is @c NULL or if a problem occurred, #EINA_FALSE is * returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator, void **data) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -246,6 +258,10 @@ EAPI Eina_Bool eina_iterator_next(Eina_Iterator *iterator, * the function returns immediately. Also, if @p cb returns #EINA_FALSE, * the iteration stops at that point, if @p cb returns #EINA_TRUE * the iteration continues. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_iterator_foreach(Eina_Iterator *iterator, Eina_Each_Cb callback, @@ -265,6 +281,10 @@ EAPI void eina_iterator_foreach(Eina_Iterator *iterator, * lockable, it will return #EINA_TRUE. * * @warning None of the existing eina data structures are lockable. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_iterator_lock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1); @@ -281,6 +301,10 @@ EAPI Eina_Bool eina_iterator_lock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1); * return #EINA_TRUE. * * @warning None of the existing eina data structures are lockable. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_iterator_unlock(Eina_Iterator *iterator) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_lalloc.h b/src/lib/eina/eina_lalloc.h index c2f551a..7a4567a 100644 --- a/src/lib/eina/eina_lalloc.h +++ b/src/lib/eina/eina_lalloc.h @@ -74,6 +74,9 @@ typedef struct _Eina_Lalloc Eina_Lalloc; * * @return A new lazy allocator. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Lalloc *eina_lalloc_new(void *data, Eina_Lalloc_Alloc alloc_cb, @@ -85,6 +88,9 @@ EAPI Eina_Lalloc *eina_lalloc_new(void *data, * * @param a The lazy allocator to free. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1); @@ -96,6 +102,9 @@ EAPI void eina_lalloc_free(Eina_Lalloc *a) EINA_ARG_NONNULL(1); * * @return EINA_TRUE on success, else EINA_FALSE. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_lalloc_elements_add(Eina_Lalloc *a, int num) EINA_ARG_NONNULL(1); @@ -107,6 +116,9 @@ EAPI Eina_Bool eina_lalloc_elements_add(Eina_Lalloc *a, * * @return EINA_TRUE on success, else EINA_FALSE. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_lalloc_element_add(Eina_Lalloc *a) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_list.h b/src/lib/eina/eina_list.h index e35943e..f660d8b 100644 --- a/src/lib/eina/eina_list.h +++ b/src/lib/eina/eina_list.h @@ -364,6 +364,10 @@ struct _Eina_List_Accounting * @endcode * * @warning @p list must be a pointer to the first element of the list(or NULL). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_append(Eina_List *list, const void *data) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -392,6 +396,10 @@ EAPI Eina_List *eina_list_append(Eina_List *list, const void *data) E * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_prepend(Eina_List *list, const void *data) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -425,6 +433,10 @@ EAPI Eina_List *eina_list_prepend(Eina_List *list, const void *data) * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_append_relative(Eina_List *list, const void *data, const void *relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -447,6 +459,10 @@ EAPI Eina_List *eina_list_append_relative(Eina_List *list, const void * old pointer is returned. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_append_relative_list(Eina_List *list, const void *data, Eina_List *relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -480,6 +496,10 @@ EAPI Eina_List *eina_list_append_relative_list(Eina_List *list, const * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_prepend_relative(Eina_List *list, const void *data, const void *relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -502,6 +522,10 @@ EAPI Eina_List *eina_list_prepend_relative(Eina_List *list, const voi * old pointer is returned. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_prepend_relative_list(Eina_List *list, const void *data, Eina_List *relative) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -528,6 +552,10 @@ EAPI Eina_List *eina_list_prepend_relative_list(Eina_List *list, cons * dereference (list walk). * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_sorted_insert(Eina_List *list, Eina_Compare_Cb func, const void *data) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; @@ -547,6 +575,10 @@ EAPI Eina_List *eina_list_sorted_insert(Eina_List *list, Eina_Compare * passed to this function. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_remove(Eina_List *list, const void *data) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -585,6 +617,10 @@ EAPI Eina_List *eina_list_remove(Eina_List *list, const void *data) E * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_remove_list(Eina_List *list, Eina_List *remove_list) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -619,6 +655,10 @@ EAPI Eina_List *eina_list_remove_list(Eina_List *list, Eina_List *rem * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_promote_list(Eina_List *list, Eina_List *move_list) EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -653,6 +693,10 @@ EAPI Eina_List *eina_list_promote_list(Eina_List *list, Eina_List *mo * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_demote_list(Eina_List *list, Eina_List *move_list); @@ -680,6 +724,10 @@ EAPI Eina_List *eina_list_demote_list(Eina_List *list, Eina_List *mov * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_list_data_find(const Eina_List *list, const void *data) EINA_PURE EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -696,6 +744,10 @@ EAPI void *eina_list_data_find(const Eina_List *list, const void * @c NULL is returned. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_data_find_list(const Eina_List *list, const void *data) EINA_PURE EINA_ARG_NONNULL(2) EINA_WARN_UNUSED_RESULT; @@ -713,6 +765,10 @@ EAPI Eina_List *eina_list_data_find_list(const Eina_List *list, const * from = eina_list_remove(from, data); * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_list_move(Eina_List **to, Eina_List **from, void *data); @@ -729,6 +785,10 @@ EAPI Eina_Bool eina_list_move(Eina_List **to, Eina_List **from, void * from = eina_list_remove_list(from, data); * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_list_move_list(Eina_List **to, Eina_List **from, Eina_List *data); @@ -741,6 +801,10 @@ EAPI Eina_Bool eina_list_move_list(Eina_List **to, Eina_List **from, * * This function frees all the nodes of @p list. It does not free the * data of the nodes. To free them, use #EINA_LIST_FREE. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_free(Eina_List *list); @@ -760,6 +824,10 @@ EAPI Eina_List *eina_list_free(Eina_List *list); * @note Worst case is O(n). * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_list_nth(const Eina_List *list, unsigned int n) EINA_PURE EINA_WARN_UNUSED_RESULT; @@ -781,6 +849,10 @@ EAPI void *eina_list_nth(const Eina_List *list, unsigned int n) * @note Worst case is O(n). * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_nth_list(const Eina_List *list, unsigned int n) EINA_PURE EINA_WARN_UNUSED_RESULT; @@ -802,6 +874,10 @@ EAPI Eina_List *eina_list_nth_list(const Eina_List *list, unsigned in * * @see eina_list_reverse_clone() * @see eina_list_iterator_reversed_new() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_reverse(Eina_List *list) EINA_WARN_UNUSED_RESULT; @@ -823,6 +899,10 @@ EAPI Eina_List *eina_list_reverse(Eina_List *list) EINA_WARN_UNUSED_R * * @see eina_list_reverse() * @see eina_list_clone() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_reverse_clone(const Eina_List *list) EINA_WARN_UNUSED_RESULT; @@ -843,6 +923,10 @@ EAPI Eina_List *eina_list_reverse_clone(const Eina_List *list) EINA_W * @warning @p list must be a pointer to the first element of the list. * * @see eina_list_reverse_clone() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_clone(const Eina_List *list) EINA_WARN_UNUSED_RESULT; @@ -886,6 +970,10 @@ EAPI Eina_List *eina_list_clone(const Eina_List *list) EINA_WARN_UNUS * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_sort(Eina_List *list, unsigned int limit, Eina_Compare_Cb func) EINA_ARG_NONNULL(3) EINA_WARN_UNUSED_RESULT; @@ -907,6 +995,10 @@ EAPI Eina_List *eina_list_sort(Eina_List *list, unsigned int limit, E * @since 1.8 * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_List *eina_list_shuffle(Eina_List *list, Eina_Random_Cb func) EINA_WARN_UNUSED_RESULT; @@ -927,6 +1019,10 @@ EAPI Eina_List *eina_list_shuffle(Eina_List *list, Eina_Random_Cb fun * making count and last access O(1). * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_merge(Eina_List *left, Eina_List *right) EINA_WARN_UNUSED_RESULT; @@ -967,6 +1063,10 @@ EAPI Eina_List *eina_list_merge(Eina_List *left, Eina_List *right) EI * @endcode * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_sorted_merge(Eina_List *left, Eina_List *right, Eina_Compare_Cb func) EINA_ARG_NONNULL(3) EINA_WARN_UNUSED_RESULT; @@ -987,6 +1087,10 @@ EAPI Eina_List *eina_list_sorted_merge(Eina_List *left, Eina_List *ri * list does not exist anymore after the split. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_split_list(Eina_List *list, Eina_List *relative, Eina_List **right) EINA_WARN_UNUSED_RESULT; @@ -1049,6 +1153,10 @@ EAPI Eina_List *eina_list_split_list(Eina_List *list, Eina_List *rela * @see eina_list_search_sorted_list() * @see eina_list_sort() * @see eina_list_sorted_merge() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_search_sorted_near_list(const Eina_List *list, Eina_Compare_Cb func, const void *data, int *result_cmp); @@ -1085,6 +1193,10 @@ EAPI Eina_List *eina_list_search_sorted_near_list(const Eina_List *li * @see eina_list_sorted_merge() * @see eina_list_search_unsorted_list() * @see eina_list_search_sorted_near_list() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_search_sorted_list(const Eina_List *list, Eina_Compare_Cb func, const void *data); @@ -1121,6 +1233,10 @@ EAPI Eina_List *eina_list_search_sorted_list(const Eina_List *list, E * @see eina_list_sort() * @see eina_list_sorted_merge() * @see eina_list_search_unsorted_list() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_list_search_sorted(const Eina_List *list, Eina_Compare_Cb func, const void *data); @@ -1147,6 +1263,10 @@ EAPI void *eina_list_search_sorted(const Eina_List *list, Eina_C * * @see eina_list_search_sorted_list() * @see eina_list_search_unsorted() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *eina_list_search_unsorted_list(const Eina_List *list, Eina_Compare_Cb func, const void *data); @@ -1174,6 +1294,10 @@ EAPI Eina_List *eina_list_search_unsorted_list(const Eina_List *list, * * @see eina_list_search_sorted() * @see eina_list_search_unsorted_list() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_list_search_unsorted(const Eina_List *list, Eina_Compare_Cb func, const void *data); @@ -1298,6 +1422,10 @@ static inline void *eina_list_last_data_get(const Eina_List *list); * @warning if the list structure changes then the iterator becomes * invalid! That is, if you add or remove nodes this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_list_iterator_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -1324,6 +1452,10 @@ EAPI Eina_Iterator *eina_list_iterator_new(const Eina_List *list) EINA_MA * @warning if the list structure changes then the iterator becomes * invalid! That is, if you add or remove nodes this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_list_iterator_reversed_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -1341,6 +1473,10 @@ EAPI Eina_Iterator *eina_list_iterator_reversed_new(const Eina_List *list * returned. * * @warning @p list must be a pointer to the first element of the list. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Accessor *eina_list_accessor_new(const Eina_List *list) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -1358,6 +1494,10 @@ EAPI Eina_Accessor *eina_list_accessor_new(const Eina_List *list) EINA_MA * @warning @p list must be a pointer to the first element of the list. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_list_data_idx(const Eina_List *list, void *data); diff --git a/src/lib/eina/eina_lock.h b/src/lib/eina/eina_lock.h index 482a77e..b783834 100644 --- a/src/lib/eina/eina_lock.h +++ b/src/lib/eina/eina_lock.h @@ -102,6 +102,10 @@ typedef void (*Eina_TLS_Delete_Cb)(void *ptr); /** * @brief A type definition for warning that a function was called from * somewhere other than the EFL main loop. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern Eina_Error EINA_ERROR_NOT_MAIN_LOOP; diff --git a/src/lib/eina/eina_log.h b/src/lib/eina/eina_log.h index a4e600c..82037ee 100644 --- a/src/lib/eina/eina_log.h +++ b/src/lib/eina/eina_log.h @@ -229,6 +229,10 @@ /** * EINA_LOG_DOMAIN_GLOBAL is the general purpose log domain to be * used, it is always registered and available everywhere. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern int EINA_LOG_DOMAIN_GLOBAL; @@ -440,6 +444,10 @@ struct _Eina_Log_Domain * * The main thread is considered the thread where the first * eina_init() was called. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_threads_enable(void); @@ -503,6 +511,10 @@ typedef enum _Eina_Log_State * @note MT: given function @a cb will be called protected by mutex. * This means you're safe from other calls but you should never * call eina_log_print(), directly or indirectly. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print_cb_set(Eina_Log_Print_Cb cb, void *data) EINA_ARG_NONNULL(1); @@ -518,6 +530,10 @@ EAPI void eina_log_print_cb_set(Eina_Log_Print_Cb cb, void *data) EINA_ARG_NONNU * @note this is initially set to envvar EINA_LOG_LEVEL by eina_init(). * * @see eina_log_level_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_level_set(int level); @@ -527,6 +543,10 @@ EAPI void eina_log_level_set(int level); * @return the log level that limits eina_log_print(). * * @see eina_log_level_set() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_log_level_get(void) EINA_WARN_UNUSED_RESULT; @@ -550,6 +570,10 @@ static inline Eina_Bool eina_log_level_check(int level); * * @return #EINA_TRUE if the current thread is the one that called * eina_log_threads_init(), otherwise #EINA_FALSE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_log_main_thread_check(void) EINA_CONST EINA_WARN_UNUSED_RESULT; @@ -562,6 +586,10 @@ EAPI Eina_Bool eina_log_main_thread_check(void) EINA_CONST EINA_WARN_UN * @note this is initially set to envvar EINA_LOG_COLOR_DISABLE by eina_init(). * * @see eina_log_color_disable_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_color_disable_set(Eina_Bool disabled); @@ -571,6 +599,10 @@ EAPI void eina_log_color_disable_set(Eina_Bool disabled); * @return If #EINA_TRUE, color logging is disabled. * * @see eina_log_color_disable_set() + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_log_color_disable_get(void) EINA_WARN_UNUSED_RESULT; @@ -582,6 +614,10 @@ EAPI Eina_Bool eina_log_color_disable_get(void) EINA_WARN_UNUSED_RESULT * @note this is initially set to envvar EINA_LOG_FILE_DISABLE by eina_init(). * * @see eina_log_file_disable_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_file_disable_set(Eina_Bool disabled); @@ -591,6 +627,10 @@ EAPI void eina_log_file_disable_set(Eina_Bool disabled); * @return if #EINA_TRUE, file name logging should be disabled. * * @see eina_log_file_disable_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_log_file_disable_get(void) EINA_WARN_UNUSED_RESULT; @@ -603,6 +643,10 @@ EAPI Eina_Bool eina_log_file_disable_get(void) EINA_WARN_UNUSED_RESULT; * eina_init(). * * @see eina_log_function_disable_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_function_disable_set(Eina_Bool disabled); @@ -612,6 +656,10 @@ EAPI void eina_log_function_disable_set(Eina_Bool disabled); * @return if #EINA_TRUE, function name logging should be disabled. * * @see eina_log_function_disable_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_log_function_disable_get(void) EINA_WARN_UNUSED_RESULT; @@ -627,6 +675,10 @@ EAPI Eina_Bool eina_log_function_disable_get(void) EINA_WARN_UNUSED_RES * * @see eina_log_abort_on_critical_get() * @see eina_log_abort_on_critical_level_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_abort_on_critical_set(Eina_Bool abort_on_critical); @@ -639,6 +691,10 @@ EAPI void eina_log_abort_on_critical_set(Eina_Bool abort_on_critic * * @see eina_log_abort_on_critical_set() * @see eina_log_abort_on_critical_level_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_log_abort_on_critical_get(void) EINA_WARN_UNUSED_RESULT; @@ -654,6 +710,10 @@ EAPI Eina_Bool eina_log_abort_on_critical_get(void) EINA_WARN_UNUSED_RE * * @see eina_log_abort_on_critical_level_get() * @see eina_log_abort_on_critical_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_abort_on_critical_level_set(int critical_level); @@ -666,6 +726,10 @@ EAPI void eina_log_abort_on_critical_level_set(int critical_level) * * @see eina_log_abort_on_critical_level_set() * @see eina_log_abort_on_critical_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_log_abort_on_critical_level_get(void) EINA_WARN_UNUSED_RESULT; @@ -681,6 +745,10 @@ EAPI int eina_log_abort_on_critical_level_get(void) EINA_WARN_UNU * yet, it will be saved as a pending set and applied upon * registration. * @param level level to use to limit eina_log_print() for given domain. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_domain_level_set(const char *domain_name, int level) EINA_ARG_NONNULL(1); @@ -701,6 +769,10 @@ EAPI void eina_log_domain_level_set(const char *domain_name, int l * * @see eina_log_domain_level_set() * @see eina_log_domain_registered_level_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_log_domain_level_get(const char *domain_name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -714,6 +786,10 @@ EAPI int eina_log_domain_level_get(const char *domain_name) EINA_ * * @return #EINA_TRUE if level should be printed, #EINA_FALSE if not. * (domain's level is greater or equal @a level). + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_log_domain_registered_level_get(int domain) EINA_WARN_UNUSED_RESULT; @@ -726,6 +802,10 @@ EAPI int eina_log_domain_registered_level_get(int domain) EINA_WA * present. * @param level level to use to limit eina_log_print() for given domain. * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_domain_registered_level_set(int domain, int level); @@ -743,6 +823,10 @@ static inline Eina_Bool eina_log_domain_level_check(int domain, int level); * macros. A negative return value means an log occurred. * * @note MT: safe to call from any thread. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_log_domain_register(const char *name, const char *color) EINA_ARG_NONNULL(1); @@ -753,6 +837,10 @@ EAPI int eina_log_domain_register(const char *name, const char *color) EINA_ARG * must be >= 0. * * @note MT: safe to call from any thread. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_domain_unregister(int domain); @@ -782,6 +870,10 @@ EAPI void eina_log_domain_unregister(int domain); * * @note MT: this function may be called from different threads if * eina_log_threads_enable() was called before. + * + * @if MOBILE @since_tizen 2.4 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print(int domain, Eina_Log_Level level, @@ -815,6 +907,10 @@ EAPI void eina_log_print(int domain, * eina_log_threads_enable() was called before. * * @see eina_log_print() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_vprint(int domain, Eina_Log_Level level, @@ -853,6 +949,10 @@ EAPI void eina_log_vprint(int domain, * @note MT: if threads are enabled, this function is called within locks. * @note MT: Threads different from main thread will have thread id * appended to domain name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d, Eina_Log_Level level, @@ -896,6 +996,10 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d, * @note MT: if threads are enabled, this function is called within locks. * @note MT: Threads different from main thread will have thread id * appended to domain name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print_cb_stderr(const Eina_Log_Domain *d, Eina_Log_Level level, @@ -923,6 +1027,10 @@ EAPI void eina_log_print_cb_stderr(const Eina_Log_Domain *d, * @note MT: if threads are enabled, this function is called within locks. * @note MT: Threads different from main thread will have thread id * appended to domain name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print_cb_file(const Eina_Log_Domain *d, Eina_Log_Level level, @@ -1006,6 +1114,10 @@ EAPI void eina_log_print_cb_dlog(const Eina_Log_Domain *d, * @note if the process has been started by systemd this will be the default logging method. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_print_cb_journald(const Eina_Log_Domain *d, Eina_Log_Level level, @@ -1027,13 +1139,29 @@ EAPI void eina_log_print_cb_journald(const Eina_Log_Domain *d, * @note on windows, both @a fp and @a color is converted automatically. * * @since 1.7 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_console_color_set(FILE *fp, const char *color) EINA_ARG_NONNULL(1, 2); -/** String that indicates the log system is initializing */ +/** + * String that indicates the log system is initializin + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ extern EAPI const char *_eina_log_state_init; -/** String that indicates the log system is shutting down */ +/** + * String that indicates the log system is shutting dow + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif + */ extern EAPI const char *_eina_log_state_shutdown; /** @def EINA_LOG_STATE_INIT *String that indicates the log system is initializing @@ -1056,6 +1184,10 @@ extern EAPI const char *_eina_log_state_shutdown; * the previous phase has stopped. * @note The phase name should be available for all the life of the timing. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_log_timing(int domain, Eina_Log_State state, diff --git a/src/lib/eina/eina_magic.h b/src/lib/eina/eina_magic.h index b12f282..bd57762 100644 --- a/src/lib/eina/eina_magic.h +++ b/src/lib/eina/eina_magic.h @@ -150,6 +150,10 @@ typedef unsigned int Eina_Magic; * - (unknown): Magic is not found in the registry. * * @warning The returned value must not be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_magic_string_get(Eina_Magic magic) EINA_WARN_UNUSED_RESULT; /** @@ -166,6 +170,10 @@ EAPI const char *eina_magic_string_get(Eina_Magic magic) EINA_WARN_UNUSED_RESULT * duplicates. Internally, eina makes a copy of @p magic_name. * * @see eina_magic_string_static_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_magic_string_set(Eina_Magic magic, const char *magic_name) EINA_ARG_NONNULL(2); @@ -185,6 +193,10 @@ EAPI Eina_Bool eina_magic_string_set(Eina_Magic magic, * @p magic_name has to be a valid pointer for as long as @p magic is used. * * @see eina_magic_string_set() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_magic_string_static_set(Eina_Magic magic, const char *magic_name) EINA_ARG_NONNULL(2); @@ -202,6 +214,10 @@ EAPI Eina_Bool eina_magic_string_static_set(Eina_Magic magic, /** * @var EINA_ERROR_MAGIC_FAILED * @brief The error identifier corresponding to the magic check failure. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern Eina_Error EINA_ERROR_MAGIC_FAILED; @@ -292,6 +308,10 @@ EAPI extern Eina_Error EINA_ERROR_MAGIC_FAILED; * @note If the environment variable EINA_LOG_ABORT is set, abort() is * called and the program stops. It is useful for debugging programs * with gdb. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_magic_fail(void *d, Eina_Magic m, Eina_Magic req_m, const char *file, const char *fnc, diff --git a/src/lib/eina/eina_main.h b/src/lib/eina/eina_main.h index d7a7f0b..47245f7 100644 --- a/src/lib/eina/eina_main.h +++ b/src/lib/eina/eina_main.h @@ -80,6 +80,10 @@ EAPI extern Eina_Version *eina_version; * * When Eina is not used anymore, call eina_shutdown() to shut down * the Eina library. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_init(void); @@ -96,6 +100,10 @@ EAPI int eina_init(void); * Once this function succeeds (that is, @c 0 is returned), you must * not call any of the Eina function anymore. You must call * eina_init() again to use the Eina functions again. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_shutdown(void); @@ -113,6 +121,10 @@ EAPI int eina_shutdown(void); * the mutexes. * * This function should never be called outside of the main loop. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_threads_init(void); @@ -131,6 +143,10 @@ EAPI int eina_threads_init(void); * eina_threads_init() again to use the Eina functions in a thread again. * * This function should never be called outside of the main loop. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_threads_shutdown(void); @@ -144,6 +160,10 @@ EAPI int eina_threads_shutdown(void); * Most EFL function are not thread safe and all the call need to happen in * the main loop. With this call you could know if you can call an EFL * function or not. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_main_loop_is(void); @@ -153,6 +173,10 @@ EAPI Eina_Bool eina_main_loop_is(void); * * If you are reading this documentation, that certainly means you don't know what is the purpose of * this call and you should just not use it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_main_loop_define(void); diff --git a/src/lib/eina/eina_matrix.h b/src/lib/eina/eina_matrix.h index 2f9ad21..d28ef20 100644 --- a/src/lib/eina/eina_matrix.h +++ b/src/lib/eina/eina_matrix.h @@ -173,11 +173,19 @@ struct _Eina_Matrix3_F16p16 * @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_f16p16_identity(Eina_Matrix3_F16p16 *m); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_f16p16_compose(const Eina_Matrix3_F16p16 *m1, const Eina_Matrix3_F16p16 *m2, @@ -193,6 +201,10 @@ EAPI void eina_matrix3_f16p16_compose(const Eina_Matrix3_F16p16 *m1, * on @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Matrix_Type eina_matrix3_f16p16_type_get(const Eina_Matrix3_F16p16 *m); @@ -225,6 +237,10 @@ EAPI Eina_Matrix_Type eina_matrix3_f16p16_type_get(const Eina_Matrix3_F16p16 *m) * on @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Matrix_Type eina_matrix3_type_get(const Eina_Matrix3 *m); @@ -249,6 +265,10 @@ EAPI Eina_Matrix_Type eina_matrix3_type_get(const Eina_Matrix3 *m); * @see eina_matrix3_values_get() * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_values_set(Eina_Matrix3 *m, double xx, double xy, double xz, @@ -276,6 +296,10 @@ EAPI void eina_matrix3_values_set(Eina_Matrix3 *m, * @see eina_matrix3_values_set() * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_values_get(const Eina_Matrix3 *m, double *xx, double *xy, double *xz, @@ -303,6 +327,10 @@ EAPI void eina_matrix3_values_get(const Eina_Matrix3 *m, * @see eina_matrix3_values_set() * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_fixed_values_get(const Eina_Matrix3 *m, Eina_F16p16 *xx, Eina_F16p16 *xy, Eina_F16p16 *xz, @@ -321,6 +349,10 @@ EAPI void eina_matrix3_fixed_values_get(const Eina_Matrix3 *m, * @p fm. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_matrix3_f16p16_to(const Eina_Matrix3 *m, Eina_Matrix3_F16p16 *fm); @@ -336,11 +368,19 @@ EAPI void eina_matrix3_matrix3_f16p16_to(const Eina_Matrix3 *m, * equal, EINA_FALSE otherwise. No check is done on the matrices. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix3_equal(const Eina_Matrix3 *m1, const Eina_Matrix3 *m2); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1, const Eina_Matrix3 *m2, @@ -353,6 +393,10 @@ EAPI void eina_matrix3_compose(const Eina_Matrix3 *m1, * @param[in] ty The Y coordinate translate * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_translate(Eina_Matrix3 *t, double tx, double ty); @@ -363,6 +407,10 @@ EAPI void eina_matrix3_translate(Eina_Matrix3 *t, double tx, double ty); * @param[in] sy The Y coordinate scale * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_scale(Eina_Matrix3 *t, double sx, double sy); @@ -372,6 +420,10 @@ EAPI void eina_matrix3_scale(Eina_Matrix3 *t, double sx, double sy); * @param[in] rad The radius to rotate the matrix * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_rotate(Eina_Matrix3 *t, double rad); @@ -384,6 +436,10 @@ EAPI void eina_matrix3_rotate(Eina_Matrix3 *t, double rad); * @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_identity(Eina_Matrix3 *t); @@ -397,6 +453,10 @@ EAPI void eina_matrix3_identity(Eina_Matrix3 *t); * is done on @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double eina_matrix3_determinant(const Eina_Matrix3 *m); @@ -410,6 +470,10 @@ EAPI double eina_matrix3_determinant(const Eina_Matrix3 *m); * is done on @p m. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_divide(Eina_Matrix3 *m, double scalar); @@ -424,32 +488,56 @@ EAPI void eina_matrix3_divide(Eina_Matrix3 *m, double scalar); * invertible, then @p m2 is set to the identity matrix. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_inverse(const Eina_Matrix3 *m, Eina_Matrix3 *m2); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_transpose(const Eina_Matrix3 *m, Eina_Matrix3 *a); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_cofactor(const Eina_Matrix3 *m, Eina_Matrix3 *a); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_adjoint(const Eina_Matrix3 *m, Eina_Matrix3 *a); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_point_transform(const Eina_Matrix3 *m, double x, double y, double *xr, double *yr); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_rectangle_transform(const Eina_Matrix3 *m, const Eina_Rectangle *r, @@ -457,6 +545,10 @@ EAPI void eina_matrix3_rectangle_transform(const Eina_Matrix3 *m, /** * @brief Creates a projective matrix that maps a quadrangle to a quadrangle + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix3_quad_quad_map(Eina_Matrix3 *m, const Eina_Quad *src, @@ -464,12 +556,20 @@ EAPI Eina_Bool eina_matrix3_quad_quad_map(Eina_Matrix3 *m, /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix3_square_quad_map(Eina_Matrix3 *m, const Eina_Quad *q); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix3_quad_square_map(Eina_Matrix3 *m, const Eina_Quad *q); @@ -483,6 +583,10 @@ EAPI Eina_Bool eina_matrix3_quad_square_map(Eina_Matrix3 *m, * Set to matrix first 9 elements from array * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v); @@ -493,6 +597,10 @@ EAPI void eina_matrix3_array_set(Eina_Matrix3 *m, const double *v); * @param src The matrix for copy. * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src); @@ -504,6 +612,10 @@ EAPI void eina_matrix3_copy(Eina_Matrix3 *dst, const Eina_Matrix3 *src); * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, const Eina_Matrix3 *mat_b); @@ -516,6 +628,10 @@ EAPI void eina_matrix3_multiply(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_multiply_copy(Eina_Matrix3 *out, const Eina_Matrix3 *mat_a, const Eina_Matrix3 *mat_b); @@ -528,6 +644,10 @@ EAPI void eina_matrix3_multiply_copy(Eina_Matrix3 *out, const Eina_Matrix3 *mat_ * @param s_y The scale value for y * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_scale_transform_set(Eina_Matrix3 *out, double s_x, double s_y); @@ -539,6 +659,10 @@ EAPI void eina_matrix3_scale_transform_set(Eina_Matrix3 *out, double s_x, double * @param p_y The position value for y * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_position_transform_set(Eina_Matrix3 *out, const double p_x, const double p_y); @@ -550,6 +674,10 @@ EAPI void eina_matrix3_position_transform_set(Eina_Matrix3 *out, const double p_ * @param m The matrix * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_normal3_matrix_get(Eina_Matrix3 *out, const Eina_Matrix4 *m); @@ -560,6 +688,10 @@ EAPI void eina_normal3_matrix_get(Eina_Matrix3 *out, const Eina_Matrix4 *m); * @param m4 The source Eina_Matrix4. * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix3_matrix4_to(Eina_Matrix4 *m4, const Eina_Matrix3 *m3); @@ -583,6 +715,10 @@ EAPI void eina_matrix3_matrix4_to(Eina_Matrix4 *m4, const Eina_Matrix3 *m3); * on @p m. * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Matrix_Type eina_matrix4_type_get(const Eina_Matrix4 *m); @@ -614,6 +750,10 @@ EAPI Eina_Matrix_Type eina_matrix4_type_get(const Eina_Matrix4 *m); * @see eina_matrix4_values_get() * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_values_set(Eina_Matrix4 *m, double xx, double xy, double xz, double xw, @@ -649,6 +789,10 @@ EAPI void eina_matrix4_values_set(Eina_Matrix4 *m, * @see eina_matrix4_values_set() * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_values_get(const Eina_Matrix4 *m, double *xx, double *xy, double *xz, double *xw, @@ -666,6 +810,10 @@ EAPI void eina_matrix4_values_get(const Eina_Matrix4 *m, * is done on @p m. * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double eina_matrix4_determinant(const Eina_Matrix4 *m); @@ -679,6 +827,10 @@ EAPI double eina_matrix4_determinant(const Eina_Matrix4 *m); * is done on @p m. * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix4_normalized(Eina_Matrix4 *out, const Eina_Matrix4 *in); @@ -691,6 +843,10 @@ EAPI Eina_Bool eina_matrix4_normalized(Eina_Matrix4 *out, * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_matrix4_inverse(Eina_Matrix4 *out, const Eina_Matrix4 *in); @@ -703,6 +859,10 @@ EAPI Eina_Bool eina_matrix4_inverse(Eina_Matrix4 *out, const Eina_Matrix4 *in); * Just going to swap row and column. * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_transpose(Eina_Matrix4 *out, const Eina_Matrix4 *in); @@ -713,6 +873,10 @@ EAPI void eina_matrix4_transpose(Eina_Matrix4 *out, const Eina_Matrix4 *in); * @param m4 The source Eina_Matrix4. * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_matrix3_to(Eina_Matrix3 *m3, const Eina_Matrix4 *m4); @@ -722,6 +886,10 @@ EAPI void eina_matrix4_matrix3_to(Eina_Matrix3 *m3, const Eina_Matrix4 *m4); * @param out The matrix to set * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_identity(Eina_Matrix4 *out); @@ -733,6 +901,10 @@ EAPI void eina_matrix4_identity(Eina_Matrix4 *out); * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_multiply_copy(Eina_Matrix4 *out, const Eina_Matrix4 *mat_a, const Eina_Matrix4 *mat_b); @@ -746,6 +918,10 @@ EAPI void eina_matrix4_multiply_copy(Eina_Matrix4 *out, * Set to matrix first 16 elements from array * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_array_set(Eina_Matrix4 *m, const double *v); @@ -756,6 +932,10 @@ EAPI void eina_matrix4_array_set(Eina_Matrix4 *m, const double *v); * @param src The matrix for copy. * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src); @@ -767,6 +947,10 @@ EAPI void eina_matrix4_copy(Eina_Matrix4 *dst, const Eina_Matrix4 *src); * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_multiply(Eina_Matrix4 *out, const Eina_Matrix4 *mat_a, const Eina_Matrix4 *mat_b); @@ -783,6 +967,10 @@ EAPI void eina_matrix4_multiply(Eina_Matrix4 *out, const Eina_Matrix4 *mat_a, * @param dfar The dfar value * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix4_ortho_set(Eina_Matrix4 *m, double left, double right, double bottom, double top, @@ -835,6 +1023,10 @@ struct _Eina_Matrix2 * @see eina_matrix2_values_get() * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_values_set(Eina_Matrix2 *m, double xx, double xy, double yx, double yy); @@ -855,6 +1047,10 @@ EAPI void eina_matrix2_values_set(Eina_Matrix2 *m, double xx, double xy, * @see eina_matrix2_values_set() * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_values_get(const Eina_Matrix2 *m, double *xx, double *xy, double *yx, double *yy); @@ -870,6 +1066,10 @@ EAPI void eina_matrix2_values_get(const Eina_Matrix2 *m, double *xx, double *xy, * invertible, then @p m2 is set to the identity matrix. * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_inverse(Eina_Matrix2 *out, const Eina_Matrix2 *mat); @@ -882,6 +1082,10 @@ EAPI void eina_matrix2_inverse(Eina_Matrix2 *out, const Eina_Matrix2 *mat); * @p m. * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_identity(Eina_Matrix2 *m); @@ -894,6 +1098,10 @@ EAPI void eina_matrix2_identity(Eina_Matrix2 *m); * Set to matrix first 4 elements from array * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_array_set(Eina_Matrix2 *m, const double *v); @@ -904,6 +1112,10 @@ EAPI void eina_matrix2_array_set(Eina_Matrix2 *m, const double *v); * @param src The matrix for copy. * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src); @@ -915,6 +1127,10 @@ EAPI void eina_matrix2_copy(Eina_Matrix2 *dst, const Eina_Matrix2 *src); * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_multiply(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a, const Eina_Matrix2 *mat_b); @@ -927,6 +1143,10 @@ EAPI void eina_matrix2_multiply(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a, * @param b The second member of the multiplication * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_matrix2_multiply_copy(Eina_Matrix2 *out, const Eina_Matrix2 *mat_a, const Eina_Matrix2 *mat_b); @@ -941,6 +1161,10 @@ EAPI void eina_matrix2_multiply_copy(Eina_Matrix2 *out, const Eina_Matrix2 *mat_ * on @p m. * * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Matrix_Type eina_matrix2_type_get(const Eina_Matrix2 *m); diff --git a/src/lib/eina/eina_matrixsparse.h b/src/lib/eina/eina_matrixsparse.h index 5523c0f..418acea 100644 --- a/src/lib/eina/eina_matrixsparse.h +++ b/src/lib/eina/eina_matrixsparse.h @@ -88,6 +88,10 @@ typedef struct _Eina_Matrixsparse_Cell Eina_Matrixsparse_Cell; * @param user_data given to @a free_func as first parameter. * * @return Newly allocated matrix or @c NULL if allocation failed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Matrixsparse *eina_matrixsparse_new(unsigned long rows, unsigned long cols, @@ -99,6 +103,10 @@ EAPI Eina_Matrixsparse *eina_matrixsparse_new(unsigned long rows, * @brief Free resources allocated to Sparse Matrix. * * @param m The Sparse Matrix instance to free, must @b not be @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_matrixsparse_free(Eina_Matrixsparse *m); @@ -115,6 +123,10 @@ EAPI void eina_matrixsparse_free(Eina_Matrixsparse *m); * returned value is zero, otherwise it's a positive integer. * @param cols returns the number of columns, may be @c NULL. If @a m is * invalid, returned value is zero, otherwise it's a positive integer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_matrixsparse_size_get(const Eina_Matrixsparse *m, unsigned long *rows, @@ -134,6 +146,10 @@ EAPI void eina_matrixsparse_size_get(const Eina_Matrixsparse *m, * @warning cells, rows or columns are not reference counted and thus * after this call any reference might be invalid if instance were * freed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_size_set(Eina_Matrixsparse *m, unsigned long rows, @@ -154,6 +170,10 @@ EAPI Eina_Bool eina_matrixsparse_size_set(Eina_Matrixsparse *m, * * @see eina_matrixsparse_cell_data_get() * @see eina_matrixsparse_data_idx_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_idx_get(const Eina_Matrixsparse *m, unsigned long row, unsigned long col, Eina_Matrixsparse_Cell **cell); @@ -166,6 +186,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_get(const Eina_Matrixsparse *m, unsign * * @see eina_matrixsparse_cell_idx_get() * @see eina_matrixsparse_data_idx_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_matrixsparse_cell_data_get(const Eina_Matrixsparse_Cell *cell); @@ -180,6 +204,10 @@ EAPI void *eina_matrixsparse_cell_data_get(const Eina_Matrixsparse_Cell *cel * * @see eina_matrixsparse_cell_idx_get() * @see eina_matrixsparse_cell_data_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_matrixsparse_data_idx_get(const Eina_Matrixsparse *m, unsigned long row, unsigned long col); @@ -191,6 +219,10 @@ EAPI void *eina_matrixsparse_data_idx_get(const Eina_Matrixsparse *m, unsign * @param col where to store cell column number, may be @c NULL. * * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@c cell is @c NULL). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_position_get(const Eina_Matrixsparse_Cell *cell, unsigned long *row, unsigned long *col); @@ -207,6 +239,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_position_get(const Eina_Matrixsparse_Cell * * @see eina_matrixsparse_cell_data_set() * @see eina_matrixsparse_data_idx_replace() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_data_replace(Eina_Matrixsparse_Cell *cell, const void *data, void **p_old); @@ -223,6 +259,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_data_replace(Eina_Matrixsparse_Cell *cell, * * @see eina_matrixsparse_cell_data_replace() * @see eina_matrixsparse_data_idx_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_data_set(Eina_Matrixsparse_Cell *cell, const void *data); @@ -240,6 +280,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_data_set(Eina_Matrixsparse_Cell *cell, con * * @see eina_matrixsparse_cell_data_replace() * @see eina_matrixsparse_data_idx_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_data_idx_replace(Eina_Matrixsparse *m, unsigned long row, unsigned long col, const void *data, void **p_old); @@ -258,6 +302,10 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_replace(Eina_Matrixsparse *m, unsigned * @return #EINA_TRUE on success, #EINA_FALSE otherwise (@a m is @c NULL, indexes are not valid). * * @see eina_matrixsparse_cell_data_replace() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_data_idx_set(Eina_Matrixsparse *m, unsigned long row, unsigned long col, const void *data); @@ -279,6 +327,10 @@ EAPI Eina_Bool eina_matrixsparse_data_idx_set(Eina_Matrixsparse *m, unsigned lon * @warning cells, rows or columns are not reference counted and thus * after this call any reference might be invalid if instance were * freed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_row_idx_clear(Eina_Matrixsparse *m, unsigned long row); @@ -298,6 +350,10 @@ EAPI Eina_Bool eina_matrixsparse_row_idx_clear(Eina_Matrixsparse *m, unsigned lo * @warning cells, rows or columns are not reference counted and thus * after this call any reference might be invalid if instance were * freed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned long col); @@ -320,6 +376,10 @@ EAPI Eina_Bool eina_matrixsparse_column_idx_clear(Eina_Matrixsparse *m, unsigned * * @note This call might delete container column and row if this cell was the * last remainder. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned long row, unsigned long col); @@ -336,6 +396,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_idx_clear(Eina_Matrixsparse *m, unsigned l * * @note This call might delete container column and row if this cell was the * last remainder. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell); @@ -358,6 +422,10 @@ EAPI Eina_Bool eina_matrixsparse_cell_clear(Eina_Matrixsparse_Cell *cell); * @warning if the matrix structure changes then the iterator becomes * invalid! That is, if you add or remove cells this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_matrixsparse_iterator_new(const Eina_Matrixsparse *m); @@ -384,6 +452,10 @@ EAPI Eina_Iterator *eina_matrixsparse_iterator_new(const Eina_Matrixsparse *m); * @warning if the matrix structure changes then the iterator becomes * invalid! That is, if you add or remove cells this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_matrixsparse_iterator_complete_new(const Eina_Matrixsparse *m); diff --git a/src/lib/eina/eina_mempool.h b/src/lib/eina/eina_mempool.h index 32774cc..8a68fcf 100644 --- a/src/lib/eina/eina_mempool.h +++ b/src/lib/eina/eina_mempool.h @@ -83,6 +83,10 @@ EAPI extern Eina_Error EINA_ERROR_NOT_MEMPOOL_MODULE; * @param[in] options Unused. Use the variable arguments list instead to pass options to the mempool. * @param[in] ... Additional options to pass to the allocator; depends entirely on the type of mempool ("int pool size" for chained and "int item_size" for one_big. * @return Newly allocated mempool instance, NULL otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Mempool *eina_mempool_add(const char *name, const char *context, const char *options, ...) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -90,6 +94,10 @@ EAPI Eina_Mempool *eina_mempool_add(const char *name, const char *context, cons * @brief Deletes the given mempool. * * @param[in] mp The mempool to delete + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_mempool_del(Eina_Mempool *mp) EINA_ARG_NONNULL(1); @@ -168,6 +176,10 @@ static inline void eina_mempool_free(Eina_Mempool *mp, void *element) EINA_ARG_ * * @see Eina_Mempool_Repack_Cb * @see _Eina_Mempool_Backend + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_mempool_repack(Eina_Mempool *mp, Eina_Mempool_Repack_Cb cb, void *data) EINA_ARG_NONNULL(1, 2); @@ -175,6 +187,10 @@ EAPI void eina_mempool_repack(Eina_Mempool *mp, Eina_Mempool_Repack_Cb c * @brief Run a garbage collection cycle. * * @param[in] mp The mempool + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_mempool_gc(Eina_Mempool *mp) EINA_ARG_NONNULL(1); @@ -183,6 +199,9 @@ EAPI void eina_mempool_gc(Eina_Mempool *mp) EINA_ARG_NONNULL(1); * * @param[in] mp The mempool * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_mempool_statistics(Eina_Mempool *mp) EINA_ARG_NONNULL(1); @@ -192,6 +211,10 @@ EAPI void eina_mempool_statistics(Eina_Mempool *mp) EINA_ARG_NONNULL(1 * @param[in] be The backend * @return #EINA_TRUE if backend has been correctly registered, #EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_mempool_register(Eina_Mempool_Backend *be) EINA_ARG_NONNULL(1); @@ -199,6 +222,10 @@ EAPI Eina_Bool eina_mempool_register(Eina_Mempool_Backend *be) EINA_ARG_NON * @brief Unregisters the given memory pool backend. * * @param[in] be The backend + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_mempool_unregister(Eina_Mempool_Backend *be) EINA_ARG_NONNULL(1); @@ -207,6 +234,10 @@ EAPI void eina_mempool_unregister(Eina_Mempool_Backend *be) EINA_ARG_N * * @param[in] size * @return The alignment for an allocation of size @p size. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ static inline unsigned int eina_mempool_alignof(unsigned int size); diff --git a/src/lib/eina/eina_mmap.h b/src/lib/eina/eina_mmap.h index 1d1d58c..7b3da5f 100644 --- a/src/lib/eina/eina_mmap.h +++ b/src/lib/eina/eina_mmap.h @@ -38,6 +38,10 @@ * such "damaged files" that would take down your process. * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_mmap_safety_enabled_set(Eina_Bool enabled); @@ -51,6 +55,10 @@ eina_mmap_safety_enabled_set(Eina_Bool enabled); * See eina_mmap_safety_enabled_set() for more information. * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_mmap_safety_enabled_get(void); diff --git a/src/lib/eina/eina_module.h b/src/lib/eina/eina_module.h index d1030b9..5a569e1 100644 --- a/src/lib/eina/eina_module.h +++ b/src/lib/eina/eina_module.h @@ -121,6 +121,10 @@ extern EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED; * to free the allocated memory. * * @see eina_module_load + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Module * eina_module_new(const char *file) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -135,6 +139,10 @@ EAPI Eina_Module * * loaded and frees the allocated memory. On success this function * returns #EINA_TRUE and #EINA_FALSE otherwise. If @p module is @c NULL, the * function returns immediately. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_module_free(Eina_Module *module) EINA_ARG_NONNULL(1); @@ -156,6 +164,10 @@ EAPI Eina_Bool * * When the symbols of the shared file objects are not needed * anymore, call eina_module_unload() to unload the module. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_module_load(Eina_Module *module) EINA_ARG_NONNULL(1); @@ -173,6 +185,10 @@ EAPI Eina_Bool * is shutted down just before. In that case, #EINA_TRUE is * returned. In all case, the reference counter is decreased. If @p module * is @c NULL, the function returns immediately #EINA_FALSE. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_module_unload(Eina_Module *module) EINA_ARG_NONNULL(1); @@ -188,6 +204,10 @@ EAPI Eina_Bool * module must have been loaded before with eina_module_load(). If @p module * is @c NULL, or if it has not been correctly loaded before, the * function returns immediately @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void * eina_module_symbol_get(const Eina_Module *module, const char *symbol) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -201,6 +221,10 @@ EAPI void * * This function returns the file name passed in eina_module_new(). If * @p module is @c NULL, the function returns immediately @c NULL. The * returned value must no be freed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char * eina_module_file_get(const Eina_Module *module) EINA_PURE EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -210,6 +234,10 @@ EAPI const char * * * @param module The module to turn off/on symbol to be exposed * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) EINA_ARG_NONNULL(1); @@ -226,6 +254,10 @@ EAPI void eina_module_symbol_global_set(Eina_Module *module, Eina_Bool global) E * can be @c NULL. The returned path must be freed when not used * anymore. If the symbol is not found, or dl_addr() is not supported, * or allocation fails, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char * eina_module_symbol_path_get(const void *symbol, const char *sub_dir) EINA_PURE EINA_MALLOC EINA_ARG_NONNULL(1, 2); @@ -243,6 +275,10 @@ EAPI char * * can be @c NULL. The returned path must be freed when not used * anymore. If the symbol is not found, or @p env does not exist, or * allocation fails, this function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char * eina_module_environment_path_get(const char *env, const char *sub_dir) EINA_PURE EINA_MALLOC EINA_ARG_NONNULL(1, 2); @@ -260,6 +296,10 @@ EAPI char * * which match the cpu architecture @p arch. If @p path or @p arch is * @c NULL, the function returns immediately @p array. @p array can be * @c NULL. In that case, it is created with 4 elements. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Array * eina_module_arch_list_get(Eina_Array *array, const char *path, const char *arch); @@ -282,6 +322,10 @@ EAPI Eina_Array * * module will not be added to the list, otherwise it will be added. * @p array can be @c NULL. In that case, it is created with 4 * elements. @p cb can be @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Array * eina_module_list_get(Eina_Array *array, const char *path, Eina_Bool recursive, Eina_Module_Cb cb, void *data) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -293,6 +337,10 @@ EAPI Eina_Array * * * This function calls eina_module_load() on each element found in * @p array. If @p array is @c NULL, this function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_module_list_load(Eina_Array *array) EINA_ARG_NONNULL(1); @@ -304,6 +352,10 @@ EAPI void * * This function calls eina_module_unload() on each element found in * @p array. If @p array is @c NULL, this function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_module_list_unload(Eina_Array *array) EINA_ARG_NONNULL(1); @@ -315,6 +367,10 @@ EAPI void * * This function calls eina_module_free() on each element found in * @p array. If @p array is @c NULL, this function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_module_list_free(Eina_Array *array) EINA_ARG_NONNULL(1); @@ -329,6 +385,10 @@ EAPI void * This function finds an @p module in @p array. * If the element is found the function returns the module, else * @c NULL is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Module * eina_module_find(const Eina_Array *array, const char *module) EINA_ARG_NONNULL(1, 2); diff --git a/src/lib/eina/eina_prefix.h b/src/lib/eina/eina_prefix.h index d5b859b..b9dece9 100644 --- a/src/lib/eina/eina_prefix.h +++ b/src/lib/eina/eina_prefix.h @@ -149,6 +149,10 @@ typedef struct _Eina_Prefix Eina_Prefix; * @since 1.1.0 * * @see eina_prefix_free() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Prefix *eina_prefix_new(const char *argv0, void *symbol, const char *envprefix, const char *sharedir, const char *magicsharefile, @@ -166,6 +170,10 @@ EAPI Eina_Prefix *eina_prefix_new(const char *argv0, void *symbol, const char *e * @since 1.1.0 * * @see eina_prefix_new() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_prefix_free(Eina_Prefix *pfx) EINA_ARG_NONNULL(1); @@ -177,6 +185,10 @@ EAPI void eina_prefix_free(Eina_Prefix *pfx) EINA_ARG_NONNULL(1); * "/home/user/myapps/appname" etc.) that the software resides in at runtime * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_prefix_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; @@ -188,6 +200,10 @@ EAPI const char *eina_prefix_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN * "/usr/bin", "/opt/appname/bin", "/home/user/myapps/appname/bin" etc.) * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_prefix_bin_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; @@ -199,6 +215,10 @@ EAPI const char *eina_prefix_bin_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_ * "/usr/lib32", "/opt/appname/lib64", "/home/user/myapps/appname/lib" etc.) * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_prefix_lib_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; @@ -210,6 +230,10 @@ EAPI const char *eina_prefix_lib_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_ * "/usr/share/appname", "/opt/appname/share/appname", "/home/user/myapps/appname/share/appname" etc.) * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_prefix_data_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; @@ -221,6 +245,10 @@ EAPI const char *eina_prefix_data_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA * "/usr/share/locale", "/opt/appname/share/locale", "/home/user/myapps/appname/share/locale" etc.) * * @since 1.1.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_prefix_locale_get(Eina_Prefix *pfx) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; diff --git a/src/lib/eina/eina_quad.h b/src/lib/eina/eina_quad.h index 93c0fb0..51c5dd8 100644 --- a/src/lib/eina/eina_quad.h +++ b/src/lib/eina/eina_quad.h @@ -56,16 +56,28 @@ typedef struct _Eina_Quad /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif * */ EAPI void eina_quad_rectangle_to(const Eina_Quad *q, Eina_Rectangle *r); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif * */ EAPI void eina_quad_rectangle_from(Eina_Quad *q, const Eina_Rectangle *r); /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif * */ EAPI void eina_quad_coords_set(Eina_Quad *q, double x1, double y1, @@ -75,6 +87,10 @@ EAPI void eina_quad_coords_set(Eina_Quad *q, /** * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif * */ EAPI void eina_quad_coords_get(const Eina_Quad *q, double *x1, double *y1, diff --git a/src/lib/eina/eina_rbtree.h b/src/lib/eina/eina_rbtree.h index 6a4d764..d90d116 100644 --- a/src/lib/eina/eina_rbtree.h +++ b/src/lib/eina/eina_rbtree.h @@ -160,6 +160,10 @@ typedef void (*Eina_Rbtree_Free_Cb)(Eina_Rbtree *node, void *data); * This function insert a new node in a valid red black tree. @c NULL is * an empty valid red black tree. The resulting new tree is a valid red * black tree. This function doesn't allocate any data. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rbtree *eina_rbtree_inline_insert(Eina_Rbtree *root, Eina_Rbtree *node, Eina_Rbtree_Cmp_Node_Cb cmp, const void *data) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; @@ -175,6 +179,10 @@ EAPI Eina_Rbtree *eina_rbtree_inline_insert(Eina_Rbtree *root, Eina_Rbt * This function remove a new node in a valid red black tree that should * contain the node that you are removing. This function will return @c NULL * when the red black tree got empty. This function doesn't free any data. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rbtree *eina_rbtree_inline_remove(Eina_Rbtree *root, Eina_Rbtree *node, Eina_Rbtree_Cmp_Node_Cb cmp, const void *data) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; @@ -185,6 +193,9 @@ EAPI Eina_Rbtree *eina_rbtree_inline_remove(Eina_Rbtree *root, Eina_Rbt * @param func The callback that will free each node. * @param data Private data to help the compare function. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rbtree_delete(Eina_Rbtree *root, Eina_Rbtree_Free_Cb func, void *data) EINA_ARG_NONNULL(2); @@ -208,6 +219,10 @@ static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, co * @warning if the rbtree structure changes then the iterator becomes * invalid! That is, if you add or remove nodes this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -228,6 +243,10 @@ EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root) * @warning if the rbtree structure changes then the iterator becomes * invalid! That is, if you add or remove nodes this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -248,6 +267,10 @@ EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) E * @warning if the rbtree structure changes then the iterator becomes * invalid! That is, if you add or remove nodes this iterator * behavior is undefined and your program may crash! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_rbtree_iterator_postfix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT; diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h index 55d370f..ce76e9c 100644 --- a/src/lib/eina/eina_rectangle.h +++ b/src/lib/eina/eina_rectangle.h @@ -348,6 +348,10 @@ static inline Eina_Bool eina_rectangle_subtract(Eina_Rectangle *thiz, Eina_Rec * This function adds the rectangle of size (@p width, @p height) to a * new pool. If the pool can not be created, @c NULL is * returned. Otherwise the newly allocated pool is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -359,6 +363,10 @@ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA * * This function returns the pool in which @p rect is. If @p rect is * @c NULL, @c NULL is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -374,6 +382,10 @@ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WAR * them in respectively @p w and @p h if they are not @c NULL. If * @p pool is @c NULL, #EINA_FALSE is returned. Otherwise #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *pool, int *w, int *h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -386,6 +398,10 @@ EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool * * This function gets the data from @p pool set by * eina_rectangle_pool_data_set(). If @p pool is @c NULL, this * function returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -397,6 +413,10 @@ EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool * * This function sets @p data to @p pool. If @p pool is @c NULL, this * function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool, const void *data) EINA_ARG_NONNULL(1); @@ -407,6 +427,10 @@ EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool * * This function frees the allocated data of @p pool. If @p pool is * @c NULL, this function returned immediately. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1); @@ -417,6 +441,10 @@ EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EI * @return The number of rectangles in the pool. * * This function returns the number of rectangles in @p pool. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -434,6 +462,10 @@ EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) E * pool size, the function returns @c NULL. On success, the function * returns the rectangle which matches the size (@p w, @p h). * Otherwise it returns @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool, int w, int h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -445,6 +477,10 @@ EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool, * This function removes @p rect from the pool. If @p rect is * @c NULL, the function returns immediately. Otherwise it removes @p * rect from the pool. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA_ARG_NONNULL(1); @@ -484,6 +520,10 @@ EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA * coordinates (@p x, @p y), with height @p w and height @p h and adds * it to the rectangles pool. No check is done on @p w and @p h. This * function returns a new rectangle on success, @c NULL otherwhise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -493,6 +533,10 @@ EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC * @param rect The rectangle to free. * * This function removes @p rect from the rectangles pool. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(1); @@ -504,6 +548,10 @@ EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL( * This function sets @p type of @p pool. * @see Eina_Rectangle_Packing * @since 1.11 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,Eina_Rectangle_Packing type) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_sched.h b/src/lib/eina/eina_sched.h index 13f35a4..fe845b1 100644 --- a/src/lib/eina/eina_sched.h +++ b/src/lib/eina/eina_sched.h @@ -43,6 +43,10 @@ * set the nice level on the current thread. In Linux, it does work and it's the * only one that is implemented as of now. In this case, the nice level is * incremented on this thread by @c NICENESS. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_sched_prio_drop(void); diff --git a/src/lib/eina/eina_simple_xml_parser.h b/src/lib/eina/eina_simple_xml_parser.h index 88b1cac..c723fd1 100644 --- a/src/lib/eina/eina_simple_xml_parser.h +++ b/src/lib/eina/eina_simple_xml_parser.h @@ -238,6 +238,10 @@ typedef Eina_Bool (*Eina_Simple_XML_Attribute_Cb)(void *data, const char *key, c * * @return #EINA_TRUE on success or #EINA_FALSE if it was aborted by user or * parsing error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_simple_xml_parse(const char *buf, unsigned buflen, Eina_Bool strip, @@ -256,6 +260,9 @@ EAPI Eina_Bool eina_simple_xml_parse(const char *buf, unsigned buflen, * The tag contents is returned by eina_simple_xml_parse() when * type is #EINA_SIMPLE_XML_OPEN or #EINA_SIMPLE_XML_OPEN_EMPTY. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char * eina_simple_xml_tag_attributes_find(const char *buf, unsigned buflen); @@ -273,6 +280,10 @@ EAPI const char * eina_simple_xml_tag_attributes_find(const char *buf, unsigned * * @return #EINA_TRUE on success or #EINA_FALSE if it was aborted by user or * parsing error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_simple_xml_attributes_parse(const char *buf, unsigned buflen, Eina_Simple_XML_Attribute_Cb func, const void *data); @@ -292,6 +303,10 @@ EAPI Eina_Bool eina_simple_xml_attributes_parse(const char *buf, unsigned buflen * parsing error. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_simple_xml_attribute_w3c_parse(const char *buf, Eina_Simple_XML_Attribute_Cb func, const void *data); @@ -307,6 +322,10 @@ eina_simple_xml_attribute_w3c_parse(const char *buf, Eina_Simple_XML_Attribute_C * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_attribute_free() or indirectly * with eina_simple_xml_node_tag_free(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Attribute * eina_simple_xml_attribute_new(Eina_Simple_XML_Node_Tag *parent, const char *key, const char *value); @@ -314,6 +333,10 @@ EAPI Eina_Simple_XML_Attribute * eina_simple_xml_attribute_new(Eina_Simple_XML_N * Remove attribute from parent and delete it. * * @param attr attribute to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_attribute_free(Eina_Simple_XML_Attribute *attr); @@ -328,6 +351,10 @@ EAPI void eina_simple_xml_attribute_free(Eina_Simple_XML_Attribute *attr); * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_node_tag_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Tag * eina_simple_xml_node_tag_new(Eina_Simple_XML_Node_Tag *parent, const char *name); @@ -335,6 +362,10 @@ EAPI Eina_Simple_XML_Node_Tag * eina_simple_xml_node_tag_new(Eina_Simple_XML_Nod * Remove tag from parent and delete it. * * @param tag to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_tag_free(Eina_Simple_XML_Node_Tag *tag); @@ -350,6 +381,10 @@ EAPI void eina_simple_xml_node_tag_free(Eina_Simple_XML_Node_Tag *tag); * @return Newly allocated memory or NULL on error. This memory should be * released with eina_simple_xml_node_data_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Data * eina_simple_xml_node_data_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -357,6 +392,10 @@ EAPI Eina_Simple_XML_Node_Data * eina_simple_xml_node_data_new(Eina_Simple_XML_N * Remove data from parent and delete it. * * @param node to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_data_free(Eina_Simple_XML_Node_Data *node); @@ -372,6 +411,10 @@ EAPI void eina_simple_xml_node_data_free(Eina_Simple_XML_Node_Data *node); * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_node_cdata_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_CData * eina_simple_xml_node_cdata_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -379,6 +422,10 @@ EAPI Eina_Simple_XML_Node_CData * eina_simple_xml_node_cdata_new(Eina_Simple_XML * Remove cdata from parent and delete it. * * @param node to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_cdata_free(Eina_Simple_XML_Node_Data *node); @@ -396,6 +443,10 @@ EAPI void eina_simple_xml_node_cdata_free(Eina_Simple_XML_Node_Data *node); * with eina_simple_xml_node_tag_free() of the parent. * * @since 1.8 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Doctype_Child * eina_simple_xml_node_doctype_child_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -405,6 +456,10 @@ EAPI Eina_Simple_XML_Node_Doctype_Child * eina_simple_xml_node_doctype_child_new * @param node to release memory. * * @since 1.8 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_doctype_child_free(Eina_Simple_XML_Node_Data *node); @@ -420,6 +475,10 @@ EAPI void eina_simple_xml_node_doctype_child_free(Eina_Simple_XML_Node_Data *nod * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_node_processing_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Processing * eina_simple_xml_node_processing_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -427,6 +486,10 @@ EAPI Eina_Simple_XML_Node_Processing * eina_simple_xml_node_processing_new(Eina_ * Remove processing from parent and delete it. * * @param node processing to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_processing_free(Eina_Simple_XML_Node_Data *node); @@ -442,6 +505,10 @@ EAPI void eina_simple_xml_node_processing_free(Eina_Simple_XML_Node_Data *node); * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_node_doctype_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Doctype * eina_simple_xml_node_doctype_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -449,6 +516,10 @@ EAPI Eina_Simple_XML_Node_Doctype * eina_simple_xml_node_doctype_new(Eina_Simple * Remove doctype from parent and delete it. * * @param node doctype to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_doctype_free(Eina_Simple_XML_Node_Data *node); @@ -464,6 +535,10 @@ EAPI void eina_simple_xml_node_doctype_free(Eina_Simple_XML_Node_Data *node); * @return Newly allocated memory or @c NULL on error. This memory should be * released with eina_simple_xml_node_comment_free() or indirectly * with eina_simple_xml_node_tag_free() of the parent. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Comment * eina_simple_xml_node_comment_new(Eina_Simple_XML_Node_Tag *parent, const char *contents, size_t length); @@ -471,6 +546,10 @@ EAPI Eina_Simple_XML_Node_Comment * eina_simple_xml_node_comment_new(Eina_Simple * Remove comment from parent and delete it. * * @param node comment to release memory. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_comment_free(Eina_Simple_XML_Node_Data *node); @@ -486,6 +565,10 @@ EAPI void eina_simple_xml_node_comment_free(Eina_Simple_XML_Node_Data *node); * @return Document root with children tags, or @c NULL on errors. * Document with errors may return partial tree instead of @c NULL, * we'll do our best to avoid returning nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Simple_XML_Node_Root * eina_simple_xml_node_load(const char *buf, unsigned buflen, Eina_Bool strip); @@ -493,6 +576,10 @@ EAPI Eina_Simple_XML_Node_Root * eina_simple_xml_node_load(const char *buf, unsi * Free node tree build with eina_simple_xml_node_load() * * @param root memory returned by eina_simple_xml_node_load() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_simple_xml_node_root_free(Eina_Simple_XML_Node_Root *root); @@ -503,6 +590,10 @@ EAPI void eina_simple_xml_node_root_free(Eina_Simple_XML_Node_Root *root); * @param indent Indentation string, or @c NULL to disable it. * * @return @c NULL on errors or a newly allocated string on success. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char * eina_simple_xml_node_dump(Eina_Simple_XML_Node *node, const char *indent); diff --git a/src/lib/eina/eina_str.h b/src/lib/eina/eina_str.h index 100cc81..78aa1f7 100644 --- a/src/lib/eina/eina_str.h +++ b/src/lib/eina/eina_str.h @@ -99,6 +99,10 @@ * @note The main difference between eina_strlcpy and strncpy is that this * ensures @p dst is NULL-terminated even if no @c NULL byte is found in the first * @p siz bytes of src. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_strlcpy(char *dst, const char *src, size_t siz) EINA_ARG_NONNULL(1, 2); @@ -116,6 +120,10 @@ EAPI size_t eina_strlcpy(char *dst, const char *src, size_t siz) EINA_A * (unless @p siz <= strlen(dst)). This function returns strlen(src) + * MIN(siz, strlen(initial dst)). If the returned value is greater or * equal than @p siz, truncation occurred. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_strlcat(char *dst, const char *src, size_t siz) EINA_ARG_NONNULL(1, 2); @@ -130,6 +138,10 @@ EAPI size_t eina_strlcat(char *dst, const char *src, size_t siz) EINA_A * This function returns #EINA_TRUE if @p str has the prefix * @p prefix, #EINA_FALSE otherwise. If the length of @p prefix is * greater than @p str, #EINA_FALSE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_str_has_prefix(const char *str, const char *prefix) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -143,6 +155,10 @@ EAPI Eina_Bool eina_str_has_prefix(const char *str, const char *prefix) EI * This function returns #EINA_TRUE if @p str has the suffix * @p suffix, #EINA_FALSE otherwise. If the length of @p suffix is * greater than @p str, #EINA_FALSE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_str_has_suffix(const char *str, const char *suffix) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -155,6 +171,10 @@ EAPI Eina_Bool eina_str_has_suffix(const char *str, const char *suffix) EI * * This function does the same as eina_str_has_suffix(), except it's case * insensitive. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_str_has_extension(const char *str, const char *ext) EINA_PURE EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -181,6 +201,10 @@ EAPI Eina_Bool eina_str_has_extension(const char *str, const char *ext) EI * * @note If you need the number of elements in the returned array see * eina_str_split_full(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char **eina_str_split(const char *string, const char *delimiter, int max_tokens) EINA_ARG_NONNULL(1, 2) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -214,6 +238,10 @@ EAPI char **eina_str_split(const char *string, const char *delimiter, i * will be 6, but the size of the array (including the @c NULL element) will actually be 7. * * @see eina_str_split() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char **eina_str_split_full(const char *string, const char *delimiter, int max_tokens, unsigned int *elements) EINA_ARG_NONNULL(1, 2, 4) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -243,6 +271,10 @@ EAPI char **eina_str_split_full(const char *string, const char *delimit * * @see eina_str_join() * @see eina_str_join_static() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_str_join_len(char *dst, size_t size, char sep, const char *a, size_t a_len, const char *b, size_t b_len) EINA_ARG_NONNULL(1, 4, 6); @@ -263,6 +295,10 @@ EAPI size_t eina_str_join_len(char *dst, size_t size, char sep, const c * * @warning This function is guaranteed to break when '\0' characters are in @p text. * DO NOT USE THIS FUNCTION IF YOUR TEXT CONTAINS NON-TERMINATING '\0' CHARACTERS. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *eina_str_convert(const char *enc_from, const char *enc_to, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(1, 2, 3); @@ -283,6 +319,10 @@ EAPI char *eina_str_convert(const char *enc_from, const char *enc_to, * the returned value must be freed. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char *eina_str_convert_len(const char *enc_from, const char *enc_to, const char *text, size_t len, size_t *retlen) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(1, 2, 3); @@ -298,6 +338,10 @@ EAPI char *eina_str_convert_len(const char *enc_from, const char *enc_ * function returns a newly allocated escaped string on success, @c NULL on * failure. When not used anymore, the * returned value must be freed. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *eina_str_escape(const char *str) EINA_WARN_UNUSED_RESULT EINA_MALLOC EINA_ARG_NONNULL(1); @@ -310,6 +354,10 @@ EAPI char *eina_str_escape(const char *str) EINA_WARN_UNUSED_RESULT EI * This function modifies the original string, changing all characters * in [A-Z] to lowercase. If @p str is @c NULL or is an empty string, * this function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_str_tolower(char **str); @@ -321,6 +369,10 @@ EAPI void eina_str_tolower(char **str); * This function modifies the original string, changing all characters * in [a-z] to uppercase. If @p str is @c NULL or is an empty string, * this function does nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_str_toupper(char **str); @@ -353,6 +405,10 @@ static inline size_t eina_strlen_bounded(const char *str, size_t maxlen) EINA_PU * @param terminate If true, the returned memory will be nul terminated with '\0' * @return the copied memory, must be freed * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI unsigned char *eina_memdup(unsigned char *mem, size_t size, Eina_Bool terminate); #include "eina_inline_str.x" diff --git a/src/lib/eina/eina_strbuf.h b/src/lib/eina/eina_strbuf.h index fd0a3c1..b419b3e 100644 --- a/src/lib/eina/eina_strbuf.h +++ b/src/lib/eina/eina_strbuf.h @@ -75,6 +75,10 @@ typedef struct _Eina_Strbuf Eina_Strbuf; * @see eina_strbuf_free() * @see eina_strbuf_append() * @see eina_strbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -93,6 +97,10 @@ EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; * @see eina_strbuf_append() * @see eina_strbuf_string_get() * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Strbuf *eina_strbuf_manage_new(char *str) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -110,6 +118,10 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new(char *str) EINA_MALLOC EINA_WARN_UNUSED * * @see eina_strbuf_manage_new() * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -127,6 +139,10 @@ EAPI Eina_Strbuf *eina_strbuf_manage_new_length(char *str, size_t length) EINA_M * * @see eina_strbuf_manage_new() * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Strbuf *eina_strbuf_manage_read_only_new_length(const char *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -137,6 +153,10 @@ EAPI Eina_Strbuf *eina_strbuf_manage_read_only_new_length(const char *str, size_ * * This function frees the memory of @p buf. @p buf must have been * created by eina_strbuf_new(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -147,6 +167,10 @@ EAPI void eina_strbuf_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * * This function reset @p buf: the buffer len is set to 0, and the * string is set to '\\0'. No memory is free'd. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_reset(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -165,6 +189,10 @@ EAPI void eina_strbuf_reset(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * * @see eina_strbuf_append() * @see eina_strbuf_append_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append(Eina_Strbuf *buf, const char *str) EINA_ARG_NONNULL(1, 2); @@ -178,6 +206,10 @@ EAPI Eina_Bool eina_strbuf_append(Eina_Strbuf *buf, const char *str) EINA_ARG_NO * This function escapes and then appends the string @p str to @p buf. If @p str * can not be appended, #EINA_FALSE is returned, otherwise, #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_escaped(Eina_Strbuf *buf, const char *str) EINA_ARG_NONNULL(1, 2); @@ -201,6 +233,10 @@ EAPI Eina_Bool eina_strbuf_append_escaped(Eina_Strbuf *buf, const char *str) EIN * * @see eina_strbuf_append() * @see eina_strbuf_append_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_n(Eina_Strbuf *buf, const char *str, size_t maxlen) EINA_ARG_NONNULL(1, 2); @@ -222,6 +258,10 @@ EAPI Eina_Bool eina_strbuf_append_n(Eina_Strbuf *buf, const char *str, size_t ma * @see eina_stringshare_length() * @see eina_strbuf_append() * @see eina_strbuf_append_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_length(Eina_Strbuf *buf, const char *str, size_t length) EINA_ARG_NONNULL(1, 2); @@ -241,6 +281,10 @@ EAPI Eina_Bool eina_strbuf_append_length(Eina_Strbuf *buf, const char *str, size * @see eina_strbuf_append_n() * @see eina_strbuf_append_length() * @since 1.9.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_strbuf_append_buffer(Eina_Strbuf *buf, const Eina_Strbuf *data) EINA_ARG_NONNULL(1, 2); @@ -254,6 +298,10 @@ EAPI Eina_Bool eina_strbuf_append_buffer(Eina_Strbuf *buf, const Eina_Strbuf *da * * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNULL(1); @@ -269,6 +317,10 @@ EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNUL * insert it, #EINA_FALSE is returned, otherwise #EINA_TRUE is returned. * * @see eina_strbuf_append() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_printf(Eina_Strbuf *buf, const char *fmt, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 3); @@ -281,6 +333,10 @@ EAPI Eina_Bool eina_strbuf_append_printf(Eina_Strbuf *buf, const char *fmt, ...) * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @see eina_strbuf_append_printf() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_append_vprintf(Eina_Strbuf *buf, const char *fmt, va_list args) EINA_ARG_NONNULL(1, 2); @@ -297,6 +353,10 @@ EAPI Eina_Bool eina_strbuf_append_vprintf(Eina_Strbuf *buf, const char *fmt, va_ * eina_strbuf_insert_length(). If the length is known beforehand, * consider using that variant. If @p buf can't insert it, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert(Eina_Strbuf *buf, const char *str, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -312,6 +372,10 @@ EAPI Eina_Bool eina_strbuf_insert(Eina_Strbuf *buf, const char *str, size_t pos) * This function escapes and inserts the string @p str to @p buf at * position @p pos. If @p buf can't insert @p str, #EINA_FALSE is * returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_escaped(Eina_Strbuf *buf, const char *str, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -332,6 +396,10 @@ EAPI Eina_Bool eina_strbuf_insert_escaped(Eina_Strbuf *buf, const char *str, siz * should then be checked so that it is greater than the size of * @p str). If @p str can not be inserted, #EINA_FALSE is returned, * otherwise, #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_n(Eina_Strbuf *buf, const char *str, size_t maxlen, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -354,6 +422,10 @@ EAPI Eina_Bool eina_strbuf_insert_n(Eina_Strbuf *buf, const char *str, size_t ma * @see eina_stringshare_length() * @see eina_strbuf_insert() * @see eina_strbuf_insert_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_length(Eina_Strbuf *buf, const char *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -369,6 +441,10 @@ EAPI Eina_Bool eina_strbuf_insert_length(Eina_Strbuf *buf, const char *str, size * This function inserts @p c to @p buf at position @p pos. If @p buf * can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EINA_ARG_NONNULL(1); @@ -384,6 +460,10 @@ EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EIN * the position @p pos. @p fmt must be of a valid format for printf family of * functions. If it can't insert it, #EINA_FALSE is returned, * otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size_t pos, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 4); @@ -397,6 +477,10 @@ EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @see eina_strbuf_insert_printf + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, size_t pos, va_list args) EINA_ARG_NONNULL(1, 2); @@ -514,6 +598,10 @@ EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, siz * This function removes a slice of @p buf, starting at @p start * (inclusive) and ending at @p end (non-inclusive). Both values are * in bytes. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_remove(Eina_Strbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1); @@ -531,6 +619,10 @@ EAPI Eina_Bool eina_strbuf_remove(Eina_Strbuf *buf, size_t start, size_t end) EI * not be freed. * * @see eina_strbuf_string_steal() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *eina_strbuf_string_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -546,6 +638,10 @@ EAPI const char *eina_strbuf_string_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL * free(). * * @see eina_strbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *eina_strbuf_string_steal(Eina_Strbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -556,6 +652,10 @@ EAPI char *eina_strbuf_string_steal(Eina_Strbuf *buf) EINA_MALLOC EINA_WARN_UNUS * * This function frees the string contained in @p buf without freeing * @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_string_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -566,6 +666,10 @@ EAPI void eina_strbuf_string_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * @return The current length of the string, in bytes. * * This function returns the length of @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_strbuf_length_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -581,6 +685,10 @@ EAPI size_t eina_strbuf_length_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1 * * This function replaces the n-th occurrence of @p str in @p buf with * @p with. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char *with, unsigned int n) EINA_ARG_NONNULL(1, 2, 3); @@ -611,6 +719,10 @@ EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char * This function replaces all the occurrences of @p str in @p buf with * the string @p with. This function returns the number of times @p str * has been replaced. On failure, it returns @c 0. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char *with) EINA_ARG_NONNULL(1, 2, 3); @@ -620,6 +732,10 @@ EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char * * @param buf the string buffer to work with. * * This function skips whitespaces in the beginning and the end of the buffer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -629,6 +745,10 @@ EAPI void eina_strbuf_trim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * @param buf the string buffer to work with. * * This function skips whitespaces in the beginning of the buffer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_ltrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -638,6 +758,10 @@ EAPI void eina_strbuf_ltrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * @param buf the string buffer to work with. * * This function skips whitespaces in the end of the buffer. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_strbuf_rtrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); @@ -649,6 +773,10 @@ EAPI void eina_strbuf_rtrim(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); * @param buf the string buffer to work with. * * This function converts all the characters in the strbuf to lower case. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_strbuf_tolower(Eina_Strbuf *buf) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_stringshare.h b/src/lib/eina/eina_stringshare.h index 080e951..1521091 100644 --- a/src/lib/eina/eina_stringshare.h +++ b/src/lib/eina/eina_stringshare.h @@ -192,6 +192,10 @@ typedef const char Eina_Stringshare; * buffer or substring. * * @see eina_share_common_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_add_length(const char *str, unsigned int slen) EINA_WARN_UNUSED_RESULT; @@ -212,6 +216,10 @@ EAPI Eina_Stringshare *eina_stringshare_add_length(const char *str, unsigned in * terminated, use eina_stringshare_add_length() instead. * * @see eina_stringshare_add_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_add(const char *str) EINA_WARN_UNUSED_RESULT; @@ -233,6 +241,10 @@ EAPI Eina_Stringshare *eina_stringshare_add(const char *str) EINA_WARN_UNUSED_R * terminated, use eina_stringshare_nprintf() instead. * * @see eina_stringshare_nprintf() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_printf(const char *fmt, ...) EINA_WARN_UNUSED_RESULT EINA_PRINTF(1, 2); @@ -255,6 +267,10 @@ EAPI Eina_Stringshare *eina_stringshare_printf(const char *fmt, ...) EINA_WARN_ * terminated, use eina_stringshare_nprintf() instead. * * @see eina_stringshare_nprintf() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_vprintf(const char *fmt, va_list args) EINA_WARN_UNUSED_RESULT; @@ -275,6 +291,10 @@ EAPI Eina_Stringshare *eina_stringshare_vprintf(const char *fmt, va_list args) * entire format string, use eina_stringshare_printf() instead. * * @see eina_stringshare_printf() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_nprintf(unsigned int len, const char *fmt, ...) EINA_WARN_UNUSED_RESULT EINA_PRINTF(2, 3); @@ -291,6 +311,10 @@ EAPI Eina_Stringshare *eina_stringshare_nprintf(unsigned int len, const char *f * call to one of the stringshare functions. * * There is no unref since this is the work of eina_share_common_del(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Stringshare *eina_stringshare_ref(Eina_Stringshare *str); @@ -306,6 +330,10 @@ EAPI Eina_Stringshare *eina_stringshare_ref(Eina_Stringshare *str); * * @note If the given pointer is not shared, bad things will happen, likely a * segmentation fault. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_stringshare_del(Eina_Stringshare *str); @@ -321,6 +349,10 @@ EAPI void eina_stringshare_del(Eina_Stringshare *str); * * @note If the given pointer is not shared, bad things will happen, likely a * segmentation fault. If in doubt, try strlen(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_stringshare_strlen(Eina_Stringshare *str) EINA_PURE EINA_WARN_UNUSED_RESULT; @@ -329,6 +361,10 @@ EAPI int eina_stringshare_strlen(Eina_Stringshare *str) EINA_PURE * * This function dumps all strings in the share_common to stdout with a * DDD: prefix per line and a memory usage summary. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_stringshare_dump(void); diff --git a/src/lib/eina/eina_thread.h b/src/lib/eina/eina_thread.h index 6a2c26d..dc052b5 100644 --- a/src/lib/eina/eina_thread.h +++ b/src/lib/eina/eina_thread.h @@ -72,6 +72,10 @@ typedef enum _Eina_Thread_Priority * Return identifier of the current thread. * @return identifier of current thread. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Thread eina_thread_self(void) EINA_WARN_UNUSED_RESULT; @@ -81,6 +85,10 @@ EAPI Eina_Thread eina_thread_self(void) EINA_WARN_UNUSED_RESULT; * @param t2 second thread identifier to compare. * @return #EINA_TRUE if they are equal, #EINA_FALSE otherwise. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_thread_equal(Eina_Thread t1, Eina_Thread t2) EINA_WARN_UNUSED_RESULT; @@ -94,6 +102,10 @@ EAPI Eina_Bool eina_thread_equal(Eina_Thread t1, Eina_Thread t2) EINA_WARN_UNUSE * @param data context data to provide to @a func as first argument. * @return #EINA_TRUE if thread was created, #EINA_FALSE on errors. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_thread_create(Eina_Thread *t, Eina_Thread_Priority prio, int affinity, @@ -111,6 +123,10 @@ EAPI Eina_Bool eina_thread_create(Eina_Thread *t, * @return value returned by @a t creation function @c func() or * @c NULL on errors. Check error with @ref Eina_Error_Group. * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_thread_join(Eina_Thread t); @@ -128,6 +144,10 @@ EAPI void *eina_thread_join(Eina_Thread t); * @return EINA_TRUE if it succeeds in setting the name or EINA_FALSE * otherwise. * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_thread_name_set(Eina_Thread t, const char *name); diff --git a/src/lib/eina/eina_thread_queue.h b/src/lib/eina/eina_thread_queue.h index a33e7b4..30c0142 100644 --- a/src/lib/eina/eina_thread_queue.h +++ b/src/lib/eina/eina_thread_queue.h @@ -71,6 +71,10 @@ struct _Eina_Thread_Queue_Msg_Sub * @return A valid new thread queue, or NULL on failure * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Thread_Queue * eina_thread_queue_new(void); @@ -85,6 +89,10 @@ eina_thread_queue_new(void); * @param thq The thread queue to free * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_thread_queue_free(Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); @@ -104,6 +112,10 @@ eina_thread_queue_free(Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); * have this structure as the first member (first N bytes) of the message. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eina_thread_queue_send(Eina_Thread_Queue *thq, int size, void **allocref) EINA_ARG_NONNULL(1, 3); @@ -118,6 +130,10 @@ eina_thread_queue_send(Eina_Thread_Queue *thq, int size, void **allocref) EINA_A * listeners. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_thread_queue_send_done(Eina_Thread_Queue *thq, void *allocref) EINA_ARG_NONNULL(1, 2); @@ -138,6 +154,10 @@ eina_thread_queue_send_done(Eina_Thread_Queue *thq, void *allocref) EINA_ARG_NON * they are done. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eina_thread_queue_wait(Eina_Thread_Queue *thq, void **allocref) EINA_ARG_NONNULL(1, 2); @@ -152,6 +172,10 @@ eina_thread_queue_wait(Eina_Thread_Queue *thq, void **allocref) EINA_ARG_NONNULL * eina_thread_queue_poll() to indicate the caller is done with the message. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_thread_queue_wait_done(Eina_Thread_Queue *thq, void *allocref) EINA_ARG_NONNULL(1, 2); @@ -170,6 +194,10 @@ eina_thread_queue_wait_done(Eina_Thread_Queue *thq, void *allocref) EINA_ARG_NON * @see eina_thread_queue_wait() * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void * eina_thread_queue_poll(Eina_Thread_Queue *thq, void **allocref) EINA_ARG_NONNULL(1, 2); @@ -184,6 +212,10 @@ eina_thread_queue_poll(Eina_Thread_Queue *thq, void **allocref) EINA_ARG_NONNULL * eina_thread_queue_wait() or eina_thread_queue_poll(). * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_thread_queue_pending_get(const Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); @@ -201,6 +233,10 @@ eina_thread_queue_pending_get(const Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); * a parent, just set the parent to NULL. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_thread_queue_parent_set(Eina_Thread_Queue *thq, Eina_Thread_Queue *thq_parent) EINA_ARG_NONNULL(1); @@ -217,6 +253,10 @@ eina_thread_queue_parent_set(Eina_Thread_Queue *thq, Eina_Thread_Queue *thq_pare * @see eina_thread_queue_parent_set() * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Thread_Queue * eina_thread_queue_parent_get(const Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); @@ -237,6 +277,10 @@ eina_thread_queue_parent_get(const Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); * thread queue. * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_thread_queue_fd_set(Eina_Thread_Queue *thq, int fd) EINA_ARG_NONNULL(1); @@ -253,6 +297,10 @@ eina_thread_queue_fd_set(Eina_Thread_Queue *thq, int fd) EINA_ARG_NONNULL(1); * @see eina_thread_queue_fd_set() * * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eina_thread_queue_fd_get(const Eina_Thread_Queue *thq) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_tiler.h b/src/lib/eina/eina_tiler.h index 8006cca..e5e6296 100644 --- a/src/lib/eina/eina_tiler.h +++ b/src/lib/eina/eina_tiler.h @@ -182,6 +182,10 @@ typedef struct _Eina_Tile_Grid_Slicer Eina_Tile_Grid_Slicer; * @return The newly created tiler * * @see eina_tiler_free() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Tiler *eina_tiler_new(int w, int h); /** @@ -191,6 +195,10 @@ EAPI Eina_Tiler *eina_tiler_new(int w, int h); * * This function frees @p t. It does not free the memory allocated for the * elements of @p t. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_tiler_free(Eina_Tiler *t); /** @@ -203,6 +211,10 @@ EAPI void eina_tiler_free(Eina_Tiler *t); * @warning @p w and @p h @b must be greater than zero, otherwise tile size * won't be changed. * @warning Tile size is not used! + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_tiler_tile_size_set(Eina_Tiler *t, int w, int h); @@ -216,6 +228,10 @@ EAPI void eina_tiler_tile_size_set(Eina_Tiler *t, int w, int h); * @since 1.8 * * @warning Must clear the tiler before changing its size. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_tiler_area_size_set(Eina_Tiler *t, int w, int h); @@ -227,6 +243,10 @@ EAPI void eina_tiler_area_size_set(Eina_Tiler *t, int w, int h); * @param h Height of the area. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_tiler_area_size_get(const Eina_Tiler *t, int *w, int *h); @@ -239,6 +259,10 @@ EAPI void eina_tiler_area_size_get(const Eina_Tiler *t, int *w, in * By default it will be loosy. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_tiler_strict_set(Eina_Tiler *t, Eina_Bool strict); @@ -249,6 +273,10 @@ EAPI void eina_tiler_strict_set(Eina_Tiler *t, Eina_Bool strict); * @return EINA_TRUE when empty, EINA_FALSE when not. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_tiler_empty(Eina_Tiler *t); @@ -260,6 +288,10 @@ EAPI Eina_Bool eina_tiler_empty(Eina_Tiler *t); * @return #EINA_TRUE on success, #EINA_FALSE on failure. * * @see eina_tiler_rect_del() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_tiler_rect_add(Eina_Tiler *t, const Eina_Rectangle *r); /** @@ -270,6 +302,10 @@ EAPI Eina_Bool eina_tiler_rect_add(Eina_Tiler *t, const Eina_Rectangle * * @see eina_tiler_rect_add() * @see eina_tiler_clear() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_tiler_rect_del(Eina_Tiler *t, const Eina_Rectangle *r); /** @@ -278,6 +314,10 @@ EAPI void eina_tiler_rect_del(Eina_Tiler *t, const Eina_Rectangle * @param t The tiler to clear. * * @see eina_tiler_rect_del() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_tiler_clear(Eina_Tiler *t); /** @@ -285,6 +325,10 @@ EAPI void eina_tiler_clear(Eina_Tiler *t); * * @param t The tiler to iterate over. * @return A iterator containing Eina_Rectangle. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_tiler_iterator_new(const Eina_Tiler *t); @@ -306,6 +350,10 @@ EAPI Eina_Iterator *eina_tiler_iterator_new(const Eina_Tiler *t); * @note This is a convenience function, iterating over the returned iterator is * equivalent to calling eina_tile_grid_slicer_setup() and calling * eina_tile_grid_slicer_next() untill it returns #EINA_FALSE. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_tile_grid_slicer_iterator_new(int x, int y, int w, int h, int tile_w, int tile_h); @@ -319,6 +367,10 @@ EAPI Eina_Iterator *eina_tile_grid_slicer_iterator_new(int x, int y, int w, * This fuction get the union of tilers @p dst and @p src. * The result is stored in @p dst. It returns #EINA_TRUE if it succeeds. * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_tiler_union(Eina_Tiler *dst, Eina_Tiler *src); @@ -332,6 +384,10 @@ EAPI Eina_Bool eina_tiler_union(Eina_Tiler *dst, Eina_Tiler *src); * This fuction subtracts two tilers @p dst and @p src. * The result is stored in @p dst. It returns #EINA_TRUE if it succeeds. * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_tiler_subtract(Eina_Tiler *dst, Eina_Tiler *src); @@ -345,6 +401,10 @@ EAPI Eina_Bool eina_tiler_subtract(Eina_Tiler *dst, Eina_Tiler *src); * This fuction gest intersection of two tilers @p t1 and @p t2. * It returns a pointer of result if intersection of two tilers exists., otherwise returns NULL. * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Tiler *eina_tiler_intersection(Eina_Tiler *t1, Eina_Tiler *t2); @@ -358,6 +418,10 @@ EAPI Eina_Tiler *eina_tiler_intersection(Eina_Tiler *t1, Eina_Tiler *t2); * This fuction gets result of comparison for @p t1 and @p t2. * It returns #EINA_TRUE if tilers are equal. * @since 1.11 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_tiler_equal(Eina_Tiler *t1, Eina_Tiler *t2); diff --git a/src/lib/eina/eina_tmpstr.h b/src/lib/eina/eina_tmpstr.h index e516cfd..5ed5c11 100644 --- a/src/lib/eina/eina_tmpstr.h +++ b/src/lib/eina/eina_tmpstr.h @@ -161,6 +161,10 @@ typedef const char Eina_Tmpstr; * @see eina_tmpstr_add_length() * * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Tmpstr *eina_tmpstr_add(const char *str) EINA_WARN_UNUSED_RESULT; @@ -194,6 +198,10 @@ EAPI Eina_Tmpstr *eina_tmpstr_add(const char *str) EINA_WARN_UNUSED_RESULT; * @see eina_tmpstr_add() * * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Tmpstr *eina_tmpstr_add_length(const char *str, size_t length); @@ -207,6 +215,10 @@ EAPI Eina_Tmpstr *eina_tmpstr_add_length(const char *str, size_t length); * @deprecated * @see eina_tmpstr_len() * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI size_t eina_tmpstr_strlen(Eina_Tmpstr *tmpstr); @@ -218,6 +230,10 @@ EINA_DEPRECATED EAPI size_t eina_tmpstr_strlen(Eina_Tmpstr *tmpstr); * @return The length of the string. * * @since 1.14.0 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI size_t eina_tmpstr_len(Eina_Tmpstr *tmpstr); @@ -234,6 +250,10 @@ EAPI size_t eina_tmpstr_len(Eina_Tmpstr *tmpstr); * @see eina_tmpstr_add() * * @since 1.8.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_tmpstr_del(Eina_Tmpstr *tmpstr) EINA_ARG_NONNULL(1); diff --git a/src/lib/eina/eina_unicode.h b/src/lib/eina/eina_unicode.h index 7774a52..233aefc 100644 --- a/src/lib/eina/eina_unicode.h +++ b/src/lib/eina/eina_unicode.h @@ -35,6 +35,10 @@ typedef uint32_t Eina_Unicode; /** * @brief Same as the standard strlen just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Unicode *EINA_UNICODE_EMPTY_STRING; @@ -50,12 +54,20 @@ EAPI size_t eina_unicode_strlen(const Eina_Unicode *ustr) EINA_ARG_NONNUL * @param ustr String to search * @param n Max length to search * @return Number of characters or n. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_unicode_strnlen(const Eina_Unicode *ustr, int n) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; /** * @brief Same as the standard strdup just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -72,30 +84,50 @@ EAPI Eina_Unicode *eina_unicode_strdup(const Eina_Unicode *text) EINA_WARN_UNUSE * text. When not needed anymore, the returned string must be freed. * * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_strndup(const Eina_Unicode *text, size_t n) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; /** * @brief Same as the standard strcmp just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_unicode_strcmp(const Eina_Unicode *a, const Eina_Unicode *b) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; /** * @brief Same as the standard strcpy just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_strcpy(Eina_Unicode *dest, const Eina_Unicode *source) EINA_ARG_NONNULL(1, 2); /** * @brief Same as the standard strstr just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_strstr(const Eina_Unicode *haystack, const Eina_Unicode *needle) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_PURE; /** * @brief Same as the standard strncpy just with Eina_Unicode instead of char. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode *source, size_t n) EINA_ARG_NONNULL(1, 2); @@ -105,6 +137,10 @@ EAPI Eina_Unicode *eina_unicode_strncpy(Eina_Unicode *dest, const Eina_Unicode * * * @param str The string to escape. * @return The escaped string. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_escape(const Eina_Unicode *str) EINA_ARG_NONNULL(1) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -139,6 +175,10 @@ static inline Eina_Unicode eina_unicode_utf8_next_get(const char *buf, int *iind * @param iindex the index to look at and return by. * @return the codepoint found, 0 if @p buf or @p iindex are NULL * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode eina_unicode_utf8_get_next(const char *buf, int *iindex) EINA_ARG_NONNULL(1, 2) EINA_DEPRECATED; @@ -154,6 +194,10 @@ EAPI Eina_Unicode eina_unicode_utf8_get_next(const char *buf, int *iindex) EINA_ * @param iindex the index to look at and return by. * @return the codepoint found. * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode eina_unicode_utf8_get_prev(const char *buf, int *iindex) EINA_ARG_NONNULL(1, 2); @@ -165,6 +209,10 @@ EAPI Eina_Unicode eina_unicode_utf8_get_prev(const char *buf, int *iindex) EINA_ * @param buf the string * @return the number of unicode characters (not bytes) in the string * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_unicode_utf8_get_len(const char *buf) EINA_ARG_NONNULL(1); @@ -175,6 +223,10 @@ EAPI int eina_unicode_utf8_get_len(const char *buf) EINA_ARG_NONNULL(1); * @param _len the length of the returned Eina_Unicode string. * @return the newly allocated Eina_Unicode string. * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode *eina_unicode_utf8_to_unicode(const char *utf, int *_len) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -186,6 +238,10 @@ EAPI Eina_Unicode *eina_unicode_utf8_to_unicode(const char *utf, int *_len) EINA * @param _len the length byte length of the return utf8 substring. * @return the newly allocated utf-8 substring. * @since 1.17 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char * eina_unicode_unicode_to_utf8_range(const Eina_Unicode *uni, int ulen, int *_len) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -196,6 +252,10 @@ EAPI char * eina_unicode_unicode_to_utf8_range(const Eina_Unicode *uni, int ulen * @param _len the length byte length of the return utf8 string. * @return the newly allocated utf-8 string. * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char * eina_unicode_unicode_to_utf8(const Eina_Unicode *uni, int *_len) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; diff --git a/src/lib/eina/eina_ustrbuf.h b/src/lib/eina/eina_ustrbuf.h index 888d8a2..a9de960 100644 --- a/src/lib/eina/eina_ustrbuf.h +++ b/src/lib/eina/eina_ustrbuf.h @@ -44,6 +44,10 @@ typedef struct _Eina_Strbuf Eina_UStrbuf; * @see eina_ustrbuf_free() * @see eina_ustrbuf_append() * @see eina_ustrbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_UStrbuf *eina_ustrbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -62,6 +66,10 @@ EAPI Eina_UStrbuf *eina_ustrbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT; * @see eina_ustrbuf_append() * @see eina_ustrbuf_string_get() * @since 1.1.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new(Eina_Unicode *str) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -79,6 +87,10 @@ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new(Eina_Unicode *str) EINA_MALLOC EINA_W * * @see eina_ustrbuf_manage_new() * @since 1.2.0 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new_length(Eina_Unicode *str, size_t length) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -89,6 +101,10 @@ EAPI Eina_UStrbuf *eina_ustrbuf_manage_new_length(Eina_Unicode *str, size_t leng * * This function frees the memory of @p buf. @p buf must have been * created by eina_ustrbuf_new(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_ustrbuf_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); @@ -99,6 +115,10 @@ EAPI void eina_ustrbuf_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); * * This function reset @p buf: the buffer len is set to 0, and the * string is set to '\\0'. No memory is free'd. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_ustrbuf_reset(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); @@ -117,6 +137,10 @@ EAPI void eina_ustrbuf_reset(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); * * @see eina_ustrbuf_append() * @see eina_ustrbuf_append_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_append(Eina_UStrbuf *buf, const Eina_Unicode *str) EINA_ARG_NONNULL(1, 2); @@ -130,6 +154,10 @@ EAPI Eina_Bool eina_ustrbuf_append(Eina_UStrbuf *buf, const Eina_Unicode *str) E * This function appends the escaped string @p str to @p buf. If @p * str can not be appended, #EINA_FALSE is returned, otherwise, #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_append_escaped(Eina_UStrbuf *buf, const Eina_Unicode *str) EINA_ARG_NONNULL(1, 2); @@ -153,6 +181,10 @@ EAPI Eina_Bool eina_ustrbuf_append_escaped(Eina_UStrbuf *buf, const Eina_Unicode * * @see eina_ustrbuf_append() * @see eina_ustrbuf_append_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_append_n(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t maxlen) EINA_ARG_NONNULL(1, 2); @@ -174,6 +206,10 @@ EAPI Eina_Bool eina_ustrbuf_append_n(Eina_UStrbuf *buf, const Eina_Unicode *str, * @see eina_stringshare_length() * @see eina_ustrbuf_append() * @see eina_ustrbuf_append_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_append_length(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t length) EINA_ARG_NONNULL(1, 2); @@ -187,6 +223,10 @@ EAPI Eina_Bool eina_ustrbuf_append_length(Eina_UStrbuf *buf, const Eina_Unicode * * This function inserts @p c to @p buf. If it can not insert it, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_append_char(Eina_UStrbuf *buf, Eina_Unicode c) EINA_ARG_NONNULL(1); @@ -203,6 +243,10 @@ EAPI Eina_Bool eina_ustrbuf_append_char(Eina_UStrbuf *buf, Eina_Unicode c) EINA_ * eina_ustrbuf_insert_length(). If the length is known beforehand, * consider using that variant. If @p buf can't insert it, #EINA_FALSE * is returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_insert(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -218,6 +262,10 @@ EAPI Eina_Bool eina_ustrbuf_insert(Eina_UStrbuf *buf, const Eina_Unicode *str, s * This function inserts the escaped string @p str to @p buf at * position @p pos. If @p buf can't insert @p str, #EINA_FALSE is * returned, otherwise #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_insert_escaped(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -238,6 +286,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_escaped(Eina_UStrbuf *buf, const Eina_Unicode * should then be checked so that it is greater than the size of * @p str). If @p str can not be inserted, #EINA_FALSE is returned, * otherwise, #EINA_TRUE is returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_insert_n(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t maxlen, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -260,6 +312,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_n(Eina_UStrbuf *buf, const Eina_Unicode *str, * @see eina_stringshare_length() * @see eina_ustrbuf_insert() * @see eina_ustrbuf_insert_n() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_insert_length(Eina_UStrbuf *buf, const Eina_Unicode *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2); @@ -275,6 +331,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_length(Eina_UStrbuf *buf, const Eina_Unicode * This function inserts @p c to @p buf at position @p pos. If @p buf * can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is * returned. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_t pos) EINA_ARG_NONNULL(1); @@ -363,6 +423,10 @@ EAPI Eina_Bool eina_ustrbuf_insert_char(Eina_UStrbuf *buf, Eina_Unicode c, size_ * This function removes a slice of @p buf, starting at @p start * (inclusive) and ending at @p end (non-inclusive). Both values are * in bytes. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_ustrbuf_remove(Eina_UStrbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1); @@ -379,6 +443,10 @@ eina_ustrbuf_remove(Eina_UStrbuf *buf, size_t start, size_t end) EINA_ARG_NONNUL * make that pointer invalid. * * @see eina_ustrbuf_string_steal() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Eina_Unicode * eina_ustrbuf_string_get(const Eina_UStrbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -395,6 +463,10 @@ eina_ustrbuf_string_get(const Eina_UStrbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_U * free(). * * @see eina_ustrbuf_string_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Unicode * eina_ustrbuf_string_steal(Eina_UStrbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -406,6 +478,10 @@ eina_ustrbuf_string_steal(Eina_UStrbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT * * This function frees the string contained in @p buf without freeing * @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_ustrbuf_string_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); @@ -417,6 +493,10 @@ eina_ustrbuf_string_free(Eina_UStrbuf *buf) EINA_ARG_NONNULL(1); * @return The current length of the string, in bytes. * * This function returns the length of @p buf. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI size_t eina_ustrbuf_length_get(const Eina_UStrbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; diff --git a/src/lib/eina/eina_ustringshare.h b/src/lib/eina/eina_ustringshare.h index f97f305..35c2654 100644 --- a/src/lib/eina/eina_ustringshare.h +++ b/src/lib/eina/eina_ustringshare.h @@ -108,6 +108,10 @@ * buffer or substring. * * @see eina_ustringshare_add() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Eina_Unicode *eina_ustringshare_add_length(const Eina_Unicode *str, unsigned int slen) EINA_WARN_UNUSED_RESULT; @@ -129,6 +133,10 @@ EAPI const Eina_Unicode *eina_ustringshare_add_length(const Eina_Unicode *str, u * terminated, use eina_stringshare_add_length() instead. * * @see eina_ustringshare_add_length() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Eina_Unicode *eina_ustringshare_add(const Eina_Unicode *str) EINA_WARN_UNUSED_RESULT; @@ -145,6 +153,10 @@ EAPI const Eina_Unicode *eina_ustringshare_add(const Eina_Unicode *str) EINA_WAR * eina_ustringshare_add(). * * There is no unref since this is the work of eina_ustringshare_del(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Eina_Unicode *eina_ustringshare_ref(const Eina_Unicode *str); @@ -160,6 +172,10 @@ EAPI const Eina_Unicode *eina_ustringshare_ref(const Eina_Unicode *str); * * @note If the given pointer is not shared, bad things will happen, likely a * segmentation fault. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_ustringshare_del(const Eina_Unicode *str); @@ -174,6 +190,10 @@ EAPI void eina_ustringshare_del(const Eina_Unicode *str); * * @note If the given pointer is not shared, bad things will happen, likely a * segmentation fault. If in doubt, try strlen(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int eina_ustringshare_strlen(const Eina_Unicode *str) EINA_PURE EINA_WARN_UNUSED_RESULT; @@ -182,6 +202,10 @@ EAPI int eina_ustringshare_strlen(const Eina_Unicode *str) EINA_ * * This function dumps all strings in the share_common to stdout with a * DDD: prefix per line and a memory usage summary. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void eina_ustringshare_dump(void); diff --git a/src/lib/eina/eina_util.h b/src/lib/eina/eina_util.h index e902003..d049e76 100644 --- a/src/lib/eina/eina_util.h +++ b/src/lib/eina/eina_util.h @@ -33,6 +33,10 @@ * it instead of the naive getenv("HOME"). * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_environment_home_get(void); @@ -44,6 +48,10 @@ EAPI const char *eina_environment_home_get(void); * it instead of the naive getenv("TMPDIR"). * * @since 1.15 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_environment_tmp_get(void); diff --git a/src/lib/eina/eina_value.h b/src/lib/eina/eina_value.h index a64d3b4..5f90962 100644 --- a/src/lib/eina/eina_value.h +++ b/src/lib/eina/eina_value.h @@ -344,6 +344,10 @@ union _Eina_Value_Union * manages unsigned char type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UCHAR; @@ -352,6 +356,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UCHAR; * manages unsigned short type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_USHORT; @@ -360,6 +368,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_USHORT; * manages unsigned int type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UINT; @@ -368,6 +380,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UINT; * manages unsigned long type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ULONG; @@ -377,6 +393,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ULONG; * @note this is identical in function to EINA_VALUE_TYPE_ULONG * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMESTAMP; @@ -385,6 +405,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMESTAMP; * manages unsigned integer of 64 bits type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UINT64; @@ -393,6 +417,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_UINT64; * manages char type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_CHAR; @@ -401,6 +429,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_CHAR; * manages short type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_SHORT; @@ -409,6 +441,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_SHORT; * manages int type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_INT; @@ -417,6 +453,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_INT; * manages long type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_LONG; @@ -425,6 +465,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_LONG; * manages integer of 64 bits type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_INT64; @@ -433,6 +477,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_INT64; * manages float type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_FLOAT; @@ -441,6 +489,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_FLOAT; * manages double type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_DOUBLE; @@ -449,6 +501,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_DOUBLE; * manages stringshared string type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRINGSHARE; @@ -457,6 +513,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRINGSHARE; * manages string type. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRING; @@ -481,6 +541,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRING; * use by value, no copies are done. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ARRAY; @@ -503,6 +567,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_ARRAY; * done. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_LIST; @@ -532,6 +600,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_LIST; * value must point to strdup(string)! * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_HASH; @@ -546,6 +618,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_HASH; * timeval" and it's an exact copy of value. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMEVAL; @@ -562,6 +638,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_TIMEVAL; * Memory is untouched unless you provide @c ops (operations) pointer. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_BLOB; @@ -584,6 +664,10 @@ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_BLOB; * use by value, no copies are done. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Type *EINA_VALUE_TYPE_STRUCT; @@ -628,6 +712,10 @@ struct _Eina_Value * @see eina_value_free() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_new(const Eina_Value_Type *type) EINA_ARG_NONNULL(1) EINA_MALLOC EINA_WARN_UNUSED_RESULT; @@ -638,6 +726,10 @@ EAPI Eina_Value *eina_value_new(const Eina_Value_Type *type) EINA_ARG_NONNULL(1) * @see eina_value_flush() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eina_value_free(Eina_Value *value); @@ -698,6 +790,10 @@ static inline void eina_value_flush(Eina_Value *value) EINA_ARG_NONNULL(1); * by getting the contents of @a value and setting it to @a copy. * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_value_copy(const Eina_Value *value, Eina_Value *copy) EINA_ARG_NONNULL(1, 2); @@ -1024,6 +1120,10 @@ static inline Eina_Bool eina_value_pget(const Eina_Value *value, * @note Both objects must have eina_value_setup() called on them beforehand! * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_value_convert(const Eina_Value *value, Eina_Value *convert) EINA_ARG_NONNULL(1, 2); @@ -1036,6 +1136,10 @@ EAPI Eina_Bool eina_value_convert(const Eina_Value *value, * * @see eina_value_convert() * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char *eina_value_to_string(const Eina_Value *value) EINA_ARG_NONNULL(1); @@ -1102,6 +1206,10 @@ struct _Eina_Value_Array * eina_value_array_setup() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_array_new(const Eina_Value_Type *subtype, unsigned int step) EINA_ARG_NONNULL(1); @@ -1752,6 +1860,10 @@ struct _Eina_Value_List * @see eina_value_list_setup() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_list_new(const Eina_Value_Type *subtype) EINA_ARG_NONNULL(1); @@ -2376,6 +2488,10 @@ struct _Eina_Value_Hash * @see eina_value_hash_setup() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_hash_new(const Eina_Value_Type *subtype, unsigned int buckets_power_size) EINA_ARG_NONNULL(1); @@ -2713,6 +2829,10 @@ struct _Eina_Value_Blob_Operations * malloc() as well. * * No compare or to_string are provided, defaults will be used. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Blob_Operations *EINA_VALUE_BLOB_OPERATIONS_MALLOC; @@ -2820,6 +2940,10 @@ struct _Eina_Value_Struct_Operations * * No other methods are set (alloc, free, copy, compare), then it uses * the default operations. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Struct_Operations *EINA_VALUE_STRUCT_OPERATIONS_BINSEARCH; @@ -2835,6 +2959,10 @@ EAPI extern const Eina_Value_Struct_Operations *EINA_VALUE_STRUCT_OPERATIONS_BIN * * No other methods are set (alloc, free, copy, compare), then it uses * the default operations. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI extern const Eina_Value_Struct_Operations *EINA_VALUE_STRUCT_OPERATIONS_STRINGSHARE; @@ -2937,6 +3065,10 @@ struct _Eina_Value_Struct * @see eina_value_struct_setup() * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_struct_new(const Eina_Value_Struct_Desc *desc) EINA_ARG_NONNULL(1); @@ -3373,6 +3505,10 @@ struct _Eina_Value_Type * @param type type reference. * @return string or @c NULL if type is invalid. * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eina_value_type_name_get(const Eina_Value_Type *type) EINA_PURE EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -3385,6 +3521,10 @@ EAPI const char *eina_value_type_name_get(const Eina_Value_Type *type) EINA_PURE * as runtime #EINA_VALUE_TYPE_VERSION. * * @since 1.2 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_value_type_check(const Eina_Value_Type *type) EINA_PURE EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; diff --git a/src/lib/eina/eina_value_util.h b/src/lib/eina/eina_value_util.h index 8bc8330..b1179e8 100644 --- a/src/lib/eina/eina_value_util.h +++ b/src/lib/eina/eina_value_util.h @@ -32,6 +32,10 @@ * @brief Create a basic #Eina_Value struct desc with refcounting * @return The #Eina_Value_Struct_Desc on success, @c NULL on failure * @since 1.12 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value_Struct_Desc *eina_value_util_struct_desc_new(void); @@ -40,6 +44,10 @@ EAPI Eina_Value_Struct_Desc *eina_value_util_struct_desc_new(void); * @param timestr The value to use * @return The #Eina_Value * @since 1.12 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eina_value_util_time_string_new(const char *timestr); diff --git a/src/lib/eina/eina_xattr.h b/src/lib/eina/eina_xattr.h index b37262e..7705bb0 100644 --- a/src/lib/eina/eina_xattr.h +++ b/src/lib/eina/eina_xattr.h @@ -58,6 +58,10 @@ struct _Eina_Xattr * if you need. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_xattr_ls(const char *file) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -71,6 +75,10 @@ EAPI Eina_Iterator *eina_xattr_ls(const char *file) EINA_ARG_NONNULL(1) EINA_WAR * if you need. The iterator will provide an Eina_Xattr structure. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_xattr_value_ls(const char *file) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -84,6 +92,10 @@ EAPI Eina_Iterator *eina_xattr_value_ls(const char *file) EINA_ARG_NONNULL(1) EI * if you need. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_xattr_fd_ls(int fd) EINA_WARN_UNUSED_RESULT; @@ -97,6 +109,10 @@ EAPI Eina_Iterator *eina_xattr_fd_ls(int fd) EINA_WARN_UNUSED_RESULT; * if you need. The iterator will provide an Eina_Xattr structure. * * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Iterator *eina_xattr_value_fd_ls(int fd) EINA_WARN_UNUSED_RESULT; @@ -107,6 +123,10 @@ EAPI Eina_Iterator *eina_xattr_value_fd_ls(int fd) EINA_WARN_UNUSED_RESULT; * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * @see eina_xattr_fd_copy() * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_xattr_copy(const char *src, const char *dst) EINA_ARG_NONNULL(1, 2); @@ -117,6 +137,10 @@ EAPI Eina_Bool eina_xattr_copy(const char *src, const char *dst) EINA_ARG_NONNUL * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * @see eina_xattr_copy() * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_xattr_fd_copy(int src, int dst); @@ -131,6 +155,10 @@ EAPI Eina_Bool eina_xattr_fd_copy(int src, int dst); * It will return @c NULL and *size will be @c 0 if it fails. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *eina_xattr_get(const char *file, const char *attribute, ssize_t *size) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT; @@ -145,6 +173,10 @@ EAPI void *eina_xattr_get(const char *file, const char *attribute, ssize_t *size * It will return @c NULL and *size will be @c 0 if it fails. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eina_xattr_fd_get(int fd, const char *attribute, ssize_t *size) EINA_ARG_NONNULL(2, 3) EINA_WARN_UNUSED_RESULT; @@ -159,6 +191,10 @@ EAPI void *eina_xattr_fd_get(int fd, const char *attribute, ssize_t *size) EINA_ * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_set(const char *file, const char *attribute, const void *data, ssize_t length, Eina_Xattr_Flags flags) EINA_ARG_NONNULL(1, 2, 3); @@ -173,6 +209,10 @@ EAPI Eina_Bool eina_xattr_set(const char *file, const char *attribute, const voi * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_xattr_fd_set(int fd, const char *attribute, const void *data, ssize_t length, Eina_Xattr_Flags flags) EINA_ARG_NONNULL(2, 3); @@ -185,6 +225,10 @@ EAPI Eina_Bool eina_xattr_fd_set(int fd, const char *attribute, const void *data * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_xattr_del(const char *file, const char *attribute) EINA_ARG_NONNULL(1, 2); @@ -196,6 +240,10 @@ EAPI Eina_Bool eina_xattr_del(const char *file, const char *attribute) EINA_ARG_ * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eina_xattr_fd_del(int fd, const char *attribute) EINA_ARG_NONNULL(2); @@ -209,6 +257,10 @@ EAPI Eina_Bool eina_xattr_fd_del(int fd, const char *attribute) EINA_ARG_NONNULL * @return EINA_TRUE on success, EINA_FALSE otherwise. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_string_set(const char *file, const char *attribute, const char *data, Eina_Xattr_Flags flags); @@ -222,6 +274,10 @@ EAPI Eina_Bool eina_xattr_string_set(const char *file, const char *attribute, co * This call check that the string is properly NULL-terminated before returning it. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *eina_xattr_string_get(const char *file, const char *attribute); @@ -235,6 +291,10 @@ EAPI char *eina_xattr_string_get(const char *file, const char *attribute); * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_double_set(const char *file, const char *attribute, double value, Eina_Xattr_Flags flags); @@ -249,6 +309,10 @@ EAPI Eina_Bool eina_xattr_double_set(const char *file, const char *attribute, do * This call check that the double is correctly set. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_double_get(const char *file, const char *attribute, double *value); @@ -262,6 +326,10 @@ EAPI Eina_Bool eina_xattr_double_get(const char *file, const char *attribute, do * @return #EINA_TRUE on success, #EINA_FALSE otherwise. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_int_set(const char *file, const char *attribute, int value, Eina_Xattr_Flags flags); @@ -276,6 +344,10 @@ EAPI Eina_Bool eina_xattr_int_set(const char *file, const char *attribute, int v * This call check that the int is correctly set. * * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool eina_xattr_int_get(const char *file, const char *attribute, int *value); diff --git a/src/lib/eio/Eio.h b/src/lib/eio/Eio.h index 2ad8c56..bc8bab0 100644 --- a/src/lib/eio/Eio.h +++ b/src/lib/eio/Eio.h @@ -272,6 +272,10 @@ struct _Eio_Progress * @see ecore_thread_feedback_run() * @see eio_file_direct_ls() * @see eio_file_stat_ls() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_ls(const char *dir, Eio_Filter_Cb filter_cb, @@ -307,6 +311,10 @@ EAPI Eio_File *eio_file_ls(const char *dir, * @see eio_file_stat_ls() * @see eina_file_direct_ls() * @see ecore_thread_feedback_run() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_direct_ls(const char *dir, Eio_Filter_Direct_Cb filter_cb, @@ -338,6 +346,10 @@ EAPI Eio_File *eio_file_direct_ls(const char *dir, * @see eio_file_stat_ls() * @see eina_file_stat_ls() * @see ecore_thread_feedback_run() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_stat_ls(const char *dir, Eio_Filter_Direct_Cb filter_cb, @@ -367,6 +379,10 @@ EAPI Eio_File *eio_file_stat_ls(const char *dir, * @see eio_dir_direct_ls() * @see eina_file_stat_ls() * @see ecore_thread_feedback_run() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_dir_stat_ls(const char *dir, Eio_Filter_Direct_Cb filter_cb, @@ -395,6 +411,10 @@ EAPI Eio_File *eio_dir_stat_ls(const char *dir, * @see eio_dir_stat_ls() * @see eina_file_direct_ls() * @see ecore_thread_feedback_run() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_dir_direct_ls(const char *dir, Eio_Filter_Dir_Cb filter_cb, @@ -412,6 +432,10 @@ EAPI Eio_File *eio_dir_direct_ls(const char *dir, * @return A reference to the I/O operation. * * eio_file_direct_stat calls stat in another thread. This prevents any blocking in your apps. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_direct_stat(const char *path, Eio_Stat_Cb done_cb, @@ -447,6 +471,10 @@ EAPI Eio_File *eio_file_direct_stat(const char *path, * * Set a new permission of a path changing it to the mode passed as argument. * It's equivalent to the chmod command. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_chmod(const char *path, mode_t mode, @@ -466,6 +494,10 @@ EAPI Eio_File *eio_file_chmod(const char *path, * * This function will change the owner of a path, setting it to the user and * group passed as argument. It's equivalent to the chown shell command. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_chown(const char *path, const char *user, @@ -483,6 +515,10 @@ EAPI Eio_File *eio_file_chown(const char *path, * @return A reference to the I/O operation. * * This function will erase a file. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_unlink(const char *path, Eio_Done_Cb done_cb, @@ -499,6 +535,10 @@ EAPI Eio_File *eio_file_unlink(const char *path, * @return A reference to the I/O operation. * * Creates a new directory using the mode provided. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_mkdir(const char *path, mode_t mode, @@ -521,6 +561,10 @@ EAPI Eio_File *eio_file_mkdir(const char *path, * This function will copy a file from source to dest. It will try to use splice * if possible, if not it will fallback to mmap/write. It will try to preserve * access rights, but not user/group identification. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_move(const char *source, const char *dest, @@ -543,6 +587,10 @@ EAPI Eio_File *eio_file_move(const char *source, * This function will copy a file from source to dest. It will try to use splice * if possible, if not it will fallback to mmap/write. It will try to preserve * access rights, but not user/group identification. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_copy(const char *source, const char *dest, @@ -573,6 +621,10 @@ EAPI Eio_File *eio_file_copy(const char *source, * the main_cb or EINA_FALSE to ignore it. * * @note if a rename occurs, the filter callback will not be called. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_dir_move(const char *source, const char *dest, @@ -601,6 +653,10 @@ EAPI Eio_File *eio_dir_move(const char *source, * Every file will be passed to the filter_cb, so it's your job to decide if you * want to pass the file to the main_cb or not. Return EINA_TRUE to pass it to * the main_cb or EINA_FALSE to ignore it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_dir_copy(const char *source, const char *dest, @@ -626,6 +682,10 @@ EAPI Eio_File *eio_dir_copy(const char *source, * Every file will be passed to the filter_cb, so it's your job to decide if you * want to pass the file to the main_cb or not. Return EINA_TRUE to pass it to * the main_cb or EINA_FALSE to ignore it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_dir_unlink(const char *path, Eio_Filter_Direct_Cb filter_cb, @@ -657,6 +717,10 @@ EAPI Eio_File *eio_dir_unlink(const char *path, * @param error_cb Callback called in the main loop when something goes wrong during the listing of the eXtended attribute. * @param data Unmodified user data passed to callbacks * @return A reference to the I/O operation. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr(const char *path, Eio_Filter_Cb filter_cb, @@ -678,6 +742,10 @@ EAPI Eio_File *eio_file_xattr(const char *path, * * eio_file_xattr_int_set calls eina_xattr_int_set from another thread. This prevents blocking in your apps. If * the writing succeeded, the done_cb will be called even if a cancel was requested, but came too late. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_int_set(const char *path, const char *attribute, @@ -700,6 +768,10 @@ EAPI Eio_File *eio_file_xattr_int_set(const char *path, * * eio_file_xattr_double_set calls eina_xattr_double_set from another thread. This prevents blocking in your apps. If * the writing succeeded, the done_cb will be called even if a cancel was requested, but came too late. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_double_set(const char *path, const char *attribute, @@ -721,6 +793,10 @@ EAPI Eio_File *eio_file_xattr_double_set(const char *path, * * eio_file_xattr_string_set calls eina_xattr_string_set from another thread. This prevents blocking in your apps. If * the writing succeeded, the done_cb will be called even if a cancel was requested, but came too late. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_string_set(const char *path, const char *attribute, @@ -743,6 +819,10 @@ EAPI Eio_File *eio_file_xattr_string_set(const char *path, * * eio_file_xattr_set calls setxattr from another thread. This prevents blocking in your apps. If * the writing succeeded, the done_cb will be called even if a cancel was requested, but came too late. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_set(const char *path, const char *attribute, @@ -763,6 +843,10 @@ EAPI Eio_File *eio_file_xattr_set(const char *path, * @return A reference to the I/O operation. * * eio_file_xattr_get calls getxattr from another thread. This prevents blocking in your apps. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_get(const char *path, const char *attribute, @@ -779,6 +863,10 @@ EAPI Eio_File *eio_file_xattr_get(const char *path, * @return A reference to the I/O operation. * * eio_file_xattr_int_get calls eina_xattr_int_get from another thread. This prevents blocking in your apps. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_int_get(const char *path, const char *attribute, @@ -795,6 +883,10 @@ EAPI Eio_File *eio_file_xattr_int_get(const char *path, * @return A reference to the I/O operation. * * eio_file_xattr_double_get calls eina_xattr_double_get from another thread. This prevents blocking in your apps. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_double_get(const char *path, const char *attribute, @@ -811,6 +903,10 @@ EAPI Eio_File *eio_file_xattr_double_get(const char *path, * @return A reference to the I/O operation. * * eio_file_xattr_string_get calls eina_xattr_string_get from another thread. This prevents blocking in your apps. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_xattr_string_get(const char *path, const char *attribute, @@ -838,12 +934,20 @@ EAPI Eio_File *eio_file_xattr_string_get(const char *path, /** * @brief Initialize eio and all its required submodule. * @return the current number of eio users. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eio_init(void); /** * @brief Shutdown eio and all its submodule if possible. * @return the number of pending users of eio. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eio_shutdown(void); @@ -862,6 +966,10 @@ EAPI int eio_shutdown(void); * @note You should give at least a reasonable amount of memory or * the thread might stall. * @since 1.10 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eio_memory_burst_limit_set(size_t limit); @@ -871,6 +979,10 @@ EAPI void eio_memory_burst_limit_set(size_t limit); * * @since 1.10 * @see eio_memory_burst_limit_set + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI size_t eio_memory_burst_limit_get(void); @@ -881,6 +993,10 @@ EAPI size_t eio_memory_burst_limit_get(void); * * This is only available and make sense in the thread callback, not in * the mainloop. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eio_file_container_get(Eio_File *ls); @@ -891,6 +1007,10 @@ EAPI void *eio_file_container_get(Eio_File *ls); * * This will cancel any kind of I/O operation and cleanup the mess. This means * that it could take time to cancel an I/O. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eio_file_cancel(Eio_File *ls); @@ -900,6 +1020,10 @@ EAPI Eina_Bool eio_file_cancel(Eio_File *ls); * @return EINA_TRUE if it was canceled, EINA_FALSE other wise. * * In case of an error it also return EINA_TRUE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eio_file_check(Eio_File *ls); @@ -915,6 +1039,10 @@ EAPI Eina_Bool eio_file_check(Eio_File *ls); * * This function can only be safely called from within the filter callback. * If you don't need to copy the key around you can use @ref eio_file_associate_direct_add + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eio_file_associate_add(Eio_File *ls, const char *key, @@ -931,6 +1059,10 @@ EAPI Eina_Bool eio_file_associate_add(Eio_File *ls, * This function can only be safely called from within the filter callback. * If you need eio to make a proper copy of the @p key to be safe use * @ref eio_file_associate_add instead. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eio_file_associate_direct_add(Eio_File *ls, const char *key, @@ -941,6 +1073,10 @@ EAPI Eina_Bool eio_file_associate_direct_add(Eio_File *ls, * @param ls The Eio_File ls request currently calling the notify callback. * @param key The key pointing to the data to retrieve. * @return the data associated with the key or @p NULL if not found. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eio_file_associate_find(Eio_File *ls, const char *key); @@ -1013,6 +1149,9 @@ static inline Eina_Bool eio_file_is_lnk(const Eina_Stat *stat); * @param data Unmodified user data passed to callbacks * @return Pointer to the file if successful or NULL otherwise. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_open(const char *name, Eina_Bool shared, Eio_Open_Cb open_cb, @@ -1026,6 +1165,10 @@ EAPI Eio_File *eio_file_open(const char *name, Eina_Bool shared, * @param error_cb Callback called in the main loop when the file couldn't be closed. * @param data Unmodified user data passed to callbacks * @return Pointer to the file if successful or NULL otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_close(Eina_File *f, Eio_Done_Cb done_cb, @@ -1043,6 +1186,10 @@ EAPI Eio_File *eio_file_close(Eina_File *f, * @return Pointer to the file if successful or NULL otherwise. * * The container of the Eio_File is the Eina_File. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_map_all(Eina_File *f, Eina_File_Populate rule, @@ -1064,6 +1211,10 @@ EAPI Eio_File *eio_file_map_all(Eina_File *f, * @return Pointer to the file if successful or NULL otherwise. * * The container of the Eio_File is the Eina_File. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_file_map_new(Eina_File *f, Eina_File_Populate rule, @@ -1098,6 +1249,10 @@ EAPI Eio_File *eio_file_map_new(Eina_File *f, * @return NULL in case of a failure. * * This function calls eet_open() from another thread using Ecore_Thread. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_open(const char *filename, Eet_File_Mode mode, @@ -1115,6 +1270,10 @@ EAPI Eio_File *eio_eet_open(const char *filename, * This function will call eet_close() from another thread by * using Ecore_Thread. You should assume that the Eet_File is dead after this * function is called. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_close(Eet_File *ef, Eio_Done_Cb done_cb, @@ -1131,6 +1290,10 @@ EAPI Eio_File *eio_eet_close(Eet_File *ef, * * This function will call eet_sync() from another thread. As long as the done_cb or * error_cb haven't be called, you must keep @p ef open. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_sync(Eet_File *ef, Eio_Done_Cb done_cb, @@ -1150,6 +1313,10 @@ EAPI Eio_File *eio_eet_sync(Eet_File *ef, * @param error_cb Callback called in the main loop when the file can't be written. * @param user_data Private data given to each callback. * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_data_write_cipher(Eet_File *ef, Eet_Data_Descriptor *edd, @@ -1171,6 +1338,10 @@ EAPI Eio_File *eio_eet_data_write_cipher(Eet_File *ef, * @param error_cb Callback called in the main loop when the data can't be read. * @param data Unmodified user data passed to callbacks * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_data_read_cipher(Eet_File *ef, Eet_Data_Descriptor *edd, @@ -1196,6 +1367,10 @@ EAPI Eio_File *eio_eet_data_read_cipher(Eet_File *ef, * @param error_cb Callback called in the main loop when the file can't be written. * @param user_data Private data given to each callback. * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_data_image_write_cipher(Eet_File *ef, const char *name, @@ -1219,6 +1394,10 @@ EAPI Eio_File *eio_eet_data_image_write_cipher(Eet_File *ef, * @param error_cb Callback called in the main loop when the data can't be read. * @param data Unmodified user data passed to callbacks * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_read_direct(Eet_File *ef, const char *name, @@ -1235,6 +1414,10 @@ EAPI Eio_File *eio_eet_read_direct(Eet_File *ef, * @param error_cb Callback called in the main loop when the data can't be read. * @param data Unmodified user data passed to callbacks * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_read_cipher(Eet_File *ef, const char *name, @@ -1255,6 +1438,10 @@ EAPI Eio_File *eio_eet_read_cipher(Eet_File *ef, * @param error_cb Callback called in the main loop when the file can't be written. * @param user_data Private data given to each callback. * @return NULL in case of a failure. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_File *eio_eet_write_cipher(Eet_File *ef, const char *name, @@ -1321,6 +1508,10 @@ struct _Eio_Monitor_Event * This function will add the given path to its internal * list of files to monitor. It utilizes the inotify mechanism * introduced in kernel 2.6.13 for passive monitoring. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_Monitor *eio_monitor_add(const char *path); @@ -1334,6 +1525,10 @@ EAPI Eio_Monitor *eio_monitor_add(const char *path); * * This fuction is just like eio_monitor_add(), however the string passed by * argument must be created using eina_stringshare_add(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eio_Monitor *eio_monitor_stringshared_add(const char *path); @@ -1342,6 +1537,10 @@ EAPI Eio_Monitor *eio_monitor_stringshared_add(const char *path); * @param monitor The Eio_Monitor you want to stop watching. * It can only be an Eio_Monitor returned to you from calling * eio_monitor_add() or eio_monitor_stringshared_add() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eio_monitor_del(Eio_Monitor *monitor); @@ -1350,6 +1549,10 @@ EAPI void eio_monitor_del(Eio_Monitor *monitor); * Eio_Monitor. * @param monitor Eio_Monitor to return the path of * @return The stringshared path belonging to @p monitor + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eio_monitor_path_get(Eio_Monitor *monitor); diff --git a/src/lib/eldbus/Eldbus.h b/src/lib/eldbus/Eldbus.h index ee11954..a7fff9f 100644 --- a/src/lib/eldbus/Eldbus.h +++ b/src/lib/eldbus/Eldbus.h @@ -147,12 +147,20 @@ EAPI extern const Eldbus_Version * eldbus_version; /**< Global Eldbus_Version ob * @brief Initialize eldbus. * * @return 1 or greater on success, 0 otherwise + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eldbus_init(void); /** * @brief Shutdown eldbus. * * @return 0 if e_dbus shuts down, greater than 0 otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int eldbus_shutdown(void); diff --git a/src/lib/eldbus/eldbus_connection.h b/src/lib/eldbus/eldbus_connection.h index 10995a7..87e6f1b 100644 --- a/src/lib/eldbus/eldbus_connection.h +++ b/src/lib/eldbus/eldbus_connection.h @@ -33,6 +33,10 @@ typedef enum * ELDBUS_CONNECTION_TYPE_SYSTEM or ELDBUS_CONNECTION_TYPE_STARTER * * @return connection with bus + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_connection_get(Eldbus_Connection_Type type); @@ -46,6 +50,10 @@ EAPI Eldbus_Connection *eldbus_connection_get(Eldbus_Connection_Type type); * ELDBUS_CONNECTION_TYPE_SYSTEM or ELDBUS_CONNECTION_TYPE_STARTER * * @return connection with bus + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_private_connection_get(Eldbus_Connection_Type type); @@ -57,6 +65,10 @@ EAPI Eldbus_Connection *eldbus_private_connection_get(Eldbus_Connection_Type typ * @param address the address which will be passed to dbus_connection_open() * * @return connection with bus + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_address_connection_get(const char *address) EINA_ARG_NONNULL(1); @@ -69,6 +81,10 @@ EAPI Eldbus_Connection *eldbus_address_connection_get(const char *address) EINA_ * @param address the address which will be passed to dbus_connection_open_private() * * @return connection with bus + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_private_address_connection_get(const char *address) EINA_ARG_NONNULL(1); @@ -77,6 +93,10 @@ EAPI Eldbus_Connection *eldbus_private_address_connection_get(const char *addres * * @param conn The given Eldbus_Connection object to reference. * @return The Eldbus_Connection object given as parameter. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_connection_ref(Eldbus_Connection *conn) EINA_ARG_NONNULL(1); @@ -87,6 +107,10 @@ EAPI Eldbus_Connection *eldbus_connection_ref(Eldbus_Connection *conn) EINA_ARG_ * its children will be invalidated. * * @param conn The given Eldbus_Connection object to unreference. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_unref(Eldbus_Connection *conn) EINA_ARG_NONNULL(1); @@ -96,11 +120,19 @@ EAPI void eldbus_connection_unref(Eldbus_Connection *conn) EINA_ARG * @param conn The connection object to add the callback to. * @param cb callback to be called * @param data data passed to callback + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_free_cb_add(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); /** * @brief Remove callback registered in eldbus_connection_free_cb_add(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_free_cb_del(Eldbus_Connection *conn, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -110,6 +142,10 @@ EAPI void eldbus_connection_free_cb_del(Eldbus_Connection *conn, El * @param conn The connection object to store data to * @param key to identify data * @param data data that will be stored + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_data_set(Eldbus_Connection *conn, const char *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -120,6 +156,10 @@ EAPI void eldbus_connection_data_set(Eldbus_Connection *conn, const * @param key key that identifies data * * @return pointer to data if found otherwise NULL + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_connection_data_get(const Eldbus_Connection *conn, const char *key) EINA_ARG_NONNULL(1, 2); @@ -130,6 +170,10 @@ EAPI void *eldbus_connection_data_get(const Eldbus_Connection *conn, * @param key that identifies data * * @return pointer to data if found otherwise NULL + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_connection_data_del(Eldbus_Connection *conn, const char *key) EINA_ARG_NONNULL(1, 2); @@ -154,11 +198,19 @@ typedef void (*Eldbus_Connection_Event_Cb)(void *data, Eldbus_Connection *conn, /** * @brief Add a callback function to be called when an event occurs of the * type passed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_event_callback_add(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); /** * @brief Remove callback registered in eldbus_connection_event_callback_add(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_connection_event_callback_del(Eldbus_Connection *conn, Eldbus_Connection_Event_Type type, Eldbus_Connection_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -173,6 +225,10 @@ EAPI void eldbus_connection_event_callback_del(Eldbus_Connectio * @param timeout timeout in milliseconds, -1 to use default internal value or * ELDBUS_TIMEOUT_INFINITE for no timeout * @return A Eldbus_Pending struct. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_connection_send(Eldbus_Connection *conn, Eldbus_Message *msg, Eldbus_Message_Cb cb, const void *cb_data, double timeout) EINA_ARG_NONNULL(1, 2); @@ -183,6 +239,10 @@ EAPI Eldbus_Pending *eldbus_connection_send(Eldbus_Connection *conn, Eldbus_Mess * * @return pointer to unique name string or NULL or error. Returned value * remains valid until connection is free. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_connection_unique_name_get(Eldbus_Connection *conn) EINA_ARG_NONNULL(1); /** diff --git a/src/lib/eldbus/eldbus_freedesktop.h b/src/lib/eldbus/eldbus_freedesktop.h index b629379..43340a7 100644 --- a/src/lib/eldbus/eldbus_freedesktop.h +++ b/src/lib/eldbus/eldbus_freedesktop.h @@ -26,6 +26,10 @@ * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_name_request(Eldbus_Connection *conn, const char *bus, unsigned int flags, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); @@ -42,6 +46,10 @@ EAPI Eldbus_Pending *eldbus_name_request(Eldbus_Connection *conn, const char *bu * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_name_release(Eldbus_Connection *conn, const char *bus, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); @@ -53,6 +61,10 @@ EAPI Eldbus_Pending *eldbus_name_release(Eldbus_Connection *conn, const char *bu * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_name_owner_get(Eldbus_Connection *conn, const char *bus, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); @@ -64,6 +76,10 @@ EAPI Eldbus_Pending *eldbus_name_owner_get(Eldbus_Connection *conn, const char * * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_name_owner_has(Eldbus_Connection *conn, const char *bus, Eldbus_Message_Cb cb, const void *cb_data); @@ -74,6 +90,10 @@ EAPI Eldbus_Pending *eldbus_name_owner_has(Eldbus_Connection *conn, const char * * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_names_list(Eldbus_Connection *conn, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1); @@ -84,6 +104,10 @@ EAPI Eldbus_Pending *eldbus_names_list(Eldbus_Connection *conn, Eldbus_Message_C * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_names_activatable_list(Eldbus_Connection *conn, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1); @@ -94,6 +118,10 @@ EAPI Eldbus_Pending *eldbus_names_activatable_list(Eldbus_Connection *conn, Eldb * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_hello(Eldbus_Connection *conn, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1); @@ -110,6 +138,10 @@ EAPI Eldbus_Pending *eldbus_hello(Eldbus_Connection *conn, Eldbus_Message_Cb cb, * @param cb Callback to call when receiving answer. * @param cb_data Data passed to callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_name_start(Eldbus_Connection *conn, const char *bus, unsigned int flags, Eldbus_Message_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 2); @@ -134,6 +166,10 @@ typedef void (*Eldbus_Name_Owner_Changed_Cb)(void *data, const char *bus, const * @param cb callback * @param cb_data context data * @param allow_initial_call allow call callback with actual id of the bus + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_name_owner_changed_callback_add(Eldbus_Connection *conn, const char *bus, Eldbus_Name_Owner_Changed_Cb cb, const void *cb_data, Eina_Bool allow_initial_call) EINA_ARG_NONNULL(1, 2, 3); /** @@ -143,6 +179,10 @@ EAPI void eldbus_name_owner_changed_callback_add(Eldbus_Connect * @param bus name of bus * @param cb callback * @param cb_data context data + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_name_owner_changed_callback_del(Eldbus_Connection *conn, const char *bus, Eldbus_Name_Owner_Changed_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 2, 3); @@ -159,6 +199,10 @@ EAPI void eldbus_name_owner_changed_callback_del(Eldbus_Connect * @param cb Callback called when receiving an answer. * @param data Data passed to the callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_object_peer_ping(Eldbus_Object *obj, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -169,6 +213,10 @@ EAPI Eldbus_Pending *eldbus_object_peer_ping(Eldbus_Object *obj, Eldbus_M * @param cb Callback called when receiving an answer. * @param data Data passed to the callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_object_peer_machine_id_get(Eldbus_Object *obj, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -189,6 +237,10 @@ EAPI Eldbus_Pending *eldbus_object_peer_machine_id_get(Eldbus_Object *obj * @param cb Callback called when receiving an answer. * @param data Data passed to the callback. * @return The Eldbus_Pending corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_object_introspect(Eldbus_Object *obj, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); /** @@ -212,6 +264,10 @@ EAPI Eldbus_Pending *eldbus_object_introspect(Eldbus_Object *obj, Eldbus_ * EINA_FALSE if it will asynchrony get the properties. * You should listen for a ELDBUS_PROXY_EVENT_PROPERTY_LOADED * to know when properties finish to load. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_proxy_properties_monitor(Eldbus_Proxy *proxy, Eina_Bool enable) EINA_ARG_NONNULL(1); @@ -223,6 +279,10 @@ EAPI Eina_Bool eldbus_proxy_properties_monitor(Eldbus_Proxy *proxy, Eina_Bool en * @param cb The callback to be called when receiving an answer. * @param data Data to be passed to the callback. * @return Eldbus_Pending object corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_property_get(Eldbus_Proxy *proxy, const char *name, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -236,6 +296,10 @@ EAPI Eldbus_Pending *eldbus_proxy_property_get(Eldbus_Proxy *proxy, const * @param cb The callback to be called when receiving an answer. * @param data Data to be passed to the callback. * @return Eldbus_Pending object corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_property_set(Eldbus_Proxy *proxy, const char *name, const char *sig, const void *value, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2, 3, 4); @@ -246,6 +310,10 @@ EAPI Eldbus_Pending *eldbus_proxy_property_set(Eldbus_Proxy *proxy, const * @param cb The callback to be called when receiving an answer. * @param data Data to be passed to the callback. * @return Eldbus_Pending object corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_property_get_all(Eldbus_Proxy *proxy, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -256,6 +324,10 @@ EAPI Eldbus_Pending *eldbus_proxy_property_get_all(Eldbus_Proxy *proxy, E * @param cb The callback to be called when receiving the signal. * @param data Data to be passed to the callback. * @return Eldbus_Signal_Handler object representing a listener for "PropertiesChanged" signal. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_proxy_properties_changed_callback_add(Eldbus_Proxy *proxy, Eldbus_Signal_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -269,6 +341,10 @@ EAPI Eldbus_Signal_Handler *eldbus_proxy_properties_changed_callback_add(Eldbus_ * @param proxy The proxy object on which to do the query. * @param name The property name to get. * @return Cached value of property. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eldbus_proxy_property_local_get(Eldbus_Proxy *proxy, const char *name) EINA_ARG_NONNULL(1, 2); @@ -281,6 +357,10 @@ EAPI Eina_Value *eldbus_proxy_property_local_get(Eldbus_Proxy *proxy, * * @param proxy The proxy object on which to do the query. * @return A Eina_Hash with all cached properties + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_Hash *eldbus_proxy_property_local_get_all(Eldbus_Proxy *proxy) EINA_ARG_NONNULL(1); @@ -301,6 +381,10 @@ EAPI const Eina_Hash *eldbus_proxy_property_local_get_all(Eldbus_Proxy *pro * @param data The data to pass to the callback. * * @return A Eldbus_Pending object corresponding to the message sent. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_object_managed_objects_get(Eldbus_Object *obj, Eldbus_Message_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -311,6 +395,10 @@ EAPI Eldbus_Pending *eldbus_object_managed_objects_get(Eldbus_Object *obj * @param cb The callback to be called when receiving the signal. * @param cb_data Data to be passed to the callback. * @return Eldbus_Signal_Handler object representing a listener for "InterfacesAdded" signal. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_object_manager_interfaces_added(Eldbus_Object *obj, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1); @@ -321,6 +409,10 @@ EAPI Eldbus_Signal_Handler *eldbus_object_manager_interfaces_added(Eldbus_Object * @param cb The callback to be called when receiving the signal. * @param cb_data Data to be passed to the callback. * @return Eldbus_Signal_Handler object representing a listener for "InterfacesRemoved" signal. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_object_manager_interfaces_removed(Eldbus_Object *obj, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1); diff --git a/src/lib/eldbus/eldbus_message.h b/src/lib/eldbus/eldbus_message.h index 439ea46..4864ca0 100644 --- a/src/lib/eldbus/eldbus_message.h +++ b/src/lib/eldbus/eldbus_message.h @@ -13,6 +13,10 @@ * * @param msg The Eldbus_Message object. * @return The previous Eldbus_Message with incremented refcount. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_message_ref(Eldbus_Message *msg) EINA_ARG_NONNULL(1); @@ -23,6 +27,10 @@ EAPI Eldbus_Message *eldbus_message_ref(Eldbus_Message *msg) EINA_ARG_NON * freed. * * @param msg The Eldbus_Message object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_message_unref(Eldbus_Message *msg) EINA_ARG_NONNULL(1); @@ -31,6 +39,10 @@ EAPI void eldbus_message_unref(Eldbus_Message *msg) EINA_ARG_NO * * @param msg The Eldbus_Message object. * @return A string containing the dbus message path. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_path_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -39,6 +51,10 @@ EAPI const char *eldbus_message_path_get(const Eldbus_Message *msg) EI * * @param msg The Eldbus_Message object. * @return A string containing the dbus message interface. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_interface_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -47,6 +63,10 @@ EAPI const char *eldbus_message_interface_get(const Eldbus_Message *ms * * @param msg The Eldbus_Message object. * @return A string containing the dbus message member. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_member_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -55,6 +75,10 @@ EAPI const char *eldbus_message_member_get(const Eldbus_Message *msg) * * @param msg The Eldbus_Message object. * @return A string containing the dbus message destination. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_destination_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -63,6 +87,10 @@ EAPI const char *eldbus_message_destination_get(const Eldbus_Message * * * @param msg The Eldbus_Message object. * @return A string containing the dbus message sender. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_sender_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -71,6 +99,10 @@ EAPI const char *eldbus_message_sender_get(const Eldbus_Message *msg) * * @param msg The Eldbus_Message object. * @return A string containing the dbus message signature. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_message_signature_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -83,6 +115,10 @@ EAPI const char *eldbus_message_signature_get(const Eldbus_Message *ms * @param method name of the method to be called * * @return a new Eldbus_Message, free with eldbus_message_unref() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_message_method_call_new(const char *dest, const char *path, const char *iface, const char *method) EINA_ARG_NONNULL(1, 2, 3, 4) EINA_WARN_UNUSED_RESULT EINA_MALLOC; @@ -96,6 +132,10 @@ EAPI Eldbus_Message *eldbus_message_method_call_new(const char *dest, con * @return a new Eldbus_Message, free with eldbus_message_unref() * * @since 1.16 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_message_signal_new(const char *path, const char *interface, const char *name) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT; @@ -107,6 +147,10 @@ EAPI Eldbus_Message *eldbus_message_signal_new(const char *path, const char *int * @param error_msg the error message string * * @return a new Eldbus_Message, free with eldbus_message_unref() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_message_error_new(const Eldbus_Message *msg, const char *error_name, const char *error_msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -116,6 +160,10 @@ EAPI Eldbus_Message *eldbus_message_error_new(const Eldbus_Message *msg, * @param msg the message we're replying to * * @return new Eldbus_Message, free with eldbus_message_unref() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_message_method_return_new(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -132,6 +180,10 @@ EAPI Eldbus_Message *eldbus_message_method_return_new(const Eldbus_Messag * @param text Variable in which to store the error text or @c NULL if it's not * desired. * @return EINA_TRUE on success, else EINA_FALSE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_error_get(const Eldbus_Message *msg, const char **name, const char **text) EINA_ARG_NONNULL(1); @@ -151,6 +203,10 @@ EAPI Eina_Bool eldbus_message_error_get(const Eldbus_Message *msg, c * * @return EINA_TRUE if the arguments were read successfully and stored in the * respective pointer arguments. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_arguments_get(const Eldbus_Message *msg, const char *signature, ...) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -165,6 +221,10 @@ EAPI Eina_Bool eldbus_message_arguments_get(const Eldbus_Message *ms * * @return EINA_TRUE if the arguments were read successfully and stored in the * respective pointer arguments. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_arguments_vget(const Eldbus_Message *msg, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -183,6 +243,10 @@ EAPI Eina_Bool eldbus_message_arguments_vget(const Eldbus_Message *m * @param ... Values of each argument to append in param msg. * * @return EINA_TRUE on success, EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_arguments_append(Eldbus_Message *msg, const char *signature, ...) EINA_ARG_NONNULL(1, 2); @@ -196,6 +260,10 @@ EAPI Eina_Bool eldbus_message_arguments_append(Eldbus_Message *msg, * @see eldbus_message_arguments_append(). * * @return EINA_TRUE on success, EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_arguments_vappend(Eldbus_Message *msg, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2); @@ -221,11 +289,19 @@ EAPI Eina_Bool eldbus_message_arguments_vappend(Eldbus_Message *msg, * @param contained_signature signature of what iterator will store * * @return the new iterator + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message_Iter *eldbus_message_iter_container_new(Eldbus_Message_Iter *iter, int type, const char* contained_signature) EINA_ARG_NONNULL(1, 3) EINA_WARN_UNUSED_RESULT; /** * @brief Append a basic type into an Eldbus_Iterator. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_basic_append(Eldbus_Message_Iter *iter, int type, ...) EINA_ARG_NONNULL(1, 3); @@ -251,6 +327,10 @@ EAPI Eina_Bool eldbus_message_iter_basic_append(Eldbus_Message_Ite * @note This function doesn't support variant, use * eldbus_message_iter_container_new() instead to create the variant, fill * with data and close it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_arguments_append(Eldbus_Message_Iter *iter, const char *signature, ...) EINA_ARG_NONNULL(1, 2); @@ -272,6 +352,10 @@ EAPI Eina_Bool eldbus_message_iter_arguments_append(Eldbus_Message * @note This function don't support variant, use instead * eldbus_message_iter_container_new() to create the variant fill * data and close it. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_arguments_vappend(Eldbus_Message_Iter *iter, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2, 3); @@ -284,6 +368,10 @@ EAPI Eina_Bool eldbus_message_iter_arguments_vappend(Eldbus_Messag * @param array data to append * @param size of array * @return EINA_TRUE on success, else EINA_FALSE + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_fixed_array_append(Eldbus_Message_Iter *iter, int type, const void *array, unsigned int size) EINA_ARG_NONNULL(1, 3); @@ -294,16 +382,28 @@ EAPI Eina_Bool eldbus_message_iter_fixed_array_append(Eldbus_Messa * @param sub the iterator that will be closed * * @return EINA_FALSE if iterator was already close or if not enough memory + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_container_close(Eldbus_Message_Iter *iter, Eldbus_Message_Iter *sub) EINA_ARG_NONNULL(1, 2); /** * @brief Get the main Eldbus_Message_Iter from the Eldbus_Message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message_Iter *eldbus_message_iter_get(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; /** * @brief Get a basic type from Eldbus_Iterator. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_message_iter_basic_get(Eldbus_Message_Iter *iter, void *value) EINA_ARG_NONNULL(1, 2); @@ -314,6 +414,10 @@ EAPI void eldbus_message_iter_basic_get(Eldbus_Message_Iter * * @return A string containing the message iterator signature. * * @note The returned string must be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI char *eldbus_message_iter_signature_get(Eldbus_Message_Iter *iter) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -322,6 +426,10 @@ EAPI char *eldbus_message_iter_signature_get(Eldbus_Message_It * @param iter iterator * * @return if iterator was reach to end return EINA_FALSE + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_next(Eldbus_Message_Iter *iter) EINA_ARG_NONNULL(1); @@ -337,6 +445,9 @@ EAPI Eina_Bool eldbus_message_iter_next(Eldbus_Message_Iter *iter) * @return if iterator was reach to end or if type different of the type that * iterator points return EINA_FALSE * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_get_and_next(Eldbus_Message_Iter *iter, char signature, ...) EINA_ARG_NONNULL(1, 2, 3); @@ -362,6 +473,10 @@ EAPI Eina_Bool eldbus_message_iter_get_and_next(Eldbus_Message_Ite * @param value * @param n_elements * @return EINA_TRUE on success, else EINA_FALSE. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_fixed_array_get(Eldbus_Message_Iter *iter, int signature, void *value, int *n_elements) EINA_ARG_NONNULL(1, 3, 4); @@ -375,6 +490,10 @@ EAPI Eina_Bool eldbus_message_iter_fixed_array_get(Eldbus_Message_Iter *iter, in * @param ... pointers of where data will be stored * * @return EINA_FALSE if signature different from signature in iterator + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_arguments_get(Eldbus_Message_Iter *iter, const char *signature, ...) EINA_ARG_NONNULL(1, 2); @@ -388,6 +507,10 @@ EAPI Eina_Bool eldbus_message_iter_arguments_get(Eldbus_Message_It * @param ap va_list of the pointers of where data will be stored * * @return EINA_FALSE if signature different from signature in iterator + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_iter_arguments_vget(Eldbus_Message_Iter *iter, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2); @@ -404,6 +527,10 @@ EAPI Eina_Bool eldbus_message_iter_arguments_vget(Eldbus_Message_I * and can be deleted. * * @param iter the iterator to be deleted. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_message_iter_del(Eldbus_Message_Iter *iter) EINA_ARG_NONNULL(1); diff --git a/src/lib/eldbus/eldbus_message_eina_value.h b/src/lib/eldbus/eldbus_message_eina_value.h index 9e51ca9..e5ca1c2 100644 --- a/src/lib/eldbus/eldbus_message_eina_value.h +++ b/src/lib/eldbus/eldbus_message_eina_value.h @@ -9,6 +9,10 @@ * * @param msg Message * @return Eina_Value of type Eina_Value_Type_Struct + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eldbus_message_to_eina_value(const Eldbus_Message *msg) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -18,6 +22,10 @@ EAPI Eina_Value *eldbus_message_to_eina_value(const Eldbus_Message *msg) EINA_AR * * @param iter Message iterator * @return Eina_Value of type Eina_Value_Type_Struct + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Value *eldbus_message_iter_struct_like_to_eina_value(const Eldbus_Message_Iter *iter); @@ -28,6 +36,10 @@ EAPI Eina_Value *eldbus_message_iter_struct_like_to_eina_value(const Eldbus_Mess * @param msg where data will be put * @param value source of data, must be of type Eina_Value_Type_Struct * @return success or not + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_message_from_eina_value(const char *signature, Eldbus_Message *msg, const Eina_Value *value) EINA_ARG_NONNULL(1, 2, 3); diff --git a/src/lib/eldbus/eldbus_message_helper.h b/src/lib/eldbus/eldbus_message_helper.h index 5843182..8ec8129 100644 --- a/src/lib/eldbus/eldbus_message_helper.h +++ b/src/lib/eldbus/eldbus_message_helper.h @@ -23,6 +23,10 @@ typedef void (*Eldbus_Dict_Cb_Get)(void *data, const void *key, Eldbus_Message_I * @param signature of entry, example: "sv" * @param cb callback that will be called in each entry * @param data context data + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_message_iter_dict_iterate(Eldbus_Message_Iter *dict, const char *signature, Eldbus_Dict_Cb_Get cb, const void *data) EINA_ARG_NONNULL(1, 2, 3); diff --git a/src/lib/eldbus/eldbus_object.h b/src/lib/eldbus/eldbus_object.h index 297cb0b..ec1c186 100644 --- a/src/lib/eldbus/eldbus_object.h +++ b/src/lib/eldbus/eldbus_object.h @@ -15,6 +15,10 @@ * @param bus name of bus or unique-id of who listens for calls of this object * @param path object path of this object * @return The corresponding Eldbus_Object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Object *eldbus_object_get(Eldbus_Connection *conn, const char *bus, const char *path) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT; @@ -23,6 +27,10 @@ EAPI Eldbus_Object *eldbus_object_get(Eldbus_Connection *conn, const char *bus, * * @param obj An Eldbus_Object. * @return The same Eldbus_Object with an increased refcount. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Object *eldbus_object_ref(Eldbus_Object *obj) EINA_ARG_NONNULL(1); @@ -31,6 +39,10 @@ EAPI Eldbus_Object *eldbus_object_ref(Eldbus_Object *obj) EINA_ARG_NONNULL(1); * If reference == 0 object will be freed and all its children. * * @param obj An Eldbus_Object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_object_unref(Eldbus_Object *obj) EINA_ARG_NONNULL(1); @@ -40,6 +52,10 @@ EAPI void eldbus_object_unref(Eldbus_Object *obj) EINA_ARG_NONNULL(1); * @param obj object that you want to monitor * @param cb callback that will be executed * @param data passed to callback + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_object_free_cb_add(Eldbus_Object *obj, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -49,6 +65,10 @@ EAPI void eldbus_object_free_cb_add(Eldbus_Object *obj, Eldbus_Free_Cb * @param obj Object monitored. * @param cb Callback that was registered. * @param data Data that was passed to callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_object_free_cb_del(Eldbus_Object *obj, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -132,6 +152,10 @@ typedef void (*Eldbus_Object_Event_Cb)(void *data, Eldbus_Object *obj, void *eve * @param type The type of the event. * @param cb The callback to call. * @param cb_data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_object_event_callback_add(Eldbus_Object *obj, Eldbus_Object_Event_Type type, Eldbus_Object_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -142,6 +166,10 @@ EAPI void eldbus_object_event_callback_add(Eldbus_Object *obj, * @param type The type of the event. * @param cb The callback to call. * @param cb_data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_object_event_callback_del(Eldbus_Object *obj, Eldbus_Object_Event_Type type, Eldbus_Object_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -150,6 +178,10 @@ EAPI void eldbus_object_event_callback_del(Eldbus_Object *obj, * * @param obj The Eldbus_Object. * @return The corresponding Eldbus_Connection object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Connection *eldbus_object_connection_get(const Eldbus_Object *obj) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -158,6 +190,10 @@ EAPI Eldbus_Connection *eldbus_object_connection_get(const Eldbus_Object *ob * * @param obj The Eldbus_Object. * @return A string corresponding to the Eldbus_Object name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_object_bus_name_get(const Eldbus_Object *obj) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -166,6 +202,10 @@ EAPI const char *eldbus_object_bus_name_get(const Eldbus_Object *obj) * * @param obj The Eldbus_Object. * @return A string corresponding to the Eldbus_Object path. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_object_path_get(const Eldbus_Object *obj) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -180,6 +220,10 @@ EAPI const char *eldbus_object_path_get(const Eldbus_Object *obj) EINA * @param timeout timeout in milliseconds, -1 to default internal value or * ELDBUS_TIMEOUT_INFINITE for no timeout * @return A Eldbus_Pending object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_object_send(Eldbus_Object *obj, Eldbus_Message *msg, Eldbus_Message_Cb cb, const void *cb_data, double timeout) EINA_ARG_NONNULL(1, 2); @@ -192,6 +236,10 @@ EAPI Eldbus_Pending *eldbus_object_send(Eldbus_Object *obj, Eldbus_Messag * @param cb callback that will be called when this signal is received * @param cb_data data that will be passed to callback * @return A listener to the desired signal. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_object_signal_handler_add(Eldbus_Object *obj, const char *interface, const char *member, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 4); @@ -203,6 +251,10 @@ EAPI Eldbus_Signal_Handler *eldbus_object_signal_handler_add(Eldbus_Object *obj, * @param member Name of the method to be called. * * @return a new Eldbus_Message, free with eldbus_message_unref() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_object_method_call_new(Eldbus_Object *obj, const char *interface, const char *member) EINA_ARG_NONNULL(1, 2, 3) EINA_WARN_UNUSED_RESULT; diff --git a/src/lib/eldbus/eldbus_pending.h b/src/lib/eldbus/eldbus_pending.h index 8cb8e96..561e2e0 100644 --- a/src/lib/eldbus/eldbus_pending.h +++ b/src/lib/eldbus/eldbus_pending.h @@ -14,6 +14,10 @@ * @param pending The Eldbus_Pending object on which the data is set. * @param key A string corresponding to the key associated with the data. * @param data The data to set to the Eldbus_Pending object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_pending_data_set(Eldbus_Pending *pending, const char *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -23,6 +27,10 @@ EAPI void eldbus_pending_data_set(Eldbus_Pending *pending, cons * @param pending The Eldbus_Pending object on which the data is set. * @param key A string corresponding to the key associated with the data. * @return The data set to the Eldbus_Pending object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_pending_data_get(const Eldbus_Pending *pending, const char *key) EINA_ARG_NONNULL(1, 2); @@ -31,6 +39,10 @@ EAPI void *eldbus_pending_data_get(const Eldbus_Pending *pending * * @param pending The Eldbus_Pending object on which the data is set. * @param key A string corresponding to the key associated with the data. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_pending_data_del(Eldbus_Pending *pending, const char *key) EINA_ARG_NONNULL(1, 2); @@ -38,6 +50,10 @@ EAPI void *eldbus_pending_data_del(Eldbus_Pending *pending, cons * @brief Cancel the pending message. * * @param pending The Eldbus_Pending object corresponding to the pending message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_pending_cancel(Eldbus_Pending *pending) EINA_ARG_NONNULL(1); @@ -46,6 +62,10 @@ EAPI void eldbus_pending_cancel(Eldbus_Pending *pending) EINA_A * * @param pending The Eldbus_Pending object. * @return A string corresponding to the destination of the message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_pending_destination_get(const Eldbus_Pending *pending) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -54,6 +74,10 @@ EAPI const char *eldbus_pending_destination_get(const Eldbus_Pending * * * @param pending The Eldbus_Pending object. * @return A string corresponding to the path of the message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_pending_path_get(const Eldbus_Pending *pending) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -62,6 +86,10 @@ EAPI const char *eldbus_pending_path_get(const Eldbus_Pending *pending * * @param pending The Eldbus_Pending object. * @return A string corresponding to the interface of the message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_pending_interface_get(const Eldbus_Pending *pending) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -70,6 +98,10 @@ EAPI const char *eldbus_pending_interface_get(const Eldbus_Pending *pe * * @param pending The Eldbus_Pending object. * @return A string corresponding to the method of the message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_pending_method_get(const Eldbus_Pending *pending) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -79,6 +111,10 @@ EAPI const char *eldbus_pending_method_get(const Eldbus_Pending *pendi * @param pending The Eldbus_Pending object on which the callback is registered. * @param cb The callback to register. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_pending_free_cb_add(Eldbus_Pending *pending, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -88,6 +124,10 @@ EAPI void eldbus_pending_free_cb_add(Eldbus_Pending *pending, E * @param pending The Eldbus_Pending object on which the callback was registered. * @param cb The callback that was registered. * @param data The data passed to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_pending_free_cb_del(Eldbus_Pending *pending, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); diff --git a/src/lib/eldbus/eldbus_proxy.h b/src/lib/eldbus/eldbus_proxy.h index b010aee..a35d6c9 100644 --- a/src/lib/eldbus/eldbus_proxy.h +++ b/src/lib/eldbus/eldbus_proxy.h @@ -14,6 +14,10 @@ * @param obj The Eldbus_Object on which to do the query. * @param interface The interface name of the proxy. * @return The corresponding Eldbus_Proxy object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Proxy *eldbus_proxy_get(Eldbus_Object *obj, const char *interface) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -22,6 +26,10 @@ EAPI Eldbus_Proxy *eldbus_proxy_get(Eldbus_Object *obj, const char *int * * @param proxy The Eldbus_Proxy on which to increase the refcount. * @return The Eldbus_Proxy with an increased refcount. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Proxy *eldbus_proxy_ref(Eldbus_Proxy *proxy) EINA_ARG_NONNULL(1); @@ -30,6 +38,10 @@ EAPI Eldbus_Proxy *eldbus_proxy_ref(Eldbus_Proxy *proxy) EINA_ARG_NONNU * If reference == 0 proxy will be freed and all your children. * * @param proxy The Eldbus_Proxy on which to decrease the refcount. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_unref(Eldbus_Proxy *proxy) EINA_ARG_NONNULL(1); @@ -38,6 +50,10 @@ EAPI void eldbus_proxy_unref(Eldbus_Proxy *proxy) EINA_ARG_NONN * * @param proxy The Eldbus_Proxy on which to do the query. * @return The corresponding Eldbus_Object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Object *eldbus_proxy_object_get(const Eldbus_Proxy *proxy) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -46,6 +62,10 @@ EAPI Eldbus_Object *eldbus_proxy_object_get(const Eldbus_Proxy *proxy) E * * @param proxy The Eldbus_Proxy on which to do the query. * @return The string corresponding to the interface name. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *eldbus_proxy_interface_get(const Eldbus_Proxy *proxy) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -55,6 +75,10 @@ EAPI const char *eldbus_proxy_interface_get(const Eldbus_Proxy *proxy) * @param proxy The Eldbus_Proxy on which to set the data. * @param key A string to which the data will be associated. * @param data The data to set to the proxy object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_data_set(Eldbus_Proxy *proxy, const char *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -64,6 +88,10 @@ EAPI void eldbus_proxy_data_set(Eldbus_Proxy *proxy, const char * @param proxy The Eldbus_Proxy on which to get the data. * @param key The string to which the data is associated. * @return The data set to the proxy object associated with the provided key. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_proxy_data_get(const Eldbus_Proxy *proxy, const char *key) EINA_ARG_NONNULL(1, 2); @@ -72,6 +100,10 @@ EAPI void *eldbus_proxy_data_get(const Eldbus_Proxy *proxy, cons * * @param proxy The Eldbus_Proxy on which to delete the data. * @param key The string to which the data is associated. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_proxy_data_del(Eldbus_Proxy *proxy, const char *key) EINA_ARG_NONNULL(1, 2); @@ -82,6 +114,10 @@ EAPI void *eldbus_proxy_data_del(Eldbus_Proxy *proxy, const char * @param proxy The Eldbus_Proxy on which to add the callback. * @param cb The callback to add. * @param data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_free_cb_add(Eldbus_Proxy *proxy, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -91,6 +127,10 @@ EAPI void eldbus_proxy_free_cb_add(Eldbus_Proxy *proxy, Eldbus_ * @param proxy The Eldbus_Proxy on which to delete the callback. * @param cb The callback to delete. * @param data The data passed to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_free_cb_del(Eldbus_Proxy *proxy, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); @@ -100,6 +140,10 @@ EAPI void eldbus_proxy_free_cb_del(Eldbus_Proxy *proxy, Eldbus_ * @param proxy The Eldbus_Proxy on which to call the method. * @param member The name of the method to invoke. * @return An Eldbus_Message object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_proxy_method_call_new(Eldbus_Proxy *proxy, const char *member) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -113,6 +157,10 @@ EAPI Eldbus_Message *eldbus_proxy_method_call_new(Eldbus_Proxy *proxy, co * @param timeout timeout in milliseconds, -1 to default internal value or * ELDBUS_TIMEOUT_INFINITE for no timeout * @return A Eldbus_Pending object on the sent message. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_send(Eldbus_Proxy *proxy, Eldbus_Message *msg, Eldbus_Message_Cb cb, const void *cb_data, double timeout) EINA_ARG_NONNULL(1, 2); @@ -127,6 +175,10 @@ EAPI Eldbus_Pending *eldbus_proxy_send(Eldbus_Proxy *proxy, Eldbus_Messag * @return The reply message, error message or NULL. * The returned Eldbus_Message need to be unref after read. * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_proxy_send_and_block(Eldbus_Proxy *proxy, Eldbus_Message *msg, double timeout) EINA_ARG_NONNULL(1, 2); @@ -147,6 +199,10 @@ EAPI Eldbus_Message *eldbus_proxy_send_and_block(Eldbus_Proxy *proxy, Eld * * @note This function only support basic type to complex types use * eldbus_message_iter_* functions. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_call(Eldbus_Proxy *proxy, const char *member, Eldbus_Message_Cb cb, const void *cb_data, double timeout, const char *signature, ...) EINA_ARG_NONNULL(1, 2, 6); @@ -166,6 +222,10 @@ EAPI Eldbus_Pending *eldbus_proxy_call(Eldbus_Proxy *proxy, const char *m * * @note This function only support basic type to complex types use * eldbus_message_iter_* functions. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Pending *eldbus_proxy_vcall(Eldbus_Proxy *proxy, const char *member, Eldbus_Message_Cb cb, const void *cb_data, double timeout, const char *signature, va_list ap) EINA_ARG_NONNULL(1, 2, 6); @@ -177,6 +237,10 @@ EAPI Eldbus_Pending *eldbus_proxy_vcall(Eldbus_Proxy *proxy, const char * * @param cb callback that will be called when this signal is received * @param cb_data data that will be passed to callback * @return A listener to the desired signal. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_proxy_signal_handler_add(Eldbus_Proxy *proxy, const char *member, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -246,6 +310,10 @@ typedef void (*Eldbus_Proxy_Event_Cb)(void *data, Eldbus_Proxy *proxy, void *eve * @param type The type of the event to register an callback on. * @param cb The callback function to register. * @param cb_data The data to pass to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_event_callback_add(Eldbus_Proxy *proxy, Eldbus_Proxy_Event_Type type, Eldbus_Proxy_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); @@ -256,6 +324,10 @@ EAPI void eldbus_proxy_event_callback_add(Eldbus_Proxy *proxy, Eldbus_Proxy_Even * @param type The type of the event the callback was registered on. * @param cb The callback function to delete. * @param cb_data The data passed to the callback. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_proxy_event_callback_del(Eldbus_Proxy *proxy, Eldbus_Proxy_Event_Type type, Eldbus_Proxy_Event_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 3); diff --git a/src/lib/eldbus/eldbus_service.h b/src/lib/eldbus/eldbus_service.h index ba5a9a3..cd47424 100644 --- a/src/lib/eldbus/eldbus_service.h +++ b/src/lib/eldbus/eldbus_service.h @@ -124,6 +124,10 @@ typedef struct _Eldbus_Service_Interface_Desc2 * @param desc description of interface * * @return Interface + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Service_Interface *eldbus_service_interface_register(Eldbus_Connection *conn, const char *path, const Eldbus_Service_Interface_Desc *desc) EINA_ARG_NONNULL(1, 2, 3); @@ -138,6 +142,10 @@ EAPI Eldbus_Service_Interface *eldbus_service_interface_register(Eldbus_Connecti * @since 1.9 * * @return Interface + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Service_Interface * eldbus_service_interface_fallback_register(Eldbus_Connection *conn, const char *path, const Eldbus_Service_Interface_Desc *desc) EINA_ARG_NONNULL(1, 2, 3); @@ -155,6 +163,10 @@ eldbus_service_interface_fallback_register(Eldbus_Connection *conn, const char * * @since 1.11 * * @return Interface + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Service_Interface *eldbus_service_interface_register2(Eldbus_Connection *conn, const char *path, const Eldbus_Service_Interface_Desc2 *desc) EINA_ARG_NONNULL(1, 2, 3); @@ -173,6 +185,10 @@ EAPI Eldbus_Service_Interface *eldbus_service_interface_register2(Eldbus_Connect * @since 1.11 * * @return Interface + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Service_Interface * eldbus_service_interface_fallback_register2(Eldbus_Connection *conn, const char *path, const Eldbus_Service_Interface_Desc2 *desc) EINA_ARG_NONNULL(1, 2, 3); @@ -182,12 +198,20 @@ eldbus_service_interface_fallback_register2(Eldbus_Connection *conn, const char * @brief Unregister a interface. * Note: This doesn't unregister the object path if interface count reaches 0. * Use eldbus_service_object_unregister() to unregister the object. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_service_interface_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); /** * @brief Unregister all interfaces of the object path that this interface belongs * and the object path. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_service_object_unregister(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); EAPI Eldbus_Connection *eldbus_service_connection_get(const Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -201,6 +225,10 @@ EAPI const char *eldbus_service_object_path_get(const Eldbus_Service_Interface * * @param iface interface of the signal * @param signal_id id of signal * @param ... values that will be send on signal + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_service_signal_emit(const Eldbus_Service_Interface *iface, unsigned int signal_id, ...) EINA_ARG_NONNULL(1); @@ -212,6 +240,10 @@ EAPI Eina_Bool eldbus_service_signal_emit(const Eldbus_Service_Interface *iface, * * @param iface interface of the signal * @param signal_id id of signal + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Message *eldbus_service_signal_new(const Eldbus_Service_Interface *iface, unsigned int signal_id) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; @@ -221,6 +253,10 @@ EAPI Eldbus_Message *eldbus_service_signal_new(const Eldbus_Service_Interface *i * On success this will call eldbus_message_unref() on the @param signal_msg, * which is the intended behavior in 99% of the cases. Remember to increment * the refcount if you want to keep it alive. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_service_signal_send(const Eldbus_Service_Interface *iface, Eldbus_Message *signal_msg) EINA_ARG_NONNULL(1, 2); @@ -232,6 +268,10 @@ EAPI Eina_Bool eldbus_service_signal_send(const Eldbus_Service_Interface *iface, * be stored * @param key to identify data * @param data + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_service_object_data_set(Eldbus_Service_Interface *iface, const char *key, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -242,6 +282,10 @@ EAPI void eldbus_service_object_data_set(Eldbus_Service_Interface *iface, const * @param key that identify data * * @return pointer to data if found otherwise NULL + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_service_object_data_get(const Eldbus_Service_Interface *iface, const char *key) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; @@ -252,6 +296,10 @@ EAPI void *eldbus_service_object_data_get(const Eldbus_Service_Interface *iface, * @param key that identify data * * @return pointer to data if found otherwise NULL + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *eldbus_service_object_data_del(Eldbus_Service_Interface *iface, const char *key) EINA_ARG_NONNULL(1, 2); @@ -262,6 +310,10 @@ EAPI void *eldbus_service_object_data_del(Eldbus_Service_Interface *iface, const * * @param iface Interface containing the changed property * @param name Property name + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_service_property_changed(const Eldbus_Service_Interface *iface, const char *name) EINA_ARG_NONNULL(1, 2); @@ -272,6 +324,10 @@ EAPI Eina_Bool eldbus_service_property_invalidate_set(const Eldbus_Service_Inter * * @param iface ObjectManager will be attach in object path of this interface. * @return EINA_TRUE if success + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_service_object_manager_attach(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); @@ -280,6 +336,10 @@ EAPI Eina_Bool eldbus_service_object_manager_attach(Eldbus_Service_Interface *if * * @param iface ObjectManager of object path of this interface will be detach. * @return EINA_TRUE if success + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_service_object_manager_detach(Eldbus_Service_Interface *iface) EINA_ARG_NONNULL(1); diff --git a/src/lib/eldbus/eldbus_signal_handler.h b/src/lib/eldbus/eldbus_signal_handler.h index b842bfc..50b39de 100644 --- a/src/lib/eldbus/eldbus_signal_handler.h +++ b/src/lib/eldbus/eldbus_signal_handler.h @@ -18,17 +18,29 @@ * @param member name of the signal * @param cb callback that will be called when this signal is received * @param cb_data data that will be passed to callback + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_signal_handler_add(Eldbus_Connection *conn, const char *sender, const char *path, const char *interface, const char *member, Eldbus_Signal_Cb cb, const void *cb_data) EINA_ARG_NONNULL(1, 6); /** * @brief Increase signal handler reference. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eldbus_Signal_Handler *eldbus_signal_handler_ref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); /** * @brief Decrease signal handler reference. * If reference == 0 signal handler will be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_signal_handler_unref(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); @@ -36,6 +48,10 @@ EAPI void eldbus_signal_handler_unref(Eldbus_Signal_Handler *ha * @brief Decrease signal handler reference like eldbus_signal_handler_unref() * but if reference > 0 this signal handler will stop listening to signals. In other * words it will be canceled but memory will not be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_signal_handler_del(Eldbus_Signal_Handler *handler) EINA_ARG_NONNULL(1); @@ -54,6 +70,10 @@ EAPI void eldbus_signal_handler_del(Eldbus_Signal_Handler *hand * * @note For more information: * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_signal_handler_match_extra_set(Eldbus_Signal_Handler *sh, ...) EINA_ARG_NONNULL(1) EINA_SENTINEL; @@ -72,16 +92,28 @@ EAPI Eina_Bool eldbus_signal_handler_match_extra_set(Eldbus_Signal_H * * @note To information: * http://dbus.freedesktop.org/doc/dbus-specification.html#message-bus-routing-match-rules + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool eldbus_signal_handler_match_extra_vset(Eldbus_Signal_Handler *sh, va_list ap) EINA_ARG_NONNULL(1); /** * @brief Add a callback function to be called when signal handler will be freed. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_signal_handler_free_cb_add(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); /** * @brief Remove callback registered in eldbus_signal_handler_free_cb_add(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void eldbus_signal_handler_free_cb_del(Eldbus_Signal_Handler *handler, Eldbus_Free_Cb cb, const void *data) EINA_ARG_NONNULL(1, 2); diff --git a/src/lib/embryo/Embryo.h b/src/lib/embryo/Embryo.h index f4d11ad..1a615c9 100644 --- a/src/lib/embryo/Embryo.h +++ b/src/lib/embryo/Embryo.h @@ -466,6 +466,8 @@ extern "C" { /** + * @internal + * * Initialises the Embryo library. * @return The number of times the library has been initialised without being * shut down. @@ -474,6 +476,8 @@ extern "C" { EAPI int embryo_init(void); /** + * @internal + * * Shuts down the Embryo library. * @return The number of times the library has been initialised without being * shutdown. @@ -490,6 +494,8 @@ EAPI int embryo_shutdown(void); */ /** + * @internal + * * Creates a new Embryo program, with bytecode data that can be freed. * @param data Pointer to the bytecode of the program. * @param size Number of bytes of bytecode. @@ -499,6 +505,8 @@ EAPI int embryo_shutdown(void); EAPI Embryo_Program *embryo_program_new(void *data, int size); /** + * @internal + * * Creates a new Embryo program, with bytecode data that cannot be * freed. * @param data Pointer to the bytecode of the program. @@ -509,6 +517,8 @@ EAPI Embryo_Program *embryo_program_new(void *data, int size); EAPI Embryo_Program *embryo_program_const_new(void *data, int size); /** + * @internal + * * Creates a new Embryo program based on the bytecode data stored in the * given file. * @param file Filename of the given file. @@ -518,6 +528,8 @@ EAPI Embryo_Program *embryo_program_const_new(void *data, int size); EAPI Embryo_Program *embryo_program_load(const char *file); /** + * @internal + * * Frees the given Embryo program. * @param ep The given program. * @ingroup Embryo_Program_Creation_Group @@ -534,6 +546,8 @@ EAPI void embryo_program_free(Embryo_Program *ep); /** * @internal + * + * @internal * @defgroup Embryo_Func_Group Function Functions * @ingroup Embryo * @@ -549,6 +563,8 @@ EAPI void embryo_program_native_call_add(Embryo_Program *ep, const c /** * @internal + * + * @internal * @defgroup Embryo_Program_VM_Group Virtual Machine Functions * @ingroup Embryo * @@ -570,6 +586,8 @@ EAPI void embryo_program_native_call_add(Embryo_Program *ep, const c EAPI void embryo_program_vm_reset(Embryo_Program *ep); /** + * @internal + * * Starts a new virtual machine session for the given program. * * See @ref Embryo_Program_VM_Group for more information about how this works. @@ -580,6 +598,8 @@ EAPI void embryo_program_vm_reset(Embryo_Program *ep); EAPI void embryo_program_vm_push(Embryo_Program *ep); /** + * @internal + * * Frees the current virtual machine session associated with the given program. * * See @ref Embryo_Program_VM_Group for more information about how this works. @@ -600,6 +620,8 @@ EAPI void embryo_program_vm_pop(Embryo_Program *ep); /** * @internal + * + * @internal * @defgroup Embryo_Swap_Group Byte Swapping Functions * @ingroup Embryo * @@ -611,6 +633,8 @@ EAPI void embryo_program_vm_pop(Embryo_Program *ep); EAPI void embryo_swap_16(unsigned short *v); /** + * @internal + * * Ensures that the given unsigned integer is in the small endian * format. * @param v Pointer to the given integer. @@ -619,6 +643,8 @@ EAPI void embryo_swap_16(unsigned short *v); EAPI void embryo_swap_32(unsigned int *v); /** + * @internal + * * Returns the function in the given program with the given name. * @param ep The given program. * @param name The given function name. @@ -639,6 +665,8 @@ EAPI Embryo_Function embryo_program_function_find(Embryo_Program *ep, const cha /** * @internal + * + * @internal * @defgroup Embryo_Public_Variable_Group Public Variable Access Functions * @ingroup Embryo * @@ -649,6 +677,8 @@ EAPI Embryo_Function embryo_program_function_find(Embryo_Program *ep, const cha EAPI Embryo_Cell embryo_program_variable_find(Embryo_Program *ep, const char *name); /** + * @internal + * * Retrieves the number of public variables in the given program. * @param ep The given program. * @return The number of public variables. @@ -657,6 +687,8 @@ EAPI Embryo_Cell embryo_program_variable_find(Embryo_Program *ep, const cha EAPI int embryo_program_variable_count_get(Embryo_Program *ep); /** + * @internal + * * Retrieves the location of the public variable in the given program * with the given identifier. * @param ep The given program. @@ -676,6 +708,8 @@ EAPI Embryo_Cell embryo_program_variable_get(Embryo_Program *ep, int num); /** * @internal + * + * @internal * @defgroup Embryo_Error_Group Error Functions * @ingroup Embryo * @@ -684,6 +718,8 @@ EAPI Embryo_Cell embryo_program_variable_get(Embryo_Program *ep, int num); EAPI void embryo_program_error_set(Embryo_Program *ep, Embryo_Error error); /** + * @internal + * * Retrieves the current error code for the given program. * @param ep The given program. * @return The current error code. @@ -700,6 +736,8 @@ EAPI Embryo_Error embryo_program_error_get(Embryo_Program *ep); /** * @internal + * + * @internal * @defgroup Embryo_Program_Data_Group Program Data Functions * @ingroup Embryo * @@ -709,6 +747,8 @@ EAPI Embryo_Error embryo_program_error_get(Embryo_Program *ep); EAPI void embryo_program_data_set(Embryo_Program *ep, void *data); /** + * @internal + * * Retrieves the data associated to the given program. * @param ep The given program. * @ingroup Embryo_Program_Data_Group @@ -716,6 +756,8 @@ EAPI void embryo_program_data_set(Embryo_Program *ep, void *data); EAPI void *embryo_program_data_get(Embryo_Program *ep); /** + * @internal + * * Retrieves a string describing the given error code. * @param error The given error code. * @return String describing the given error code. If the given code is not @@ -734,6 +776,8 @@ EAPI const char *embryo_error_string_get(Embryo_Error error); /** * @internal + * + * @internal * @defgroup Embryo_Data_String_Group Embryo Data String Functions * @ingroup Embryo * @@ -742,6 +786,8 @@ EAPI const char *embryo_error_string_get(Embryo_Error error); EAPI int embryo_data_string_length_get(Embryo_Program *ep, Embryo_Cell *str_cell); /** + * @internal + * * Copies the string starting at the given cell to the given buffer. * @param ep The program the cell is part of. * @param str_cell Pointer to the first cell of the string. @@ -751,6 +797,8 @@ EAPI int embryo_data_string_length_get(Embryo_Program *ep, Embryo_C EAPI void embryo_data_string_get(Embryo_Program *ep, Embryo_Cell *str_cell, char *dst); /** + * @internal + * * Copies string in the given buffer into the virtual machine memory * starting at the given cell. * @param ep The program the cell is part of. @@ -761,6 +809,8 @@ EAPI void embryo_data_string_get(Embryo_Program *ep, Embryo_Cell *st EAPI void embryo_data_string_set(Embryo_Program *ep, const char *src, Embryo_Cell *str_cell); /** + * @internal + * * Retreives a pointer to the address in the virtual machine given by the * given cell. * @param ep The program whose virtual machine address is being queried. @@ -782,6 +832,8 @@ EAPI Embryo_Cell *embryo_data_address_get(Embryo_Program *ep, Embryo_Cell ad /** * @internal + * + * @internal * @defgroup Embryo_Heap_Group Heap Functions * @ingroup Embryo * @@ -792,6 +844,8 @@ EAPI Embryo_Cell *embryo_data_address_get(Embryo_Program *ep, Embryo_Cell ad EAPI Embryo_Cell embryo_data_heap_push(Embryo_Program *ep, int cells); /** + * @internal + * * Decreases the size of the heap of the given virtual machine down to the * given size. * @param ep The program with the given virtual machine. @@ -809,6 +863,8 @@ EAPI void embryo_data_heap_pop(Embryo_Program *ep, Embryo_Cell down_ /** * @internal + * + * @internal * @defgroup Embryo_Run_Group Program Run Functions * @ingroup Embryo * @@ -818,6 +874,8 @@ EAPI void embryo_data_heap_pop(Embryo_Program *ep, Embryo_Cell down_ EAPI int embryo_program_recursion_get(Embryo_Program *ep); /** + * @internal + * * Runs the given function of the given Embryo program in the current * virtual machine. The parameter @p fn can be found using * @ref embryo_program_function_find. @@ -838,6 +896,8 @@ EAPI int embryo_program_recursion_get(Embryo_Program *ep); EAPI Embryo_Status embryo_program_run(Embryo_Program *ep, Embryo_Function func); /** + * @internal + * * Retreives the return value of the last called function of the given * program. * @param ep The given program. @@ -848,6 +908,8 @@ EAPI Embryo_Status embryo_program_run(Embryo_Program *ep, Embryo_Function fun EAPI Embryo_Cell embryo_program_return_value_get(Embryo_Program *ep); /** + * @internal + * * Sets the maximum number of abstract machine cycles any given program run * can execute before being put to sleep and returning. * @@ -898,6 +960,8 @@ EAPI Embryo_Cell embryo_program_return_value_get(Embryo_Program *ep); EAPI void embryo_program_max_cycle_run_set(Embryo_Program *ep, int max); /** + * @internal + * * Retreives the maximum number of abstract machine cycles a program is allowed * to run. * @param ep The given program. @@ -922,6 +986,8 @@ EAPI int embryo_program_max_cycle_run_get(Embryo_Program *ep); /** * @internal + * + * @internal * @defgroup Embryo_Parameter_Group Function Parameter Functions * @ingroup Embryo * @@ -930,6 +996,8 @@ EAPI int embryo_program_max_cycle_run_get(Embryo_Program *ep); EAPI int embryo_parameter_cell_push(Embryo_Program *ep, Embryo_Cell cell); /** + * @internal + * * Pushes a string onto the function stack to use as a parameter for the * next function that is called in the given program. * @param ep The given program. @@ -940,6 +1008,8 @@ EAPI int embryo_parameter_cell_push(Embryo_Program *ep, Embryo_Cell EAPI int embryo_parameter_string_push(Embryo_Program *ep, const char *str); /** + * @internal + * * Pushes an array of Embryo_Cells onto the function stack to be used as * parameters for the next function that is called in the given program. * @param ep The given program. diff --git a/src/lib/emotion/Emotion.h b/src/lib/emotion/Emotion.h index 1f10fc9..98b464b 100644 --- a/src/lib/emotion/Emotion.h +++ b/src/lib/emotion/Emotion.h @@ -375,6 +375,8 @@ extern "C" { */ /** + * @internal + * * @brief Initialise Emotion library * * Initialise needed libraries like eina ecore eet @@ -383,6 +385,8 @@ extern "C" { EAPI Eina_Bool emotion_init(void); /** + * @internal + * * @brief Shutdown Emotion library * * Proper shutdown of all loaded modules and initialised libraries. @@ -390,6 +394,8 @@ EAPI Eina_Bool emotion_init(void); EAPI Eina_Bool emotion_shutdown(void); /** + * @internal + * * @brief Add an emotion object to the canvas. * * @param evas The canvas where the object will be added to. @@ -417,6 +423,8 @@ EAPI Eina_Bool emotion_shutdown(void); EAPI Evas_Object *emotion_object_add (Evas *evas); /** + * @internal + * * @brief Set borders for the emotion object. * * @param obj The emotion object where borders are being set. @@ -447,6 +455,8 @@ EAPI Evas_Object *emotion_object_add (Evas *evas); EAPI void emotion_object_border_set(Evas_Object *obj, int l, int r, int t, int b); /** + * @internal + * * @brief Get the borders set for the emotion object. * * @param obj The emotion object from which the borders are being retrieved. @@ -462,6 +472,8 @@ EAPI void emotion_object_border_set(Evas_Object *obj, int l, int r, int t, int b EAPI void emotion_object_border_get(const Evas_Object *obj, int *l, int *r, int *t, int *b); /** + * @internal + * * @brief Set a color for the background rectangle of this emotion object. * * @param obj The emotion object where the background color is being set. @@ -483,6 +495,8 @@ EAPI void emotion_object_border_get(const Evas_Object *obj, int *l, int *r, int EAPI void emotion_object_bg_color_set(Evas_Object *obj, int r, int g, int b, int a); /** + * @internal + * * @brief Get the background color set for the emotion object. * * @param obj The emotion object from which the background color is being retrieved. @@ -498,6 +512,8 @@ EAPI void emotion_object_bg_color_set(Evas_Object *obj, int r, int g, int b, int EAPI void emotion_object_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a); /** + * @internal + * * @brief Set whether emotion should keep the aspect ratio of the video. * * @param obj The emotion object where to set the aspect. @@ -542,6 +558,8 @@ EAPI void emotion_object_bg_color_get(const Evas_Object *obj, int *r, int *g, in EAPI void emotion_object_keep_aspect_set(Evas_Object *obj, Emotion_Aspect a); /** + * @internal + * * @brief Get the current emotion aspect ratio policy. * * @param obj The emotion object from which we are fetching the aspect ratio @@ -555,6 +573,8 @@ EAPI void emotion_object_keep_aspect_set(Evas_Object *obj, Emotion_Aspect a); EAPI Emotion_Aspect emotion_object_keep_aspect_get(const Evas_Object *obj); /** + * @internal + * * @brief Set the file to be played in the Emotion object. * * @param obj The emotion object where the file is being loaded. @@ -586,6 +606,8 @@ EAPI Emotion_Aspect emotion_object_keep_aspect_get(const Evas_Object *obj); EAPI Eina_Bool emotion_object_file_set (Evas_Object *obj, const char *filename); /** + * @internal + * * @brief Get the filename of the file associated with the emotion object. * * @param obj The emotion object from which the filename will be retrieved. @@ -610,6 +632,8 @@ EAPI const char *emotion_object_file_get (const Evas_Object *obj); * @{ */ /** + * @internal + * * * @brief Set play/pause state of the media file. * @@ -621,6 +645,8 @@ EAPI const char *emotion_object_file_get (const Evas_Object *obj); */ EAPI void emotion_object_play_set (Evas_Object *obj, Eina_Bool play); /** + * @internal + * * @brief Get play/pause state of the media file. * * @param obj The emotion object from which the state will be retrieved. @@ -628,6 +654,8 @@ EAPI void emotion_object_play_set (Evas_Object *obj, Eina_B */ EAPI Eina_Bool emotion_object_play_get (const Evas_Object *obj); /** + * @internal + * * @brief Set the position in the media file. * * @param obj The emotion object whose position will be changed. @@ -641,6 +669,8 @@ EAPI Eina_Bool emotion_object_play_get (const Evas_Object *obj); */ EAPI void emotion_object_position_set (Evas_Object *obj, double sec); /** + * @internal + * * @brief Get the position in the media file. * * @param obj The emotion object from which the position will be retrieved. @@ -652,6 +682,8 @@ EAPI void emotion_object_position_set (Evas_Object *obj, double EAPI double emotion_object_position_get (const Evas_Object *obj); /** + * @internal + * * @brief Get the percentual size of the buffering cache. * * @param obj The emotion object from which the buffer size will be retrieved. @@ -668,6 +700,8 @@ EAPI double emotion_object_position_get (const Evas_Object *obj); EAPI double emotion_object_buffer_size_get (const Evas_Object *obj); /** + * @internal + * * @brief Get whether the media file is seekable. * * @param obj The emotion object from which the seekable status will be @@ -676,6 +710,8 @@ EAPI double emotion_object_buffer_size_get (const Evas_Object *obj); */ EAPI Eina_Bool emotion_object_seekable_get (const Evas_Object *obj); /** + * @internal + * * @brief Get the length of play for the media file. * * @param obj The emotion object from which the length will be retrieved. @@ -689,6 +725,8 @@ EAPI Eina_Bool emotion_object_seekable_get (const Evas_Object *obj); EAPI double emotion_object_play_length_get (const Evas_Object *obj); /** + * @internal + * * @brief Set the play speed of the media file. * * @param obj The emotion object whose speed will be set. @@ -702,6 +740,8 @@ EAPI double emotion_object_play_length_get (const Evas_Object *obj); */ EAPI void emotion_object_play_speed_set (Evas_Object *obj, double speed); /** + * @internal + * * @brief Get the play speed of the media file. * * @param obj The emotion object from which the filename will be retrieved. @@ -711,6 +751,8 @@ EAPI void emotion_object_play_speed_set (Evas_Object *obj, double */ EAPI double emotion_object_play_speed_get (const Evas_Object *obj); /** + * @internal + * * @brief Get how much of the file has been played. * * @param obj The emotion object from which the filename will be retrieved. @@ -721,6 +763,8 @@ EAPI double emotion_object_play_speed_get (const Evas_Object *obj); */ EAPI const char *emotion_object_progress_info_get (const Evas_Object *obj); /** + * @internal + * * @brief Get how much of the file has been played. * * @param obj The emotion object from which the filename will be retrieved @@ -733,12 +777,16 @@ EAPI const char *emotion_object_progress_info_get (const Evas_Object *obj); */ EAPI double emotion_object_progress_status_get (const Evas_Object *obj); /** + * @internal + * * @} */ EAPI Eina_Bool emotion_object_video_handled_get (const Evas_Object *obj); EAPI Eina_Bool emotion_object_audio_handled_get (const Evas_Object *obj); /** + * @internal + * * @brief Retrieve the video aspect ratio of the media file loaded. * * @param obj The emotion object which the video aspect ratio will be retrieved @@ -822,6 +870,8 @@ EAPI Eina_Bool emotion_object_audio_handled_get (const Evas_Object *obj); EAPI double emotion_object_ratio_get (const Evas_Object *obj); /** + * @internal + * * @brief Retrieve the video size of the loaded file. * * @param obj The object from which we are retrieving the video size. @@ -846,6 +896,8 @@ EAPI double emotion_object_ratio_get (const Evas_Object *obj); EAPI void emotion_object_size_get (const Evas_Object *obj, int *iw, int *ih); /** + * @internal + * * @brief Sets whether to use of high-quality image scaling algorithm * of the given video object. * @@ -863,6 +915,8 @@ EAPI void emotion_object_size_get (const Evas_Object *obj, EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_Bool smooth); /** + * @internal + * * @brief Gets whether the high-quality image scaling algorithm * of the given video object is used. * @@ -876,6 +930,8 @@ EAPI void emotion_object_smooth_scale_set (Evas_Object *obj, Eina_B EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj); /** + * @internal + * * @brief Send an Emotion Event to an Evas object * * @param obj The object target of the event. @@ -886,6 +942,8 @@ EAPI Eina_Bool emotion_object_smooth_scale_get (const Evas_Object *obj); EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotion_Event ev); /** + * @internal + * * @brief Set the audio volume. * * @param obj The object where the volume is being set. @@ -906,6 +964,8 @@ EAPI void emotion_object_event_simple_send (Evas_Object *obj, Emotio EAPI void emotion_object_audio_volume_set (Evas_Object *obj, double vol); /** + * @internal + * * @brief Get the audio volume. * * @param obj The object from which we are retrieving the volume. @@ -921,6 +981,8 @@ EAPI void emotion_object_audio_volume_set (Evas_Object *obj, double EAPI double emotion_object_audio_volume_get (const Evas_Object *obj); /** + * @internal + * * @brief Set the mute audio option for this object. * * @param obj The object which we are setting the mute audio option. @@ -939,6 +1001,8 @@ EAPI double emotion_object_audio_volume_get (const Evas_Object *obj); EAPI void emotion_object_audio_mute_set (Evas_Object *obj, Eina_Bool mute); /** + * @internal + * * @brief Get the mute audio option of this object. * * @param obj The object which we are retrieving the mute audio option from. @@ -958,6 +1022,8 @@ EAPI void emotion_object_audio_channel_set (Evas_Object *obj, int ch EAPI int emotion_object_audio_channel_get (const Evas_Object *obj); /** + * @internal + * * @brief Set the mute video option for this object. * * @param obj The object which we are setting the mute video option. @@ -976,6 +1042,8 @@ EAPI int emotion_object_audio_channel_get (const Evas_Object *obj); EAPI void emotion_object_video_mute_set (Evas_Object *obj, Eina_Bool mute); /** + * @internal + * * @brief Get the mute video option of this object. * * @param obj The object which we are retrieving the mute video option from. @@ -991,6 +1059,8 @@ EAPI void emotion_object_video_mute_set (Evas_Object *obj, Eina_B EAPI Eina_Bool emotion_object_video_mute_get (const Evas_Object *obj); /** + * @internal + * * @brief Set the video's subtitle file path. * * @param obj The object which we are setting a subtitle file path. @@ -1007,6 +1077,8 @@ EAPI Eina_Bool emotion_object_video_mute_get (const Evas_Object *obj); EAPI void emotion_object_video_subtitle_file_set (Evas_Object *obj, const char *filepath); /** + * @internal + * * @brief Get the video's subtitle file path. * * @param obj The object which we are retrieving the subtitle file path from. @@ -1023,6 +1095,8 @@ EAPI void emotion_object_video_subtitle_file_set (Evas_Object *obj, cons EAPI const char *emotion_object_video_subtitle_file_get (const Evas_Object *obj); /** + * @internal + * * @brief Get the number of available video channel * * @param obj The object which we are retrieving the channel count from @@ -1035,6 +1109,8 @@ EAPI const char *emotion_object_video_subtitle_file_get (const Evas_Object *ob EAPI int emotion_object_video_channel_count (const Evas_Object *obj); /** + * @internal + * * @brief Get the name of a given video channel * * @param obj The object which we are retrieving the channel name from @@ -1048,6 +1124,8 @@ EAPI int emotion_object_video_channel_count (const Evas_Object *obj); EAPI const char *emotion_object_video_channel_name_get(const Evas_Object *obj, int channel); /** + * @internal + * * @brief Set the channel for a given video object * * @param obj The target object which we are setting the channel @@ -1058,6 +1136,8 @@ EAPI const char *emotion_object_video_channel_name_get(const Evas_Object *obj, EAPI void emotion_object_video_channel_set (Evas_Object *obj, int channel); /** + * @internal + * * @brief Get the channel for a given video object * * @param obj The target object which we are getting the channel @@ -1079,6 +1159,8 @@ EAPI const char *emotion_object_chapter_name_get (const Evas_Object *obj, EAPI void emotion_object_eject (Evas_Object *obj); /** + * @internal + * * @brief Get the dvd title from this emotion object. * * @param obj The object which the title will be retrieved from. @@ -1097,6 +1179,8 @@ EAPI int emotion_object_spu_button_count_get (const Evas_Object *obj); EAPI int emotion_object_spu_button_get (const Evas_Object *obj); /** + * @internal + * * @brief Retrieve meta information from this file being played. * * @param obj The object which the meta info will be extracted from. @@ -1119,6 +1203,8 @@ EAPI int emotion_object_spu_button_get (const Evas_Object *obj); EAPI const char *emotion_object_meta_info_get (const Evas_Object *obj, Emotion_Meta_Info meta); /** + * @internal + * * @brief Set the visualization to be used with this object. * * @param obj The object where the visualization will be set on. @@ -1138,6 +1224,8 @@ EAPI const char *emotion_object_meta_info_get (const Evas_Object *obj, EAPI void emotion_object_vis_set (Evas_Object *obj, Emotion_Vis visualization); /** + * @internal + * * @brief Get the type of visualization in use by this emotion object. * * @param obj The emotion object which the visualization is being retrieved @@ -1155,6 +1243,8 @@ EAPI void emotion_object_vis_set (Evas_Object *obj, Emotio EAPI Emotion_Vis emotion_object_vis_get (const Evas_Object *obj); /** + * @internal + * * @brief Query whether a type of visualization is supported by this object. * * @param obj The object which the query is being ran on. @@ -1173,6 +1263,8 @@ EAPI Emotion_Vis emotion_object_vis_get (const Evas_Object *obj); EAPI Eina_Bool emotion_object_vis_supported (const Evas_Object *obj, Emotion_Vis visualization); /** + * @internal + * * @brief Raise priority of an object so it will have a priviledged access to hardware resources. * * @param obj The object which the query is being ran on. @@ -1193,6 +1285,8 @@ EAPI Eina_Bool emotion_object_vis_supported (const Evas_Object *obj, EAPI void emotion_object_priority_set(Evas_Object *obj, Eina_Bool priority); /** + * @internal + * * @brief Get the actual priority of an object. * * @param obj The object which the query is being ran on. @@ -1208,6 +1302,8 @@ EAPI void emotion_object_priority_set(Evas_Object *obj, Eina_Bool priori EAPI Eina_Bool emotion_object_priority_get(const Evas_Object *obj); /** + * @internal + * * @brief Change the state of an object pipeline. * * @param obj The object which the query is being ran on. @@ -1225,6 +1321,8 @@ EAPI Eina_Bool emotion_object_priority_get(const Evas_Object *obj); EAPI void emotion_object_suspend_set(Evas_Object *obj, Emotion_Suspend state); /** + * @internal + * * @brief Get the current state of the pipeline * * @param obj The object which the query is being ran on. @@ -1238,6 +1336,8 @@ EAPI void emotion_object_suspend_set(Evas_Object *obj, Emotion_Suspend s EAPI Emotion_Suspend emotion_object_suspend_get(Evas_Object *obj); /** + * @internal + * * @brief Load the last known position if available * * @param obj The object which the query is being ran on. @@ -1254,6 +1354,8 @@ EAPI Emotion_Suspend emotion_object_suspend_get(Evas_Object *obj); EAPI void emotion_object_last_position_load(Evas_Object *obj); /** + * @internal + * * @brief Save the lastest position if possible * * @param obj The object which the query is being ran on. @@ -1270,6 +1372,8 @@ EAPI void emotion_object_last_position_load(Evas_Object *obj); EAPI void emotion_object_last_position_save(Evas_Object *obj); /** + * @internal + * * @brief Do we have a chance to play that file * * @param file A stringshared filename that we want to know if Emotion can play. @@ -1282,6 +1386,8 @@ EAPI void emotion_object_last_position_save(Evas_Object *obj); EAPI Eina_Bool emotion_object_extension_may_play_fast_get(const char *file); /** + * @internal + * * @brief Do we have a chance to play that file * * @param file A filename that we want to know if Emotion can play. @@ -1294,6 +1400,8 @@ EAPI Eina_Bool emotion_object_extension_may_play_fast_get(const char *file); EAPI Eina_Bool emotion_object_extension_may_play_get(const char *file); /** + * @internal + * * @brief Get the actual image object that contains the pixels of the video stream * * @param obj The object which the query is being ran on. @@ -1317,6 +1425,8 @@ EAPI extern int EMOTION_WEBCAM_ADD; /**< Ecore_Event triggered when a new webcam EAPI extern int EMOTION_WEBCAM_DEL; /**< Ecore_Event triggered when a webcam is unplugged @since 1.8 */ /** + * @internal + * * @brief Get a list of active and available webcam * * @return the list of available webcam at the time of the call. @@ -1329,6 +1439,8 @@ EAPI extern int EMOTION_WEBCAM_DEL; /**< Ecore_Event triggered when a webcam is EAPI const Eina_List *emotion_webcams_get(void); /** + * @internal + * * @brief Get the human understandable name of a Webcam * * @param ew The webcam to get the name from. @@ -1339,6 +1451,8 @@ EAPI const Eina_List *emotion_webcams_get(void); EAPI const char *emotion_webcam_name_get(const Emotion_Webcam *ew); /** + * @internal + * * @brief Get the uri of a Webcam that will be understood by emotion * * @param ew The webcam to get the uri from. diff --git a/src/lib/emotion/emotion_object.eo b/src/lib/emotion/emotion_object.eo index 3486c5c..fe79722 100644 --- a/src/lib/emotion/emotion_object.eo +++ b/src/lib/emotion/emotion_object.eo @@ -2,7 +2,7 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player, Efl.Image) { eo_prefix: emotion_obj; methods { @property option { - set { + set @internal { [[Set the specified option for the current module. This function allows one to mute the video or audio of the @@ -22,7 +22,7 @@ class Emotion.Object (Evas.Object_Smart, Efl.File, Efl.Player, Efl.Image) { } } @property engine { - set { + set @internal { [[Initializes an emotion object with the specified module. This function is required after creating the emotion object, diff --git a/src/lib/eo/Eo.h b/src/lib/eo/Eo.h index 53ae8a6..89b8275 100644 --- a/src/lib/eo/Eo.h +++ b/src/lib/eo/Eo.h @@ -114,6 +114,8 @@ typedef struct _Eo_Opaque Eo; typedef Eo Eo_Class; /** + * @internal + * * @var _eo_class_creation_lock * This variable is used for locking purposes in the class_get function * defined in #EO_DEFINE_CLASS. @@ -169,6 +171,8 @@ typedef Eina_Bool (*Eo_Event_Cb)(void *data, Eo *obj, const Eo_Event_Description */ /** + * @internal + * * @var EO_DBG_INFO_TYPE * The Eina_Value_Type for the debug info. */ @@ -219,6 +223,8 @@ do { \ } while (0) /** + * @internal + * * Frees the Eo_Dbg_Info tree. (The whole tree recursively). * @param[in] info The tree to delete. */ @@ -381,6 +387,8 @@ struct _Eo_Class_Description typedef struct _Eo_Class_Description Eo_Class_Description; /** + * @internal + * * @brief Create a new class. * @param desc the class description to create the class with. * @param parent the class to inherit from. @@ -395,6 +403,8 @@ typedef struct _Eo_Class_Description Eo_Class_Description; EAPI const Eo_Class *eo_class_new(const Eo_Class_Description *desc, const Eo_Class *parent, ...); /** + * @internal + * * @brief Check if an object "is a" klass. * @param obj The object to check * @param klass The klass to check against. @@ -405,6 +415,8 @@ EAPI const Eo_Class *eo_class_new(const Eo_Class_Description *desc, const Eo_Cla EAPI Eina_Bool eo_isa(const Eo *obj, const Eo_Class *klass); /** + * @internal + * * @brief Gets the name of the passed class. * @param klass the class to work on. * @return The class's name. @@ -418,6 +430,8 @@ EAPI const char *eo_class_name_get(const Eo_Class *klass); */ /** + * @internal + * * @brief Init the eo subsystem * @return @c EINA_TRUE on success. * @@ -426,6 +440,8 @@ EAPI const char *eo_class_name_get(const Eo_Class *klass); EAPI Eina_Bool eo_init(void); /** + * @internal + * * @brief Shutdown the eo subsystem * @return @c EINA_TRUE on success. * @@ -600,6 +616,8 @@ EAPI EINA_CONST void *_eo_stack_get(void); /*****************************************************************************/ /** + * @internal + * * @brief Gets the class of the object. * @param obj The object to work on * @return The object's class. @@ -657,6 +675,8 @@ EAPI const Eo_Class *eo_class_get(const Eo *obj); EAPI Eo * _eo_add_internal_start(const char *file, int line, const Eo_Class *klass_id, Eo *parent, Eina_Bool ref); /** + * @internal + * * @brief Get a pointer to the data of an object for a specific class. * @param obj the object to work on. * @param klass the klass associated with the data. @@ -666,6 +686,8 @@ EAPI Eo * _eo_add_internal_start(const char *file, int line, const Eo_Class *kla EAPI void *eo_data_get(const Eo *obj, const Eo_Class *klass) EINA_DEPRECATED; /** + * @internal + * * @brief Get a pointer to the data of an object for a specific class. * The data reference count is not incremented. The pointer must be used only * in the scope of the function and its callees. @@ -693,6 +715,8 @@ EAPI void *eo_data_scope_get(const Eo *obj, const Eo_Class *klass); #define eo_data_ref(obj, klass) eo_data_xref_internal(__FILE__, __LINE__, obj, klass, (const Eo *)obj) /** + * @internal + * * @brief Get a pointer to the data of an object for a specific class and * increment the data reference count. * @param obj the object to work on. @@ -723,6 +747,8 @@ EAPI void *eo_data_xref_internal(const char *file, int line, const Eo *obj, cons #define eo_data_unref(obj, data) eo_data_xunref_internal(obj, data, obj) /** + * @internal + * * @brief Decrement the object data reference count by 1. * @param obj the object to work on. * @param data a pointer to the data to unreference @@ -734,6 +760,8 @@ EAPI void *eo_data_xref_internal(const char *file, int line, const Eo *obj, cons EAPI void eo_data_xunref_internal(const Eo *obj, void *data, const Eo *ref_obj); /** + * @internal + * * @brief Increment the object's reference count by 1. * @param obj the object to work on. * @return The object passed. @@ -751,6 +779,8 @@ EAPI void eo_data_xunref_internal(const Eo *obj, void *data, const Eo *ref_obj); EAPI Eo *eo_ref(const Eo *obj); /** + * @internal + * * @brief Decrement the object's reference count by 1 and free it if needed. * @param obj the object to work on. * @@ -760,6 +790,8 @@ EAPI Eo *eo_ref(const Eo *obj); EAPI void eo_unref(const Eo *obj); /** + * @internal + * * @brief Return the ref count of the object passed. * @param obj the object to work on. * @return the ref count of the object. @@ -770,6 +802,8 @@ EAPI void eo_unref(const Eo *obj); EAPI int eo_ref_get(const Eo *obj); /** + * @internal + * * @brief Unrefs the object and reparents it to NULL. * @param obj the object to work on. * @@ -789,6 +823,8 @@ EAPI void eo_del(const Eo *obj); #define eo_xref(obj, ref_obj) eo_xref_internal(__FILE__, __LINE__, obj, ref_obj) /** + * @internal + * * @brief Increment the object's reference count by 1 (and associate the ref with ref_obj) * @param obj the object to work on. * @param ref_obj the object that references obj. @@ -805,6 +841,8 @@ EAPI void eo_del(const Eo *obj); EAPI Eo *eo_xref_internal(const char *file, int line, Eo *obj, const Eo *ref_obj); /** + * @internal + * * @brief Decrement the object's reference count by 1 and free it if needed. Will free the ref associated with ref_obj). * @param obj the object to work on. * @param ref_obj the object that references obj. @@ -818,6 +856,8 @@ EAPI Eo *eo_xref_internal(const char *file, int line, Eo *obj, const Eo *ref_obj EAPI void eo_xunref(Eo *obj, const Eo *ref_obj); /** + * @internal + * * @brief Enable or disable the manual free feature. * @param obj the object to work on. * @param manual_free indicates if the free is manual (EINA_TRUE) or automatic (EINA_FALSE). @@ -834,6 +874,8 @@ EAPI void eo_xunref(Eo *obj, const Eo *ref_obj); EAPI void eo_manual_free_set(Eo *obj, Eina_Bool manual_free); /** + * @internal + * * @brief Frees the object. * @param obj the object to work on. * This function must be called by the developer if the function @@ -847,6 +889,8 @@ EAPI void eo_manual_free_set(Eo *obj, Eina_Bool manual_free); EAPI Eina_Bool eo_manual_free(Eo *obj); /** + * @internal + * * @brief Checks if the object was already descructed (only relevant for manual_free objects). * @param obj the object to check. * This function checks if the object was already destructed (but not alraedy @@ -936,6 +980,8 @@ typedef void (*eo_key_data_free_func)(void *); */ /** + * @internal + * * Don't use. * The values of the returned event structure are also internal, don't assume * anything about them. diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h index 6eff764..4d7e473 100755 --- a/src/lib/evas/Evas_Common.h +++ b/src/lib/evas/Evas_Common.h @@ -768,6 +768,8 @@ typedef void (*Evas_Async_Events_Put_Cb)(void *target, Evas_Callback_Type t */ /** + * @internal + * * Get the path for the cserve binary to execute * * There is little need for anyone except a desktop environment to call this. @@ -813,6 +815,10 @@ EAPI const char *evas_cserve_path_get(void); * developers. See the full @ref Example_Evas_Buffer_Simple "example". * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int evas_init(void); @@ -844,6 +850,10 @@ EAPI int evas_init(void); * "example". * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int evas_shutdown(void); @@ -897,6 +907,10 @@ EAPI int evas_shutdown(void); * @endcode * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Alloc_Error evas_alloc_error(void); @@ -922,6 +936,10 @@ EAPI Evas_Alloc_Error evas_alloc_error(void); * apart from ecore, may make use of it. * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int evas_async_events_fd_get(void) EINA_WARN_UNUSED_RESULT; @@ -937,6 +955,10 @@ EAPI int evas_async_events_fd_get(void) EINA_WARN_UNUSED_RESULT; * those parameters), in that order. * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int evas_async_events_process(void); @@ -956,6 +978,10 @@ EAPI int evas_async_events_process(void); * called. * * @ingroup Evas_Main_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool evas_async_events_put(const void *target, Evas_Callback_Type type, void *event_info, Evas_Async_Events_Put_Cb func) EINA_ARG_NONNULL(1, 4); @@ -1063,6 +1089,10 @@ EAPI Eina_Bool evas_async_events_put(const void *target, Evas_Callback_T * } * evas_output_method_set(evas, engine_id); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_render_method_lookup(const char *name) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -1096,6 +1126,10 @@ EAPI int evas_render_method_lookup(const char *name) EINA_WARN_UNU * printf("%s\n", engine_name); * evas_render_method_list_free(engine_list); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *evas_render_method_list(void) EINA_WARN_UNUSED_RESULT; @@ -1126,6 +1160,10 @@ EAPI Eina_List *evas_render_method_list(void) EINA_WARN_UNUSED_RESULT; * printf("%s\n", engine_name); * evas_render_method_list_free(engine_list); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_render_method_list_free(Eina_List *list); @@ -1175,6 +1213,10 @@ EAPI void evas_render_method_list_free(Eina_List *list); * @see evas_render_updates() for an example * * @ingroup Evas_Canvas + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_render_updates_free(Eina_List *updates); @@ -1248,6 +1290,10 @@ EAPI void evas_render_updates_free(Eina_List *updates); * * @see evas_device_del * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Device *evas_device_add(Evas *e); @@ -1260,6 +1306,10 @@ EAPI Evas_Device *evas_device_add(Evas *e); * @see evas_device_push * @see evas_device_pop * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_del(Evas_Device *dev); @@ -1289,6 +1339,10 @@ EAPI void evas_device_del(Evas_Device *dev); * * @see evas_device_pop * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_push(Evas *e, Evas_Device *dev); @@ -1303,6 +1357,10 @@ EAPI void evas_device_push(Evas *e, Evas_Device *dev); * * @see evas_device_push * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_pop(Evas *e); @@ -1329,6 +1387,10 @@ EAPI void evas_device_pop(Evas *e); * @see evas_device_subclass_get * @see evas_device_emulation_source_get * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_List *evas_device_list(Evas *e, const Evas_Device *dev); @@ -1339,6 +1401,10 @@ EAPI const Eina_List *evas_device_list(Evas *e, const Evas_Device *dev); * @p name The name string as a readable C UTF8 string * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_name_set(Evas_Device *dev, const char *name); @@ -1355,6 +1421,10 @@ EAPI void evas_device_name_set(Evas_Device *dev, const char *name); * "Finger", "Keyboard" or "Numberpad" etc. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *evas_device_name_get(const Evas_Device *dev); @@ -1365,6 +1435,10 @@ EAPI const char *evas_device_name_get(const Evas_Device *dev); * @p name The description string as a readable C UTF8 string * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_description_set(Evas_Device *dev, const char *desc); @@ -1383,6 +1457,10 @@ EAPI void evas_device_description_set(Evas_Device *dev, const char *desc); * precisely which device is being talked about. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *evas_device_description_get(const Evas_Device *dev); @@ -1405,6 +1483,10 @@ EAPI const char *evas_device_description_get(const Evas_Device *dev); * @see evas_device_list * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_parent_set(Evas_Device *dev, Evas_Device *parent); @@ -1418,6 +1500,10 @@ EAPI void evas_device_parent_set(Evas_Device *dev, Evas_Device *parent); * parent device exists (is a toplevel device). * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Device *evas_device_parent_get(const Evas_Device *dev); @@ -1431,6 +1517,10 @@ EAPI const Evas_Device *evas_device_parent_get(const Evas_Device *dev); * touch, pen etc.). * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_class_set(Evas_Device *dev, Evas_Device_Class clas); @@ -1443,6 +1533,10 @@ EAPI void evas_device_class_set(Evas_Device *dev, Evas_Device_Class clas); * This sets the device class set by evas_device_class_set(). * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Device_Class evas_device_class_get(const Evas_Device *dev); @@ -1456,6 +1550,10 @@ EAPI Evas_Device_Class evas_device_class_get(const Evas_Device *dev); * within a broader category. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_subclass_set(Evas_Device *dev, Evas_Device_Subclass clas); @@ -1466,6 +1564,10 @@ EAPI void evas_device_subclass_set(Evas_Device *dev, Evas_Device_Subclass clas); * @return The device sub-class set by evas_device_subclass_set(). * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Device_Subclass evas_device_subclass_get(const Evas_Device *dev); @@ -1483,6 +1585,10 @@ EAPI Evas_Device_Subclass evas_device_subclass_get(const Evas_Device *dev); * pay attention to source device events for example. * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_device_emulation_source_set(Evas_Device *dev, Evas_Device *src); @@ -1493,6 +1599,10 @@ EAPI void evas_device_emulation_source_set(Evas_Device *dev, Evas_Device *src); * @return The source emulation device set by evas_device_emulation_source_set(). * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Device *evas_device_emulation_source_get(const Evas_Device *dev); @@ -1944,6 +2054,10 @@ EAPI const Evas_Device *evas_device_emulation_source_get(const Evas_Device *dev) * @see evas_map_util_points_populate_from_object() * @see evas_map_point_coord_set() * @see evas_map_point_image_uv_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_points_populate_from_object_full(Evas_Map *m, const Evas_Object *obj, Evas_Coord z); @@ -1965,6 +2079,10 @@ EAPI void evas_map_util_points_populate_from_object_full(Evas_Map *m, * @see evas_map_util_points_populate_from_geometry() * @see evas_map_point_coord_set() * @see evas_map_point_image_uv_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_points_populate_from_object(Evas_Map *m, const Evas_Object *obj); @@ -1988,6 +2106,10 @@ EAPI void evas_map_util_points_populate_from_object(Evas_Map *m, cons * @see evas_map_util_points_populate_from_object() * @see evas_map_point_coord_set() * @see evas_map_point_image_uv_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_points_populate_from_geometry(Evas_Map *m, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Evas_Coord z); @@ -2004,6 +2126,10 @@ EAPI void evas_map_util_points_populate_from_geometry(Evas_Map *m, Ev * @param a alpha (0 - 255) * * @see evas_map_point_color_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_points_color_set(Evas_Map *m, int r, int g, int b, int a); @@ -2023,6 +2149,10 @@ EAPI void evas_map_util_points_color_set(Evas_Map *m, int r, int g, i * * @see evas_map_point_coord_set() * @see evas_map_util_zoom() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_rotate(Evas_Map *m, double degrees, Evas_Coord cx, Evas_Coord cy); @@ -2043,6 +2173,10 @@ EAPI void evas_map_util_rotate(Evas_Map *m, double degrees, Evas_Coor * * @see evas_map_point_coord_set() * @see evas_map_util_rotate() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_zoom(Evas_Map *m, double zoomx, double zoomy, Evas_Coord cx, Evas_Coord cy); @@ -2063,6 +2197,10 @@ EAPI void evas_map_util_zoom(Evas_Map *m, double zoomx, double zoomy, * @param cx rotation's center horizontal position. * @param cy rotation's center vertical position. * @param cz rotation's center vertical position. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_3d_rotate(Evas_Map *m, double dx, double dy, double dz, Evas_Coord cx, Evas_Coord cy, Evas_Coord cz); @@ -2087,6 +2225,10 @@ EAPI void evas_map_util_3d_rotate(Evas_Map *m, double dx, double dy, * If this is not the case the behavior is undefined. * * @since 1.8 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_quat_rotate(Evas_Map *m, double qx, double qy, double qz, double qw, double cx, double cy, double cz); @@ -2143,6 +2285,10 @@ EAPI void evas_map_util_quat_rotate(Evas_Map *m, double qx, double qy * @param ar ambient color red value (0 - 255) * @param ag ambient color green value (0 - 255) * @param ab ambient color blue value (0 - 255) + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_3d_lighting(Evas_Map *m, Evas_Coord lx, Evas_Coord ly, Evas_Coord lz, int lr, int lg, int lb, int ar, int ag, int ab); @@ -2167,6 +2313,10 @@ EAPI void evas_map_util_3d_lighting(Evas_Map *m, Evas_Coord lx, Evas_ * @param py The perspective distance Y coordinate * @param z0 The "0" z plane value * @param foc The focal distance + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_util_3d_perspective(Evas_Map *m, Evas_Coord px, Evas_Coord py, Evas_Coord z0, Evas_Coord foc); @@ -2180,6 +2330,10 @@ EAPI void evas_map_util_3d_perspective(Evas_Map *m, Evas_Coord px, Ev * * @param m map to query. * @return 1 if clockwise, 0 otherwise + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_map_util_clockwise_get(Evas_Map *m); @@ -2201,6 +2355,10 @@ EAPI Eina_Bool evas_map_util_clockwise_get(Evas_Map *m); * @see evas_map_util_points_populate_from_object() * * @see evas_object_map_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Map *evas_map_new(int count); @@ -2213,6 +2371,10 @@ EAPI Evas_Map *evas_map_new(int count); * * @param m map to modify. Must not be NULL. * @param enabled enable or disable smooth map rendering + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_smooth_set(Evas_Map *m, Eina_Bool enabled); @@ -2223,6 +2385,10 @@ EAPI void evas_map_smooth_set(Evas_Map *m, Eina_Bool enabled); * * @param m map to get the smooth from. Must not be NULL. * @return @c EINA_TRUE if the smooth is enabled, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_map_smooth_get(const Evas_Map *m); @@ -2237,6 +2403,10 @@ EAPI Eina_Bool evas_map_smooth_get(const Evas_Map *m); * * @param m map to modify. Must not be NULL. * @param enabled enable or disable alpha map rendering + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_alpha_set(Evas_Map *m, Eina_Bool enabled); @@ -2247,6 +2417,10 @@ EAPI void evas_map_alpha_set(Evas_Map *m, Eina_Bool enabled); * * @param m map to get the alpha from. Must not be NULL. * @return EINA_FALSE if map is NULL EINA_TRUE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_map_alpha_get(const Evas_Map *m); @@ -2262,6 +2436,10 @@ EAPI Eina_Bool evas_map_alpha_get(const Evas_Map *m); * @param enabled enable or disable the object move synchronization for map * rendering. * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_map_util_object_move_sync_set(Evas_Map *m, Eina_Bool enabled); @@ -2274,6 +2452,10 @@ EAPI void evas_map_util_object_move_sync_set(Evas_Map *m, Eina_Bool e * not be NULL. * @return EINA_FALSE if map is NULL EINA_TRUE otherwise. * @since 1.13 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool evas_map_util_object_move_sync_get(const Evas_Map *m); @@ -2284,6 +2466,10 @@ EAPI Eina_Bool evas_map_util_object_move_sync_get(const Evas_Map *m); * * @param m map to copy. Must not be NULL. * @return newly allocated map with the same count and contents as @p m. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Map *evas_map_dup(const Evas_Map *m); @@ -2294,6 +2480,10 @@ EAPI Evas_Map *evas_map_dup(const Evas_Map *m); * free a map returned by evas_object_map_get() as this is internal. * * @param m map to free. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_free(Evas_Map *m); @@ -2304,6 +2494,10 @@ EAPI void evas_map_free(Evas_Map *m); * * @param m map to get size. * @return -1 on error, points otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_map_count_get(const Evas_Map *m) EINA_CONST; @@ -2335,6 +2529,10 @@ EAPI int evas_map_count_get(const Evas_Map *m) EINA_CONST; * @see evas_map_util_zoom() * @see evas_map_util_points_populate_from_object_full() * @see evas_map_util_points_populate_from_object() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_coord_set(Evas_Map *m, int idx, Evas_Coord x, Evas_Coord y, Evas_Coord z); @@ -2348,6 +2546,10 @@ EAPI void evas_map_point_coord_set(Evas_Map *m, int idx, Evas_Coord x * @param x where to return the X coordinate. * @param y where to return the Y coordinate. * @param z where to return the Z coordinate. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_coord_get(const Evas_Map *m, int idx, Evas_Coord *x, Evas_Coord *y, Evas_Coord *z); @@ -2399,6 +2601,10 @@ EAPI void evas_map_point_precise_coord_get(const Evas_Map *m, int idx * @see evas_object_map_set() * @see evas_map_util_points_populate_from_object_full() * @see evas_map_util_points_populate_from_object() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_image_uv_set(Evas_Map *m, int idx, double u, double v); @@ -2411,6 +2617,10 @@ EAPI void evas_map_point_image_uv_set(Evas_Map *m, int idx, double u, * @param idx index of point to query. Must be smaller than map size. * @param u where to write the X coordinate within the image/texture source * @param v where to write the Y coordinate within the image/texture source + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_image_uv_get(const Evas_Map *m, int idx, double *u, double *v); @@ -2433,6 +2643,10 @@ EAPI void evas_map_point_image_uv_get(const Evas_Map *m, int idx, dou * @see evas_map_util_points_color_set() * @see evas_map_point_coord_set() * @see evas_object_map_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_color_set(Evas_Map *m, int idx, int r, int g, int b, int a); @@ -2451,6 +2665,10 @@ EAPI void evas_map_point_color_set(Evas_Map *m, int idx, int r, int g * * @see evas_map_point_coord_set() * @see evas_object_map_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_map_point_color_get(const Evas_Map *m, int idx, int *r, int *g, int *b, int *a); /** @@ -3062,6 +3280,10 @@ typedef void (*Evas_Object_Image_Pixels_Get_Cb)(void *data, Evas_Object *o); * If file is a Eina_Stringshare, use directly @ref evas_object_image_extension_can_load_fast_get. * * This functions is threadsafe. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_extension_can_load_get(const char *file); @@ -3074,6 +3296,10 @@ EAPI Eina_Bool evas_object_image_extension_can_load_get(cons * @since 1.1 * * This functions is threadsafe. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_extension_can_load_fast_get(const char *file); /** @@ -3307,6 +3533,10 @@ typedef enum _Evas_Textblock_Cursor_Type * Returns the unescaped version of escape. * @param escape the string to be escaped * @return the unescaped version of escape + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_textblock_escape_string_get(const char *escape) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3315,6 +3545,10 @@ EAPI const char *evas_textblock_escape_string_get(c * @param string to escape * @param len_ret the len of the part of the string that was used. * @return the escaped string. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_textblock_string_escape_get(const char *string, int *len_ret) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3324,18 +3558,30 @@ EAPI const char *evas_textblock_string_escape_get(c * @param escape_start the start of the string. * @param escape_end the end of the string. * @return the unescaped version of the range + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); /** * Creates a new textblock style. * @return The new textblock style. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Textblock_Style *evas_textblock_style_new(void) EINA_WARN_UNUSED_RESULT EINA_MALLOC; /** * Destroys a textblock style. * @param ts The textblock style to free. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_style_free(Evas_Textblock_Style *ts) EINA_ARG_NONNULL(1); @@ -3346,6 +3592,10 @@ EAPI void evas_textblock_style_free(Evas_Tex * @param ts the style to set. * @param text the text to parse - NOT NULL. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_style_set(Evas_Textblock_Style *ts, const char *text) EINA_ARG_NONNULL(1); @@ -3353,6 +3603,10 @@ EAPI void evas_textblock_style_set(Evas_Text * Return the text of the style ts. * @param ts the style to get it's text. * @return the text of the style or null on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_textblock_style_get(const Evas_Textblock_Style *ts) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3364,6 +3618,10 @@ EAPI const char *evas_textblock_style_get(const Eva * @param cur the cursor to prepend to. * @param text the markup text to prepend. * @return Return no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_textblock_text_markup_prepend(Evas_Textblock_Cursor *cur, const char *text) EINA_ARG_NONNULL(1, 2); @@ -3373,6 +3631,10 @@ EAPI void evas_object_textblock_text_markup_ * * @param cur the cursor to free. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_free(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3381,6 +3643,10 @@ EAPI void evas_textblock_cursor_free(Evas_Te * * @param cur the cursor to update. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_paragraph_first(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3389,6 +3655,10 @@ EAPI void evas_textblock_cursor_paragraph_fi * * @param cur the cursor to set. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_paragraph_last(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3398,6 +3668,10 @@ EAPI void evas_textblock_cursor_paragraph_la * @param cur the cursor to update * @return @c EINA_TRUE if it managed to advance a paragraph, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_paragraph_next(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3407,6 +3681,10 @@ EAPI Eina_Bool evas_textblock_cursor_paragraph_ne * @param cur the cursor to update * @return @c EINA_TRUE if it managed to advance a paragraph, @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_paragraph_prev(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3415,6 +3693,10 @@ EAPI Eina_Bool evas_textblock_cursor_paragraph_pr * * @param n the current format node - not null. * @return Returns the next format node, may be null. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_next_get(const Evas_Object_Textblock_Node_Format *n) EINA_ARG_NONNULL(1); @@ -3423,6 +3705,10 @@ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_next_ge * * @param n the current format node - not null. * @return Returns the prev format node, may be null. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_prev_get(const Evas_Object_Textblock_Node_Format *n) EINA_ARG_NONNULL(1); @@ -3432,6 +3718,10 @@ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_node_format_prev_ge * * @param cur the cursor to update. * @param n the format node to update according. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void evas_textblock_cursor_set_at_format(Evas_Textblock_Cursor *cur, const Evas_Object_Textblock_Node_Format *n) EINA_ARG_NONNULL(1, 2); @@ -3441,6 +3731,10 @@ EINA_DEPRECATED EAPI void evas_textblock_cursor_set_at_forma * @param cur the position to look at. * @return the format node if found, @c NULL otherwise. * @see evas_textblock_cursor_format_is_visible_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_cursor_format_get(const Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3449,6 +3743,10 @@ EAPI const Evas_Object_Textblock_Node_Format *evas_textblock_cursor_format_get(c * * @param fnode the format node. * @return the textual format of the format node. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_textblock_node_format_text_get(const Evas_Object_Textblock_Node_Format *fnode) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3457,6 +3755,10 @@ EAPI const char *evas_textblock_node_format_text_ge * * @param cur the cursor to update * @param fmt the format to update according to. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_at_format_set(Evas_Textblock_Cursor *cur, const Evas_Object_Textblock_Node_Format *fmt) EINA_ARG_NONNULL(1, 2); @@ -3469,6 +3771,10 @@ EAPI void evas_textblock_cursor_at_format_se * @return @c EINA_TRUE if the cursor points to a visible format, @c EINA_FALSE * otherwise. * @see evas_textblock_cursor_format_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_format_is_visible_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3477,6 +3783,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_is_vi * * @param cur the cursor to be updated. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_format_next(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3485,6 +3795,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_next( * * @param cur the cursor to update. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_format_prev(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3494,6 +3808,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_prev( * @param cur the cursor to check. * @return @c EINA_TRUE if a cursor points to a format @c EINA_FALSE * otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_is_format(const Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3502,6 +3820,10 @@ EAPI Eina_Bool evas_textblock_cursor_is_format(co * * @param cur the cursor to advance. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_char_next(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3510,6 +3832,10 @@ EAPI Eina_Bool evas_textblock_cursor_char_next(Ev * * @param cur the cursor to advance. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_char_prev(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3541,6 +3867,10 @@ EAPI Eina_Bool evas_textblock_cursor_cluster_prev * @param cur the cursor to move. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_word_start(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3550,6 +3880,10 @@ EAPI Eina_Bool evas_textblock_cursor_word_start(E * @param cur the cursor to move. * @return @c EINA_TRUE on success @c EINA_FALSE otherwise. * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_word_end(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3558,6 +3892,10 @@ EAPI Eina_Bool evas_textblock_cursor_word_end(Eva * * @param cur the cursor to update. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_paragraph_char_first(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3566,6 +3904,10 @@ EAPI void evas_textblock_cursor_paragraph_ch * * @param cur the cursor to update. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_paragraph_char_last(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3574,6 +3916,10 @@ EAPI void evas_textblock_cursor_paragraph_ch * * @param cur the cursor to update. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_line_char_first(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3582,6 +3928,10 @@ EAPI void evas_textblock_cursor_line_char_fi * * @param cur the cursor to update. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_line_char_last(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3590,6 +3940,10 @@ EAPI void evas_textblock_cursor_line_char_la * * @param cur the cursor to take the position from. * @return the position or -1 on error + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_pos_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3598,6 +3952,10 @@ EAPI int evas_textblock_cursor_pos_get(cons * * @param cur the cursor to be set. * @param pos the pos to set. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_pos_set(Evas_Textblock_Cursor *cur, int pos) EINA_ARG_NONNULL(1); @@ -3607,6 +3965,10 @@ EAPI void evas_textblock_cursor_pos_set(Evas * @param cur cursor to update. * @param line numer to set. * @return @c EINA_TRUE on success, @c EINA_FALSE on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_line_set(Evas_Textblock_Cursor *cur, int line) EINA_ARG_NONNULL(1); @@ -3616,6 +3978,10 @@ EAPI Eina_Bool evas_textblock_cursor_line_set(Eva * @param cur1 the first cursor. * @param cur2 the second cursor. * @return -1 if cur1 < cur2, 0 if cur1 == cur2 and 1 otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); @@ -3626,6 +3992,10 @@ EAPI int evas_textblock_cursor_compare(cons * @param cur the source cursor. * @param cur_dest destination cursor. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_copy(const Evas_Textblock_Cursor *cur, Evas_Textblock_Cursor *cur_dest) EINA_ARG_NONNULL(1, 2); @@ -3637,6 +4007,10 @@ EAPI void evas_textblock_cursor_copy(const E * @param text the text to add. * @return Returns the len of the text added. * @see evas_textblock_cursor_text_prepend() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_text_append(Evas_Textblock_Cursor *cur, const char *text) EINA_ARG_NONNULL(1, 2); @@ -3648,6 +4022,10 @@ EAPI int evas_textblock_cursor_text_append( * @param text the text to add. * @return Returns the len of the text added. * @see evas_textblock_cursor_text_append() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_text_prepend(Evas_Textblock_Cursor *cur, const char *text) EINA_ARG_NONNULL(1, 2); @@ -3673,6 +4051,10 @@ EAPI int evas_textblock_cursor_text_prepend * * @param cur the cursor to look at. * @return @c EINA_TRUE if the cursor points to the terminating null, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_format_append(Evas_Textblock_Cursor *cur, const char *format) EINA_ARG_NONNULL(1, 2); @@ -3690,6 +4072,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_appen * @param format the format to add. * @return Returns true if a visible format was added, false otherwise. * @see evas_textblock_cursor_format_prepend() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_format_prepend(Evas_Textblock_Cursor *cur, const char *format) EINA_ARG_NONNULL(1, 2); @@ -3699,6 +4085,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_prepe * * @param cur the cursor pointing to the current location. * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_char_delete(Evas_Textblock_Cursor *cur) EINA_ARG_NONNULL(1); @@ -3708,6 +4098,10 @@ EAPI void evas_textblock_cursor_char_delete( * @param cur1 one side of the range. * @param cur2 the second side of the range * @return Returns no value. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_textblock_cursor_range_delete(Evas_Textblock_Cursor *cur1, Evas_Textblock_Cursor *cur2) EINA_ARG_NONNULL(1, 2); @@ -3716,6 +4110,10 @@ EAPI void evas_textblock_cursor_range_delete * * @param cur the cursor pointing to the paragraph. * @return the text on success, @c NULL otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_textblock_cursor_paragraph_text_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3724,6 +4122,10 @@ EAPI const char *evas_textblock_cursor_paragraph_te * * @param cur the position of the paragraph. * @return the length of the paragraph on success, -1 otehrwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_paragraph_text_length_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3734,6 +4136,10 @@ EAPI int evas_textblock_cursor_paragraph_te * @param end the end of the range. * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_visible_range_get(Evas_Textblock_Cursor *start, Evas_Textblock_Cursor *end) EINA_ARG_NONNULL(1, 2); @@ -3744,6 +4150,10 @@ EAPI Eina_Bool evas_textblock_cursor_visible_rang * @param cur2 the other side of the range * @return the foramt nodes in the range. You have to free it. * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); @@ -3755,6 +4165,10 @@ EAPI Eina_List *evas_textblock_cursor_range_format * @param format The form on which to return the text. Markup - in textblock markup. Plain - UTF8. * @return the text in the range * @see elm_entry_markup_to_utf8() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); @@ -3777,6 +4191,10 @@ EAPI char *evas_textblock_cursor_range_text_v * * @param cur the cursor * @return the text in the range, terminated by a nul byte (may be utf8). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *evas_textblock_cursor_content_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3802,6 +4220,10 @@ EAPI char *evas_textblock_cursor_content_get( * @param[in] ctype the type of the cursor. * @return @c EINA_TRUE for split cursor, @c EINA_FALSE otherwise * @since 1.8 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_geometry_bidi_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch, Evas_Coord *cx2, Evas_Coord *cy2, Evas_Coord *cw2, Evas_Coord *ch2, Evas_Textblock_Cursor_Type ctype); @@ -3827,6 +4249,10 @@ evas_textblock_cursor_geometry_bidi_get(const Evas_Textblock_Cursor *cur, Evas_C * @param dir the direction of the cursor, can be NULL. * @param ctype the type of the cursor. * @return line number of the char on success, -1 on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch, Evas_BiDi_Direction *dir, Evas_Textblock_Cursor_Type ctype) EINA_ARG_NONNULL(1); @@ -3839,6 +4265,10 @@ EAPI int evas_textblock_cursor_geometry_get * @param cw the w of the char. * @param ch the h of the char. * @return line number of the char on success, -1 on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_char_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1); @@ -3851,6 +4281,10 @@ EAPI int evas_textblock_cursor_char_geometr * @param cadv the adv of the char. * @param ch the h of the char. * @return line number of the char on success, -1 on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_pen_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cpen_x, Evas_Coord *cy, Evas_Coord *cadv, Evas_Coord *ch) EINA_ARG_NONNULL(1); @@ -3863,6 +4297,10 @@ EAPI int evas_textblock_cursor_pen_geometry * @param cw the width of the line. * @param ch the height of the line. * @return line number of the line on success, -1 on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_line_geometry_get(const Evas_Textblock_Cursor *cur, Evas_Coord *cx, Evas_Coord *cy, Evas_Coord *cw, Evas_Coord *ch) EINA_ARG_NONNULL(1); @@ -3873,6 +4311,10 @@ EAPI int evas_textblock_cursor_line_geometr * @param x coord to set by. * @param y coord to set by. * @return @c EINA_TRUE on success, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_char_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1); @@ -3894,6 +4336,10 @@ EAPI Eina_Bool evas_textblock_cursor_cluster_coor * @param cur the cur to be set. * @param y the coord to set by. * @return the line number found, -1 on error. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_textblock_cursor_line_coord_set(Evas_Textblock_Cursor *cur, Evas_Coord y) EINA_ARG_NONNULL(1); @@ -3903,6 +4349,10 @@ EAPI int evas_textblock_cursor_line_coord_s * @param cur1 one side of the range. * @param cur2 other side of the range. * @return a list of Rectangles representing the geometry of the range. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); @@ -3915,6 +4365,10 @@ EAPI Eina_List *evas_textblock_cursor_range_geomet * @param cur1 one side of the range. * @param cur2 other side of the range. * @return an iterator of rectangles representing the geometry of the range. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Iterator *evas_textblock_cursor_range_simple_geometry_get(const Evas_Textblock_Cursor *cur1, const Evas_Textblock_Cursor *cur2) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); @@ -3923,6 +4377,10 @@ EAPI Eina_Iterator *evas_textblock_cursor_range_si * * @param cur one side of the range. * @param cur2 other side of the range. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ 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); @@ -3931,6 +4389,10 @@ EAPI Eina_Bool evas_textblock_cursor_format_item_ * * @param cur the cursor to check. * @return @c EINA_TRUE if true, @c EINA_FALSE otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_textblock_cursor_eol_get(const Evas_Textblock_Cursor *cur) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -4432,6 +4894,10 @@ struct _Evas_Smart_Cb_Description * Evas will internally count references on #Evas_Smart handles and free them * when they are not referenced anymore. Thus, this function is of no use * for Evas users, most probably. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_smart_free(Evas_Smart *s) EINA_ARG_NONNULL(1); @@ -4449,6 +4915,10 @@ EAPI void evas_smart_free(Evas_Smart *s) EINA_ARG_N * @note If you are willing to subclass a given smart class to * construct yours, consider using the #EVAS_SMART_SUBCLASS_NEW macro, * which will make use of this function automatically for you. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Smart *evas_smart_class_new(const Evas_Smart_Class *sc) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -4457,6 +4927,10 @@ EAPI Evas_Smart *evas_smart_class_new(const Evas_Smart_Cla * * @param s a valid #Evas_Smart pointer * @return the #Evas_Smart_Class in it + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Smart_Class *evas_smart_class_get(const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -4467,6 +4941,10 @@ EAPI const Evas_Smart_Class *evas_smart_class_get(const Evas_Smart *s) * * This data pointer is set as the data field in the #Evas_Smart_Class * passed in to evas_smart_class_new(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_smart_data_get(const Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -4505,6 +4983,10 @@ EAPI void *evas_smart_data_get(const Evas_Smart *s) * evas_object_smart_callbacks_descriptions_get() to get those * as well. * @see evas_object_smart_callbacks_descriptions_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Smart_Cb_Description **evas_smart_callbacks_descriptions_get(const Evas_Smart *s, unsigned int *count) EINA_ARG_NONNULL(1, 1); @@ -4520,6 +5002,10 @@ EAPI const Evas_Smart_Cb_Description **evas_smart_callbacks_descriptions_get(con * @return A reference to the description if found, or @c NULL, otherwise * * @see evas_smart_callbacks_descriptions_get() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Smart_Cb_Description *evas_smart_callback_description_find(const Evas_Smart *s, const char *name) EINA_ARG_NONNULL(1, 2); @@ -4539,6 +5025,10 @@ EAPI const Evas_Smart_Cb_Description *evas_smart_callback_description_find(cons * @param parent_sc_size size of parent_sc structure, child should be at least * this size. Everything after @c Evas_Smart_Class size is copied * using regular memcpy(). + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool evas_smart_class_inherit_full(Evas_Smart_Class *sc, const Evas_Smart_Class *parent_sc, unsigned int parent_sc_size) EINA_ARG_NONNULL(1, 2); @@ -4560,6 +5050,10 @@ EAPI Eina_Bool evas_smart_class_inherit_full(Evas_Smart_ * behavior etc. etc.), so either never remove the original * Evas_Smart_Class data from memory (have it be a constant structure and * data), or use this API call and be very careful. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI int evas_smart_usage_get(const Evas_Smart *s); @@ -4638,6 +5132,10 @@ EAPI int evas_smart_usage_get(const Evas_Smart *s) * @see eo_isa * * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_smart_legacy_type_register(const char *type, const Eo_Class *klass) EINA_ARG_NONNULL(1, 2); @@ -4729,6 +5227,10 @@ struct _Evas_Object_Smart_Clipped_Data * @note There are other means of assigning parent smart classes to * child ones, like the #EVAS_SMART_SUBCLASS_NEW macro or the * evas_smart_class_inherit_full() function. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_smart_clipped_smart_set(Evas_Smart_Class *sc) EINA_ARG_NONNULL(1); @@ -4738,6 +5240,10 @@ EAPI void evas_object_smart_clipped_smart_set(Evas_Smart_Clas * * @see #Evas_Smart_Object_Clipped for more information on this smart * class + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Evas_Smart_Class *evas_object_smart_clipped_class_get(void) EINA_CONST; /** @@ -4978,6 +5484,10 @@ struct _Evas_Object_Box_Option * * @param api The box API struct to set back, most probably with * overridden fields (on class extensions scenarios) + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_box_smart_set(Evas_Object_Box_Api *api) EINA_ARG_NONNULL(1); @@ -4988,6 +5498,10 @@ EAPI void evas_object_box_smart_set(Evas_Object_Box_Api *a * * The returned value is @b not to be modified, just use it as your * parent class. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const Evas_Object_Box_Api *evas_object_box_smart_class_get(void) EINA_CONST; @@ -5102,6 +5616,8 @@ struct _Evas_Cserve_Config }; /** + * @internal + * * Retrieves if the system wants to share bitmaps using the server. * @return @c EINA_TRUE if it wants, @c EINA_FALSE otherwise. * @ingroup Evas_Cserve @@ -5109,6 +5625,8 @@ struct _Evas_Cserve_Config EAPI Eina_Bool evas_cserve_want_get(void) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Retrieves if the system is connected to the server used to share * bitmaps. * @@ -5118,6 +5636,8 @@ EAPI Eina_Bool evas_cserve_want_get(void) EINA_WARN_UNUSED_RESULT; EAPI Eina_Bool evas_cserve_connected_get(void) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Retrieves statistics from a running bitmap sharing server. * @param stats pointer to structure to fill with statistics about the * bitmap cache server. @@ -5129,6 +5649,8 @@ EAPI Eina_Bool evas_cserve_connected_get(void) EINA_WARN_UNUSED_RESULT; EAPI Eina_Bool evas_cserve_stats_get(Evas_Cserve_Stats *stats) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Completely discard/clean a given images cache, thus re-setting it. * * @param cache A handle to the given images cache. @@ -5136,6 +5658,8 @@ EAPI Eina_Bool evas_cserve_stats_get(Evas_Cserve_Stats *stats) EINA_WARN_UNUSE EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache *cache); /** + * @internal + * * Retrieves the current configuration of the Evas image caching * server. * @@ -5155,6 +5679,8 @@ EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache EAPI Eina_Bool evas_cserve_config_get(Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Changes the configurations of the Evas image caching server. * * @param config A bitmap cache configuration handle with fields set @@ -5169,6 +5695,8 @@ EAPI Eina_Bool evas_cserve_config_get(Evas_Cserve_Config *config) EINA_WARN_UN EAPI Eina_Bool evas_cserve_config_set(const Evas_Cserve_Config *config) EINA_WARN_UNUSED_RESULT; /** + * @internal + * * Force the system to disconnect from the bitmap caching server. * * @ingroup Evas_Cserve @@ -5211,6 +5739,10 @@ EAPI void evas_cserve_disconnect(void); * Example_Evas_Images "example". * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_load_error_str(Evas_Load_Error error); @@ -5232,6 +5764,10 @@ EAPI const char *evas_load_error_str(Evas_Load_Error error); * color format. * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int *b); @@ -5249,6 +5785,10 @@ EAPI void evas_color_hsv_to_rgb(float h, float s, float v, int *r, int *g, int * * color format. * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float *v); @@ -5266,6 +5806,10 @@ EAPI void evas_color_rgb_to_hsv(int r, int g, int b, float *h, float *s, float * * factor. Alpha factor is used to define transparency. * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_color_argb_premul(int a, int *r, int *g, int *b); @@ -5283,6 +5827,10 @@ EAPI void evas_color_argb_premul(int a, int *r, int *g, int *b); * @see evas_color_argb_premul(). * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_color_argb_unpremul(int a, int *r, int *g, int *b); @@ -5296,6 +5844,10 @@ EAPI void evas_color_argb_unpremul(int a, int *r, int *g, int *b); * factor. Alpha factor is used to define transparency. * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_data_argb_premul(unsigned int *data, unsigned int len); @@ -5309,6 +5861,10 @@ EAPI void evas_data_argb_premul(unsigned int *data, unsigned int len); * factor. Alpha factor is used to define transparency. * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif **/ EAPI void evas_data_argb_unpremul(unsigned int *data, unsigned int len); @@ -5332,6 +5888,10 @@ EAPI void evas_data_argb_unpremul(unsigned int *data, unsigned int len); * @return The byte index of the next character * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_string_char_next_get(const char *str, int pos, int *decoded) EINA_ARG_NONNULL(1); @@ -5353,6 +5913,10 @@ EAPI int evas_string_char_next_get(const char *str, int pos, int *decoded) EINA * @return The byte index of the previous character * * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_string_char_prev_get(const char *str, int pos, int *decoded) EINA_ARG_NONNULL(1); @@ -5361,6 +5925,10 @@ EAPI int evas_string_char_prev_get(const char *str, int pos, int *decoded) EINA * @param str The string to get the length of. * @return The length in characters (not bytes) * @ingroup Evas_Utils + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_string_char_len_get(const char *str) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -5430,6 +5998,10 @@ EAPI void evas_language_reinit(void); * @see evas_key_modifier_get * @see evas_key_modifier_on * @see evas_key_modifier_off + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_key_modifier_is_set(const Evas_Modifier *m, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); @@ -5449,6 +6021,10 @@ EAPI Eina_Bool evas_key_modifier_is_set(const Evas_Modifier *m, const * @see evas_key_lock_del * @see evas_key_lock_on * @see evas_key_lock_off + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_key_lock_is_set(const Evas_Lock *l, const char *keyname) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); @@ -5492,6 +6068,10 @@ typedef Eo Evas_Out; * for the application. * @ingroup Evas_Font_Path_Group * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_font_path_global_clear(void); @@ -5500,6 +6080,10 @@ EAPI void evas_font_path_global_clear(void); * @param path The new font path. * @ingroup Evas_Font_Path_Group * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_font_path_global_append(const char *path) EINA_ARG_NONNULL(1); @@ -5508,6 +6092,10 @@ EAPI void evas_font_path_global_append(const char *path) EINA * @param path The new font path. * @ingroup Evas_Font_Path_Group * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_font_path_global_prepend(const char *path) EINA_ARG_NONNULL(1); @@ -5516,6 +6104,10 @@ EAPI void evas_font_path_global_prepend(const char *path) EIN * @return The list of font paths used. * @ingroup Evas_Font_Path_Group * @since 1.9 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const Eina_List *evas_font_path_global_list(void) EINA_WARN_UNUSED_RESULT; @@ -5525,6 +6117,10 @@ EAPI const Eina_List *evas_font_path_global_list(void) EINA_WARN_UNUSED_R * * @ingroup Evas_Font_Path_Group * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_font_reinit(void); diff --git a/src/lib/evas/Evas_Legacy.h b/src/lib/evas/Evas_Legacy.h index ac50e49..33464a9 100644 --- a/src/lib/evas/Evas_Legacy.h +++ b/src/lib/evas/Evas_Legacy.h @@ -29,6 +29,10 @@ * * @return A new uninitialised Evas canvas on success. Otherwise, @c NULL. * @ingroup Evas_Canvas + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas *evas_new(void) EINA_WARN_UNUSED_RESULT EINA_MALLOC; @@ -41,6 +45,10 @@ EAPI Evas *evas_new(void) EINA_WARN_UNUSED_RESULT EINA_MALLOC; * @param e The given evas. * * @ingroup Evas_Canvas + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_free(Evas *e) EINA_ARG_NONNULL(1); @@ -118,6 +126,10 @@ EAPI void evas_free(Evas *e) EINA_ARG_NONNULL(1); * existed before exactly as the one being registered (and thus, call * it more than once on the event, in this case). This would make * sense if you passed different functions and/or callback data, only. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3); @@ -135,6 +147,10 @@ EAPI void evas_event_callback_add(Evas *e, Evas_Callback_Type type, Evas_Event_ * * @see evas_event_callback_add * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_event_callback_priority_add(Evas *e, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4); @@ -161,6 +177,10 @@ EAPI void evas_event_callback_priority_add(Evas *e, Evas_Callback_Type type, Ev * * my_data = evas_event_callback_del(ebject, EVAS_CALLBACK_CANVAS_FOCUS_IN, focus_in_callback); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func) EINA_ARG_NONNULL(1, 3); @@ -193,6 +213,10 @@ EAPI void *evas_event_callback_del(Evas *e, Evas_Callback_Type type, Evas_Event_ * * @note For deletion of canvas events callbacks filtering by just * type and function pointer, user evas_event_callback_del(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3); @@ -218,6 +242,9 @@ EAPI void *evas_event_callback_del_full(Evas *e, Evas_Callback_Type type, Evas_E * callback prepares information ready for taking action, but the post callback * actually does the action). * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_post_event_callback_push(Evas *e, Evas_Object_Event_Post_Cb func, const void *data); @@ -231,6 +258,10 @@ EAPI void evas_post_event_callback_push(Evas *e, Evas_Object_Event_Post_Cb func * evas_post_event_callback_push(). The first instance of the function in * the callback stack is removed from being executed when the stack is * unwound. Further instances may still be run on unwind. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_post_event_callback_remove(Evas *e, Evas_Object_Event_Post_Cb func); @@ -245,6 +276,10 @@ EAPI void evas_post_event_callback_remove(Evas *e, Evas_Object_Event_Post_Cb fu * evas_post_event_callback_push(). The first instance of the function and data * in the callback stack is removed from being executed when the stack is * unwound. Further instances may still be run on unwind. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_post_event_callback_remove_full(Evas *e, Evas_Object_Event_Post_Cb func, const void *data); @@ -286,6 +321,10 @@ EAPI void evas_post_event_callback_remove_full(Evas *e, Evas_Object_Event_Post_ * events for 3 seconds, when the "f" key is pressed. In a more * realistic code we would be freezing while a toolkit or Edje was * doing some UI changes, thawing it back afterwards. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_event_freeze(Evas *e) EINA_ARG_NONNULL(1); @@ -301,6 +340,10 @@ EAPI void evas_event_freeze(Evas *e) EINA_ARG_NONNULL(1); * evaluated. * * See evas_event_freeze() for an example. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_event_thaw(Evas *e) EINA_ARG_NONNULL(1); @@ -323,6 +366,9 @@ EAPI void evas_event_thaw(Evas *e) EINA_ARG_NONNULL(1); * while (evas_event_freeze_get(evas) > 0) evas_event_thaw(evas); * @endcode * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_event_freeze_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -334,6 +380,10 @@ EAPI int evas_event_freeze_get(const Evas *e) EINA_WARN_UNUSED_RESU * This is normally called after evas_event_thaw() to re-evaluate mouse * containment and other states and thus also call callbacks for mouse in and * out on new objects if the state change demands it. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_event_thaw_eval(Evas *e) EINA_ARG_NONNULL(1); /** @@ -353,6 +403,10 @@ EAPI void evas_event_thaw_eval(Evas *e) EINA_ARG_NONNULL(1); * @param available the list returned by evas_font_dir_available_list(). * * @ingroup Evas_Font_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_font_available_list_free(Evas *e, Eina_List *available) EINA_ARG_NONNULL(1); @@ -399,6 +453,10 @@ EAPI void evas_font_available_list_free(Evas *e, Eina_List *a * * @ingroup Evas_Object_Group_Basic * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_ref(Evas_Object *obj); @@ -417,6 +475,10 @@ EAPI void evas_object_ref(Evas_Object *obj); * * @ingroup Evas_Object_Group_Basic * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_unref(Evas_Object *obj); @@ -436,6 +498,10 @@ EAPI void evas_object_unref(Evas_Object *obj); * * @ingroup Evas_Object_Group_Basic * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_object_ref_get(const Evas_Object *obj); @@ -458,6 +524,10 @@ EAPI int evas_object_ref_get(const Evas_Object *obj); * @see evas_object_unref() * * @ingroup Evas_Object_Group_Basic + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_del(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -489,6 +559,10 @@ EAPI void evas_object_del(Evas_Object *obj) EINA_ARG_NONNULL(1); * See the full @ref Example_Evas_Events "example". * * @ingroup Evas_Object_Group_Basic + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1); @@ -516,6 +590,10 @@ EAPI void evas_object_geometry_get(const Evas_Object *obj, Evas_Coor * * @since 1.8 * @ingroup Evas_Object_Group_Basic + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_geometry_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1); @@ -532,6 +610,10 @@ EAPI void evas_object_geometry_set(Evas_Object *obj, Evas_Coord x, E * @see evas_object_visible_get() * * @ingroup Evas_Object_Group_Basic + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_show(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -564,6 +646,10 @@ EAPI void evas_object_show(Evas_Object *obj) EINA_ARG_NONNULL(1); * See the full @ref Example_Evas_Object_Manipulation "example". * * @ingroup Evas_Object_Group_Basic + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_hide(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -581,6 +667,10 @@ EAPI void evas_object_hide(Evas_Object *obj) EINA_ARG_NONNULL(1); * @param[in] g The green component of the given color. * @param[in] b The blue component of the given color. * @param[in] a The alpha component of the given color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); @@ -618,6 +708,10 @@ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); * @param[out] g The green component of the given color. * @param[out] b The blue component of the given color. * @param[out] a The alpha component of the given color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a); @@ -627,6 +721,10 @@ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, * * @param[in] x in * @param[in] y in + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); @@ -636,6 +734,10 @@ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); * * @param[in] w in * @param[in] h in + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h); @@ -643,6 +745,9 @@ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h); * * Retrieves whether or not the given Evas object is visible. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); @@ -667,6 +772,10 @@ EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); * * @param[in] l The number of the layer to place the object on. Must be between #EVAS_LAYER_MIN and #EVAS_LAYER_MAX. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_layer_set(Evas_Object *obj, short l); @@ -678,6 +787,9 @@ EAPI void evas_object_layer_set(Evas_Object *obj, short l); * * @see evas_object_layer_set() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI short evas_object_layer_get(const Evas_Object *obj); @@ -695,6 +807,9 @@ EAPI short evas_object_layer_get(const Evas_Object *obj); * @see evas_object_layer_set() * @see evas_object_below_get() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; @@ -712,6 +827,9 @@ EAPI Evas_Object *evas_object_below_get(const Evas_Object *obj) EINA_WARN_UNUSED * @see evas_object_layer_set() * @see evas_object_below_get() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT; @@ -741,6 +859,10 @@ EAPI Evas_Object *evas_object_above_get(const Evas_Object *obj) EINA_WARN_UNUSED * * * @param[in] below the object below which to stack + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG_NONNULL(2); @@ -756,6 +878,9 @@ EAPI void evas_object_stack_below(Evas_Object *obj, Evas_Object *below) EINA_ARG * @see evas_object_lower() * * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_raise(Evas_Object *obj); @@ -785,6 +910,10 @@ EAPI void evas_object_raise(Evas_Object *obj); * * * @param[in] above the object above which to stack + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG_NONNULL(2); @@ -800,6 +929,9 @@ EAPI void evas_object_stack_above(Evas_Object *obj, Evas_Object *above) EINA_ARG * @see evas_object_raise() * * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_lower(Evas_Object *obj); @@ -817,6 +949,10 @@ EAPI void evas_object_lower(Evas_Object *obj); * @param[in] g The green component of the given color. * @param[in] b The blue component of the given color. * @param[in] a The alpha component of the given color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); @@ -854,6 +990,10 @@ EAPI void evas_object_color_set(Evas_Object *obj, int r, int g, int b, int a); * @param[out] g The green component of the given color. * @param[out] b The blue component of the given color. * @param[out] a The alpha component of the given color. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a); @@ -863,6 +1003,10 @@ EAPI void evas_object_color_get(const Evas_Object *obj, int *r, int *g, int *b, * * @param[in] x in * @param[in] y in + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); @@ -872,6 +1016,10 @@ EAPI void evas_object_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y); * * @param[in] w in * @param[in] h in + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h); @@ -879,6 +1027,9 @@ EAPI void evas_object_resize(Evas_Object *obj, Evas_Coord w, Evas_Coord h); * * Retrieves whether or not the given Evas object is visible. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); @@ -1084,6 +1235,9 @@ EAPI Eina_Bool evas_object_visible_get(const Evas_Object *obj); * * See the full example @ref Example_Evas_Events "here". * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3); @@ -1100,6 +1254,10 @@ EAPI void evas_object_event_callback_add(Evas_Object *obj, Evas_Callback_Ty * * @see evas_object_event_callback_add * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_event_callback_priority_add(Evas_Object *obj, Evas_Callback_Type type, Evas_Callback_Priority priority, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 4); @@ -1126,6 +1284,10 @@ EAPI void evas_object_event_callback_priority_add(Evas_Object *obj, Evas_Ca * * my_data = evas_object_event_callback_del(object, EVAS_CALLBACK_MOUSE_UP, up_callback); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func) EINA_ARG_NONNULL(1, 3); @@ -1160,6 +1322,10 @@ EAPI void *evas_object_event_callback_del(Evas_Object *obj, Evas_Callback_Ty * * my_data = evas_object_event_callback_del_full(object, EVAS_CALLBACK_MOUSE_UP, up_callback, data); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callback_Type type, Evas_Object_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 3); @@ -1210,6 +1376,10 @@ EAPI void *evas_object_event_callback_del_full(Evas_Object *obj, Evas_Callba * evas_object_data_set(obj, "name_of_data", my_data); * printf("The data that was attached was %p\n", evas_object_data_get(obj, "name_of_data")); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_data_set(Evas_Object *obj, const char *key, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1241,6 +1411,10 @@ EAPI void evas_object_data_set(Evas_Object *obj, const char * if (my_data) printf("Data stored was %p\n", my_data); * else printf("No data was stored on the object\n"); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_object_data_get(const Evas_Object *obj, const char *key) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2); @@ -1263,6 +1437,10 @@ EAPI void *evas_object_data_get(const Evas_Object *obj, const * * my_data = evas_object_data_del(obj, "name_of_my_data"); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_object_data_del(Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2); @@ -1291,6 +1469,10 @@ EAPI void *evas_object_data_del(Evas_Object *obj, const char * @warning This function will @b skip objects parented by smart * objects, acting only on the ones at the "top level", with regard to * object parenting. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Object *evas_object_top_at_pointer_get(const Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -1316,6 +1498,9 @@ EAPI Evas_Object *evas_object_top_at_pointer_get(const Evas *e) EINA_WARN_UNUSED * * @see evas_object_intercept_show_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_show_callback_add(Evas_Object *obj, Evas_Object_Intercept_Show_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1330,6 +1515,9 @@ EAPI void evas_object_intercept_show_callback_add(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_show_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_show_callback_del(Evas_Object *obj, Evas_Object_Intercept_Show_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1345,6 +1533,9 @@ EAPI void *evas_object_intercept_show_callback_del(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_hide_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_hide_callback_add(Evas_Object *obj, Evas_Object_Intercept_Hide_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1359,6 +1550,9 @@ EAPI void evas_object_intercept_hide_callback_add(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_hide_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_hide_callback_del(Evas_Object *obj, Evas_Object_Intercept_Hide_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1374,6 +1568,9 @@ EAPI void *evas_object_intercept_hide_callback_del(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_move_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_move_callback_add(Evas_Object *obj, Evas_Object_Intercept_Move_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1388,6 +1585,9 @@ EAPI void evas_object_intercept_move_callback_add(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_move_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_move_callback_del(Evas_Object *obj, Evas_Object_Intercept_Move_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1403,6 +1603,9 @@ EAPI void *evas_object_intercept_move_callback_del(Evas_Object *obj, Evas_Object * * @see evas_object_intercept_resize_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_resize_callback_add(Evas_Object *obj, Evas_Object_Intercept_Resize_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1417,6 +1620,9 @@ EAPI void evas_object_intercept_resize_callback_add(Evas_Object *obj, Evas_Obje * * @see evas_object_intercept_resize_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_resize_callback_del(Evas_Object *obj, Evas_Object_Intercept_Resize_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1432,6 +1638,9 @@ EAPI void *evas_object_intercept_resize_callback_del(Evas_Object *obj, Evas_Obje * * @see evas_object_intercept_raise_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_raise_callback_add(Evas_Object *obj, Evas_Object_Intercept_Raise_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1446,6 +1655,9 @@ EAPI void evas_object_intercept_raise_callback_add(Evas_Object *obj, Evas_Objec * * @see evas_object_intercept_raise_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_raise_callback_del(Evas_Object *obj, Evas_Object_Intercept_Raise_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1461,6 +1673,9 @@ EAPI void *evas_object_intercept_raise_callback_del(Evas_Object *obj, Evas_Objec * * @see evas_object_intercept_lower_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_lower_callback_add(Evas_Object *obj, Evas_Object_Intercept_Lower_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1475,6 +1690,9 @@ EAPI void evas_object_intercept_lower_callback_add(Evas_Object *obj, Evas_Objec * * @see evas_object_intercept_lower_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_lower_callback_del(Evas_Object *obj, Evas_Object_Intercept_Lower_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1490,6 +1708,9 @@ EAPI void *evas_object_intercept_lower_callback_del(Evas_Object *obj, Evas_Objec * * @see evas_object_intercept_stack_above_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_stack_above_callback_add(Evas_Object *obj, Evas_Object_Intercept_Stack_Above_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1504,6 +1725,9 @@ EAPI void evas_object_intercept_stack_above_callback_add(Evas_Object *obj, Evas * * @see evas_object_intercept_stack_above_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_stack_above_callback_del(Evas_Object *obj, Evas_Object_Intercept_Stack_Above_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1519,6 +1743,9 @@ EAPI void *evas_object_intercept_stack_above_callback_del(Evas_Object *obj, Evas * * @see evas_object_intercept_stack_below_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_stack_below_callback_add(Evas_Object *obj, Evas_Object_Intercept_Stack_Below_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1533,6 +1760,9 @@ EAPI void evas_object_intercept_stack_below_callback_add(Evas_Object *obj, Evas * * @see evas_object_intercept_stack_below_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_stack_below_callback_del(Evas_Object *obj, Evas_Object_Intercept_Stack_Below_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1548,6 +1778,9 @@ EAPI void *evas_object_intercept_stack_below_callback_del(Evas_Object *obj, Evas * * @see evas_object_intercept_layer_set_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_layer_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Layer_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1562,6 +1795,9 @@ EAPI void evas_object_intercept_layer_set_callback_add(Evas_Object *obj, Evas_O * * @see evas_object_intercept_layer_set_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_layer_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Layer_Set_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1577,6 +1813,9 @@ EAPI void *evas_object_intercept_layer_set_callback_del(Evas_Object *obj, Evas_O * * @see evas_object_intercept_color_set_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_color_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Color_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1591,6 +1830,9 @@ EAPI void evas_object_intercept_color_set_callback_add(Evas_Object *obj, Evas_O * * @see evas_object_intercept_color_set_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_color_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Color_Set_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1606,6 +1848,9 @@ EAPI void *evas_object_intercept_color_set_callback_del(Evas_Object *obj, Evas_O * * @see evas_object_intercept_clip_set_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_clip_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Clip_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1620,6 +1865,9 @@ EAPI void evas_object_intercept_clip_set_callback_add(Evas_Object *obj, Evas_Ob * * @see evas_object_intercept_clip_set_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_clip_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Clip_Set_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1635,6 +1883,9 @@ EAPI void *evas_object_intercept_clip_set_callback_del(Evas_Object *obj, Evas_Ob * * @see evas_object_intercept_clip_unset_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_clip_unset_callback_add(Evas_Object *obj, Evas_Object_Intercept_Clip_Unset_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1649,6 +1900,9 @@ EAPI void evas_object_intercept_clip_unset_callback_add(Evas_Object *obj, Evas_ * * @see evas_object_intercept_clip_unset_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_clip_unset_callback_del(Evas_Object *obj, Evas_Object_Intercept_Clip_Unset_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1664,6 +1918,9 @@ EAPI void *evas_object_intercept_clip_unset_callback_del(Evas_Object *obj, Evas_ * * @see evas_object_intercept_focus_set_callback_del(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_intercept_focus_set_callback_add(Evas_Object *obj, Evas_Object_Intercept_Focus_Set_Cb func, const void *data) EINA_ARG_NONNULL(1, 2); @@ -1678,6 +1935,9 @@ EAPI void evas_object_intercept_focus_set_callback_add(Evas_Object *obj, Evas_O * * @see evas_object_intercept_focus_set_callback_add(). * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_intercept_focus_set_callback_del(Evas_Object *obj, Evas_Object_Intercept_Focus_Set_Cb func) EINA_ARG_NONNULL(1, 2); @@ -1697,6 +1957,10 @@ EAPI void *evas_object_intercept_focus_set_callback_del(Evas_Object *obj, Evas_O * @return The new rectangle object. * * @ingroup Evas_Object_Rectangle + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -1791,6 +2055,10 @@ EAPI Evas_Object *evas_object_rectangle_add(Evas *e) EINA_WARN_UNUSED_RESULT EIN * * @see evas_obj_vg_root_node_get() * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Object *evas_object_vg_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -1805,6 +2073,10 @@ EAPI void evas_object_vg_path_set(Evas_Object *vg, const char *path, int src_vg, * @return The created vector shape object handle. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Efl_VG* evas_vg_shape_add(Efl_VG *parent); @@ -1815,6 +2087,10 @@ EAPI Efl_VG* evas_vg_shape_add(Efl_VG *parent); * @return The created vector container object handle. * * @since 1.14 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Efl_VG* evas_vg_container_add(Efl_VG *parent); @@ -1824,6 +2100,9 @@ EAPI Efl_VG* evas_vg_container_add(Efl_VG *parent); * Retrieves whether or not the given Efl_Vg object is visible. * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Eina_Bool evas_vg_node_visible_get(Eo *obj); @@ -1833,6 +2112,9 @@ EAPI Eina_Bool evas_vg_node_visible_get(Eo *obj); * * @param[in] v @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_visible_set(Eo *obj, Eina_Bool v); @@ -1855,6 +2137,9 @@ EAPI void evas_vg_node_visible_set(Eo *obj, Eina_Bool v); * @param[out] b The blue component of the given color. * @param[out] a The alpha component of the given color. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_color_get(Eo *obj, int *r, int *g, int *b, int *a); @@ -1873,6 +2158,9 @@ EAPI void evas_vg_node_color_get(Eo *obj, int *r, int *g, int *b, int *a); * @param[in] b The blue component of the given color. * @param[in] a The alpha component of the given color. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_color_set(Eo *obj, int r, int g, int b, int a); @@ -1885,6 +2173,9 @@ EAPI void evas_vg_node_color_set(Eo *obj, int r, int g, int b, int a); * @param[out] w in * @param[out] h in * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_geometry_get(Eo *obj, int *x, int *y, int *w, int *h); @@ -1897,6 +2188,9 @@ EAPI void evas_vg_node_geometry_get(Eo *obj, int *x, int *y, int *w, int *h); * @param[in] w in * @param[in] h in * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_geometry_set(Eo *obj, int x, int y, int w, int h); @@ -1927,6 +2221,9 @@ EAPI void evas_vg_node_geometry_set(Eo *obj, int x, int y, int w, int h); * * @param[in] below the object below which to stack * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_stack_below(Eo *obj, Eo *below); @@ -1957,6 +2254,9 @@ EAPI void evas_vg_node_stack_below(Eo *obj, Eo *below); * * @param[in] above the object above which to stack * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_stack_above(Eo *obj, Eo *above); @@ -1971,6 +2271,10 @@ EAPI void evas_vg_node_stack_above(Eo *obj, Eo *above); * @see evas_object_stack_below() * @see evas_object_lower() * + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_raise(Eo *obj); @@ -1987,6 +2291,9 @@ EAPI void evas_vg_node_raise(Eo *obj); * * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_node_lower(Eo *obj); @@ -1998,6 +2305,9 @@ EAPI void evas_vg_node_lower(Eo *obj); * @since 1.14 * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double evas_vg_shape_stroke_scale_get(Eo *obj); @@ -2009,6 +2319,9 @@ EAPI double evas_vg_shape_stroke_scale_get(Eo *obj); * * @param[in] s stroke scale value * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_scale_set(Eo *obj, double s); @@ -2022,6 +2335,9 @@ EAPI void evas_vg_shape_stroke_scale_set(Eo *obj, double s); * @param[out] b The blue component of the given color. * @param[out] a The alpha component of the given color. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_color_get(Eo *obj, int *r, int *g, int *b, int *a); @@ -2035,6 +2351,9 @@ EAPI void evas_vg_shape_stroke_color_get(Eo *obj, int *r, int *g, int *b, int *a * @param[in] b The blue component of the given color. * @param[in] a The alpha component of the given color. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_color_set(Eo *obj, int r, int g, int b, int a); @@ -2044,6 +2363,9 @@ EAPI void evas_vg_shape_stroke_color_set(Eo *obj, int r, int g, int b, int a); * @since 1.14 * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double evas_vg_shape_stroke_width_get(Eo *obj); @@ -2054,6 +2376,9 @@ EAPI double evas_vg_shape_stroke_width_get(Eo *obj); * * @param[in] w stroke width to be used * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_width_set(Eo *obj, double w); @@ -2062,6 +2387,9 @@ EAPI void evas_vg_shape_stroke_width_set(Eo *obj, double w); * Not Implemented * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double evas_vg_shape_stroke_location_get(Eo *obj); @@ -2071,6 +2399,9 @@ EAPI double evas_vg_shape_stroke_location_get(Eo *obj); * * @param[in] centered * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_location_set(Eo *obj, double centered); @@ -2081,6 +2412,9 @@ EAPI void evas_vg_shape_stroke_location_set(Eo *obj, double centered); * @param[out] dash * @param[out] length * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_dash_get(Eo *obj, const Efl_Gfx_Dash **dash, unsigned int *length); @@ -2091,6 +2425,9 @@ EAPI void evas_vg_shape_stroke_dash_get(Eo *obj, const Efl_Gfx_Dash **dash, unsi * @param[in] dash * @param[in] length * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_dash_set(Eo *obj, const Efl_Gfx_Dash *dash, unsigned int length); @@ -2100,6 +2437,9 @@ EAPI void evas_vg_shape_stroke_dash_set(Eo *obj, const Efl_Gfx_Dash *dash, unsig * @since 1.14 * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Efl_Gfx_Cap evas_vg_shape_stroke_cap_get(Eo *obj); @@ -2114,6 +2454,9 @@ EAPI Efl_Gfx_Cap evas_vg_shape_stroke_cap_get(Eo *obj); * * @param[in] c cap style to use , default is EFL_GFX_CAP_BUTT * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_cap_set(Eo *obj, Efl_Gfx_Cap c); @@ -2123,6 +2466,9 @@ EAPI void evas_vg_shape_stroke_cap_set(Eo *obj, Efl_Gfx_Cap c); * @since 1.14 * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Efl_Gfx_Join evas_vg_shape_stroke_join_get(Eo *obj); @@ -2138,6 +2484,9 @@ EAPI Efl_Gfx_Join evas_vg_shape_stroke_join_get(Eo *obj); * @param[in] j join style to use , default is EFL_GFX_JOIN_MITER * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_stroke_join_set(Eo *obj, Efl_Gfx_Join j); @@ -2153,6 +2502,9 @@ EAPI void evas_vg_shape_stroke_join_set(Eo *obj, Efl_Gfx_Join j); * @param[in] op command list * @param[in] points point list * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_path_set(Eo *obj, const Efl_Gfx_Path_Command *op, const double *points); @@ -2164,6 +2516,9 @@ EAPI void evas_vg_shape_shape_path_set(Eo *obj, const Efl_Gfx_Path_Command *op, * @param[out] op command list * @param[out] points point list * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_path_get(Eo *obj, const Efl_Gfx_Path_Command **op, const double **points); @@ -2180,6 +2535,9 @@ EAPI void evas_vg_shape_shape_current_ctrl_get(Eo *obj, double *x, double *y); * * @param[in] dup_from Shape object from where data will be copied. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_dup(Eo *obj, Eo *dup_from); @@ -2191,6 +2549,9 @@ EAPI void evas_vg_shape_shape_dup(Eo *obj, Eo *dup_from); * * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_reset(Eo *obj); @@ -2206,6 +2567,9 @@ EAPI void evas_vg_shape_shape_reset(Eo *obj); * @param[in] x X co-ordinate of the current point. * @param[in] y Y co-ordinate of the current point. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_move_to(Eo *obj, double x, double y); @@ -2225,6 +2589,9 @@ EAPI void evas_vg_shape_shape_append_move_to(Eo *obj, double x, double y); * @param[in] x X co-ordinate of end point of the line. * @param[in] y Y co-ordinate of end point of the line. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_line_to(Eo *obj, double x, double y); @@ -2243,6 +2610,9 @@ EAPI void evas_vg_shape_shape_append_line_to(Eo *obj, double x, double y); * @param[in] ctrl_x X co-ordinate of control point. * @param[in] ctrl_y Y co-ordinate of control point. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_quadratic_to(Eo *obj, double x, double y, double ctrl_x, double ctrl_y); @@ -2258,6 +2628,9 @@ EAPI void evas_vg_shape_shape_append_quadratic_to(Eo *obj, double x, double y, d * @param[in] x X co-ordinate of end point of the line. * @param[in] y Y co-ordinate of end point of the line. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_squadratic_to(Eo *obj, double x, double y); @@ -2278,6 +2651,9 @@ EAPI void evas_vg_shape_shape_append_squadratic_to(Eo *obj, double x, double y); * @param[in] ctrl_x1 X co-ordinate of 2nd control point. * @param[in] ctrl_y1 Y co-ordinate of 2nd control point. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_cubic_to(Eo *obj, double x, double y, double ctrl_x0, double ctrl_y0, double ctrl_x1, double ctrl_y1); @@ -2296,6 +2672,9 @@ EAPI void evas_vg_shape_shape_append_cubic_to(Eo *obj, double x, double y, doubl * @param[in] ctrl_x X co-ordinate of 2nd control point. * @param[in] ctrl_y Y co-ordinate of 2nd control point. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_scubic_to(Eo *obj, double x, double y, double ctrl_x, double ctrl_y); @@ -2320,6 +2699,9 @@ EAPI void evas_vg_shape_shape_append_scubic_to(Eo *obj, double x, double y, doub * @param[in] large_arc Defines whether to draw the larger arc or smaller arc joining two point. * @param[in] sweep Defines whether the arc will be drawn counter-clockwise or clockwise from current point to the end point taking into account the large_arc property. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_arc_to(Eo *obj, double x, double y, double rx, double ry, double angle, Eina_Bool large_arc, Eina_Bool sweep); @@ -2353,6 +2735,9 @@ EAPI void evas_vg_shape_shape_append_arc(Eo *obj, double x, double y, double w, * * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_close(Eo *obj); @@ -2368,6 +2753,9 @@ EAPI void evas_vg_shape_shape_append_close(Eo *obj); * @param[in] y Y co-ordinate of the center of the circle. * @param[in] radius radius of the circle. * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_circle(Eo *obj, double x, double y, double radius); @@ -2392,6 +2780,9 @@ EAPI void evas_vg_shape_shape_append_circle(Eo *obj, double x, double y, double * @param[in] rx The x radius of the rounded corner and should be in range [ 0 to w/2 ] * @param[in] ry The y radius of the rounded corner and should be in range [ 0 to h/2 ] * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_shape_shape_append_rect(Eo *obj, double x, double y, double w, double h, double rx, double ry); @@ -2409,6 +2800,9 @@ EAPI Eina_Bool evas_vg_shape_shape_equal_commands(Eo *obj, const Eo *with); * @param[in] colors color stops list * @param[in] length length of the list * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_stop_set(Eo *obj, const Efl_Gfx_Gradient_Stop *colors, unsigned int length); @@ -2420,6 +2814,9 @@ EAPI void evas_vg_gradient_stop_set(Eo *obj, const Efl_Gfx_Gradient_Stop *colors * @param[out] colors color stops list * @param[out] length length of the list * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_stop_get(Eo *obj, const Efl_Gfx_Gradient_Stop **colors, unsigned int *length); @@ -2430,6 +2827,9 @@ EAPI void evas_vg_gradient_stop_get(Eo *obj, const Efl_Gfx_Gradient_Stop **color * * @param[in] s spread type to be used * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_spread_set(Eo *obj, Efl_Gfx_Gradient_Spread s); @@ -2440,6 +2840,9 @@ EAPI void evas_vg_gradient_spread_set(Eo *obj, Efl_Gfx_Gradient_Spread s); * @since 1.14 * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Efl_Gfx_Gradient_Spread evas_vg_gradient_spread_get(Eo *obj); @@ -2452,6 +2855,9 @@ EAPI Efl_Gfx_Gradient_Spread evas_vg_gradient_spread_get(Eo *obj); * @param[in] x x co-ordinate of start point * @param[in] y y co-ordinate of start point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_linear_start_set(Eo *obj, double x, double y); @@ -2462,6 +2868,9 @@ EAPI void evas_vg_gradient_linear_start_set(Eo *obj, double x, double y); * @param[out] x x co-ordinate of start point * @param[out] y y co-ordinate of start point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_linear_start_get(Eo *obj, double *x, double *y); @@ -2472,6 +2881,9 @@ EAPI void evas_vg_gradient_linear_start_get(Eo *obj, double *x, double *y); * @param[in] x x co-ordinate of end point * @param[in] y y co-ordinate of end point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_linear_end_set(Eo *obj, double x, double y); @@ -2482,6 +2894,9 @@ EAPI void evas_vg_gradient_linear_end_set(Eo *obj, double x, double y); * @param[out] x x co-ordinate of end point * @param[out] y y co-ordinate of end point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_linear_end_get(Eo *obj, double *x, double *y); @@ -2494,6 +2909,9 @@ EAPI void evas_vg_gradient_linear_end_get(Eo *obj, double *x, double *y); * @param[in] x x co-ordinate of center point * @param[in] y y co-ordinate of center point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_radial_center_set(Eo *obj, double x, double y); @@ -2504,6 +2922,9 @@ EAPI void evas_vg_gradient_radial_center_set(Eo *obj, double x, double y); * @param[out] x x co-ordinate of center point * @param[out] y y co-ordinate of center point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_radial_center_get(Eo *obj, double *x, double *y); @@ -2513,6 +2934,9 @@ EAPI void evas_vg_gradient_radial_center_get(Eo *obj, double *x, double *y); * * @param[in] r center radius * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_radial_radius_set(Eo *obj, double r); @@ -2521,6 +2945,9 @@ EAPI void evas_vg_gradient_radial_radius_set(Eo *obj, double r); * Gets the center radius of this radial gradient. * * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI double evas_vg_gradient_radial_radius_get(Eo *obj); @@ -2531,6 +2958,9 @@ EAPI double evas_vg_gradient_radial_radius_get(Eo *obj); * @param[in] x x co-ordinate of focal point * @param[in] y y co-ordinate of focal point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_radial_focal_set(Eo *obj, double x, double y); @@ -2541,6 +2971,9 @@ EAPI void evas_vg_gradient_radial_focal_set(Eo *obj, double x, double y); * @param[out] x x co-ordinate of focal point * @param[out] y y co-ordinate of focal point * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_vg_gradient_radial_focal_get(Eo *obj, double *x, double *y); @@ -2578,6 +3011,10 @@ EAPI void evas_vg_gradient_radial_focal_get(Eo *obj, double *x, double *y); * img = evas_object_image_add(canvas); * evas_object_image_file_set(img, "/path/to/img", NULL); * @endcode + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_image_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -2598,6 +3035,10 @@ EAPI Evas_Object *evas_object_image_add(Evas *e) EINA_WARN_UNUS * @see evas_object_image_add() * @see evas_object_image_filled_set() * @see evas_object_image_fill_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_image_filled_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -2623,6 +3064,10 @@ EAPI Evas_Object *evas_object_image_filled_add(Evas *e) EINA_WA * @param size The size of the image file data in bytes * @param format The format of the file (optional), or @c NULL if not needed * @param key The image key in file, or @c NULL. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_memfile_set(Evas_Object *obj, void *data, int size, char *format, char *key) EINA_ARG_NONNULL(1, 2); @@ -2634,6 +3079,9 @@ EAPI void evas_object_image_memfile_set(Evas_Object *ob * * This function sets a native surface of a given canvas image. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_native_surface_set(Evas_Object *obj, Evas_Native_Surface *surf) EINA_ARG_NONNULL(1, 2); @@ -2661,6 +3109,10 @@ EAPI void evas_object_image_native_surface_set(Evas_Obj * of the former until the image is loaded). It is highly advisable, * then, that the user preload an image with it being @b hidden, just * to be shown on the #EVAS_CALLBACK_IMAGE_PRELOADED event's callback. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_preload(Evas_Object *obj, Eina_Bool cancel) EINA_ARG_NONNULL(1); @@ -2672,6 +3124,10 @@ EAPI void evas_object_image_preload(Evas_Object *obj, E * * This is equivalent to calling evas_object_image_source_set() with a * @c NULL source. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_source_unset(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -2686,6 +3142,10 @@ EAPI Eina_Bool evas_object_image_source_unset(Evas_Object *o * * @param obj Object to use as an alpha mask. * @param ismask Use image as alphamask, must be true. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_alpha_mask_set(Evas_Object *obj, Eina_Bool ismask) EINA_ARG_NONNULL(1); @@ -2719,6 +3179,10 @@ EAPI void evas_object_image_alpha_mask_set(Evas_Object * @param[in] file The image file path. * @param[in] key The image key in @p file (if its an Eet one), or @c NULL, otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_file_set(Eo *obj, const char *file, const char *key); @@ -2735,6 +3199,10 @@ EAPI void evas_object_image_file_set(Eo *obj, const char *file, const char *key) * @param[out] file The image file path. * @param[out] key The image key in @p file (if its an Eet one), or @c NULL, otherwise. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_file_get(const Eo *obj, const char **file, const char **key); @@ -2752,6 +3220,10 @@ EAPI void evas_object_image_file_get(const Eo *obj, const char **file, const cha * @param[in] f The mmaped file * @param[in] key The image key in @p file (if its an Eet one), or @c NULL, otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_image_mmap_set(Eo *obj, const Eina_File *f, const char *key); @@ -2769,6 +3241,10 @@ EAPI void evas_object_image_mmap_set(Eo *obj, const Eina_File *f, const char *ke * @param[out] f The mmaped file * @param[out] key The image key in @p file (if its an Eet one), or @c NULL, otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_image_mmap_get(const Eo *obj, const Eina_File **f, const char **key); @@ -2791,6 +3267,10 @@ obligatory). otherwise. * @param[in] flags String containing the flags to be used (@c NULL for none). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_save(const Eo *obj, const char *file, const char *key, const char *flags) EINA_ARG_NONNULL(2); @@ -2845,6 +3325,9 @@ EAPI Eina_Bool evas_object_image_save(const Eo *obj, const char *file, const cha * @see evas_object_image_animated_frame_set() * @since 1.1 * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_animated_get(const Eo *obj); @@ -2863,6 +3346,10 @@ EAPI Eina_Bool evas_object_image_animated_get(const Eo *obj); * * @param[in] w The new width of the image's load size. * @param[in] h The new height of the image's load size. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_load_size_set(Eo *obj, int w, int h); @@ -2882,6 +3369,10 @@ EAPI void evas_object_image_load_size_set(Eo *obj, int w, int h); * * @param[out] w The new width of the image's load size. * @param[out] h The new height of the image's load size. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_load_size_get(const Eo *obj, int *w, int *h); @@ -2901,6 +3392,10 @@ EAPI void evas_object_image_load_size_get(const Eo *obj, int *w, int *h); * @see evas_object_image_smooth_scale_get() * * @param[in] smooth_scale Whether to use smooth scale or not. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_smooth_scale_set(Eo *obj, Eina_Bool smooth_scale); @@ -2913,6 +3408,9 @@ EAPI void evas_object_image_smooth_scale_set(Eo *obj, Eina_Bool smooth_scale); * * See @ref evas_object_image_smooth_scale_set() for more details. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_image_smooth_scale_get(const Eo *obj); @@ -2922,6 +3420,10 @@ EAPI Eina_Bool evas_object_image_smooth_scale_get(const Eo *obj); * EVAS_TEXTURE_RESTRICT, or EVAS_TEXTURE_PAD. * * @param[in] spread One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT, + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_fill_spread_set(Evas_Object *obj, Evas_Fill_Spread spread); @@ -2932,6 +3434,9 @@ EAPI void evas_object_image_fill_spread_set(Evas_Object *obj, Evas_Fill_Spread s * * @return The current spread mode of the image object. * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Fill_Spread evas_object_image_fill_spread_get(const Evas_Object *obj); @@ -2971,6 +3476,10 @@ image) to start drawing from. image) to start drawing from. * @param[in] w The width the bound image will be displayed at. * @param[in] h The height the bound image will be displayed at. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_fill_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h); @@ -2990,6 +3499,10 @@ image) to start drawing from. image) to start drawing from. * @param[out] w The width the bound image will be displayed at. * @param[out] h The height the bound image will be displayed at. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_fill_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h); @@ -3005,6 +3518,10 @@ EAPI void evas_object_image_fill_get(const Evas_Object *obj, Evas_Coord *x, Evas * * @param[in] w The new width of the image. * @param[in] h The new height of the image. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_size_set(Evas_Object *obj, int w, int h); @@ -3016,6 +3533,10 @@ EAPI void evas_object_image_size_set(Evas_Object *obj, int w, int h); * * @param[out] w The new width of the image. * @param[out] h The new height of the image. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_image_size_get(const Evas_Object *obj, int *w, int *h); @@ -3035,7 +3556,13 @@ EAPI void evas_object_image_size_get(const Evas_Object *obj, int *w, int *h); * * @param[in] to_cspace The colorspace to which the image raw data will be converted. */ -/** @deprecated evas_object_image_data_convert */ +/** + * @deprecated evas_object_image_data_conver + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + */ EAPI void *evas_object_image_data_convert(Evas_Object *obj, Evas_Colorspace to_cspace) EINA_WARN_UNUSED_RESULT EINA_DEPRECATED; /* @@ -3045,7 +3572,13 @@ EAPI void *evas_object_image_data_convert(Evas_Object *obj, Evas_Colorspace to_c * * @param[in] pixels The pixel's source to be imported. */ -/** @deprecated evas_object_image_pixels_import */ +/** + * @deprecated evas_object_image_pixels_impor + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + */ EAPI Eina_Bool evas_object_image_pixels_import(Evas_Object *obj, Evas_Pixel_Import_Source *pixels) EINA_ARG_NONNULL(2) EINA_DEPRECATED; /* @@ -3053,7 +3586,13 @@ EAPI Eina_Bool evas_object_image_pixels_import(Evas_Object *obj, Evas_Pixel_Impo * * This function reloads the image data bound to image object @p obj. */ -/** @deprecated evas_object_image_reload */ +/** + * @deprecated evas_object_image_reloa + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif + */ EAPI void evas_object_image_reload(Evas_Object *obj) EINA_DEPRECATED; #include "canvas/evas_image.eo.legacy.h" @@ -3081,6 +3620,10 @@ EAPI void evas_object_image_reload(Evas_Object *obj) EINA_DEPRECATED; * @see evas_object_text_font_source_set() * @see evas_object_text_font_set() * @see evas_object_text_text_set() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_text_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3091,6 +3634,10 @@ EAPI Evas_Object *evas_object_text_add(Evas *e) EINA_WARN_UNUSED_RESULT * @see evas_object_text_text_get() * * @param[in] text Text string to display on it. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_text_text_set(Eo *obj, const char *text); @@ -3105,6 +3652,9 @@ EAPI void evas_object_text_text_set(Eo *obj, const char *text); * * @see evas_object_text_text_set() * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_object_text_text_get(const Eo *obj); @@ -3121,6 +3671,10 @@ EAPI const char *evas_object_text_text_get(const Eo *obj); * @see evas_object_text_font_get() * * @param[in] font_source The font file's path. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_text_font_source_set(Eo *obj, const char *font_source); @@ -3133,6 +3687,9 @@ EAPI void evas_object_text_font_source_set(Eo *obj, const char *font_source); * * @see evas_object_text_font_get() for more details * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI const char *evas_object_text_font_source_get(const Eo *obj); @@ -3151,6 +3708,10 @@ EAPI const char *evas_object_text_font_source_get(const Eo *obj); * * @param[in] font The font family name or filename. * @param[in] size The font size, in points. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_text_font_set(Eo *obj, const char *font, Evas_Font_Size size); @@ -3167,6 +3728,10 @@ EAPI void evas_object_text_font_set(Eo *obj, const char *font, Evas_Font_Size si * * @param[out] font The font family name or filename. * @param[out] size The font size, in points. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_text_font_get(const Eo *obj, const char **font, Evas_Font_Size *size); @@ -3183,6 +3748,10 @@ EAPI void evas_object_text_font_get(const Eo *obj, const char **font, Evas_Font_ * Set to null to disable filtering. * * @param[in] code filter program source code + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void evas_object_text_filter_program_set(Eo *obj, const char *code); @@ -3195,6 +3764,10 @@ EINA_DEPRECATED EAPI void evas_object_text_filter_program_set(Eo *obj, const cha * * @param[in] buffer name as used in the program * @param[in] source object to use as a proxy source + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EINA_DEPRECATED EAPI void evas_object_text_filter_source_set(Eo *obj, const char *name, Evas_Object *eo_source); @@ -3219,6 +3792,10 @@ EAPI Eina_Bool evas_object_text_ellipsis_status_g * Adds a textblock to the given evas. * @param e The given evas. * @return The new textblock object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_textblock_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3234,6 +3811,10 @@ EAPI Evas_Object *evas_object_textblock_add(Evas *e) * @param text The markup text (if @c NULL, return @c NULL). * @return An allocated plain text version of the markup. * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *evas_textblock_text_markup_to_utf8(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC; @@ -3248,6 +3829,10 @@ EAPI char *evas_textblock_text_markup_to_utf8 * @param text The plain text (if @c NULL, return @c NULL). * @return An allocated markup version of the plain text. * @since 1.2 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI char *evas_textblock_text_utf8_to_markup(const Evas_Object *obj, const char *text) EINA_WARN_UNUSED_RESULT EINA_MALLOC; @@ -3257,6 +3842,10 @@ EAPI char *evas_textblock_text_utf8_to_markup * * @param obj the object to clear. * @return nothing. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_textblock_clear(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -3287,6 +3876,10 @@ EAPI Eina_Bool evas_object_textblock_ellipsis_sta * This function adds a new textgrid object to the Evas @p e and returns the object. * * @since 1.7 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Object *evas_object_textgrid_add(Evas *e); @@ -3309,6 +3902,10 @@ EAPI Evas_Object *evas_object_textgrid_add(Evas *e); * @since 1.7 * * @param[in] font_source The font file's path. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_textgrid_font_source_set(Eo *obj, const char *font_source); @@ -3328,6 +3925,9 @@ EAPI void evas_object_textgrid_font_source_set(Eo *obj, const char *font_source) * * @since 1.7 * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const char *evas_object_textgrid_font_source_get(const Eo *obj); @@ -3352,6 +3952,10 @@ EAPI const char *evas_object_textgrid_font_source_get(const Eo *obj); * * @param[in] font_name The font (family) name. * @param[in] font_size The font size, in points. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_textgrid_font_set(Eo *obj, const char *font_name, Evas_Font_Size font_size); @@ -3375,6 +3979,10 @@ EAPI void evas_object_textgrid_font_set(Eo *obj, const char *font_name, Evas_Fon * * @param[out] font_name The font (family) name. * @param[out] font_size The font size, in points. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_textgrid_font_get(const Eo *obj, const char **font_name, Evas_Font_Size *font_size); @@ -3391,6 +3999,10 @@ EAPI void evas_object_textgrid_font_get(const Eo *obj, const char **font_name, E * Adds a new evas line object to the given evas. * @param e The given evas. * @return The new evas line object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_line_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3409,6 +4021,10 @@ EAPI Evas_Object *evas_object_line_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG * Adds a new evas polygon object to the given evas. * @param e The given evas. * @return A new evas polygon object. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_polygon_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3442,6 +4058,10 @@ EAPI Evas_Object *evas_object_polygon_add(Evas *e) EINA_WARN_UNUSED_RESULT EINA_ * #EVAS_SMART_SUBCLASS_NEW, for example. * * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1, 2) EINA_MALLOC; @@ -3464,6 +4084,10 @@ EAPI Evas_Object *evas_object_smart_add(Evas *e, Evas_Smart *s) EINA_WARN_UNUSED * @see evas_object_smart_members_get() * * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *smart_obj) EINA_ARG_NONNULL(1, 2); @@ -3479,6 +4103,10 @@ EAPI void evas_object_smart_member_add(Evas_Object *obj, Evas_Object *sm * * @see evas_object_smart_member_add() for more details * @see evas_object_smart_members_get() + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_smart_member_del(Evas_Object *obj) EINA_ARG_NONNULL(1); @@ -3519,6 +4147,10 @@ EAPI void evas_object_smart_member_del(Evas_Object *obj) EINA_ARG_NONNUL * * @see evas_object_smart_callback_del() * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *event, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1, 2, 3); @@ -3536,6 +4168,10 @@ EAPI void evas_object_smart_callback_add(Evas_Object *obj, const char *e * @see evas_object_smart_callback_add * @since 1.1 * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, const char *event, Evas_Callback_Priority priority, Evas_Smart_Cb func, const void *data); @@ -3559,6 +4195,10 @@ EAPI void evas_object_smart_callback_priority_add(Evas_Object *obj, cons * @see evas_object_smart_callback_add() for more details. * * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *event, Evas_Smart_Cb func) EINA_ARG_NONNULL(1, 2, 3); @@ -3587,6 +4227,10 @@ EAPI void *evas_object_smart_callback_del(Evas_Object *obj, const char *e * * @note To delete all smart event callbacks which match @p type and @p func, * use evas_object_smart_callback_del(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ 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); @@ -3610,6 +4254,10 @@ EAPI void *evas_object_smart_callback_del_full(Evas_Object *obj, const ch * can have introspection on its events API at run time. * * @ingroup Evas_Smart_Object_Group + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char *event, void *event_info) EINA_ARG_NONNULL(1, 2); @@ -3625,6 +4273,10 @@ EAPI void evas_object_smart_callback_call(Evas_Object *obj, const char * * * @return The interface's handle pointer, if found, @c NULL * otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI const void *evas_object_smart_interface_get(const Evas_Object *obj, const char *name); @@ -3638,6 +4290,10 @@ EAPI const void *evas_object_smart_interface_get(const Evas_Object *obj, c * * @return The object interface's private data blob pointer, if found, * @c NULL otherwise. + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void *evas_object_smart_interface_data_get(const Evas_Object *obj, const Evas_Smart_Interface *iface); @@ -3656,6 +4312,10 @@ EAPI void *evas_object_smart_interface_data_get(const Evas_Object *o * * @ingroup Evas_Smart_Object_Group * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI int evas_smart_objects_calculate_count_get(const Evas *e); @@ -3681,6 +4341,10 @@ EAPI int evas_smart_objects_calculate_count_get(const Evas *e); * properties, like colors. * * @see evas_object_smart_clipped_smart_add() + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Object *obj) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1); @@ -3708,6 +4372,10 @@ EAPI Evas_Object *evas_object_smart_clipped_clipper_get(const Evas_Ob * set to evas_object_box_layout_horizontal(). The remaining * properties of the box must be set/retrieved via * evas_object_box_{h,v}_{align,padding}_{get,set)(). + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_box_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3727,6 +4395,10 @@ EAPI Evas_Object *evas_object_box_add(Evas *evas) EINA_WARN_UNUSED * This is a variable argument list variant of the * evas_object_box_option_property_get(). See its documentation for * more details. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_box_option_property_vget(const Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) EINA_ARG_NONNULL(1, 2); @@ -3746,6 +4418,10 @@ EAPI Eina_Bool evas_object_box_option_property_vget(const Evas_ * This is a variable argument list variant of the * evas_object_box_option_property_set(). See its documentation for * more details. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_box_option_property_vset(Evas_Object *o, Evas_Object_Box_Option *opt, int property, va_list args) EINA_ARG_NONNULL(1, 2); @@ -3773,6 +4449,10 @@ EAPI Eina_Bool evas_object_box_option_property_vset(Evas_Object * list, with the values passed after @p property, and call * evas_object_box_option_property_vset() with this list and the same * previous arguments. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_box_option_property_set(Evas_Object *o, Evas_Object_Box_Option *opt, int property, ...) EINA_ARG_NONNULL(1, 2); @@ -3800,6 +4480,10 @@ EAPI Eina_Bool evas_object_box_option_property_set(Evas_Object * list, with the values passed after @p property, and call * evas_object_box_option_property_vget() with this list and the same * previous arguments. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_Bool evas_object_box_option_property_get(const Evas_Object *o, Evas_Object_Box_Option *opt, int property, ...) EINA_ARG_NONNULL(1, 2); @@ -3817,6 +4501,10 @@ EAPI Eina_Bool evas_object_box_option_property_get(const Evas_O * It's up to the user to destroy it when it no longer needs it. * It's possible to remove objects from the box when walking * this list, but these removals won't be reflected on it. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Eina_List *evas_object_box_children_get(const Evas_Object *o) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3835,6 +4523,10 @@ EAPI Eina_List *evas_object_box_children_get(const Evas_Object * * @brief Create a new table. * * @param evas Canvas in which table will be added. + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_table_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3842,6 +4534,10 @@ EAPI Evas_Object *evas_object_table_add(Evas *evas) EINA_W * Get the child of the table at the given coordinates * * @note This does not take into account col/row spanning + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_table_child_get(const Evas_Object *o, unsigned short col, unsigned short row) EINA_ARG_NONNULL(1); @@ -3862,6 +4558,10 @@ EAPI Evas_Object *evas_object_table_child_get(const Evas_O * It's set to a virtual size of 1x1 by default and add children with * evas_object_grid_pack(). * @since 1.1 + * + * @if MOBILE @since_tizen 2.3 + * @elseif WEARABLE @since_tizen 2.3.1 + * @endif */ EAPI Evas_Object *evas_object_grid_add(Evas *evas) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_MALLOC; @@ -3883,6 +4583,10 @@ EAPI Evas_Object *evas_object_grid_add(Evas *evas) EINA_WARN_UNUSED_RESULT EIN * @see evas_output_size_set * * @since 1.8 + * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI Evas_Out *evas_out_add(Evas *e); @@ -3896,6 +4600,9 @@ EAPI Evas_Out *evas_out_add(Evas *e); * * @since 1.8 * + * @if MOBILE @since_tizen 3.0 + * @elseif WEARABLE @since_tizen 3.0 + * @endif */ EAPI void evas_output_del(Evas_Out *evo); diff --git a/src/lib/evas/canvas/efl_vg_base.eo b/src/lib/evas/canvas/efl_vg_base.eo index 3476bab..3e80ec2 100644 --- a/src/lib/evas/canvas/efl_vg_base.eo +++ b/src/lib/evas/canvas/efl_vg_base.eo @@ -8,6 +8,10 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) [[Set an unique name from the parent point of view. $null means no name. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.16 ]] } @@ -18,6 +22,10 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) defined, it might be forced back to $null if the parent already has a node of that name. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.16 ]] } @@ -31,12 +39,22 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) Note: Pass $null to cancel the applied transformation. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] } get { [[Gets the transformation matrix used for this node object. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] } values { m: const(Eina_Matrix3) *; [[transformation matrix.]] @@ -48,12 +66,22 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) This origin position affects to node transformation. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] } get { [[Gets the origin position of this node object. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] } values { x: double; [[$origin x position.]] @@ -62,8 +90,18 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) } @property mask { set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { m: Efl_VG *; @@ -84,7 +122,12 @@ abstract Efl.VG.Base (Eo.Base, Efl.Gfx.Base, Efl.Gfx.Stack) It will start as the control box until it is refined once the shape is computed. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] params { @out r: Eina.Rectangle; [[bounding box to be returned.]] } diff --git a/src/lib/evas/canvas/efl_vg_shape.eo b/src/lib/evas/canvas/efl_vg_shape.eo index 337c807..8d90d55 100644 --- a/src/lib/evas/canvas/efl_vg_shape.eo +++ b/src/lib/evas/canvas/efl_vg_shape.eo @@ -4,8 +4,18 @@ class Efl.VG.Shape (Efl.VG.Base, Efl.Gfx.Shape) methods { @property fill { set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { f: Efl_VG *; @@ -13,8 +23,18 @@ class Efl.VG.Shape (Efl.VG.Base, Efl.Gfx.Shape) } @property stroke_fill { set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { f: Efl_VG *; @@ -22,8 +42,18 @@ class Efl.VG.Shape (Efl.VG.Base, Efl.Gfx.Shape) } @property stroke_marker { set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { m: Efl_VG *; diff --git a/src/lib/evas/canvas/evas_box.eo b/src/lib/evas/canvas/evas_box.eo index ae449ee..1092a20 100644 --- a/src/lib/evas/canvas/evas_box.eo +++ b/src/lib/evas/canvas/evas_box.eo @@ -18,13 +18,23 @@ class Evas.Box (Evas.Smart_Clipped) Note: The default values for both alignments is $0.5. - See also @.align.get.]] + See also @.align.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Get the alignment of the whole bounding box of contents, for a given box object. - See also @.align.set for more information.]] + See also @.align.set for more information. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { horizontal: double; [[The horizontal alignment, in pixels.]] @@ -37,12 +47,22 @@ class Evas.Box (Evas.Smart_Clipped) Note: The default values for both padding components is $0. - See also @.padding.get.]] + See also @.padding.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Get the (space) padding between cells set for a given box object. - See also @.padding.set.]] + See also @.padding.set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { horizontal: Evas.Coord; [[The horizontal padding, in pixels.]] @@ -63,7 +83,12 @@ class Evas.Box (Evas.Smart_Clipped) Refer to each of their documentation texts for details on them. Note: A box layouting function will be triggered by the - $'calculate' smart callback of the box's smart class.]] + $'calculate' smart callback of the box's smart class. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { cb: Evas_Object_Box_Layout @nonull; [[The new layout function to set on $o.]] @@ -118,7 +143,12 @@ class Evas.Box (Evas.Smart_Clipped) If one desires that, besides having weights, child elements must be resized bounded to a minimum or maximum size, those size hints must be set, by the evas_object_size_hint_{min,max}_set - functions.]] + functions. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; @@ -129,7 +159,12 @@ class Evas.Box (Evas.Smart_Clipped) This function behaves analogously to evas_object_box_layout_horizontal. The description of its - behaviour can be derived from that function's documentation.]] + behaviour can be derived from that function's documentation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; @@ -175,7 +210,12 @@ class Evas.Box (Evas.Smart_Clipped) properties apply for padding/alignment relative to the overall height of the box. A value of $-1.0 to $align_y makes the box try to resize this child element to the exact height of its parent - (respecting the max hint on the child's height).]] + (respecting the max hint on the child's height). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; @@ -195,7 +235,12 @@ class Evas.Box (Evas.Smart_Clipped) This function behaves analogously to evas_object_box_layout_flow_horizontal. The description of its - behaviour can be derived from that function's documentation.]] + behaviour can be derived from that function's documentation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; @@ -220,7 +265,12 @@ class Evas.Box (Evas.Smart_Clipped) depend on the layout set to it. Note: This call will trigger the box's - _Evas_Object_Box_Api.insert_after smart function.]] + _Evas_Object_Box_Api.insert_after smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas_Object_Box_Option *; [[A box option bound to the recently added box item or $null, on errors]] @@ -234,7 +284,12 @@ class Evas.Box (Evas.Smart_Clipped) This has the same effect of calling evas_object_box_remove on each of $o's child objects, in sequence. If, and only if, all - those calls succeed, so does this one.]] + those calls succeed, so does this one. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true, on success, $false otherwise.]] params { @@ -244,7 +299,12 @@ class Evas.Box (Evas.Smart_Clipped) iterator_new @const { [[Get an iterator to walk the list of children of a given box object. - Note: Do not remove or delete objects while walking the list.]] + Note: Do not remove or delete objects while walking the list. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: free(own(iterator *), eina_iterator_free) @warn_unused; [[An iterator on $o's child objects, on success, or $null, on errors.]] } @@ -252,7 +312,12 @@ class Evas.Box (Evas.Smart_Clipped) [[Add a new box as a child of a given smart object. This is a helper function that has the same effect of putting a new - box object into $parent by use of evas_object_smart_member_add.]] + box object into $parent by use of evas_object_smart_member_add. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object * @warn_unused; [[$null on error, a pointer to a new box object on success.]] @@ -268,7 +333,12 @@ class Evas.Box (Evas.Smart_Clipped) right. Note: This call will trigger the box's _Evas_Object_Box_Api.append - smart function.]] + smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas_Object_Box_Option *; [[A box option bound to the recently added box item or $null, on errors.]] @@ -285,7 +355,12 @@ class Evas.Box (Evas.Smart_Clipped) (see #Evas_Object_Box_Option) on it, would benefit from this function. They'd have to implement it and set it to be the _Evas_Object_Box_Api.property_id_get smart class function of the - box, which is originally set to $null.]] + box, which is originally set to $null. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: int @warn_unused; [[The numerical ID of the given property or $-1, on errors.]] params { @@ -304,7 +379,12 @@ class Evas.Box (Evas.Smart_Clipped) on its left. Note: This call will trigger the box's - _Evas_Object_Box_Api.prepend smart function.]] + _Evas_Object_Box_Api.prepend smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas_Object_Box_Option *; [[A box option bound to the recently added box item or $null, on errors.]] @@ -316,7 +396,12 @@ class Evas.Box (Evas.Smart_Clipped) [[Get an accessor (a structure providing random items access) to the list of children of a given box object. - Note: Do not remove or delete objects while walking the list.]] + Note: Do not remove or delete objects while walking the list. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: free(own(accessor *), eina_accessor_free) @warn_unused; [[An accessor on $o's child objects, on success, or $null, on errors.]] @@ -369,7 +454,12 @@ class Evas.Box (Evas.Smart_Clipped) given $o's internal list of elements. Note: This call will trigger the box's - _Evas_Object_Box_Api.remove_at smart function.]] + _Evas_Object_Box_Api.remove_at smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$ture on success, $false on failure.]] params { @@ -416,7 +506,12 @@ class Evas.Box (Evas.Smart_Clipped) depend on the layout set to it. Note: This call will trigger the box's - _Evas_Object_Box_Api.insert_before smart function.]] + _Evas_Object_Box_Api.insert_before smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas_Object_Box_Option *; [[A box option bound to the recently added box item or $null, on errors.]] @@ -434,7 +529,12 @@ class Evas.Box (Evas.Smart_Clipped) (see #Evas_Object_Box_Option) on it, would benefit from this function. They'd have to implement it and set it to be the _Evas_Object_Box_Api.property_name_get smart class function of the - box, which is originally set to $null.]] + box, which is originally set to $null. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: const(char)* @warn_unused; [[The name of the given property or $null, on errors.]] params { @in property: int; [[The numerical identifier of the option being searched, @@ -481,7 +581,12 @@ class Evas.Box (Evas.Smart_Clipped) properties apply for padding/alignment relative to the overall height of the box. A value of $-1.0 to $align_y makes the box try to resize this child element to the exact height of its parent - (respecting the maximum size hint on the child's height).]] + (respecting the maximum size hint on the child's height). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in priv: Evas_Object_Box_Data *; @in data: void *; @@ -502,7 +607,12 @@ class Evas.Box (Evas.Smart_Clipped) This function behaves analogously to evas_object_box_layout_homogeneous_max_size_horizontal. The description of its behaviour can be derived from that function's - documentation.]] + documentation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in priv: Evas_Object_Box_Data *; @in data: void *; @@ -530,7 +640,12 @@ class Evas.Box (Evas.Smart_Clipped) depend on the layout set to it. Note: This call will trigger the box's - _Evas_Object_Box_Api.insert_at smart function.]] + _Evas_Object_Box_Api.insert_at smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas_Object_Box_Option *; [[A box option bound to the recently added box item or $null, on errors.]] @@ -558,7 +673,12 @@ class Evas.Box (Evas.Smart_Clipped) will take place. Note: This call will trigger the box's _Evas_Object_Box_Api.remove - smart function.]] + smart function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false otherwise.]] params { @@ -584,7 +704,12 @@ class Evas.Box (Evas.Smart_Clipped) $align_x makes the box try to resize this child element to the exact width of its cell (respecting the min and max hints on the child's width and accounting for its horizontal padding properties). The - same applies to the vertical axis.]] + same applies to the vertical axis. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in priv: Evas_Object_Box_Data *; @in data: void *; @@ -596,7 +721,12 @@ class Evas.Box (Evas.Smart_Clipped) This function behaves analogously to evas_object_box_layout_homogeneous_horizontal. The description - of its behaviour can be derived from that function's documentation.]] + of its behaviour can be derived from that function's documentation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; @@ -635,7 +765,12 @@ class Evas.Box (Evas.Smart_Clipped) required height of the child element and is the only means (besides row justifying) of setting space between rows. Note, however, that $align_y dictates positioning relative to the largest - height required by a child object in the actual row.]] + height required by a child object in the actual row. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { priv: Evas_Object_Box_Data *; data: void *; diff --git a/src/lib/evas/canvas/evas_canvas.eo b/src/lib/evas/canvas/evas_canvas.eo index 4bc5128..b873399 100644 --- a/src/lib/evas/canvas/evas_canvas.eo +++ b/src/lib/evas/canvas/evas_canvas.eo @@ -15,6 +15,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) The units used for $w and $h depend on the engine used by the evas. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -22,6 +26,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) [[Get the render engine's output framespace coordinates in canvas units. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -43,6 +51,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Note: The coordinate values do not have to map 1-to-1 with the output target. However, it is generally advised that it is done for ease of use. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -55,6 +67,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) output location and size values written to them in canvas units. Any of $x, $y, $w or $h that are $null will not be written to. If $e is invalid, the results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -78,12 +94,20 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) [[Set the image cache. This function sets the image cache of canvas in bytes. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } get { [[Get the image cache. This function returns the image cache size of canvas in bytes. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } values { @@ -98,6 +122,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) out with and initial value (no flags). This lets you set the default flags that an event begins with to be $flags. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] } @@ -107,6 +135,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This gets the default event flags events are produced with when fed in. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] } @@ -124,11 +156,19 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Note: it is mandatory that one calls \@ref evas_init before setting the output method. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Retrieves the number of the output engine used for the given evas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -137,10 +177,20 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } @property font_cache { set { - [[Changes the size of font cache of the given evas.]] + [[Changes the size of font cache of the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { - [[Get the size of font cache of the given evas in bytes.]] + [[Get the size of font cache of the given evas in bytes. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { size: int; [[The size in bytes.]] @@ -157,6 +207,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) The units used for $w and $h depend on the engine used by the evas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -168,6 +222,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) If either $w or $h is $null, then it is ignored. If $e is invalid, the returned results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -177,10 +235,20 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } @property data_attach { set { - [[Attaches a specific pointer to the evas for fetching later.]] + [[Attaches a specific pointer to the evas for fetching later. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { - [[Returns the pointer attached by @.data_attach.set.]] + [[Returns the pointer attached by @.data_attach.set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { data: void *; [[The attached pointer.]] @@ -191,10 +259,19 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) [[Changes the font hinting for the given evas. #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } get { - [[Retrieves the font hinting used by the given evas.]] + [[Retrieves the font hinting used by the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { hinting: Evas.Font.Hinting_Flags; [[ @@ -217,6 +294,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) engines allow their settings to be changed more than once. Once called, the $info pointer should be considered invalid. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: bool; [[$true if no error occurred, $false otherwise.]] } @@ -228,6 +309,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) are valid until either @.engine_info.set or @.render are called. This structure does not need to be freed by the caller. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -254,6 +339,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also \@ref evas_object_focus_set, \@ref evas_object_focus_get, \@ref evas_object_key_grab, \@ref evas_object_key_ungrab. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] /* FIXME-doc Example: @@ -286,6 +375,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also \@ref evas_object_layer_get, \@ref evas_object_layer_set, \@ref evas_object_below_get, \@ref evas_object_above_get. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; [[A pointer to the highest object on it (if any) or $null otherwise.]] @@ -298,6 +391,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This is required to check for which locks are set at a given time with the \@ref evas_key_lock_is_set function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: const(Evas.Lock)* @warn_unused; [[ An Evas_Lock handle to query Evas' keys subsystem with @@ -314,6 +411,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) the Evas_Coords pointed to by $x and $y to contain these coordinates. If $e is not a valid canvas the results of this function are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -335,6 +436,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) get { [[Get the number of mouse or multi presses currently active. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.2 ]] return: int; @@ -355,6 +460,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) generation/run if the calculations maybe cause self-feeding effects. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] return: int; @@ -362,12 +471,17 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } @property focus_state { get { - [[Get the focus state known by the given evas.]] + [[Get the focus state known by the given evas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; } } @property changed { - get { + get @internal { [[Get the changed marker for the canvas. @since 1.11 @@ -384,6 +498,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) the integers pointed to by $x and $y to contain these coordinates. If $e is not a valid canvas the results of this function are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -418,6 +536,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) A canvas begins with the mouse being assumed outside ($false). If $e is not a valid canvas, the return value is undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -442,6 +564,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) $maxw and $maxh as there may still be a limit, just a much higher one. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.1 ]] return: bool; @@ -465,6 +591,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also \@ref evas_object_layer_get, \@ref evas_object_layer_set, \@ref evas_object_below_get, \@ref evas_object_below_set. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; [[ A pointer to the lowest object on it, if any, or $null @@ -482,6 +612,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also @.key_modifier_add, @.key_modifier_del, @.key_modifier_on, @.key_modifier_off. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: const(Evas.Modifier)* @warn_unused; [[ An Evas_Modifier handle to query Evas' keys subsystem @@ -509,6 +643,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) to the last mouse button (button 32). If $e is not a valid canvas, the return value is undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -537,6 +675,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) given position. It will enter the smart objects. It will not append to the list pass events as hidden objects. Call eina_list_free on the returned list after usage. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: list * @warn_unused; params { @@ -551,6 +693,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when the mouse wheel is scrolled up or down. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in direction: int; [[The wheel mouse direction.]] @@ -568,6 +714,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also @.key_lock_add, @.key_lock_del, @.key_lock_del, @.key_lock_off. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the lock to enable.]] @@ -579,6 +729,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when a key is pressed. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in keyname: const(char)*; [[Name of the key.]] @@ -601,6 +755,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also @.key_modifier_add, \@ref evas_key_modifier_get, @.key_modifier_on, @.key_modifier_off, \@ref evas_key_modifier_is_set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: Evas.Modifier_Mask @warn_unused; [[ The bit mask or 0 if the $keyname key wasn't registered as a @@ -628,6 +786,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) \@ref ecore_evas_new family of helper functions, Ecore will take care of registering on it all standard modifiers: "Shift", "Control", "Alt", "Meta", "Hyper", "Super". + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[ @@ -643,6 +805,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) See also @.key_modifier_add, \@ref evas_key_modifier_get, @.key_modifier_on, @.key_modifier_mask_get, \@ref evas_key_modifier_is_set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the modifier to disable.]] @@ -652,6 +818,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) [[Hold event feed. This function makes the object to stop sending events. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in hold: int; [[The hold.]] @@ -665,6 +835,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when the mouse is moved from its last position. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in x: int; [[The horizontal position of the mouse pointer.]] @@ -679,6 +853,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when a key is released. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in keyname: const(char)*; [[Name of the key.]] @@ -695,6 +873,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessar when the mouse out event happens. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in timestamp: uint; [[Timestamp of the mouse up event.]] @@ -729,6 +911,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Warning: This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: list * @warn_unused; [[ The list of Evas objects that are over the given position in $e. @@ -780,7 +966,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) @in data: const(void)*; } } - render_async { + render_async @internal { [[Render the given Evas canvas asynchronously. This function only returns $true when a frame will be rendered. @@ -800,7 +986,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) ]] return: bool; [[$true if the canvas will render, $false otherwise.]] } - render2 { + render2 @internal { [[Render the given Evas canvas using the new rendering infra. This is experimental and will change over time until noted here. @@ -814,7 +1000,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) ]] return: bool; [[$true if the canvas will render, $false otherwise.]] } - render2_updates { + render2_updates @internal { [[Render the given Evas canvas using the new rendering infra. This is experimental and will change over time until noted here. @@ -829,7 +1015,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) ]] } focus_out { - [[Inform to the evas that it lost the focus.]] + [[Inform to the evas that it lost the focus. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } event_input_mouse_move { [[Mouse move event feed from input. @@ -840,6 +1031,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) canvas 0,0. It will take care of doing any special transformation like adding the framespace offset to the mouse event. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.8 ]] params { @@ -858,6 +1053,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function updates the canvas internal objects not triggering renderization. To force renderization function @.render should be used. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } touch_point_list_count { @@ -866,6 +1065,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) New touched point is added to the list whenever touching the evas and point is removed whenever removing touched point from the evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] /* FIXME-doc Example: @@ -904,6 +1107,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Warning: Do not use this function unless you know what Evas exactly works with "changed" state. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } key_lock_off { @@ -914,6 +1121,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) after this call. See also @.key_lock_on. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the lock to disable.]] @@ -927,10 +1138,19 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Warning: Do not use this function unless you know what Evas exactly works with "changed" state. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } font_cache_flush { - [[Force the given evas and associated engine to flush its font cache.]] + [[Force the given evas and associated engine to flush its font cache. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } font_hinting_can_hint @const { @@ -938,6 +1158,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) One of #EVAS_FONT_HINTING_NONE, #EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: bool @warn_unused; [[$true if it is supported, $false otherwise.]] params { @@ -956,6 +1180,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Warning: This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; [[The Evas object that is over all other objects at the given position.]] params { @@ -979,6 +1207,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) between this call and a matching evas_key_modifier_off(). See also @.key_modifier_off. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the modifier to enable.]] @@ -990,6 +1222,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when the mouse button is released. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in b: int; [[The button number.]] @@ -1004,6 +1240,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when the mouse button is pressed. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in b: int; [[The button number.]] @@ -1019,6 +1259,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function call evas_event_feed_* functions, so it can cause havoc if not used wisely. Please use it responsibly. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in event_copy: void *; [[The event to refeed.]] @@ -1031,6 +1275,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) The list depends on Evas compile time configuration, such as fontconfig support, and the paths provided at runtime as explained in \@ref Evas_Font_Path_Group. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: list * @warn_unused; [[ A newly allocated list of strings. Do not change the @@ -1057,6 +1305,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) canvas-wide, then which one of the many objects with that name is returned is undefined, so only use this if you can ensure the object name is unique. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; [[ If successful, the Evas object with the given name. Otherwise, @@ -1069,6 +1321,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) font_path_append { [[Appends a font path to the list of font paths used by the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in path: const(char)* @nonull; [[The new font path.]] @@ -1080,6 +1336,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) The point which comes from Mouse Event has $id 0 and The point which comes from Multi Event has $id that is same as Multi Event's device id. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] /* FIXME-doc Example: @@ -1100,12 +1360,21 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } } font_path_clear { - [[Removes all font paths loaded into memory for the given evas.]] + [[Removes all font paths loaded into memory for the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } smart_objects_calculate { [[Call user-provided $calculate smart functions and unset the flag signalling that the object needs to get recalculated to all smart objects in the canvas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } touch_point_list_nth_xy_get { @@ -1113,6 +1382,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Touch point's coordinates is updated whenever moving that point on the canvas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] /* FIXME-doc Example: @@ -1136,6 +1409,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) key_lock_del { [[Removes the $keyname key from the current list of lock keys on canvas $e. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the key to remove from the locks list.]] @@ -1149,6 +1426,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Note: All newly created Evas rectangles get the default color values of 255 255 255 255 (opaque white). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in x: int; [[The rectangle's left position.]] @@ -1160,13 +1441,22 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) sync { } font_path_list @const { - [[Retrieves the list of font paths used by the given evas.]] + [[Retrieves the list of font paths used by the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: const(list)* @warn_unused; [[The list of font paths used.]] } image_cache_reload { [[Reload the image cache. This function reloads the image cache of canvas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } @@ -1179,6 +1469,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) output size, viewport size and location, returning it as the function return value. If $e is invalid, the results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -1225,6 +1519,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Note: Evas is a stateful canvas. If no operations changing its state took place since the last rendering action, you won't see no changes and this call will be a no-op. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example code follows. @@ -1245,6 +1543,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) [[Flush the image cache of the canvas. This function flushes image cache of canvas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } coord_screen_y_to_world @const { @@ -1255,6 +1557,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) and converts it into canvas units, accounting for output size, viewport size and location, returning it as the function return value. If $e is invalid, the results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -1276,6 +1582,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) on canvas $e. See also @.key_modifier_add. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the key to remove from the modifiers list.]] @@ -1288,6 +1598,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) EVAS_TOUCH_POINT_STILL when the point is not moved after pressed, EVAS_TOUCH_POINT_MOVE when moved at least once after pressed and EVAS_TOUCH_POINT_UP when released. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] /* FIXME-doc Example: @@ -1311,7 +1625,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } } focus_in { - [[Inform to the evas that it got the focus.]] + [[Inform to the evas that it got the focus. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } obscured_rectangle_add { [[Add an "obscured region" to an Evas canvas. @@ -1346,6 +1665,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see \@ref evas_damage_rectangle_add). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example code follows. @@ -1376,6 +1699,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) immediately prior to this to perhaps discard a little more, though this function should implicitly delete most of what @.render_idle_flush might discard too. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } render_copy { @@ -1402,6 +1729,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will set some evas properties that is necessary when the mouse in event happens. It prepares information to be treated by the callback function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in timestamp: uint; [[The timestamp of the mouse up event.]] @@ -1421,6 +1752,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) Warning: This function will skip objects parented by smart objects, acting only on the ones at the "top level", with regard to object parenting. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; [[ The Evas object that is over all other objects at the given @@ -1448,7 +1783,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) } } render { - [[Force renderization of the given canvas.]] + [[Force renderization of the given canvas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } event_feed_multi_up { @@ -1471,6 +1811,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) font_path_prepend { [[Prepends a font path to the list of font paths used by the given evas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in path: const(char)* @nonull; [[The new font path.]] @@ -1491,6 +1835,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) changed. If you want to re-render it afterwards expecting new contents, you have to add "damage" regions yourself (see @.damage_rectangle_add). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } event_feed_mouse_cancel { @@ -1498,6 +1846,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) This function will call @.event_feed_mouse_up when a mouse cancel event happens. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in timestamp: uint; [[The timestamp of the mouse up event.]] @@ -1513,6 +1865,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) output size, viewport size and location, returning it as the function return value. If $e is invalid, the results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -1550,6 +1906,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) ecore_evas_new() family of helper functions, Ecore will take care of registering on it all standard lock keys: "Caps_Lock", "Num_Lock", "Scroll_Lock". + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in keyname: const(char)* @nonull; [[The name of the key to add to the locks list.]] @@ -1563,6 +1923,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) objects. Other things it may also discard are: shared memory segments, temporary scratch buffers, cached data to avoid re-compute of that data etc. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } coord_world_y_to_screen @const { @@ -1574,6 +1938,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) output size, viewport size and location, returning it as the function return value. If $e is invalid, the results are undefined. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -1597,6 +1965,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) when a key is pressed. It prepares information to be treated by the callback function. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.10 ]] params { @@ -1616,6 +1988,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) when a key is released. It prepares information to be treated by the callback function. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.10 ]] params { @@ -1635,6 +2011,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface) when an e.g. stylus axis is updated. It prepares information to be treated by the callback function. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.13 ]] params { diff --git a/src/lib/evas/canvas/evas_grid.eo b/src/lib/evas/canvas/evas_grid.eo index c140af9..f275be4 100644 --- a/src/lib/evas/canvas/evas_grid.eo +++ b/src/lib/evas/canvas/evas_grid.eo @@ -9,14 +9,24 @@ class Evas.Grid (Evas.Smart_Clipped) from right to left instead of left to right. That is, 0,0 is top right, not to left. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] } get { [[Gets the mirrored mode of the grid. See also @.mirrored.set - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] } values { mirrored: bool; [[the mirrored mode to set.]] @@ -26,14 +36,24 @@ class Evas.Grid (Evas.Smart_Clipped) set { [[Set the virtual resolution for the grid - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] } get { [[Get the current virtual resolution See also @.size.set - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] } values { w: int; [[The virtual horizontal size (resolution) in integer units.]] @@ -49,7 +69,12 @@ class Evas.Grid (Evas.Smart_Clipped) It's possible to remove objects from the grid when walking this list, but these removals won't be reflected on it. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: free(own(list *), eina_list_free) @warn_unused; } } @@ -58,14 +83,24 @@ class Evas.Grid (Evas.Smart_Clipped) Note: Do not remove or delete objects while walking the list. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: free(own(accessor *), eina_accessor_free) @warn_unused; } clear { [[Faster way to remove all child objects from a grid object. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] params { @in clear: bool; [[if true, it will delete just removed children.]] @@ -76,7 +111,12 @@ class Evas.Grid (Evas.Smart_Clipped) Note: Do not remove or delete objects while walking the list. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: free(own(iterator *), eina_iterator_free) @warn_unused; } @@ -85,7 +125,12 @@ class Evas.Grid (Evas.Smart_Clipped) \@ref evas_object_grid_add() - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: Evas.Object * @warn_unused; } @@ -96,7 +141,12 @@ class Evas.Grid (Evas.Smart_Clipped) to recalculate numbers of columns and rows. If you plan to remove all children, use evas_object_grid_clear() instead. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: bool; [[1 on success, 0 on failure.]] params { @@ -109,7 +159,12 @@ class Evas.Grid (Evas.Smart_Clipped) Get the pack x, y, width and height in virtual coordinates set by @.pack. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: bool; [[1 on success, 0 on failure.]] params { @in child: Evas.Object *; [[The grid child to query for coordinates.]] @@ -122,7 +177,12 @@ class Evas.Grid (Evas.Smart_Clipped) pack { [[Add a new child to a grid object. - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: bool; [[1 on success, 0 on failure.]] params { diff --git a/src/lib/evas/canvas/evas_image.eo b/src/lib/evas/canvas/evas_image.eo index cb5da1a..d3c3e51 100644 --- a/src/lib/evas/canvas/evas_image.eo +++ b/src/lib/evas/canvas/evas_image.eo @@ -9,6 +9,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function sets the DPI resolution of a given loaded canvas image. Most useful for the SVG image loader. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -16,6 +20,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function returns the DPI resolution of the given canvas image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -27,6 +35,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, set { [[Clip the proxy object with the source object's clipper. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.8 ]] } @@ -34,6 +46,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, [[Determine whether an object is clipped by source object's clipper. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.8 ]] } @@ -59,11 +75,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, "proxy state" anymore). Warning: You cannot set a proxy as another proxy's source. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: bool; } get { - [[Get the current source object of an image object.]] + [[Get the current source object of an image object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { src: Evas.Object *; [[Source object to use for the proxy.]] @@ -78,6 +103,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, automatically trigger a call to \@ref evas_object_image_fill_set with the that new size (and 0, 0 as source image's origin), so the bound image will fill the whole object's area. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -86,6 +115,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Returns $true if it is tracking, $false if not (and \@ref evas_object_fill_set must be called manually). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -103,6 +136,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, your driver implementation supports it, setting this hint to #EVAS_IMAGE_CONTENT_HINT_DYNAMIC will make it need zero copies at texture upload time, which is an "expensive" operation. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -110,6 +147,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, canvas. This returns #EVAS_IMAGE_CONTENT_HINT_NONE on error. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -128,6 +169,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note: The image loader for the image format in question has to support selective region loading in order to this function to take effect. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -136,6 +181,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note: Use $null pointers on the coordinates you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -155,6 +204,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, makes it use alpha channel data, and $false makes it ignore that data. Note that this has nothing to do with an object's color as manipulated by \@ref evas_object_color_set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -163,6 +216,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function returns $true if the image object's alpha channel is being used, or $false otherwise. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -189,6 +246,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note: By default, image objects have no borders set, i. e. $l, $r, $t and $b start as 0. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc See the following figures for visual explanation:\n @@ -212,6 +273,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note: Use $null pointers on the border components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -225,11 +290,19 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, set { [[Sets the scaling factor (multiplier) for the borders of an image object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Retrieves the scaling factor (multiplier) for the borders of an image object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -246,11 +319,19 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Warning: Use this function if you really know what you are doing. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Retrieves whether the given image object is dirty (needs to be redrawn). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -261,6 +342,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, set { [[Set the video surface linked to a given image of the canvas. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] values { @@ -270,6 +355,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, get { [[Get the video surface linekd to a given image of the canvas. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] values { @@ -279,10 +368,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, } @property video_surface_caps { set { - [[Set the video surface capabilities to a given image of the canvas.]] + [[Set the video surface capabilities to a given image of the canvas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { - [[Get the video surface capabilities to a given image of the canvas.]] + [[Get the video surface capabilities to a given image of the canvas. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { caps: uint; @@ -293,6 +392,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, [[Define if the orientation information in the image file should be honored. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -300,6 +403,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, [[Get if the orientation information in the image file should be honored. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -320,11 +427,19 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, for making frames and decorations. You would most probably also be using a filled image (as in @.filled.set) to use as a frame. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Retrieves how the center part of the given image object (not the borders) is to be drawn when Evas is rendering it. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -350,12 +465,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Warning: If the all of proxies are deleted, then the source visibility of the source object will be cancelled. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.8 ]] } get { [[Get the state of the source object visibility. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.8 ]] } @@ -377,6 +500,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function returns the native surface of a given canvas image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -390,11 +517,19 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function sets the scale down factor of a given canvas image. Most useful for the SVG image loader. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Get the scale down factor of a given image object's source image, when loading it. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -408,6 +543,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function sets the scale hint value of the given image object in the canvas, which will affect how Evas is to cache scaled versions of its original source image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -415,6 +554,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function returns the scale hint value of the given image object of the canvas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -436,12 +579,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, If $source is $false, events occurring on $obj will be processed only on it. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.8 ]] } get { [[Determine whether an object is set to source events. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.8 ]] } @@ -455,12 +606,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, [[Set the colorspace of a given image of the canvas. This function sets the colorspace of given canvas image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Get the colorspace of a given image of the canvas. This function returns the colorspace of given canvas image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -473,6 +632,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This functions sets a function to be the callback function that get pixels from a image of the canvas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -498,6 +661,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note that the caller is responsible for freeing the buffer when finished with it, as user-set image data will not be automatically freed when the image object is deleted. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -515,6 +682,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, @.animated_frame_count.get, @.animated_loop_type.get, @.animated_loop_count.get, @.animated_frame_duration_get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -526,6 +697,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, get { [[Get the support state of a given image. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] return: bool @warn_unused; [[The region support state.]] @@ -535,6 +710,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, get { [[Retrieves a number representing any error that occurred during the last loading of the given image object's source image. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: Evas_Load_Error @warn_unused; [[ A value giving the last error that occurred. It should be @@ -554,6 +733,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, @.animated_frame_count.get, @.animated_loop_type.get, @.animated_loop_count.get, @.animated_frame_duration_get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] return: int; [[The number of frames.]] @@ -565,6 +748,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, The row stride is the number of bytes between the start of a row and the start of the next row for image data. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: int @warn_unused; [[The stride of the image (in bytes).]] } @@ -587,6 +774,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, @.animated_frame_count.get, @.animated_loop_type.get, @.animated_loop_count.get, @.animated_frame_duration_get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] return: Evas_Image_Animated_Loop_Hint; [[Loop type of the image object.]] @@ -607,6 +798,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, @.animated_frame_count.get, @.animated_loop_type.get, @.animated_loop_count.get, @.animated_frame_duration_get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] return: int; [[The number of loop of an animated image object.]] @@ -642,12 +837,20 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function allows to rotate or flip the image. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.14 ]] } get { [[Get the image orientation. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.14 ]] } @@ -662,6 +865,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, inside it and you can reuse it as a source for any kind of effect. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.15 ]] } @@ -669,6 +876,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, [[Determine wether the Evas_Object_Image replicate the content of the canvas below. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.15 ]] } @@ -686,6 +897,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, This function schedules a particular rectangular region of an image object to be updated (redrawn) at the next rendering cycle. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in x: int; [[X-offset of the region to be updated.]] @@ -708,6 +923,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, @.animated_frame_count.get, @.animated_loop_type.get, @.animated_loop_count.get, @.animated_frame_duration_get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] return: double; @@ -725,6 +944,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, If data is $null, the current image data will be freed. Naturally, if one does not set an image object's data manually, it will still have one, allocated by Evas. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] params { @in data: void *; [[The raw data, or $null.]] @@ -750,6 +973,10 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image, Efl.Gfx.Fill, Efl.Gfx.View, Note: You may want to use @.data_update_add to inform data changes, if you did any. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: void * @warn_unused; [[ The raw image data.]] params { diff --git a/src/lib/evas/canvas/evas_line.eo b/src/lib/evas/canvas/evas_line.eo index 2356c1b..360d3c3 100644 --- a/src/lib/evas/canvas/evas_line.eo +++ b/src/lib/evas/canvas/evas_line.eo @@ -10,12 +10,20 @@ class Evas.Line (Evas.Object) [[Sets the coordinates of the end points of the given evas line object. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.8 ]] } get { [[Retrieves the coordinates of the end points of the given evas line object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { diff --git a/src/lib/evas/canvas/evas_object.eo b/src/lib/evas/canvas/evas_object.eo index af5b853..3517231 100644 --- a/src/lib/evas/canvas/evas_object.eo +++ b/src/lib/evas/canvas/evas_object.eo @@ -18,6 +18,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Smart objects (such as elementary) can have their own size hint policy. So calling this API may or may not affect the size of smart objects. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -39,6 +43,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Use $null pointers on the hint components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -59,6 +67,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Smart objects(such as elementary) can have their own size hint policy. So calling this API may or may not affect the size of smart objects. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } get { @@ -70,6 +82,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Use $null pointers on the hint components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] } values { @@ -93,6 +109,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac built-in smart objects, these names are "EvasObjectSmartClipped" for the clipped smart object, "Evas_Object_Box" for the box object and "Evas_Object_Table for the table object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -120,6 +140,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Smart objects(such as elementary) can have their own size hint policy. So calling this API may or may not affect the size of smart objects. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -141,6 +165,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Use $null pointers on the hint components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -164,10 +192,19 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac will be emitted just when inside this object area. The default value is EVAS_OBJECT_POINTER_MODE_AUTOGRAB. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { - [[Determine how pointer will behave.]] + [[Determine how pointer will behave. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { pointer_mode: Evas.Object_Pointer_Mode; [[Desired behavior.]] @@ -175,11 +212,20 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac } @property render_op { set { - [[Sets the render_op to be used for rendering the Evas object.]] + [[Sets the render_op to be used for rendering the Evas object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Retrieves the current value of the operation used for rendering the Evas object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -202,12 +248,20 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac we won't guarantee the state of the object, that only had key/mouse down events, will be. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } get { [[Determine whether an object is set to freeze (discard) events. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -237,6 +291,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: The map points a uv coordinates match the image geometry. If the $map parameter is $null, the stored map will be freed and geometry prior to enabling/setting a map will be restored. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc If you have a 200x100 source @@ -265,6 +323,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac object. It is intended for read-only access and is only valid as long as the object is not deleted or the map on the object is not changed. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc If you wish to modify the map @@ -297,6 +359,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Smart objects(such as elementary) can have their own size hint policy. So calling this API may or may not affect the size of smart objects. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -314,6 +380,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Use $null pointers on the hint components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc These images illustrate some of the #Evas_Aspect_Control policies: @@ -392,6 +462,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac The clip object $clip must be a valid object, but can also be $null, in which case the effect of this function is the same as @.clip_unset on the $obj object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc The following figure illustrates some clipping in Evas: @@ -414,6 +488,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac This function returns the object clipping $obj. If $obj is not being clipped at all, $null is returned. The object $obj must be a valid Evas_Object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -438,6 +516,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Smart objects(such as elementary) can have their own size hint policy. So calling this API may or may not affect the size of smart objects. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -451,6 +533,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Use $null pointers on the hint components you're not interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc This space will be rendered @@ -487,6 +573,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac If $repeat is $false, events occurring on $obj will be processed only on it. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -498,7 +588,12 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac */ } get { - [[Determine whether an object is set to repeat events.]] + [[Determine whether an object is set to repeat events. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { repeat: bool; [[Whether $obj is to repeat events ($true) or @@ -525,6 +620,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac ones. Note: Default weight hint values are 0.0, for both axis. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -554,6 +653,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: If $obj is invalid, then the hint components will be set with 0.0. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -567,6 +670,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac There might be occasions where one would like to name his/her objects. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -582,6 +689,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Return: The name of the object or $null, if no name has been given to it. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -607,10 +718,19 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Only text and textblock objects have scaling change handlers. Other objects won't change visually on this call. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { - [[Retrieves the scaling factor for the given Evas object.]] + [[Retrieves the scaling factor for the given Evas object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { scale: double; [[The scaling factor. 1.0 means no scaling, @@ -626,10 +746,19 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac static clipper and shouldn't be moved with children and otherwise considered specially. The default value for new objects is $false. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { - [[Get the "static clipper" hint flag for a given Evas object.]] + [[Get the "static clipper" hint flag for a given Evas object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { is_static_clip: bool; [[$true if it's to be used as a static @@ -648,6 +777,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac exclusive key grabs on other objects. See also @.key_grab, @.key_ungrab. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -663,6 +796,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac If the passed object is the currently focused one, $true is returned. $false is returned, otherwise. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -679,10 +816,24 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac } @property is_frame_object { set { - [[@since 1.2]] + [[not documented. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2 + ]] } get { - [[@since 1.2]] + [[not documented. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.2 + ]] } values { is_frame: bool; @@ -701,6 +852,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac \@ref evas_object_map_set), the initial geometry will be undefined. It is advised to always set a map to the object first, and then call this function to enable its use. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -709,6 +864,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac This returns the currently enabled state of the map on the object indicated. The default map enable state is off. You can enable and disable it with @.map_enable.set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -727,6 +886,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Warning: By using precise point collision detection you'll be making Evas more resource intensive. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example code follows. @@ -740,6 +903,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac get { [[Determine whether an object is set to use precise point collision detection. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -772,6 +939,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac that should be used whenever appropriate. Note: Default alignment hint values are 0.5, for both axis. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc See the following figure: @@ -801,6 +972,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: If $obj is invalid, then the hint components will be set with 0.5 + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -826,6 +1001,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.repeat_events.set, @.pass_events.set, @.freeze_events.set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -833,6 +1012,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.repeat_events.get, @.pass_events.get, @.freeze_events.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -853,6 +1036,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.repeat_events.set, @.propagate_events.set, @.freeze_events.set. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { @@ -860,6 +1047,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.repeat_events.get, @.propagate_events.get, @.freeze_events.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -879,11 +1070,19 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac set { [[Sets whether or not the given Evas object is to be drawn anti-aliased. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { [[Retrieves whether or not the given Evas object is to be drawn anti_aliased. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -893,7 +1092,12 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac } @property smart_data { get { - [[Retrieve user data stored on a given smart object.]] + [[Retrieve user data stored on a given smart object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: void * @warn_unused; [[A pointer to data or $null.]] } } @@ -903,6 +1107,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Use this function if you want to change any of this clipper's properties, like colors. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: Evas.Object * @warn_unused; } @@ -924,6 +1132,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac The object $obj must be a valid Evas_Object. See also @.clip.set, @.clip_unset and @.clip.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example: @@ -950,6 +1162,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac get { [[Gets the parent smart object of a given Evas object, if it has one. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: Evas.Object * @warn_unused; [[The parent smart object of $obj or $null.]] @@ -963,6 +1179,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac enforcement in any way, it's just a hint that can be used whenever appropriate. This mode can be used object's display mode like commpress or expand. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } set { @@ -970,6 +1190,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac This is not a size enforcement in any way, it's just a hint that can be used whenever appropriate. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -982,8 +1206,18 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac can inherit the paragraph direction from the given object. The default paragraph direction is @Evas.BiDi_Direction.inherit.]] set { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { dir: Evas.BiDi_Direction; [[Paragraph direction for the given object.]] @@ -992,6 +1226,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac clipees_has @const { [[Test if any object is clipped by $obj. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.8 ]] return: bool @warn_unused; @@ -1025,6 +1263,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.key_ungrab, @.focus.get, @.focus.set, \@ref evas_focus_get, \@ref evas_key_modifier_add. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example code follows. @@ -1061,6 +1303,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac a smart class' name is a single string in Evas. See also @.smart_type_check_ptr. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: bool @warn_unused; params { @@ -1079,6 +1325,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac returned. If $recurse is set to -1 then it will recurse without limit. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.2 ]] return: Evas.Object * @warn_unused; [[The Evas object with the given name @@ -1100,6 +1350,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac See also @.key_grab, @.focus.get, @.focus.set, \@ref evas_focus_get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] /* FIXME-doc Example code follows. @@ -1128,6 +1382,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac object $obj must be a valid Evas_Object. See also @.clip.set, @.clipees.get and @.clip.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } smart_move_children_relative { @@ -1141,6 +1399,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac Note: Clipped smart objects already make use of this function on their $move smart function definition. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] params { @in dx: Evas.Coord; [[Horizontal offset (delta).]] @@ -1150,6 +1412,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface, Efl.Gfx.Base, Efl.Gfx.Stac smart_type_check_ptr @const { [[Checks whether a given smart object or any of its smart object parents is of a given smart class, using pointer comparison. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif ]] return: bool @warn_unused; [[$true if $obj or any of its parents is of type $type, $false otherwise.]] diff --git a/src/lib/evas/canvas/evas_object_smart.eo b/src/lib/evas/canvas/evas_object_smart.eo index 3ecab65..fb85f0d 100644 --- a/src/lib/evas/canvas/evas_object_smart.eo +++ b/src/lib/evas/canvas/evas_object_smart.eo @@ -27,7 +27,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) call this function automatically, with $true as parameter. See also @.need_recalculate.get, @.calculate and - \@ref evas_smart_objects_calculate().]] + \@ref evas_smart_objects_calculate(). + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { [[Get the value of the flag signalling that a given smart object needs to @@ -38,7 +43,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) If it's not provided, then the flag will be left unchanged after the rendering phase. - See also @.need_recalculate.set, for more details.]] + See also @.need_recalculate.set, for more details. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { value: bool; [[whether one wants to set ($true) or to unset @@ -73,7 +83,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) This data is stored independently of the one set by evas_object_data_set(), naturally. - See also @.data.get.]] + See also @.data.get. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { data: void *; [[A pointer to user data.]] @@ -90,13 +105,23 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) See also @.member_add, @.member_del and @.iterator_new. - @since 1.7]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.7 + ]] return: list * @warn_unused; [[Returns the list of the member objects of $obj.]] } } @property smart { get { - [[Get the @Evas.Smart from which $obj smart object was created.]] + [[Get the @Evas.Smart from which $obj smart object was created. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] return: Evas.Smart * @warn_unused; [[the @Evas.Smart handle or $null, on errors.]] } @@ -133,7 +158,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) not recommended. Use class callbacks descriptions instead as they make you smart object user's life simpler and will use less memory, as descriptions and arrays will be - shared among all instances.]] + shared among all instances. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false on failure.]] params { @@ -161,7 +191,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) Note: Use $null pointers on the descriptions/counters you're not interested in: they'll be ignored by the function. - \@ref evas_smart_callbacks_descriptions_get().]] + \@ref evas_smart_callbacks_descriptions_get(). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @out class_descriptions: const(Evas.Smart_Cb_Description)**; [[Where to store class callbacks descriptions array, if any is known. If no descriptions are @@ -180,7 +215,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) See also @.member_add and @.member_del - @since 1.8]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.8 + ]] return: free(own(iterator *), eina_iterator_free) @warn_unused; [[Returns the iterator of the member objects of $obj.]] } @@ -189,7 +229,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) or $null if not found. If parameter is $null, no search - will be done on instance descriptions.]] + will be done on instance descriptions. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] params { @in name: const(char)* @nonull; [[name of desired callback, must not be $null. The search have a special case for name being the same @@ -213,7 +258,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) flag on it telling it needs recalculation for the next rendering phase. - See also @.need_recalculate.set]] + See also @.need_recalculate.set + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } add { @@ -264,7 +314,12 @@ class Evas.Object_Smart (Evas.Object, Evas.Signal_Interface) forcefully. As an effect, on the next rendering cycle its calculate() (see #Evas_Smart_Class) smart function will be called. - See also @.need_recalculate.set and @.calculate.]] + See also @.need_recalculate.set and @.calculate. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } member_del { diff --git a/src/lib/evas/canvas/evas_out.eo b/src/lib/evas/canvas/evas_out.eo index 18a7b7a..f564f55 100644 --- a/src/lib/evas/canvas/evas_out.eo +++ b/src/lib/evas/canvas/evas_out.eo @@ -6,7 +6,7 @@ class Evas.Out (Eo.Base) legacy_prefix: evas_output; methods { @property view { - set { + set @internal { [[Sets the viewport region of the canvas that the output displays. This sets both the viewport region in the canvas that displays @@ -14,7 +14,12 @@ class Evas.Out (Eo.Base) output resolution 1:1.]] } get { - [[Gets the viewport region of the canvas that the output displays.]] + [[Gets the viewport region of the canvas that the output displays. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { x: Evas.Coord; @@ -24,11 +29,11 @@ class Evas.Out (Eo.Base) } } @property engine_info { - set { + set @internal { [[Sets the engine specific output parameters for a given output.]] return: bool; } - get { + get @internal { [[Gets the engine specific output parameters for a given output.]] } values { diff --git a/src/lib/evas/canvas/evas_polygon.eo b/src/lib/evas/canvas/evas_polygon.eo index 4a7357a..077121d 100644 --- a/src/lib/evas/canvas/evas_polygon.eo +++ b/src/lib/evas/canvas/evas_polygon.eo @@ -4,14 +4,24 @@ class Evas.Polygon (Evas.Object) eo_prefix: evas_obj_polygon; methods { point_add { - [[Adds the given point to the given evas polygon object.]] + [[Adds the given point to the given evas polygon object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in x: Evas.Coord; [[The X coordinate of the given point.]] @in y: Evas.Coord; [[The Y coordinate of the given point.]] } } points_clear { - [[Removes all of the points from the given evas polygon object.]] + [[Removes all of the points from the given evas polygon object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } } implements { diff --git a/src/lib/evas/canvas/evas_table.eo b/src/lib/evas/canvas/evas_table.eo index a401970..0474b87 100644 --- a/src/lib/evas/canvas/evas_table.eo +++ b/src/lib/evas/canvas/evas_table.eo @@ -56,8 +56,18 @@ class Evas.Table (Evas.Smart_Clipped) no minimum size is provided at all then the table will fallback to expand mode as well.]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { homogeneous: Evas.Object_Table.Homogeneous_Mode; @@ -66,8 +76,18 @@ class Evas.Table (Evas.Smart_Clipped) @property align { [[Control the alignment of the whole bounding box of contents.]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { horizontal: double; @@ -77,8 +97,18 @@ class Evas.Table (Evas.Smart_Clipped) @property padding { [[Control the padding between cells.]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { horizontal: Evas.Coord; @@ -92,8 +122,18 @@ class Evas.Table (Evas.Smart_Clipped) @since 1.1]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { mirrored: bool; [[$true if mirrored, $false otherwise]] @@ -106,7 +146,12 @@ class Evas.Table (Evas.Smart_Clipped) Note: columns and rows are virtual entities, one can specify a table with a single object that takes 4 columns and 5 rows. The only difference for a single cell table is that paddings will be - accounted proportionally.]] + accounted proportionally. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { cols: int; @@ -120,7 +165,12 @@ class Evas.Table (Evas.Smart_Clipped) Note: This is a duplicate of the list kept by the table internally. It's up to the user to destroy it when it no longer needs it. It's possible to remove objects from the table when walking this - list, but these removals won't be reflected on it.]] + list, but these removals won't be reflected on it. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: free(own(list *), eina_list_free) @warn_unused; } } @@ -128,7 +178,12 @@ class Evas.Table (Evas.Smart_Clipped) get { [[Get the child of the table at the given coordinates - Note: This does not take into account col/row spanning]] + Note: This does not take into account col/row spanning + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } keys { col: ushort; @@ -139,7 +194,12 @@ class Evas.Table (Evas.Smart_Clipped) } } clear { - [[Faster way to remove all child objects from a table object.]] + [[Faster way to remove all child objects from a table object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] params { @in clear: bool; [[If $true, it will delete just removed children.]] @@ -148,26 +208,46 @@ class Evas.Table (Evas.Smart_Clipped) accessor_new @const { [[Get an accessor to get random access to the list of children for the table. - Note: Do not remove or delete objects while walking the list.]] + Note: Do not remove or delete objects while walking the list. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: free(own(accessor *), eina_accessor_free) @warn_unused; } iterator_new @const { [[Get an iterator to walk the list of children for the table. - Note: Do not remove or delete objects while walking the list.]] + Note: Do not remove or delete objects while walking the list. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: free(own(iterator *), eina_iterator_free) @warn_unused; } add_to { - [[Create a table that is child of a given element $parent.]] + [[Create a table that is child of a given element $parent. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Object * @warn_unused; } pack_get @const { [[Get packing location of a child of table - @since 1.1]] + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + + @since 1.1 + ]] return: bool; [[$true on success, $false on failure.]] params { @in child: Evas.Object *; [[The child object to add.]] @@ -184,7 +264,12 @@ class Evas.Table (Evas.Smart_Clipped) That means that col + colspan AND row + rowspan must fit inside 16bit unsigned values cleanly. You will be warned once values exceed 15bit storage, and attempting to use values not able to fit in 16bits will - result in failure.]] + result in failure. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false on failure.]] params { @@ -200,7 +285,12 @@ class Evas.Table (Evas.Smart_Clipped) Note: removing a child will immediately call a walk over children in order to recalculate numbers of columns and rows. If you plan to remove - all children, use @Evas.Table.clear instead.]] + all children, use @Evas.Table.clear instead. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false on failure.]] params { diff --git a/src/lib/evas/canvas/evas_text.eo b/src/lib/evas/canvas/evas_text.eo index de9cbd9..3e9c502 100644 --- a/src/lib/evas/canvas/evas_text.eo +++ b/src/lib/evas/canvas/evas_text.eo @@ -22,10 +22,20 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) See @.shadow_color]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { [[Note: Use $NULL pointers on the color components you're not - interested in: they'll be ignored by the function.]] + interested in: they'll be ignored by the function. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { r: int; [[The red component of the given color.]] @@ -46,8 +56,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @since 1.8]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { ellipsis: double(-1); [[the ellipsis. Allowed values: -1.0 or 0.0-1.0]] @@ -62,8 +82,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @since 1.1]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { delim: const(char)*; [[A null terminated string of delimiters, e.g ",|".]] @@ -79,8 +109,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) - @Evas.Text_Style_Type.outline_shadow - @Evas.Text_Style_Type.outline_soft_shadow]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { r: int; [[The red component of the given color.]] @@ -97,8 +137,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) to the @Evas.Text_Style_Type.glow style. See also @.glow_color.]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { r: int; [[The red component of the given color.]] @@ -130,8 +180,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @see evas_object_text_glow_color_set() @see evas_object_text_glow2_color_set() */ set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { style: Evas.Text_Style_Type; [[a style type.]] @@ -148,8 +208,18 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) itself, but no touching it. For glowing effects right on the borders of the glyphs, see 'glow 2' effects.]] set { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { + [[ + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { r: int; [[The red component of the given color.]] @@ -161,11 +231,21 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @property max_descent { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property style_pad { get { - [[Gets the text style pad of a text object.]] + [[Gets the text style pad of a text object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { l: int; [[The left pad (or $NULL).]] @@ -177,7 +257,12 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @property direction { get { [[Retrieves the direction of the text currently being displayed in the - text object.]] + text object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.BiDi_Direction; } @@ -185,11 +270,21 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @property ascent { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property horiz_advance { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property horiz_width_without_ellipsis { @@ -204,25 +299,50 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) @property inset { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property max_ascent { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property vert_advance { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } @property descent { get { return: Evas.Coord; + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } } last_up_to_pos @const { - [[Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text.]] + [[Returns the logical position of the last char in the text up to the pos given. this is NOT the position of the last char because of the possibility of RTL in the text. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: int(-1); params { @in x: Evas.Coord; @@ -246,7 +366,12 @@ class Evas.Text (Evas.Object, Efl.Text, Efl.Text_Properties, Evas.Filter) This function is used to obtain the X, Y, width and height of the character located at $pos within the @Evas.Object $obj. $obj must be a text object Any of the $Evas_Coord parameters ($cx, $cy, $cw, $ch) may be $NULL in which case no value will be assigned to that - parameter.]] + parameter. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$false on success, $true otherwise]] params { diff --git a/src/lib/evas/canvas/evas_textblock.eo b/src/lib/evas/canvas/evas_textblock.eo index a087400..c6d377c 100644 --- a/src/lib/evas/canvas/evas_textblock.eo +++ b/src/lib/evas/canvas/evas_textblock.eo @@ -13,10 +13,19 @@ class Evas.Textblock (Evas.Object) Note: assumes text does not include the unicode object replacement char (0xFFFC) + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } get { - [[Get the markup of the object.]] + [[Get the markup of the object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { text: const(char)*; [[The markup text to use.]] @@ -31,12 +40,20 @@ class Evas.Textblock (Evas.Object) be between 0.0 and 1.0 (1.0 bottom of object, 0.5 being vertically centered etc.). + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } get { [[Gets the vertical alignment of a textblock + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -53,6 +70,10 @@ class Evas.Textblock (Evas.Object) e-mail clients where bidi oddities can occur when mixing RTL and LTR. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -64,6 +85,10 @@ class Evas.Textblock (Evas.Object) e-mail clients where bidi oddities can occur when mixing RTL and LTR. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -73,7 +98,12 @@ class Evas.Textblock (Evas.Object) } @property replace_char { set { - [[Set the "replacement character" to use for the given textblock object.]] + [[Set the "replacement character" to use for the given textblock object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { ch: const(char)*; [[The charset name.]] @@ -84,6 +114,10 @@ class Evas.Textblock (Evas.Object) [[Sets newline mode. When true, newline character will behave as a paragraph separator. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -91,6 +125,10 @@ class Evas.Textblock (Evas.Object) [[Gets newline mode. When true, newline character behaves as a paragraph separator. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.1 ]] } @@ -100,10 +138,20 @@ class Evas.Textblock (Evas.Object) } @property style { set { - [[Set the objects style to $ts.]] + [[Set the objects style to $ts. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } get { - [[Get the style of an object.]] + [[Get the style of an object. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] } values { ts: const(Evas.Textblock.Style)*; [[The style.]] @@ -111,7 +159,12 @@ class Evas.Textblock (Evas.Object) } @property node_format_first { get { - [[Gets the first format node.]] + [[Gets the first format node. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] legacy: evas_textblock_node_format_first_get; } values { @@ -136,6 +189,10 @@ class Evas.Textblock (Evas.Object) "You shall not pass!" with no margins or padding and assuming a monospace font and a size of 7x10 char widths (for simplicity) has a native size of 19x1 and a formatted size of 5x4. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -145,7 +202,12 @@ class Evas.Textblock (Evas.Object) } @property node_format_last { get { - [[Gets the last format node.]] + [[Gets the last format node. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] legacy: evas_textblock_node_format_last_get; } values { @@ -154,7 +216,12 @@ class Evas.Textblock (Evas.Object) } @property cursor { get { - [[Get the object's main cursor.]] + [[Get the object's main cursor. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: Evas.Textblock.Cursor *; } } @@ -176,6 +243,10 @@ class Evas.Textblock (Evas.Object) "You shall not pass!" with no margins or padding and assuming a monospace font and a size of 7x10 char widths (for simplicity) has a native size of 19x1 and a formatted size of 5x4. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] } values { @@ -184,7 +255,13 @@ class Evas.Textblock (Evas.Object) } } @property style_insets { - get {} + get { + [[ + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] + } values { l: Evas.Coord; r: Evas.Coord; @@ -193,7 +270,12 @@ class Evas.Textblock (Evas.Object) } } line_number_geometry_get @const { - [[Get the geometry of a line number.]] + [[Get the geometry of a line number. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] return: bool; [[$true on success, $false otherwise.]] params { @in line: int; [[The line number.]] @@ -207,6 +289,10 @@ class Evas.Textblock (Evas.Object) [[Get the "replacement character" for given textblock object. Returns $null if no replacement character is in use. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: const(char)*; [[Replacement character or $null.]] } @@ -215,6 +301,10 @@ class Evas.Textblock (Evas.Object) See also @.style.get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] } @@ -229,6 +319,10 @@ class Evas.Textblock (Evas.Object) slightly faster to just allocate the cursor yourself and not associate it. (only people developing the actual object, and not users of the object). + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif ]] return: Evas.Textblock.Cursor *; [[The new cursor.]] } @@ -244,12 +338,21 @@ class Evas.Textblock (Evas.Object) See also @.style.get. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] return: const(Evas.Textblock.Style)*; [[The style of the object.]] } node_format_remove_pair { - [[Remove a format node and its match.]] + [[Remove a format node and its match. + + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + ]] legacy: evas_textblock_node_format_remove_pair; params { @in n: Evas.Textblock.Node_Format *; @@ -274,6 +377,10 @@ class Evas.Textblock (Evas.Object) See also @.style.set. + \@if MOBILE \@since_tizen 2.3 + \@elseif WEARABLE \@since_tizen 2.3.1 + \@endif + @since 1.2 ]] params { @@ -287,6 +394,10 @@ class Evas.Textblock (Evas.Object) The textblock does the layout of the text according to the position of the obstacle. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.15 ]] params { @@ -297,6 +408,10 @@ class Evas.Textblock (Evas.Object) obstacle_del { [[Removes $eo_obs from observation during text layout. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.15 ]] params { @@ -317,6 +432,10 @@ class Evas.Textblock (Evas.Object) call this so it will consider this new state and will relayout the text. + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + @since 1.15 ]] } diff --git a/src/lib/evas/canvas/evas_textgrid.eo b/src/lib/evas/canvas/evas_textgrid.eo index 8d30d63..3267096 100644 --- a/src/lib/evas/canvas/evas_textgrid.eo +++ b/src/lib/evas/canvas/evas_textgrid.eo @@ -27,10 +27,20 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) methods { @property supported_font_styles { set { - [[This function is not implemented yet, do not use.]] + [[This function is not implemented yet, do not use. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } get { - [[This function is not implemented yet, do not use.]] + [[This function is not implemented yet, do not use. + + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + ]] } values { styles: Evas.Textgrid.Font_Style; [[EVAS_TEXTGRID_FONT_STYLE_NORMAL]] @@ -45,7 +55,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) $w or $h are less or equal than 0, this functiond does nothing. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] } get { [[Get the size of the textgrid object. @@ -55,7 +70,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) the textgrid object $obj. $w or $h can be $null. On error, their value is 0. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] } values { w: int; [[The number of columns (width in cells) of the grid.]] @@ -75,7 +95,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @Efl.Text_Properties.font.set and @.supported_font_styles.set - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] } values { width: int; [[A pointer to the location to store the width in pixels of a cell.]] @@ -91,7 +116,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @.cellrow_set, @.cellrow_get and @.size.set. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] /* FIXME-doc * An application should modify cells like this * as an example: @@ -122,7 +152,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @.cellrow_get, @.size.set and @.update_add. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] params { @in y: int; [[The row index of the grid.]] @@ -138,7 +173,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @.cellrow_set, @.size.set and @.update_add. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] return: Evas.Textgrid.Cell*; [[A pointer to the first cell of the given row.]] params { @in y: int; [[The row index of the grid.]] @@ -160,7 +200,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @.palette_get. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] params { @in pal: Evas.Textgrid.Palette; [[The type of the palette to set the color.]] @@ -184,7 +229,12 @@ class Evas.Textgrid (Evas.Object, Efl.Text_Properties) See also @.palette_set. - @since 1.7]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.7 + ]] params { @in pal: Evas.Textgrid.Palette; [[The type of the palette to set the color.]] @in idx: int; [[The index of the palette to which the color is stored.]] diff --git a/src/lib/evas/canvas/evas_vg.eo b/src/lib/evas/canvas/evas_vg.eo index 6438fe3..286f0d4 100644 --- a/src/lib/evas/canvas/evas_vg.eo +++ b/src/lib/evas/canvas/evas_vg.eo @@ -11,7 +11,12 @@ class Evas.VG (Evas.Object, Efl.Gfx.Fill, Efl.Gfx.View) object canvas you must create the hirarchy and set the parent as root node. - @since 1.14]] + \@if MOBILE \@since_tizen 3.0 + \@elseif WEARABLE \@since_tizen 3.0 + \@endif + + @since 1.14 + ]] } values { container: Efl_VG *; [[Root node of the VG canvas.]] -- 2.7.4