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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XPrinter_idl__
  20 #define __com_sun_star_awt_XPrinter_idl__
  21
  22 #include <com/sun/star/awt/XPrinterPropertySet.idl>
  23
  24 #include <com/sun/star/awt/PrinterException.idl>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.idl>
  27
  28 #include <com/sun/star/awt/XDevice.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module awt {
  33
  34
  35 /** represents a virtual printer.
  36
  37     <p>All properties are vetoable properties.
  38     If you change the properties between a call to
  39     com::sun::star::awt::XPrinter::startPage() and a call
  40     to com::sun::star::awt::XPrinter::endPage(),
  41     a com::sun::star::beans::PropertyVetoException is
  42     thrown.</p>
  43  */
  44 published interface XPrinter: com::sun::star::awt::XPrinterPropertySet
  45 {
  46
  47     /** puts the job into the printer spooler.
  48
  49         <p>This call may block the thread. So release all resources
  50         (mutex, semaphore, etc.) before this call.</p>
  51      */
  52     boolean start( [in] string nJobName,
  53              [in] short nCopies,
  54              [in] boolean nCollate )
  55             raises( com::sun::star::awt::PrinterException,
  56                     com::sun::star::lang::IllegalArgumentException );
  57
  58
  59     /** notifies the printer spooler that the job is done and printing
  60         starts.
  61
  62         @see terminate
  63      */
  64     void end()
  65             raises( com::sun::star::awt::PrinterException );
  66
  67
  68     /** stops the current print job.
  69
  70         <p>If the method
  71         com::sun::star::awt::XPrinter::end()
  72         is called beforehand, then this call does nothing. If you call
  73         com::sun::star::awt::XPrinter::terminate()
  74         in or before the call to
  75         com::sun::star::awt::XPrinter::start(),
  76         com::sun::star::awt::XPrinter::terminate()
  77         returns `FALSE`. This call must not block the thread.</p>
  78
  79         @see end
  80      */
  81     void terminate();
  82
  83
  84     /** begins with a new page.
  85      */
  86     com::sun::star::awt::XDevice startPage()
  87             raises( com::sun::star::awt::PrinterException );
  88
  89
  90     /** ends the current page.
  91      */
  92     void endPage()
  93             raises( com::sun::star::awt::PrinterException );
  94
  95 };
  96
  97
  98 }; }; }; };
  99
 100 #endif
 101
 102 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */