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

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