boost::locale::generator Class Reference

the major class used for locale generation More...

#include <boost/locale/generator.hpp>

List of all members.

Public Member Functions

void categories (unsigned cats)
unsigned categories () const
void characters (unsigned chars)
unsigned characters () const
void octet_encoding (std::string const &encoding)
std::string octet_encoding () const
void add_messages_domain (std::string const &domain)
void set_default_messages_domain (std::string const &domain)
void clear_domains ()
void add_messages_path (std::string const &path)
void clear_paths ()
void clear_cache ()
void preload (std::string const &id)
void preload (std::string const &id, std::string const &encoding)
void preload (std::locale const &base, std::string const &id)
void preload (std::locale const &base, std::string const &id, std::string const &encoding)
std::locale generate (std::string const &id) const
std::locale generate (std::string const &id, std::string const &encoding) const
std::locale generate (std::locale const &base, std::string const &id) const
std::locale generate (std::locale const &base, std::string const &id, std::string const &encoding) const
std::locale get (std::string const &id) const
std::locale get (std::string const &id, std::string const &encoding) const
std::locale operator() (std::string const &id) const
std::locale operator() (std::string const &id, std::string const &encoding) const


Detailed Description

the major class used for locale generation

This class is used for specification of all parameters required for locale generation and caching. This class const member functions are thread safe if locale class implementation is thread safe.

Examples:

boundary.cpp, calendar.cpp, collate.cpp, conversions.cpp, hello.cpp, wboundary.cpp, wconversions.cpp, and whello.cpp.


Member Function Documentation

void boost::locale::generator::categories ( unsigned  cats  ) 

Set types of facets that should be generated, default all

unsigned boost::locale::generator::categories (  )  const

Get types of facets that should be generated, default all

void boost::locale::generator::characters ( unsigned  chars  ) 

Set the characters type for which the facets should be generated, default all supported

unsigned boost::locale::generator::characters (  )  const

Get the characters type for which the facets should be generated, default all supported

void boost::locale::generator::octet_encoding ( std::string const &  encoding  ) 

Set encoding used for 8-bit character encoding. Default is system default encoding

Examples:
calendar.cpp.

std::string boost::locale::generator::octet_encoding (  )  const

Get encoding used for 8-bit character encoding. Default is system default encoding

void boost::locale::generator::add_messages_domain ( std::string const &  domain  ) 

Add a new domain of messages that would be generated. It should be set in order to enable messages support.

void boost::locale::generator::set_default_messages_domain ( std::string const &  domain  ) 

Set default message domain. If this member was not called, the first added messages domain is used. If the domain domain is not added yet it is added.

void boost::locale::generator::clear_domains (  ) 

Remove all added domains from the list

void boost::locale::generator::add_messages_path ( std::string const &  path  ) 

Add a search path where dictionaries are looked in.

void boost::locale::generator::clear_paths (  ) 

Remove all added paths

void boost::locale::generator::clear_cache (  ) 

Remove all cached locales

void boost::locale::generator::preload ( std::string const &  id  ) 

Generate a locale with id id and put it in cache

void boost::locale::generator::preload ( std::string const &  id,
std::string const &  encoding 
)

Generate a locale with id id, encoding encoding and put it in cache

void boost::locale::generator::preload ( std::locale const &  base,
std::string const &  id 
)

Generate a locale with id id and put it in cache, use base as a locale for which all facets are added, instead of global one

void boost::locale::generator::preload ( std::locale const &  base,
std::string const &  id,
std::string const &  encoding 
)

Generate a locale with id id, encoding encoding and put it in cache, use base as a locale for which all facets are added, instead of global one

std::locale boost::locale::generator::generate ( std::string const &  id  )  const

Generate a locale with id id

Examples:
collate.cpp.

std::locale boost::locale::generator::generate ( std::string const &  id,
std::string const &  encoding 
) const

Generate a locale with id id, encoding encoding

std::locale boost::locale::generator::generate ( std::locale const &  base,
std::string const &  id 
) const

Generate a locale with id id, use base as a locale for which all facets are added, instead of global one

std::locale boost::locale::generator::generate ( std::locale const &  base,
std::string const &  id,
std::string const &  encoding 
) const

Generate a locale with id id, encoding encoding, use base as a locale for which all facets are added, instead of global one

std::locale boost::locale::generator::get ( std::string const &  id  )  const

Get a locale with id id from cache, if not found, generate one

std::locale boost::locale::generator::get ( std::string const &  id,
std::string const &  encoding 
) const

Get a locale with id id and encoding encoding from cache, if not found, generate one

std::locale boost::locale::generator::operator() ( std::string const &  id  )  const [inline]

Shortcut to get(id)

std::locale boost::locale::generator::operator() ( std::string const &  id,
std::string const &  encoding 
) const [inline]

Shortcut to get(id,encoding)


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

Generated on Thu Mar 18 23:02:03 2010 for Boost.Locale by doxygen 1.5.6