xref: /AOO41X/main/offapi/com/sun/star/view/PrinterDescriptor.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_view_PrinterDescriptor_idl__
24#define __com_sun_star_view_PrinterDescriptor_idl__
25
26#ifndef __com_sun_star_view_PaperOrientation_idl__
27#include <com/sun/star/view/PaperOrientation.idl>
28#endif
29
30#ifndef __com_sun_star_view_PaperFormat_idl__
31#include <com/sun/star/view/PaperFormat.idl>
32#endif
33
34#ifndef __com_sun_star_awt_Size_idl__
35#include <com/sun/star/awt/Size.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module view {
42
43//=============================================================================
44
45/** describes a printer by specifying the queue name and some settings.
46
47    <p>This service may be represented by a <type scope="com::sun::star::beans" dim="[]">PropertyValue</type>.
48
49    @see com::sun::star::beans::PropertyValue
50 */
51published service PrinterDescriptor
52{
53    //-------------------------------------------------------------------------
54    /** specifies the name of the printer queue to be used.
55
56        <p>Which printer queues are available, can be figured out with the
57        system library of the used programming language/environment.
58     */
59    [property] string Name;
60
61    //-------------------------------------------------------------------------
62    /** specifies the orientation of the paper.
63     */
64    [property] com::sun::star::view::PaperOrientation PaperOrientation;
65
66    //-------------------------------------------------------------------------
67    /** specifies a predefined paper size or if the paper size
68        is a user-defined size.
69
70        <p>Setting this property may change the value of
71        <member>PrinterDescriptor</member>PaperSize</member.</p>
72     */
73    [property] com::sun::star::view::PaperFormat PaperFormat;
74
75    //-------------------------------------------------------------------------
76    /** specifies the size of the paper in 100th mm.
77
78        <p>Setting this property may change the value of
79        <member>PrinterDescriptor</member>PaperFormat</member.</p>
80     */
81    [property] com::sun::star::awt::Size PaperSize;
82
83    //-------------------------------------------------------------------------
84    /** indicates, whether the printer is busy or not.
85     */
86    [readonly, property] boolean IsBusy;
87
88    //-------------------------------------------------------------------------
89    /** indicates, whether the printer allows changes to
90        <member>PrinterDescriptor::PaperOrientation</member>.
91     */
92    [readonly, property] boolean CanSetPaperOrientation;
93
94    //-------------------------------------------------------------------------
95    /** indicates, whether the printer allows changes to
96        <member>PrinterDescriptor::PaperFormat</member>.
97     */
98    [readonly, property] boolean CanSetPaperFormat;
99
100    //-------------------------------------------------------------------------
101
102    /** indicates if the printer allows changes to
103        <member>PrinterDescriptor::PaperSize</member>.
104     */
105    [readonly, property] boolean CanSetPaperSize;
106
107};
108
109//=============================================================================
110
111}; }; }; };
112
113#endif
114