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_view_XRenderable_idl__
24#define __com_sun_star_view_XRenderable_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
40module com {  module sun {  module star {  module view {
41
42//=============================================================================
43
44/** represents something that can be rendered.
45
46    @since OpenOffice 1.1.2
47 */
48published interface XRenderable : com::sun::star::uno::XInterface
49{
50	//-------------------------------------------------------------------------
51
52	/** @returns
53			the count of renderers (based on paper count of a document, for example).
54
55		<p> If a selection is given, the count has to be calculated
56			based on this selection. The other methods of this interface
57			will rely on this value if called.
58
59        <p> If the selection contains a valid XModel interface,
60			it is assumed that the whole document should be rendered.
61			If the selection is empty, nothing should be rendered.
62
63		@see RenderOptions
64	 */
65	long getRendererCount( [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
66			raises( com::sun::star::lang::IllegalArgumentException );
67
68	//-------------------------------------------------------------------------
69
70	/** @returns
71			a descriptor of the specific renderer.
72
73		<p> returns the specific renderer properties based on the given selection.
74
75        <p> If the selection contains a valid XModel interface,
76			it is assumed that the whole document should be rendered.
77			If the selection is empty, nothing should be rendered.
78
79		@see RenderDescriptor
80		@see RenderOptions
81	 */
82	sequence<com::sun::star::beans::PropertyValue> getRenderer( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
83			raises( com::sun::star::lang::IllegalArgumentException );
84
85	//-------------------------------------------------------------------------
86
87	/** renders the object.
88
89		<p> renders the object with the specific renderer based on the given selection.
90
91        <p> If the selection contains a valid XModel interface,
92			it is assumed that the whole document should be rendered.
93			If the selection is empty, nothing should be rendered.
94
95		@see RenderOptions
96	 */
97	void render( [in] long nRenderer, [in] any aSelection, [in] sequence<com::sun::star::beans::PropertyValue> xOptions )
98			raises( com::sun::star::lang::IllegalArgumentException );
99
100};
101
102//=============================================================================
103
104}; }; }; };
105
106#endif
107