offapi/com/sun/star/awt/XPrinterPropertySet.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: XPrinterPropertySet.idl,v $
  10  * $Revision: 1.12 $
  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_awt_XPrinterPropertySet_idl__
  31 #define __com_sun_star_awt_XPrinterPropertySet_idl__
  32
  33 #ifndef __com_sun_star_beans_XPropertySet_idl__
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyVetoException_idl__
  38 #include <com/sun/star/beans/PropertyVetoException.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 awt {
  49
  50 //=============================================================================
  51
  52 /** represents an extended property set for printer properties.
  53
  54     <p>All properties are vetoable properties. If you change the properties
  55     between <member scope="com::sun::star::awt">XPrinter::startPage</member>
  56     and <member scope="com::sun::star::awt">XPrinter::endPage</member>, a
  57     <type scope="com::sun::star::beans">PropertyVetoException</type>
  58     is thrown.</p>
  59
  60     @see XPrinter
  61     @see XInfoPrinter
  62  */
  63 published interface XPrinterPropertySet: com::sun::star::beans::XPropertySet
  64 {
  65     //-------------------------------------------------------------------------
  66
  67     /** sets the orientation.
  68      */
  69     void setHorizontal( [in] boolean bHorizontal )
  70             raises( com::sun::star::beans::PropertyVetoException,
  71                     com::sun::star::lang::IllegalArgumentException );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** returns descriptions of all available printer forms.
  76      */
  77     sequence<string> getFormDescriptions();
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** sets the form that should be used.
  82
  83         <p>Indirectly a printer is selected.</p>
  84      */
  85     void selectForm( [in] string aFormDescription )
  86             raises( com::sun::star::beans::PropertyVetoException,
  87                     com::sun::star::lang::IllegalArgumentException );
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** returns a binary encoded version of the printer setup.
  92      */
  93     sequence<byte> getBinarySetup();
  94
  95     //-------------------------------------------------------------------------
  96
  97     /** sets the data specific to the printer driver.
  98
  99         <p>Get this data from the info printer and set the data to the
 100         printer.</p>
 101      */
 102     void setBinarySetup( [in] sequence<byte> data )
 103             raises( com::sun::star::beans::PropertyVetoException,
 104                     com::sun::star::lang::IllegalArgumentException );
 105
 106 };
 107
 108 //=============================================================================
 109
 110 }; }; }; };
 111
 112 #endif