offapi/com/sun/star/graphic/GraphicRendererVCL.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: GraphicRendererVCL.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef com_sun_star_graphic_GraphicRendererVCL_idl
  32 #define com_sun_star_graphic_GraphicRendererVCL_idl
  33
  34 #include <com/sun/star/beans/XPropertySet.idl>
  35 #include <com/sun/star/graphic/XGraphicRenderer.idl>
  36 #include <com/sun/star/awt/Rectangle.idl>
  37
  38 module com { module sun { module star { module graphic
  39 {
  40
  41 /** Service that describes the necessary interfaces and properties
  42     to render a graphic container of <type>XGraphic</type> type
  43
  44     <p>To render a <type>XGraphic</type> container, just create an
  45     instance of this service, set the appropriate properties and use
  46     the <type>XGraphicRenderer</type> interface to initiate the rendering
  47     process itself</p>
  48  */
  49 service GraphicRendererVCL
  50 {
  51     /** Interface to initiate the rendering process
  52     */
  53     interface ::com::sun::star::graphic::XGraphicRenderer;
  54
  55     /** The property interface by which the properties of all
  56         supported services are exchanged
  57     */
  58     interface ::com::sun::star::beans::XPropertySet;
  59
  60     /** Holds the device onto which the <type>XGraphic</type>
  61         container should be rendered
  62
  63         <p>In case of using VCL Devices, this property should
  64         hold a <type scope="com::sun::star::awt">XDevice</type>
  65         interface</p>
  66     */
  67     [property] any Device;
  68
  69     /** Specifies the destination rectangle, into which the graphic
  70     content is to be rendered onto the device
  71     */
  72     [property] ::com::sun::star::awt::Rectangle DestinationRect;
  73
  74
  75     /** Additional properties for rendering, unspecified at the moment
  76     */
  77     [optional, property] any RenderData;
  78 };
  79
  80 } ; } ; } ; } ;
  81
  82 #endif