diff options
Diffstat (limited to 'doc/html/classQextScintillaPrinter.html')
| -rw-r--r-- | doc/html/classQextScintillaPrinter.html | 252 |
1 files changed, 252 insertions, 0 deletions
diff --git a/doc/html/classQextScintillaPrinter.html b/doc/html/classQextScintillaPrinter.html new file mode 100644 index 0000000..1e829ca --- /dev/null +++ b/doc/html/classQextScintillaPrinter.html @@ -0,0 +1,252 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>QScintilla: QextScintillaPrinter Class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.7 --> +<div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li id="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <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> +<h1>QextScintillaPrinter Class Reference</h1><!-- doxytag: class="QextScintillaPrinter" -->The <a class="el" href="classQextScintillaPrinter.html">QextScintillaPrinter</a> class is a sub-class of the Qt QPrinter class that is able to print the text of a Scintilla document. +<a href="#_details">More...</a> +<p> +<code>#include <qextscintillaprinter.h></code> +<p> +<a href="classQextScintillaPrinter-members.html">List of all members.</a><h2>Public Member Functions</h2> +<ul> +<li><a class="el" href="classQextScintillaPrinter.html#d304f2d535a10595acc613521f92dc49">QextScintillaPrinter</a> (PrinterMode mode=ScreenResolution) +<li><a class="el" href="classQextScintillaPrinter.html#34077d68da930b18eba124ab64555898">~QextScintillaPrinter</a> () +<li>virtual void <a class="el" href="classQextScintillaPrinter.html#5d6f0f8c13568054efbe9003867f1b09">formatPage</a> (QPainter &painter, bool drawing, QRect &area, int pagenr) +<li>int <a class="el" href="classQextScintillaPrinter.html#a990192f1b73683409f23b0bb1ba3e94">magnification</a> () const +<li>virtual void <a class="el" href="classQextScintillaPrinter.html#7343a1deb132bfc5dfd2c4208eff3d00">setMagnification</a> (int magnification) +<li>virtual int <a class="el" href="classQextScintillaPrinter.html#31d261de4a31e82646f4f75d1a6085f6">printRange</a> (<a class="el" href="classQextScintillaBase.html">QextScintillaBase</a> *qsb, int from=-1, int to=-1) +<li><a class="el" href="classQextScintilla.html#15ead1c6cb74fa8a441f27587ed99ed3">QextScintilla::WrapMode</a> <a class="el" href="classQextScintillaPrinter.html#8aba0d63efee1fb2d6b5609c9120f970">wrapMode</a> () const +<li>virtual void <a class="el" href="classQextScintillaPrinter.html#f4904d6ba001f4c7145983f9814f00c1">setWrapMode</a> (<a class="el" href="classQextScintilla.html#15ead1c6cb74fa8a441f27587ed99ed3">QextScintilla::WrapMode</a> wmode) +</ul> +<hr><a name="_details"></a><h2>Detailed Description</h2> +The <a class="el" href="classQextScintillaPrinter.html">QextScintillaPrinter</a> class is a sub-class of the Qt QPrinter class that is able to print the text of a Scintilla document. +<p> +The class can be further sub-classed to alter to layout of the text, adding headers and footers for example. +<p> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="d304f2d535a10595acc613521f92dc49"></a><!-- doxytag: member="QextScintillaPrinter::QextScintillaPrinter" ref="d304f2d535a10595acc613521f92dc49" args="(PrinterMode mode=ScreenResolution)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QextScintillaPrinter::QextScintillaPrinter </td> + <td>(</td> + <td class="paramtype">PrinterMode </td> + <td class="paramname"> <em>mode</em> = <code>ScreenResolution</code> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructs a printer paint device with mode <em>mode</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="34077d68da930b18eba124ab64555898"></a><!-- doxytag: member="QextScintillaPrinter::~QextScintillaPrinter" ref="34077d68da930b18eba124ab64555898" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QextScintillaPrinter::~QextScintillaPrinter </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroys the <a class="el" href="classQextScintillaPrinter.html">QextScintillaPrinter</a> instance. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="5d6f0f8c13568054efbe9003867f1b09"></a><!-- doxytag: member="QextScintillaPrinter::formatPage" ref="5d6f0f8c13568054efbe9003867f1b09" args="(QPainter &painter, bool drawing, QRect &area, int pagenr)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void QextScintillaPrinter::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><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"><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="classQextScintillaPrinter.html#31d261de4a31e82646f4f75d1a6085f6">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. +</div> +</div><p> +<a class="anchor" name="a990192f1b73683409f23b0bb1ba3e94"></a><!-- doxytag: member="QextScintillaPrinter::magnification" ref="a990192f1b73683409f23b0bb1ba3e94" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int QextScintillaPrinter::magnification </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> 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 compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaPrinter.html#7343a1deb132bfc5dfd2c4208eff3d00">setMagnification()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="7343a1deb132bfc5dfd2c4208eff3d00"></a><!-- doxytag: member="QextScintillaPrinter::setMagnification" ref="7343a1deb132bfc5dfd2c4208eff3d00" args="(int magnification)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void QextScintillaPrinter::setMagnification </td> + <td>(</td> + <td class="paramtype">int </td> + <td class="paramname"> <em>magnification</em> </td> + <td> ) </td> + <td width="100%"><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 compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaPrinter.html#a990192f1b73683409f23b0bb1ba3e94">magnification()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="31d261de4a31e82646f4f75d1a6085f6"></a><!-- doxytag: member="QextScintillaPrinter::printRange" ref="31d261de4a31e82646f4f75d1a6085f6" args="(QextScintillaBase *qsb, int from=-1, int to=-1)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual int QextScintillaPrinter::printRange </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQextScintillaBase.html">QextScintillaBase</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><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td width="100%"><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. +</div> +</div><p> +<a class="anchor" name="8aba0d63efee1fb2d6b5609c9120f970"></a><!-- doxytag: member="QextScintillaPrinter::wrapMode" ref="8aba0d63efee1fb2d6b5609c9120f970" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classQextScintilla.html#15ead1c6cb74fa8a441f27587ed99ed3">QextScintilla::WrapMode</a> QextScintillaPrinter::wrapMode </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td width="100%"> 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="classQextScintilla.html#15ead1c6cb74fa8a441f27587ed99ed3a7f65cd359e236aee9ab70d7bf55085c">QextScintilla::WrapWord</a>.<p> +<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaPrinter.html#f4904d6ba001f4c7145983f9814f00c1">setWrapMode()</a> </dd></dl> + +</div> +</div><p> +<a class="anchor" name="f4904d6ba001f4c7145983f9814f00c1"></a><!-- doxytag: member="QextScintillaPrinter::setWrapMode" ref="f4904d6ba001f4c7145983f9814f00c1" args="(QextScintilla::WrapMode wmode)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual void QextScintillaPrinter::setWrapMode </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classQextScintilla.html#15ead1c6cb74fa8a441f27587ed99ed3">QextScintilla::WrapMode</a> </td> + <td class="paramname"> <em>wmode</em> </td> + <td> ) </td> + <td width="100%"><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 compact><dt><b>See also:</b></dt><dd><a class="el" href="classQextScintillaPrinter.html#8aba0d63efee1fb2d6b5609c9120f970">wrapMode()</a> </dd></dl> + +</div> +</div><p> +<hr size="1"><address style="align: right;"><small>Generated on Thu Nov 30 09:32:31 2006 for QScintilla by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address> +</body> +</html> |