xref: /trunk/main/offapi/com/sun/star/view/PrintOptions.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_PrintOptions_idl__
28#define __com_sun_star_view_PrintOptions_idl__
29
30
31//=============================================================================
32
33module com {  module sun {  module star {  module view {
34
35//=============================================================================
36
37/** describes the options for print jobs.
38
39    <p>These options are only valid for a single print job. They do not
40    change layout or formatting of the document.
41 */
42published service PrintOptions
43{
44    //-------------------------------------------------------------------------
45    /** specifies the number of copies to print.
46     */
47    [property] short CopyCount;
48
49    //-------------------------------------------------------------------------
50    /** if set, specifies the name of a file to print to.
51     */
52    [property] string FileName;
53
54    //-------------------------------------------------------------------------
55    /** advises the printer to collate the pages of the copies.
56     */
57    [property] boolean Collate;
58
59    //-------------------------------------------------------------------------
60    /** advises the printer to sort the pages of the copies.
61
62        @deprecated
63            Use <member>Collate</member> instead.
64     */
65    [property] boolean Sort;
66
67    //-------------------------------------------------------------------------
68    /** specifies which pages to print.
69
70        <p>This range is given as at the user interface. For example: "1-4;10"
71        to print the pages 1 to 4 and 10. </p>
72     */
73    [property] string Pages;
74
75    //-------------------------------------------------------------------------
76    /** if set to TRUE, the corresponding <type>XPrintable</type>.print() request will
77        be executed synchronous.
78
79            <p>Default is the asynchronous print mode.</p>
80
81        @attention  Using of this property with TRUE as value is highly reommended.
82                Otherwhise following actions (as e.g. closing the corresponding model) can fail.
83     */
84    [optional, property] boolean Wait;
85
86    //-------------------------------------------------------------------------
87    /** determines the duplex mode for the print job.
88
89        @see <type>DuplexMode</type> for more information about supported values
90     */
91    [optional, property] short DuplexMode;
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99