summaryrefslogtreecommitdiff
path: root/doc/source/c++
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2011-04-05 14:37:16 +0200
committerJulian Andres Klode <jak@debian.org>2011-04-05 14:37:16 +0200
commit4548cac388f26cec60f1cef028421db910385565 (patch)
tree6baf34bf0ac3cbc7e0737ff1ea0c3751b62332a5 /doc/source/c++
parentf7adc2d7205e2fdbff7d808e8e4c262b65e3e05d (diff)
downloadpython-apt-4548cac388f26cec60f1cef028421db910385565.tar.gz
Add apt_pkg.Group class, wrapping pkgCache::GrpIterator
Diffstat (limited to 'doc/source/c++')
-rw-r--r--doc/source/c++/api.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/source/c++/api.rst b/doc/source/c++/api.rst
index 97ab24d1..4922d272 100644
--- a/doc/source/c++/api.rst
+++ b/doc/source/c++/api.rst
@@ -389,6 +389,36 @@ Description (pkgCache::DescIterator)
Return the :ctype:`pkgCache::DescIterator` reference contained in the
Python object *object*.
+
+Group (pkgCache::GrpIterator)
+----------------------------------
+.. cvar:: PyTypeObject PyGroup_Type
+
+ The type object for :class:`apt_pkg.Group` objects.
+
+.. cfunction:: int PyGroup_Check(PyObject *object)
+
+ Check that the object *object* is an :class:`apt_pkg.Group` object, or
+ a subclass thereof.
+
+.. cfunction:: int PyGroup_CheckExact(PyObject *object)
+
+ Check that the object *object* is an :class:`apt_pkg.Group` object
+ and no subclass thereof.
+
+.. cfunction:: PyObject* PyGroup_FromCpp(pkgCache::GrpIterator &cpp, bool delete, PyObject *owner)
+
+ Create a new :class:`apt_pkg.Group` object from the :ctype:`pkgCache::GrpIterator`
+ reference given by the parameter *cpp*. If the parameter *delete* is
+ true, *cpp* will be deleted when the reference
+ count of the returned object reaches 0. The parameter *owner* should be
+ a PyObject of the type :cdata:`PyCache_Type`.
+
+.. cfunction:: pkgCache::GrpIterator& PyGroup_ToCpp(PyObject *object)
+
+ Return the :ctype:`pkgCache::GrpIterator` reference contained in the
+ Python object *object*.
+
Hashes (Hashes)
----------------------------------
.. cvar:: PyTypeObject PyHashes_Type