Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: awt ::

interface XPrinter
Base Interfaces
XPrinter
┗ XPrinterPropertySet
   ┗ ::com::sun::star::beans::XPropertySet
XPrinterPropertySet
(referenced interface's summary:)
represents an extended property set for printer properties.
Description
represents a virtual printer.

All properties are vetoable properties. If you change the properties between a call to XPrinter::startPage and a call to XPrinter::endPage, a ::com::sun::star::beans::PropertyVetoException is thrown.
Methods' Summary
start puts the job into the printer spooler.  
end notifies the printer spooler that the job is done and printing starts.  
terminate stops the current print job.  
startPage begins with a new page.  
endPage ends the current page.  
Methods' Details
start
boolean
start( [in] string  nJobName,
[in] short  nCopies,
[in] boolean  nCollate )
raises( PrinterException,
::com::sun::star::lang::IllegalArgumentException );
Description
puts the job into the printer spooler.

This call may block the thread. So release all resources (mutex, semaphore, etc.) before this call.
end
void
end()
raises( PrinterException );
Description
notifies the printer spooler that the job is done and printing starts.
See also
terminate
terminate
void
terminate();
Description
stops the current print job.

If the method XPrinter::end is called beforehand, then this call does nothing. If you call XPrinter::terminate in or before the call to XPrinter::start, XPrinter::terminate returns false. This call must not block the thread.

See also
end
startPage
XDevice
startPage()
raises( PrinterException );
Description
begins with a new page.
endPage
void
endPage()
raises( PrinterException );
Description
ends the current page.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

The ASF

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.