summaryrefslogtreecommitdiff
path: root/doc/source/c++/api.rst
diff options
context:
space:
mode:
authorJulian Andres Klode <jak@debian.org>2011-04-27 13:08:20 +0200
committerJulian Andres Klode <jak@debian.org>2011-04-27 13:08:20 +0200
commit6282a925c2e32aeaa342b789470a01b6dcf70890 (patch)
tree8d1e2dd556810263df517a6eed9ad615d8a98532 /doc/source/c++/api.rst
parent58cebce48503e2478f59cbfe0e1f9849156d6337 (diff)
downloadpython-apt-6282a925c2e32aeaa342b789470a01b6dcf70890.tar.gz
apt_pkg: Add OrderList, wanted for mancoosi (Closes: #623485)
Diffstat (limited to 'doc/source/c++/api.rst')
-rw-r--r--doc/source/c++/api.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/doc/source/c++/api.rst b/doc/source/c++/api.rst
index 25cfcd9e..63ed1599 100644
--- a/doc/source/c++/api.rst
+++ b/doc/source/c++/api.rst
@@ -622,6 +622,34 @@ IndexFile (pkgIndexFile)
Return the :ctype:`pkgIndexFile` pointer contained in the Python object
*object*.
+OrderList (pkgOrderList)
+---------------------------
+.. cvar:: PyTypeObject PyOrderList_Type
+
+ The type object for :class:`apt_pkg.OrderList` objects.
+
+.. cfunction:: int PyOrderList_Check(PyObject *object)
+
+ Check that the object *object* is an :class:`apt_pkg.OrderList` object, or
+ a subclass thereof.
+
+.. cfunction:: int PyOrderList_CheckExact(PyObject *object)
+
+ Check that the object *object* is an :class:`apt_pkg.OrderList` object
+ and no subclass thereof.
+
+.. cfunction:: PyObject* PyOrderList_FromCpp(pkgOrderList *cpp, bool delete, PyObject *owner)
+
+ Create a new :class:`apt_pkg.OrderList` object from the :ctype:`pkgOrderList`
+ pointer given by the parameter *cpp*. If the parameter *delete* is
+ true, the object pointed to by *cpp* will be deleted when the reference
+ count of the returned object reaches 0. The owner must be a
+ :class:`apt_pkg.DepCache` object.
+
+.. cfunction:: pkgOrderList* PyOrderList_ToCpp(PyObject *object)
+
+ Return the :ctype:`pkgOrderList` pointer contained in the Python object
+ *object*.
PackageManager (pkgPackageManager)
----------------------------------