xref: /aoo4110/main/offapi/com/sun/star/drawing/XShapeArranger.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_drawing_XShapeArranger_idl__
#define __com_sun_star_drawing_XShapeArranger_idl__

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

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

#ifndef __com_sun_star_drawing_Arrangement_idl__
#include <com/sun/star/drawing/Arrangement.idl>
#endif

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


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

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

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

// DocMerge from xml: interface com::sun::star::drawing::XShapeArranger
/** Objects implementing this interface can be used to arrange
	<type>Shape</type>s.

	@deprecated
 */
published interface XShapeArranger: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::arrange
	/** applies the specified <type>Arrangement</type> to
		the specified collection of <type>Shape</type>s.
	 */
	void arrange( [in] com::sun::star::drawing::XShapes xShapes,
			 [in] com::sun::star::drawing::Arrangement eType );

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

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::bringToFront
	/** moves the specified <type>Shape</type>s by a specified number
		of objects more to the front.
	 */
	void bringToFront( [in] com::sun::star::drawing::XShapes xShapes,
			 [in] short nSteps );

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

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::sendToBack
	/** moves the specified <type>Shape</type>s
		<var>nSteps</var> objects more to the back.
	 */
	void sendToBack( [in] com::sun::star::drawing::XShapes xShapes,
			 [in] short nSteps );

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

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setBehindShape
	/** moves the specified collection of <type>Shape</type>s
		behind the specified single <type>Shape</type>.
	 */
	void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes,
			 [in] com::sun::star::drawing::XShape xShape );

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

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setInFrontOf
	/** moves the specified collection of <type>Shape</type>s in
		front of the specified single <type>Shape</type>.
	 */
	void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes,
			 [in] com::sun::star::drawing::XShape xShape );

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

	// DocMerge from xml: method com::sun::star::drawing::XShapeArranger::reverseOrder
	/** reverses the order of the specified collection of
		<type>Shape</type>s.
	 */
	void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes );

};

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

}; }; }; };

#endif