Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 1249

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XPrinter</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XPrinter-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">awt</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XPrinter</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XPrinter</strong>
&#x2517 <a href="XPrinterPropertySet.html">XPrinterPropertySet</a>
   &#x2517 ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left"><a href="XPrinterPropertySet.html">XPrinterPropertySet</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>represents an extended property set for printer properties.
 
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>represents a virtual printer. 
 
 </dd>
<dd><p>All properties are vetoable properties.
 If you change the properties between a call to
 <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#startPage">startPage</a> and a call
 to <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#endPage">endPage</a>,
 a ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyVetoException.html">PropertyVetoException</a> is
 thrown.</p>
 </dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#start">start</a></td>
<td class="imsum_right">puts the job into the printer spooler. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#end">end</a></td>
<td class="imsum_right">notifies the printer spooler that the job is done and printing
 starts.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#terminate">terminate</a></td>
<td class="imsum_right">stops the current print job. 
 
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#startPage">startPage</a></td>
<td class="imsum_right">begins with a new page.
 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#endPage">endPage</a></td>
<td class="imsum_right">ends the current page.
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="start" class="membertitle">start</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>start</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;nJobName,</td>
</tr>
<tr>
<td/><td valign="top">[in] short</td>
<td valign="bottom">&nbsp;nCopies,</td>
</tr>
<tr>
<td/><td valign="top">[in] boolean</td>
<td valign="bottom">&nbsp;nCollate )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="PrinterException.html">PrinterException</a>,<br>
::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>puts the job into the printer spooler. 
 
 </dd>
<dd><p>This call may block the thread. So release all resources 
 (mutex, semaphore, etc.) before this call.</p>
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="end" class="membertitle">end</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>end</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="PrinterException.html">PrinterException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>notifies the printer spooler that the job is done and printing
 starts.

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#terminate">terminate</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="terminate" class="membertitle">terminate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>terminate</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>stops the current print job. 
 
 </dd>
<dd><p>If the method
 <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#end">end</a>
 is called beforehand, then this call does nothing. If you call
 <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#terminate">terminate</a>
 in or before the call to
 <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#start">start</a>,
 <a href="XPrinter.html">XPrinter</a>::<a href="XPrinter.html#terminate">terminate</a>
 returns <b>false</b>. This call must not block the thread.</p>

 </dd>
<dt><b>See also</b></dt>
<dd><a href="#end">end</a></dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="startPage" class="membertitle">startPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3"><a href="XDevice.html">XDevice</a></td>
</tr>
<tr>
<td valign="top"><b>startPage</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="PrinterException.html">PrinterException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>begins with a new page.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="endPage" class="membertitle">endPage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>endPage</b>()</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2"><a href="PrinterException.html">PrinterException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>ends the current page.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>