include/rtl/locale.h

   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 #ifndef INCLUDED_RTL_LOCALE_H
  21 #define INCLUDED_RTL_LOCALE_H
  22
  23 #include "sal/config.h"
  24
  25 #include "rtl/ustring.h"
  26 #include "sal/saldllapi.h"
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif
  31
  32 #ifdef _WIN32
  33 #   pragma pack(push, 8)
  34 #endif
  35
  36 /**
  37     The implementation structure of a locale. Do not create this structure
  38     direct. Only use the functions rtl_locale_register and
  39     rtl_locale_setDefault. The strings Language, Country and Variant
  40     are constants, so it is not necessary to acquire and release them.
  41  */
  42 typedef struct _rtl_Locale
  43 {
  44     /**
  45          Lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
  46      */
  47     rtl_uString *   Language;
  48     /**
  49          uppercase two-letter ISO-3166 code.
  50      */
  51     rtl_uString *   Country;
  52     /**
  53          Lowercase vendor and browser specific code.
  54      */
  55     rtl_uString *   Variant;
  56     /**
  57          The merged hash value of the Language, Country and Variant strings.
  58      */
  59     sal_Int32       HashCode;
  60 } rtl_Locale;
  61
  62 #if defined( _WIN32)
  63 #pragma pack(pop)
  64 #endif
  65
  66 /**
  67     Register a locale from language, country and variant.
  68     @param language lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
  69     @param country uppercase two-letter ISO-3166 code. May be null.
  70     @param variant vendor and browser specific code. May be null.
  71  */
  72 SAL_DLLPUBLIC rtl_Locale * SAL_CALL rtl_locale_register(
  73         const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant );
  74
  75 /**
  76     Common method of getting the current default Locale.
  77
  78     @deprecated  LibreOffice itself does not use this anymore, and client code
  79     should not have good use for it either.  It may eventually be removed.
  80  */
  81 SAL_DLLPUBLIC rtl_Locale * SAL_CALL rtl_locale_getDefault(void);
  82
  83 /**
  84     Sets the default.
  85
  86     <code>setDefault</code> does not reset the host locale.
  87
  88     @param language lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
  89     @param country uppercase two-letter ISO-3166 code.
  90     @param variant vendor and browser specific code. See class description.
  91
  92     @deprecated  LibreOffice itself does not use this anymore, and client code
  93     should not have good use for it either.  It may eventually be removed.
  94  */
  95 SAL_DLLPUBLIC void SAL_CALL rtl_locale_setDefault(
  96         const sal_Unicode * language, const sal_Unicode * country, const sal_Unicode * variant );
  97
  98 /**
  99     Getter for programmatic name of field,
 100     a lowercase two-letter ISO 639-1 or three-letter ISO 639-3 code.
 101     @see getDisplayLanguage
 102  */
 103 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getLanguage( rtl_Locale * This );
 104
 105 /**
 106     Getter for programmatic name of field,
 107     an uppercased two-letter ISO-3166 code.
 108     @see getDisplayCountry
 109  */
 110 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getCountry( rtl_Locale * This );
 111
 112 /**
 113     Getter for programmatic name of field.
 114     @see getDisplayVariant
 115  */
 116 SAL_DLLPUBLIC rtl_uString * SAL_CALL rtl_locale_getVariant( rtl_Locale * This );
 117
 118 /**
 119     Returns the hash code of the locale This.
 120  */
 121 SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_locale_hashCode( rtl_Locale * This );
 122
 123 /**
 124     Returns true if the locals are equal, otherwise false.
 125  */
 126 SAL_DLLPUBLIC sal_Int32 SAL_CALL rtl_locale_equals( rtl_Locale * This, rtl_Locale * obj  );
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 #endif // INCLUDED_RTL_LOCALE_H
 133
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */