1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XPrinter_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_awt_XPrinter_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XPrinterPropertySet_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XPrinterPropertySet.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_PrinterException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/PrinterException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 35*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 36*b1cdbd2cSJim Jagielski#endif 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_awt_XDevice_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/awt/XDevice.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski//============================================================================= 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski module com { module sun { module star { module awt { 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski//============================================================================= 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski/** represents a virtual printer. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <p>All properties are vetoable properties. 52*b1cdbd2cSJim Jagielski If you change the properties between a call to 53*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">XPrinter::startPage</member> and a call 54*b1cdbd2cSJim Jagielski to <member scope="com::sun::star::awt">XPrinter::endPage</member>, 55*b1cdbd2cSJim Jagielski a <type scope="com::sun::star::beans">PropertyVetoException</type> is 56*b1cdbd2cSJim Jagielski thrown.</p> 57*b1cdbd2cSJim Jagielski */ 58*b1cdbd2cSJim Jagielskipublished interface XPrinter: com::sun::star::awt::XPrinterPropertySet 59*b1cdbd2cSJim Jagielski{ 60*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski /** puts the job into the printer spooler. 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski <p>This call may block the thread. So release all resources 65*b1cdbd2cSJim Jagielski (mutex, semaphore, etc.) before this call.</p> 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski boolean start( [in] string nJobName, 68*b1cdbd2cSJim Jagielski [in] short nCopies, 69*b1cdbd2cSJim Jagielski [in] boolean nCollate ) 70*b1cdbd2cSJim Jagielski raises( com::sun::star::awt::PrinterException, 71*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException ); 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** notifies the printer spooler that the job is done and printing 76*b1cdbd2cSJim Jagielski starts. 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski @see terminate 79*b1cdbd2cSJim Jagielski */ 80*b1cdbd2cSJim Jagielski void end() 81*b1cdbd2cSJim Jagielski raises( com::sun::star::awt::PrinterException ); 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** stops the current print job. 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski <p>If the method 88*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">XPrinter::end</member> 89*b1cdbd2cSJim Jagielski is called beforehand, then this call does nothing. If you call 90*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">XPrinter::terminate</member> 91*b1cdbd2cSJim Jagielski in or before the call to 92*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">XPrinter::start</member>, 93*b1cdbd2cSJim Jagielski <member scope="com::sun::star::awt">XPrinter::terminate</member> 94*b1cdbd2cSJim Jagielski returns <FALSE/>. This call must not block the thread.</p> 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @see end 97*b1cdbd2cSJim Jagielski */ 98*b1cdbd2cSJim Jagielski void terminate(); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski /** begins with a new page. 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski com::sun::star::awt::XDevice startPage() 105*b1cdbd2cSJim Jagielski raises( com::sun::star::awt::PrinterException ); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski /** ends the current page. 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski void endPage() 112*b1cdbd2cSJim Jagielski raises( com::sun::star::awt::PrinterException ); 113*b1cdbd2cSJim Jagielski 114*b1cdbd2cSJim Jagielski}; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski//============================================================================= 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski}; }; }; }; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski#endif 121