offapi/com/sun/star/graphic/XPrimitive2DRenderer.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_XPrimitive2DRenderer_idl__
  21 #define __com_sun_star_graphic_XPrimitive2DRenderer_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/rendering/XBitmap.idl>
  25 #include <com/sun/star/beans/PropertyValue.idl>
  26 #include <com/sun/star/geometry/RealRectangle2D.idl>
  27
  28 module com {  module sun {  module star {  module graphic {
  29
  30 interface XPrimitive2D;
  31
  32 /** XPrimitive2DRenderer interface
  33
  34     This interface allows to convert from a sequence of XPrimitive2Ds
  35     to a XBitmap
  36  */
  37 interface XPrimitive2DRenderer : ::com::sun::star::uno::XInterface
  38 {
  39     /** return rasterized version of given XPrimitive2D
  40
  41         @param Primitive2DSequence
  42             The graphic content description
  43
  44         @param aViewInformationSequence
  45             The ViewInformation2D
  46
  47         @param DPI_X
  48             The horizontal resolution of the callers device in pixel per inch. This
  49             value is needed to calculate the correct dimensions of the graphic to be
  50             rasterized. If a value of <value>0</value> is given, a horizontal default
  51             resolution of 72 DPI is used.
  52
  53         @param DPI_Y
  54             The vertical resolution of the callers device in pixel per inch. This
  55             value is needed to calculate the correct dimensions of the graphic to be
  56             rasterized. If a value of <value>0</value> is given, a vertical default
  57             resolution of 72 DPI is used.
  58
  59         @param Range
  60             The range in 1/100th mm of the graphic to be rasterized
  61
  62         @param MaximumQuadraticPixels
  63             The maximum allowed number of pixels to be used to allow limiting the
  64             possible size of used pixels. The AspectRatio is preserved, the result
  65             gets limited to given number. If a value of 0 is given, a default of
  66             500000 is used.
  67      */
  68     com::sun::star::rendering::XBitmap rasterize(
  69         [in] sequence< XPrimitive2D > Primitive2DSequence,
  70         [in] sequence< ::com::sun::star::beans::PropertyValue > aViewInformationSequence,
  71         [in] unsigned long DPI_X,
  72         [in] unsigned long DPI_Y,
  73         [in] ::com::sun::star::geometry::RealRectangle2D Range,
  74         [in] unsigned long MaximumQuadraticPixels);
  75 };
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */