libs/log/doc/html/boost/log/expressions/format_terminal.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template format_terminal</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Log v2">
   8 <link rel="up" href="../../../expressions.html#header.boost.log.expressions.formatters.format_hpp" title="Header &lt;boost/log/expressions/formatters/format.hpp&gt;">
   9 <link rel="prev" href="format_d_idm45711347887344.html" title="Function template format_date_time">
  10 <link rel="next" href="format_idm45711347862720.html" title="Function template format">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td></tr></table>
  14 <hr>
  15 <div class="spirit-nav">
  16 <a accesskey="p" href="format_d_idm45711347887344.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.format_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="format_idm45711347862720.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.format_terminal"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template format_terminal</span></h2>
  22 <p>boost::log::expressions::format_terminal &#8212; Template expressions terminal node with Boost.Format-like formatter. </p>
  23 </div>
  24 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  25 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../expressions.html#header.boost.log.expressions.formatters.format_hpp" title="Header &lt;boost/log/expressions/formatters/format.hpp&gt;">boost/log/expressions/formatters/format.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="format_terminal.html" title="Class template format_terminal">format_terminal</a> <span class="special">{</span>
  29 <span class="keyword">public</span><span class="special">:</span>
  30   <span class="comment">// types</span>
  31   <span class="keyword">typedef</span> <span class="identifier">CharT</span>                          <a name="boost.log.expressions.format_terminal.char_type"></a><span class="identifier">char_type</span><span class="special">;</span>    <span class="comment">// Character type. </span>
  32   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                    <a name="boost.log.expressions.format_terminal.format_type"></a><span class="identifier">format_type</span><span class="special">;</span>  <span class="comment">// Boost.Format formatter type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_string</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.format_terminal.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>  <span class="comment">// String type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">format_type</span><span class="special">::</span><span class="identifier">pump</span>              <a name="boost.log.expressions.format_terminal.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>  <span class="comment">// Terminal result type. </span>
  35
  36   <span class="comment">// <a class="link" href="format_terminal.html#boost.log.expressions.format_terminalconstruct-copy-destruct">construct/copy/destruct</a></span>
  37   <span class="keyword">explicit</span> <a class="link" href="format_terminal.html#idm45711347865040-bb"><span class="identifier">format_terminal</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
  38   <a class="link" href="format_terminal.html#idm45711347863488-bb"><span class="identifier">format_terminal</span></a><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  39
  40   <span class="comment">// <a class="link" href="format_terminal.html#idm45711347868704-bb">public member functions</a></span>
  41   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a class="link" href="format_terminal.html#idm45711347868144-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span></a><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  42 <span class="special">}</span><span class="special">;</span></pre></div>
  43 <div class="refsect1">
  44 <a name="idm45554745683296"></a><h2>Description</h2>
  45 <div class="refsect2">
  46 <a name="idm45554745682880"></a><h3>
  47 <a name="boost.log.expressions.format_terminalconstruct-copy-destruct"></a><code class="computeroutput">format_terminal</code>
  48         public
  49        construct/copy/destruct</h3>
  50 <div class="orderedlist"><ol class="orderedlist" type="1">
  51 <li class="listitem">
  52 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711347865040-bb"></a><span class="identifier">format_terminal</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">char_type</span> <span class="special">*</span> format<span class="special">)</span><span class="special">;</span></pre>Initializing constructor. </li>
  53 <li class="listitem"><pre class="literallayout"><a name="idm45711347863488-bb"></a><span class="identifier">format_terminal</span><span class="special">(</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
  54 </ol></div>
  55 </div>
  56 <div class="refsect2">
  57 <a name="idm45554745669200"></a><h3>
  58 <a name="idm45711347868704-bb"></a><code class="computeroutput">format_terminal</code> public member functions</h3>
  59 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
  60 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> ContextT<span class="special">&gt;</span> <span class="identifier">result_type</span> <a name="idm45711347868144-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</span><span class="special">(</span><span class="identifier">ContextT</span> <span class="keyword">const</span> <span class="special">&amp;</span> ctx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Invokation operator. </li></ol></div>
  61 </div>
  62 </div>
  63 </div>
  64 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  65 <td align="left"></td>
  66 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  67         Distributed under the Boost Software License, Version 1.0. (See accompanying
  68         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
  69       </p>
  70 </div></td>
  71 </tr></table>
  72 <hr>
  73 <div class="spirit-nav">
  74 <a accesskey="p" href="format_d_idm45711347887344.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.format_hpp"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="format_idm45711347862720.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  75 </div>
  76 </body>
  77 </html>