Changeset 9972 for main/waeup.kofa/trunk/src

Timestamp:

20 Feb 2013, 10:58:21 (12 years ago)

Author:

uli

Message:

Give some hints about usage of get_signature_tables().

File:

• main/waeup.kofa/trunk/src/waeup/kofa/browser/pdf.py (modified) (2 diffs)

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

@@ -392 +392 @@
                          horizontal=None, single_table=False):
     """Get a list of reportlab flowables representing signature fields.
+
+    `signatures` is a list of signatures. Each signature can be a
+    simple string or a tuple of format::
+
+      (<PRE-TEXT>, <SIGNATURE>, <POST-TEXT>)
+
+    where ``<PRE-TEXT>`` and ``<POST-TEXT>`` are texts that should
+    appear on top (PRE) or below (POST) the signature cell. Both
+    formats, string and tuple, can be mixed. A single signature would
+    be given as ``[('Pre-Text', 'Signature', 'Post-Text'),]`` or
+    simply as ``['Signature']`` if not pre or post-text is wanted.
+
+    All texts (pre, sig, post) are rendered as paragraphs, so you can
+    pass in also longer texts with basic HTML formatting like ``<b>``,
+    ``<i>``, ``<br />``, etc.
+
+    ``lang`` sets the language to use in I18n context. All texts are
+    translated to the given language (``en`` by default) if a
+    translation is available.
+
+    ``max_per_row`` gives the maximum number of signatures to put into
+    a single row. The default is 3. If more signatures are passed in,
+    these signatures are put into a new row. So, for example by
+    default 8 signatures would be spread over 3 rows.
+
+    ``horizontal`` tells how the single signature cells should be
+    rendered: horizontal or vertical. While horizontal cells render
+    date and signature fields side by side, in vertical cells date is
+    rendered on top of the signature.
+
+    This parameter accepts *three* different values: ``True``,
+    ``False``, or ``None``. While with ``True`` each cell is rendered
+    in horizontal mode, ``False`` will create only vertical cells.
+
+    The ``None`` value (set by default) is different: if set, the mode
+    will be dependent on the number of signatures per row. If a row
+    contains exactly one signature (because only one sig was passed
+    in, or because ``max_per_row`` was set to ``1``), then this
+    signature is rendered in horizontal mode. Otherwise (with more
+    than one sig per row) each cell is rendered in vertical mode. This
+    pseudo-smart behaviour can be switched off by setting
+    ``horizontal`` explicitly to ``True`` or ``False``.
+
+    ``single_table`` is a boolean defaulting to ``False``. By default
+    we return the rows of a signature table in several tables, one of
+    each row. This makes it easier for reportlab to perform pagebreaks
+    in case the page is already full, without wasting space. If the
+    parameter is set to ``True``, then always a list with exactly one
+    table is returned, which will contain all rows in one table.
+
+    Generally, if a row contains only one signature, only a part of
+    the page width is used to render this signature. If two or more
+    signatures are passed in, the complete page width will be filled
+    and the single signature cells will be shrinked to fit.
     """
     data_list = get_sig_tables(
@@ -397 +451 @@
         horizontal=horizontal, single_table=single_table)
     return [Table(row_data, style=row_style, colWidths=row_col_widths,
-                  repeatRows=2)
+                  repeatRows=4)
             for row_data, row_style, row_col_widths in data_list]