xref: /aoo42x/main/offapi/com/sun/star/drawing/XShapeBinder.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_XShapeBinder_idl__
#define __com_sun_star_drawing_XShapeBinder_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

#ifndef __com_sun_star_drawing_XShapes_idl__
#include <com/sun/star/drawing/XShapes.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module drawing {

//=============================================================================

/** connects or breaks the lines of <type>Shape</type>s
 */
published interface XShapeBinder: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** binds <type>Shape</type>s together.

		@param xShapes
			a container with <type>Shape</type>s that will be bind toghether.
			All <type>Shapes</type> will be converted to a <type>PolyPolygonBezierShape</type>
			and the lines will be connected. The <type>Shape</types>s in xShape will be
			removed from the <type>GenericDrawPage</type> and disposed.

		@returns
			a newly created <type>PolyPolygonBezierShape</type> which contains all
			line segment from the supplied <type>Shape</type>s. It is also added
			to the <type>GenericDrawPage</type> of the source <type>Shape</type>s.
	 */
	com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes );

	//-------------------------------------------------------------------------

	/** breaks a <type>Shape</type> into its line segments

		@param xShape
			the given <type>Shape</type> will be converted to a <type>PolyPolygonBezierShape</type>
			and the line segments of this <type>Shape</type> will be used to create
			new <type>PolyPolygonBezierShape</type> shapes. The original <type>Shape</type>
			will be removed from its <type>GenericDrawPage</type> and disposed.
	 */
	void unbind( [in] com::sun::star::drawing::XShape xShape );

};

//=============================================================================

}; }; }; };

#endif