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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XRenderable.idl,v $
* $Revision: 1.13 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_view_XRenderable_idl__
#define __com_sun_star_view_XRenderable_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 {
//=============================================================================
/** represents something that can be rendered.
@since OOo 1.1.2
*/
published interface XRenderable : com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** @returns
the count of renderers (based on paper count of a document, for example).
<p> If a selection is given, the count has to be calculated
based on this selection. The other methods of this interface
will rely on this value if called.
<p> If the selection contains a valid XModel interface,
it is assumed that the whole document should be rendered.
If the selection is empty, nothing should be rendered.
@see RenderOptions
*/
long getRendererCount( [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** @returns
a descriptor of the specific renderer.
<p> returns the specific renderer properties based on the given selection.
<p> If the selection contains a valid XModel interface,
it is assumed that the whole document should be rendered.
If the selection is empty, nothing should be rendered.
@see RenderDescriptor
@see RenderOptions
*/
sequence<com::sun::star::beans::PropertyValue> getRenderer( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
raises( com::sun::star::lang::IllegalArgumentException );
//-------------------------------------------------------------------------
/** renders the object.
<p> renders the object with the specific renderer based on the given selection.
<p> If the selection contains a valid XModel interface,
it is assumed that the whole document should be rendered.
If the selection is empty, nothing should be rendered.
@see RenderOptions
*/
void render( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
raises( com::sun::star::lang::IllegalArgumentException );
};
//=============================================================================
}; }; }; };
#endif
|
