docs/user/locale/localeintro.dox

   1 /*!
   2 \page locale_intro Introduction to the Locale Kit
   3
   4 The Locale Kit provides a set of tools for internationalizing, localizing and
   5 translating your software. This includes not only replacing string with their
   6 translations at runtime, but also more complex tasks such as formatting numbers,
   7 dates, and times in a way that match the locale preferences of the user.
   8
   9 The main way to access locale data is through BLocaleRoster::Default(). This
  10 returns a global instance of the BLocaleRoster class, storing the data for
  11 localizing an application according to the user's preferred settings. Most of
  12 the time, you should be able to use the default BLocale object and its
  13 convenience methods to get things formatted according to the user preferences.
  14 However, you can also use the various formatter classes directly when you need
  15 a more advanced formatting.  For example, you may need to format a date with a
  16 fixed format in english for including in an e-mail header, as it is the only
  17 format accepted there.
  18
  19 Note that creating a new format is a costly operation. The idea is that you
  20 create your format object once and reuse it accross your application to format
  21 all the stuff that needs it.
  22
  23 */