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