summaryrefslogtreecommitdiffstats
path: root/comphelper/inc
diff options
context:
space:
mode:
authorEike Rathke <erack@redhat.com>2013-03-28 01:36:40 +0100
committerEike Rathke <erack@redhat.com>2013-03-28 01:39:09 +0100
commit567a3ea42caa79ecdfcce6e9eaa2eac804d85653 (patch)
treec641be6675ca12cff6c1f8629e9c25edfb296b29 /comphelper/inc
parentunused comphelper/locale.hxx (diff)
downloadcore-567a3ea42caa79ecdfcce6e9eaa2eac804d85653.tar.gz
core-567a3ea42caa79ecdfcce6e9eaa2eac804d85653.zip
ditched now unused comphelper::Locale
Change-Id: Iddfce58d2cce01e777d51054f1a70c25ad06b15c
Diffstat (limited to 'comphelper/inc')
-rw-r--r--comphelper/inc/comphelper/locale.hxx370
1 files changed, 0 insertions, 370 deletions
diff --git a/comphelper/inc/comphelper/locale.hxx b/comphelper/inc/comphelper/locale.hxx
deleted file mode 100644
index 418fff34ffe2..000000000000
--- a/comphelper/inc/comphelper/locale.hxx
+++ /dev/null
@@ -1,370 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * This file is part of the LibreOffice project.
- *
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- * This file incorporates work covered by the following license notice:
- *
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed
- * with this work for additional information regarding copyright
- * ownership. The ASF licenses this file to you under the Apache
- * License, Version 2.0 (the "License"); you may not use this file
- * except in compliance with the License. You may obtain a copy of
- * the License at http://www.apache.org/licenses/LICENSE-2.0 .
- */
-
-#ifndef _COMPHELPER_LOCALE_HXX_
-#define _COMPHELPER_LOCALE_HXX_
-
-#include <vector>
-#include <rtl/ustring.hxx>
-#include "comphelper/comphelperdllapi.h"
-
-namespace comphelper{
-
-/** @short A Locale object represents a specific geographical, political, or cultural region.
-
- @descr This Locale class can be used to:
- - provide the different parts of a Locale (Language, Country, Variant)
- - converting it from/to ISO formated string values (like e.g. "en-US")
- - provide some predefined (static) Locale objects
- */
-class COMPHELPER_DLLPUBLIC Locale
-{
- public:
-
- /** @short seperates LANGUAGE and COUNTRY part of an ISO formated Locale. */
- static const sal_Unicode SEPERATOR_LC;
-
- /** @short seperates COUNTRY and VARIANT part of an ISO formated Locale. */
- static const sal_Unicode SEPERATOR_CV;
-
- /** @short seperates COUNTRY and VARIANT part of an ISO formated Locale.
- @descr Its true for some linux derivates only :-( */
- static const sal_Unicode SEPERATOR_CV_LINUX;
-
- /** @short some predefined Locale objects. */
- static const Locale EN_US();
- static const Locale X_DEFAULT();
- static const Locale X_NOTRANSLATE();
-
- //-------------------------------------------
- // types
-
- public:
-
- /** @short will be throw during convertion, if a Locale cant be interpreted. */
- struct MalFormedLocaleException
- {
- public:
- ::rtl::OUString Message;
-
- MalFormedLocaleException()
- {}
-
- MalFormedLocaleException(const ::rtl::OUString& sMessage)
- : Message(sMessage)
- {}
- };
-
- //-------------------------------------------
- // member
-
- private :
-
- //---------------------------------------
- /** @short must be a valid ISO Language Code.
-
- @descr 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">
- http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt</a>
- */
- ::rtl::OUString m_sLanguage;
-
- //---------------------------------------
- /** @short must be a valid ISO Country Code.
- @descr 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">
- http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html</a>
- */
- ::rtl::OUString m_sCountry;
-
- //---------------------------------------
- /** @short Variant codes are vendor and browser-specific.
- @descr For example, use WIN for Windows, MAC for Macintosh, and POSIX for POSIX.
- Where there are two variants, separate them with an underscore, and
- put the most important one first. For example, a Traditional Spanish collation
- might be referenced, with "ES", "ES", "Traditional_WIN".
- */
- ::rtl::OUString m_sVariant;
-
- //-------------------------------------------
- // interface
-
- public :
-
- //---------------------------------------
- /** @short needed by outside users!
-
- @descr Otherwise it wouldnt be possible to use
- any instance of such Locale static ...
- */
- Locale();
-
- //---------------------------------------
- /** @short construct a Locale from an ISO formated string value.
-
- @seealso fromISO()
-
- @param sISO
- an ISO formated string value, which can be parsed and
- tokenized into a Lamnguage, Country and Variant part.
-
- @throw MalFormedLocaleException
- if conversion failed.
- */
- Locale(const ::rtl::OUString& sISO)
- throw(MalFormedLocaleException);
-
- //---------------------------------------
- /** @short construct a Locale from language, country and variant.
-
- @seealso setLanguage()
- @seealso setCountry()
- @seealso setVariant()
-
- @param sLanguage
- lowercase two-letter ISO-639 code.
-
- @param sCountry
- uppercase two-letter ISO-3166 code.
-
- @param sVariant
- vendor and browser specific code.
- */
- Locale(const ::rtl::OUString& sLanguage ,
- const ::rtl::OUString& sCountry ,
- const ::rtl::OUString& sVariant = ::rtl::OUString());
-
- //---------------------------------------
- /** @short copy constructor.
-
- @param aCopy
- the copy object.
- */
- Locale(const Locale& aCopy);
-
- //---------------------------------------
- /** @short returns the language code for this locale.
-
- @descr That will either be the empty string or
- a lowercase ISO 639 code.
-
- @return [string]
- the language code.
- */
- ::rtl::OUString getLanguage() const;
-
- //---------------------------------------
- /** @short returns the country/region code for this locale.
-
- @descr That will either be the empty string or an
- upercase ISO 3166 2-letter code.
-
- @return [string]
- the country code.
- */
- ::rtl::OUString getCountry() const;
-
- //---------------------------------------
- /** @short returns the variant code for this locale.
-
- @return [string]
- the variant code.
- */
- ::rtl::OUString getVariant() const;
-
- //---------------------------------------
- /** @short set the new language code for this locale.
-
- @descr That will either be the empty string or
- a lowercase ISO 639 code.
-
- @param sLanguage
- the language code.
- */
- void setLanguage(const ::rtl::OUString& sLanguage);
-
- //---------------------------------------
- /** @short set the new country/region code for this locale.
-
- @descr That will either be the empty string or an
- upercase ISO 3166 2-letter code.
-
- @param sCountry
- the country code.
- */
- void setCountry(const ::rtl::OUString& sCountry);
-
- //---------------------------------------
- /** @short set the new variant code for this locale.
-
- @param sVariant
- the variant code.
- */
- void setVariant(const ::rtl::OUString& sVariant);
-
- //---------------------------------------
- /** @short take over new Locale information.
-
- @seealso Locale(const ::rtl::OUString& sISO)
-
- @param sISO
- an ISO formated string value, which can be parsed and
- tokenized into a Lamnguage, Country and Variant part.
- e.g. "en-US" or "en-US_WIN"
-
- @throw MalFormedLocaleException
- if conversion failed.
- */
- void fromISO(const ::rtl::OUString& sISO)
- throw(MalFormedLocaleException);
-
- //---------------------------------------
- /** @short converts this Locale to an ISO formated string value.
-
- @descr The different parts of this Locale will be assempled
- e.g. to "en-US" or "en-US_WIN"
-
- @return [string]
- the ISO formated string.
- */
- ::rtl::OUString toISO() const;
-
- //---------------------------------------
- /** @short check, if two Locale objects are equals.
-
- @descr All parts of a Locale (means Language, Country and Variant)
- will be checked.
-
- @param aComparable
- the Locale object for compare.
-
- @return [boolean]
- TRUE if both objects uses the same values for
- Language, Country and Variant.
- */
- sal_Bool equals(const Locale& aComparable) const;
-
- //---------------------------------------
- /** @short check, if two Locale objects
- uses the same language.
-
- @descr The Country and Variant parts of a Locale
- wont be checked here.
-
- @return [boolean]
- TRUE if both objects uses the same
- Language value.
- */
- sal_Bool similar(const Locale& aComparable) const;
-
- //---------------------------------------
- /** @short search for an equal or at least for a similar
- Locale in a list of possible ones.
-
- @descr First it searches for a Locale, which is equals
- to the reference Locale.
- (means: same Language, Country, Variant)
-
- If the reference Locale couldnt be located, it will
- tried again - but we are checking for "similar" Locales then.
- (means: same Language)
-
- If no similar Locale could be located, we search
- for a Locale "en-US" inside the given Locale list.
-
- If "en-US" could not be located, we search for
- a Locale "en" inside the given list.
-
- If no "same" nor any "similar" locale could be found,
- we try "x-default" and "x-notranslate" explicitly.
- Sometimes localized variables are optimized and doesnt use
- localzation realy. E.g. in case the localized value is a fix
- product name.
-
- If no locale match till now, we use any other existing
- locale, which exists inside the set of given ones!
-
- @seealso equals()
- @seealso similar()
-
- @param lISOList
- the list of possible Locales
- (as formated ISO strings).
-
- @param sReferenceISO
- the reference Locale, which should be searched
- if its equals or similar to any Locale inside
- the provided Locale list.
-
- @return An iterator, which points to the found element
- inside the given Locale list.
- If no matching Locale could be found, it points
- to the end of the list.
-
- @throw [MalFormedLocaleException]
- if at least one ISO formated string couldnt
- be converted to a valid Locale Object.
- */
- static ::std::vector< ::rtl::OUString >::const_iterator getFallback(const ::std::vector< ::rtl::OUString >& lISOList ,
- const ::rtl::OUString& sReferenceISO)
- throw(MalFormedLocaleException);
-
- //---------------------------------------
- /** @short assign elements of another locale
- to this instance.
-
- @param rCopy
- another locale object.
- */
- void operator=(const Locale& rCopy);
-
- //---------------------------------------
- /** @short check if two Locale objects are equals.
-
- @seealso equals()
-
- @param aComparable
- the Locale object for compare.
-
- @return [boolean]
- TRUE if both objects uses the same values for
- Language, Country and Variant.
- */
- sal_Bool operator==(const Locale& aComparable) const;
-
- //---------------------------------------
- /** @short check if two Locale objects are different.
-
- @param aComparable
- the Locale object for compare.
-
- @return [boolean]
- TRUE if at least one part of such Locale
- isnt the same.
- */
- sal_Bool operator!=(const Locale& aComparable) const;
-};
-
-} // namespace salhelper
-
-#endif // _COMPHELPER_LOCALE_HXX_
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */