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
  20
  21
  22  module com {  module sun {  module star {  module awt {
  23
  24
  25 /** represents a virtual printer.
  26
  27     <p>All properties are vetoable properties.
  28     If you change the properties between a call to
  29     com::sun::star::awt::XPrinter::startPage() and a call
  30     to com::sun::star::awt::XPrinter::endPage(),
  31     a com::sun::star::beans::PropertyVetoException is
  32     thrown.</p>
  33  */
  34 published interface XPrinter: com::sun::star::awt::XPrinterPropertySet
  35 {
  36
  37     /** puts the job into the printer spooler.
  38
  39         <p>This call may block the thread. So release all resources
  40         (mutex, semaphore, etc.) before this call.</p>
  41      */
  42     boolean start( [in] string nJobName,
  43              [in] short nCopies,
  44              [in] boolean nCollate )
  45             raises( com::sun::star::awt::PrinterException,
  46                     com::sun::star::lang::IllegalArgumentException );
  47
  48
  49     /** notifies the printer spooler that the job is done and printing
  50         starts.
  51
  52         @see terminate
  53      */
  54     void end()
  55             raises( com::sun::star::awt::PrinterException );
  56
  57
  58     /** stops the current print job.
  59
  60         <p>If the method
  61         com::sun::star::awt::XPrinter::end()
  62         is called beforehand, then this call does nothing. If you call
  63         com::sun::star::awt::XPrinter::terminate()
  64         in or before the call to
  65         com::sun::star::awt::XPrinter::start(),
  66         com::sun::star::awt::XPrinter::terminate()
  67         returns `FALSE`. This call must not block the thread.</p>
  68
  69         @see end
  70      */
  71     void terminate();
  72
  73
  74     /** begins with a new page.
  75      */
  76     com::sun::star::awt::XDevice startPage()
  77             raises( com::sun::star::awt::PrinterException );
  78
  79
  80     /** ends the current page.
  81      */
  82     void endPage()
  83             raises( com::sun::star::awt::PrinterException );
  84
  85 };
  86
  87
  88 }; }; }; };
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */