boost::locale Namespace Reference

This is the main namespace that encloses all localization classes. More...

Classes
class	collator_base
	a base class that included collation level flags More...
class	collator
	Collation facet. More...
struct	comparator
	This class can be used in STL algorithms and containers for comparison of strings with different level then primary. More...
class	date_time_error
	This error is thrown in case of invalid state that occurred. More...
struct	date_time_period
	This structure provides a pair period_type and amount. More...
class	date_time_period_set
	this class that represents a set of periods, More...
class	calendar
	this class provides an access to general calendar information. More...
class	date_time
	this class represents a date time and allows to perform various operation according to the locale settings. More...
class	date_time_duration
	This class represents a period: a pair of two date_time objects. More...
class	basic_format
	a printf like class that allows type-safe and locale aware message formatting More...
class	generator
	the major class used for locale generation More...
class	info
	a facet that holds general information about locale More...
struct	message
	This class represents a message that can be converted to specific locale message. More...
class	time_zone
	this class represents time zone and time zone related information More...
Namespaces
namespace	as
	This namespace includes all manipulators that can be used on IO streams.
namespace	boundary
	This namespae contains all operations required for boundary analysis of text.
namespace	conv
	Namespace that contains all functions related to character set conversion.
namespace	period
	Namespace that contains a enum that defines various periods like years, days.
Typedefs
typedef basic_format< char >	format
typedef basic_format< wchar_t >	wformat
Enumerations
enum	norm_type {   norm_nfd, norm_nfc, norm_nfkd, norm_nfkc,   norm_default = norm_nfc }
enum	character_facet_type {   char_facet = 1 << 0, wchar_t_facet = 1 << 1, char16_t_facet = 1 << 2, char32_t_facet = 1 << 3,   all_characters = 0xFFFF }
enum	locale_category_type {   collation_facet = 1 << 0, formatting_facet = 1 << 1, message_facet = 1 << 2, codepage_facet = 1 << 3,   all_categories = 0xFFFFFFFFu }
Functions
template<typename CharType>
std::codecvt< CharType, char, mbstate_t > *	create_codecvt (info const &inf)
template<typename CharType>
std::basic_string< CharType >	normalize (std::basic_string< CharType > const &str, norm_type n=norm_default)
template<typename CharType>
std::basic_string< CharType >	normalize (CharType const *str, norm_type n=norm_default)
template<typename CharType>
std::basic_string< CharType >	normalize (CharType const *begin, CharType const *end, norm_type n=norm_default)
template<typename CharType>
std::basic_string< CharType >	to_upper (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_upper (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_upper (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_lower (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_lower (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_lower (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_title (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_title (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	to_title (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	fold_case (std::basic_string< CharType > const &str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	fold_case (CharType const *str, std::locale const &loc=std::locale())
template<typename CharType>
std::basic_string< CharType >	fold_case (CharType const *begin, CharType const *end, std::locale const &loc=std::locale())
date_time_period	operator+ (period::period_type f)
date_time_period	operator- (period::period_type f)
date_time_period	operator* (period::period_type f, char v)
date_time_period	operator* (char v, period::period_type f)
date_time_period	operator* (char v, date_time_period f)
date_time_period	operator* (date_time_period f, char v)
date_time_period	operator* (period::period_type f, short int v)
date_time_period	operator* (short int v, period::period_type f)
date_time_period	operator* (short int v, date_time_period f)
date_time_period	operator* (date_time_period f, short int v)
date_time_period	operator* (period::period_type f, int v)
date_time_period	operator* (int v, period::period_type f)
date_time_period	operator* (int v, date_time_period f)
date_time_period	operator* (date_time_period f, int v)
date_time_period	operator* (period::period_type f, long int v)
date_time_period	operator* (long int v, period::period_type f)
date_time_period	operator* (long int v, date_time_period f)
date_time_period	operator* (date_time_period f, long int v)
date_time_period	operator* (period::period_type f, unsigned char v)
date_time_period	operator* (unsigned char v, period::period_type f)
date_time_period	operator* (unsigned char v, date_time_period f)
date_time_period	operator* (date_time_period f, unsigned char v)
date_time_period	operator* (period::period_type f, unsigned short int v)
date_time_period	operator* (unsigned short int v, period::period_type f)
date_time_period	operator* (unsigned short int v, date_time_period f)
date_time_period	operator* (date_time_period f, unsigned short int v)
date_time_period	operator* (period::period_type f, unsigned int v)
date_time_period	operator* (unsigned int v, period::period_type f)
date_time_period	operator* (unsigned int v, date_time_period f)
date_time_period	operator* (date_time_period f, unsigned int v)
date_time_period	operator* (period::period_type f, unsigned long int v)
date_time_period	operator* (unsigned long int v, period::period_type f)
date_time_period	operator* (unsigned long int v, date_time_period f)
date_time_period	operator* (date_time_period f, unsigned long int v)
date_time_period_set	operator+ (date_time_period_set const &a, date_time_period_set const &b)
date_time_period_set	operator- (date_time_period_set const &a, date_time_period_set const &b)
template<typename CharType>
std::basic_ostream< CharType > &	operator<< (std::basic_ostream< CharType > &out, date_time const &t)
template<typename CharType>
std::basic_istream< CharType > &	operator>> (std::basic_istream< CharType > &in, date_time &t)
date_time_duration	operator- (date_time const &later, date_time const &earlier)
template<typename CharType>
std::basic_ostream< CharType > &	operator<< (std::basic_ostream< CharType > &out, basic_format< CharType > const &fmt)
template<typename CharType>
std::basic_ostream< CharType > &	operator<< (std::basic_ostream< CharType > &out, message const &msg)
message	translate (char const *msg)
message	translate (char const *single, char const *plural, int n)
message	translate (std::string const &msg)
message	translate (std::string const &single, std::string const &plural, int n)
template<typename CharType>
std::basic_ostream< CharType > &	operator<< (std::basic_ostream< CharType > &out, time_zone const &tz)

---

Detailed Description

This is the main namespace that encloses all localization classes.

---

Enumeration Type Documentation

enum boost::locale::character_facet_type

a enum type that specifies the character type that locales can be generated for

Enumerator:

char_facet	8-bit character facets
wchar_t_facet	wide character facets
char16_t_facet	C++0x char16_t facets.
char32_t_facet	C++0x char32_t facets.
all_characters	Special mask -- generate all.

enum boost::locale::locale_category_type

a special enum used for more fine grained generation of facets

Enumerator:

collation_facet	Generate collation facets.
formatting_facet	Generate numbers, currency, date-time formatting facets.
message_facet	Generate message facets.
codepage_facet	Generate codepage conversion facets (derived from std::codecvt).
all_categories	Generate all of them.

---

Function Documentation

template<typename CharType>

std::codecvt<CharType,char,mbstate_t>* boost::locale::create_codecvt

(

info const &

inf

)

[inline]

This function creates std::codecvt facet suitable for embedding in locale class for codepage conversion.

Usually never called directly, generator class is used instead