xref: /AOO41X/main/offapi/com/sun/star/awt/XPrinterPropertySet.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XPrinterPropertySet_idl__
24#define __com_sun_star_awt_XPrinterPropertySet_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyVetoException_idl__
31#include <com/sun/star/beans/PropertyVetoException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module awt {
42
43//=============================================================================
44
45/** represents an extended property set for printer properties.
46
47    <p>All properties are vetoable properties. If you change the properties
48    between <member scope="com::sun::star::awt">XPrinter::startPage</member>
49    and <member scope="com::sun::star::awt">XPrinter::endPage</member>, a
50    <type scope="com::sun::star::beans">PropertyVetoException</type>
51    is thrown.</p>
52
53    @see XPrinter
54    @see XInfoPrinter
55 */
56published interface XPrinterPropertySet: com::sun::star::beans::XPropertySet
57{
58    //-------------------------------------------------------------------------
59
60    /** sets the orientation.
61     */
62    void setHorizontal( [in] boolean bHorizontal )
63            raises( com::sun::star::beans::PropertyVetoException,
64                    com::sun::star::lang::IllegalArgumentException );
65
66    //-------------------------------------------------------------------------
67
68    /** returns descriptions of all available printer forms.
69     */
70    sequence<string> getFormDescriptions();
71
72    //-------------------------------------------------------------------------
73
74    /** sets the form that should be used.
75
76        <p>Indirectly a printer is selected.</p>
77     */
78    void selectForm( [in] string aFormDescription )
79            raises( com::sun::star::beans::PropertyVetoException,
80                    com::sun::star::lang::IllegalArgumentException );
81
82    //-------------------------------------------------------------------------
83
84    /** returns a binary encoded version of the printer setup.
85     */
86    sequence<byte> getBinarySetup();
87
88    //-------------------------------------------------------------------------
89
90    /** sets the data specific to the printer driver.
91
92        <p>Get this data from the info printer and set the data to the
93        printer.</p>
94     */
95    void setBinarySetup( [in] sequence<byte> data )
96            raises( com::sun::star::beans::PropertyVetoException,
97                    com::sun::star::lang::IllegalArgumentException );
98
99};
100
101//=============================================================================
102
103}; }; }; };
104
105#endif
106