xref: /AOO41X/main/offapi/com/sun/star/drawing/XShapeArranger.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_drawing_XShapeArranger_idl__
24#define __com_sun_star_drawing_XShapeArranger_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_drawing_XShapes_idl__
31#include <com/sun/star/drawing/XShapes.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_Arrangement_idl__
35#include <com/sun/star/drawing/Arrangement.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_XShape_idl__
39#include <com/sun/star/drawing/XShape.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module drawing {
46
47//=============================================================================
48
49// DocMerge from xml: interface com::sun::star::drawing::XShapeArranger
50/** Objects implementing this interface can be used to arrange
51    <type>Shape</type>s.
52
53    @deprecated
54 */
55published interface XShapeArranger: com::sun::star::uno::XInterface
56{
57    //-------------------------------------------------------------------------
58
59    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::arrange
60    /** applies the specified <type>Arrangement</type> to
61        the specified collection of <type>Shape</type>s.
62     */
63    void arrange( [in] com::sun::star::drawing::XShapes xShapes,
64             [in] com::sun::star::drawing::Arrangement eType );
65
66    //-------------------------------------------------------------------------
67
68    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::bringToFront
69    /** moves the specified <type>Shape</type>s by a specified number
70        of objects more to the front.
71     */
72    void bringToFront( [in] com::sun::star::drawing::XShapes xShapes,
73             [in] short nSteps );
74
75    //-------------------------------------------------------------------------
76
77    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::sendToBack
78    /** moves the specified <type>Shape</type>s
79        <var>nSteps</var> objects more to the back.
80     */
81    void sendToBack( [in] com::sun::star::drawing::XShapes xShapes,
82             [in] short nSteps );
83
84    //-------------------------------------------------------------------------
85
86    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setBehindShape
87    /** moves the specified collection of <type>Shape</type>s
88        behind the specified single <type>Shape</type>.
89     */
90    void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes,
91             [in] com::sun::star::drawing::XShape xShape );
92
93    //-------------------------------------------------------------------------
94
95    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setInFrontOf
96    /** moves the specified collection of <type>Shape</type>s in
97        front of the specified single <type>Shape</type>.
98     */
99    void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes,
100             [in] com::sun::star::drawing::XShape xShape );
101
102    //-------------------------------------------------------------------------
103
104    // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::reverseOrder
105    /** reverses the order of the specified collection of
106        <type>Shape</type>s.
107     */
108    void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes );
109
110};
111
112//=============================================================================
113
114}; }; }; };
115
116#endif
117
118