| Boost.Locale

- Main Page
- Modules
- Namespaces
- Classes
- Files
- Examples

- Class List
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions
boost::locale::info Class Reference

a facet that holds general information about locale More...

`#include <boost/locale/info.hpp>`

List of all members.

## Public Types

enum | string_propery { language_property, country_property, variant_property, encoding_property, name_property }
enum | integer_property { utf8_property }

## Public Member Functions

| info (size_t refs=0)
std::string | language () const
std::string | country () const
std::string | variant () const
std::string | encoding () const
std::string | name () const
bool | utf8 () const

## Static Public Attributes

static std::locale::id | id
| This member uniquely defines this facet, required by STL.

## Protected Member Functions

virtual std::string | get_string_property (string_propery v) const =0
virtual int | get_integer_property (integer_property v) const =0

## Detailed Description

a facet that holds general information about locale

This facet should be always created in order to make all Boost.Locale functions work

## Member Enumeration Documentation

enum boost::locale::info::integer_property

Integer information about locale

Enumerator:

  utf8_property | Non zero value if uses UTF-8 encoding.

enum boost::locale::info::string_propery

String information about the locale

Enumerator:

  language_property | ISO 639 language id.
  country_property | ISO 3166 country id.
  variant_property | Variant for locale.
  encoding_property | encoding name
  name_property | locale name

## Constructor & Destructor Documentation

boost::locale::info::info | ( | size_t | refs = `0` | ) | `[inline]`

Standard facet's constructor

## Member Function Documentation

std::string boost::locale::info::country | ( |  | ) | const`[inline]`

Get country name

std::string boost::locale::info::encoding | ( |  | ) | const`[inline]`

Get encoding

virtual int boost::locale::info::get_integer_property | ( | integer_property | v | ) | const`[protected, pure virtual]`

Get integer property by its id v

virtual std::string boost::locale::info::get_string_property | ( | string_propery | v | ) | const`[protected, pure virtual]`

Get string property by its id v

std::string boost::locale::info::language | ( |  | ) | const`[inline]`

Get language name

std::string boost::locale::info::name | ( |  | ) | const`[inline]`

Get the name of the locale, like en_US.UTF-8

bool boost::locale::info::utf8 | ( |  | ) | const`[inline]`

True if the underlying encoding is UTF-8 (for char streams and strings)

std::string boost::locale::info::variant | ( |  | ) | const`[inline]`

Get locale variant

The documentation for this class was generated from the following file:

- boost/locale/info.hpp