offapi/com/sun/star/view/XPrintJob.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: XPrintJob.idl,v $
  10  * $Revision: 1.8 $
  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_view_XPrintJob_idl__
  31 #define __com_sun_star_view_XPrintJob_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_view_XPrintable_idl__
  38 #include <com/sun/star/view/XPrintable.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_PropertyValue_idl__
  42 #include <com/sun/star/beans/PropertyValue.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module view {
  49
  50 //-----------------------------------------------------------------------------
  51 /** allows for getting information about a print job.
  52
  53     <p><type>XPrintJob</type> is implemented by print jobs that are created by
  54     classes that implement <type>XPrintable</type>. It gives information about
  55     the context of the print job.</p>
  56
  57     @see XPrintJobListener
  58
  59     @since OOo 1.1.2
  60  */
  61 published interface XPrintJob : com::sun::star::uno::XInterface
  62 {
  63     /** returns the PrintOptions used for the print job
  64      */
  65     sequence<com::sun::star::beans::PropertyValue> getPrintOptions();
  66
  67     /** returns the Printer used for the print job
  68      */
  69     sequence<com::sun::star::beans::PropertyValue> getPrinter();
  70
  71     /** returns the printed object used for the print job
  72      */
  73     XPrintable getPrintable();
  74
  75     void cancelJob();
  76 };
  77
  78 }; }; }; };
  79
  80 #endif