merge the formfield patch from ooo-build
[ooovba.git] / offapi / com / sun / star / drawing / XShapeCombiner.idl
blob724a8cb3ea8e708e3e8dfcced1f3ffc56a8e9aa7
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XShapeCombiner.idl,v $
10 * $Revision: 1.8 $
12 * This file is part of OpenOffice.org.
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
29 ************************************************************************/
30 #ifndef __com_sun_star_drawing_XShapeCombiner_idl__
31 #define __com_sun_star_drawing_XShapeCombiner_idl__
33 #ifndef __com_sun_star_uno_XInterface_idl__
34 #include <com/sun/star/uno/XInterface.idl>
35 #endif
37 #ifndef __com_sun_star_drawing_XShape_idl__
38 #include <com/sun/star/drawing/XShape.idl>
39 #endif
41 #ifndef __com_sun_star_drawing_XShapes_idl__
42 #include <com/sun/star/drawing/XShapes.idl>
43 #endif
46 //=============================================================================
48 module com { module sun { module star { module drawing {
50 //=============================================================================
52 /** specifies the combine/split functionality.
54 published interface XShapeCombiner: com::sun::star::uno::XInterface
56 //-------------------------------------------------------------------------
58 /** combines <type>Shape</type>s
60 @param xShapes
61 the <type>Shape</type>s inside this container are converted
62 to <type>PolyPolygonBezierShape</type>s and are than combined
63 into one <type>PolyPolygonBezierShape</type>.
64 The <type>Shape</types>s in xShape will be removed from the
65 <type>GenericDrawPage</type> and disposed.
67 @returns
68 a newly created <type>PolyPolygonBezierShape</type> which contains all
69 converted <type>PolyPolygonBezierShape</type> combined. It is also added
70 to the <type>GenericDrawPage</type> of the source <type>Shape</type>s.
73 com::sun::star::drawing::XShape combine( [in] com::sun::star::drawing::XShapes xShapes );
75 //-------------------------------------------------------------------------
77 /** splits <type>Shape</type>s.
79 @param xShapes
80 the <type>Shape</type> is converted to a
81 <type>PolyPolygonBezierShape</type>s and then splited into
82 several <type>PolyPolygonBezierShape</type>s
83 The <type>Shape</types>s in xShape will be removed from the
84 <type>GenericDrawPage</type> and disposed.
86 void split( [in] com::sun::star::drawing::XShape xGroup );
88 };
90 //=============================================================================
92 }; }; }; };
94 #endif