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.
 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);
 153
 154 /**
 155  * @deprecated Deprecated since 3.0.
 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);
 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  $TZ_CFG_KEEP_BEGIN$
 195  *          The application can notice this error if it set the callback function using the efl_util_set_window_screen_mode_error_cb().
 196  $TZ_CFG_KEEP_END$
 197  * @param[in] window The EFL window
 198  * @param[in] mode The screen mode
 199  * @return @c 0 on success, otherwise a negative error value
 200  * @retval #EFL_UTIL_ERROR_NONE Successful
 201  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 202  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 203  */
 204 API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
 205
 206 /**
 207  * @brief Gets the screen mode of the specified window.
 208  * @since_tizen $TZ_CFG_VER_24_OR_30$
 209  * @param[in] window The EFL window
 210  * @param[out] mode The screen mode
 211  * @return @c 0 on success, otherwise a negative error value
 212  * @retval #EFL_UTIL_ERROR_NONE Successful
 213  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 214  */
 215 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
 216
 217 $TZ_CFG_KEEP_BEGIN$
 218 /**
 219  * @deprecated Deprecated since 3.0.
 220  * @brief Called when an error occurs for setting window's screen mode
 221  * @since_tizen 2.4
 222  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 223  * @param[in] window The EFL window
 224  * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
 225  * @param[in] user_data The user data passed from the callback registration function
 226  * @see efl_util_set_window_screen_mode_error_cb()
 227  * @see efl_util_unset_window_screen_mode_error_cb()
 228  */
 229 typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int error_code, void *user_data);
 230
 231 /**
 232  * @deprecated Deprecated since 3.0.
 233  * @brief Registers a callback function to be invoked when an error which set the screen mode.
 234  * @since_tizen 2.4
 235  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 236  * @param[in] window The EFL window
 237  * @param[in] callback The callback function to register
 238  * @param[in] user_data The user data to be passed to the callback function
 239  * @return @c 0 on success, otherwise a negative error value
 240  * @retval #EFL_UTIL_ERROR_NONE Successful
 241  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 242  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 243  * @post  efl_util_window_screen_mode_error_cb() will be invoked.
 244  * @see efl_util_unset_window_screen_mode_error_cb()
 245  * @see efl_util_window_screen_mode_error_cb()
 246  */
 247 API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_window_screen_mode_error_cb callback, void *user_data);
 248
 249 /**
 250  * @deprecated Deprecated since 3.0.
 251  * @brief Unregisters the callback function.
 252  * @since_tizen 2.4
 253  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 254  * @param[in] window The EFL window
 255  * @return @c 0 on success, otherwise a negative error value
 256  * @retval #EFL_UTIL_ERROR_NONE Successful
 257  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 258  * @see efl_util_set_window_screen_mode_error_cb()
 259  */
 260 API int efl_util_unset_window_screen_mode_error_cb(Evas_Object *window);
 261 $TZ_CFG_KEEP_END$
 262
 263 /**
 264  * @brief Sets the user's preferred brightness of the specified window.
 265  * @details This API is useful when the application need to change the brightness of the screen when it is appeared on the screen.
 266  *          If the application sets the brightness 0 to 100 to its window and the application window is shown wholly or partially,
 267  *          the window manager requests the display system to change the brightness of the screen using user's preferred brightness.
 268  *          If the window is no longer shown, then the window manger request the display system to go back to default brightness.
 269  *          If the brightness is less than 0, this means to use the default screen brightness.
 270  * @since_tizen 3.0
 271  * @privlevel public
 272  * @privilege %http://tizen.org/privilege/display
 273  * @remarks This API needs the privilege.
 274  *          If the application which is not get the privilege use this API, the window manager generates the permission deny error.
 275  * @param[in] window The EFL window
 276  * @param[in] brightness The preferred brightness
 277  * @return @c 0 on success, otherwise a negative error value
 278  * @retval #EFL_UTIL_ERROR_NONE Successful
 279  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 280  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 281  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 282  * @see efl_util_get_window_brightness()
 283  */
 284 API int efl_util_set_window_brightness(Evas_Object *window, int brightness);
 285
 286 /**
 287  * @brief Gets the user's preferred brightness of the specified window.
 288  * @since_tizen 3.0
 289  * @param[in] window The EFL window
 290  * @param[out] brightness The preferred brightness
 291  * @return @c 0 on success, otherwise a negative error value
 292  * @retval #EFL_UTIL_ERROR_NONE Successful
 293  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 294  * @see efl_util_set_window_brightness()
 295  */
 296 API int efl_util_get_window_brightness(Evas_Object *window, int *brightness);
 297
 298
 299 /**
 300  * @}
 301  */
 302
 303 /**
 304  * @addtogroup CAPI_EFL_UTIL_INPUT_MODULE
 305  * @{
 306  */
 307
 308  /**
 309   * @platform
 310   * @brief Definition for the input generator handle.
 311   * @since_tizen $TZ_CFG_VER_24_OR_30$
 312   */
 313
 314  typedef struct _efl_util_inputgen_h * efl_util_inputgen_h;
 315
 316 /**
 317  * @platform
 318  * @brief Enumeration of device type generated events.
 319  * @since_tizen $TZ_CFG_VER_24_OR_30$
 320  */
 321 typedef enum
 322 {
 323    EFL_UTIL_INPUT_DEVTYPE_NONE = 0x0,
 324    EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN = (1 << 0), /**< Touch Screen device */
 325    EFL_UTIL_INPUT_DEVTYPE_KEYBOARD = (1 << 1), /**< Keyboard device */
 326    EFL_UTIL_INPUT_DEVTYPE_ALL = EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN |
 327                                 EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, /**< Both of touch screen and keyboard device */
 328    EFL_UTIL_INPUT_DEVTYPE_MAX = (1 << 10)
 329 } efl_util_input_device_type_e;
 330
 331 /**
 332  * @platform
 333  * @brief Enumeration of touch event types.
 334  * @since_tizen $TZ_CFG_VER_24_OR_30$
 335  */
 336 typedef enum
 337 {
 338    EFL_UTIL_INPUT_TOUCH_NONE,
 339    EFL_UTIL_INPUT_TOUCH_BEGIN, /**< Finger press. It is same a behavior put your finger on touch screen */
 340    EFL_UTIL_INPUT_TOUCH_UPDATE, /**< Finger move. It is same a behavior move your finger on touch screen */
 341    EFL_UTIL_INPUT_TOUCH_END, /**< Finger release. It is same a behavior release your finger on touch screen */
 342    EFL_UTIL_INPUT_TOUCH_MAX = 10
 343 } efl_util_input_touch_type_e;
 344
 345 /**
 346    * @platform
 347    * @brief Initializes system and check input generate functions are supported, open devices generated events.
 348    * @since_tizen $TZ_CFG_VER_24_OR_30$
 349    * @privlevel platform
 350    * @privilege %http://tizen.org/privilege/inputgenerator
 351    * @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
 352    * @param[in] dev_type The device type want to generate events (ex> EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN, EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, EFL_UTIL_INPUT_DEVTYPE_ALL)
 353    * @return #efl_util_inputgen_h on success, otherwise @c NULL
 354    * @retval #efl_util_inputgen_h The input generator handle
 355    * @exception #EFL_UTIL_ERROR_NONE Successful
 356    * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 357    * @exception #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
 358    * @exception #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
 359    * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 360    * @see efl_util_input_deinitialize_generator()
 361    */
 362 API efl_util_inputgen_h efl_util_input_initialize_generator(efl_util_input_device_type_e dev_type);
 363
 364 /**
 365    * @platform
 366    * @brief Deinitializes system and close opened devices.
 367    * @since_tizen $TZ_CFG_VER_24_OR_30$
 368    * @privlevel platform
 369    * @privilege %http://tizen.org/privilege/inputgenerator
 370    * @param[in] inputgen_h The efl_util_inputgen_h handle
 371    * @return @c 0 on success, otherwise a negative error value
 372    * @retval #EFL_UTIL_ERROR_NONE Successful
 373    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 374    * @see efl_util_input_initialize_generator()
 375    */
 376 API int efl_util_input_deinitialize_generator(efl_util_inputgen_h inputgen_h);
 377
 378 /**
 379    * @platform
 380    * @brief Generates all of key events using a opened device.
 381    * @since_tizen $TZ_CFG_VER_24_OR_30$
 382    * @privlevel platform
 383    * @privilege %http://tizen.org/privilege/inputgenerator
 384    * @param[in] key_name The key name want to generate
 385    * @param[in] pressed The value that select key press or release (0: release, 1: press)
 386    * @return @c 0 on success, otherwise a negative error value
 387    * @retval #EFL_UTIL_ERROR_NONE Successful
 388    * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 389    * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate key
 390    */
 391 API int efl_util_input_generate_key(efl_util_inputgen_h inputgen_h, const char *key_name, int pressed);
 392
 393 /**
 394    * @platform
 395    * @brief Generates a touch event using a opened device.
 396    * @since_tizen $TZ_CFG_VER_24_OR_30$
 397    * @privlevel platform
 398    * @privilege %http://tizen.org/privilege/inputgenerator
 399    * @param[in] idx The index of touched finger
 400    * @param[in] efl_util_input_touch_type_e The touch type (ex> EFL_UTIL_INPUT_TOUCH_BEGIN, EFL_UTIL_INPUT_TOUCH_UPDATE, EFL_UTIL_INPUT_TOUCH_END)
 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    * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Has no permission to generate touch
 405    */
 406 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);
 407
 408 /**
 409  * @}
 410  */
 411
 412 /**
 413  * @addtogroup CAPI_EFL_UTIL_SCREENSHOT_MODULE
 414  * @{
 415  */
 416
 417 /**
 418  * @platform
 419  * @brief Definition for the screenshot handle.
 420  * @since_tizen $TZ_CFG_VER_24_OR_30$
 421  */
 422 typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
 423
 424 /**
 425  * @platform
 426  * @brief Initializes the screenshot.
 427  * @since_tizen $TZ_CFG_VER_24_OR_30$
 428  * @privlevel platform
 429  * @privilege %http://tizen.org/privilege/screenshot
 430  * @remarks The specific error code can be obtained using the get_last_result()
 431  * method. Error codes are described in Exception section.
 432  * @param[in] width width of the screenshot surface
 433  * @param[in] height height of the screenshot surface
 434  * @return #efl_util_screenshot_h on success, otherwise @c NULL
 435  * @retval #efl_util_screenshot_h  The screenshot handle
 436  * @exception #EFL_UTIL_ERROR_NONE Successful
 437  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 438  * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 439  * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure
 440  * @see efl_util_screenshot_deinitialize()
 441  */
 442 API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
 443
 444 /**
 445  * @platform
 446  * @brief Takes a screenshot and get a tbm_surface handle.
 447  * @since_tizen $TZ_CFG_VER_24_OR_30$
 448  * @privlevel platform
 449  * @privilege %http://tizen.org/privilege/screenshot
 450  * @remarks The specific error code can be obtained using the get_last_result()
 451  *          The tbm_surface_h must be free by caller
 452  * @param[in] screenshot efl_util_screenshot_h handle
 453  * @return #tbm_surface_h on success, otherwise @c NULL
 454  * @retval #tbm_surface_h The TBM surface handle
 455  * @exception #EFL_UTIL_ERROR_NONE Successful
 456  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 457  * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure
 458  * @see efl_util_screenshot_initialize()
 459  * @see efl_util_screenshot_deinitialize()
 460  */
 461 API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h screenshot);
 462
 463 /**
 464  * @platform
 465  * @brief Deinitializes the screenshot.
 466  * @since_tizen $TZ_CFG_VER_24_OR_30$
 467  * @privlevel platform
 468  * @privilege %http://tizen.org/privilege/screenshot
 469  * @param[in]  screenshot  efl_util_screenshot_h handle
 470  * @return @c 0 on success, otherwise a negative error value
 471  * @retval #EFL_UTIL_ERROR_NONE Successful
 472  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 473  * @see efl_util_screenshot_initialize()
 474  */
 475 API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot);
 476
 477 /**
 478  * @}
 479  */
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif
 484 #endif /* __TIZEN_UI_EFL_UTIL_H__ */