offapi/com/sun/star/awt/XPrinterPropertySet.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XPrinterPropertySet_idl__
  29 #define __com_sun_star_awt_XPrinterPropertySet_idl__
  30
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32
  33 #include <com/sun/star/beans/PropertyVetoException.idl>
  34
  35 #include <com/sun/star/lang/IllegalArgumentException.idl>
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module awt {
  41
  42 //=============================================================================
  43
  44 /** represents an extended property set for printer properties.
  45
  46     <p>All properties are vetoable properties. If you change the properties
  47     between <member scope="com::sun::star::awt">XPrinter::startPage</member>
  48     and <member scope="com::sun::star::awt">XPrinter::endPage</member>, a
  49     <type scope="com::sun::star::beans">PropertyVetoException</type>
  50     is thrown.</p>
  51
  52     @see XPrinter
  53     @see XInfoPrinter
  54  */
  55 published interface XPrinterPropertySet: com::sun::star::beans::XPropertySet
  56 {
  57     //-------------------------------------------------------------------------
  58
  59     /** sets the orientation.
  60      */
  61     void setHorizontal( [in] boolean bHorizontal )
  62             raises( com::sun::star::beans::PropertyVetoException,
  63                     com::sun::star::lang::IllegalArgumentException );
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** returns descriptions of all available printer forms.
  68      */
  69     sequence<string> getFormDescriptions();
  70
  71     //-------------------------------------------------------------------------
  72
  73     /** sets the form that should be used.
  74
  75         <p>Indirectly a printer is selected.</p>
  76      */
  77     void selectForm( [in] string aFormDescription )
  78             raises( com::sun::star::beans::PropertyVetoException,
  79                     com::sun::star::lang::IllegalArgumentException );
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** returns a binary encoded version of the printer setup.
  84      */
  85     sequence<byte> getBinarySetup();
  86
  87     //-------------------------------------------------------------------------
  88
  89     /** sets the data specific to the printer driver.
  90
  91         <p>Get this data from the info printer and set the data to the
  92         printer.</p>
  93      */
  94     void setBinarySetup( [in] sequence<byte> data )
  95             raises( com::sun::star::beans::PropertyVetoException,
  96                     com::sun::star::lang::IllegalArgumentException );
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105
 106 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */