configuration.h revision e1c61d3cc8458ce9a15d8109f728e60f5248939d
1/* 2 * Copyright (C) 2010 The Android Open Source Project 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 ANDROID_CONFIGURATION_H 18#define ANDROID_CONFIGURATION_H 19 20#include <android/asset_manager.h> 21 22#ifdef __cplusplus 23extern "C" { 24#endif 25 26struct AConfiguration; 27typedef struct AConfiguration AConfiguration; 28 29enum { 30 ACONFIGURATION_ORIENTATION_ANY = 0x0000, 31 ACONFIGURATION_ORIENTATION_PORT = 0x0001, 32 ACONFIGURATION_ORIENTATION_LAND = 0x0002, 33 ACONFIGURATION_ORIENTATION_SQUARE = 0x0003, 34 35 ACONFIGURATION_TOUCHSCREEN_ANY = 0x0000, 36 ACONFIGURATION_TOUCHSCREEN_NOTOUCH = 0x0001, 37 ACONFIGURATION_TOUCHSCREEN_STYLUS = 0x0002, 38 ACONFIGURATION_TOUCHSCREEN_FINGER = 0x0003, 39 40 ACONFIGURATION_DENSITY_DEFAULT = 0, 41 ACONFIGURATION_DENSITY_LOW = 120, 42 ACONFIGURATION_DENSITY_MEDIUM = 160, 43 ACONFIGURATION_DENSITY_TV = 213, 44 ACONFIGURATION_DENSITY_HIGH = 240, 45 ACONFIGURATION_DENSITY_XHIGH = 320, 46 ACONFIGURATION_DENSITY_XXHIGH = 480, 47 ACONFIGURATION_DENSITY_NONE = 0xffff, 48 49 ACONFIGURATION_KEYBOARD_ANY = 0x0000, 50 ACONFIGURATION_KEYBOARD_NOKEYS = 0x0001, 51 ACONFIGURATION_KEYBOARD_QWERTY = 0x0002, 52 ACONFIGURATION_KEYBOARD_12KEY = 0x0003, 53 54 ACONFIGURATION_NAVIGATION_ANY = 0x0000, 55 ACONFIGURATION_NAVIGATION_NONAV = 0x0001, 56 ACONFIGURATION_NAVIGATION_DPAD = 0x0002, 57 ACONFIGURATION_NAVIGATION_TRACKBALL = 0x0003, 58 ACONFIGURATION_NAVIGATION_WHEEL = 0x0004, 59 60 ACONFIGURATION_KEYSHIDDEN_ANY = 0x0000, 61 ACONFIGURATION_KEYSHIDDEN_NO = 0x0001, 62 ACONFIGURATION_KEYSHIDDEN_YES = 0x0002, 63 ACONFIGURATION_KEYSHIDDEN_SOFT = 0x0003, 64 65 ACONFIGURATION_NAVHIDDEN_ANY = 0x0000, 66 ACONFIGURATION_NAVHIDDEN_NO = 0x0001, 67 ACONFIGURATION_NAVHIDDEN_YES = 0x0002, 68 69 ACONFIGURATION_SCREENSIZE_ANY = 0x00, 70 ACONFIGURATION_SCREENSIZE_SMALL = 0x01, 71 ACONFIGURATION_SCREENSIZE_NORMAL = 0x02, 72 ACONFIGURATION_SCREENSIZE_LARGE = 0x03, 73 ACONFIGURATION_SCREENSIZE_XLARGE = 0x04, 74 75 ACONFIGURATION_SCREENLONG_ANY = 0x00, 76 ACONFIGURATION_SCREENLONG_NO = 0x1, 77 ACONFIGURATION_SCREENLONG_YES = 0x2, 78 79 ACONFIGURATION_UI_MODE_TYPE_ANY = 0x00, 80 ACONFIGURATION_UI_MODE_TYPE_NORMAL = 0x01, 81 ACONFIGURATION_UI_MODE_TYPE_DESK = 0x02, 82 ACONFIGURATION_UI_MODE_TYPE_CAR = 0x03, 83 ACONFIGURATION_UI_MODE_TYPE_TELEVISION = 0x04, 84 ACONFIGURATION_UI_MODE_TYPE_APPLIANCE = 0x05, 85 86 ACONFIGURATION_UI_MODE_NIGHT_ANY = 0x00, 87 ACONFIGURATION_UI_MODE_NIGHT_NO = 0x1, 88 ACONFIGURATION_UI_MODE_NIGHT_YES = 0x2, 89 90 ACONFIGURATION_SCREEN_WIDTH_DP_ANY = 0x0000, 91 92 ACONFIGURATION_SCREEN_HEIGHT_DP_ANY = 0x0000, 93 94 ACONFIGURATION_SMALLEST_SCREEN_WIDTH_DP_ANY = 0x0000, 95 96 ACONFIGURATION_MCC = 0x0001, 97 ACONFIGURATION_MNC = 0x0002, 98 ACONFIGURATION_LOCALE = 0x0004, 99 ACONFIGURATION_TOUCHSCREEN = 0x0008, 100 ACONFIGURATION_KEYBOARD = 0x0010, 101 ACONFIGURATION_KEYBOARD_HIDDEN = 0x0020, 102 ACONFIGURATION_NAVIGATION = 0x0040, 103 ACONFIGURATION_ORIENTATION = 0x0080, 104 ACONFIGURATION_DENSITY = 0x0100, 105 ACONFIGURATION_SCREEN_SIZE = 0x0200, 106 ACONFIGURATION_VERSION = 0x0400, 107 ACONFIGURATION_SCREEN_LAYOUT = 0x0800, 108 ACONFIGURATION_UI_MODE = 0x1000, 109 ACONFIGURATION_SMALLEST_SCREEN_SIZE = 0x2000, 110}; 111 112/** 113 * Create a new AConfiguration, initialized with no values set. 114 */ 115AConfiguration* AConfiguration_new(); 116 117/** 118 * Free an AConfiguration that was previously created with 119 * AConfiguration_new(). 120 */ 121void AConfiguration_delete(AConfiguration* config); 122 123/** 124 * Create and return a new AConfiguration based on the current configuration in 125 * use in the given AssetManager. 126 */ 127void AConfiguration_fromAssetManager(AConfiguration* out, AAssetManager* am); 128 129/** 130 * Copy the contents of 'src' to 'dest'. 131 */ 132void AConfiguration_copy(AConfiguration* dest, AConfiguration* src); 133 134/** 135 * Return the current MCC set in the configuration. 0 if not set. 136 */ 137int32_t AConfiguration_getMcc(AConfiguration* config); 138 139/** 140 * Set the current MCC in the configuration. 0 to clear. 141 */ 142void AConfiguration_setMcc(AConfiguration* config, int32_t mcc); 143 144/** 145 * Return the current MNC set in the configuration. 0 if not set. 146 */ 147int32_t AConfiguration_getMnc(AConfiguration* config); 148 149/** 150 * Set the current MNC in the configuration. 0 to clear. 151 */ 152void AConfiguration_setMnc(AConfiguration* config, int32_t mnc); 153 154/** 155 * Return the current language code set in the configuration. The output will 156 * be filled with an array of two characters. They are not 0-terminated. If 157 * a language is not set, they will be 0. 158 */ 159void AConfiguration_getLanguage(AConfiguration* config, char* outLanguage); 160 161/** 162 * Set the current language code in the configuration, from the first two 163 * characters in the string. 164 */ 165void AConfiguration_setLanguage(AConfiguration* config, const char* language); 166 167/** 168 * Return the current country code set in the configuration. The output will 169 * be filled with an array of two characters. They are not 0-terminated. If 170 * a country is not set, they will be 0. 171 */ 172void AConfiguration_getCountry(AConfiguration* config, char* outCountry); 173 174/** 175 * Set the current country code in the configuration, from the first two 176 * characters in the string. 177 */ 178void AConfiguration_setCountry(AConfiguration* config, const char* country); 179 180/** 181 * Return the current ACONFIGURATION_ORIENTATION_* set in the configuration. 182 */ 183int32_t AConfiguration_getOrientation(AConfiguration* config); 184 185/** 186 * Set the current orientation in the configuration. 187 */ 188void AConfiguration_setOrientation(AConfiguration* config, int32_t orientation); 189 190/** 191 * Return the current ACONFIGURATION_TOUCHSCREEN_* set in the configuration. 192 */ 193int32_t AConfiguration_getTouchscreen(AConfiguration* config); 194 195/** 196 * Set the current touchscreen in the configuration. 197 */ 198void AConfiguration_setTouchscreen(AConfiguration* config, int32_t touchscreen); 199 200/** 201 * Return the current ACONFIGURATION_DENSITY_* set in the configuration. 202 */ 203int32_t AConfiguration_getDensity(AConfiguration* config); 204 205/** 206 * Set the current density in the configuration. 207 */ 208void AConfiguration_setDensity(AConfiguration* config, int32_t density); 209 210/** 211 * Return the current ACONFIGURATION_KEYBOARD_* set in the configuration. 212 */ 213int32_t AConfiguration_getKeyboard(AConfiguration* config); 214 215/** 216 * Set the current keyboard in the configuration. 217 */ 218void AConfiguration_setKeyboard(AConfiguration* config, int32_t keyboard); 219 220/** 221 * Return the current ACONFIGURATION_NAVIGATION_* set in the configuration. 222 */ 223int32_t AConfiguration_getNavigation(AConfiguration* config); 224 225/** 226 * Set the current navigation in the configuration. 227 */ 228void AConfiguration_setNavigation(AConfiguration* config, int32_t navigation); 229 230/** 231 * Return the current ACONFIGURATION_KEYSHIDDEN_* set in the configuration. 232 */ 233int32_t AConfiguration_getKeysHidden(AConfiguration* config); 234 235/** 236 * Set the current keys hidden in the configuration. 237 */ 238void AConfiguration_setKeysHidden(AConfiguration* config, int32_t keysHidden); 239 240/** 241 * Return the current ACONFIGURATION_NAVHIDDEN_* set in the configuration. 242 */ 243int32_t AConfiguration_getNavHidden(AConfiguration* config); 244 245/** 246 * Set the current nav hidden in the configuration. 247 */ 248void AConfiguration_setNavHidden(AConfiguration* config, int32_t navHidden); 249 250/** 251 * Return the current SDK (API) version set in the configuration. 252 */ 253int32_t AConfiguration_getSdkVersion(AConfiguration* config); 254 255/** 256 * Set the current SDK version in the configuration. 257 */ 258void AConfiguration_setSdkVersion(AConfiguration* config, int32_t sdkVersion); 259 260/** 261 * Return the current ACONFIGURATION_SCREENSIZE_* set in the configuration. 262 */ 263int32_t AConfiguration_getScreenSize(AConfiguration* config); 264 265/** 266 * Set the current screen size in the configuration. 267 */ 268void AConfiguration_setScreenSize(AConfiguration* config, int32_t screenSize); 269 270/** 271 * Return the current ACONFIGURATION_SCREENLONG_* set in the configuration. 272 */ 273int32_t AConfiguration_getScreenLong(AConfiguration* config); 274 275/** 276 * Set the current screen long in the configuration. 277 */ 278void AConfiguration_setScreenLong(AConfiguration* config, int32_t screenLong); 279 280/** 281 * Return the current ACONFIGURATION_UI_MODE_TYPE_* set in the configuration. 282 */ 283int32_t AConfiguration_getUiModeType(AConfiguration* config); 284 285/** 286 * Set the current UI mode type in the configuration. 287 */ 288void AConfiguration_setUiModeType(AConfiguration* config, int32_t uiModeType); 289 290/** 291 * Return the current ACONFIGURATION_UI_MODE_NIGHT_* set in the configuration. 292 */ 293int32_t AConfiguration_getUiModeNight(AConfiguration* config); 294 295/** 296 * Set the current UI mode night in the configuration. 297 */ 298void AConfiguration_setUiModeNight(AConfiguration* config, int32_t uiModeNight); 299 300/** 301 * Return the current configuration screen width in dp units, or 302 * ACONFIGURATION_SCREEN_WIDTH_DP_ANY if not set. 303 */ 304int32_t AConfiguration_getScreenWidthDp(AConfiguration* config); 305 306/** 307 * Set the configuration's current screen width in dp units. 308 */ 309void AConfiguration_setScreenWidthDp(AConfiguration* config, int32_t value); 310 311/** 312 * Return the current configuration screen height in dp units, or 313 * ACONFIGURATION_SCREEN_HEIGHT_DP_ANY if not set. 314 */ 315int32_t AConfiguration_getScreenHeightDp(AConfiguration* config); 316 317/** 318 * Set the configuration's current screen width in dp units. 319 */ 320void AConfiguration_setScreenHeightDp(AConfiguration* config, int32_t value); 321 322/** 323 * Return the configuration's smallest screen width in dp units, or 324 * ACONFIGURATION_SMALLEST_SCREEN_WIDTH_DP_ANY if not set. 325 */ 326int32_t AConfiguration_getSmallestScreenWidthDp(AConfiguration* config); 327 328/** 329 * Set the configuration's smallest screen width in dp units. 330 */ 331void AConfiguration_setSmallestScreenWidthDp(AConfiguration* config, int32_t value); 332 333/** 334 * Perform a diff between two configurations. Returns a bit mask of 335 * ACONFIGURATION_* constants, each bit set meaning that configuration element 336 * is different between them. 337 */ 338int32_t AConfiguration_diff(AConfiguration* config1, AConfiguration* config2); 339 340/** 341 * Determine whether 'base' is a valid configuration for use within the 342 * environment 'requested'. Returns 0 if there are any values in 'base' 343 * that conflict with 'requested'. Returns 1 if it does not conflict. 344 */ 345int32_t AConfiguration_match(AConfiguration* base, AConfiguration* requested); 346 347/** 348 * Determine whether the configuration in 'test' is better than the existing 349 * configuration in 'base'. If 'requested' is non-NULL, this decision is based 350 * on the overall configuration given there. If it is NULL, this decision is 351 * simply based on which configuration is more specific. Returns non-0 if 352 * 'test' is better than 'base'. 353 * 354 * This assumes you have already filtered the configurations with 355 * AConfiguration_match(). 356 */ 357int32_t AConfiguration_isBetterThan(AConfiguration* base, AConfiguration* test, 358 AConfiguration* requested); 359 360#ifdef __cplusplus 361}; 362#endif 363 364#endif // ANDROID_CONFIGURATION_H 365