1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_view_PrinterDescriptor_idl__
28#define __com_sun_star_view_PrinterDescriptor_idl__
29
30#ifndef __com_sun_star_view_PaperOrientation_idl__
31#include <com/sun/star/view/PaperOrientation.idl>
32#endif
33
34#ifndef __com_sun_star_view_PaperFormat_idl__
35#include <com/sun/star/view/PaperFormat.idl>
36#endif
37
38#ifndef __com_sun_star_awt_Size_idl__
39#include <com/sun/star/awt/Size.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module view {
46
47//=============================================================================
48
49/** describes a printer by specifying the queue name and some settings.
50
51	<p>This service may be represented by a <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
52
53	@see com::sun::star::beans::PropertyValue
54 */
55published service PrinterDescriptor
56{
57	//-------------------------------------------------------------------------
58	/** specifies the name of the printer queue to be used.
59
60		<p>Which printer queues are available, can be figured out with the
61		system library of the used programming language/environment.
62	 */
63	[property] string Name;
64
65	//-------------------------------------------------------------------------
66	/** specifies the orientation of the paper.
67	 */
68	[property] com::sun::star::view::PaperOrientation PaperOrientation;
69
70	//-------------------------------------------------------------------------
71	/** specifies a predefined paper size or if the paper size
72		is a user-defined size.
73
74		<p>Setting this property may change the value of
75		<member>PrinterDescriptor</member>PaperSize</member.</p>
76	 */
77	[property] com::sun::star::view::PaperFormat PaperFormat;
78
79	//-------------------------------------------------------------------------
80	/** specifies the size of the paper in 100th mm.
81
82		<p>Setting this property may change the value of
83		<member>PrinterDescriptor</member>PaperFormat</member.</p>
84	 */
85	[property] com::sun::star::awt::Size PaperSize;
86
87	//-------------------------------------------------------------------------
88	/** indicates, whether the printer is busy or not.
89	 */
90	[readonly, property] boolean IsBusy;
91
92	//-------------------------------------------------------------------------
93	/** indicates, whether the printer allows changes to
94		<member>PrinterDescriptor::PaperOrientation</member>.
95	 */
96	[readonly, property] boolean CanSetPaperOrientation;
97
98	//-------------------------------------------------------------------------
99	/** indicates, whether the printer allows changes to
100		<member>PrinterDescriptor::PaperFormat</member>.
101	 */
102	[readonly, property] boolean CanSetPaperFormat;
103
104	//-------------------------------------------------------------------------
105
106	/** indicates if the printer allows changes to
107		<member>PrinterDescriptor::PaperSize</member>.
108	 */
109	[readonly, property] boolean CanSetPaperSize;
110
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118