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