summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/graphic/GraphicRendererVCL.idl
blob: 7fffef432bef0cf79e309b2b0abfa5ef03654f9b (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef com_sun_star_graphic_GraphicRendererVCL_idl
#define com_sun_star_graphic_GraphicRendererVCL_idl

#include <com/sun/star/beans/XPropertySet.idl>
#include <com/sun/star/graphic/XGraphicRenderer.idl>
#include <com/sun/star/awt/Rectangle.idl>

module com { module sun { module star { module graphic
{

/** Service that describes the necessary interfaces and properties
    to render a graphic container of XGraphic type

    <p>To render a XGraphic container, just create an
    instance of this service, set the appropriate properties and use
    the XGraphicRenderer interface to initiate the rendering
    process itself</p>
 */
service GraphicRendererVCL
{
    /** Interface to initiate the rendering process
    */
    interface ::com::sun::star::graphic::XGraphicRenderer;

    /** The property interface by which the properties of all
        supported services are exchanged
    */
    interface ::com::sun::star::beans::XPropertySet;

    /** Holds the device onto which the XGraphic
        container should be rendered

        <p>In case of using VCL Devices, this property should
        hold a com::sun::star::awt::XDevice
        interface</p>
    */
    [property] any Device;

    /** Specifies the destination rectangle, into which the graphic
    content is to be rendered onto the device
    */
    [property] ::com::sun::star::awt::Rectangle DestinationRect;


    /** Additional properties for rendering, unspecified at the moment
    */
    [optional, property] any RenderData;
};

} ; } ; } ; } ;

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */