1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_drawing_XShapeGrouper_idl__
28#define __com_sun_star_drawing_XShapeGrouper_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_XShapeGroup_idl__
35#include <com/sun/star/drawing/XShapeGroup.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_XShapes_idl__
39#include <com/sun/star/drawing/XShapes.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module drawing {
46
47//=============================================================================
48
49/** specifies the group/ungroup functionality.
50 */
51published interface XShapeGrouper: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	/** groups the <type>Shape</type>s inside a collection.
56
57        <p>Grouping of objects in text documents works only if none
58        of the objects has an anchor of type
59        <member scope="com::sun::star::text::TextContentAnchorType">AS_CHARACTER</member>
60        </p>.
61
62		@param xShapes
63			the <type>Shape</type>s that will be grouped. They
64			must all be inserted into the same <type>GenericDrawPage</type>.
65
66		@returns
67			a newly created <type>GroupShape</type> that contains all
68			<type>Shape</type>s from xShapes and is also added to the
69			<type>GenericDrawPage</type> of the <type>Shape</type>s
70			in xShapes.
71	 */
72	com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes );
73
74	//-------------------------------------------------------------------------
75
76	/** ungroups a given <type>GroupShape</type>.
77
78		@param aGroup
79			moves all <type>Shape</type>s from this <type>GroupShape</type>
80			to the parent <type>XShapes</type> of the <type>GroupShape</type>.
81			The <type>GroupShape</type> is than removed from the
82			<type>GenericDrawPage</type> and disposed.
83	 */
84	void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup );
85
86};
87
88//=============================================================================
89
90}; }; }; };
91
92#endif
93
94