offapi/com/sun/star/view/XPrintJob.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_view_XPrintJob_idl__
  28 #define __com_sun_star_view_XPrintJob_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_view_XPrintable_idl__
  35 #include <com/sun/star/view/XPrintable.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_PropertyValue_idl__
  39 #include <com/sun/star/beans/PropertyValue.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module view {
  46
  47 //-----------------------------------------------------------------------------
  48 /** allows for getting information about a print job.
  49
  50     <p><type>XPrintJob</type> is implemented by print jobs that are created by
  51     classes that implement <type>XPrintable</type>. It gives information about
  52     the context of the print job.</p>
  53
  54     @see XPrintJobListener
  55
  56     @since OOo 1.1.2
  57  */
  58 published interface XPrintJob : com::sun::star::uno::XInterface
  59 {
  60     /** returns the PrintOptions used for the print job
  61      */
  62     sequence<com::sun::star::beans::PropertyValue> getPrintOptions();
  63
  64     /** returns the Printer used for the print job
  65      */
  66     sequence<com::sun::star::beans::PropertyValue> getPrinter();
  67
  68     /** returns the printed object used for the print job
  69      */
  70     XPrintable getPrintable();
  71
  72     void cancelJob();
  73 };
  74
  75 }; }; }; };
  76
  77 #endif