1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XPrinter.idl,v $
* $Revision: 1.13 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_awt_XPrinter_idl__
#define __com_sun_star_awt_XPrinter_idl__
#ifndef __com_sun_star_awt_XPrinterPropertySet_idl__
#include <com/sun/star/awt/XPrinterPropertySet.idl>
#endif
#ifndef __com_sun_star_awt_PrinterException_idl__
#include <com/sun/star/awt/PrinterException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_awt_XDevice_idl__
#include <com/sun/star/awt/XDevice.idl>
#endif
//=============================================================================
module com { module sun { module star { module awt {
//=============================================================================
/** represents a virtual printer.
<p>All properties are vetoable properties.
If you change the properties between a call to
<member scope="com::sun::star::awt">XPrinter::startPage</member> and a call
to <member scope="com::sun::star::awt">XPrinter::endPage</member>,
a <type scope="com::sun::star::beans">PropertyVetoException</type> is
thrown.</p>
*/
published interface XPrinter: com::sun::star::awt::XPrinterPropertySet
{
//-------------------------------------------------------------------------
/** puts the job into the printer spooler.
<p>This call may block the thread. So release all resources
(mutex, semaphore, etc.) before this call.</p>
*/
boolean start( [in] string nJobName,
[in] short nCopies,
[in] boolean nCollate )
raises( com::sun::star::awt::PrinterException,
com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** notifies the printer spooler that the job is done and printing
starts.
@see terminate
*/
void end()
raises( com::sun::star::awt::PrinterException );
//-------------------------------------------------------------------------
/** stops the current print job.
<p>If the method
<member scope="com::sun::star::awt">XPrinter::end</member>
is called beforehand, then this call does nothing. If you call
<member scope="com::sun::star::awt">XPrinter::terminate</member>
in or before the call to
<member scope="com::sun::star::awt">XPrinter::start</member>,
<member scope="com::sun::star::awt">XPrinter::terminate</member>
returns <FALSE/>. This call must not block the thread.</p>
@see end
*/
void terminate();
//-------------------------------------------------------------------------
/** begins with a new page.
*/
com::sun::star::awt::XDevice startPage()
raises( com::sun::star::awt::PrinterException );
//-------------------------------------------------------------------------
/** ends the current page.
*/
void endPage()
raises( com::sun::star::awt::PrinterException );
};
//=============================================================================
}; }; }; };
#endif
|