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