xref: /AOO41X/main/offapi/com/sun/star/view/XPrintable.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_XPrintable_idl__
28#define __com_sun_star_view_XPrintable_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_PropertyValue_idl__
35#include <com/sun/star/beans/PropertyValue.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module view {
46
47//=============================================================================
48
49/** offers printing functionality.
50 */
51published interface XPrintable: com::sun::star::uno::XInterface
52{
53    //-------------------------------------------------------------------------
54    /** @returns
55            a descriptor of the current printer.
56
57        <p>The attributes of the current printer are used for formatting.
58
59        @see PrinterDescriptor
60     */
61    sequence<com::sun::star::beans::PropertyValue> getPrinter();
62
63    //-------------------------------------------------------------------------
64    /** assigns a new printer to the object.
65
66        <p>Setting a new printer will cause reformatting.
67
68        @see PrinterDescriptor
69     */
70    void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter )
71            raises( com::sun::star::lang::IllegalArgumentException );
72
73    //-------------------------------------------------------------------------
74    /** prints the object.
75
76        @param xOptions
77            specifies the number of copies and some other values which do not
78            affect formatting.
79
80        @see PrintOptions
81     */
82    void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
83            raises( com::sun::star::lang::IllegalArgumentException );
84
85};
86
87//=============================================================================
88
89}; }; }; };
90
91#endif
92