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_XShapeGrouper_idl__
24#define __com_sun_star_drawing_XShapeGrouper_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_XShapeGroup_idl__
31#include <com/sun/star/drawing/XShapeGroup.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XShapes_idl__
35#include <com/sun/star/drawing/XShapes.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module drawing {
42
43//=============================================================================
44
45/** specifies the group/ungroup functionality.
46 */
47published interface XShapeGrouper: com::sun::star::uno::XInterface
48{
49	//-------------------------------------------------------------------------
50
51	/** groups the <type>Shape</type>s inside a collection.
52
53        <p>Grouping of objects in text documents works only if none
54        of the objects has an anchor of type
55        <member scope="com::sun::star::text::TextContentAnchorType">AS_CHARACTER</member>
56        </p>.
57
58		@param xShapes
59			the <type>Shape</type>s that will be grouped. They
60			must all be inserted into the same <type>GenericDrawPage</type>.
61
62		@returns
63			a newly created <type>GroupShape</type> that contains all
64			<type>Shape</type>s from xShapes and is also added to the
65			<type>GenericDrawPage</type> of the <type>Shape</type>s
66			in xShapes.
67	 */
68	com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes );
69
70	//-------------------------------------------------------------------------
71
72	/** ungroups a given <type>GroupShape</type>.
73
74		@param aGroup
75			moves all <type>Shape</type>s from this <type>GroupShape</type>
76			to the parent <type>XShapes</type> of the <type>GroupShape</type>.
77			The <type>GroupShape</type> is than removed from the
78			<type>GenericDrawPage</type> and disposed.
79	 */
80	void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup );
81
82};
83
84//=============================================================================
85
86}; }; }; };
87
88#endif
89
90