include/efl_util.h.in

   1 /*
   2  * Copyright (c) 2011-2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_UI_EFL_UTIL_H__
  18 #define __TIZEN_UI_EFL_UTIL_H__
  19
  20 #include <tizen.h>
  21 #include <Evas.h>
  22 #include <tbm_surface.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 #ifdef __GNUC__
  29 # if __GNUC__ >= 4
  30 #  ifndef API
  31 #   define API __attribute__ ((visibility("default")))
  32 #  endif
  33 # endif
  34 #endif
  35
  36 /**
  37  * @file efl_util.h
  38  */
  39
  40 /**
  41  * @addtogroup CAPI_EFL_UTIL_MODULE
  42  * @{
  43  */
  44
  45 /**
  46  * @brief Enumeration for EFL UTIL ERROR.
  47  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  48  */
  49 typedef enum
  50 {
  51    EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
  52    EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
  53    EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
  54    EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
  55    EFL_UTIL_ERROR_NO_SUCH_DEVICE = TIZEN_ERROR_NO_SUCH_DEVICE, /**< @platform No such device or address (@b Since: $TZ_CFG_VER_24_OR_30$) */
  56    EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: $TZ_CFG_VER_24_OR_30$) */
  57    EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: $TZ_CFG_VER_24_OR_30$) */
  58    EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01, /**< Window type not supported */
  59    EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL = TIZEN_ERROR_EFL_UTIL | 0x02,  /**< @platform Screenshot initialization fail (@b Since: $TZ_CFG_VER_24_OR_30$) */
  60    EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03  /**< @platform Screenshot execution fail (@b Since: $TZ_CFG_VER_24_OR_30$) */
  61 } efl_util_error_e;
  62
  63 /**
  64  * @brief Enumeration of notification window's priority level.
  65  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  66  */
  67 typedef enum
  68 {
  69    EFL_UTIL_NOTIFICATION_LEVEL_1, /**< Default notification level. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT instead.) */
  70    EFL_UTIL_NOTIFICATION_LEVEL_2, /**< Higher notification level than default. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM instead.) */
  71    EFL_UTIL_NOTIFICATION_LEVEL_3, /**< The highest notification level. (Deprecated since $TZ_CFG_VER_24_OR_30$. Use EFL_UTIL_NOTIFICATION_LEVEL_TOP instead.) */
  72    EFL_UTIL_NOTIFICATION_LEVEL_NONE    = -1, /**< No (reset) notification level. This value makes the window place in normal layer. (@b Since: $TZ_CFG_VER_24_OR_30$) */
  73    EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: $TZ_CFG_VER_24_OR_30$) */
  74    EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM  = 20, /**< Higher notification level than default. (@b Since: $TZ_CFG_VER_24_OR_30$) */
  75    EFL_UTIL_NOTIFICATION_LEVEL_HIGH    = 30, /**< Higher notification level than medium. (@b Since: $TZ_CFG_VER_24_OR_30$) */
  76    EFL_UTIL_NOTIFICATION_LEVEL_TOP     = 40  /**< The highest notification level. (@b Since: $TZ_CFG_VER_24_OR_30$) */
  77 } efl_util_notification_level_e;
  78
  79 /**
  80  * @brief Enumeration of screen mode.
  81  * @since_tizen $TZ_CFG_VER_24_OR_30$
  82  */
  83 typedef enum
  84 {
  85    EFL_UTIL_SCREEN_MODE_DEFAULT, /**< The mode which turns the screen off after a timeout. */
  86    EFL_UTIL_SCREEN_MODE_ALWAYS_ON, /**< The mode which keeps the screen turned on. */
  87 } efl_util_screen_mode_e;
  88
  89 /**
  90  * @brief Sets the priority level for the specified notification window.
  91  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  92  * @privlevel public
  93  * @privilege %http://tizen.org/privilege/window.priority.set
  94  * @remarks This API can be used for a notification type window only.
  95  *          Up to the version $TZ_CFG_VER_24_OR_231$, it supports as async APIs.
  96  *          But it is synchronous call since Tizen 3.0
  97  * @param[in] window The EFL window
  98  * @param[in] level The notification window level
  99  * @return @c 0 on success, otherwise a negative error value
 100  * @retval #EFL_UTIL_ERROR_NONE Successful
 101  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 102  * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
 103  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 104  */
 105 API int efl_util_set_notification_window_level(Evas_Object *window, efl_util_notification_level_e level);
 106
 107 /**
 108  * @brief Gets the priority level for the specified notification window.
 109  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 110  *
 111  * @remarks This API can be used for a notification type window only.
 112  *          Up to the version $TZ_CFG_VER_24_OR_231$, it supports as async APIs.
 113  *          But it is synchronous call since Tizen 3.0
 114  * @param[in] window The EFL window
 115  * @param[out] level The notification window level
 116  * @return @c 0 on success, otherwise a negative error value
 117  * @retval #EFL_UTIL_ERROR_NONE Successful
 118  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 119  * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
 120  */
 121 API int efl_util_get_notification_window_level(Evas_Object *window, efl_util_notification_level_e *level);
 122
 123 /**
 124  * @deprecated Deprecated since 3.0.
 125  * @brief Called when an error occurs for setting notification window level
 126  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 127  * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
 128  * @param[in] window The EFL window
 129  * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
 130  * @param[in] user_data The user data passed from the callback registration function
 131  * @see efl_util_set_notification_window_level_error_cb()
 132  * @see efl_util_unset_notification_window_level_error_cb()
 133  */
 134 typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data);
 135
 136 /**
 137  * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_notification_window_level() instead.
 138  * @brief Registers a callback function to be invoked when an error which set the notification level occurs.
 139  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 140  * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
 141  * @param[in] window The EFL window
 142  * @param[in] callback The callback function to register
 143  * @param[in] user_data The user data to be passed to the callback function
 144  * @return @c 0 on success, otherwise a negative error value
 145  * @retval #EFL_UTIL_ERROR_NONE Successful
 146  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 147  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 148  * @post efl_util_notification_window_level_error_cb() will be invoked.
 149  * @see efl_util_unset_notification_window_level_error_cb()
 150  * @see efl_util_notification_window_level_error_cb()
 151  */
 152 API int efl_util_set_notification_window_level_error_cb(Evas_Object *window, efl_util_notification_window_level_error_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 153
 154 /**
 155  * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_notification_window_level() instead.
 156  * @brief Unregisters the callback function.
 157  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 158  * @remarks An application can check error by the return value of efl_util_set_notification_window_level since 3.0.
 159  * @param[in] window The EFL window
 160  * @return @c 0 on success, otherwise a negative error value
 161  * @retval #EFL_UTIL_ERROR_NONE Successful
 162  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 163  * @see efl_util_set_notification_window_level_error_cb()
 164  */
 165 API int efl_util_unset_notification_window_level_error_cb(Evas_Object *window) TIZEN_DEPRECATED_API;
 166
 167 /**
 168  * @brief Sets the alpha window's visual state to opaque state
 169  * @details This API sets the alpha window's visual state to opaque state.
 170  *          If the alpha window sets the visual state to the opaque,
 171  *          then the window manager could handle it as the opaque window while calculating visibility.
 172  *          This API will have no effect when used by a non-alpha window.
 173  * @since_tizen $TZ_CFG_VER_24_OR_30$
 174  * @param[in] window The EFL window
 175  * @param[in] opaque The value that indicates whether the window has set a visual state to opaque (0: unset, 1: set)
 176  * @return @c 0 on success, otherwise a negative error value
 177  * @retval #EFL_UTIL_ERROR_NONE Successful
 178  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 179  */
 180 API int efl_util_set_window_opaque_state(Evas_Object *window, int opaque);
 181
 182 /**
 183  * @brief Sets the window's screen mode.
 184  * @details This API is useful when the application need to keep the display turned on.
 185  *          If the application set the mode to #EFL_UTIL_SCREEN_MODE_ALWAYS_ON to its window and the window is shown wholly or partially,
 186  *          the window manager requests the display system to keep the display on as long as the window is shown.
 187  *          If the window is no longer shown, then the window manger request the display system to go back to normal operation.
 188  *          Default screen mode of window is #EFL_UTIL_SCREEN_MODE_DEFAULT.
 189  * @since_tizen $TZ_CFG_VER_24_OR_30$
 190  * @privlevel public
 191  * @privilege %http://tizen.org/privilege/display
 192  * @remarks This API needs the privilege.
 193  *          If the application which is not get the privilege use this API, the window manager generates the permission deny error.
 194  * @param[in] window The EFL window
 195  * @param[in] mode The screen mode
 196  * @return @c 0 on success, otherwise a negative error value
 197  * @retval #EFL_UTIL_ERROR_NONE Successful
 198  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 199  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 200  */
 201 API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
 202
 203 /**
 204  * @brief Gets the screen mode of the specified window.
 205  * @since_tizen $TZ_CFG_VER_24_OR_30$
 206  * @param[in] window The EFL window
 207  * @param[out] mode The screen mode
 208  * @return @c 0 on success, otherwise a negative error value
 209  * @retval #EFL_UTIL_ERROR_NONE Successful
 210  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 211  */
 212 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
 213
 214 /**
 215  * @deprecated Deprecated since 3.0.
 216  * @brief Called when an error occurs for setting window's screen mode
 217  * @since_tizen 2.4
 218  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 219  * @param[in] window The EFL window
 220  * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
 221  * @param[in] user_data The user data passed from the callback registration function
 222  * @see efl_util_set_window_screen_mode_error_cb()
 223  * @see efl_util_unset_window_screen_mode_error_cb()
 224  */
 225 typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int error_code, void *user_data);
 226
 227 /**
 228  * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_window_screen_mode() instead.
 229  * @brief Registers a callback function to be invoked when an error which set the screen mode.
 230  * @since_tizen 2.4
 231  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 232  * @param[in] window The EFL window
 233  * @param[in] callback The callback function to register
 234  * @param[in] user_data The user data to be passed to the callback function
 235  * @return @c 0 on success, otherwise a negative error value
 236  * @retval #EFL_UTIL_ERROR_NONE Successful
 237  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 238  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 239  * @post  efl_util_window_screen_mode_error_cb() will be invoked.
 240  * @see efl_util_unset_window_screen_mode_error_cb()
 241  * @see efl_util_window_screen_mode_error_cb()
 242  */
 243 API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_window_screen_mode_error_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 244
 245 /**
 246  * @deprecated Deprecated since 3.0. Use the return value of efl_util_set_window_screen_mode() instead.
 247  * @brief Unregisters the callback function.
 248  * @since_tizen 2.4
 249  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 250  * @param[in] window The EFL window
 251  * @return @c 0 on success, otherwise a negative error value
 252  * @retval #EFL_UTIL_ERROR_NONE Successful
 253  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 254  * @see efl_util_set_window_screen_mode_error_cb()
 255  */
 256 API int efl_util_unset_window_screen_mode_error_cb(Evas_Object *window) TIZEN_DEPRECATED_API;
 257
 258 /**
 259  * @brief Sets the user's preferred brightness of the specified window.
 260  * @details This API is useful when the application need to change the brightness of the screen when it is appeared on the screen.
 261  *          If the application sets the brightness 0 to 100 to its window and the application window is shown wholly or partially,
 262  *          the window manager requests the display system to change the brightness of the screen using user's preferred brightness.
 263  *          If the window is no longer shown, then the window manger request the display system to go back to default brightness.
 264  *          If the brightness is less than 0, this means to use the default screen brightness.
 265  * @since_tizen 3.0
 266  * @privlevel public
 267  * @privilege %http://tizen.org/privilege/display
 268  * @remarks This API needs the privilege.
 269  *          If the application which is not get the privilege use this API, the window manager generates the permission deny error.
 270  * @param[in] window The EFL window
 271  * @param[in] brightness The preferred brightness
 272  * @return @c 0 on success, otherwise a negative error value
 273  * @retval #EFL_UTIL_ERROR_NONE Successful
 274  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 275  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 276  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 277  * @see efl_util_get_window_brightness()
 278  */
 279 API int efl_util_set_window_brightness(Evas_Object *window, int brightness);
 280
 281 /**
 282  * @brief Gets the user's preferred brightness of the specified window.
 283  * @since_tizen 3.0
 284  * @param[in] window The EFL window
 285  * @param[out] brightness The preferred brightness
 286  * @return @c 0 on success, otherwise a negative error value
 287  * @retval #EFL_UTIL_ERROR_NONE Successful
 288  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 289  * @see efl_util_set_window_brightness()
 290  */
 291 API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
 292
 293
 294 /**
 295  * @}
 296  */
 297
 298 /**
 299  * @addtogroup CAPI_EFL_UTIL_INPUT_MODULE
 300  * @{
 301  */
 302
 303  /**
 304   * @platform
 305   * @brief Definition for the input generator handle.
 306   * @since_tizen $TZ_CFG_VER_24_OR_30$
 307   */
 308
 309  typedef struct _efl_util_inputgen_h * efl_util_inputgen_h;
 310
 311 /**
 312  * @platform
 313  * @brief Enumeration of device type generated events.
 314  * @since_tizen $TZ_CFG_VER_24_OR_30$
 315  */
 316 typedef enum
 317 {
 318    EFL_UTIL_INPUT_DEVTYPE_NONE = 0x0, /**< (Deprecated since 3.0.) */
 319    EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN = (1 << 0), /**< Touch Screen device */
 320    EFL_UTIL_INPUT_DEVTYPE_KEYBOARD = (1 << 1), /**< Keyboard device */
 321    EFL_UTIL_INPUT_DEVTYPE_POINTER = (1 << 2), /**< Mouse device (Since 3.0) */
 322    EFL_UTIL_INPUT_DEVTYPE_ALL = EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN |
 323                                 EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, /**< Both of touch screen and keyboard device (Deprecated since 3.0. Check all enumerations using OR operand instead) */
 324    EFL_UTIL_INPUT_DEVTYPE_MAX = (1 << 10) /**< (Deprecated since 3.0.) */
 325 } efl_util_input_device_type_e;
 326
 327 /**
 328  * @platform
 329  * @brief Enumeration of touch event types.
 330  * @since_tizen $TZ_CFG_VER_24_OR_30$
 331  */
 332 typedef enum
 333 {
 334    EFL_UTIL_INPUT_TOUCH_NONE, /**< (Deprecated since 3.0.) */
 335    EFL_UTIL_INPUT_TOUCH_BEGIN, /**< Finger press. It is same a behavior put your finger on touch screen */
 336    EFL_UTIL_INPUT_TOUCH_UPDATE, /**< Finger move. It is same a behavior move your finger on touch screen */
 337    EFL_UTIL_INPUT_TOUCH_END, /**< Finger release. It is same a behavior release your finger on touch screen */
 338    EFL_UTIL_INPUT_TOUCH_MAX = 10 /**< (Deprecated since 3.0.) */
 339 } efl_util_input_touch_type_e;
 340
 341 /**
 342  * @platform
 343  * @brief Enumeration of pointer event types.
 344  * @since_tizen 3.0
 345  */
 346 typedef enum
 347 {
 348    EFL_UTIL_INPUT_POINTER_BUTTON_DOWN, /**< Mouse button press. */
 349    EFL_UTIL_INPUT_POINTER_BUTTON_UP, /**< Mouse move. */
 350    EFL_UTIL_INPUT_POINTER_MOVE, /**< Mouse button release. */
 351 } efl_util_input_pointer_type_e;
 352
 353 /**
 354    * @platform
 355    * @brief Initializes system and check input generate functions are supported, open devices generated events.
 356    * @since_tizen $TZ_CFG_VER_24_OR_30$
 357    * @privlevel platform
 358    * @privilege %http://tizen.org/privilege/inputgenerator
 359    * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
 360    * @remarks The dev_type is changed into the unsigned int to perform bitwise operations. (Since 3.0)
 361    * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
 362    * @return #efl_util_inputgen_h on success, otherwise @c NULL
 363    * @retval #efl_util_inputgen_h The input generator handle
 364    * @exception #EFL_UTIL_ERROR_NONE Successful
 365    * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 366    * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
 367    * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
 368    * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 369    * @see efl_util_input_deinitialize_generator()
 370    */
 371 API efl_util_inputgen_h efl_util_input_initialize_generator(unsigned int dev_type);
 372
 373 /**
 374    * @platform
 375    * @brief Initializes system, check input generate functions are supported and then open events generator devices with given name.
 376    * @since_tizen 4.0
 377    * @privlevel platform
 378    * @privilege %http://tizen.org/privilege/inputgenerator
 379    * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
 380    * @remarks The dev_type is changed into the unsigned int to perform bitwise operations.
 381    * @param[in] dev_type The device type want to generate events (ex> #EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN | #EFL_UTIL_INPUT_DEVTYPE_KEYBOARD)
 382    * @param[in] name The device name (maximum 31 characters)
 383    * @return #efl_util_inputgen_h on success, otherwise @c NULL
 384    * @retval #efl_util_inputgen_h The input generator handle
 385    * @exception #EFL_UTIL_ERROR_NONE Successful
 386    * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 387    * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
 388    * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
 389    * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 390    * @see efl_util_input_deinitialize_generator()
 391    */
 392 API efl_util_inputgen_h efl_util_input_initialize_generator_with_name(unsigned int dev_type, const char *name);
 393
 394 /**
 395    * @platform
 396    * @brief Deinitializes system and close opened devices.
 397    * @since_tizen $TZ_CFG_VER_24_OR_30$
 398    * @privlevel platform
 399    * @privilege %http://tizen.org/privilege/inputgenerator
 400    * @param[in] inputgen_h The #efl_util_inputgen_h handle
 401    * @return @c 0 on success, otherwise a negative error value
 402    * @retval #EFL_UTIL_ERROR_NONE Successful
 403    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 404    * @see efl_util_input_initialize_generator()
 405    */
 406 API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h);
 407
 408 /**
 409    * @platform
 410    * @brief Generates all of key events using a opened device.
 411    * @since_tizen $TZ_CFG_VER_24_OR_30$
 412    * @privlevel platform
 413    * @privilege %http://tizen.org/privilege/inputgenerator
 414    * @param[in] inputgen_h The #efl_util_inputgen_h handle
 415    * @param[in] key_name The key name want to generate
 416    * @param[in] pressed The value that select key press or release (0: release, 1: press)
 417    * @return @c 0 on success, otherwise a negative error value
 418    * @retval #EFL_UTIL_ERROR_NONE Successful
 419    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 420    * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate key
 421    */
 422 API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *key_name, int pressed);
 423
 424 /**
 425    * @platform
 426    * @brief Generates a touch event using a opened device.
 427    * @since_tizen $TZ_CFG_VER_24_OR_30$
 428    * @privlevel platform
 429    * @privilege %http://tizen.org/privilege/inputgenerator
 430    * @param[in] inputgen_h The #efl_util_inputgen_h handle
 431    * @param[in] idx The index of touched finger
 432    * @param[in] touch_type The touch type (ex> #EFL_UTIL_INPUT_TOUCH_BEGIN, #EFL_UTIL_INPUT_TOUCH_UPDATE, #EFL_UTIL_INPUT_TOUCH_END)
 433    * @param[in] x The x axis of touch point
 434    * @param[in] y The y axis of touch point
 435    * @return @c 0 on success, otherwise a negative error value
 436    * @retval #EFL_UTIL_ERROR_NONE Successful
 437    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 438    * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate touch
 439    */
 440 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);
 441
 442 /**
 443    * @platform
 444    * @brief Generate a pointer event using a opened device.
 445    * @since_tizen 3.0
 446    * @privlevel platform
 447    * @privilege %http://tizen.org/privilege/inputgenerator
 448    * @param[in] inputgen_h The #efl_util_inputgen_h handle
 449    * @param[in] buttons The number of button
 450    * @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)
 451    * @param[in] x x coordination to move
 452    * @param[in] y y coordination to move
 453    * @return @c 0 on success, otherwise a negative error value
 454    * @retval #EFL_UTIL_ERROR_NONE Successful
 455    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 456    * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate pointer
 457    * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
 458    * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 459    */
 460 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);
 461
 462 /**
 463  * @}
 464  */
 465
 466 /**
 467  * @addtogroup CAPI_EFL_UTIL_SCREENSHOT_MODULE
 468  * @{
 469  */
 470
 471 /**
 472  * @platform
 473  * @brief Definition for the screenshot handle.
 474  * @since_tizen $TZ_CFG_VER_24_OR_30$
 475  */
 476 typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
 477
 478 /**
 479  * @platform
 480  * @brief Initializes the screenshot.
 481  * @since_tizen $TZ_CFG_VER_24_OR_30$
 482  * @privlevel platform
 483  * @privilege %http://tizen.org/privilege/screenshot
 484  * @remarks The specific error code can be obtained using the get_last_result()
 485  * method. Error codes are described in Exception section.
 486  * @param[in] width width of the screenshot surface
 487  * @param[in] height height of the screenshot surface
 488  * @return #efl_util_screenshot_h on success, otherwise @c NULL
 489  * @retval #efl_util_screenshot_h  The screenshot handle
 490  * @exception #EFL_UTIL_ERROR_NONE Successful
 491  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 492  * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 493  * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure
 494  * @see efl_util_screenshot_deinitialize()
 495  */
 496 API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
 497
 498 /**
 499  * @platform
 500  * @brief Takes a screenshot and get a tbm_surface handle.
 501  * @since_tizen $TZ_CFG_VER_24_OR_30$
 502  * @privlevel platform
 503  * @privilege %http://tizen.org/privilege/screenshot
 504  * @remarks The specific error code can be obtained using the get_last_result()
 505  *          The #tbm_surface_h must be free by caller
 506  * @param[in] screenshot efl_util_screenshot_h handle
 507  * @return #tbm_surface_h on success, otherwise @c NULL
 508  * @retval #tbm_surface_h The TBM surface handle
 509  * @exception #EFL_UTIL_ERROR_NONE Successful
 510  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 511  * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure
 512  * @see efl_util_screenshot_initialize()
 513  * @see efl_util_screenshot_deinitialize()
 514  */
 515 API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h screenshot);
 516
 517 /**
 518  * @platform
 519  * @brief Deinitializes the screenshot.
 520  * @since_tizen $TZ_CFG_VER_24_OR_30$
 521  * @privlevel platform
 522  * @privilege %http://tizen.org/privilege/screenshot
 523  * @param[in]  screenshot  efl_util_screenshot_h handle
 524  * @return @c 0 on success, otherwise a negative error value
 525  * @retval #EFL_UTIL_ERROR_NONE Successful
 526  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 527  * @see efl_util_screenshot_initialize()
 528  */
 529 API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot);
 530
 531 /**
 532  * @}
 533  */
 534
 535 #ifdef __cplusplus
 536 }
 537 #endif
 538 #endif /* __TIZEN_UI_EFL_UTIL_H__ */