1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>QScintilla: QsciPrinter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">QScintilla
 <span id="projectnumber">2.8.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">QsciPrinter Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="QsciPrinter" -->
<p><code>#include <qsciprinter.h></code></p>
<p><a href="classQsciPrinter-members.html">List of all members.</a></p>
<h2><a name="pub-methods"></a>
Public Member Functions</h2>
<ul>
<li><a class="anchor" id="aaa54abecf0defffdfda80f95af6febf9"></a><!-- doxytag: member="QsciPrinter::QsciPrinter" ref="aaa54abecf0defffdfda80f95af6febf9" args="(PrinterMode mode=ScreenResolution)" -->
<a class="el" href="classQsciPrinter.html#aaa54abecf0defffdfda80f95af6febf9">QsciPrinter</a> (PrinterMode mode=ScreenResolution)
<li><a class="anchor" id="a9c7747919e355a885d6ebb4b0d0dc619"></a><!-- doxytag: member="QsciPrinter::~QsciPrinter" ref="a9c7747919e355a885d6ebb4b0d0dc619" args="()" -->
virtual <a class="el" href="classQsciPrinter.html#a9c7747919e355a885d6ebb4b0d0dc619">~QsciPrinter</a> ()
<li>virtual void <a class="el" href="classQsciPrinter.html#a420e136529a8d49551eb8af0f5cdce03">formatPage</a> (QPainter &painter, bool drawing, QRect &area, int pagenr)
<li>int <a class="el" href="classQsciPrinter.html#a2c9e0ee7b3be1592502b0025bd15f7cf">magnification</a> () const
<li>virtual void <a class="el" href="classQsciPrinter.html#ad66724c8a5e5e202998bd6533fef61be">setMagnification</a> (int magnification)
<li>virtual int <a class="el" href="classQsciPrinter.html#aae304336a4a8d4c2e332744ceeba1393">printRange</a> (<a class="el" href="classQsciScintillaBase.html">QsciScintillaBase</a> *qsb, int from=-1, int to=-1)
<li><a class="el" href="classQsciScintilla.html#a7081c7ff25b5f6bd5b3a6cbd478a9f42">QsciScintilla::WrapMode</a> <a class="el" href="classQsciPrinter.html#a20cc49cd4c55125fc5fcb2235d372a84">wrapMode</a> () const
<li>virtual void <a class="el" href="classQsciPrinter.html#aa95827e3bd2c3c0e658afe55fa12476e">setWrapMode</a> (<a class="el" href="classQsciScintilla.html#a7081c7ff25b5f6bd5b3a6cbd478a9f42">QsciScintilla::WrapMode</a> wmode)
</ul>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classQsciPrinter.html" title="The QsciPrinter class is a sub-class of the Qt QPrinter class that is able to print the text of a Sci...">QsciPrinter</a> class is a sub-class of the Qt QPrinter class that is able to print the text of a Scintilla document. </p>
<p>The class can be further sub-classed to alter to layout of the text, adding headers and footers for example. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a420e136529a8d49551eb8af0f5cdce03"></a><!-- doxytag: member="QsciPrinter::formatPage" ref="a420e136529a8d49551eb8af0f5cdce03" args="(QPainter &painter, bool drawing, QRect &area, int pagenr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QsciPrinter::formatPage </td>
<td>(</td>
<td class="paramtype">QPainter & </td>
<td class="paramname"><em>painter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>drawing</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QRect & </td>
<td class="paramname"><em>area</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>pagenr</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Format a page, by adding headers and footers for example, before the document text is drawn on it. <em>painter</em> is the painter to be used to add customised text and graphics. <em>drawing</em> is true if the page is actually being drawn rather than being sized. <em>painter</em> drawing methods must only be called when <em>drawing</em> is true. <em>area</em> is the area of the page that will be used to draw the text. This should be modified if it is necessary to reserve space for any customised text or graphics. By default the area is relative to the printable area of the page. Use QPrinter::setFullPage() because calling <a class="el" href="classQsciPrinter.html#aae304336a4a8d4c2e332744ceeba1393">printRange()</a> if you want to try and print over the whole page. <em>pagenr</em> is the number of the page. The first page is numbered 1. </p>
</div>
</div>
<a class="anchor" id="a2c9e0ee7b3be1592502b0025bd15f7cf"></a><!-- doxytag: member="QsciPrinter::magnification" ref="a2c9e0ee7b3be1592502b0025bd15f7cf" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int QsciPrinter::magnification </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the number of points to add to each font when printing.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciPrinter.html#ad66724c8a5e5e202998bd6533fef61be">setMagnification()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ad66724c8a5e5e202998bd6533fef61be"></a><!-- doxytag: member="QsciPrinter::setMagnification" ref="ad66724c8a5e5e202998bd6533fef61be" args="(int magnification)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QsciPrinter::setMagnification </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>magnification</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the number of points to add to each font when printing to <em>magnification</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciPrinter.html#a2c9e0ee7b3be1592502b0025bd15f7cf">magnification()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aae304336a4a8d4c2e332744ceeba1393"></a><!-- doxytag: member="QsciPrinter::printRange" ref="aae304336a4a8d4c2e332744ceeba1393" args="(QsciScintillaBase *qsb, int from=-1, int to=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int QsciPrinter::printRange </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQsciScintillaBase.html">QsciScintillaBase</a> * </td>
<td class="paramname"><em>qsb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>from</em> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>to</em> = <code>-1</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Print a range of lines from the Scintilla instance <em>qsb</em>. <em>from</em> is the first line to print and a negative value signifies the first line of text. <em>to</em> is the last line to print and a negative value signifies the last line of text. true is returned if there was no error. </p>
</div>
</div>
<a class="anchor" id="a20cc49cd4c55125fc5fcb2235d372a84"></a><!-- doxytag: member="QsciPrinter::wrapMode" ref="a20cc49cd4c55125fc5fcb2235d372a84" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQsciScintilla.html#a7081c7ff25b5f6bd5b3a6cbd478a9f42">QsciScintilla::WrapMode</a> QsciPrinter::wrapMode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the line wrap mode used when printing. The default is <a class="el" href="classQsciScintilla.html#a7081c7ff25b5f6bd5b3a6cbd478a9f42aeb6fe909aad13c04aab01c9c216ac2ec" title="Lines are wrapped at word boundaries.">QsciScintilla::WrapWord</a>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciPrinter.html#aa95827e3bd2c3c0e658afe55fa12476e">setWrapMode()</a> </dd></dl>
</div>
</div>
<a class="anchor" id="aa95827e3bd2c3c0e658afe55fa12476e"></a><!-- doxytag: member="QsciPrinter::setWrapMode" ref="aa95827e3bd2c3c0e658afe55fa12476e" args="(QsciScintilla::WrapMode wmode)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void QsciPrinter::setWrapMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classQsciScintilla.html#a7081c7ff25b5f6bd5b3a6cbd478a9f42">QsciScintilla::WrapMode</a> </td>
<td class="paramname"><em>wmode</em></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the line wrap mode used when printing to <em>wmode</em>.</p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classQsciPrinter.html#a20cc49cd4c55125fc5fcb2235d372a84">wrapMode()</a> </dd></dl>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>
Generated on Thu Sep 11 2014 18:15:20 for QScintilla by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>
</body>
</html>
|