summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/text/PrintSettings.idl
blob: 82f55f3bc2b6aedbf19105ed84308eaef2dafc6f (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
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_text_PrintSettings_idl__
#define __com_sun_star_text_PrintSettings_idl__

#ifndef __com_sun_star_text_NotePrintMode_idl__
#include <com/sun/star/text/NotePrintMode.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

// DocMerge from xml: service com::sun::star::text::PrintSettings
/** These properties describe the printing of the content of a text document.
 */
published service PrintSettings
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintGraphics
    /** determines if graphic objects are printed
     */
    [property] boolean PrintGraphics;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintTables
    /** determines if text tables are printed.
     */
    [property] boolean PrintTables;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintDrawings
    /** determines if shapes are printed.
     */
    [property] boolean PrintDrawings;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintLeftPage
    /** determines if left pages are printed.
     */
    [property] boolean PrintLeftPages;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintRightPage
    /** determines if right pages are printed.
     */
    [property] boolean PrintRightPages;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintControls
    /** determines if control shapes are printed.
     */
    [property] boolean PrintControls;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintReverse
    /** determines if the pages are printed in the reverse order, starting with the last page.
     */
    [property] boolean PrintReversed;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PaperFromSetup
    /** specifies if the printer paper tray selection of the system
        printer is used.



        <p>If <member scope="com::sun::star::view">PrintSettings::PaperFromSetup</member> is <FALSE/>,
        then the paper tray selection of the page styles is used.</p>
     */
    [property] boolean PrintPaperFromSetup;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::FaxName
    /** contains the name of the fax.
     */
    [property] string PrintFaxName;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintNotes
    /** determines how notes are printed.@see NotePrintMode
     */
    [property] com::sun::star::text::NotePrintMode PrintAnnotationMode;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintProspect
    /** determines if prospect printing is used.
     */
    [property] boolean PrintProspect;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBackground
    /** determines if the background color / background graphic of pages is printed.
     */
    [property] boolean PrintPageBackground;

    //-------------------------------------------------------------------------

    // DocMerge from xml: property com::sun::star::text::PrintSettings::PrintBlackFont
    /** determines if characters are always printed in black.
     */
    [property] boolean PrintBlackFonts;

        //-------------------------------------------------------------------------

        /** determines if automatically inserted empty pages are printed.
         */
        [optional, property] boolean PrintEmptyPages;
};

//=============================================================================

}; }; }; };

#endif