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