xref: /trunk/main/offapi/com/sun/star/drawing/XShapeBinder.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_drawing_XShapeBinder_idl__
28#define __com_sun_star_drawing_XShapeBinder_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XShape_idl__
35#include <com/sun/star/drawing/XShape.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_XShapes_idl__
39#include <com/sun/star/drawing/XShapes.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module drawing {
46
47//=============================================================================
48
49/** connects or breaks the lines of <type>Shape</type>s
50 */
51published interface XShapeBinder: com::sun::star::uno::XInterface
52{
53    //-------------------------------------------------------------------------
54
55    /** binds <type>Shape</type>s together.
56
57        @param xShapes
58            a container with <type>Shape</type>s that will be bind toghether.
59            All <type>Shapes</type> will be converted to a <type>PolyPolygonBezierShape</type>
60            and the lines will be connected. The <type>Shape</types>s in xShape will be
61            removed from the <type>GenericDrawPage</type> and disposed.
62
63        @returns
64            a newly created <type>PolyPolygonBezierShape</type> which contains all
65            line segment from the supplied <type>Shape</type>s. It is also added
66            to the <type>GenericDrawPage</type> of the source <type>Shape</type>s.
67     */
68    com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes );
69
70    //-------------------------------------------------------------------------
71
72    /** breaks a <type>Shape</type> into its line segments
73
74        @param xShape
75            the given <type>Shape</type> will be converted to a <type>PolyPolygonBezierShape</type>
76            and the line segments of this <type>Shape</type> will be used to create
77            new <type>PolyPolygonBezierShape</type> shapes. The original <type>Shape</type>
78            will be removed from its <type>GenericDrawPage</type> and disposed.
79     */
80    void unbind( [in] com::sun::star::drawing::XShape xShape );
81
82};
83
84//=============================================================================
85
86}; }; }; };
87
88#endif
89
90