|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
|
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
|
|
|
<head>
|
|
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
|
|
|
|
|
|
<title>SIP Reference Guide — SIP 4.10.5 Reference Guide</title>
|
|
|
|
|
<link rel="stylesheet" href="_static/default.css" type="text/css" />
|
|
|
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
|
<script type="text/javascript">
|
|
|
|
|
var DOCUMENTATION_OPTIONS = {
|
|
|
|
|
URL_ROOT: '#',
|
|
|
|
|
VERSION: '4.10.5',
|
|
|
|
|
COLLAPSE_MODINDEX: false,
|
|
|
|
|
FILE_SUFFIX: '.html',
|
|
|
|
|
HAS_SOURCE: true
|
|
|
|
|
};
|
|
|
|
|
</script>
|
|
|
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
|
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
|
|
|
<link rel="top" title="SIP 4.10.5 Reference Guide" href="#" />
|
|
|
|
|
<link rel="next" title="Introduction" href="introduction.html" />
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="related">
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
<a href="genindex.html" title="General Index"
|
|
|
|
|
accesskey="I">index</a></li>
|
|
|
|
|
<li class="right" >
|
|
|
|
|
<a href="modindex.html" title="Global Module Index"
|
|
|
|
|
accesskey="M">modules</a> |</li>
|
|
|
|
|
<li class="right" >
|
|
|
|
|
<a href="introduction.html" title="Introduction"
|
|
|
|
|
accesskey="N">next</a> |</li>
|
|
|
|
|
<li><a href="#">SIP 4.10.5 Reference Guide</a> »</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="document">
|
|
|
|
|
<div class="documentwrapper">
|
|
|
|
|
<div class="bodywrapper">
|
|
|
|
|
<div class="body">
|
|
|
|
|
|
|
|
|
|
<div class="section" id="sip-reference-guide">
|
|
|
|
|
<h1>SIP Reference Guide<a class="headerlink" href="#sip-reference-guide" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="introduction.html">Introduction</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="introduction.html#license">License</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="introduction.html#features">Features</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="introduction.html#sip-components">SIP Components</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="introduction.html#qt-support">TQt Support</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="incompatibilities.html">Potential Incompatibilities with Earlier Versions</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="incompatibilities.html#sip-v4-10-1">SIP v4.10.1</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="incompatibilities.html#sip-v4-8">SIP v4.8</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="incompatibilities.html#sip-v4-7-8">SIP v4.7.8</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="incompatibilities.html#sip-v4-7-3">SIP v4.7.3</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="incompatibilities.html#sip-v4-4">SIP v4.4</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="installation.html">Installation</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="installation.html#downloading">Downloading</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="installation.html#configuring">Configuring</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="installation.html#building">Building</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="using.html">Using SIP</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#a-simple-c-example">A Simple C++ Example</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#id7">A Simple C Example</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#a-more-complex-c-example">A More Complex C++ Example</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#ownership-of-objects">Ownership of Objects</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#types-and-meta-types">Types and Meta-types</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#lazy-type-attributes">Lazy Type Attributes</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#support-for-python-s-buffer-interface">Support for Python’s Buffer Interface</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#support-for-wide-characters">Support for Wide Characters</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#the-python-global-interpreter-lock">The Python Global Interpreter Lock</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="using.html#managing-incompatible-apis">Managing Incompatible APIs</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="command_line.html">The SIP Command Line</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="specification_files.html">SIP Specification Files</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="specification_files.html#syntax-definition">Syntax Definition</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="specification_files.html#variable-numbers-of-arguments">Variable Numbers of Arguments</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="specification_files.html#additional-sip-types">Additional SIP Types</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="specification_files.html#classic-division-and-true-division">Classic Division and True Division</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="directives.html">Directives</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="annotations.html">Annotations</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#argument-annotations">Argument Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#class-annotations">Class Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#mapped-type-annotations">Mapped Type Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#enum-annotations">Enum Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#exception-annotations">Exception Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#function-annotations">Function Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#license-annotations">License Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#typedef-annotations">Typedef Annotations</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="annotations.html#variable-annotations">Variable Annotations</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="c_api.html">C API for Handwritten Code</a><ul>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="c_api.html#generated-type-structures">Generated Type Structures</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="c_api.html#generated-type-objects">Generated Type Objects</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="c_api.html#generated-named-enum-type-objects">Generated Named Enum Type Objects</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="c_api.html#generated-derived-classes">Generated Derived Classes</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference external" href="c_api.html#generated-exception-objects">Generated Exception Objects</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="embedding.html">Using the C API when Embedding</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="python_api.html">Python API for Applications</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="build_system.html">The Build System</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="distutils.html">Building Your Extension with distutils</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference external" href="builtin.html">Builtin Modules and Custom Interpreters</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="sphinxsidebar">
|
|
|
|
|
<div class="sphinxsidebarwrapper">
|
|
|
|
|
<h4>Next topic</h4>
|
|
|
|
|
<p class="topless"><a href="introduction.html"
|
|
|
|
|
title="next chapter">Introduction</a></p>
|
|
|
|
|
<div id="searchbox" style="display: none">
|
|
|
|
|
<h3>Quick search</h3>
|
|
|
|
|
<form class="search" action="search.html" method="get">
|
|
|
|
|
<input type="text" name="q" size="18" />
|
|
|
|
|
<input type="submit" value="Go" />
|
|
|
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
|
|
|
<input type="hidden" name="area" value="default" />
|
|
|
|
|
</form>
|
|
|
|
|
<p class="searchtip" style="font-size: 90%">
|
|
|
|
|
Enter search terms or a module, class or function name.
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="clearer"></div>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="related">
|
|
|
|
|
<h3>Navigation</h3>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class="right" style="margin-right: 10px">
|
|
|
|
|
<a href="genindex.html" title="General Index"
|
|
|
|
|
>index</a></li>
|
|
|
|
|
<li class="right" >
|
|
|
|
|
<a href="modindex.html" title="Global Module Index"
|
|
|
|
|
>modules</a> |</li>
|
|
|
|
|
<li class="right" >
|
|
|
|
|
<a href="introduction.html" title="Introduction"
|
|
|
|
|
>next</a> |</li>
|
|
|
|
|
<li><a href="#">SIP 4.10.5 Reference Guide</a> »</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="footer">
|
|
|
|
|
© Copyright 2010 Riverbank Computing Limited.
|
|
|
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4.
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
