boost/python
2
0
Fork 0
mirror of https://github.com/boostorg/python.git synced 2026-01-22 17:32:55 +00:00
Code Issues Projects Releases Wiki Activity

doc updates

Browse Source 
[SVN r14054]
This commit is contained in:
Dave Abrahams
2002-05-28 20:42:12 +00:00
parent 502094439c
commit b03dcfb7de
3 changed files with 186 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
doc/v2/reference.html
View File

@@ -17,8 +17,8 @@
<tr>
<td valign="top" width="300">
<h3><a href="http://www.boost.org"><img height="86" width=
"277" alt="C++ Boost" src="../../../../c++boost.gif" border="0">
</a></h3>
"277" alt="C++ Boost" src="../../../../c++boost.gif" border=
"0"></a></h3>
<td valign="top">
<h1 class="c1">Boost.Python</h1>
@@ -41,6 +41,9 @@
<dt><a href="#models_of_call_policies">Models of
CallPolicies</a>
<dt><a href="#models_of_result_converter">Models of
ResultConverter</a>
<dt><a href="#result_converter_generators">Models of
ResultConverterGenerator</a>
</dl>
@@ -48,31 +51,31 @@
<dt><a href="#type_conversion">To/From Python Type Conversion</a>
<dt><a href="#utility">Utility and Infrastructure</a>
</dl>
<hr>
<hr>
<!-- xxxxx -->
<h2><a name="concepts">Concepts</a></h2>
<dl class="index">
<dt><a href=
"CallPolicies.html#CallPolicies-concept">CallPolicies</a>
<dt><a href=
"Dereferenceable.html#Dereferenceable-concept">Dereferenceable</a>
<dl class="index">
<dt><a href=
"CallPolicies.html#CallPolicies-concept">CallPolicies</a>
<dt><a href=
"Dereferenceable.html#Extractor-concept">Extractor</a>
<dt><a href=
"Dereferenceable.html#Dereferenceable-concept">Dereferenceable</a>
<dt><a href=
"HolderGenerator.html#HolderGenerator-concept">HolderGenerator</a>
<dt><a href=
"Dereferenceable.html#Extractor-concept">Extractor</a>
<dt><a href=
"ResultConverter.html#ResultConverter-concept">ResultConverter</a>
<dt><a href=
"HolderGenerator.html#HolderGenerator-concept">HolderGenerator</a>
<dt><a href=
"ResultConverter.html#ResultConverterGenerator-concept">ResultConverterGenerator</a>
</dl>
<dt><a href=
"ResultConverter.html#ResultConverter-concept">ResultConverter</a>
<dt><a href=
"ResultConverter.html#ResultConverterGenerator-concept">ResultConverterGenerator</a>
</dl>
<h2><a name="high_level">High Level Components</a></h2>
@@ -330,6 +333,38 @@
</dl>
</dl>
</dl>
<a name="models_of_result_converter"></a>
<h3>Models of ResultConverter</h3>
<dl class="index">
<dt><a href=
"to_python_indirect.html">to_python_indirect.hpp</a>
<dd>
<dl class="index">
<dt><a href="to_python_indirect.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"to_python_indirect.html#to_python_indirect-spec">to_python_indirect</a>
</dl>
</dl>
<dt><a href="to_python_value.html">to_python_value.hpp</a>
<dd>
<dl class="index">
<dt><a href="to_python_value.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"to_python_value.html#to_python_value-spec">to_python_value</a>
</dl>
</dl>
</dl>
<a name="result_converter_generators"></a>
<h3>Models of ResultConverterGenerator</h3>
@@ -353,6 +388,7 @@
<dt><a href=
"copy_non_const_reference.html">copy_non_const_reference.hpp</a>
<dd>
<dl class="index">
<dt><a href=
@@ -368,6 +404,7 @@
<dt><a href=
"manage_new_object.html">manage_new_object.hpp</a>
<dd>
<dl class="index">
<dt><a href="manage_new_object.html#classes">Classes</a>
@@ -381,6 +418,7 @@
<dt><a href=
"reference_existing_object.html">reference_existing_object.hpp</a>
<dd>
<dl class="index">
<dt><a href=
@@ -393,7 +431,6 @@
reference_existing_object</a>
</dl>
</dl>
</dl>
</dl>
@@ -427,22 +464,24 @@
</dl>
</dl>
<dt><a href=
"lvalue_from_pytype.html">lvalue_from_pytype.hpp</a>
<dt><a href="lvalue_from_pytype.html">lvalue_from_pytype.hpp</a>
<dd>
<dl class="index">
<dt><a href="lvalue_from_pytype.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href="lvalue_from_pytype.html#classes">Classes</a>
<dt><a href=
"lvalue_from_pytype.html#lvalue_from_pytype-spec">lvalue_from_pytype</a>
<dd>
<dl class="index">
<dt><a href=
"lvalue_from_pytype.html#lvalue_from_pytype-spec">lvalue_from_pytype</a>
<dt><a href=
"lvalue_from_pytype.html#extract_identity-spec">extract_identity</a>
<dt><a href=
"lvalue_from_pytype.html#extract_member-spec">extract_member</a>
</dl>
<dt><a href=
"lvalue_from_pytype.html#extract_identity-spec">extract_identity</a>
<dt><a href=
"lvalue_from_pytype.html#extract_member-spec">extract_member</a>
</dl>
</dl>
<dt><a href=
"to_python_converter.html">to_python_converter.hpp</a>
@@ -458,42 +497,20 @@
</dl>
</dl>
<dt><a href="to_python_indirect.html">to_python_indirect.hpp</a>
<dd>
<dl class="index">
<dt><a href="to_python_indirect.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"to_python_indirect.html#to_python_indirect-spec">to_python_indirect</a>
</dl>
</dl>
<dt><a href="to_python_value.html">to_python_value.hpp</a>
<dd>
<dl class="index">
<dt><a href="to_python_value.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"to_python_value.html#to_python_value-spec">to_python_value</a>
</dl>
</dl>
<dt><a href="lvalue_from_python.html">type_from_python.hpp</a>
<dd>
<dl class="index">
<dt><a href="type_from_python.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"type_from_python.html#type_from_python-spec">type_from_python</a>
<dt><a href=
"type_from_python.html#identity_extractor-spec">identity_extractor</a>
<dt><a href=
"type_from_python.html#member_extractor-spec">member_extractor</a>
</dl>
@@ -529,21 +546,18 @@
</dl>
</dl>
<dt><a href=
"instance_holder.html">instance_holder.hpp</a>
<dt><a href="instance_holder.html">instance_holder.hpp</a>
<dd>
<dl class="index">
<dt><a href=
"instance_holder.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href="instance_holder.html#classes">Classes</a>
<dd>
<dl class="index">
<dt><a href=
"instance_holder.html#instance_holder-spec">
instance_holder</a>
</dl>
</dl>
<dd>
<dl class="index">
<dt><a href=
"instance_holder.html#instance_holder-spec">instance_holder</a>
</dl>
</dl>
<dt><a href="pointee.html">pointee.hpp</a>

