LibreOffice
LibreOffice 24.2 SDK C/C++ API Reference
locale.h
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 
20 /*
21  * This file is part of LibreOffice published API.
22  */
23 
24 #ifndef INCLUDED_RTL_LOCALE_H
25 #define INCLUDED_RTL_LOCALE_H
26 
27 #include "sal/config.h"
28 
29 #include "rtl/ustring.h"
30 #include "sal/saldllapi.h"
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 #ifdef _WIN32
37 # pragma pack(push, 8)
38 #endif
39 
46 typedef struct _rtl_Locale
47 {
51  rtl_uString * Language;
55  rtl_uString * Country;
59  rtl_uString * Variant;
63  sal_Int32 HashCode;
64 } rtl_Locale;
65 
66 #if defined( _WIN32)
67 #pragma pack(pop)
68 #endif
69 
77  const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant );
78 
86 
100  const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant );
101 
107 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getLanguage( rtl_Locale * This );
108 
114 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This );
115 
120 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This );
121 
125 SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_locale_hashCode( rtl_Locale * This );
126 
130 SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_locale_equals( rtl_Locale * This, rtl_Locale * obj );
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 #endif // INCLUDED_RTL_LOCALE_H
137 
138 
139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
SAL_DLLPUBLIC rtl_uString * rtl_locale_getLanguage(rtl_Locale *This)
Getter for programmatic name of field, a lowercase two-letter ISO 639-1 or three-letter ISO 639-3 cod...
rtl_uString * Variant
Lowercase vendor and browser specific code.
Definition: locale.h:59
#define SAL_DLLPUBLIC
Definition: saldllapi.h:34
The implementation structure of a locale.
Definition: locale.h:46
SAL_DLLPUBLIC sal_Int32 rtl_locale_hashCode(rtl_Locale *This)
Returns the hash code of the locale This.
SAL_DLLPUBLIC rtl_uString * rtl_locale_getCountry(rtl_Locale *This)
Getter for programmatic name of field, an uppercased two-letter ISO-3166 code.
sal_Int32 HashCode
The merged hash value of the Language, Country and Variant strings.
Definition: locale.h:63
SAL_DLLPUBLIC sal_Int32 rtl_locale_equals(rtl_Locale *This, rtl_Locale *obj)
Returns true if the locals are equal, otherwise false.
sal_uInt16 sal_Unicode
Definition: types.h:123
struct _rtl_Locale rtl_Locale
The implementation structure of a locale.
SAL_DLLPUBLIC rtl_uString * rtl_locale_getVariant(rtl_Locale *This)
Getter for programmatic name of field.
SAL_DLLPUBLIC void rtl_locale_setDefault(const sal_Unicode *language, const sal_Unicode *country, const sal_Unicode *variant)
Sets the default.
rtl_uString * Country
uppercase two-letter ISO-3166 code.
Definition: locale.h:55
SAL_DLLPUBLIC rtl_Locale * rtl_locale_register(const sal_Unicode *language, const sal_Unicode *country, const sal_Unicode *variant)
Register a locale from language, country and variant.
rtl_uString * Language
Lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
Definition: locale.h:51
SAL_DLLPUBLIC rtl_Locale * rtl_locale_getDefault(void)
Common method of getting the current default Locale.