xref: /AOO41X/main/offapi/com/sun/star/graphic/GraphicRendererVCL.idl (revision d5bd2f9e3a2ae3e1afd69ce26d2fa06adc6f3f31)
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
24#ifndef com_sun_star_graphic_GraphicRendererVCL_idl
25#define com_sun_star_graphic_GraphicRendererVCL_idl
26
27#include <com/sun/star/beans/XPropertySet.idl>
28#include <com/sun/star/graphic/XGraphicRenderer.idl>
29#include <com/sun/star/awt/Rectangle.idl>
30
31module com { module sun { module star { module graphic
32{
33
34/** Service that describes the necessary interfaces and properties
35    to render a graphic container of <type>XGraphic</type> type
36
37    <p>To render a <type>XGraphic</type> container, just create an
38    instance of this service, set the appropriate properties and use
39    the <type>XGraphicRenderer</type> interface to initiate the rendering
40    process itself</p>
41 */
42service GraphicRendererVCL
43{
44    /** Interface to initiate the rendering process
45    */
46    interface ::com::sun::star::graphic::XGraphicRenderer;
47
48    /** The property interface by which the properties of all
49        supported services are exchanged
50    */
51    interface ::com::sun::star::beans::XPropertySet;
52
53    /** Holds the device onto which the <type>XGraphic</type>
54        container should be rendered
55
56        <p>In case of using VCL Devices, this property should
57        hold a <type scope="com::sun::star::awt">XDevice</type>
58        interface</p>
59    */
60    [property] any Device;
61
62    /** Specifies the destination rectangle, into which the graphic
63    content is to be rendered onto the device
64    */
65    [property] ::com::sun::star::awt::Rectangle DestinationRect;
66
67
68    /** Additional properties for rendering, unspecified at the moment
69    */
70    [optional, property] any RenderData;
71};
72
73} ; } ; } ; } ;
74
75#endif
76