2
doc/v2/to_python_converter.html
View File

@@ -146,7 +146,7 @@ struct tag_to_noddy
BOOST_PYTHON_MODULE_INIT(to_python_converter)
{
module to_python(&quot;to_python_converter&quot;)
module(&quot;to_python_converter&quot;)
.def(&quot;make_tag&quot;, make_tag)
;
to_python_converter&lt;tag, tag_to_noddy&gt;();

101
doc/v2/to_python_value.html Normal file
View File

@@ -0,0 +1,101 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" type="text/css" href="../boost.css">
<title>Boost.Python - &lt;boost/python/to_python_value.hpp&gt;</title>
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
"header">
<tr>
<td valign="top" width="300">
<h3><a href="../../../../index.htm"><img height="86" width="277" alt=
"C++ Boost" src="../../../../c++boost.gif" border="0"></a></h3>
<td valign="top">
<h1 align="center">Boost.Python</h1>
<h2 align="center">Header
&lt;boost/python/to_python_value.hpp&gt;</h2>
</table>
<hr>
<h2>Contents</h2>
<dl class="page-index">
<dt><a href="#classes">Classes</a>
<dd>
<dl class="page-index">
<dt><a href="#to_python_value-spec">Class
<code>to_python_value</code></a>
<dd>
<dl class="page-index">
<dt><a href="#to_python_value-spec-synopsis">Class template
<code>to_python_value</code> synopsis</a>
<dt><a href="#to_python_value-spec-observers">Class template
<code>to_python_value</code> observer functions</a>
</dl>
</dl>
</dl>
<hr>
<h2><a name="classes"></a>Classes</h2>
<h3><a name="to_python_value-spec"></a>Class template
<code>to_python_value</code></h3>
<p><code>to_python_value</code> is a model of <a href=
"ResultConverter.html#ResultConverter-concept">ResultConverter</a>
which copies its argument into a new Python object.
<h4><a name="to_python_value-spec-synopsis"></a>Class
<code>to_python_value</code> synopsis</h4>
<pre>
namespace boost { namespace python
{
template &lt;class T&gt;
struct to_python_value
{
typedef typename <a href="../../../type_traits/index.htm#transformations">add_reference</a>&lt;
typename <a href="../../../type_traits/index.htm#transformations">add_const</a>&lt;T&gt;::type
&gt;::type argument_type;
static bool convertible();
PyObject* operator()(argument_type) const;
};
}}
</pre>
<h4><a name="to_python_value-spec-observers"></a>Class
<code>to_python_value</code> observers</h4>
<pre>
static bool convertible();
</pre>
<dl class="function-semantics">
<dt><b>Returns:</b> <code>true</code> iff a converter has been registered which can convert <code>T</code> to python by-value.
</dl>
<pre>
PyObject* operator()(argument_type x) const;
</pre>
<dl class="function-semantics">
<dt><b>Requires:</b> <code>convertible()&nbsp;==&nbsp;true</code>
<dt><b>Effects:</b> converts <code>x</code> to python
<dt><b>Returns:</b> the resulting Python object iff a converter for <code>T</code> has been registered, <code>0</code> otherwise.
</dl>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
15 February, 2002
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
<p><i>&copy; Copyright <a href="../../../../people/dave_abrahams.htm">Dave
Abrahams</a> 2002. All Rights Reserved.</i>