1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _RTL_LOCALE_H_ 25*b1cdbd2cSJim Jagielski #define _RTL_LOCALE_H_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <rtl/ustring.h> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #ifdef __cplusplus 30*b1cdbd2cSJim Jagielski extern "C" { 31*b1cdbd2cSJim Jagielski #endif 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski #ifdef SAL_W32 34*b1cdbd2cSJim Jagielski # pragma pack(push, 8) 35*b1cdbd2cSJim Jagielski #elif defined(SAL_OS2) 36*b1cdbd2cSJim Jagielski # pragma pack(push, 4) 37*b1cdbd2cSJim Jagielski #endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski /** 40*b1cdbd2cSJim Jagielski The implementation structur of a locale. Do not create this structure 41*b1cdbd2cSJim Jagielski direct. Only use the functions rtl_locale_register and 42*b1cdbd2cSJim Jagielski rtl_locale_setDefault. The strings Language, Country and Variant 43*b1cdbd2cSJim Jagielski are constants, so it is not necessary to acquire and release them. 44*b1cdbd2cSJim Jagielski */ 45*b1cdbd2cSJim Jagielski typedef struct _rtl_Locale 46*b1cdbd2cSJim Jagielski { 47*b1cdbd2cSJim Jagielski /** 48*b1cdbd2cSJim Jagielski Lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code. 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski rtl_uString * Language; 51*b1cdbd2cSJim Jagielski /** 52*b1cdbd2cSJim Jagielski uppercase two-letter ISO-3166 code. 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielski rtl_uString * Country; 55*b1cdbd2cSJim Jagielski /** 56*b1cdbd2cSJim Jagielski Lowercase vendor and browser specific code. 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielski rtl_uString * Variant; 59*b1cdbd2cSJim Jagielski /** 60*b1cdbd2cSJim Jagielski The merged hash value of the Language, Country and Variant strings. 61*b1cdbd2cSJim Jagielski */ 62*b1cdbd2cSJim Jagielski sal_Int32 HashCode; 63*b1cdbd2cSJim Jagielski } rtl_Locale; 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski #if defined( SAL_W32) || defined(SAL_OS2) 66*b1cdbd2cSJim Jagielski #pragma pack(pop) 67*b1cdbd2cSJim Jagielski #endif 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski /** 70*b1cdbd2cSJim Jagielski Register a locale from language, country and variant. 71*b1cdbd2cSJim Jagielski @param language lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code. 72*b1cdbd2cSJim Jagielski @param country uppercase two-letter ISO-3166 code. May be null. 73*b1cdbd2cSJim Jagielski @param variant vendor and browser specific code. May be null. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski rtl_Locale * SAL_CALL rtl_locale_register( const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** 78*b1cdbd2cSJim Jagielski Common method of getting the current default Locale. 79*b1cdbd2cSJim Jagielski Used for the presentation: menus, dialogs, etc. 80*b1cdbd2cSJim Jagielski Generally set once when your applet or application is initialized, 81*b1cdbd2cSJim Jagielski then never reset. (If you do reset the default locale, you 82*b1cdbd2cSJim Jagielski probably want to reload your GUI, so that the change is reflected 83*b1cdbd2cSJim Jagielski in your interface.) 84*b1cdbd2cSJim Jagielski <p>More advanced programs will allow users to use different locales 85*b1cdbd2cSJim Jagielski for different fields, e.g. in a spreadsheet. 86*b1cdbd2cSJim Jagielski <BR>Note that the initial setting will match the host system. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski rtl_Locale * SAL_CALL rtl_locale_getDefault(); 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** 91*b1cdbd2cSJim Jagielski Sets the default. 92*b1cdbd2cSJim Jagielski Normally set once at the beginning of applet or application, 93*b1cdbd2cSJim Jagielski then never reset. <code>setDefault</code> does not reset the host locale. 94*b1cdbd2cSJim Jagielski @param language lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code. 95*b1cdbd2cSJim Jagielski @param country uppercase two-letter ISO-3166 code. 96*b1cdbd2cSJim Jagielski @param variant vendor and browser specific code. See class description. 97*b1cdbd2cSJim Jagielski */ 98*b1cdbd2cSJim Jagielski void SAL_CALL rtl_locale_setDefault( const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant ); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski /** 101*b1cdbd2cSJim Jagielski Getter for programmatic name of field, 102*b1cdbd2cSJim Jagielski a lowercased two-letter ISO 639-1 or three-letter ISO 639-3 code. 103*b1cdbd2cSJim Jagielski @see #getDisplayLanguage 104*b1cdbd2cSJim Jagielski */ 105*b1cdbd2cSJim Jagielski rtl_uString * SAL_CALL rtl_locale_getLanguage( rtl_Locale * This ); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski /** 108*b1cdbd2cSJim Jagielski Getter for programmatic name of field, 109*b1cdbd2cSJim Jagielski an uppercased two-letter ISO-3166 code. 110*b1cdbd2cSJim Jagielski @see #getDisplayCountry 111*b1cdbd2cSJim Jagielski */ 112*b1cdbd2cSJim Jagielski rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This ); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski /** 115*b1cdbd2cSJim Jagielski Getter for programmatic name of field. 116*b1cdbd2cSJim Jagielski @see #getDisplayVariant 117*b1cdbd2cSJim Jagielski */ 118*b1cdbd2cSJim Jagielski rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This ); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski /** 121*b1cdbd2cSJim Jagielski Returns the hash code of the locale This. 122*b1cdbd2cSJim Jagielski */ 123*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL rtl_locale_hashCode( rtl_Locale * This ); 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski /** 126*b1cdbd2cSJim Jagielski Returns true if the locals are equal, otherwis false. 127*b1cdbd2cSJim Jagielski */ 128*b1cdbd2cSJim Jagielski sal_Int32 SAL_CALL rtl_locale_equals( rtl_Locale * This, rtl_Locale * obj ); 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski #ifdef __cplusplus 131*b1cdbd2cSJim Jagielski } 132*b1cdbd2cSJim Jagielski #endif 133*b1cdbd2cSJim Jagielski 134*b1cdbd2cSJim Jagielski #endif /* _RTL_LOCALE_H_ */ 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski 137