offapi/com/sun/star/drawing/XShapeBinder.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: XShapeBinder.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  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.
  17  *
  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).
  23  *
  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.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_drawing_XShapeBinder_idl__
  31 #define __com_sun_star_drawing_XShapeBinder_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XShape_idl__
  38 #include <com/sun/star/drawing/XShape.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_XShapes_idl__
  42 #include <com/sun/star/drawing/XShapes.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48  module com {  module sun {  module star {  module drawing {
  49
  50 //=============================================================================
  51
  52 /** connects or breaks the lines of <type>Shape</type>s
  53  */
  54 published interface XShapeBinder: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** binds <type>Shape</type>s together.
  59
  60         @param xShapes
  61             a container with <type>Shape</type>s that will be bind toghether.
  62             All <type>Shapes</type> will be converted to a <type>PolyPolygonBezierShape</type>
  63             and the lines will be connected. The <type>Shape</types>s in xShape will be
  64             removed from the <type>GenericDrawPage</type> and disposed.
  65
  66         @returns
  67             a newly created <type>PolyPolygonBezierShape</type> which contains all
  68             line segment from the supplied <type>Shape</type>s. It is also added
  69             to the <type>GenericDrawPage</type> of the source <type>Shape</type>s.
  70      */
  71     com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** breaks a <type>Shape</type> into its line segments
  76
  77         @param xShape
  78             the given <type>Shape</type> will be converted to a <type>PolyPolygonBezierShape</type>
  79             and the line segments of this <type>Shape</type> will be used to create
  80             new <type>PolyPolygonBezierShape</type> shapes. The original <type>Shape</type>
  81             will be removed from its <type>GenericDrawPage</type> and disposed.
  82      */
  83     void unbind( [in] com::sun::star::drawing::XShape xShape );
  84
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif
  92