xref: /aoo41x/main/offapi/com/sun/star/view/XPrintable.idl (revision d1766043)
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_view_XPrintable_idl__
24#define __com_sun_star_view_XPrintable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.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
41module com {  module sun {  module star {  module view {
42
43//=============================================================================
44
45/** offers printing functionality.
46 */
47published interface XPrintable: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50	/** @returns
51			a descriptor of the current printer.
52
53		<p>The attributes of the current printer are used for formatting.
54
55		@see PrinterDescriptor
56	 */
57	sequence<com::sun::star::beans::PropertyValue> getPrinter();
58
59	//-------------------------------------------------------------------------
60	/** assigns a new printer to the object.
61
62		<p>Setting a new printer will cause reformatting.
63
64		@see PrinterDescriptor
65	 */
66	void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter )
67			raises( com::sun::star::lang::IllegalArgumentException );
68
69	//-------------------------------------------------------------------------
70	/** prints the object.
71
72		@param xOptions
73			specifies the number of copies and some other values which do not
74			affect formatting.
75
76		@see PrintOptions
77	 */
78	void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
79			raises( com::sun::star::lang::IllegalArgumentException );
80
81};
82
83//=============================================================================
84
85}; }; }; };
86
87#endif
88