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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Class template wrapped_formatter_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.wrap_formatter_hpp" title="Header &lt;boost/log/expressions/formatters/wrap_formatter.hpp&gt;">
   9 <link rel="prev" href="wrapped_formatter_actor.html" title="Class template wrapped_formatter_actor">
  10 <link rel="next" href="wrap_for_idm45711347617056.html" title="Function template wrap_formatter">
  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="wrapped_formatter_actor.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.wrap_formatter_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="wrap_for_idm45711347617056.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  17 </div>
  18 <div class="refentry">
  19 <a name="boost.log.expressions.wrapped_formatter_terminal"></a><div class="titlepage"></div>
  20 <div class="refnamediv">
  21 <h2><span class="refentrytitle">Class template wrapped_formatter_terminal</span></h2>
  22 <p>boost::log::expressions::wrapped_formatter_terminal</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.wrap_formatter_hpp" title="Header &lt;boost/log/expressions/formatters/wrap_formatter.hpp&gt;">boost/log/expressions/formatters/wrap_formatter.hpp</a>&gt;
  26
  27 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> FunT<span class="special">,</span> <span class="keyword">typename</span> CharT<span class="special">&gt;</span>
  28 <span class="keyword">class</span> <a class="link" href="wrapped_formatter_terminal.html" title="Class template wrapped_formatter_terminal">wrapped_formatter_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.wrapped_formatter_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="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.wrapped_formatter_terminal.string_type"></a><span class="identifier">string_type</span><span class="special">;</span>    <span class="comment">// String type. </span>
  33   <span class="keyword">typedef</span> <span class="identifier">basic_formatting_ostream</span><span class="special">&lt;</span> <span class="identifier">char_type</span> <span class="special">&gt;</span> <a name="boost.log.expressions.wrapped_formatter_terminal.stream_type"></a><span class="identifier">stream_type</span><span class="special">;</span>    <span class="comment">// Formatting stream type. </span>
  34   <span class="keyword">typedef</span> <span class="identifier">FunT</span>                                  <a name="boost.log.expressions.wrapped_formatter_terminal.function_type"></a><span class="identifier">function_type</span><span class="special">;</span>  <span class="comment">// Wrapped function type. </span>
  35   <span class="keyword">typedef</span> <span class="identifier">string_type</span>                           <a name="boost.log.expressions.wrapped_formatter_terminal.result_type"></a><span class="identifier">result_type</span><span class="special">;</span>    <span class="comment">// Formatter result type. </span>
  36
  37   <span class="comment">// <a class="link" href="wrapped_formatter_terminal.html#boost.log.expressions.wrapped_formatter_terminalconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <span class="keyword">explicit</span> <a class="link" href="wrapped_formatter_terminal.html#idm45711347620368-bb"><span class="identifier">wrapped_formatter_terminal</span></a><span class="special">(</span><span class="identifier">function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="wrapped_formatter_terminal.html#idm45711347618816-bb"><span class="identifier">wrapped_formatter_terminal</span></a><span class="special">(</span><a class="link" href="wrapped_formatter_terminal.html" title="Class template wrapped_formatter_terminal">wrapped_formatter_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  40
  41   <span class="comment">// <a class="link" href="wrapped_formatter_terminal.html#idm45711347628128-bb">public member functions</a></span>
  42   <span class="identifier">function_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a class="link" href="wrapped_formatter_terminal.html#idm45711347627568-bb"><span class="identifier">get_function</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  43   <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="wrapped_formatter_terminal.html#idm45711347626144-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="special">;</span>
  44   <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="wrapped_formatter_terminal.html#idm45711347623472-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>
  45 <span class="special">}</span><span class="special">;</span></pre></div>
  46 <div class="refsect1">
  47 <a name="idm45554744118192"></a><h2>Description</h2>
  48 <p>Formatter function wrapper terminal. </p>
  49 <div class="refsect2">
  50 <a name="idm45554744117472"></a><h3>
  51 <a name="boost.log.expressions.wrapped_formatter_terminalconstruct-copy-destruct"></a><code class="computeroutput">wrapped_formatter_terminal</code>
  52         public
  53        construct/copy/destruct</h3>
  54 <div class="orderedlist"><ol class="orderedlist" type="1">
  55 <li class="listitem">
  56 <pre class="literallayout"><span class="keyword">explicit</span> <a name="idm45711347620368-bb"></a><span class="identifier">wrapped_formatter_terminal</span><span class="special">(</span><span class="identifier">function_type</span> <span class="keyword">const</span> <span class="special">&amp;</span> fun<span class="special">)</span><span class="special">;</span></pre>Initializing construction. </li>
  57 <li class="listitem">
  58 <pre class="literallayout"><a name="idm45711347618816-bb"></a><span class="identifier">wrapped_formatter_terminal</span><span class="special">(</span><a class="link" href="wrapped_formatter_terminal.html" title="Class template wrapped_formatter_terminal">wrapped_formatter_terminal</a> <span class="keyword">const</span> <span class="special">&amp;</span> that<span class="special">)</span><span class="special">;</span></pre>Copy constructor. </li>
  59 </ol></div>
  60 </div>
  61 <div class="refsect2">
  62 <a name="idm45554744102608"></a><h3>
  63 <a name="idm45711347628128-bb"></a><code class="computeroutput">wrapped_formatter_terminal</code> public member functions</h3>
  64 <div class="orderedlist"><ol class="orderedlist" type="1">
  65 <li class="listitem">
  66 <pre class="literallayout"><span class="identifier">function_type</span> <span class="keyword">const</span>  <span class="special">&amp;</span> <a name="idm45711347627568-bb"></a><span class="identifier">get_function</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the wrapped function. </li>
  67 <li class="listitem">
  68 <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="idm45711347626144-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="special">;</span></pre>Invokation operator. </li>
  69 <li class="listitem">
  70 <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="idm45711347623472-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>
  71 </ol></div>
  72 </div>
  73 </div>
  74 </div>
  75 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  76 <td align="left"></td>
  77 <td align="right"><div class="copyright-footer">Copyright &#169; 2007-2016 Andrey Semashev<p>
  78         Distributed under the Boost Software License, Version 1.0. (See accompanying
  79         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>).
  80       </p>
  81 </div></td>
  82 </tr></table>
  83 <hr>
  84 <div class="spirit-nav">
  85 <a accesskey="p" href="wrapped_formatter_actor.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../expressions.html#header.boost.log.expressions.formatters.wrap_formatter_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="wrap_for_idm45711347617056.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  86 </div>
  87 </body>
  88 </html>