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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef com_sun_star_graphic_GraphicRendererVCL_idl
  21 #define com_sun_star_graphic_GraphicRendererVCL_idl
  22
  23 #include <com/sun/star/beans/XPropertySet.idl>
  24 #include <com/sun/star/graphic/XGraphicRenderer.idl>
  25 #include <com/sun/star/awt/Rectangle.idl>
  26
  27 module com { module sun { module star { module graphic
  28 {
  29
  30 /** Service that describes the necessary interfaces and properties
  31     to render a graphic container of XGraphic type
  32
  33     <p>To render a XGraphic container, just create an
  34     instance of this service, set the appropriate properties and use
  35     the XGraphicRenderer interface to initiate the rendering
  36     process itself</p>
  37  */
  38 service GraphicRendererVCL
  39 {
  40     /** Interface to initiate the rendering process
  41     */
  42     interface ::com::sun::star::graphic::XGraphicRenderer;
  43
  44     /** The property interface by which the properties of all
  45         supported services are exchanged
  46     */
  47     interface ::com::sun::star::beans::XPropertySet;
  48
  49     /** Holds the device onto which the XGraphic
  50         container should be rendered
  51
  52         <p>In case of using VCL Devices, this property should
  53         hold a com::sun::star::awt::XDevice
  54         interface</p>
  55     */
  56     [property] any Device;
  57
  58     /** Specifies the destination rectangle, into which the graphic
  59     content is to be rendered onto the device
  60     */
  61     [property] ::com::sun::star::awt::Rectangle DestinationRect;
  62
  63
  64     /** Additional properties for rendering, unspecified at the moment
  65     */
  66     [optional, property] any RenderData;
  67 };
  68
  69 } ; } ; } ; } ;
  70
  71 #endif
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */