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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22 module com {  module sun {  module star {  module view {
  23
  24
  25 /** offers printing functionality.
  26  */
  27 published interface XPrintable: com::sun::star::uno::XInterface
  28 {
  29     /** @returns
  30             a descriptor of the current printer.
  31
  32         <p>The attributes of the current printer are used for formatting.
  33
  34         @see PrinterDescriptor
  35      */
  36     sequence<com::sun::star::beans::PropertyValue> getPrinter();
  37
  38     /** assigns a new printer to the object.
  39
  40         <p>Setting a new printer will cause reformatting.
  41
  42         @see PrinterDescriptor
  43      */
  44     void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter )
  45             raises( com::sun::star::lang::IllegalArgumentException );
  46
  47     /** prints the object.
  48
  49         @param xOptions
  50             specifies the number of copies and some other values which do not
  51             affect formatting.
  52
  53         @see PrintOptions
  54      */
  55     void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
  56             raises( com::sun::star::lang::IllegalArgumentException );
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */