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