tdelocale.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1997 Stephan Kulow <coolo@kde.org>
    Copyright (C) 1999-2003 Hans Petter Bieker <bieker@kde.org>
    Copyright (c) 2002 Lukas Tinkl <lukas@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef _TDELOCALE_H
#define _TDELOCALE_H
 
#include <tqstring.h>
#include <tdelibs_export.h>
 
class TQStringList;
class TQTextCodec;
class TQDate;
class TQTime;
class TQDateTime;
 
class TDEGlobal;
class TDEConfig;
class TDEConfigBase;
class TDELocalePrivate;
class KCatalogue;
class KCalendarSystem;
 
#ifndef I18N_NOOP
#define I18N_NOOP(x) x
#endif
 
#ifndef I18N_NOOP2
#define I18N_NOOP2(comment,x) x
#endif
 
TDECORE_EXPORT TQString i18n(const char *text);
 
TDECORE_EXPORT TQString i18n(const char *comment, const char *text);
 
TDECORE_EXPORT TQString i18n(const char *singular, const char *plural, unsigned long n);
 
inline TQString tr2i18n(const char* message, const char* =0) {
  return i18n(message);
}
 
class TDECORE_EXPORT TDELocale
{
  friend class TDEGlobal; // for initInstance()
public:
  TDELocale( const TQString& catalog, TDEConfig *config = 0 );
 
  TDELocale( const TDELocale & rhs );
 
  TDELocale& operator= ( const TDELocale & rhs );
 
  ~TDELocale();
 
  TQString translate( const char *index ) const;
 
  TQString translate( const char *comment, const char *fallback) const;
 
  TQString translate( const char *singular, const char *plural,
             unsigned long n) const;
 
  bool setEncoding(int mibEnum);
 
  bool setLanguage(const TQString & language);
 
  bool setLanguage(const TQStringList & languages);
 
  bool setCountry(const TQString & country);
 
  enum SignPosition { ParensAround = 0, BeforeQuantityMoney = 1,
              AfterQuantityMoney = 2,
              BeforeMoney = 3, AfterMoney = 4 };
 
  TQString decimalSymbol() const;
 
  TQString thousandsSeparator() const;
 
  TQString currencySymbol() const;
 
  TQString monetaryDecimalSymbol() const;
 
  TQString monetaryThousandsSeparator() const;
 
  TQString positiveSign() const;
 
  TQString negativeSign() const;
 
  int fracDigits() const;
 
  bool positivePrefixCurrencySymbol() const;
 
  bool negativePrefixCurrencySymbol() const;
 
  SignPosition positiveMonetarySignPosition() const;
 
  SignPosition negativeMonetarySignPosition() const;
 
  TQString formatMoney(double num,
              const TQString & currency = TQString::null,
              int digits = -1) const;
 
  TQString formatNumber(double num, int precision = -1) const;
 
  TQString formatNumber(const TQString &numStr) const TDE_DEPRECATED;
 
  TQString formatNumber(const TQString &numStr, bool round, int precision) const;
 
  TQString formatLong(long num) const;
 
   bool nounDeclension() const;
 
  TQString formatDate(const TQDate &pDate, bool shortFormat = false) const;
 
  bool dateMonthNamePossessive() const;
 
  TQString formatTime(const TQTime &pTime, bool includeSecs, bool isDuration /*=false*/) const;
 
  TQString formatTime(const TQTime &pTime, bool includeSecs = false) const; // BIC: merge with above
 
  bool use12Clock() const;
 
  bool weekStartsMonday() const TDE_DEPRECATED; //### remove for KDE 4.0
 
  int weekStartDay() const;
 
  TQString monthName(int i, bool shortName = false) const TDE_DEPRECATED;
 
  TQString monthNamePossessive(int i, bool shortName = false) const TDE_DEPRECATED;
 
  TQString weekDayName(int i, bool shortName = false) const TDE_DEPRECATED;
 
  const KCalendarSystem * calendar() const;
 
  TQString calendarType() const;
 
  void setCalendar(const TQString & calendarType);
 
  TQString formatDateTime(const TQDateTime &pDateTime,
             bool shortFormat = true,
             bool includeSecs = false) const;
 
  double readMoney(const TQString &numStr, bool * ok = 0) const;
 
  double readNumber(const TQString &numStr, bool * ok = 0) const;
 
  TQDate readDate(const TQString &str, bool* ok = 0) const;
 
  TQDate readDate( const TQString &intstr, const TQString &fmt, bool* ok = 0) const;
 
  enum ReadDateFlags {
      NormalFormat = 1,
      ShortFormat = 2
  };
 
  TQDate readDate(const TQString &str, ReadDateFlags flags, bool *ok = 0) const;
 
  TQTime readTime(const TQString &str, bool* ok = 0) const;
 
  enum ReadTimeFlags {
      WithSeconds = 0, // default (no flag set)
      WithoutSeconds = 1
  }; // (maybe use this enum as a bitfield, if adding independent features?)
  TQTime readTime(const TQString &str, ReadTimeFlags flags, bool *ok = 0) const;
 
  TQString language() const;
 
  TQString country() const;
 
  TQStringList languagesTwoAlpha() const;
 
  TQStringList languageList() const;
 
  const char * encoding() const;
 
  int encodingMib() const;
  TQTextCodec * codecForEncoding() const;
 
  int fileEncodingMib() const;
 
  void setDateFormat(const TQString & format);
  void setDateFormatShort(const TQString & format);
  void setDateMonthNamePossessive(bool possessive);
  void setTimeFormat(const TQString & format);
 
  void setWeekStartsMonday(bool start) TDE_DEPRECATED; //### remove for KDE 4.0
 
  void setWeekStartDay(int day);
  TQString dateFormat() const;
  TQString dateFormatShort() const;
  TQString timeFormat() const;
 
  void setDecimalSymbol(const TQString & symbol);
  void setThousandsSeparator(const TQString & separator);
  void setPositiveSign(const TQString & sign);
  void setNegativeSign(const TQString & sign);
  void setPositiveMonetarySignPosition(SignPosition signpos);
  void setNegativeMonetarySignPosition(SignPosition signpos);
  void setPositivePrefixCurrencySymbol(bool prefix);
  void setNegativePrefixCurrencySymbol(bool prefix);
  void setFracDigits(int digits);
  void setMonetaryThousandsSeparator(const TQString & separator);
  void setMonetaryDecimalSymbol(const TQString & symbol);
  void setCurrencySymbol(const TQString & symbol);
 
  int pageSize() const;
 
  void setPageSize(int paperFormat);
 
  enum MeasureSystem { Metric, Imperial };
 
  MeasureSystem measureSystem() const;
 
  void setMeasureSystem(MeasureSystem value);
  
  void insertCatalogue(const TQString& catalog);
 
  void removeCatalogue(const TQString &catalog);
 
  void setActiveCatalogue(const TQString &catalog);
 
  TQString translateQt(const char *context,
              const char *sourceText,
              const char *message) const;
 
  TQStringList allLanguagesTwoAlpha() const;
 
  TQString twoAlphaToLanguageName(const TQString &code) const;
 
  TQStringList allCountriesTwoAlpha() const;
 
  TQString twoAlphaToCountryName(const TQString &code) const;
 
  static void splitLocale(const TQString & str,
              TQString & language,
              TQString & country,
              TQString & charset);
 
  static void setMainCatalogue(const char *catalog);
 
  static TQString langLookup(const TQString &fname, const char *rtype = "html");
 
  static TQString defaultLanguage();
 
  static TQString defaultCountry();
 
 
  static TQString _initLanguage(TDEConfigBase *config);
 
#ifdef KDE_NO_COMPAT
private:
#endif
  TQString formatMoney(const TQString &numStr) const TDE_DEPRECATED;
 
  TQString languages() const TDE_DEPRECATED;
 
  bool setCharset(const TQString & charset) TDE_DEPRECATED;
 
  TQString charset() const TDE_DEPRECATED;
 
protected:
  static void initInstance();
 
private:
  void initFormat(TDEConfig *config);
  
  void initMainCatalogues(const TQString & catalog);
  
  void initLanguageList(TDEConfig * config, bool useEnv);
 
  void initEncoding(TDEConfig * config);
 
  void initFileNameEncoding(TDEConfig *config);
 
  static TQCString encodeFileNameUTF8( const TQString & fileName );
 
  static TQString decodeFileNameUTF8( const TQCString & localFileName );
 
  void initCatalogue( KCatalogue & catalog );
 
  void doFormatInit() const;
 
  void initFormat();
 
  TQString translate_priv(const char *index,
             const char *text,
             const char ** original = 0,
             int* pluralType = 0) const;
 
  bool useDefaultLanguage() const;
 
  bool isLanguageInstalled(const TQString & language) const;
  
  void updateCatalogues( );
  
  void initPluralTypes( );
  int pluralType( const TQString & language );
  
  int pluralType( const KCatalogue& catalog );
  // const KCatalogue * catalog( const TQString & language, const TQString & name );
  
 
  static TQString catalogueFileName(const TQString & language,
                   const KCatalogue & catalog);
public:
   bool isApplicationTranslatedInto( const TQString & language);
   
private:
  // Numbers and money
  TQString m_decimalSymbol;
  TQString m_thousandsSeparator;
  TQString m_currencySymbol;
  TQString m_monetaryDecimalSymbol;
  TQString m_monetaryThousandsSeparator;
  TQString m_positiveSign;
  TQString m_negativeSign;
  int m_fracDigits;
  SignPosition m_positiveMonetarySignPosition;
  SignPosition m_negativeMonetarySignPosition;
 
  // Date and time
  TQString m_timeFormat;
  TQString m_dateFormat;
  TQString m_dateFormatShort;
 
  TQString m_language;
  TQString m_country;
 
  bool m_weekStartsMonday; //### remove for KDE 4.0
  bool m_positivePrefixCurrencySymbol;
  bool m_negativePrefixCurrencySymbol;
 
  TDELocalePrivate *d;
};
 
#endif