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