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_RenderOptions_idl__
24#define __com_sun_star_view_RenderOptions_idl__
25
26#ifndef __com_sun_star_awt_XDevice_idl__
27#include <com/sun/star/awt/XDevice.idl>
28#endif
29
30//=============================================================================
31
32module com {  module sun {  module star {  module view {
33
34//=============================================================================
35
36/** describes the options for Render jobs.
37
38    @since OOo 1.1.2
39 */
40published service RenderOptions
41{
42	//-------------------------------------------------------------------------
43
44	/** specifies the device the page should be rendered to
45	 */
46	[property] com::sun::star::awt::XDevice RenderDevice;
47
48    //-------------------------------------------------------------------------
49
50    /** indicates that the current page is the first page to be exported.
51
52        <p>Hyperlinks, notes, and outlines cannot be exported on a per
53        page base. They have to be exported once *before* the first page
54        is exported. Therefore the IsFirstPage property has been introduced.
55        It is evaluated in the ::render function and indicates that the
56        current page is the first page to be exported.
57        </p>
58
59        @see XRenderable
60     */
61    [optional, property] boolean IsFirstPage;
62    //-------------------------------------------------------------------------
63
64    /** indicates that the current page is the last page to be exported.
65
66        <p>Hyperlinks from the EditEngine have to be exported once *after*
67        the last page has been processed. Therefore the IsLastPage property
68        has been introduced. It is evaluated in the ::render function and
69        indicates that the current page is the last page to be exported.
70        </p>
71
72        @see XRenderable
73     */
74    [optional, property] boolean IsLastPage;
75    //-------------------------------------------------------------------------
76
77    /** specifies if empty pages should be skipped.
78
79        <p>Tells the pdf export to skip empty pages. This flag also has
80        to be passed to the ::render function, in order to calculate to
81        correct page numbers during the export of hyperlinks, notes, and
82        outlines.
83        </p>
84
85        @see XRenderable
86     */
87    [optional, property] boolean IsSkipEmptyPages;
88    //-------------------------------------------------------------------------
89
90    /** specifies the page ranges to be rendered.
91
92        <p>Tells the pdf export to skip empty pages. This flag also has
93        to be passed to the ::render function, in order to calculate to
94        correct page numbers during the export of hyperlinks, notes,
95        and outlines.
96        </p>
97
98        @see XRenderable
99     */
100    [optional, property] string PageRange;
101};
102
103//=============================================================================
104
105}; }; }; };
106
107
108#endif
109