xref: /AOO41X/main/offapi/com/sun/star/text/XPagePrintable.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_text_XPagePrintable_idl__
24#define __com_sun_star_text_XPagePrintable_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module text {
42
43//=============================================================================
44
45/** Print several pages on one printer page.
46 */
47published interface XPagePrintable: com::sun::star::uno::XInterface
48{
49    //-------------------------------------------------------------------------
50
51    /** @returns the settings of printing of pages.
52             <p>
53             These settings contains:
54            <UL>
55                <LI><P>short PageRows  - number of rows of pages printed to one page  </P>
56                <LI><P>short PageColumns - number of columns of pages printed to one page</P>
57                <LI><P>long LeftMargin  - left margin of the page</P>
58                <LI><P>long RightMargin - right margin of the page</P>
59                <LI><P>long TopMargin   - top margin of the page</P>
60                <LI><P>long BottomMargin - bottom margin of the page</P>
61                <LI><P>long HoriMargin  - margin between rows of pages</P>
62                <LI><P>long VertMargin  - margin between columns of pages</P>
63                <LI><P>boolean IsLandscape - determins if the output page is printed in landscape format</P>
64            </UL>
65             </p>
66     */
67    sequence<com::sun::star::beans::PropertyValue> getPagePrintSettings();
68
69    //-------------------------------------------------------------------------
70        /** adjusts the settings of the page printing.
71            @see getPagePrintSettings
72     */
73    void setPagePrintSettings( [in] sequence<com::sun::star::beans::PropertyValue> aSettings );
74
75    //-------------------------------------------------------------------------
76
77    // DocMerge from xml: method com::sun::star::text::XPagePrintable::printPages
78    /** prints the pages according to the <typ>PagePrintSettings</type>.
79
80    @see com::sun::star::view::PrintOptions
81     */
82    void printPages( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
83            raises( com::sun::star::lang::IllegalArgumentException );
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91
92#endif
93