* ecore_shutdown();
* }
* @endcode
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
* 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);
*
* @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);
* @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);
* 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);
*
* @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);
* 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);
* 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);
*
* 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);
* 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);
* 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);
*
* @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);
*
* @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);
* 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);
* 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);
*
* 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);
* 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);
*
* 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);
*
* 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);
* 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);
* 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);
* 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);
* 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);
*
* 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);
*
* 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);
* 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);
* @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);
* @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);
* 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);
* 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);
* @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);
* 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);
* @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);
* 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);
*
* @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);
* 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);
* @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);
* @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);
*
* @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);
* @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);
* 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);
* @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);
* @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);
* 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);
* @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);
* 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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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);
*
* @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);
* @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);
* 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);
/**
* 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);
/**
* @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.
*/
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.
*
* 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);
* @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);
* 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
* @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);
* @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,
* 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);
* @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);
* 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);
* 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);
* 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);
* 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);
*
* 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);
*
* 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);
*
* 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);
*
* @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);
*
* @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);
*
* @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);
* 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);
* @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);
* @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);
*
* @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);
* 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);
* @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);
* @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);
*
* @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);
* 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);
*
* @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);
* @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);
*
* @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,
*
* @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);
* @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);
* 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);
* 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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
*
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
*
* 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);
* @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);
* 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);
* 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);
* @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);
* 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);
* 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);
* 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);
* @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);
* @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);
* @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);
* 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);
* @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);
*
* 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);
* @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);
* @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);
*
* @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);
* @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);
* @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);
*
* @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);
* 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);
* @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);
* 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);
*
* @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);
*
* @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);
* @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);
* 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);
*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);
*
* 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);
* 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);
* 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);
*
* 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);
* (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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
{
eo_prefix: ecore_animator;
methods {
- timeline_constructor {
+ timeline_constructor @internal {
[[Constructor.]]
legacy: null;
params {
@in data: const(void)*;
}
}
- constructor {
+ constructor @internal {
[[Constructor.]]
legacy: null;
params {
{
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 {
@in data: const(void)*;
}
}
- after_constructor {
+ after_constructor @internal {
[[Contructor. Will insert the handler at the end of the list.]]
legacy: null;
params {
{
eo_prefix: ecore_idle_exiter;
methods {
- constructor {
+ constructor @internal {
[[Constructor.]]
legacy: null;
params {
{
eo_prefix: ecore_idler;
methods {
- constructor {
+ constructor @internal {
[[Constructor.]]
legacy: null;
params {
{
eo_prefix: ecore_job;
methods {
- constructor {
+ constructor @internal {
[[Constructor.]]
legacy: null;
params {
class Ecore.Poller (Eo.Base)
{
methods {
- constructor {
+ constructor @internal {
[[Constructor with parameters for Ecore Poller.]]
legacy: null;
params {
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 {
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]]
}
@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;
}
}
[[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]]
/* Audio operations */
/**
+ * @internal
+ *
* @brief Initialize the Ecore_Audio library.
*
* @return 1 or greater on success, 0 on error.
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
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
EAPI Ecore_Avahi *ecore_avahi_add(void);
/**
+ * @internal
+ *
* @brief Delete the specified handler of an AvahiPoll.
*
* @param handler The actual handler to destroy.
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.
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
*
* 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);
/**
* @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);
/**
* @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);
/**
* @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);
* 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);
/**
* 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);
* @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);
/**
* @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);
/**
*
* 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);
/**
* 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);
/**
* @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);
/**
*
* 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);
/**
*
* 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);
/**
* @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);
* @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);
/**
* @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);
/**
* 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);
/**
* 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);
/**
* 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);
/**
*
* 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);
/**
*
* 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);
/**
* @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);
} 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;
/**
*
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
*
* 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,
*
* 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,
* 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);
* @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);
/**
* @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);
*
* @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);
* @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);
/**
*
* 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);
/**
*
* @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,
* 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,
* 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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
* @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);
* 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);
/**
*
* @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,
*
* @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);
/**
*
* @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);
*
* @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);
*
* 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);
/**
*
* @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);
/**
* 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);
/**
* 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);
/**
*
* @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);
/**
*
* @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);
/**
* @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);
* @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);
*
* @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);
*
* @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);
* 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);
/**
* @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);
*
* @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);
/**
*
* @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);
* @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);
* 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);
* 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);
/**
* @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,
* @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);
/**
* 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);
/**
*
* 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);
/**
*
* @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);
/**
*
* @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,
* @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);
/**
* @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);
/**
* @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,
*
* @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,
*
* 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,
* 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);
* @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);
*
* @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);
/**
* 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);
*
* @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);
/**
*
* @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);
/**
*
* @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);
* 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);
* 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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
/**
* 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);
* 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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
/**
* * 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);
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.]]
[[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.]]
}
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.]]
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.]]
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;
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
EAPI extern int ECORE_DRM_EVENT_SEAT_ADD; /**< @since 1.14 */
/**
+ * @internal
+ *
* @file
* @brief Ecore functions for dealing with drm, virtual terminals
*
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
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.
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.
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
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
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
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
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
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
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
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
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
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.
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.
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.
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.
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.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
* 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);
/**
* 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);
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
*/
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
* 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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
* @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);
/**
* @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);
/**
*
* @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);
/**
*
* @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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
* 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);
/**
* @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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
* @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));
/**
* @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));
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
* 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);
/**
* 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);
/**
* 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);
/**
* @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);
/**
* @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.
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
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.
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.
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.
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
*
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.
#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.
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
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.
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.
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.
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.
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
*
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.
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.
* 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);
* 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);
* @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);
* 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
*
/**
+ * @internal
+ *
* @brief Return the backing store image object that represents the given
* window in EWS.
* @return The evas object of EWS backing store.
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()
*
EAPI void ecore_evas_ews_delete_request(Ecore_Evas *ee);
/**
+ * @internal
+ *
* @brief Create an Evas image object with image data <b>bound to an
* own, internal @c Ecore_Evas canvas wrapper</b>
*
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()
*
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()
*
/* 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.
* @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);
/**
* @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);
/**
* 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);
/**
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
*
* @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);
/**
* @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);
* @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);
* @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);
* 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);
* @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);
/**
* @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);
/**
* @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);
* @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);
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
* 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);
* 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);
*
* @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);
/**
* @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
* @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);
*
* 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);
*
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* 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);
* @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);
* @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);
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
*/
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
*/
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.
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.
*/
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.
*/
/**
+ * @internal
+ *
* @brief Set the engine to be used by the backing store engine.
*
* @param engine The engine to be set.
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.
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.
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.
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
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.
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
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()
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
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.
*
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.
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.
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
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
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.
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.
*
* @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);
* @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
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
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
*
* 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()
* 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()
*
* 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)
*
* 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)
*
* 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)
*
* 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)
* 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)
* 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)
* 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)
*
* 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)
*
* 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)
*
* 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)
* 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)
* 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)
* 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)
* @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)
*
* 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)
* 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)
* 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)
*
* 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)
* 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)
*
* 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)
*
* 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)
*
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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)
* 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,
* @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,
* @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)
* 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)
* 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)
* 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,
* 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)
* 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)
* 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)
* 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)
* 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)
* @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);
* @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);
* @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));
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);
* @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);
* @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);
* @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);
* @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);
* }
* }
* @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);
* @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);
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* 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);
*
* 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);
*
* 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);
*
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
*
* 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);
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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));
* @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);
* @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);
* 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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* 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);
*
* 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);
* @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;
/**
* 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);
* @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);
*
* @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);
* @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
/**
* 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
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* 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)
* @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)
* @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)
* 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)
*
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* @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)
* 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)
*
* @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)
* 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)
/**
* @internal
*
+ * @internal
+ *
* @file
* @brief Ecore functions for dealing with the Wayland window system
*
/**
* @internal
*
+ * @internal
+ *
* Initialize the Wayland display connection to the given display.
*
* @param name Display target name. if @c NULL, the default display is
/**
* @internal
*
+ * @internal
+ *
* Shuts down the Ecore Wayland Library
*
* In shutting down the library, the Wayland display connection is terminated
/**
* @internal
*
+ * @internal
+ *
* Sends all Wayland commands to the Wayland Display.
*
* @ingroup Ecore_Wl_Flush_Group
/**
* @internal
*
+ * @internal
+ *
* Flushes the command buffer and waits until all requests have been
* processed by the server.
*
/**
* @internal
*
+ * @internal
+ *
* Retrieves the Wayland Shm Interface used for the current Wayland connection.
*
* @return The current wayland shm interface, or NULL on error
/**
* @internal
*
+ * @internal
+ *
* Retrieves the Wayland Display Interface used for the current Wayland connection.
*
* @return The current wayland display interface, or NULL on error
/**
* @internal
*
+ * @internal
+ *
* Retrieves the size of the current screen.
*
* @param w where to return the width. May be NULL. Returns 0 on error.
/**
* @internal
*
+ * @internal
+ *
* Retrieves the position of the current screen.
*
* @param x where to return the horizontal position. May be NULL. Returns 0 on error.
/**
* @internal
*
+ * @internal
+ *
* Return the screen DPI
*
* This is a simplistic call to get DPI. It does not account for differing
/**
* @internal
*
+ * @internal
+ *
* Dispatch Wayland events
*
* Dispatches any events queued on the default queue. Wayland will attempt
/**
* @internal
*
+ * @internal
+ *
* Retrieves the requested cursor from the cursor theme
*
* @param cursor_name The desired cursor name to be looked up in the theme
/**
* @internal
*
+ * @internal
+ *
* @ingroup Ecore_Wl_Input_Group
* @since 1.8
*/
/**
* @internal
*
+ * @internal
+ *
* @ingroup Ecore_Wl_Input_Group
* @since 1.12
*/
/**
* @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
/**
* @internal
*
+ * @internal
+ *
* Retrieves the Wayland Registry used for the current Wayland connection.
*
* @return The current wayland registry, or NULL on error
/**
* @internal
*
+ * @internal
+ *
* Creates a new window
*
* @param parent The parent window to use. If @p parent is @c 0, the root window
/**
* @internal
*
+ * @internal
+ *
* Deletes the given window
*
* @param win The given window
/**
* @internal
*
+ * @internal
+ *
* Signals for Wayland to initiate a window move.
*
* The position requested (@p x, @p y) is not honored by Wayland because
/**
* @internal
*
+ * @internal
+ *
* Signals for Wayland to initiate a window resize.
*
* The size requested (@p w, @p h) is not honored by Wayland because
/**
* @internal
*
+ * @internal
+ *
* Shows a window
*
* Synonymous to "mapping" a window in Wayland System terminology.
/**
* @internal
*
+ * @internal
+ *
* Hides a window
*
* Synonymous to "unmapping" a window in Wayland System terminology.
/**
* @internal
*
+ * @internal
+ *
* Raises a window
*
* @param win The window to raise.
/**
* @internal
*
+ * @internal
+ *
* Iconify a window
*
* @param win The window to iconifiy
/**
* @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.
/**
* @internal
*
+ * @internal
+ *
* Returns the Ecore_Wl_Window from a wl_surface
*
* @param surface The surface for which to find the Ecore_Wl_Window from
/**
* @internal
*
+ * @internal
+ *
* Set the input region of the Ecore_Wl_Window.
*
* To set an empty region, pass width and height as 0.
/**
* @internal
*
+ * @internal
+ *
* Set the opaque region of the Ecore_Wl_Window
*
* @param win The window
/**
* @internal
*
+ * @internal
+ *
* Set the rotation of the Ecore_Wl_Window
*
* @param win The window
/**
* @internal
*
+ * @internal
+ *
* Get the rotation of the Ecore_Wl_Window
*
* @param win The window
/**
* @internal
*
+ * @internal
+ *
* @deprecated use ecore_wl_dnd_selection_set
* @since 1.7
*/
/**
* @internal
*
+ * @internal
+ *
* @deprecated use ecore_wl_dnd_selection_get
* @since 1.7
*/
/**
* @internal
*
+ * @internal
+ *
* @deprecated Do Not Use
* @since 1.7
*/
/**
* @internal
*
+ * @internal
+ *
* @deprecated use ecore_wl_dnd_drag_start
* @since 1.7
*/
/**
* @internal
*
+ * @internal
+ *
* @deprecated use ecore_wl_dnd_selection_owner_has
* @since 1.7
*/
/**
* @internal
*
+ * @internal
+ *
* @return false on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* @return false if type not found or on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* @return true if input has a selection source, false otherwise or on error
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* @return false on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
*
+ * @internal
+ *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
*
+ * @internal
+ *
* @return false if type not found or on error, true otherwise
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* @ingroup Ecore_Wl_Dnd_Group
* @since 1.8
*/
/**
* @internal
*
+ * @internal
+ *
* @return the data types being offered for drag-and-drop, or NULL on error
*
* @ingroup Ecore_Wl_Dnd_Group
/**
* @internal
*
+ * @internal
+ *
* Enable/disable server mode.
*
* With this enabled, the compositor acts as a Wayland server, iterating
/**
* @internal
*
+ * @internal
+ *
* Create and return a new subsurface.
*
* Create a new surface (and subsurface interface), with the parent surface
/**
* @internal
*
+ * @internal
+ *
* Destroy the given subsurface, as well as the surface associated with it.
*
* @param ess the subsurface
/**
* @internal
*
+ * @internal
+ *
* Get the wl_surface for this subsurface
*
* @param ess the subsurface
/**
* @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.
/**
* @internal
*
+ * @internal
+ *
* Get the position of this subsurface, relative to its parent surface.
* Coordinates will be returned in x and y if non-NULL.
*
/**
* @internal
*
+ * @internal
+ *
* Place subsurface on layer above a reference surface
*
* Moves the @param ess subsurface to just above the reference @param
/**
* @internal
*
+ * @internal
+ *
* Place subsurface on layer below a reference surface
*
* See ecore_wl_subsurf_place_above.
/**
* @internal
*
+ * @internal
+ *
* Enables or disables sub-surface synchronization
*
* When synchronization is enabled, surface commits on the subsurface
/**
* @internal
*
+ * @internal
+ *
* Set an opaque region for the given subsurface.
*
* This is an optimization hint to the compositor to allow it avoid
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
*/
EAPI char *ecore_x_e_window_profile_get(Ecore_X_Window win);
/**
+ * @internal
+ *
* @brief Set the window profile
*
* @param win The client x window
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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
*/
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.
*/
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.
*/
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.
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
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.
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.
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
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
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
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
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
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.
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
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
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.
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.
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.
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.
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
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
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
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.
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
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.
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 */
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.
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
*
* @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);
* @see embryo_init()
* @see eet_init()
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
*
* 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);
* 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);
* 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);
* 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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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;
* 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);
* 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);
* 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);
* 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);
*
* @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;
* }
*
* @endcode
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* 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);
* 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);
*
* @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);
* 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);
*
* @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);
* 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);
*
* @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);
*
* 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);
* 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);
* 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);
* @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);
* 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);
*
* @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);
* @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);
* 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);
* 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);
*
* 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);
* @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);
* @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);
* @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);
* 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);
* @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);
* @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);
* 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);
*
* @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);
*
* @see edje_frametime_set()
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
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);
*
* @see edje_freeze()
*
+ * @if MOBILE @since_tizen 2.3
+ * @elseif WEARABLE @since_tizen 2.3.1
+ * @endif
*/
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);
* @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);
*
* @since 1.15
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI double edje_transition_duration_factor_get (void);
* 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);
*
* @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);
/**
* 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);
/**
* @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);
/**
* @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);
/**
* 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);
/**
*
* @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);
/**
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* 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);
* @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);
* @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);
* 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);
* @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);
* @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);
* @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);
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.]]
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]]
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]]
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.
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
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.
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,
\@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.]]
}
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.]]
}
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 {
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,
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,
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]]
@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]]
@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]]
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 {
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.]]
}
@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]]
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 {
[[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]]
@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]]
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]]
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
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<const(char)*> *; [[A list all accessibility part names on obj]]
}
}
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
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
[[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 {
}
}
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.]]
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
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 {
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 {
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]]
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]]
}
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]]
}
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 {
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]]
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]]
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]]
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]]
}
[[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]]
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 {
}
}
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]]
}
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 {
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]]
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]]
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]]
[[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]]
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 {
}
}
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]]
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 {
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 {
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]]
[[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]]
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]]
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]]
}
[[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 {
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]]
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]]
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 {
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]]
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]]
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]]
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 {
[[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]]
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]]
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]]
[[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]]
}
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.]]
[[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<const(Evas.Textblock_Rectangle)*>)*; [[The list of anchor rects (const Evas_Textblock_Rectangle
*), do not modify! Geometry is relative to entry part.]]
params {
}
}
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 {
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 {
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]]
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.]]
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
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]]
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]]
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]]
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]]
}
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 {
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 {
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]]
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 {
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
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 {
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 {
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
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]]
}
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]]
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]]
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]]
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]]
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]]
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]]
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]]
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
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]]
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 {
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 {
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 {
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]]
}
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]]
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 {
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.]]
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 {
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
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
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.]]
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
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.]]
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 {
}
}
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 {
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]]
[[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]]
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]]
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]]
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]]
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]]
}
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 {
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]]
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 {
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 {
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)*;
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 {
}
}
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 {
}
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]]
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<const(char)*>)*; [[The list of anchors (const char *), do not modify!]]
params {
@in part: const(char)*; [[The part name]]
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]]
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]]
}
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 {
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 {
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]]
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]]
}
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 {
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<const(char)*>)*; [[The list of items (const char *), do not modify!]]
params {
@in part: const(char)*; [[The part name]]
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 {
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]]
*
* @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);
*
* @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);
*
* @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);
* 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,
* 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);
*
* @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,
*
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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,
*
* @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);
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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);
*
* @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,
*
* @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,
*
* @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);
*
* @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);
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
* @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,
*
* @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);
*
* @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,
* @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,
* @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,
*
* @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,
* @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,
*
* @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,
* @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,
*/
/**
+ * @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).
*
* @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);
*
* @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);
*
* @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,
*
* @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,
*
* @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);
*
* @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);
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
*
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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);
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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);
* @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);
* @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);
/**
* @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,
/**
* 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,
/**
* 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,
/**
* 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,
* @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);
* @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);
/**
* 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);
/**
* 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,
/**
* 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,
/**
* 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,
/**
* 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,
*
* @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,
*
* @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,
*
* @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);
*
* @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,
*
* @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,
*
* @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,
/**
+ * @internal
+ *
* Initialize the eeze library.
* @return The number of times the function has been called, or -1 on failure.
*
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.
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.
*/
/**
+ * @internal
+ *
* Returns a stringshared list of all syspaths that are (or should be) the same
* device as the device pointed at by @p syspath.
*
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.
*
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
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
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
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
*/
/**
+ * @internal
+ *
* Get the syspath of a device from the /dev/ path.
*
* @param devpath The /dev/ path of the device
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/"
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/"
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
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/
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/
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/
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/
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/
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/
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/
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/
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/
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/
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/
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/
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/
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/
*/
/**
+ * @internal
+ *
* Walks up the device chain starting at @p syspath,
* checking each device for @p sysattr with (optional) @p value.
*
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.
*
*/
/**
+ * @internal
+ *
* Add a watch for a device type
*
* @param type The #Eeze_Udev_Type to watch
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
};
/**
+ * @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,
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
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
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
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
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
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
*
EAPI void eeze_disk_free(Eeze_Disk *disk);
/**
+ * @internal
+ *
* @brief Retrieve all disk information
* @param disk
*
EAPI void eeze_disk_scan(Eeze_Disk *disk);
/**
+ * @internal
+ *
* @brief Associate data with a disk
* @param disk The disk
* @param data The data
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
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
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
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
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
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
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
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
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
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
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.
/**
+ * @internal
+ *
* @brief Return the mount state of a disk
* @param disk The disk
* @return The mount state
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.
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
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.
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.
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.
*/
EAPI Eina_Bool eeze_disk_eject(Eeze_Disk *disk);
/**
+ * @internal
+ *
* @brief Cancel a pending operation on the disk
* @param disk The 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
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
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
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
/**
+ * @internal
+ *
* @brief Begin watching mtab and fstab
* @return @c EINA_TRUE if watching was started, @c EINA_FALSE otherwise.
*
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.
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.
*
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.
*
EAPI Eina_Bool eeze_mount_fstab_scan(void);
/**
+ * @internal
+ *
* @brief Get the property value of a disk
*
* @param disk The disk
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
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
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.
*
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.
*
/**
* @internal
+ *
+ * @internal
* @defgroup Eeze_Sensor_Events Available eeze sensor events
* @brief Sensor events that are emitted from the library as ecore events
* @ingroup Eeze
#endif
/**
+ * @internal
+ *
* @brief Create sensor object to operate on.
* @param type Sensor type to create object from.
* @return Sensor object for the given type.
EAPI Eeze_Sensor_Obj *eeze_sensor_new(Eeze_Sensor_Type type);
/**
+ * @internal
+ *
* @brief Free a sensor object.
* @param sens Sensor object to operate on.
*
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.
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.
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.
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.
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.
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
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.
#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
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
/**
+ * @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
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
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
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
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
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.
/**
+ * @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
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
*/
/**
+ * @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
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
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.
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.
*/
/**
+ * @internal
+ *
* @return Returns the XDG Data Home directory
* @brief Retrieves the XDG Data Home directory
*
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
*
/**
+ * @internal
+ *
* @return Returns the XDG Config Home directory
* @brief Retrieves the XDG Config Home directory
*
EAPI const char *efreet_config_home_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Desktop directory
* @brief Retrieves the XDG Desktop directory
*
EAPI const char *efreet_desktop_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Download directory
* @brief Retrieves the XDG Download directory
*
EAPI const char *efreet_download_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Templates directory
* @brief Retrieves the XDG Templates directory
*
EAPI const char *efreet_templates_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Public Share directory
* @brief Retrieves the XDG Public Share directory
*
EAPI const char *efreet_public_share_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Documents directory
* @brief Retrieves the XDG Documents directory
*
EAPI const char *efreet_documents_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Music directory
* @brief Retrieves the XDG Music directory
*
EAPI const char *efreet_music_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Pictures directory
* @brief Retrieves the XDG Pictures directory
*
EAPI const char *efreet_pictures_dir_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG Videos directory
* @brief Retrieves the XDG Videos directory
*
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
/**
+ * @internal
+ *
* @return Returns the XDG Cache Home directory
* @brief Retrieves the XDG Cache Home directory
*
EAPI const char *efreet_cache_home_get(void);
/**
+ * @internal
+ *
* @return Returns the XDG User Runtime directory.
* @brief Retrieves the XDG User Runtime directory.
*
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
*/
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
*/
/**
+ * @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
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
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
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
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
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
/**
+ * @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
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
/**
+ * @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
/**
+ * @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")
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
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
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
/**
+ * @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
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
const char *category);
/**
+ * @internal
+ *
* @param desktop the desktop
* @param category the category name
* @brief removes a category from a 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
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
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
/**
+ * @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
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
/**
+ * @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
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
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
/**
+ * @internal
+ *
* Event id for cache update.
*/
EAPI extern int EFREET_EVENT_ICON_CACHE_UPDATE;
};
/**
+ * @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
/**
+ * @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
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.
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.
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
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
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
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.
/**
+ * @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
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.
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
/**
+ * @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
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
/**
+ * @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
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
/**
+ * @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
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
/**
+ * @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
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
/**
+ * @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
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
/**
+ * @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
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
/**
+ * @internal
+ *
* @param ini The ini struct to work with
* @param key The key to remove
* @return Returns no value
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.
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
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
*
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
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
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
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
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
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)
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
/**
+ * @internal
+ *
* @param menu The Efreet_Menu to unreference
* @return Returns no value
* @brief Decrements refcount for the menu, and on 0 frees
/**
+ * @internal
+ *
* @param menu The menu to work with
* @param desktop The desktop to insert
* @param pos The position to place the new desktop
int pos);
/**
+ * @internal
+ *
* @param menu The menu to work with
* @param desktop The desktop to remove
* @return Returns 1 on success, 0 on failure
/**
+ * @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
/**
+ * @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
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
EAPI Efreet_Uri *efreet_uri_decode(const char *val);
/**
+ * @internal
+ *
* @param uri The uri to free
* @brief Free the given uri structure.
*/
/**
+ * @internal
+ *
* Returns the fdo file id for a given path. If the file isn't inside
* a default fdo path it will return NULL.
*
/**
+ * @internal
+ *
* Find all desktops for a given mime type
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
/**
+ * @internal
+ *
* Find all desktops for a given wm class
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
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
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
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
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
/**
+ * @internal
+ *
* Find all desktops where name matches a glob pattern
*
* This list must be freed using EINA_LIST_FREE / efreet_desktop_free
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
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
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
/**
+ * @internal
+ *
* Find all desktop categories
* This list must be freed using EINA_LIST_FREE
*
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
/**
+ * @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
* @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);
* @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,
*
* @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;
* @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,
* 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);
* @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);
* 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);
*
* 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;
* 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);
* 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,
* 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);
*
* 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),
* @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;
* 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;
/**
*
* 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);
* 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);
*
* 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,
* 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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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;
*
* @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;
* @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.
*
* 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);
*
* 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);
* @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);
* @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);
*
* 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);
* @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);
* 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);
* 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);
* 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;
* 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);
*
* 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);
* @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;
* 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;
* 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);
*
* @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);
*
* @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;
*
* @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);
*
* 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);
*
* 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);
*
* 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);
*
* 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,
* @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);
*
* @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,
*
* @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);
* (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);
*
* @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);
* 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);
* @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);
* @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;
* @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);
* @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;
*
* @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);
* @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;
* @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,
* @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,
* 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);
* @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;
* @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);
*
* @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);
* @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);
/**
* @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;
* 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;
* 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;
* 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);
* 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);
* 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);
* @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;
*
* @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;
};
/**
+ * @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.).
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
eina_evlog_steal(void);
/**
+ * @internal
+ *
* @brief Begin logging - until now eina_evlog is a NOOP
*
* @since 1.15
eina_evlog_start(void);
/**
+ * @internal
+ *
* @brief Stop logging
*
* You must not be using any evlog buffers stolen by eina_evlog_steal() by
* 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,
* 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;
* @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;
* 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;
* @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);
*
* @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);
*
* @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);
* 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;
* 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);
* 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);
* 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;
* @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);
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* 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);
* @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);
* @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);
* @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);
* 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,
* 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);
* @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);
*
* @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);
*
* @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);
* @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);
* 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,
*
* @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);
* 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);
*
* 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);
* 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);
* 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);
* 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);
* 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);
* 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);
* 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,
* 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,
* 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,
* @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);
* 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,
* 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,
* 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,
* 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);
* 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);
*
* 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);
* 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,
* 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,
*
* @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,
* @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);
*
* @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);
* @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,
* '\\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,
* @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,
* @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;
* @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;
* @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;
* 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,
* @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);
/**
* @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);
/**
* @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);
* @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);
* @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;
* @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);
* @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,
* @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);
* @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);
* 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);
* @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,
* @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,
* @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);
* @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);
* @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;
* @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,
* @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,
* @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,
* @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);
* @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);
* @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);
* @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,
* 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,
* @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,
* 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,
* @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);
* @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;
* 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);
* 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);
* 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);
* @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;
* @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;
* @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,
* @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,
* @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;
* @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;
* @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;
* @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;
* @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;
* @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;
* 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;
* 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;
* @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);
* 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);
* @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);
* 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,
*
* 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);
* @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);
*
* 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;
* @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;
* 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,
* 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);
* 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);
*
* @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,
*
* @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);
*
* @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);
*
* @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);
* @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;
* @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;
* @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;
* 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;
* @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;
* 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;
* 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;
* 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;
* @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;
* @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;
* @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);
* @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;
* @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;
* 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);
* 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);
*
* 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);
* @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;
* @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;
*
* @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;
*
* @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;
* @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;
* @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;
* @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;
* 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;
* @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;
* 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;
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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;
* @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;
* 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;
* @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);
/**
* @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;
/**
* 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;
*
* 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);
* @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);
* @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);
* @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;
*
* @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;
* @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);
* @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;
* @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);
* @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;
* 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);
* @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;
*
* @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);
*
* @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;
*
* @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);
*
* @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;
* 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);
*
* @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);
*
* @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;
* 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);
* 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);
* 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);
*
* @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,
* 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,
* @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,
* @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,
* @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,
* @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,
* @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
* 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,
* - (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;
/**
* 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);
* @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);
/**
* @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;
* @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,
*
* 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);
* 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);
* 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);
* 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);
* 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);
*
* 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);
* @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,
* 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);
* 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);
* @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,
* @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,
* @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,
* @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);
* 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,
* @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);
* @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);
* @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);
* @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);
* 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);
* 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);
* 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,
/**
* @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,
/**
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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,
* @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,
* 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);
* 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);
* @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);
* 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);
* @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);
* @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);
* @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);
* 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);
* @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);
* @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);
* @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,
* @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);
* @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);
* 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);
* @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);
* 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);
* @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);
* @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);
* @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);
* 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);
* @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,
* @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);
* 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,
* @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,
*
* @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);
*
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
* @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);
*
* @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);
* @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);
* @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);
*
* @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);
* 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);
* 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);
* 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);
* 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);
*
* 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);
* 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);
* 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;
* 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);
*
* @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);
* 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);
* 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);
* 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);
* 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;
*
* 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);
*
* 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);
*
* 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);
* 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);
* @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,
* @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);
* "/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;
* "/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;
* "/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;
* "/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;
* "/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;
/**
* @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,
/**
* @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,
* 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;
* 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;
* @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);
* @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;
* @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;
* @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;
* 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;
*
* 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);
* 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;
* 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);
*
* 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);
*
* 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);
* @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;
* 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);
* 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);
* 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;
* @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);
* 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);
* 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);
*
* @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,
* 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);
*
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* 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);
* @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);
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* @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);
* @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);
* (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);
* 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;
* 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;
*
* 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;
*
* @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;
* 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;
*
* @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);
*
* @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);
* 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);
* 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);
* 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);
* 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);
* @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"
* @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;
* @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;
*
* @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;
*
* @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;
*
* 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);
*
* 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);
*
* @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);
* 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);
*
* @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);
* @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);
* @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);
*
* 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);
* 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);
* @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);
* 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);
* 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);
* 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);
* @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);
* 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);
* 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);
* @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);
* 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);
* not</b> 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;
* 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);
*
* 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);
* @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;
*
* 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);
* 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);
* @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);
* @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);
* @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);
* @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);
* 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;
* 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;
* 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);
* 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;
* 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);
* 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);
*
* @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);
*
* @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;
*
* 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);
* 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;
* @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;
* @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,
* @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);
* @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);
* @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);
* @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);
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
* 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);
* @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);
* 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);
* @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);
* @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);
/**
*
* 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);
/**
* @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);
* @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);
* @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);
* 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);
* @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);
* @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);
/**
*
* @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);
/**
* @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);
/**
*
* @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);
* @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);
* 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);
* 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);
* 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);
* 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);
* @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;
* @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);
* @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);
* @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);
* @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);
/**
* @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;
* @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;
* 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);
*
* @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;
* @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;
* @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);
* @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);
* @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;
* @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;
* @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;
* @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;
* @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;
*
* @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;
*
* 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);
*
* 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);
*
* @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);
* 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);
*
* @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);
* @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);
*
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
* 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);
* 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;
* 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);
*
* 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);
* @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;
* 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;
* 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;
* 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);
*
* @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);
*
* @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;
*
* 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);
* 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);
* 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);
* 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;
* 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;
* 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;
* 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;
* @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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* 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;
* @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;
* @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);
* 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);
* @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);
*
* @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);
* 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);
* @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);
* @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);
* 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;
*
* 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;
*
* 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;
* @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);
* @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;
* 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;
* @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);
* @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);
* 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;
* 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;
* 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;
* 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;
* @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);
* @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);
* 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;
* 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;
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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);
* 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);
* @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);
* 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);
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
*
* 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,
*
* 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,
* @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,
* @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,
* 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,
* 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,
* 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,
* 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,
* 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,
* @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,
*
* 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,
*
* 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,
*
* 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,
*
* 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,
* @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,
* @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,
* @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,
* @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,
/**
* @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);
* @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);
*
* @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);
*
* 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);
*
* 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);
* @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);
*
* 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,
* 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,
* @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);
* @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,
* @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,
* @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,
* @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,
* @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,
* 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,
*
* 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,
* @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,
* @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,
* @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,
* @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,
* @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,
* @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,
* 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);
*
* 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);
* @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);
* 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);
* @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);
* 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);
* 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);
* @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);
* @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);
*
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
/**
* @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);
* @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);
*
* @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);
/**
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
/**
* @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);
* @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);
* @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);
* @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);
/**
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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);
* 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);
*
* @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;
*
* @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;
*
* @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;
*
* @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;
*
* @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;
*
* @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;
* @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;
* @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;
* @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;
* @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;
* @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);
*
* @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;
*
* @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;
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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;
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
*
* @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;
*
* @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);
* @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);
* @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);
* @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;
*
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
*
* @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;
*
* @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;
*
* @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;
* @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);
* @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);
* @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;
* @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);
* @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);
*
* @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);
* @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);
*
* @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;
*
* @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;
*
* @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;
*
* @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;
* @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);
* @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);
* @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;
*
* @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);
* 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);
*
* @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;
*
* @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;
* @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);
* @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);
*
* @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);
* @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);
* @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);
* @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;
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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;
* @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);
*
* @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;
* 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);
* 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);
* @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;
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
*
* @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;
*
* @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);
/**
+ * @internal
+ *
* Initialises the Embryo library.
* @return The number of times the library has been initialised without being
* shut down.
EAPI int embryo_init(void);
/**
+ * @internal
+ *
* Shuts down the Embryo library.
* @return The number of times the library has been initialised without being
* shutdown.
*/
/**
+ * @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.
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.
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.
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
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Func_Group Function Functions
* @ingroup Embryo
*
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Program_VM_Group Virtual Machine Functions
* @ingroup Embryo
*
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.
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Swap_Group Byte Swapping Functions
* @ingroup Embryo
*
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.
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Public_Variable_Group Public Variable Access Functions
* @ingroup Embryo
*
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.
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Error_Group Error Functions
* @ingroup Embryo
*
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Program_Data_Group Program Data Functions
* @ingroup Embryo
*
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
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
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Data_String_Group Embryo Data String Functions
* @ingroup Embryo
*
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.
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.
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Heap_Group Heap Functions
* @ingroup Embryo
*
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Run_Group Program Run Functions
* @ingroup Embryo
*
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.
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.
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.
*
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.
/**
* @internal
+ *
+ * @internal
* @defgroup Embryo_Parameter_Group Function Parameter Functions
* @ingroup Embryo
*
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.
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.
*/
/**
+ * @internal
+ *
* @brief Initialise Emotion library
*
* Initialise needed libraries like eina ecore eet
EAPI Eina_Bool emotion_init(void);
/**
+ * @internal
+ *
* @brief Shutdown Emotion library
*
* Proper shutdown of all loaded modules and initialised libraries.
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.
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.
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.
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.
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.
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.
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
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.
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.
* @{
*/
/**
+ * @internal
+ *
*
* @brief Set play/pause state of the media file.
*
*/
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.
*/
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.
*/
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.
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.
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
*/
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.
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.
*/
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.
*/
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.
*/
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
*/
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
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.
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.
*
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.
*
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
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
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
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
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
}
}
@property engine {
- set {
+ set @internal {
[[Initializes an emotion object with the specified module.
This function is required after creating the emotion object,
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.
*/
/**
+ * @internal
+ *
* @var EO_DBG_INFO_TYPE
* The Eina_Value_Type for the debug info.
*/
} while (0)
/**
+ * @internal
+ *
* Frees the Eo_Dbg_Info tree. (The whole tree recursively).
* @param[in] info The tree to delete.
*/
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.
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.
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.
*/
/**
+ * @internal
+ *
* @brief Init the eo subsystem
* @return @c EINA_TRUE on success.
*
EAPI Eina_Bool eo_init(void);
/**
+ * @internal
+ *
* @brief Shutdown the eo subsystem
* @return @c EINA_TRUE on success.
*
/*****************************************************************************/
/**
+ * @internal
+ *
* @brief Gets the class of the object.
* @param obj The object to work on
* @return The object's class.
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.
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.
#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.
#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
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.
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.
*
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.
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.
*
#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.
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.
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).
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
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
*/
/**
+ * @internal
+ *
* Don't use.
* The values of the returned event structure are also internal, don't assume
* anything about them.
*/
/**
+ * @internal
+ *
* Get the path for the cserve binary to execute
*
* There is little need for anyone except a desktop environment to call this.
* 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);
* "example".
*
* @ingroup Evas_Main_Group
+ *
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
* 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;
* 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);
* 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);
* }
* 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);
* 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;
* 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);
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* "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);
* @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);
* 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);
* @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);
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* 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);
* @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);
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* 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);
*
* @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);
* 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);
*
* @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;
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
/**
* 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);
* @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);
/**
* 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);
* @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);
* @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);
* @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);
* 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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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;
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* 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);
* @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;
*
* @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);
*
* 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);
* 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);
* @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);
* @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);
* 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);
* @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);
* @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);
*
* @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;
/**
*
* @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);
*
* 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;
};
/**
+ * @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
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.
*
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.
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.
EAPI void evas_cserve_image_cache_contents_clean(Evas_Cserve_Image_Cache *cache);
/**
+ * @internal
+ *
* Retrieves the current configuration of the Evas image caching
* server.
*
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
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
* 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);
* 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);
* 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);
* 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);
* @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);
* 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);
* 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);
* @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);
* @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);
* @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);
* @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);
* @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);
* 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);
* @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);
* @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);
* @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;
*
* @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);
*
* @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;
* @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);
* 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);
*
* @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);
*
* 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);
*
* @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);
* 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);
* 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);
* 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);
* 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);
* 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);
* 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);
* 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);
/**
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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);
* 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);
*
* @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);
* @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);
* 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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* 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);
*
* @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);
*
* @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);
* @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;
* @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;
*
*
* @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);
* @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);
*
*
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
*
* 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);
*
* 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);
*
* @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);
*
* 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);
*
* 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);
* 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);
* 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);
*
* 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);
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* @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;
*
* @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;
* @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);
* @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);
* 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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
* @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);
* @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);
*
*
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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);
* 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);
*
* @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);
* @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);
* @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);
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
*
*
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
*
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
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);
* @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);
* @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);
* @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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
* @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);
*
* @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);
* 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);
* @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);
* @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);
* 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;
* @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;
* @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);
*
* 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);
* 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);
*
* 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);
*
* @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);
* @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);
* @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);
* @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);
* @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);
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);
* @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);
*
* @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);
*
* @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);
* @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);
*
* 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);
* 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);
*
* @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);
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);
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);
*
* @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);
*
* @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);
*
* @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;
/*
*
* @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;
/*
*
* 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"
* @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;
* @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);
*
* @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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* 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);
*
* @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);
* 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;
* @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;
* @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;
*
* @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);
* 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);
* @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);
*
* @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);
*
* @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);
*
* @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);
* 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;
* 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;
* #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;
* @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);
*
* @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);
*
* @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);
* @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);
* @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);
*
* @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);
* can have introspection on its events API <b>at run time</b>.
*
* @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);
*
* @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);
*
* @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);
*
* @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);
* 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);
* set to evas_object_box_layout_horizontal(). The remaining
* properties of the box must be set/retrieved via
* <c>evas_object_box_{h,v}_{align,padding}_{get,set)()</c>.
+ *
+ * @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;
* 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);
* 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);
* 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);
* 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);
* 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;
* @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;
* 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);
* 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;
* @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);
*
* @since 1.8
*
+ * @if MOBILE @since_tizen 3.0
+ * @elseif WEARABLE @since_tizen 3.0
+ * @endif
*/
EAPI void evas_output_del(Evas_Out *evo);
[[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
]]
}
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
]]
}
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.]]
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.]]
}
@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 *;
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.]]
}
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 *;
}
@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 *;
}
@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 *;
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.]]
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.]]
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.]]
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 *;
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 *;
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 *;
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 *;
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]]
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 {
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<Evas.Object *> *), eina_iterator_free)
@warn_unused; [[An iterator on $o's child objects, on success, or $null, on errors.]]
}
[[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.]]
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.]]
(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 {
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.]]
[[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<Evas.Object *> *), eina_accessor_free)
@warn_unused; [[An accessor on $o's child objects, on success, or $null,
on errors.]]
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 {
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.]]
(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,
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 *;
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 *;
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.]]
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 {
$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 *;
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 *;
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 *;
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
]]
}
[[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
]]
}
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 {
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:
[[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 {
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
]]
}
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
]]
}
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 {
}
@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.]]
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 {
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 {
}
@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.]]
[[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; [[
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.]]
}
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 {
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:
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.]]
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
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:
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;
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;
}
@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
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:
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:
$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;
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
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
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:
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<Evas.Object *> * @warn_unused;
params {
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.]]
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.]]
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.]]
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
\@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; [[
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.]]
[[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.]]
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.]]
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.]]
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.]]
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<Evas.Object *> * @warn_unused; [[
The list of Evas objects that are over the given position in $e.
@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.
]]
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.
]]
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.
]]
}
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.
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 {
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 {
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:
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 {
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.]]
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 {
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 {
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 {
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.]]
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.]]
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.]]
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.]]
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<const(char) *> * @warn_unused; [[
A newly allocated list of strings. Do not change the
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,
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.]]
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:
}
}
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 {
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:
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.]]
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.]]
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<const(char) *>)* @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
]]
}
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:
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.
[[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 {
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:
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.]]
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:
}
}
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.
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.
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 {
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.]]
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
}
}
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 {
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.]]
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 {
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.]]
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:
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.]]
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 {
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:
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 {
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 {
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 {
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.]]
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.]]
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<Evas.Object *> *), eina_list_free) @warn_unused;
}
}
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<Evas.Object *> *), 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.]]
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<Evas.Object *> *), eina_iterator_free)
@warn_unused;
}
\@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;
}
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 {
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.]]
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 {
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 {
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 {
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
]]
}
[[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
]]
}
"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.]]
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 {
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 {
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 {
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 {
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 {
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 {
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 {
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 {
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
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 {
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 {
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 {
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 {
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 {
}
@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;
[[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
]]
}
[[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
]]
}
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 {
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
]]
}
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 {
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 {
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 {
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 {
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
]]
}
[[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 {
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 {
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 {
@.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
]]
}
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.]]
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
@.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.]]
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).]]
}
@.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.]]
@.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.]]
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
]]
}
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
]]
}
[[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
]]
}
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.]]
@.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;
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.]]
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 {
[[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 {
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:
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 {
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 {
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 {
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:
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:
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 {
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.]]
}
@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 {
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
]]
}
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
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
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 {
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:
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:
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:
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 {
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
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:
*/
}
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
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:
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 {
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:
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:
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,
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
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:
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:
}
@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;
\@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 {
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 {
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.
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 {
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:
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 {
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 {
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 {
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 {
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:
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 {
}
@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.]]
}
}
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;
}
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:
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.]]
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 {
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 {
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.]]
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;
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.
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 {
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
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.
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 {
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).]]
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.]]
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
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
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.]]
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<Evas.Object*> * @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.]]
}
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 {
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
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<Evas.Object *> *), eina_iterator_free)
@warn_unused; [[Returns the iterator of the member objects of $obj.]]
}
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
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 {
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 {
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
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;
}
}
@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 {
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 {
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;
@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;
@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;
@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]]
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;
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<Evas.Object *> *), eina_list_free) @warn_unused;
}
}
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;
}
}
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.]]
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<Evas.Object *> *), 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<Evas.Object *> *), 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.]]
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 {
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 {
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.]]
@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]]
@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 ",|".]]
- @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.]]
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.]]
@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.]]
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.]]
@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).]]
@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;
}
@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 {
@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;
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 {
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.]]
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
]]
}
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
]]
}
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
]]
}
}
@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.]]
[[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
]]
}
[[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
]]
}
}
@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.]]
}
@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 {
"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 {
}
@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 {
}
@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 *;
}
}
"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 {
}
}
@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;
}
}
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.]]
[[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.]]
}
See also @.style.get.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.2
]]
}
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.]]
}
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 *;
See also @.style.set.
+ \@if MOBILE \@since_tizen 2.3
+ \@elseif WEARABLE \@since_tizen 2.3.1
+ \@endif
+
@since 1.2
]]
params {
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 {
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 {
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
]]
}
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]]
$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.
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.]]
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.]]
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:
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.]]
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.]]
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.]]
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.]]
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.]]