include/efl_util.h

   1 /*
   2  * Copyright (c) 2011 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
  18 #ifndef __TIZEN_UI_EFL_UTIL_H__
  19 #define __TIZEN_UI_EFL_UTIL_H__
  20
  21 #include <tizen.h>
  22 #include <Evas.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /**
  29  * @file efl_util.h
  30  */
  31
  32 /**
  33  * @addtogroup CAPI_EFL_UTIL_MODULE
  34  * @{
  35  */
  36
  37 /**
  38  * @brief Enumeration for EFL UTIL ERROR.
  39  * @since_tizen 2.3
  40  */
  41 typedef enum
  42 {
  43         EFL_UTIL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
  44         EFL_UTIL_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
  45         EFL_UTIL_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
  46         EFL_UTIL_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permisson denied */
  47         EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE = TIZEN_ERROR_EFL_UTIL | 0x01  /**< Window type not supported */
  48 } efl_util_error_e;
  49
  50 /**
  51  * @brief Enumeration of notification window's priority level.
  52  * @since_tizen 2.3
  53  */
  54 typedef enum
  55 {
  56         EFL_UTIL_NOTIFICATION_LEVEL_1, /**< Default notification level */
  57         EFL_UTIL_NOTIFICATION_LEVEL_2, /**< Higher notification level than default */
  58         EFL_UTIL_NOTIFICATION_LEVEL_3, /**< The highest notification level */
  59 } efl_util_notification_level_e;
  60
  61
  62 /**
  63  * @brief Sets the priority level for the specified notification window, asynchronously.
  64  * @since_tizen 2.3
  65  * @privlevel public
  66  * @privilege %http://tizen.org/privilege/window.priority.set
  67  * @remarks This API can be used for a notification type window only.
  68  * @param[in] window The EFL window
  69  * @param[in] level The notification window level
  70  * @return @c 0 on success,
  71  *         otherwise a negative error value
  72  * @retval #EFL_UTIL_ERROR_NONE Successful
  73  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  74  * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
  75  */
  76 int efl_util_set_notification_window_level (Evas_Object *window, efl_util_notification_level_e level);
  77
  78
  79 /**
  80  * @brief Gets the priority level for the specified notification window, asynchronously.
  81  * @since_tizen 2.3
  82  *
  83  * @remarks This API can be used for a notification type window only.
  84  * @param[in] window The EFL window
  85  * @param[out] level The notification window level
  86  * @return @c 0 on success,
  87  *         otherwise a negative error value
  88  * @retval #EFL_UTIL_ERROR_NONE Successful
  89  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
  90  * @retval #EFL_UTIL_ERROR_NOT_SUPPORTED_WINDOW_TYPE Window type not supported
  91  */
  92 int efl_util_get_notification_window_level (Evas_Object *window, efl_util_notification_level_e* level);
  93
  94
  95 /**
  96  * @brief Called when an error occurs for setting notification window level
  97  * @since_tizen 2.3
  98  * @param[in]   window  The EFL window
  99  * @param[in]   error_code      The error code (#EFL_UTIL_ERROR_PERMISSION_DENIED)
 100  * @param[in]   user_data       The user data passed from the callback registration function
 101  * @see efl_util_set_notification_window_level_error_cb()
 102  * @see efl_util_unset_notification_window_level_error_cb()
 103  */
 104 typedef void (*efl_util_notification_window_level_error_cb)(Evas_Object *window, int error_code, void *user_data);
 105
 106
 107 /**
 108  * @brief Registers a callback function to be invoked when an error which set the notification level occurs.
 109  * @since_tizen 2.3
 110  * @param[in] window    The EFL window
 111  * @param[in] callback  The callback function to register
 112  * @param[in] user_data The user data to be passed to the callback function
 113  * @return @c 0 on success,
 114  *                 otherwise a negative error value
 115  * @retval #EFL_UTIL_ERROR_NONE Successful
 116  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 117  * @retval #EFL_UTIL_ERROR_OUT_OF_MEMORY Out of memory
 118  * @post  efl_util_notification_window_level_error_cb() will be invoked.
 119  * @see efl_util_unset_notification_window_level_error_cb()
 120  * @see efl_util_notification_window_level_error_cb()
 121  */
 122 int efl_util_set_notification_window_level_error_cb(Evas_Object *window, efl_util_notification_window_level_error_cb callback, void *user_data);
 123
 124
 125 /**
 126  * @brief Unregisters the callback function.
 127  * @since_tizen 2.3
 128  * @param[in] window The EFL window
 129  * @return @c 0 on success,
 130  *                 otherwise a negative error value
 131  * @retval #EFL_UTIL_ERROR_NONE Successful
 132  * @retval #EFL_UTIL_ERROR_INVALID_PARAMETER Invalid parameter
 133  * @see efl_util_set_notification_window_level_error_cb()
 134  */
 135 int efl_util_unset_notification_window_level_error_cb(Evas_Object *window);
 136
 137
 138 /**
 139  * @}
 140  */
 141
 142 #ifdef __cplusplus
 143 }
 144 #endif
 145 #endif                          /* __TIZEN_UI_EFL_UTIL_H__ */