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