doc/html/boost/visitor_ptr.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Function template visitor_ptr</title>
   6 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../variant/reference.html#header.boost.variant.visitor_ptr_hpp" title="Header &lt;boost/variant/visitor_ptr.hpp&gt;">
  10 <link rel="prev" href="visitor_ptr_t.html" title="Class template visitor_ptr_t">
  11 <link rel="next" href="../variant/design.html" title="Design Overview">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
  16 <td align="center"><a href="../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="visitor_ptr_t.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.visitor_ptr_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="../variant/design.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.visitor_ptr"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Function template visitor_ptr</span></h2>
  30 <p>boost::visitor_ptr &#8212; Returns a visitor object that adapts function pointers for
  31         use as a static visitor.</p>
  32 </div>
  33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  34 <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="../variant/reference.html#header.boost.variant.visitor_ptr_hpp" title="Header &lt;boost/variant/visitor_ptr.hpp&gt;">boost/variant/visitor_ptr.hpp</a>&gt;
  35
  36 </span>
  37 <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> R<span class="special">,</span> <span class="keyword">typename</span> T<span class="special">&gt;</span> <a class="link" href="visitor_ptr_t.html" title="Class template visitor_ptr_t">visitor_ptr_t</a><span class="special">&lt;</span><span class="identifier">T</span><span class="special">,</span><span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">visitor_ptr</span><span class="special">(</span><span class="identifier">R</span> <span class="special">(</span><span class="special">*</span><span class="special">)</span><span class="special">(</span><span class="identifier">T</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre></div>
  38 <div class="refsect1">
  39 <a name="idp617090464"></a><h2>Description</h2>
  40 <p>Constructs and returns a
  41         <code class="computeroutput"><a class="link" href="visitor_ptr_t.html" title="Class template visitor_ptr_t">visitor_ptr_t</a></code> adaptor over the
  42         given function.</p>
  43 <div class="variablelist"><table border="0" class="variablelist compact">
  44 <colgroup>
  45 <col align="left" valign="top">
  46 <col>
  47 </colgroup>
  48 <tbody>
  49 <tr>
  50 <td><p><span class="term">Returns:</span></p></td>
  51 <td>Returns a <code class="computeroutput"><a class="link" href="visitor_ptr_t.html" title="Class template visitor_ptr_t">visitor_ptr_t</a></code>
  52           visitor object that, when applied, invokes the given
  53           function.</td>
  54 </tr>
  55 <tr>
  56 <td><p><span class="term">Throws:</span></p></td>
  57 <td>Will not throw. (Note, however, that the returned
  58         <a class="link" href="visitor_ptr_t.html" title="Class template visitor_ptr_t">visitor object</a> may
  59         throw when applied.)</td>
  60 </tr>
  61 </tbody>
  62 </table></div>
  63 </div>
  64 </div>
  65 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  66 <td align="left"></td>
  67 <td align="right"><div class="copyright-footer">Copyright &#169; 2002, 2003 Eric Friedman, Itay Maman<p>Distributed under the Boost Software License, Version 1.0.
  68     (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
  69     <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  70     </p>
  71 </div></td>
  72 </tr></table>
  73 <hr>
  74 <div class="spirit-nav">
  75 <a accesskey="p" href="visitor_ptr_t.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../variant/reference.html#header.boost.variant.visitor_ptr_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="../variant/design.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
  76 </div>
  77 </body>
  78 </html>