Changeset 688

Timestamp:

01/18/06 11:59:09 (3 years ago)

Author:

laotzu

Message:

Add basic documentation for all API functions.

Files:

• pypdf/trunk/pyPdf/pdf.py (modified) (7 diffs)

pypdf/trunk/pyPdf/pdf.py

@@ -52 +52 @@
-
-    def addPage(self, page):
+        """
+        Adds a page to this PDF file.  A dictionary of /Type = /Page.
+        Currently usually aquired from PdfFileReader.getPage().
+
+        Stability: Added in v1.0, will exist for all v1.x releases.
+        """
-        self.pages.append(page)
-
-    def write(self, stream):
+        """
+        Writes this PDF file to an output stream.  Writes the file as a
+        PDF-1.3 format file.
+
+        Stability: Added in v1.0, will exist for all v1.x releases.
+        """
-        objects = []
-
@@ -164 +176 @@
-class PdfFileReader(object):
-    def __init__(self, stream):
+        """
+        Initializes a PdfFileReader object.  This operation can take some time,
+        as the PDF file cross-reference tables are read.  "stream" parameter
+        must be a data stream, not a string or a path name.
+
+        Stability: Added in v1.0, will exist for all v1.x releases.
+        """
-        self.flattenedPages = None
-        self.resolvedObjects = {}
@@ -170 +189 @@
-
-    def getNumPages(self):
+        """
+        Returns the number of pages in this PDF file.
+
+        Stability: Added in v1.0, will exist for all v1.x releases.
+        """
-        if self.flattenedPages == None:
-            self.flatten()
@@ -175 +199 @@
-
-    def getPage(self, pageNumber):
+        """
+        Retrieves a page by number from this PDF file.  Returns a PageObject
+        instance.
+
+        Stability: Added in v1.0, will exist for all v1.x releases.
+        """
-        if self.flattenedPages == None:
-            self.flatten()
@@ -671 +701 @@
-class PageObject(DictionaryObject):
-    def rotateClockwise(self, angle):
+        """
+        Rotates a page clockwise by increments of 90 degrees.
+
+        Stability: Added in v1.1, will exist for all v1.x releases thereafter.
+        """
-        assert angle % 90 == 0
-        self.__rotate(angle)
@@ -676 +711 @@
-
-    def rotateCounterClockwise(self, angle):
-
+
+
+
+
+
+
+
-        self.__rotate(-angle)
-        return self
@@ -762 +803 @@
-    
-    output.write(file("test.pdf", "wb"))
+