mirror of
https://github.com/boostorg/python.git
synced 2026-01-21 17:12:22 +00:00
482 lines
14 KiB
HTML
482 lines
14 KiB
HTML
<!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 - Reference</title>
|
|
|
|
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
|
|
"reference">
|
|
<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>
|
|
|
|
<td valign="top">
|
|
<h1 align="center">Boost.Python</h1>
|
|
|
|
<h2 align="center">Reference</h2>
|
|
</table>
|
|
<hr>
|
|
|
|
<h2>Contents</h2>
|
|
|
|
<dl class="Reference">
|
|
<dt><a href="#high_level">High Level Components</a>
|
|
|
|
<dt><a href="#models_of_call_policies">Models of CallPolicies</a>
|
|
|
|
<dt><a href="#return_handler_generators">Models of ReturnHandlerGenerator</a>
|
|
|
|
<dt><a href="#type_conversion">To/From Python Type Conversion</a>
|
|
|
|
<dt><a href="#by_name">Index By Name</a>
|
|
</dl>
|
|
<a name="high_level"></a>
|
|
|
|
<h2>High Level Components</h2>
|
|
|
|
<dl class="index">
|
|
<dd>
|
|
<a name="general_purpose"></a>
|
|
|
|
<h3>General Purpose</h3>
|
|
|
|
<dl class="index">
|
|
|
|
<dt><a href="call.html">call.hpp</a>
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="call.html#functions">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"call.html#call-spec">call</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="call_method.html">call_method.hpp</a>
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="call_method.html#functions">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"call_method.html#call_method-spec">call_method</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="class.html">class.hpp/class_fwd.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="class.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="class.html#class_-spec">class_</a>
|
|
|
|
<dt><a href="class.html#bases-spec">bases</a>
|
|
|
|
<dt><a href="class.html#args-spec">args</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="data_members.html">data_members.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="data_members.html#functions">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"data_members.html#make_getter-spec">make_getter</a>
|
|
|
|
<dt><a href=
|
|
"data_members.html#make_setter-spec">make_setter</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="errors.html">errors.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="errors.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"errors.html#error_already_set-spec">error_already_set</a>
|
|
</dl>
|
|
|
|
<dt><a href="errors.html#functions">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"errors.html#handle_exception-spec">handle_exception</a>
|
|
|
|
<dt><a href=
|
|
"errors.html#expect_non_null-spec">expect_non_null</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="make_function.html">make_function.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="make_function.html#classes">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"make_function.html#make_function-spec">make_function</a>
|
|
|
|
<dt><a href=
|
|
"make_.html#make_constructor-spec">make_constructor</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="module.html">module.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="module.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="module.html#module-spec">module</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="objects.html">objects.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="objects.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="objects.html#xxx-spec">not yet documented</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="reference_hpp.html">reference.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="reference_hpp.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="reference_hpp.html#reference-spec">reference</a>
|
|
</dl>
|
|
|
|
<dt><a href="reference_hpp.html#types">Types</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="reference_hpp.html#ref-spec">ref</a>
|
|
</dl>
|
|
</dl>
|
|
</dl>
|
|
|
|
|
|
<a name="models_of_call_policies"></a>
|
|
|
|
<h3>Models of CallPolicies</h3>
|
|
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"default_call_policies.html">default_call_policies.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="default_call_policies.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"default_call_policies.html#default_call_policies-spec">default_call_policies</a>
|
|
|
|
<dt><a href=
|
|
"default_call_policies.html#default_result_converter-spec">default_result_converter</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href=
|
|
"return_internal_reference.html">return_internal_reference.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="return_internal_reference.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"return_internal_reference.html#return_internal_reference-spec">
|
|
return_internal_reference</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="return_value_policy.html">return_value_policy.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="return_value_policy.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"return_value_policy.html#return_value_policy-spec">return_value_policy</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href=
|
|
"with_custodian_and_ward.html">with_custodian_and_ward.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="with_custodian_and_ward.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"with_custodian_and_ward.html#with_custodian_and_ward-spec">with_custodian_and_ward</a>
|
|
|
|
<dt><a href=
|
|
"with_custodian_and_ward.html#with_custodian_and_ward_postcall-spec">
|
|
with_custodian_and_ward_postcall</a>
|
|
</dl>
|
|
</dl>
|
|
</dl>
|
|
<a name="return_handler_generators"></a>
|
|
|
|
<h3>Models of ReturnHandlerGenerator</h3>
|
|
|
|
<dl class="index">
|
|
<dt><a href="copy_const_reference.html">copy_const_reference.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="copy_const_reference.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"copy_const_reference.html#copy_const_reference-spec">copy_const_reference</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href=
|
|
"copy_non_const_reference.html">copy_non_const_reference.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="copy_non_const_reference.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"copy_non_const_reference.html#copy_non_const_reference-spec">
|
|
copy_non_const_reference</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<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>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"manage_new_object.html#manage_new_object-spec">manage_new_object</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href=
|
|
"reference_existing_object.html">reference_existing_object.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="reference_existing_object.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"reference_existing_object.html#reference_existing_object-spec">
|
|
reference_existing_object</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href=
|
|
"lvalue_from_python.html">reference_from_python.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="lvalue_from_python.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"lvalue_from_python.html#reference_from_python-spec">reference_from_python</a>
|
|
|
|
<dt><a href=
|
|
"lvalue_from_python.html#get_member-spec">get_member</a>
|
|
</dl>
|
|
</dl>
|
|
</dl>
|
|
|
|
<a name="type_conversion"></a>
|
|
|
|
<h3>To/From Python Type Conversion</h3>
|
|
|
|
<dl class="index">
|
|
<dt><a href="from_python.html">from_python.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="from_python.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"from_python.html#from_python-spec">from_python</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="has_back_reference.html">has_back_reference.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="has_back_reference.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"has_back_reference.html#has_back_reference-spec">has_back_reference</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="implicit.html">implicit.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="implicit.html#functions">Functions</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"implicit.html#implicitly_convertible-spec">implicitly_convertible</a>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="ptr.html">ptr.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="ptr.html#functions">Functions</a>
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="ptr.html#ptr-spec">ptr</a>
|
|
</dl>
|
|
|
|
<dt><a href="ptr.html#classes">Classes</a>
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="ptr.html#pointer_wrapper-spec">pointer_wrapper</a>
|
|
</dl>
|
|
|
|
<dt><a href="ptr.html#classes">MetaFunctions</a>
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="ptr.html#is_pointer_wrapper-spec">is_pointer_wrapper</a>
|
|
<dt><a href="ptr.html#unwrap_pointer-spec">unwrap_pointer</a>
|
|
</dl>
|
|
|
|
</dl>
|
|
|
|
<dt><a href="to_python_converter.html">to_python_converter.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="to_python_converter.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"to_python_converter.html#to_python_converter-spec">to_python_converter</a>
|
|
</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="type_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>
|
|
</dl>
|
|
</dl>
|
|
|
|
<dt><a href="value_from_python.html">value_from_python.hpp</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href="value_from_python.html#classes">Classes</a>
|
|
|
|
<dd>
|
|
<dl class="index">
|
|
<dt><a href=
|
|
"value_from_python.html#value_from_python-spec">value_from_python</a>
|
|
</dl>
|
|
</dl>
|
|
</dl>
|
|
|
|
</dl>
|
|
<hr>
|
|
|
|
<p>Revised
|
|
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
|
|
05 November, 2002
|
|
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
|
|
|
|
|
|
<p><i>© Copyright <a href="../../../../people/dave_abrahams.htm">Dave
|
|
Abrahams</a> 2002. All Rights Reserved.</i>
|
|
|