include/system_settings.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 #ifndef __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__
  18 #define __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__
  19
  20 #include <tizen.h>
  21
  22 #ifdef __cplusplus
  23 extern "C"
  24 {
  25 #endif
  26
  27 /**
  28  * @file system_settings.h
  29  */
  30
  31 /**
  32  * @addtogroup CAPI_SYSTEM_SYSTEM_SETTINGS_MODULE
  33  * @{
  34  */
  35
  36
  37 /**
  38  * @brief Enumeration for system settings error.
  39  * @since_tizen 2.3
  40  */
  41 typedef enum {
  42         SYSTEM_SETTINGS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
  43         SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
  44         SYSTEM_SETTINGS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
  45         SYSTEM_SETTINGS_ERROR_IO_ERROR =  TIZEN_ERROR_IO_ERROR, /**< Internal I/O error */
  46         SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED =  TIZEN_ERROR_PERMISSION_DENIED, /**< Permition denied */
  47         SYSTEM_SETTINGS_ERROR_NOT_SUPPORTED =  TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported @if MOBILE (Since 2.3.1) @endif */
  48         SYSTEM_SETTINGS_ERROR_CALL_UNSUPPORTED_API = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported @if MOBILE (Since 2.3.1) @endif */
  49
  50         /* lock screen app error code */
  51         SYSTEM_SETTINGS_ERROR_LOCKSCREEN_APP_PASSWORD_MODE = TIZEN_ERROR_SYSTEM_SETTING | 0x01, /**< Current lock screen app set 'password' type */
  52 }
  53 system_settings_error_e;
  54
  55
  56 /**
  57  * @brief Enumeration for System Settings Key.
  58  * @since_tizen 2.3
  59  */
  60 typedef enum {
  61         SYSTEM_SETTINGS_KEY_INCOMING_CALL_RINGTONE, /**< (string) The file path of the current ringtone */
  62         SYSTEM_SETTINGS_KEY_WALLPAPER_HOME_SCREEN, /**< (string) The file path of the current home screen wallpaper */
  63         SYSTEM_SETTINGS_KEY_WALLPAPER_LOCK_SCREEN, /**< (string) The file path of the current lock screen wallpaper */
  64         SYSTEM_SETTINGS_KEY_FONT_SIZE, /**< (int) The current system font size */
  65         SYSTEM_SETTINGS_KEY_FONT_TYPE, /**< (string) The current system font type */
  66
  67         SYSTEM_SETTINGS_KEY_MOTION_ACTIVATION, /**< (bool) Indicates whether the motion service is activated */
  68         SYSTEM_SETTINGS_KEY_EMAIL_ALERT_RINGTONE,  /**< (string) The file path of the current email alert ringtone */
  69         SYSTEM_SETTINGS_KEY_USB_DEBUGGING_ENABLED,      /**< (bool) Indicates whether the USB debugging is enabled (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
  70         SYSTEM_SETTINGS_KEY_3G_DATA_NETWORK_ENABLED,  /**< bool) Indicates whether the 3G data network is enabled (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
  71         SYSTEM_SETTINGS_KEY_LOCKSCREEN_APP = SYSTEM_SETTINGS_KEY_3G_DATA_NETWORK_ENABLED+2,      /**< (string) Indicates lockscreen app pkg name  */
  72
  73         SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE,/**< (string) The current system default font type (only support Get) */
  74         SYSTEM_SETTINGS_KEY_LOCALE_COUNTRY,             /**< (string) Indicates the current country setting in the <LANGUAGE>_<REGION> syntax. The country setting is in the ISO 639-2 format, and the region setting is in the ISO 3166-1 alpha-2 format */
  75         SYSTEM_SETTINGS_KEY_LOCALE_LANGUAGE,    /**< (string) Indicates the current language setting in the <LANGUAGE>_<REGION> syntax. The language setting is in the ISO 639-2 format and the region setting is in the ISO 3166-1 alpha-2 format. */
  76         SYSTEM_SETTINGS_KEY_LOCALE_TIMEFORMAT_24HOUR,   /**< (bool) Indicates whether the 24-hour clock is used. If the value is @c false, the 12-hour clock is used. */
  77         SYSTEM_SETTINGS_KEY_LOCALE_TIMEZONE,    /**< (string) Indicates the current time zone. */
  78
  79         SYSTEM_SETTINGS_KEY_TIME_CHANGED,               /**< (int) Once System changes time, this event occurs to notify time change. */
  80         SYSTEM_SETTINGS_KEY_SOUND_LOCK,                                 /**< GET (bool) Indicates whether the screen lock sound is enabled on the device. ex) LCD on/off sound */
  81         SYSTEM_SETTINGS_KEY_SOUND_SILENT_MODE,                  /**< GET (bool) Indicates whether the device is in the silent mode. */
  82         SYSTEM_SETTINGS_KEY_SOUND_TOUCH,                                /**< GET (bool) Indicates whether the screen touch sound is enabled on the device. */
  83         SYSTEM_SETTINGS_KEY_DISPLAY_SCREEN_ROTATION_AUTO,       /**< GET (bool) Indicates whether rotation control is automatic.*/
  84
  85         SYSTEM_SETTINGS_KEY_DEVICE_NAME,                                        /**< GET (string) Indicates device name. */
  86         SYSTEM_SETTINGS_KEY_MOTION_ENABLED,                                     /**< GET (bool) Indicates whether the device user has enabled the motion feature. */
  87         SYSTEM_SETTINGS_KEY_NETWORK_WIFI_NOTIFICATION,          /**< GET (bool) Indicates whether Wi-Fi-related notifications are enabled on the device. */
  88         SYSTEM_SETTINGS_KEY_NETWORK_FLIGHT_MODE,                        /**< GET (bool) Indicates whether the device is in the flight mode. */
  89         SYSTEM_SETTINGS_KEY_SCREEN_BACKLIGHT_TIME,                      /**< (int) Indicates the backlight time (in seconds). @internal The following values can be used: 15, 30, 60, 120, 300, and 600. */
  90
  91         SYSTEM_SETTINGS_KEY_SOUND_NOTIFICATION,                         /**< (string) Indicates the file path of the current notification tone set by the user. */
  92         SYSTEM_SETTINGS_KEY_SOUND_NOTIFICATION_REPETITION_PERIOD,       /**< (int) Indicates the time period for notification repetitions. */
  93         SYSTEM_SETTINGS_KEY_LOCK_STATE,         /**< (int) Indicates the current lock state */
  94         SYSTEM_SETTINGS_KEY_MAX,
  95
  96 } system_settings_key_e;
  97
  98 /**
  99  * @brief Enumeration for Idle Lock State
 100  * @since_tizen 2.3.1
 101  */
 102 typedef enum {
 103         SYSTEM_SETTINGS_LOCK_STATE_UNLOCK = 0, /**< Device is unlocked */
 104         SYSTEM_SETTINGS_LOCK_STATE_LOCK, /**< Device is locked */
 105         SYSTEM_SETTINGS_LOCK_STATE_LAUNCHING_LOCK /**< Device is being locked */
 106 } system_settings_idle_lock_state_e;
 107
 108
 109 /**
 110  * @brief Enumeration for font size.
 111  * @since_tizen 2.3
 112  */
 113 typedef enum {
 114         SYSTEM_SETTINGS_FONT_SIZE_SMALL = 0, /**< A small size */
 115         SYSTEM_SETTINGS_FONT_SIZE_NORMAL, /**< A normal size */
 116         SYSTEM_SETTINGS_FONT_SIZE_LARGE, /**< A large size */
 117         SYSTEM_SETTINGS_FONT_SIZE_HUGE, /**< A huge size */
 118         SYSTEM_SETTINGS_FONT_SIZE_GIANT, /**< A giant size */
 119 } system_settings_font_size_e;
 120
 121
 122 /**
 123  * @brief Called when the system settings changes.
 124  * @since_tizen 2.3
 125  * @param[in] key The key name of the system settings changed system settings
 126  * @param[in] user_data The user data passed from the callback registration function
 127  * @pre system_settings_set_changed_cb() will invoke this callback function.
 128  * @see system_settings_set_changed_cb()
 129  * @see system_settings_unset_changed_cb()
 130  */
 131 typedef void (*system_settings_changed_cb)(system_settings_key_e key, void *user_data);
 132
 133 /**
 134  * @platform
 135  * @brief Sets the system settings value associated with the given key as an integer.
 136  * @since_tizen 2.3
 137  * @privlevel platform
 138  * @privilege %http://tizen.org/privilege/systemsettings.admin
 139  * @param[in] key The key name of the system settings changed
 140  * @param[in] key The key name of the system settings
 141  * @param[out] value The new system settings value of the given key
 142  * @return @c 0 on success, otherwise a negative error value
 143  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 144  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 145  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 146  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 147  */
 148 int system_settings_set_value_int(system_settings_key_e key, int value);
 149
 150 /**
 151  * @brief Gets the system settings value associated with the given key as an integer.
 152  * @since_tizen 2.3
 153  * @param[in] key The key name of the system settings
 154  * @param[out] value The current system settings value of the given key
 155  * @return @c 0 on success, otherwise a negative error value
 156  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 157  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 158  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 159  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 160  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
 161  */
 162 int system_settings_get_value_int(system_settings_key_e key, int *value);
 163
 164
 165 /**
 166  * @platform
 167  * @brief Sets the system settings value associated with the given key as a boolean.
 168  * @since_tizen 2.3
 169  * @privlevel platform
 170  * @privilege %http://tizen.org/privilege/systemsettings.admin
 171  * @param[in] key The key name of the system settings
 172  * @param[out] value The new system settings value of the given key
 173  * @return @c 0 on success, otherwise a negative error value
 174  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 175  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 176  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 177  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 178  */
 179 int system_settings_set_value_bool(system_settings_key_e key, bool value);
 180
 181 /**
 182  * @brief Gets the system settings value associated with the given key as a boolean.
 183  * @since_tizen 2.3
 184  * @param[in] key The key name of the system settings
 185  * @param[out] value The current system settings value of the given key
 186  * @return @c 0 on success, otherwise a negative error value
 187  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 188  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 189  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 190  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 191  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
 192  */
 193 int system_settings_get_value_bool(system_settings_key_e key, bool *value);
 194
 195 /**
 196  * @platform
 197  * @brief Sets the system settings value associated with the given key as a string.
 198  * @since_tizen 2.3
 199  * @privlevel platform
 200  * @privilege %http://tizen.org/privilege/systemsettings.admin
 201  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for setting.
 202  * @param[in] key The key name of the system settings
 203  * @param[out] value The new system settings value of the given key
 204  * @return @c 0 on success, otherwise a negative error value
 205  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 206  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 207  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 208  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 209  */
 210 int system_settings_set_value_string(system_settings_key_e key, const char *value);
 211
 212 /**
 213  * @brief Gets the system settings value associated with the given key as a string.
 214  * @since_tizen 2.3
 215  * @remarks You must release @a value using free().
 216  * @param[in] key The key name of the system settings
 217  * @param[out] value The current system settings value of the given key
 218  * @return      0 on success, otherwise a negative error value
 219  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 220  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 221  * @retval      #SYSTEM_SETTINGS_ERROR_IO_ERROR Internal I/O error
 222  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 223  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
 224  */
 225 int system_settings_get_value_string(system_settings_key_e key, char **value);
 226
 227 /**
 228  * @brief Registers a change event callback for the given system settings key.
 229  * @since_tizen 2.3
 230  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for set_changed_cb.
 231  * @param[in] key The key name of the system settings
 232  * @param[in] callback The callback function to invoke
 233  * @param[in] user_data The user data to be passed to the callback function
 234  * @return      0 on success, otherwise a negative error value
 235  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 236  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 237  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 238  * @post system_settings_changed_cb() will be invoked.
 239  *
 240  * @see system_settings_unset_changed_cb()
 241  * @see system_settings_changed_cb()
 242  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
 243  *
 244 */
 245 int system_settings_set_changed_cb(system_settings_key_e key, system_settings_changed_cb callback, void *user_data);
 246
 247 /**
 248  * @brief Unregisters the callback function.
 249  * @since_tizen 2.3
 250  * @remarks #SYSTEM_SETTINGS_KEY_DEFAULT_FONT_TYPE is not available for set_changed_cb.
 251  * @param[in] key The key name of the system settings
 252  * @return      0 on success, otherwise a negative error value
 253  * @retval      #SYSTEM_SETTINGS_ERROR_NONE Successful
 254  * @retval      #SYSTEM_SETTINGS_ERROR_INVALID_PARAMETER Invalid parameter
 255  * @retval      #SYSTEM_SETTINGS_ERROR_PERMISSION_DENIED Permission violation error
 256  *
 257  * @see system_settings_set_changed_cb()
 258  * @warning %http://tizen.org/privilege/systemsettings (public level privilege) <b>MUST NOT</b> be declared to use this API since 2.3.1.
 259  */
 260 int system_settings_unset_changed_cb(system_settings_key_e key);
 261
 262
 263 /**
 264  * @}
 265  */
 266
 267
 268 #ifdef __cplusplus
 269 }
 270 #endif
 271
 272 #endif /* __TIZEN_SYSTEM_SYSTEM_SETTINGS_H__ */