/*
- * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2011-2017 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
- * limitations under the License.
+ * limitations under the License.
*/
-
#ifndef __TIZEN_UI_EFL_UTIL_H__
#define __TIZEN_UI_EFL_UTIL_H__
#include <tizen.h>
#include <Evas.h>
+#include <tbm_surface.h>
#ifdef __cplusplus
extern "C" {
#endif
+#ifdef __GNUC__
+# if __GNUC__ >= 4
+# ifndef API
+# define API __attribute__ ((visibility("default")))
+# endif
+# endif
+#endif
+
/**
* @file efl_util.h
*/
/**
- * @addtogroup CAPI_EFL_UTIL_MODULE
+ * @addtogroup CAPI_EFL_UTIL_WIN_PROPERTY_MODULE
* @{
*/
-// Duplicated from utilX.h, should be moved to somewhere common in the future
+/**
+ * @brief Enumeration for EFL UTIL ERROR.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ */
+typedef enum
+{
+ EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
+ EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
+ EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
+ EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
+ EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01, /**< Window type not supported */
+ EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL = TIZEN_ERROR_EFL_UTIL | 0x02, /**< @platform Screenshot initialization fail (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03, /**< @platform Screenshot execution fail (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE = TIZEN_ERROR_EFL_UTIL | 0x04 /**< Resource is not available (@b Since: 4.0) */
+} efl_util_error_e;
-#ifndef KEY_VOLUMEUP
-#define KEY_VOLUMEUP "XF86AudioRaiseVolume" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Volume Up' key */
-#endif
+/**
+ * @brief Enumeration of notification window's priority level.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ */
+typedef enum
+{
+ EFL_UTIL_NOTIFICATION_LEVEL_NONE = -1, /**< No (reset) notification level. This value makes the window place in normal layer. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM = 20, /**< Higher notification level than default. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_NOTIFICATION_LEVEL_HIGH = 30, /**< Higher notification level than medium. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+ EFL_UTIL_NOTIFICATION_LEVEL_TOP = 40 /**< The highest notification level. (@b Since: @if WEARABLE 3.0 @else 2.4 @endif) */
+} efl_util_notification_level_e;
-#ifndef KEY_VOLUMEDOWN
-#define KEY_VOLUMEDOWN "XF86AudioLowerVolume" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Volume Down' key */
-#endif
+/**
+ * @brief Enumeration of screen mode.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ */
+typedef enum
+{
+ EFL_UTIL_SCREEN_MODE_DEFAULT, /**< The mode which turns the screen off after a timeout. */
+ EFL_UTIL_SCREEN_MODE_ALWAYS_ON, /**< The mode which keeps the screen turned on. */
+} efl_util_screen_mode_e;
-#ifndef KEY_CAMERA
-#define KEY_CAMERA "XF86WebCam" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Half-Press of Camera' key */
-#endif
+/**
+ * @brief Sets the priority level for the specified notification window.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/window.priority.set
+ * @remarks This API can be used for a notification type window only.
+ * Up to the version @if WEARABLE 2.3.1 @else 2.4 @endif, it supports as async APIs.
+ * But it is synchronous call since Tizen 3.0
+ * @param[in] window The EFL window
+ * @param[in] level The notification window level
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ */
+API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_notification_level_e level);
-#ifndef KEY_CONFIG
-#define KEY_CONFIG "XF86Pictures" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Full-Press of Camera' key */
-#endif
+/**
+ * @brief Gets the priority level for the specified notification window.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @remarks This API can be used for a notification type window only.
+ * Up to the version @if WEARABLE 2.3.1 @else 2.4 @endif, it supports as async APIs.
+ * But it is synchronous call since Tizen 3.0
+ * @param[in] window The EFL window
+ * @param[out] level The notification window level
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
+ */
+API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_notification_level_e *level);
-#ifndef KEY_POWER
-#define KEY_POWER "XF86PowerOff" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Power' key */
-#endif
+/**
+ * @brief Sets the alpha window's visual state to opaque state.
+ * @details This API sets the alpha window's visual state to opaque state.
+ * If the alpha window sets the visual state to the opaque,
+ * then the window manager could handle it as the opaque window while calculating visibility.
+ * This API will have no effect when used by a non-alpha window.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @param[in] window The EFL window
+ * @param[in] opaque The value that indicates whether the window has set a visual state to opaque (0: unset, 1: set)
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ */
+API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
-#ifndef KEY_PAUSE
-#define KEY_PAUSE "XF86Standby" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Pause' key */
-#endif
+/**
+ * @brief Sets the window's screen mode.
+ * @details This API is useful when the application need to keep the display turned on.
+ * If the application set the mode to #EFL_UTIL_SCREEN_MODE_ALWAYS_ON to its window and the window is shown wholly or partially,
+ * the window manager requests the display system to keep the display on as long as the window is shown.
+ * If the window is no longer shown, then the window manger request the display system to go back to normal operation.
+ * Default screen mode of window is #EFL_UTIL_SCREEN_MODE_DEFAULT.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/display
+ * @remarks This API needs the privilege.
+ * If the application which is not get the privilege use this API, the window manager generates the permission deny error.
+ * @param[in] window The EFL window
+ * @param[in] mode The screen mode
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ */
+API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
-#ifndef KEY_CANCEL
-#define KEY_CANCEL "Cancel" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Cancel' key */
-#endif
+/**
+ * @brief Gets the screen mode of the specified window.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @param[in] window The EFL window
+ * @param[out] mode The screen mode
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ */
+API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
-// Earjack/BT Headset/Multimedia keys
-#ifndef KEY_PLAYCD
-#define KEY_PLAYCD "XF86AudioPlay" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Play Audio' key */
-#endif
+/**
+ * @brief Sets the user's preferred brightness of the specified window.
+ * @details This API is useful when the application need to change the brightness of the screen when it is appeared on the screen.
+ * If the application sets the brightness 0 to 100 to its window and the application window is shown wholly or partially,
+ * the window manager requests the display system to change the brightness of the screen using user's preferred brightness.
+ * If the window is no longer shown, then the window manger request the display system to go back to default brightness.
+ * If the brightness is less than 0, this means to use the default screen brightness.
+ * @since_tizen 3.0
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/display
+ * @remarks This API needs the privilege.
+ * If the application which is not get the privilege use this API, the window manager generates the permission deny error.
+ * @param[in] window The EFL window
+ * @param[in] brightness The preferred brightness
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
+ * @see efl_util_get_window_brightness()
+ */
+API int efl_util_set_window_brightness(Evas_Object *window, int brightness);
-#ifndef KEY_STOPCD
-#define KEY_STOPCD "XF86AudioStop" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Stop Audio' key */
-#endif
+/**
+ * @brief Gets the user's preferred brightness of the specified window.
+ * @since_tizen 3.0
+ * @param[in] window The EFL window
+ * @param[out] brightness The preferred brightness
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @see efl_util_set_window_brightness()
+ */
+API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
-#ifndef KEY_PAUSECD
-#define KEY_PAUSECD "XF86AudioPause" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Pause Audio' key */
-#endif
-#ifndef KEY_NEXTSONG
-#define KEY_NEXTSONG "XF86AudioNext" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Next Song' key */
-#endif
+/**
+ * @}
+ */
-#ifndef KEY_PREVIOUSSONG
-#define KEY_PREVIOUSSONG "XF86AudioPrev" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Previous Song' key */
-#endif
+/**
+ * @addtogroup CAPI_EFL_UTIL_INPUT_MODULE
+ * @{
+ */
-#ifndef KEY_REWIND
-#define KEY_REWIND "XF86AudioRewind" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Rewind Song' key */
-#endif
+ /**
+ * @platform
+ * @brief Definition for the input generator handle.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ */
-#ifndef KEY_FASTFORWARD
-#define KEY_FASTFORWARD "XF86AudioForward" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Forward Song' key */
-#endif
+ typedef struct _efl_util_inputgen_h * efl_util_inputgen_h;
-#ifndef KEY_MEDIA
-#define KEY_MEDIA "XF86AudioMedia" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Media' key */
-#endif
+/**
+ * @platform
+ * @brief Enumeration of device type generated events.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ */
+typedef enum
+{
+ EFL_UTIL_INPUT_DEVTYPE_NONE = 0x0, /**< (Deprecated since 3.0.) */
+ EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN = (1 << 0), /**< Touch Screen device */
+ EFL_UTIL_INPUT_DEVTYPE_KEYBOARD = (1 << 1), /**< Keyboard device */
+ EFL_UTIL_INPUT_DEVTYPE_POINTER = (1 << 2), /**< Mouse device (Since 3.0) */
+ EFL_UTIL_INPUT_DEVTYPE_ALL = EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN |
+ EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, /**< Both of touch screen and keyboard device (Deprecated since 3.0. Check all enumerations using OR operand instead) */
+ EFL_UTIL_INPUT_DEVTYPE_MAX = (1 << 10) /**< (Deprecated since 3.0.) */
+} efl_util_input_device_type_e;
-// 3-Touch key
-#ifndef KEY_SEND
-#define KEY_SEND "XF86Send" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Send' key */
-#endif
+/**
+ * @platform
+ * @brief Enumeration of touch event types.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ */
+typedef enum
+{
+ EFL_UTIL_INPUT_TOUCH_NONE, /**< (Deprecated since 3.0.) */
+ EFL_UTIL_INPUT_TOUCH_BEGIN, /**< Finger press. It is same a behavior put your finger on touch screen */
+ EFL_UTIL_INPUT_TOUCH_UPDATE, /**< Finger move. It is same a behavior move your finger on touch screen */
+ EFL_UTIL_INPUT_TOUCH_END, /**< Finger release. It is same a behavior release your finger on touch screen */
+ EFL_UTIL_INPUT_TOUCH_MAX = 10 /**< (Deprecated since 3.0.) */
+} efl_util_input_touch_type_e;
-#ifndef KEY_SELECT
-#define KEY_SELECT "XF86Phone" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Home' key */
-#endif
+/**
+ * @platform
+ * @brief Enumeration of pointer event types.
+ * @since_tizen 3.0
+ */
+typedef enum
+{
+ EFL_UTIL_INPUT_POINTER_BUTTON_DOWN, /**< Mouse button press. */
+ EFL_UTIL_INPUT_POINTER_BUTTON_UP, /**< Mouse move. */
+ EFL_UTIL_INPUT_POINTER_MOVE, /**< Mouse button release. */
+} efl_util_input_pointer_type_e;
-#ifndef KEY_END
-#define KEY_END "XF86Stop" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'End' key */
-#endif
+/**
+ * @platform
+ * @brief Enumeration of pointer wheel event types.
+ * @since_tizen 5.5
+ */
+typedef enum
+{
+ EFL_UTIL_INPUT_POINTER_WHEEL_VERT, /**< Vertical wheel. */
+ EFL_UTIL_INPUT_POINTER_WHEEL_HORZ, /**< Horizontal wheel. */
+} efl_util_input_pointer_wheel_type_e;
-// Renamed 3-Touch key
-#ifndef KEY_MENU
-#define KEY_MENU "XF86Send" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Send' key */
-#endif
+/**
+ * @platform
+ * @brief Initializes system and check input generate functions are supported, open devices generated events.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
+ * @remarks The dev_type is changed into the unsigned int to perform bitwise operations. (Since 3.0)
+ * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
+ * @return #efl_util_inputgen_h on success, otherwise @c NULL
+ * @retval #efl_util_inputgen_h The input generator handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator
+ * @see efl_util_input_deinitialize_generator()
+ */
+API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_type);
-#ifndef KEY_HOME
-#define KEY_HOME "XF86Phone" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'Home' key */
-#endif
+/**
+ * @platform
+ * @brief Initializes system, check input generate functions are supported and then open events generator devices with given name.
+ * @since_tizen 4.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
+ * @remarks The dev_type is changed into the unsigned int to perform bitwise operations.
+ * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
+ * @param[in] name The device name (maximum 31 characters)
+ * @return #efl_util_inputgen_h on success, otherwise @c NULL
+ * @retval #efl_util_inputgen_h The input generator handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator
+ * @see efl_util_input_deinitialize_generator()
+ */
+API efl_util_inputgen_h efl_util_input_initialize_generator_with_name(unsigned int dev_type, const char *name);
-#ifndef KEY_BACK
-#define KEY_BACK "XF86Stop" /**< this macro means the XKeySym (XServer Key Symbol) corresponds to 'End' key */
-#endif
+/**
+ * @platform
+ * @brief Initializes the system, checks if input generated functions are supported and then open events generator devices synchronously.
+ * @since_tizen 5.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
+ * @remarks @a dev_type is changed into the unsigned int to perform bitwise operations.
+ * @remarks If the @a name is NULL, it will be set to "Input Generator"
+ * @remarks The returned object should be released with efl_util_input_deinitialize_generator().
+ * @param[in] dev_type The device type to generate events, values of #efl_util_input_device_type_e combined with bitwise 'or'\n
+ * Example: #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD
+ * @param[in] name The device name (maximum 31 characters, can be NULL)
+ * @return #efl_util_inputgen_h on success, otherwise @c NULL
+ * @retval #efl_util_inputgen_h The input generator handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to initialize input generator
+ * @see efl_util_input_deinitialize_generator()
+ */
+API efl_util_inputgen_h efl_util_input_initialize_generator_with_sync(unsigned int dev_type, const char *name);
-#ifndef OR_EXCLUSIVE_GRAB
-#define OR_EXCLUSIVE_GRAB 0xf00000 /**< this means that the client window will always get the grabbed-key exclusively regardless of the position on the window stack but the grab is overridable by the other client window */
-#endif
+/**
+ * @platform
+ * @brief Requests to set the maximum touch count.
+ * @since_tizen 6.5
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @remarks If you would like to generate more touch count supported than the display server supports,
+ you can use this API to increase the maximum touch count.
+ Note that this API returns success only when there is no configuration enabled
+ about maximum touch count in the display server.
+ * @param[in] max_count The maximum number of touches want to generate.
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to deinitialize input generator
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API int efl_util_input_set_touch_count(int max_count);
-#ifndef EXCLUSIVE_GRAB
-#define EXCLUSIVE_GRAB 0x0f0000 /**< this means that the client window will always get the grabbed-key exclusively regardless of the position on the window stack */
-#endif
+/**
+ * @platform
+ * @brief Deinitializes system and close opened devices.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to deinitialize input generator
+ * @see efl_util_input_initialize_generator()
+ */
+API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h);
-#ifndef TOP_POSITION_GRAB
-#define TOP_POSITION_GRAB 0x00f000 /**< this means that the client window will get the grabbed-key only when on the top of the grabbing-window stack */
-#endif
+/**
+ * @platform
+ * @brief Generates all of key events using a opened device.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @param[in] key_name The key name want to generate
+ * @param[in] pressed The value that select key press or release (0: release, 1: press)
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate key
+ */
+API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *key_name, int pressed);
-#ifndef SHARED_GRAB
-#define SHARED_GRAB 0x000f00 /**< this means that the client window will get the grabbed-key together with the other client window(s) */
-#endif
+/**
+ * @platform
+ * @brief Generates a touch event using a opened device.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @param[in] idx The index of touched finger
+ * @param[in] touch_type The touch type (ex> #EFL_UTIL_INPUT_TOUCH_BEGIN, #EFL_UTIL_INPUT_TOUCH_UPDATE, #EFL_UTIL_INPUT_TOUCH_END)
+ * @param[in] x The x axis of touch point
+ * @param[in] y The y axis of touch point
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate touch
+ */
+API int efl_util_input_generate_touch(efl_util_inputgen_h inputgen_h, int idx, efl_util_input_touch_type_e touch_type, int x, int y);
-#ifndef GRAB_MODE_MASK
-#define GRAB_MODE_MASK 0xffff00 /**< this mask will be used for getting the key-grab mode of a client window */
-#endif
+/**
+ * @platform
+ * @brief Generates a pointer event using a opened device.
+ * @since_tizen 3.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @param[in] buttons The number of button
+ * @param[in] pointer_type The pointer type (ex> #EFL_UTIL_INPUT_POINTER_BUTTON_PRESS, #EFL_UTIL_INPUT_POINTER_BUTTON_UP, #EFL_UTIL_INPUT_POINTER_MOVE)
+ * @param[in] x x coordination to move
+ * @param[in] y y coordination to move
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate pointer
+ * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ */
+API int efl_util_input_generate_pointer(efl_util_inputgen_h inputgen_h, int buttons, efl_util_input_pointer_type_e pointer_type, int x, int y);
+
+/**
+ * @platform
+ * @brief Generates a wheel event using an opened device.
+ * @details Commonly wheel events are generated with one of two orientations, vertical and horizontal.
+ * #efl_util_input_pointer_wheel_type_e has enums for orientations.
+ * For each orientation there is a value which represents both size and direction.
+ * For #EFL_UTIL_INPUT_POINTER_WHEEL_VERT, if the value is positive, the direction is "up", if it's negative, the direction is "down"
+ * For #EFL_UTIL_INPUT_POINTER_WHEEL_HORZ, if the value is positive, the direction is "right", if it's negative, the direction is "left"
+ * General mouse devices generate wheel events with value 1 or -1,
+ * but some mouse devices have a smooth wheel which generates wheel events with value bigger than absolute 1.
+ * @since_tizen 5.5
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @param[in] wheel_type The wheel type (ex> #EFL_UTIL_INPUT_POINTER_WHEEL_VERT, #EFL_UTIL_INPUT_POINTER_WHEEL_HORZ)
+ * @param[in] value The wheel value
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a wheel event
+ * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported
+ */
+API int efl_util_input_generate_wheel(efl_util_inputgen_h inputgen_h, efl_util_input_pointer_wheel_type_e wheel_type, int value);
+
+/**
+ * @platform
+ * @brief Generates a touch event using an opened device.
+ * @details Normally touch events are represented by a specific point (x, y).
+ * But there are many contact points between touchscreen and fingers.
+ * The coordinates (x, y) are the center of the contact area, and the area where the finger and the touchscreen come into contact is represented with an ellipse.
+ * To give information about the size of the touching cllipse, use @a radius_x and @a radius_y.
+ * The value of @a idx is touch index used in multi-touch. 0 means first touch, 1 means second touch and the index increases further.
+ * General devices support 10 touch indices(0 ~ 9), but this may differ depending on the device.
+ * Some devices may not support the @a palm value, and this value is closely dependent on device.
+ * The value of @a x, @a y, @a radius_x, @a radius_y, @a pressure and @a palm must be greater than 0.
+ * The @a angle is the angle between the vertical edge of the device and the y-axis of the ellipse. If the @a angle is 0, then the ellipse's y-axis is parallel to the device's vertical edge.
+ * @since_tizen 5.5
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/inputgenerator
+ * @param[in] inputgen_h The #efl_util_inputgen_h handle
+ * @param[in] idx The index of the touching finger, used in multi-touch
+ * @param[in] touch_type The touch type (ex> #EFL_UTIL_INPUT_TOUCH_BEGIN, #EFL_UTIL_INPUT_TOUCH_UPDATE, #EFL_UTIL_INPUT_TOUCH_END)
+ * @param[in] x The x coordinate of the touch point
+ * @param[in] y The y coordinate of the touch point
+ * @param[in] radius_x The x-axis radius of the touching ellipse before rotation
+ * @param[in] radius_y The y-axis radius of the touching ellipse before rotation
+ * @param[in] pressure The pressure on the contact touch area
+ * @param[in] angle The rotation angle of the touching ellipse, in degrees
+ * @param[in] palm The palm area of the contact touch area
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission to generate a touch event
+ * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported
+ */
+API int efl_util_input_generate_touch_axis(efl_util_inputgen_h inputgen_h, int idx, efl_util_input_touch_type_e touch_type, int x, int y, double radius_x, double radius_y, double pressure, double angle, double palm);
+
+/**
+ * @}
+ */
-typedef enum _Efl_Util_Window_Type
+/**
+ * @addtogroup CAPI_EFL_UTIL_SCREENSHOT_MODULE
+ * @{
+ */
+
+/**
+ * @platform
+ * @brief Definition for the screenshot handle.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ */
+typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
+
+/**
+ * @platform
+ * @brief Initializes the screenshot.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/screenshot
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * method. Error codes are described in Exception section.
+ * @param[in] width width of the screenshot surface
+ * @param[in] height height of the screenshot surface
+ * @return #efl_util_screenshot_h on success, otherwise @c NULL
+ * @retval #efl_util_screenshot_h The screenshot handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure
+ * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot
+ * @see efl_util_screenshot_deinitialize()
+ */
+API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
+
+/**
+ * @platform
+ * @brief Takes a screenshot and get a tbm_surface handle.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/screenshot
+ * @remarks The specific error code can be obtained using the get_last_result()
+ * The #tbm_surface_h must be free by caller
+ * @param[in] screenshot #efl_util_screenshot_h handle
+ * @return #tbm_surface_h on success, otherwise @c NULL
+ * @retval #tbm_surface_h The TBM surface handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure
+ * @exception #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot
+ * @see efl_util_screenshot_initialize()
+ * @see efl_util_screenshot_deinitialize()
+ */
+API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h screenshot);
+
+/**
+ * @platform
+ * @brief Deinitializes the screenshot.
+ * @since_tizen @if WEARABLE 3.0 @else 2.4 @endif
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/screenshot
+ * @param[in] screenshot #efl_util_screenshot_h handle
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED No permission for screenshot
+ * @see efl_util_screenshot_initialize()
+ */
+API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot);
+
+/**
+ * @}
+ */
+
+/**
+ * @addtogroup CAPI_EFL_UTIL_GESTURE_MODULE
+ * @{
+ */
+
+/**
+ * @brief Definition for the gesture handle.
+ * @since_tizen 4.0
+ */
+typedef struct _efl_util_gesture_h * efl_util_gesture_h;
+
+/**
+ * @brief Definition for the edge swipe gesture event.
+ * @since_tizen 4.0
+ */
+API extern int EFL_UTIL_EVENT_GESTURE_EDGE_SWIPE;
+
+/**
+ * @brief Definition for the edge swipe gesture event.
+ * @since_tizen 4.0
+ */
+API extern int EFL_UTIL_EVENT_GESTURE_EDGE_DRAG;
+
+/**
+ * @brief Definition for the tap gesture event.
+ * @since_tizen 4.0
+ */
+API extern int EFL_UTIL_EVENT_GESTURE_TAP;
+
+/**
+ * @brief Definition for the palm cover gesture event.
+ * @since_tizen 4.0
+ */
+API extern int EFL_UTIL_EVENT_GESTURE_PALM_COVER;
+
+/**
+ * @brief Enumeration of gesture type.
+ * @since_tizen 4.0
+ */
+typedef enum _efl_util_gesture_type_e
{
- EFL_UTIL_WINDOW_TYPE_NORMAL = 8, /**< ecore_x compatible, ECORE_X_WINDOW_TYPE_NORMAL */
- EFL_UTIL_WINDOW_TYPE_NOTIFICATION = 12, /**< ecore_x compatible, ECORE_X_WINDOW_TYPE_NOTIFICATION */
-} Efl_Util_Window_Type;
+ EFL_UTIL_GESTURE_TYPE_NONE = 0, /**< None gesture type */
+ EFL_UTIL_GESTURE_TYPE_EDGE_SWIPE = (1 << 0), /**< Edge swipe gesture type */
+ EFL_UTIL_GESTURE_TYPE_EDGE_DRAG = (1 << 1), /**< Edge drag gesture type */
+ EFL_UTIL_GESTURE_TYPE_TAP = (1 << 2), /**< Tap gesture type */
+ EFL_UTIL_GESTURE_TYPE_PALM_COVER = (1 << 3), /**< Palm cover gesture type */
+ EFL_UTIL_GESTURE_TYPE_PAN = (1 << 4), /**< Pan gesture type */
+ EFL_UTIL_GESTURE_TYPE_PINCH = (1 << 5), /**< Pinch gesture type */
+ EFL_UTIL_GESTURE_TYPE_PALM_SWIPE = (1 << 6) /**< Palm swipe gesture type */
+} efl_util_gesture_type_e;
-typedef enum _Efl_Util_Notification_Level
+/**
+ * @brief Enumeration of gesture mode.
+ * @since_tizen 4.0
+ */
+typedef enum _efl_util_gesture_mode_e
{
- EFL_UTIL_NOTIFICATION_LEVEL_LOW, /**< low level notification */
- EFL_UTIL_NOTIFICATION_LEVEL_NORMAL, /**< normal level notification*/
- EFL_UTIL_NOTIFICATION_LEVEL_HIGH, /**< high level notification */
- EFL_UTIL_NOTIFICATION_LEVEL_UNKNOWN
-} Efl_Util_Notification_Level;
+ EFL_UTIL_GESTURE_MODE_NONE = 0, /**< None gesture mode */
+ EFL_UTIL_GESTURE_MODE_BEGIN, /**< Begin a gesture event */
+ EFL_UTIL_GESTURE_MODE_UPDATE, /**< continually update a gesture event */
+ EFL_UTIL_GESTURE_MODE_END, /**< End a gesture event */
+ EFL_UTIL_GESTURE_MODE_DONE /**< Occur a gesture event */
+} efl_util_gesture_mode_e;
/**
- * @brief Enumeration for EFL UTIL ERROR.
- * @since_tizen 2.3
+ * @brief Enumeration of gesture edge.
+ * @since_tizen 4.0
*/
-typedef enum
+typedef enum _efl_util_gesture_edge_e
{
- EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
- EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
- EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
- EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permisson denied */
- EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = -0x02800000 | 0x01 /**< Window type not supported */
- //EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01 /**< Window type not supported */
-} efl_util_error_e;
+ EFL_UTIL_GESTURE_EDGE_NONE = 0, /**< None edge point */
+ EFL_UTIL_GESTURE_EDGE_TOP, /**< Top edge position of screen */
+ EFL_UTIL_GESTURE_EDGE_RIGHT, /**< Right edge position of screen */
+ EFL_UTIL_GESTURE_EDGE_BOTTOM, /**< Bottom edge position of screen */
+ EFL_UTIL_GESTURE_EDGE_LEFT /**< Left edge position of screen */
+} efl_util_gesture_edge_e;
-// TODO: are we going to have more states than on/off shouldn't we move it to a bool in the API's
-typedef enum _Efl_Util_Opaque_State
+/**
+ * @brief Enumeration of gesture edge size.
+ * @since_tizen 4.0
+ */
+typedef enum _efl_util_gesture_edge_size_e
{
- EFL_UTIL_OPAQUE_STATE_OFF = 0, /**< Transparent state */
- EFL_UTIL_OPAQUE_STATE_ON = 1, /**< Opaque state */
-} Efl_Util_Opaque_State;
+ EFL_UTIL_GESTURE_EDGE_SIZE_NONE, /**< None size of edge */
+ EFL_UTIL_GESTURE_EDGE_SIZE_FULL, /**< Full size in the edge */
+ EFL_UTIL_GESTURE_EDGE_SIZE_PARTIAL /**< Part of edge */
+} efl_util_gesture_edge_size_e;
/**
- * @brief Enumeration of notification window's priority level.
- * @since_tizen 2.3
+ * @brief Definition for the gesture data handle.
+ * @since_tizen 4.0
*/
-typedef enum
+typedef void *efl_util_gesture_data;
+
+/**
+ * @brief Definition for the edge swipe gesture's event data structure.
+ * @since_tizen 4.0
+ */
+typedef struct _efl_util_event_gesture_edge_swipe_s
{
- EFL_UTIL_NOTIFICATION_LEVEL_1, /**< Default notification level */
- EFL_UTIL_NOTIFICATION_LEVEL_2, /**< Higher notification level than default */
- EFL_UTIL_NOTIFICATION_LEVEL_3, /**< The highest notification level */
-} efl_util_notification_level_e;
+ efl_util_gesture_mode_e mode; /**< Mode of a gesture event */
+ unsigned int fingers; /**< Number of fingers */
+ int sx; /**< Start x point of edge area */
+ int sy; /**< Start y point of edge area */
+ unsigned int edge; /**< Start edge location */
+} efl_util_event_gesture_edge_swipe_s;
-typedef enum _Efl_Util_Effect_Type
+/**
+ * @brief Definition for the edge drag gesture's event data structure.
+ * @since_tizen 4.0
+ */
+typedef struct efl_util_event_gesture_edge_drag_s
{
- EFL_UTIL_EFFECT_TYPE_MAP, /**< Effect for Window's Map Notify Event */
- EFL_UTIL_EFFECT_TYPE_UNMAP, /**< Effect for Window's UnMap Notify Event */
- EFL_UTIL_EFFECT_TYPE_RAISEABOVE, /**< Effect for Window's Configure Notify ( RaiseAbove case ) Event */
- EFL_UTIL_EFFECT_TYPE_ROTATION, /**< Effect for Window's Rotation Property Change Notify Event ( X Property: ECORE_X_ATOM_E_ILLUME_ROTATE_WINDOW_ANGLE ) */
- EFL_UTIL_EFFECT_TYPE_FOCUSIN, /**< Effect for Window's FocusIn Event ( E17's Event: E_EVENT_BORDER_FOCUS_IN ) */
- EFL_UTIL_EFFECT_TYPE_FOCUSOUT /**< Effect for Window's FocusOut Event ( E17's Event : E_EVENT_BORDER_FOCUS_OUT ) */
-} Efl_Util_Effect_Type;
-
-typedef enum _Efl_Util_Effect_Style
+ efl_util_gesture_mode_e mode; /**< Mode of a gesture event */
+ unsigned int fingers; /**< Number of fingers */
+ int cx; /**< Center x point of edge area */
+ int cy; /**< Center y point of edge area */
+ unsigned int edge; /**< Start edge location */
+} efl_util_event_gesture_edge_drag_s;
+
+/**
+ * @brief Definition for the tap gesture's event data structure.
+ * @since_tizen 4.0
+ */
+typedef struct _efl_util_event_gesture_tap_s
{
- EFL_UTIL_EFFECT_STYLE_DEFAULT, /**< Default Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_NONE, /**< None of Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM0, /**< Custom0 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM1, /**< Custom1 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM2, /**< Custom2 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM3, /**< Custom3 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM4, /**< Custom4 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM5, /**< Custom5 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM6, /**< Custom6 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM7, /**< Custom7 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM8, /**< Custom8 Effect Style for Effect Type */
- EFL_UTIL_EFFECT_STYLE_CUSTOM9 /**< Custom9 Effect Style for Effect Type */
-} Efl_Util_Effect_Style;
-
-/**
- * @brief Sets the priority level for the specified notification window, asynchronously.
- * @since_tizen 2.3
- * @privlevel public
- * @privilege %http://tizen.org/privilege/window.priority.set
- * @remarks This API can be used for a notification type window only.
- * @param[in] window The EFL window
- * @param[in] level The notification window level
- * @return @c 0 on success,
- * otherwise a negative error value
+ efl_util_gesture_mode_e mode; /**< Mode of a gesture event */
+ unsigned int fingers; /**< Number of fingers */
+ unsigned int repeats; /**< Number of tap repeats */
+} efl_util_event_gesture_tap_s;
+
+/**
+ * @brief Definition for the palm cover gesture's event data structure.
+ * @since_tizen 4.0
+ */
+typedef struct _efl_util_event_gesture_palm_cover_s
+{
+ efl_util_gesture_mode_e mode; /**< Mode of a gesture event */
+ unsigned int duration; /**< Duration time of gesture behavior */
+ int cx; /**< Center x point of edge area */
+ int cy; /**< Center y point of edge area */
+ unsigned int size; /**< Size of touched area */
+ double pressure; /**< Pressure of touched finger */
+} efl_util_event_gesture_palm_cover_s;
+
+/**
+ * @brief Initializes system and check if global gestures are supported.
+ * @since_tizen 4.0
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exception section.
+ * @return #efl_util_gesture_h on success, otherwise @c NULL
+ * @retval #efl_util_gesture_h The global gesture handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported
+ * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ * @see efl_util_gesture_deinitialize()
+ */
+API efl_util_gesture_h efl_util_gesture_initialize(void);
+
+/**
+ * @brief Deinitializes system.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @return @c 0 on success, otherwise a negative error value
* @retval #EFL_UTIL_ERROR_NONE Successful
* @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
+ * @see efl_util_gesture_initialize()
*/
-int efl_util_set_notification_window_level (Evas_Object *window, efl_util_notification_level_e level);
+API int efl_util_gesture_deinitialize(efl_util_gesture_h gesture_h);
+/**
+ * @brief Generates a edge swipe gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] fingers The number of fingers
+ * @param[in] edge The position of edge
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exception section.
+ * @return #efl_util_gesture_data on success, otherwise @c NULL
+ * @retval #efl_util_gesture_data The specific gesture data handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API efl_util_gesture_data efl_util_gesture_edge_swipe_new(efl_util_gesture_h gesture_h, unsigned int fingers, efl_util_gesture_edge_e edge);
/**
- * @brief Gets the priority level for the specified notification window, asynchronously.
- * @since_tizen 2.3
- *
- * @remarks This API can be used for a notification type window only.
- * @param[in] window The EFL window
- * @param[out] level The notification window level
- * @return @c 0 on success,
- * otherwise a negative error value
+ * @brief Frees a memory of edge swipe gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle
+ * @return @c 0 on success, otherwise a negative error value
* @retval #EFL_UTIL_ERROR_NONE Successful
* @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
*/
-int efl_util_get_notification_window_level (Evas_Object *window, efl_util_notification_level_e* level);
+API int efl_util_gesture_edge_swipe_free(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
/**
- * @brief Called when an error occurs for setting notification window level
- * @since_tizen 2.3
- * @param[in] window The EFL window
- * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
- * @param[in] user_data The user data passed from the callback registration function
- * @see efl_util_set_notification_window_level_error_cb()
- * @see efl_util_unset_notification_window_level_error_cb()
+ * @brief Sets a specific size of edge for edge swipe gesture.
+ * @since_tizen 4.0
+ * @param[in] data The #efl_util_gesture_data handle
+ * @param[in] edge_size The #efl_util_gesture_edge_size_e enum
+ * @param[in] start_point The start point of edge area
+ * @param[in] end_point The end point of edge area
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data);
+API int efl_util_gesture_edge_swipe_size_set(efl_util_gesture_data data, efl_util_gesture_edge_size_e edge_size, unsigned int start_point, unsigned int end_point);
+/**
+ * @brief Generates a edge drag gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] fingers The number of fingers
+ * @param[in] edge The position of edge
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exception section.
+ * @return #efl_util_gesture_data on success, otherwise @c NULL
+ * @retval #efl_util_gesture_data The specific gesture data handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API efl_util_gesture_data efl_util_gesture_edge_drag_new(efl_util_gesture_h gesture_h, unsigned int fingers, efl_util_gesture_edge_e edge);
/**
- * @brief Registers a callback function to be invoked when an error which set the notification level occurs.
- * @since_tizen 2.3
- * @param[in] window The EFL window
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
- * @return @c 0 on success,
- * otherwise a negative error value
+ * @brief Frees a memory of edge drag gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle
+ * @return @c 0 on success, otherwise a negative error value
* @retval #EFL_UTIL_ERROR_NONE Successful
* @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
- * @post efl_util_notification_window_level_error_cb() will be invoked.
- * @see efl_util_unset_notification_window_level_error_cb()
- * @see efl_util_notification_window_level_error_cb()
*/
-int efl_util_set_notification_window_level_error_cb(Evas_Object *window, efl_util_notification_window_level_error_cb callback, void *user_data);
+API int efl_util_gesture_edge_drag_free(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
+
+/**
+ * @brief Sets a specific size of edge for edge drag gesture.
+ * @since_tizen 4.0
+ * @param[in] data The #efl_util_gesture_data handle
+ * @param[in] edge_size The #efl_util_gesture_edge_size_e enum
+ * @param[in] start_point The start point of edge area
+ * @param[in] end_point The end point of edge area
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API int efl_util_gesture_edge_drag_size_set(efl_util_gesture_data data, efl_util_gesture_edge_size_e edge_size, unsigned int start_point, unsigned int end_point);
+/**
+ * @brief Generates a tap gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] fingers The number of fingers
+ * @param[in] repeats The number of repeats
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exception section.
+ * @return #efl_util_gesture_data on success, otherwise @c NULL
+ * @retval #efl_util_gesture_data The specific gesture data handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API efl_util_gesture_data efl_util_gesture_tap_new(efl_util_gesture_h gesture_h, unsigned int fingers, unsigned int repeats);
/**
- * @brief Unregisters the callback function.
- * @since_tizen 2.3
- * @param[in] window The EFL window
- * @return @c 0 on success,
- * otherwise a negative error value
+ * @brief Frees a memory of tap gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle
+ * @return @c 0 on success, otherwise a negative error value
* @retval #EFL_UTIL_ERROR_NONE Successful
* @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
- * @see efl_util_set_notification_window_level_error_cb()
*/
-int efl_util_unset_notification_window_level_error_cb(Evas_Object *window);
+API int efl_util_gesture_tap_free(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
+/**
+ * @brief Generates a palm cover gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @remarks The specific error code can be obtained using the get_last_result() method.
+ * Error codes are described in Exception section.
+ * @return #efl_util_gesture_data on success, otherwise @c NULL
+ * @retval #efl_util_gesture_data The specific gesture data handle
+ * @exception #EFL_UTIL_ERROR_NONE Successful
+ * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @exception #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
+ */
+API efl_util_gesture_data efl_util_gesture_palm_cover_new(efl_util_gesture_h gesture_h);
-/**
- * @brief Grabs a key specfied by key_name for obj in grab_mode.
- *
- * @param obj The Evas_Object representing the window to set the key grab to.
- * @param key The key of interest.
- * @param grab_mode EXCLUSIVE_GRAB, TOP_POSITION_GRAB, SHARED_GRAB, EXCLUSIVE_GRAB
- *
- * @return 0 on Success, fail othrewise.
- * @see efl_util_ungrab_key()
+/**
+ * @brief Frees a memory of palm cover gesture's grab info handle.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int efl_util_grab_key (Evas_Object *obj, const char* key, int grab_mode);
+API int efl_util_gesture_palm_cover_free(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
-/**
- * @brief Ungrabs a key specfied by key_name for win
- *
- * @param obj The Evas_Object representing the window to ungrab the key.
- * @param key The key of interest.
- *
- * @return 0 on Success, fail otherwise.
- * @see efl_util_grab_key()
+/**
+ * @platform
+ * @brief Grabs a global gesture.
+ * @since_tizen 4.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/gesturegrab
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle.
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-int efl_util_ungrab_key (Evas_Object *obj, const char* key);
+API int efl_util_gesture_grab(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
-/**
- * @brief Sets the priority level for the specified notification window
- *
- * @param obj The Evas_Object representing the window to set the notification level.
- * @param level The notification level.
- *
- * @see Efl_Util_Notification_Level
+/**
+ * @platform
+ * @brief Ungrabs a global gesture.
+ * @since_tizen 4.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/gesturegrab
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] data The #efl_util_gesture_data handle.
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED Not supported
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-void efl_util_set_system_notification_level (Evas_Object *obj, Efl_Util_Notification_Level level);
+API int efl_util_gesture_ungrab(efl_util_gesture_h gesture_h, efl_util_gesture_data data);
-/**
- * @brief Gets the priority level for the specified notification window.
- *
- * @param obj The Evas_Object representing the window to get the system notification level
- * set to.
- *
- * @return current notication level (EFL_UTIL_NOTIFICATION_LEVEL_LOW,
- * EFL_UTIL_NOTIFICATION_LEVEL_NORMAL, EFL_UTIL_NOTIFICATION_LEVEL_HIGH)
+/**
+ * @brief Selects a global gesture on given window.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] window The efl window
+ * @param[in] data The #efl_util_gesture_data handle.
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-Efl_Util_Notification_Level efl_util_get_system_notification_level (Evas_Object *obj);
+API int efl_util_gesture_select(efl_util_gesture_h gesture_h, Evas_Object *window, efl_util_gesture_data data);
-/**
- * @brief Set the functional type of window by sending _NET_WM_WINDOW_TYPE property to window.
- *
- * @param obj The Evas_Object representing the window to set the net_wm to.
- * @param type The type to be set.
+/**
+ * @brief Deselects a global gesture on given window.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] window The efl window
+ * @param[in] data The #efl_util_gesture_data handle
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-void efl_util_netwm_window_type_set(Evas_Object *obj, Efl_Util_Window_Type type);
+API int efl_util_gesture_deselect(efl_util_gesture_h gesture_h, Evas_Object *window, efl_util_gesture_data data);
-/**
- * @brief Sets a window's effect style with effect type.
- *
- * @param win The window to set the style to.
- * @param type type Specifies the window's effect type ( ex. EFL_UTIL_EFFECT_TYPE_MAP, EFL_UTIL_EFFECT_TYPE_UNMAP, etc )
- * @param style Specifies the window's effect style ( ex. EFL_UTIL_EFFECT_STYLE_DEFAULT, EFL_UTIL_EFFECT_STYLE_NONE, EFL_UTIL_EFFECT_STYLE_CUSTOM0, etc )
+/**
+ * @platform
+ * @brief Activates or deactivates a global gesture.
+ * @since_tizen 4.0
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/gestureactivation
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] type The gesture type to activate /deactivate combined by #efl_util_gesture_type_e to bitwise operation
+ * @param[in] active The activated boolean value
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-void efl_util_set_window_effect_style(Evas_Object *win, Efl_Util_Effect_Type type, Efl_Util_Effect_Style style);
+API int efl_util_gesture_activate_set(efl_util_gesture_h gesture_h, unsigned int type, Eina_Bool active);
/**
- * @brief Sets the window's opaque state
- *
- * @param win The window to set the opaque state to.
- * @param state The state (EFL_UTIL_OPAQUE_STATE_ON, EFL_UTIL_OPAQUE_STATE_OFF).
- *
- * @return 0 on failure
+ * @brief Activates or deactivates a global gesture on given window.
+ * @since_tizen 4.0
+ * @param[in] gesture_h The #efl_util_gesture_h handle
+ * @param[in] window The efl window
+ * @param[in] type The gesture type to activate /deactivate combined by #efl_util_gesture_type_e to bitwise operation
+ * @param[in] active The activated boolean value
+ * @return @c 0 on success, otherwise a negative error value
+ * @retval #EFL_UTIL_ERROR_NONE Successful
+ * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
+ * @retval #EFL_UTIL_ERROR_NO_RESOURCE_AVAILABLE Resource is not available
*/
-int efl_util_set_window_opaque_state (Evas_Object *win, Efl_Util_Opaque_State state);
+API int efl_util_gesture_activate_set_on_window(efl_util_gesture_h gesture_h, Evas_Object *window, unsigned int type, Eina_Bool active);
/**
* @}
#ifdef __cplusplus
}
#endif
-#endif /* __TIZEN_UI_EFL_UTIL_H__ */
+#endif /* __TIZEN_UI_EFL_UTIL_H__ */
projects / platform / core / api / efl-util.git / blobdiff