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