summaryrefslogtreecommitdiff
path: root/bin/reportlab/docs/userguide/ch7_custom.py
diff options
context:
space:
mode:
Diffstat (limited to 'bin/reportlab/docs/userguide/ch7_custom.py')
-rw-r--r--bin/reportlab/docs/userguide/ch7_custom.py81
1 files changed, 81 insertions, 0 deletions
diff --git a/bin/reportlab/docs/userguide/ch7_custom.py b/bin/reportlab/docs/userguide/ch7_custom.py
new file mode 100644
index 00000000000..176d042cd85
--- /dev/null
+++ b/bin/reportlab/docs/userguide/ch7_custom.py
@@ -0,0 +1,81 @@
+#Copyright ReportLab Europe Ltd. 2000-2004
+#see license.txt for license details
+#history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/docs/userguide/ch7_custom.py
+from reportlab.tools.docco.rl_doc_utils import *
+
+heading1("Writing your own $Flowable$ Objects")
+disc("""
+Flowables are intended to be an open standard for creating
+reusable report content, and you can easily create your
+own objects. We hope that over time we will build up
+a library of contributions, giving reportlab users a
+rich selection of charts, graphics and other "report
+widgets" they can use in their own reports. This section
+shows you how to create your own flowables.""")
+
+todo("""we should put the Figure class in the
+standard library, as it is a very useful base.""")
+
+
+
+
+heading2("A very simple $Flowable$")
+
+disc("""
+Recall the $hand$ function from the $pdfgen$ section of this user guide which
+generated a drawing of a hand as a closed figure composed from Bezier curves.
+""")
+illust(examples.hand, "a hand")
+disc("""
+To embed this or any other drawing in a Platypus flowable we must define a
+subclass of $Flowable$
+with at least a $wrap$ method and a $draw$ method.
+""")
+eg(examples.testhandannotation)
+disc("""
+The $wrap$ method must provide the size of the drawing -- it is used by
+the Platypus mainloop to decide whether this element fits in the space remaining
+on the current frame. The $draw$ method performs the drawing of the object after
+the Platypus mainloop has translated the $(0,0)$ origin to an appropriate location
+in an appropriate frame.
+""")
+disc("""
+Below are some example uses of the $HandAnnotation$ flowable.
+""")
+
+from reportlab.lib.colors import blue, pink, yellow, cyan, brown
+from reportlab.lib.units import inch
+
+handnote()
+
+disc("""The default.""")
+
+handnote(size=inch)
+
+disc("""Just one inch high.""")
+
+handnote(xoffset=3*inch, size=inch, strokecolor=blue, fillcolor=cyan)
+
+disc("""One inch high and shifted to the left with blue and cyan.""")
+
+
+heading2("Modifying a Built in $Flowable$")
+disc("""To modify an existing flowable, you should create a derived class
+and override the methods you need to change to get the desired behaviour""")
+disc("""As an example to create a rotated image you need to override the wrap
+and draw methods of the existing Image class""")
+import os
+from reportlab.platypus import *
+I = '../images/replogo.gif'
+
+EmbeddedCode("""
+class RotatedImage(Image):
+ def wrap(self,availWidth,availHeight):
+ h, w = Image.wrap(self,availHeight,availWidth)
+ return w, h
+ def draw(self):
+ self.canv.rotate(90)
+ Image.draw(self)
+I = RotatedImage('%s')
+I.hAlign = 'CENTER'
+""" % I,'I') \ No newline at end of file