summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/view/XPrintable.idl
blob: 3a5668565ab72c01911500826c4d204c66c84d2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_view_XPrintable_idl__
#define __com_sun_star_view_XPrintable_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module view {

//=============================================================================

/** offers printing functionality.
 */
published interface XPrintable: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** @returns
            a descriptor of the current printer.

        <p>The attributes of the current printer are used for formatting.

        @see PrinterDescriptor
     */
    sequence<com::sun::star::beans::PropertyValue> getPrinter();

    //-------------------------------------------------------------------------
    /** assigns a new printer to the object.

        <p>Setting a new printer will cause reformatting.

        @see PrinterDescriptor
     */
    void setPrinter( [in] sequence<com::sun::star::beans::PropertyValue> aPrinter )
            raises( com::sun::star::lang::IllegalArgumentException );

    //-------------------------------------------------------------------------
    /** prints the object.

        @param xOptions
            specifies the number of copies and some other values which do not
            affect formatting.

        @see PrintOptions
     */
    void print( [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
            raises( com::sun::star::lang::IllegalArgumentException );

};

//=============================================================================

}; }; }; };

#endif