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

doc update

Browse Source 
[SVN r15674]
This commit is contained in:
Dave Abrahams
2002-10-03 14:07:13 +00:00
parent 48fffd7a7b
commit 021aa51707
2 changed files with 239 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/v2/object.html
View File

@@ -631,9 +631,15 @@ proxy<object_slice> slice(T const& start; start, V const& finish);
<h3><a name="object-spec"></a>Class <code>object</code></h3>
<p>The intention is that <code>object</code> acts as much like a Python
variable as possible. Thus expressions you'd expect to work in Python
should generally work in the same way from C++.</p>
<p>The intention is that <code>object</code> acts as much like a
Python variable as possible. Thus expressions you'd expect to work
in Python should generally work in the same way from C++. Most of
<code>object</code>'s interface is provided by its base class
<code><a
href="#object_operators-spec">object_operators</a>&lt;object&gt;</code>,
and the <a href="#functions">free functions</a> defined in this
header.
</p>
<h4><a name="object-spec-synopsis"></a>Class <code>object</code>
synopsis</h4>

230
doc/v2/str.html Normal file
View File

@@ -0,0 +1,230 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Windows (vers 1st August 2002), 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/str.hpp&gt;</title>
</head>
<body>
<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>
<td valign="top">
<h1 align="center">Boost.Python</h1>
<h2 align="center">Header &lt;boost/python/str.hpp&gt;</h2>
</td>
</tr>
</table>
<hr>
<h2>Contents</h2>
<dl class="page-index">
<dt><a href="#introduction">Introduction</a></dt>
<dt><a href="#classes">Classes</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#str-spec">Class <code>str</code></a></dt>
<dd>
<dl class="page-index">
<dt><a href="#str-spec-synopsis">Class <code>str</code>
synopsis</a></dt>
</dl>
</dd>
</dl>
</dd>
<dt><a href="#examples">Example(s)</a></dt>
</dl>
<hr>
<h2><a name="introduction"></a>Introduction</h2>
<p>Exposes a <a href=
"ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> for the Python
<a href=
"http://www.python.org/dev/doc/devel/lib/string-methods.html">str</a>
type.</p>
<h2><a name="classes"></a>Classes</h2>
<h3><a name="str-spec"></a>Class <code>str</code></h3>
<p>Exposes the <a href=
"http://www.python.org/dev/doc/devel/lib/string-methods.html">string
methods</a> of Python's built-in <code>str</code> type. The
semantics of the constructors and member functions defined below
can be fully understood by reading the <a href=
"ObjectWrapper.html#TypeWrapper-concept">TypeWrapper</a> concept
definition. Since <code>str</code> is publicly derived from
<code><a href="object.html#object-spec">object</a></code>, the
public object interface applies to <code>str</code> instances as
well.</p>
<h4><a name="str-spec-synopsis"></a>Class <code>str</code>
synopsis</h4>
<pre>
namespace boost
{
class str : public object
{
public:
str(); // new str
str(const char* s); // new str
template &lt;class T&gt;
explicit str(T const&amp; other);
str capitalize() const;
template &lt;class T&gt;
str center(T const&amp; width) const;
template&lt;class T&gt;
long count(T const&amp; sub) const;
template&lt;class T1, class T2&gt;
long count(T1 const&amp; sub,T2 const&amp; start) const;
template&lt;class T1, class T2, class T3&gt;
long count(T1 const&amp; sub,T2 const&amp; start, T3 const&amp; end) const;
object decode() const;
template&lt;class T&gt;
object decode(T const&amp; encoding) const;
template&lt;class T1, class T2&gt;
object decode(T1 const&amp; encoding, T2 const&amp; errors) const;
object encode() const;
template &lt;class T&gt;
object encode(T const&amp; encoding) const;
template &lt;class T1, class T2&gt;
object encode(T1 const&amp; encoding, T2 const&amp; errors) const;
template &lt;class T&gt;
bool endswith(T const&amp; suffix) const;
template &lt;class T1, class T2&gt;
bool endswith(T1 const&amp; suffix, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
bool endswith(T1 const&amp; suffix, T2 const&amp; start, T3 const&amp; end) const;
str expandtabs() const;
template &lt;class T&gt;
str expandtabs(T const&amp; tabsize) const;
template &lt;class T&gt;
long find(T const&amp; sub) const;
template &lt;class T1, class T2&gt;
long find(T1 const&amp; sub, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
long find(T1 const&amp; sub, T2 const&amp; start, T3 const&amp; end) const;
template &lt;class T&gt;
long index(T const&amp; sub) const;
template &lt;class T1, class T2&gt;
long index(T1 const&amp; sub, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
long index(T1 const&amp; sub, T2 const&amp; start, T3 const&amp; end) const;
bool isalnum() const;
bool isalpha() const;
bool isdigit() const;
bool islower() const;
bool isspace() const;
bool istitle() const;
bool isupper() const;
template &lt;class T&gt;
str join(T const&amp; sequence) const;
template &lt;class T&gt;
str ljust(T const&amp; width) const;
str lower() const;
str lstrip() const;
template &lt;class T1, class T2&gt;
str replace(T1 const&amp; old, T2 const&amp; new_) const;
template &lt;class T1, class T2, class T3&gt;
str replace(T1 const&amp; old, T2 const&amp; new_, T3 const&amp; maxsplit) const;
template &lt;class T&gt;
long rfind(T const&amp; sub) const;
template &lt;class T1, class T2&gt;
long rfind(T1 const&amp; sub, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
long rfind(T1 const&amp; sub, T2 const&amp; start, T3 const&amp; end) const;
template &lt;class T&gt;
long rindex(T const&amp; sub) const;
template &lt;class T1, class T2&gt;
long rindex(T1 const&amp; sub, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
long rindex(T1 const&amp; sub, T2 const&amp; start, T3 const&amp; end) const;
template &lt;class T&gt;
str rjust(T const&amp; width) const;
str rstrip() const;
list split() const;
template &lt;class T&gt;
list split(T const&amp; sep) const;
template &lt;class T1, class T2&gt;
list split(T1 const&amp; sep, T2 const&amp; maxsplit) const;
list splitlines() const;
template &lt;class T&gt;
list splitlines(T const&amp; keepends) const;
template &lt;class T&gt;
bool startswith(T const&amp; prefix) const;
template &lt;class T1, class T2&gt;
bool startswidth(T1 const&amp; prefix, T2 const&amp; start) const;
template &lt;class T1, class T2, class T3&gt;
bool startswidth(T1 const&amp; prefix, T2 const&amp; start, T3 const&amp; end) const;
str strip() const;
str swapcase() const;
str title() const;
template &lt;class T&gt;
str translate(T const&amp; table) const;
template &lt;class T1, class T2&gt;
str translate(T1 const&amp; table, T2 const&amp; deletechars) const;
str upper() const;
};
}
</pre>
<h2><a name="examples"></a>Example</h2>
<pre>
using namespace boost::python;
str remove_angle_brackets(str x)
{
return x.strip('&lt;').strip('&gt;');
}
</pre>
<p>Revised 3 October, 2002</p>
<p><i>&copy; Copyright <a href=
"../../../../people/dave_abrahams.htm">Dave Abrahams</a> 2002. All Rights
Reserved.</i></p>
</body>
</html>