interface XPrinter in module com::sun::star::awt::

(Global Index)

Syntax

interface XPrinter : com::sun::star::awt::XPrinterPropertySet ;

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 PropertyVetoException is thrown.

Method 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.

Method Details



start

Syntax

boolean start (
string nJobName,
short nCopies,
boolean nCollate )
raises ( com::sun::star::awt::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

Syntax

void end ();
raises ( com::sun::star::awt::PrinterException );

Description

notifies the printer spooler that the job is done and printing starts.

See also

terminate

terminate

Syntax

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::termnate returns false . This call must not block the thread.

See also

end

startPage

Syntax

com::sun::star::awt::XDevice startPage ();
raises ( com::sun::star::awt::PrinterException );

Description

begins with a new page.


endPage

Syntax

void endPage ();
raises ( com::sun::star::awt::PrinterException );

Description

ends the current page.

Top of Page