summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/view/PrinterDescriptor.idl
blob: 17ec7a9b0964c9b164edcf9de8c26f2838d2a4a3 (plain)
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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */



module com {  module sun {  module star {  module view {


/** describes a printer by specifying the queue name and some settings.

    <p>This service may be represented by a
    com::sun::star::beans::PropertyValue[].

    @see com::sun::star::beans::PropertyValue
 */
published service PrinterDescriptor
{
    /** specifies the name of the printer queue to be used.

        <p>Which printer queues are available, can be figured out with the
        system library of the used programming language/environment.
     */
    [property] string Name;

    /** specifies the orientation of the paper.
     */
    [property] com::sun::star::view::PaperOrientation PaperOrientation;

    /** specifies a predefined paper size or if the paper size
        is a user-defined size.

        <p>Setting this property may change the value of
        PrinterDescriptor::PaperSize.</p>
     */
    [property] com::sun::star::view::PaperFormat PaperFormat;

    /** specifies the size of the paper in 100th mm.

        <p>Setting this property may change the value of
        PrinterDescriptor::PaperFormat.</p>
     */
    [property] com::sun::star::awt::Size PaperSize;

    /** indicates, whether the printer is busy or not.
     */
    [readonly, property] boolean IsBusy;

    /** indicates, whether the printer allows changes to
        PrinterDescriptor::PaperOrientation.
     */
    [readonly, property] boolean CanSetPaperOrientation;

    /** indicates, whether the printer allows changes to
        PrinterDescriptor::PaperFormat.
     */
    [readonly, property] boolean CanSetPaperFormat;


    /** indicates if the printer allows changes to
        PrinterDescriptor::PaperSize.
     */
    [readonly, property] boolean CanSetPaperSize;

};


}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */