offapi/com/sun/star/graphic/XPrimitiveFactory2D.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 #ifndef __com_sun_star_graphic_XPrimitiveFactory2D_idl__
  20 #define __com_sun_star_graphic_XPrimitiveFactory2D_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/beans/PropertyValue.idl>
  24
  25
  26 // predefines
  27
  28 module com {  module sun {  module star {  module drawing {
  29     interface XShape;
  30     interface XDrawPage;
  31 }; }; }; };
  32
  33
  34
  35 module com {  module sun {  module star {  module graphic {
  36
  37 interface XPrimitive2D;
  38
  39 /** XPrimitiveFactory2D interface
  40
  41     Use this interface to generate XPrimitive2D instances
  42  */
  43 interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface
  44 {
  45     /** Create primitives from ::com::sun::star::drawing::XShape
  46
  47         @param xShape
  48         The XShape, for which the primitives are to be
  49         generated. Specifying an invalid or empty shape here will
  50         result in an empty return value.
  51
  52         @param aParms
  53         Sequence of factory parameters, whose semantics depend on the
  54         shape to be generated.
  55
  56         @return a sequence of primitives, that consists of the
  57         geometrical representation from the given XShape.
  58      */
  59     sequence< XPrimitive2D > createPrimitivesFromXShape(
  60         [in] ::com::sun::star::drawing::XShape xShape,
  61         [in] sequence< ::com::sun::star::beans::PropertyValue > aParms );
  62
  63     /** Create primitives from ::com::sun::star::drawing::XDrawPage
  64
  65         @param xDrawPage
  66         The XDrawPage, for which the primitives are to be
  67         generated. Specifying an invalid or empty page here will
  68         result in an empty return value.
  69
  70         @param aParms
  71         Sequence of factory parameters, whose semantics depend on the
  72         page to be generated.
  73
  74         @return a sequence of primitives, that consists of the
  75         geometrical representation for the given XDrawPage.
  76      */
  77     sequence< XPrimitive2D > createPrimitivesFromXDrawPage(
  78         [in] ::com::sun::star::drawing::XDrawPage xDrawPage,
  79         [in] sequence< ::com::sun::star::beans::PropertyValue > aParms );
  80
  81 };
  82
  83 }; }; }; };
  84
  85
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */