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

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