offapi/com/sun/star/awt/XPrinter.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPrinter.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XPrinter_idl__
  31 #define __com_sun_star_awt_XPrinter_idl__
  32
  33 #ifndef __com_sun_star_awt_XPrinterPropertySet_idl__
  34 #include <com/sun/star/awt/XPrinterPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_PrinterException_idl__
  38 #include <com/sun/star/awt/PrinterException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_XDevice_idl__
  46 #include <com/sun/star/awt/XDevice.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module awt {
  53
  54 //=============================================================================
  55
  56 /** represents a virtual printer.
  57
  58     <p>All properties are vetoable properties.
  59     If you change the properties between a call to
  60     <member scope="com::sun::star::awt">XPrinter::startPage</member> and a call
  61     to <member scope="com::sun::star::awt">XPrinter::endPage</member>,
  62     a <type scope="com::sun::star::beans">PropertyVetoException</type> is
  63     thrown.</p>
  64  */
  65 published interface XPrinter: com::sun::star::awt::XPrinterPropertySet
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** puts the job into the printer spooler.
  70
  71         <p>This call may block the thread. So release all resources
  72         (mutex, semaphore, etc.) before this call.</p>
  73      */
  74     boolean start( [in] string nJobName,
  75              [in] short nCopies,
  76              [in] boolean nCollate )
  77             raises( com::sun::star::awt::PrinterException,
  78                     com::sun::star::lang::IllegalArgumentException );
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** notifies the printer spooler that the job is done and printing
  83         starts.
  84
  85         @see terminate
  86      */
  87     void end()
  88             raises( com::sun::star::awt::PrinterException );
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** stops the current print job.
  93
  94         <p>If the method
  95         <member scope="com::sun::star::awt">XPrinter::end</member>
  96         is called beforehand, then this call does nothing. If you call
  97         <member scope="com::sun::star::awt">XPrinter::terminate</member>
  98         in or before the call to
  99         <member scope="com::sun::star::awt">XPrinter::start</member>,
 100         <member scope="com::sun::star::awt">XPrinter::terminate</member>
 101         returns <FALSE/>. This call must not block the thread.</p>
 102
 103         @see end
 104      */
 105     void terminate();
 106
 107     //-------------------------------------------------------------------------
 108
 109     /** begins with a new page.
 110      */
 111     com::sun::star::awt::XDevice startPage()
 112             raises( com::sun::star::awt::PrinterException );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** ends the current page.
 117      */
 118     void endPage()
 119             raises( com::sun::star::awt::PrinterException );
 120
 121 };
 122
 123 //=============================================================================
 124
 125 }; }; }; };
 126
 127 #endif