mirror of
https://github.com/boostorg/locale.git
synced 2026-02-23 15:52:15 +00:00
802f5d031d
- Fixed issues with inspector - Changed the use of boost::mutex - not include entire boost.thread - Updated documentation build script [SVN r73059]
185 lines
8.9 KiB
HTML
185 lines
8.9 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<title>Boost.Locale: Format</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
<!--
|
|
Switch the lines for stand alone version
|
|
<link rel="stylesheet" type="text/css" href="http://www.boost.org/style-v2/section-basic.css">
|
|
-->
|
|
<link rel="stylesheet" type="text/css" href="../style/section-basic.css">
|
|
</head>
|
|
<body>
|
|
<div id="boost-common-heading-doc">
|
|
<div class="heading-inner">
|
|
<div class="heading-placard"></div>
|
|
|
|
<h1 class="heading-title">
|
|
<a href="http://www.boost.org/">
|
|
<!--
|
|
Switch the lines for stand alone version
|
|
<img src="http://www.boost.org/gfx/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
|
|
-->
|
|
<img src="../style/space.png" alt= "Boost C++ Libraries" class="heading-logo" />
|
|
<span class="heading-boost">Boost</span>
|
|
<span class="heading-cpplibraries">C++ Libraries</span>
|
|
</a>
|
|
</h1>
|
|
|
|
<p class="heading-quote">
|
|
|
|
<q>...one of the most highly
|
|
regarded and expertly designed C++ library projects in the
|
|
world.</q>
|
|
|
|
<span class="heading-attribution">— <a href=
|
|
"http://www.gotw.ca/" class="external">Herb Sutter</a> and <a href=
|
|
"http://en.wikipedia.org/wiki/Andrei_Alexandrescu" class="external">Andrei
|
|
Alexandrescu</a>, <a href=
|
|
"http://safari.awprofessional.com/?XmlId=0321113586" class="external">C++
|
|
Coding Standards</a></span>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="boost-common-heading-doc-spacer"></div>
|
|
<!-- Generated by Doxygen 1.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<h1>Format</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr><td colspan="2"><h2><a name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::basic_format< CharType ></a></td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">a printf like class that allows type-safe and locale aware message formatting <a href="classboost_1_1locale_1_1basic__format.html#_details">More...</a><br/></td></tr>
|
|
<tr><td colspan="2"><h2><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef basic_format< char > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#gad7914df7b54382c1ad7f5360676fe2e8">boost::locale::format</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef basic_format< wchar_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga610f3ae827801febc962019cf82a2227">boost::locale::wformat</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef basic_format< char16_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga7e1b668f020290ebca6570b4c12a36e6">boost::locale::u16format</a></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">typedef basic_format< char32_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__format.html#ga70ce1d532e859739182439f1f3321032">boost::locale::u32format</a></td></tr>
|
|
<tr><td colspan="2"><h2><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr><td class="memTemplParams" colspan="2">template<typename CharType > </td></tr>
|
|
<tr><td class="memTemplItemLeft" align="right" valign="top">std::basic_ostream< CharType > & </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__format.html#ga1f24c2af23fab51855945ab2c6800278">boost::locale::operator<<</a> (std::basic_ostream< CharType > &out, basic_format< CharType > const &fmt)</td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>This module provides printf like functionality integrated into iostreams and suitable for localization </p>
|
|
<hr/><h2>Typedef Documentation</h2>
|
|
<a class="anchor" id="gad7914df7b54382c1ad7f5360676fe2e8"></a><!-- doxytag: member="boost::locale::format" ref="gad7914df7b54382c1ad7f5360676fe2e8" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef basic_format<char> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::format</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Definition of char based format </p>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="calendar_8cpp-example.html#a5">calendar.cpp</a>, and <a class="el" href="hello_8cpp-example.html#a1">hello.cpp</a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga7e1b668f020290ebca6570b4c12a36e6"></a><!-- doxytag: member="boost::locale::u16format" ref="ga7e1b668f020290ebca6570b4c12a36e6" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef basic_format<char16_t> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::u16format</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Definition of char16_t based format </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga70ce1d532e859739182439f1f3321032"></a><!-- doxytag: member="boost::locale::u32format" ref="ga70ce1d532e859739182439f1f3321032" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef basic_format<char32_t> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::u32format</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Definition of char32_t based format </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ga610f3ae827801febc962019cf82a2227"></a><!-- doxytag: member="boost::locale::wformat" ref="ga610f3ae827801febc962019cf82a2227" args="" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">typedef basic_format<wchar_t> <a class="el" href="classboost_1_1locale_1_1basic__format.html">boost::locale::wformat</a></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Definition of wchar_t based format </p>
|
|
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="whello_8cpp-example.html#a1">whello.cpp</a>.</dd>
|
|
</dl>
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Function Documentation</h2>
|
|
<a class="anchor" id="ga1f24c2af23fab51855945ab2c6800278"></a><!-- doxytag: member="boost::locale::operator<<" ref="ga1f24c2af23fab51855945ab2c6800278" args="(std::basic_ostream< CharType > &out, basic_format< CharType > const &fmt)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename CharType > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::basic_ostream<CharType>& boost::locale::operator<< </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::basic_ostream< CharType > & </td>
|
|
<td class="paramname"> <em>out</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">basic_format< CharType > const & </td>
|
|
<td class="paramname"> <em>fmt</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
<p>Write formatted message to stream.</p>
|
|
<p>This operator actually causes actual text formatting. It uses the locale of <em>out</em> stream </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr class="footer"/><address class="footer"><small>
|
|
© Copyright 2009-2011 Artyom Beilis, Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License</a>, Version 1.0.
|
|
</small></address>
|
|
</body>
|
|
</html>
|