Changeset 8059 for main/waeup.kofa/trunk/src/waeup/kofa/browser/interfaces.py

Timestamp:

7 Apr 2012, 08:15:16 (12 years ago)

Author:

uli

Message:

Improve pdf generation: a global pdf generator, watermarks and more.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/browser/interfaces.py (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/browser/interfaces.py

@@ -163 +163 @@
         """Get captcha chosen for a certain site or default.
         """
+
+class IPDFCreator(Interface):
+    """A component that knows where logo graphics for PDFs are stored
+    and can generate PDF documents.
+
+    It is a utility (and not a simple function or class) to make these
+    data customizable in derived packages.
+    """
+    header_logo_path = schema.TextLine(
+        title = u'Path to header logo JPG')
+    watermark_path = schema.TextLine(
+        title = u'Path to watermark logo JPG')
+    def paint_background(canvas, doc):
+        """A callback function to render background of PDFs.
+        """
+    def create_pdf(data, headerline=None, title=None):
+        """Create a PDF.
+
+        `data` is expected to be a list of reportlab flowables
+        (paragraphs, images, tables, etc.), that will be rendered into
+        some background.
+
+        `headerline` will be displayed in page head and `title` under
+        the top bar.
+
+        If no `headerline` is given, a default will be rendered (name
+        of university).
+
+        If no `title` is given, nothing will be rendered.
+        """