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 module com { module sun { module star { module graphic
  21 {
  22
  23 /** Service that describes the necessary interfaces and properties
  24     to render a graphic container of XGraphic type
  25
  26     <p>To render a XGraphic container, just create an
  27     instance of this service, set the appropriate properties and use
  28     the XGraphicRenderer interface to initiate the rendering
  29     process itself</p>
  30  */
  31 service GraphicRendererVCL
  32 {
  33     /** Interface to initiate the rendering process
  34     */
  35     interface ::com::sun::star::graphic::XGraphicRenderer;
  36
  37     /** The property interface by which the properties of all
  38         supported services are exchanged
  39     */
  40     interface ::com::sun::star::beans::XPropertySet;
  41
  42     /** Holds the device onto which the XGraphic
  43         container should be rendered
  44
  45         <p>In case of using VCL Devices, this property should
  46         hold a com::sun::star::awt::XDevice
  47         interface</p>
  48     */
  49     [property] any Device;
  50
  51     /** Specifies the destination rectangle, into which the graphic
  52     content is to be rendered onto the device
  53     */
  54     [property] ::com::sun::star::awt::Rectangle DestinationRect;
  55
  56
  57     /** Additional properties for rendering, unspecified at the moment
  58     */
  59     [optional, property] any RenderData;
  60 };
  61
  62 } ; } ; } ; } ;
  63
  64 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */