HelpSource/Classes/QPenPrinter.schelp

   1 CLASS:: QPenPrinter
   2 summary:: QPen PDF export and printing of vector graphics
   3 categories:: GUI>Printing
   4 related:: Classes/QPen, Classes/Pen
   5
   6 DESCRIPTION::
   7 QPenPrinter allows QPen to operate on a printer device. The graphics can be exported to PDF by using "print to file" as printer device.
   8
   9 CLASSMETHODS::
  10 private:: qtClass
  11
  12
  13 METHOD:: new
  14 Create a new QPenPrinter object.
  15
  16 returns:: an instance of QPenPrinter
  17
  18 METHOD:: print
  19 Convenience function to show a print dialog and print.
  20
  21 argument:: printFunc
  22 A link::Classes/Function:: to be evaluated when the user presses "Print", with the printer object as QPen painter target.
  23 See strong::aPrintFunc:: in link::#-print:: below.
  24
  25 argument:: cancelFunc
  26 An optional link::Classes/Function:: to be evaluated if the user presses "Cancel".
  27
  28
  29 INSTANCEMETHODS::
  30 private:: init
  31
  32 subsection:: Printing
  33
  34 METHOD:: showDialog
  35 Shows a Print Dialog to allow the user to configure the printer object. This is asynchronous and the method will return immediately.
  36 When the user presses the "Print" button, strong::aOkFunc:: is called with this QPenPrinter object as argument.
  37
  38 argument:: aOkFunc
  39 A link::Classes/Function:: to be evaluated when the user presses "Print".
  40
  41 argument:: aCancelFunc
  42 An optional link::Classes/Function:: to be evaluated if the user presses "Cancel".
  43
  44
  45 METHOD:: print
  46 This method does the actual printing or PDF export. It evaluates strong::aPrintFunc:: with the printer object as QPen painter target. This QPenPrinter object is passed as the argument.
  47
  48 All the ordinary link::Classes/QPen:: commands can be used inside the function.
  49
  50 argument:: aPrintFunc
  51 A link::Classes/Function:: to be evaluated to draw the graphics.
  52
  53 discussion::
  54 If this method is called without configuring the printer object first, it will print on the default printer with default settings.
  55
  56 This method is typically called from within the strong::aOkFunc:: of link::#-showDialog:: above. After showDialog has configured the printer once, this method can be called multiple times to reuse the last printer configuration.
  57
  58 The point at (0@0) will coincide with the origin of link::#-pageRect::, which is offset by the page margins. So you don't need to translate the Pen.
  59
  60
  61 METHOD:: newPage
  62 Starts a new page. Typically called within the strong::aPrintFunc:: of link::#-print::.
  63
  64
  65 subsection:: Properties
  66
  67 METHOD:: paperRect
  68 Get the paper bounds.
  69
  70 returns:: a link::Classes/Rect::
  71
  72
  73 METHOD:: pageRect
  74 Get the page bounds, which is the printable area and usually smaller than link::#-paperRect:: due to margins.
  75
  76 returns:: a link::Classes/Rect::
  77
  78 discussion::
  79 The strong::origin:: of the Rect is relative to the paper, and will be non-zero due to margins.
  80
  81
  82 METHOD:: pageSize
  83 Get the page size as a Size.
  84
  85 returns:: a link::Classes/Size::
  86
  87 discussion::
  88 This can be used to scale the graphics to fit the page if the bounds of the graphics is known:
  89 code::
  90 x = penPrinter.pageSize.width / bounds.width;
  91 Pen.scale(x,x);
  92 // ... draw stuff here ...
  93 ::
  94
  95 subsection:: Page range
  96 The methods below returns the page range selected by the user. Page number starts at 1. When both methods returns 0 it means "print all pages".
  97
  98 METHOD:: fromPage
  99 Get the start page.
 100
 101 returns:: an link::Classes/Integer::
 102
 103 METHOD:: toPage
 104 Get the end page.
 105
 106 returns:: an link::Classes/Integer::
 107
 108
 109
 110 EXAMPLES::
 111
 112 Simple usage:
 113 code::
 114 QPenPrinter.print {
 115     // first page
 116     Pen.moveTo(100@100);
 117     Pen.lineTo(300@300);
 118     Pen.stroke;
 119
 120     // second page
 121     p.newPage;
 122     Pen.addRect(p.pageSize.asRect);
 123     Pen.stroke;
 124 }
 125 ::
 126
 127 Keep the QPenPrinter object to save configuration state:
 128 code::
 129 p = QPenPrinter();
 130 ::
 131 The code below can then be called multiple times:
 132 code::
 133 p.showDialog {
 134     p.print {
 135         // first page
 136         Pen.moveTo(100@100);
 137         Pen.lineTo(300@300);
 138         Pen.stroke;
 139
 140         // second page
 141         p.newPage;
 142         Pen.addRect(p.pageSize.asRect);
 143         Pen.stroke;
 144     }
 145 } {
 146     "Printing cancelled!".postln;
 147 };
 148 ::
 149