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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPrimitiveFactory2D.idl,v $
  10  *
  11  * $Revision: 1.2 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31 #ifndef __com_sun_star_graphic_XPrimitiveFactory2D_idl__
  32 #define __com_sun_star_graphic_XPrimitiveFactory2D_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 //////////////////////////////////////////////////////////////////////////////
  42 // predefines
  43
  44 module com {  module sun {  module star {  module drawing {
  45     interface XShape;
  46     interface XDrawPage;
  47 }; }; }; };
  48
  49 //////////////////////////////////////////////////////////////////////////////
  50
  51 module com {  module sun {  module star {  module graphic {
  52
  53 interface XPrimitive2D;
  54
  55 /** XPrimitiveFactory2D interface
  56
  57     Use this interface to generate XPrimitive2D instances
  58  */
  59 interface XPrimitiveFactory2D : ::com::sun::star::uno::XInterface
  60 {
  61     /** Create primitives from <type>::com::sun::star::drawing::XShape</type>
  62
  63         @param xShape
  64         The XShape, for which the primitives are to be
  65         generated. Specifying an invalid or empty shape here will
  66         result in an empty return value.
  67
  68         @param aParms
  69         Sequence of factory parameters, whose semantics depend on the
  70         shape to be generated.
  71
  72         @return a sequence of primitives, that consists of the
  73         geometrical representation from the given XShape.
  74      */
  75     sequence< XPrimitive2D > createPrimitivesFromXShape(
  76         [in] ::com::sun::star::drawing::XShape xShape,
  77         [in] sequence< ::com::sun::star::beans::PropertyValue > aParms );
  78
  79     /** Create primitives from <type>::com::sun::star::drawing::XDrawPage</type>
  80
  81         @param xDrawPage
  82         The XDrawPage, for which the primitives are to be
  83         generated. Specifying an invalid or empty page here will
  84         result in an empty return value.
  85
  86         @param aParms
  87         Sequence of factory parameters, whose semantics depend on the
  88         page to be generated.
  89
  90         @return a sequence of primitives, that consists of the
  91         geometrical representation for the given XDrawPage.
  92      */
  93     sequence< XPrimitive2D > createPrimitivesFromXDrawPage(
  94         [in] ::com::sun::star::drawing::XDrawPage xDrawPage,
  95         [in] sequence< ::com::sun::star::beans::PropertyValue > aParms );
  96
  97 };
  98
  99 }; }; }; };
 100
 101 //////////////////////////////////////////////////////////////////////////////
 102
 103 #endif
 104
 105 // eof