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