<html> <head> <title>Interface XLocale</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XLocale-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">resource</a> :: </p> </td> </tr> <tr> <td class="title">interface XLocale</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>offers some operations on ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> structures.</dd> <dt><b>See also</b></dt> <dd><a href="XResourceBundle.html">XResourceBundle</a>, <a href="XLocale.html#Locale">Locale</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#create">create</a></td> <td class="imsum_right">creates a locale from language, country, and variant. </td> </tr> <tr> <td class="imsum_left"><a href="#getDefault">getDefault</a></td> <td class="imsum_right">the common method of getting the current default locale. </td> </tr> <tr> <td class="imsum_left"><a href="#setDefault">setDefault</a></td> <td class="imsum_right">sets the default locale for the whole environment. </td> </tr> <tr> <td class="imsum_left"><a href="#getAvailableLocales">getAvailableLocales</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getISOCountries">getISOCountries</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getISOLanguages">getISOLanguages</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getLanguagesForCountry">getLanguagesForCountry</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getISO3Language">getISO3Language</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getISO3Country">getISO3Country</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayLanguage_Default">getDisplayLanguage_Default</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayLanguage">getDisplayLanguage</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayCountry_Default">getDisplayCountry_Default</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayCountry">getDisplayCountry</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayVariant_Default">getDisplayVariant_Default</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayVariant">getDisplayVariant</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayName_Default">getDisplayName_Default</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#getDisplayName">getDisplayName</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#equals">equals</a></td> <td class="imsum_right"> </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="create" class="membertitle">create</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>create</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLanguage,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aCountry,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aVariant );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a locale from language, country, and variant. </dd> <dd><p>NOTE: ISO 639 is not a stable standard; some of the language codes it defines (specifically iw, ji, and in) have changed. This constructor accepts both the old codes (iw, ji, and in) and the new codes (he, yi, and id), but all other API on XLocale will return only the <b>NEW</b> codes. </p> <p>Note: The Java class <code>Locale</code> returns the <strong>old</strong> codes. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDefault" class="membertitle">getDefault</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> </tr> <tr> <td valign="top"><b>getDefault</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>the common method of getting the current default locale. </dd> <dd><p>It is used for the presentation (for menus, dialogs, etc.). It is, generally, set once when your applet or application is initialized, then never reset. (If you do reset the default locale, you probably want to reload your GUI, so that the change is reflected in your interface.) </p> <p>More advanced programs allow users to use different locales for different fields, for example, in a spreadsheet. <br>Note that the initial setting will match the host system.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setDefault" class="membertitle">setDefault</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setDefault</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> newLocale );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the default locale for the whole environment. </dd> <dd><p>It is normally set once at the beginning of an application, then never reset. <code>setDefault</code> does not reset the host locale. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAvailableLocales" class="membertitle">getAvailableLocales</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> ></td> </tr> <tr> <td valign="top"><b>getAvailableLocales</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of all locales which are available in the system. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getISOCountries" class="membertitle">getISOCountries</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getISOCountries</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of all ISO country codes known to the component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getISOLanguages" class="membertitle">getISOLanguages</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getISOLanguages</b>();</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence of all ISO language codes known to the component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLanguagesForCountry" class="membertitle">getLanguagesForCountry</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< string ></td> </tr> <tr> <td valign="top"><b>getLanguagesForCountry</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> country );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a sequence for language codes which are valid within the given country. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getISO3Language" class="membertitle">getISO3Language</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getISO3Language</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MissingResourceException.html">MissingResourceException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the ISO language code for the specified locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getISO3Country" class="membertitle">getISO3Country</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getISO3Country</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MissingResourceException.html">MissingResourceException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the ISO country code for the specified locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayLanguage_Default" class="membertitle">getDisplayLanguage_Default</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayLanguage_Default</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>language code for display of field to user. If the localized name is not found, returns the ISO code. The desired user language is from the default locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayLanguage" class="membertitle">getDisplayLanguage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayLanguage</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> inLocale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>language code for display of field to user. If the localized name is not found, returns the ISO codes. </dd> <dt><b>Parameter inLocale</b></dt> <dd>specifies the desired user language. </dd> <dt><b>Example</b></dt> <dd>"English (UK)", "Deutch", "Germany" </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayCountry_Default" class="membertitle">getDisplayCountry_Default</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayCountry_Default</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>country code for display of field to user. If the localized name is not found, returns the ISO code. The desired user country is from the default locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayCountry" class="membertitle">getDisplayCountry</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayCountry</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> inLocale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>country code for display of field to user. If the localized name is not found, returns the ISO codes. </dd> <dt><b>Parameter inLocale</b></dt> <dd>specifies the desired user country. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayVariant_Default" class="membertitle">getDisplayVariant_Default</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayVariant_Default</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>variant code for display of field to user. The desired user variant is from the default locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayVariant" class="membertitle">getDisplayVariant</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayVariant</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> inLocale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>variant code for display of field to user. If the localized name is not found, returns the ISO codes. </dd> <dt><b>Parameter inLocale</b></dt> <dd>specifies the desired user variant. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayName_Default" class="membertitle">getDisplayName_Default</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayName_Default</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a string to display the entire locale to user. If the localized name is not found, uses the ISO codes. The default locale is used for the presentation language. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDisplayName" class="membertitle">getDisplayName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">string</td> </tr> <tr> <td valign="top"><b>getDisplayName</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> locale,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> inLocale );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>a string to display the entire locale to user. If the localized name is not found, uses the ISO codes. </dd> <dt><b>Parameter inLocale</b></dt> <dd>specifies the desired user locale. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="equals" class="membertitle">equals</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>equals</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> l1,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td> <td valign="bottom"> l2 );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd><b>true</b> if the ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a> <var>l1</var> is equal to the other one. <p>A locale is deemed equal to another locale with identical language, country, and variant, and unequal to all other objects. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4747
