offapi/com/sun/star/view/XPrintable.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_XPrintable_idl__
  29 #define __com_sun_star_view_XPrintable_idl__
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32
  33 #include <com/sun/star/beans/PropertyValue.idl>
  34
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module view {
  41
  42 //=============================================================================
  43
  44 /** offers printing functionality.
  45  */
  46 published interface XPrintable: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49     /** @returns
  50             a descriptor of the current printer.
  51
  52         <p>The attributes of the current printer are used for formatting.
  53
  54         @see PrinterDescriptor
  55      */
  56     sequence<com::sun::star::beans::PropertyValue> getPrinter();
  57
  58     //-------------------------------------------------------------------------
  59     /** assigns a new printer to the object.
  60
  61         <p>Setting a new printer will cause reformatting.
  62
  63         @see PrinterDescriptor
  64      */
  65     void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter )
  66             raises( com::sun::star::lang::IllegalArgumentException );
  67
  68     //-------------------------------------------------------------------------
  69     /** prints the object.
  70
  71         @param xOptions
  72             specifies the number of copies and some other values which do not
  73             affect formatting.
  74
  75         @see PrintOptions
  76      */
  77     void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  78             raises( com::sun::star::lang::IllegalArgumentException );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif
  87
  88 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */