125 lines
5 KiB
Text
125 lines
5 KiB
Text
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: Locale.idl,v $
|
|
* $Revision: 1.12 $
|
|
*
|
|
* This file is part of OpenOffice.org.
|
|
*
|
|
* OpenOffice.org is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License version 3
|
|
* only, as published by the Free Software Foundation.
|
|
*
|
|
* OpenOffice.org is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License version 3 for more details
|
|
* (a copy is included in the LICENSE file that accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* version 3 along with OpenOffice.org. If not, see
|
|
* <http://www.openoffice.org/license.html>
|
|
* for a copy of the LGPLv3 License.
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_lang_Locale_idl__
|
|
#define __com_sun_star_lang_Locale_idl__
|
|
|
|
#include <com/sun/star/uno/XInterface.idl>
|
|
|
|
|
|
//=============================================================================
|
|
|
|
module com { module sun { module star { module lang {
|
|
|
|
//=============================================================================
|
|
|
|
// DocMerge from xml: struct com::sun::star::lang::Locale
|
|
/** object represents a specific geographical, political, or cultural region.
|
|
|
|
<p>An operation that requires a <code>Locale</code> to perform
|
|
its task is called <em>locale-sensitive</em> and uses the
|
|
<code>Locale</code> to tailor information for the user. For example,
|
|
displaying a number is a locale-sensitive operation; the number
|
|
should be formatted according to the customs/conventions of the
|
|
user's native country, region, or culture. </p>
|
|
|
|
<p> Because a <code>Locale</code> object is just an identifier for a
|
|
region, no validity check is performed. If you want to see whether
|
|
particular resources are available for the <code>Locale</code>, use
|
|
the <method scope="com::sun::star::resource">XLocale::getAvailableLocales</method> method to ask for the
|
|
locales it supports.</p>
|
|
|
|
<p> <strong>Note:</strong> When you ask for a resource for a
|
|
particular locale, you get the best available match, not necessarily
|
|
precisely what you asked for. For more information, see
|
|
<type scope="com::sun::star::resource">XResourceBundle</type>.</p>
|
|
|
|
<p> Each implementation that performs locale-sensitive operations
|
|
allows you to get all the available objects of that type. Use the
|
|
<typed scope="com::sun::star::resource">XLocale</type> interface to set the locale. </p>
|
|
*/
|
|
published struct Locale
|
|
{
|
|
// DocMerge from xml: field com::sun::star::lang::Locale::Language
|
|
/** specifies an <strong>ISO Language Code</strong>.
|
|
|
|
<p>These codes are the lower-case two-letter codes as defined by
|
|
ISO-639. You can find a full list of these codes at a number of
|
|
sites, such as: <br>
|
|
<a href="http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt">
|
|
<code>http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</code></a>.
|
|
</p>
|
|
|
|
<p>If this field contains an empty string, the meaning depends on the
|
|
context.</p>
|
|
*/
|
|
string Language;
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: field com::sun::star::lang::Locale::Country
|
|
/** specifies an <strong>ISO Country Code.</strong>
|
|
|
|
<p>These codes are the upper-case two-letter codes as
|
|
defined by ISO-3166. You can find a full list of these codes at a
|
|
number of sites, such as: <br>
|
|
<a href="http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html">
|
|
<code>http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</code></a>.
|
|
</p>
|
|
|
|
<p>If this field contains an empty string, the meaning depends on the
|
|
context.</p>
|
|
*/
|
|
string Country;
|
|
|
|
//-------------------------------------------------------------------------
|
|
|
|
// DocMerge from xml: field com::sun::star::lang::Locale::Variant
|
|
/** contains a variant of the locale; codes are vendor and
|
|
browser-specific.
|
|
|
|
<p>For example, use WIN for Windows, MAC for Macintosh, and POSIX
|
|
for POSIX. Wherever there are two variants, separate them with an
|
|
underscore, and put the most important one first. For example, a
|
|
traditional Spanish collation might construct a locale with parameters
|
|
for language, country and variant as: "es", "ES", "Traditional_WIN".</p>
|
|
*/
|
|
string Variant;
|
|
|
|
};
|
|
|
|
|
|
//=============================================================================
|
|
|
|
}; }; }; };
|
|
|
|
/*=============================================================================
|
|
|
|
=============================================================================*/
|
|
#endif
|