/******************************************************************* Copyright © 1995 - 1998, 3Com Corporation or its subsidiaries ("3Com"). All rights reserved. This software may be copied and used solely for developing products for the Palm Computing platform and for archival and backup purposes. Except for the foregoing, no part of this software may be reproduced or transmitted in any form or by any means or used to make any derivative work (such as translation, transformation or adaptation) without express written consent from 3Com. 3Com reserves the right to revise this software and to make changes in content from time to time without obligation on the part of 3Com to provide notification of such revision or changes. 3COM MAKES NO REPRESENTATIONS OR WARRANTIES THAT THE SOFTWARE IS FREE OF ERRORS OR THAT THE SOFTWARE IS SUITABLE FOR YOUR USE. THE SOFTWARE IS PROVIDED ON AN "AS IS" BASIS. 3COM MAKES NO WARRANTIES, TERMS OR CONDITIONS, EXPRESS OR IMPLIED, EITHER IN FACT OR BY OPERATION OF LAW, STATUTORY OR OTHERWISE, INCLUDING WARRANTIES, TERMS, OR CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND SATISFACTORY QUALITY. TO THE FULL EXTENT ALLOWED BY LAW, 3COM ALSO EXCLUDES FOR ITSELF AND ITS SUPPLIERS ANY LIABILITY, WHETHER BASED IN CONTRACT OR TORT (INCLUDING NEGLIGENCE), FOR DIRECT, INCIDENTAL, CONSEQUENTIAL, INDIRECT, SPECIAL, OR PUNITIVE DAMAGES OF ANY KIND, OR FOR LOSS OF REVENUE OR PROFITS, LOSS OF BUSINESS, LOSS OF INFORMATION OR DATA, OR OTHER FINANCIAL LOSS ARISING OUT OF OR IN CONNECTION WITH THIS SOFTWARE, EVEN IF 3COM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 3Com, HotSync, Palm Computing, and Graffiti are registered trademarks, and Palm III and Palm OS are trademarks of 3Com Corporation or its subsidiaries. IF THIS SOFTWARE IS PROVIDED ON A COMPACT DISK, THE OTHER SOFTWARE AND DOCUMENTATION ON THE COMPACT DISK ARE SUBJECT TO THE LICENSE AGREEMENT ACCOMPANYING THE COMPACT DISK. *------------------------------------------------------------------- * FileName: * Preferences.h * * Description: * Header for the system preferences * * History: * 2/31/95 rsf - Created by Roger Flores * *******************************************************************/ #ifndef __PREFERENCES_H__ #define __PREFERENCES_H__ /*********************************************************************** * Constants ***********************************************************************/ #define noPreferenceFound -1 #define preferenceDataVersion 4 #define defaultAutoOffDuration 2 // minutes // Obsolete after V20 #if EMULATION_LEVEL == EMULATION_NONE #define defaultSysSoundLevel slOn #define defaultGameSoundLevel slOn #define defaultAlarmSoundLevel slOn #else // EMULATION_LEVEL != EMULATION_NONE #define defaultSysSoundLevel slOff #define defaultGameSoundLevel slOff #define defaultAlarmSoundLevel slOn #endif #if EMULATION_LEVEL == EMULATION_NONE #define defaultSysSoundVolume sndMaxAmp #define defaultGameSoundVolume sndMaxAmp #define defaultAlarmSoundVolume sndMaxAmp #else // EMULATION_LEVEL != EMULATION_NONE #define defaultSysSoundVolume 0 #define defaultGameSoundVolume 0 #define defaultAlarmSoundVolume sndMaxAmp #endif typedef enum { cAustralia, cAustria, cBelgium, cBrazil, cCanada, cDenmark, cFinland, cFrance, cGermany, cHongKong, cIceland, cIreland, cItaly, cJapan, cLuxembourg, cMexico, cNetherlands, cNewZealand, cNorway, cSpain, cSweden, cSwitzerland, cUnitedKingdom, cUnitedStates } CountryType; #define countryFirst cAustralia #define countryLast cUnitedStates #define countryCount (countryLast - countryFirst + 1) typedef enum { tfColon, tfColonAMPM, // 1:00 pm tfColon24h, // 13:00 tfDot, tfDotAMPM, // 1.00 pm tfDot24h, // 13.00 tfHoursAMPM, // 1 pm tfHours24h, // 13 tfComma24h // 13,00 } TimeFormatType; typedef enum { dsNone, // Daylight Savings Time not observed dsUSA, // United States Daylight Savings Time dsAustralia, // Australian Daylight Savings Time dsWesternEuropean, // Western European Daylight Savings Time dsMiddleEuropean, // Middle European Daylight Savings Time dsEasternEuropean, // Eastern European Daylight Savings Time dsGreatBritain, // Great Britain and Eire Daylight Savings Time dsRumania, // Rumanian Daylight Savings Time dsTurkey, // Turkish Daylight Savings Time dsAustraliaShifted // Australian Daylight Savings Time with shift in 1986 } DaylightSavingsTypes; // pass a TimeFormatType #define Use24HourFormat(t) ((t) == tfColon24h || (t) == tfDot24h || (t) == tfHours24h || (t) == tfComma24h) #define TimeSeparator(t) ( t <= tfColon24h ? ':' : (t <= tfDot24h ? '.' : ',')) typedef enum { dfMDYWithSlashes, // 12/31/95 dfDMYWithSlashes, // 31/12/95 dfDMYWithDots, // 31.12.95 dfDMYWithDashes, // 31-12-95 dfYMDWithSlashes, // 95/12/31 dfYMDWithDots, // 95.12.31 dfYMDWithDashes, // 95-12-31 dfMDYLongWithComma, // Dec 31, 1995 dfDMYLong, // 31 Dec 1995 dfDMYLongWithDot, // 31. Dec 1995 dfDMYLongNoDay, // Dec 1995 dfDMYLongWithComma, // 31 Dec, 1995 dfYMDLongWithDot, // 1995.12.31 dfYMDLongWithSpace, // 1995 Dec 31 dfMYMed, // Dec '95 dfMYMedNoPost // Dec 95 (added for French 2.0 ROM) } DateFormatType; // The number format (thousands separator and decimal point). This defines // how numbers are formatted and not neccessarily currency numbers (i.e. Switzerland). typedef enum { nfCommaPeriod, nfPeriodComma, nfSpaceComma, nfApostrophePeriod, nfApostropheComma } NumberFormatType; // These sound levels must corrospond to positions in the popup lists // used by the preferences app. These are made obsolete after V20. The // loudness of the sound is now represented as a number from 0 to sndMaxAmp. typedef enum { slOn = 0, slOff = 1 } SoundLevelTypeV20; #define countryNameLength 20 #define currencyNameLength 20 #define currencySymbolLength 6 // An array of these structures (one per country) is kept in the system // resource. typedef struct { CountryType country; // Country the structure represents Char countryName[countryNameLength]; DateFormatType dateFormat; // Format to display date in DateFormatType longDateFormat; // Format to display date in Byte weekStartDay; // Sunday or Monday TimeFormatType timeFormat; // Format to display time in NumberFormatType numberFormat; // Format to display numbers in Char currencyName[currencyNameLength]; // Dollars Char currencySymbol[currencySymbolLength]; // $ Char uniqueCurrencySymbol[currencySymbolLength]; // US$ Byte currencyDecimalPlaces; // 2 for 1.00 DaylightSavingsTypes daylightSavings; // Type of daylight savings correction DWord minutesWestOfGMT; // minutes west of Greenwich } CountryPreferencesType; // The number format (thousands separator and decimal point). This defines // how numbers are formatted and not neccessarily currency numbers (i.e. Switzerland). typedef enum { alOff, // Never show an animation alEventsOnly, // Show an animation for an event alEventsAndRandom, // Also show random animation alEventsAndMoreRandom // Show random animations more frequently } AnimationLevelType; typedef enum { prefVersion, prefCountry, prefDateFormat, prefLongDateFormat, prefWeekStartDay, prefTimeFormat, prefNumberFormat, prefAutoOffDuration, prefSysSoundLevelV20, prefGameSoundLevelV20, prefAlarmSoundLevelV20, prefHidePrivateRecords, prefDeviceLocked, prefLocalSyncRequiresPassword, prefRemoteSyncRequiresPassword, prefSysBatteryKind, prefAllowEasterEggs, prefMinutesWestOfGMT, prefDaylightSavings, prefRonamaticChar, prefHard1CharAppCreator, // App creator for hard key #1 prefHard2CharAppCreator, // App creator for hard key #2 prefHard3CharAppCreator, // App creator for hard key #3 prefHard4CharAppCreator, // App creator for hard key #4 prefCalcCharAppCreator, // App creator for calculator soft key prefHardCradleCharAppCreator, // App creator for hard cradle key prefLauncherAppCreator, // App creator for launcher soft key prefSysPrefFlags, prefHardCradle2CharAppCreator, // App creator for 2nd hard cradle key prefAnimationLevel, prefSysSoundVolume, prefGameSoundVolume, prefAlarmSoundVolume, prefBeamReceive, // False turns off IR sniffing, sends still work. prefCalibrateDigitizerAtReset, // True makes the user calibrate at soft reset time prefSystemKeyboardID, // ID of the preferred keyboard resource prefDefSerialPlugIn // creator ID of the default serial plug-in } SystemPreferencesChoice; typedef struct { Word version; // Version of preference info // International preferences CountryType country; // Country the device is in DateFormatType dateFormat; // Format to display date in DateFormatType longDateFormat; // Format to display date in Byte weekStartDay; // Sunday or Monday TimeFormatType timeFormat; // Format to display time in NumberFormatType numberFormat; // Format to display numbers in // system preferences Byte autoOffDuration; // Time period before shutting off SoundLevelTypeV20 sysSoundLevel; // High, Med, Low, Off - error beeps SoundLevelTypeV20 alarmSoundLevel; // High, Med, Low, Off - alarm only Boolean hideSecretRecords; // True to not display records with // their secret bit attribute set Boolean deviceLocked; // Device locked until the system // password is entered Word sysPrefFlags; // Miscellaneous system pref flags // copied into the global GSysPrefFlags // at boot time. SysBatteryKind sysBatteryKind; // The type of batteries installed. This // is copied into the globals GSysbatteryKind // at boot time. } SystemPreferencesTypeV10; // Any entries added to this structure must be initialized in // Prefereces.c:GetPreferenceResource typedef struct { Word version; // Version of preference info // International preferences CountryType country; // Country the device is in DateFormatType dateFormat; // Format to display date in DateFormatType longDateFormat; // Format to display date in Byte weekStartDay; // Sunday or Monday TimeFormatType timeFormat; // Format to display time in NumberFormatType numberFormat; // Format to display numbers in // system preferences Byte autoOffDuration; // Time period in minutes before shutting off SoundLevelTypeV20 sysSoundLevelV20; // High, Med, Low, Off - error beeps SoundLevelTypeV20 gameSoundLevelV20; // game sound effects SoundLevelTypeV20 alarmSoundLevelV20; // High, Med, Low, Off - alarm only Boolean hideSecretRecords; // True to not display records with // their secret bit attribute set Boolean deviceLocked; // Device locked until the system // password is entered Boolean localSyncRequiresPassword; // User must enter password on Pilot Boolean remoteSyncRequiresPassword; // User must enter password on Pilot Word sysPrefFlags; // Miscellaneous system pref flags // copied into the global GSysPrefFlags // at boot time. Constants are // sysPrefFlagXXX defined in SystemPrv.h SysBatteryKind sysBatteryKind; // The type of batteries installed. This // is copied into the globals GSysbatteryKind // at boot time. DWord minutesWestOfGMT; // minutes west of Greenwich DaylightSavingsTypes daylightSavings; // Type of daylight savings correction UInt ronamaticChar; // character to generate from ronamatic stroke. // Typically it popups the onscreen keyboard. DWord hard1CharAppCreator; // creator of application to launch in response // to the hard button #1. Used by SysHandleEvent. DWord hard2CharAppCreator; // creator of application to launch in response // to the hard button #2. Used by SysHandleEvent. DWord hard3CharAppCreator; // creator of application to launch in response // to the hard button #3. Used by SysHandleEvent. DWord hard4CharAppCreator; // creator of application to launch in response // to the hard button #4. Used by SysHandleEvent. DWord calcCharAppCreator; // creator of application to launch in response // to the Calculator icon. Used by SysHandleEvent. DWord hardCradleCharAppCreator; // creator of application to launch in response // to the Cradle button. Used by SysHandleEvent. DWord launcherCharAppCreator; // creator of application to launch in response // to the launcher button. Used by SysHandleEvent. DWord hardCradle2CharAppCreator; // creator of application to launch in response // to the 2nd Cradle button. Used by SysHandleEvent. AnimationLevelType animationLevel; // amount of animation to display // Additions for V30. Word sysSoundVolume; // system amplitude (0 - sndMaxAmp) - taps, beeps Word gameSoundVolume; // game amplitude (0 - sndMaxAmp) - explosions Word alarmSoundVolume; // alarm amplitude (0 - sndMaxAmp) Boolean beamReceive; // False turns off IR sniffing, sends still work. Boolean calibrateDigitizerAtReset; // True makes the user calibrate at soft reset time Word systemKeyboardID; // ID of the preferred keyboard resource DWord defSerialPlugIn; // creator ID of the default serial plug-in } SystemPreferencesType; typedef SystemPreferencesType * SystemPreferencesPtr; //------------------------------------------------------------------- // Preferences routines //------------------------------------------------------------------- #ifdef __cplusplus extern "C" { #endif extern DmOpenRef PrefOpenPreferenceDBV10 (void) SYS_TRAP(sysTrapPrefOpenPreferenceDBV10); extern DmOpenRef PrefOpenPreferenceDB (Boolean saved) SYS_TRAP(sysTrapPrefOpenPreferenceDB); extern void PrefGetPreferences(SystemPreferencesPtr p) SYS_TRAP(sysTrapPrefGetPreferences); extern void PrefSetPreferences(SystemPreferencesPtr p) SYS_TRAP(sysTrapPrefSetPreferences); extern DWord PrefGetPreference(SystemPreferencesChoice choice) SYS_TRAP(sysTrapPrefGetPreference); extern void PrefSetPreference(SystemPreferencesChoice choice, DWord value) SYS_TRAP(sysTrapPrefSetPreference); extern SWord PrefGetAppPreferences (DWord creator, Word id, VoidPtr prefs, Word *prefsSize, Boolean saved) SYS_TRAP(sysTrapPrefGetAppPreferences); extern Boolean PrefGetAppPreferencesV10 (DWord type, SWord version, VoidPtr prefs, Word prefsSize) SYS_TRAP(sysTrapPrefGetAppPreferencesV10); extern void PrefSetAppPreferences (DWord creator, Word id, SWord version, VoidPtr prefs, Word prefsSize, Boolean saved) SYS_TRAP(sysTrapPrefSetAppPreferences); extern void PrefSetAppPreferencesV10 (DWord creator, SWord version, VoidPtr prefs, Word prefsSize) SYS_TRAP(sysTrapPrefSetAppPreferencesV10); #ifdef __cplusplus } #endif #endif // __PREFERENCES_H__