offapi/com/sun/star/awt/XPrinterPropertySet.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 awt {
  23
  24
  25 /** represents an extended property set for printer properties.
  26
  27     <p>All properties are vetoable properties. If you change the properties
  28     between com::sun::star::awt::XPrinter::startPage()
  29     and com::sun::star::awt::XPrinter::endPage(), a
  30     com::sun::star::beans::PropertyVetoException
  31     is thrown.</p>
  32
  33     @see XPrinter
  34     @see XInfoPrinter
  35  */
  36 published interface XPrinterPropertySet: com::sun::star::beans::XPropertySet
  37 {
  38
  39     /** sets the orientation.
  40      */
  41     void setHorizontal( [in] boolean bHorizontal )
  42             raises( com::sun::star::beans::PropertyVetoException,
  43                     com::sun::star::lang::IllegalArgumentException );
  44
  45
  46     /** returns descriptions of all available printer forms.
  47      */
  48     sequence<string> getFormDescriptions();
  49
  50
  51     /** sets the form that should be used.
  52
  53         <p>Indirectly a printer is selected.</p>
  54      */
  55     void selectForm( [in] string aFormDescription )
  56             raises( com::sun::star::beans::PropertyVetoException,
  57                     com::sun::star::lang::IllegalArgumentException );
  58
  59
  60     /** returns a binary encoded version of the printer setup.
  61      */
  62     sequence<byte> getBinarySetup();
  63
  64
  65     /** sets the data specific to the printer driver.
  66
  67         <p>Get this data from the info printer and set the data to the
  68         printer.</p>
  69      */
  70     void setBinarySetup( [in] sequence<byte> data )
  71             raises( com::sun::star::beans::PropertyVetoException,
  72                     com::sun::star::lang::IllegalArgumentException );
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */