include/efl_util.h

   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: 2.4) */
  56    EFL_UTIL_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< @platform Function not implemented (@b Since: 2.4) */
  57    EFL_UTIL_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< @platform Not supported (@b Since: 2.4) */
  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: 2.4) */
  60    EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL = TIZEN_ERROR_EFL_UTIL | 0x03  /**< @platform Screenshot execution fail (@b Since: 2.4) */
  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 2.4. Use EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT instead.) */
  70    EFL_UTIL_NOTIFICATION_LEVEL_2, /**< Higher notification level than default. (Deprecated since 2.4. Use EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM instead.) */
  71    EFL_UTIL_NOTIFICATION_LEVEL_3, /**< The highest notification level. (Deprecated since 2.4. 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: 2.4) */
  73    EFL_UTIL_NOTIFICATION_LEVEL_DEFAULT = 10, /**< Default notification level. (@b Since: 2.4) */
  74    EFL_UTIL_NOTIFICATION_LEVEL_MEDIUM  = 20, /**< Higher notification level than default. (@b Since: 2.4) */
  75    EFL_UTIL_NOTIFICATION_LEVEL_HIGH    = 30, /**< Higher notification level than medium. (@b Since: 2.4) */
  76    EFL_UTIL_NOTIFICATION_LEVEL_TOP     = 40  /**< The highest notification level. (@b Since: 2.4) */
  77 } efl_util_notification_level_e;
  78
  79 /**
  80  * @brief Enumeration of screen mode.
  81  * @since_tizen 2.4
  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 2.4, 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 2.4, 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_tizen 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_tizen 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_tizen 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 2.4
 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 2.4
 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  *          The application can notice this error if it set the callback function using the efl_util_set_window_screen_mode_error_cb().
 195  * @param[in] window The EFL window
 196  * @param[in] mode The screen mode
 197  * @return @c 0 on success, otherwise a negative error value
 198  * @retval #EFL_UTIL_ERROR_NONE Successful
 199  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 200  * @retval #EFL_UTIL_ERROR_PERMISSION_DENIED Permission denied
 201  */
 202 API int efl_util_set_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e mode);
 203
 204 /**
 205  * @brief Gets the screen mode of the specified window.
 206  * @since_tizen 2.4
 207  * @param[in] window The EFL window
 208  * @param[out] mode The screen mode
 209  * @return @c 0 on success, otherwise a negative error value
 210  * @retval #EFL_UTIL_ERROR_NONE Successful
 211  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 212  */
 213 API int efl_util_get_window_screen_mode(Evas_Object *window, efl_util_screen_mode_e *mode);
 214
 215 /**
 216  * @deprecated Deprecated since_tizen 3.0.
 217  * @brief Called when an error occurs for setting window's screen mode
 218  * @since_tizen 2.4
 219  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 220  * @param[in] window The EFL window
 221  * @param[in] error_code The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
 222  * @param[in] user_data The user data passed from the callback registration function
 223  * @see efl_util_set_window_screen_mode_error_cb()
 224  * @see efl_util_unset_window_screen_mode_error_cb()
 225  */
 226 typedef void (*efl_util_window_screen_mode_error_cb)(Evas_Object *window, int error_code, void *user_data);
 227
 228 /**
 229  * @deprecated Deprecated since_tizen 3.0.
 230  * @brief Registers a callback function to be invoked when an error which set the screen mode.
 231  * @since_tizen 2.4
 232  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 233  * @param[in] window The EFL window
 234  * @param[in] callback The callback function to register
 235  * @param[in] user_data The user data to be passed to the callback function
 236  * @return @c 0 on success, otherwise a negative error value
 237  * @retval #EFL_UTIL_ERROR_NONE Successful
 238  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 239  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 240  * @post  efl_util_window_screen_mode_error_cb() will be invoked.
 241  * @see efl_util_unset_window_screen_mode_error_cb()
 242  * @see efl_util_window_screen_mode_error_cb()
 243  */
 244 API int efl_util_set_window_screen_mode_error_cb(Evas_Object *window, efl_util_window_screen_mode_error_cb callback, void *user_data);
 245
 246 /**
 247  * @deprecated Deprecated since_tizen 3.0.
 248  * @brief Unregisters the callback function.
 249  * @since_tizen 2.4
 250  * @remarks An application can check error by the return value of efl_util_set_window_screen_mode since 3.0.
 251  * @param[in] window The EFL window
 252  * @return @c 0 on success, otherwise a negative error value
 253  * @retval #EFL_UTIL_ERROR_NONE Successful
 254  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 255  * @see efl_util_set_window_screen_mode_error_cb()
 256  */
 257 API int efl_util_unset_window_screen_mode_error_cb(Evas_Object *window);
 258
 259 /**
 260  * @}
 261  */
 262
 263 /**
 264  * @addtogroup CAPI_EFL_UTIL_INPUT_MODULE
 265  * @{
 266  */
 267
 268 /**
 269  * @platform
 270  * @brief Enumeration of device type generated events.
 271  * @since_tizen 2.4
 272  */
 273 typedef enum
 274 {
 275    EFL_UTIL_INPUT_DEVTYPE_NONE,
 276    EFL_UTIL_INPUT_DEVTYPE_TOUCHSCREEN, /**< Touch Screen device */
 277    EFL_UTIL_INPUT_DEVTYPE_KEYBOARD, /**< Keyboard device */
 278    EFL_UTIL_INPUT_DEVTYPE_ALL, /**< Both of touch screen and keyboard device */
 279    EFL_UTIL_INPUT_DEVTYPE_MAX
 280 } efl_util_input_device_type_e;
 281
 282 /**
 283  * @platform
 284  * @brief Enumeration of touch event types.
 285  * @since_tizen 2.4
 286  */
 287 typedef enum
 288 {
 289    EFL_UTIL_INPUT_TOUCH_NONE,
 290    EFL_UTIL_INPUT_TOUCH_BEGIN, /**< Finger press. It is same a behavior put your finger on touch screen */
 291    EFL_UTIL_INPUT_TOUCH_UPDATE, /**< Finger move. It is same a behavior move your finger on touch screen */
 292    EFL_UTIL_INPUT_TOUCH_END, /**< Finger release. It is same a behavior release your finger on touch screen */
 293    EFL_UTIL_INPUT_TOUCH_MAX
 294 } efl_util_input_touch_type_e;
 295
 296 /**
 297  * @platform
 298  * @brief Initializes system and check input generate functions are supported, open devices generated events.
 299  * @since_tizen 2.4
 300  * @privlevel platform
 301  * @privilege %http://tizen.org/privilege/inputgenerator
 302  * @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)
 303  * @return @c 0 on success, otherwise a negative error value
 304  * @retval #EFL_UTIL_ERROR_NONE Successful
 305  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 306  * @retval #EFL_UTIL_ERROR_NO_SUCH_DEVICE No such device or address
 307  * @retval #EFL_UTIL_ERROR_INVALID_OPERATION Function not implemented
 308  * @see efl_util_input_generate_deinit()
 309  */
 310 API int efl_util_input_initialize_generator(efl_util_input_device_type_e dev_type);
 311
 312 /**
 313  * @platform
 314  * @brief Deinitializes system and close opened devices.
 315  * @since_tizen 2.4
 316  * @privlevel platform
 317  * @privilege %http://tizen.org/privilege/inputgenerator
 318  * @see efl_util_input_generate_init()
 319  */
 320 API void efl_util_input_deinitialize_generator(void);
 321
 322 /**
 323  * @platform
 324  * @brief Generates all of key events using a opened device.
 325  * @since_tizen 2.4
 326  * @privlevel platform
 327  * @privilege %http://tizen.org/privilege/inputgenerator
 328  * @param[in] key_name The key name want to generate
 329  * @param[in] pressed The value that select key press or release (0: release, 1: press)
 330  * @return @c 0 on success, otherwise a negative error value
 331  * @retval #EFL_UTIL_ERROR_NONE Successful
 332  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 333  */
 334 API int efl_util_input_generate_key(const char *key_name, int pressed);
 335
 336 /**
 337  * @platform
 338  * @brief Generates a touch event using a opened device.
 339  * @since_tizen 2.4
 340  * @privlevel platform
 341  * @privilege %http://tizen.org/privilege/inputgenerator
 342  * @param[in] idx The index of touched finger
 343  * @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)
 344  * @return @c 0 on success, otherwise a negative error value
 345  * @retval #EFL_UTIL_ERROR_NONE Successful
 346  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 347  */
 348 API int efl_util_input_generate_touch(int idx, efl_util_input_touch_type_e touch_type, int x, int y);
 349
 350 /**
 351  * @}
 352  */
 353
 354 /**
 355  * @addtogroup CAPI_EFL_UTIL_SCREENSHOT_MODULE
 356  * @{
 357  */
 358
 359 /**
 360  * @platform
 361  * @brief Definition for the screenshot handle.
 362  * @since_tizen 2.4
 363  */
 364 typedef struct _efl_util_screenshot_h * efl_util_screenshot_h;
 365
 366 /**
 367  * @platform
 368  * @brief Initializes the screenshot.
 369  * @since_tizen 2.4
 370  * @privlevel platform
 371  * @privilege %http://tizen.org/privilege/screenshot
 372  * @remarks The specific error code can be obtained using the get_last_result()
 373  * method. Error codes are described in Exception section.
 374  * @param[in] width width of the screenshot surface
 375  * @param[in] height height of the screenshot surface
 376  * @return #efl_util_screenshot_h on success, otherwise @c NULL
 377  * @retval #efl_util_screenshot_h  The screenshot handle
 378  * @exception #EFL_UTIL_ERROR_NONE Successful
 379  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 380  * @exception #EFL_UTIL_ERROR_OUT_OF_MEMORY Memory allocation failure
 381  * @exception #EFL_UTIL_ERROR_SCREENSHOT_INIT_FAIL Initialization failure
 382  * @see efl_util_screenshot_deinitialize()
 383  */
 384 API efl_util_screenshot_h efl_util_screenshot_initialize(int width, int height);
 385
 386 /**
 387  * @platform
 388  * @brief Takes a screenshot and get a tbm_surface handle.
 389  * @since_tizen 2.4
 390  * @privlevel platform
 391  * @privilege %http://tizen.org/privilege/screenshot
 392  * @remarks The specific error code can be obtained using the get_last_result()
 393  *          The tbm_surface_h must be free by caller
 394  * @param[in] screenshot efl_util_screenshot_h handle
 395  * @return #tbm_surface_h on success, otherwise @c NULL
 396  * @retval #tbm_surface_h The TBM surface handle
 397  * @exception #EFL_UTIL_ERROR_NONE Successful
 398  * @exception #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 399  * @exception #EFL_UTIL_ERROR_SCREENSHOT_EXECUTION_FAIL Execution failure
 400  * @see efl_util_screenshot_initialize()
 401  * @see efl_util_screenshot_deinitialize()
 402  */
 403 API tbm_surface_h efl_util_screenshot_take_tbm_surface(efl_util_screenshot_h screenshot);
 404
 405 /**
 406  * @platform
 407  * @brief Deinitializes the screenshot.
 408  * @since_tizen 2.4
 409  * @privlevel platform
 410  * @privilege %http://tizen.org/privilege/screenshot
 411  * @param[in]  screenshot  efl_util_screenshot_h handle
 412  * @return @c 0 on success, otherwise a negative error value
 413  * @retval #EFL_UTIL_ERROR_NONE Successful
 414  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 415  * @see efl_util_screenshot_initialize()
 416  */
 417 API int efl_util_screenshot_deinitialize(efl_util_screenshot_h screenshot);
 418
 419 /**
 420  * @}
 421  */
 422
 423 #ifdef __cplusplus
 424 }
 425 #endif
 426 #endif /* __TIZEN_UI_EFL_UTIL_H__ */