xref: /aoo41x/main/offapi/com/sun/star/view/XPrintJob.idl (revision 34c958ab)
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_XPrintJob_idl__
24#define __com_sun_star_view_XPrintJob_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_view_XPrintable_idl__
31#include <com/sun/star/view/XPrintable.idl>
32#endif
33
34#ifndef __com_sun_star_beans_PropertyValue_idl__
35#include <com/sun/star/beans/PropertyValue.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module view {
42
43//-----------------------------------------------------------------------------
44/** allows for getting information about a print job.
45
46	<p><type>XPrintJob</type> is implemented by print jobs that are created by
47	classes that implement <type>XPrintable</type>. It gives information about
48	the context of the print job.</p>
49
50	@see XPrintJobListener
51
52    @since OpenOffice 1.1.2
53 */
54published interface XPrintJob : com::sun::star::uno::XInterface
55{
56	/** returns the PrintOptions used for the print job
57	 */
58	sequence<com::sun::star::beans::PropertyValue> getPrintOptions();
59
60	/** returns the Printer used for the print job
61	 */
62	sequence<com::sun::star::beans::PropertyValue> getPrinter();
63
64	/** returns the printed object used for the print job
65	 */
66	XPrintable getPrintable();
67
68	void cancelJob();
69};
70
71}; }; }; };
72
73#endif
74