offapi/com/sun/star/drawing/XShapeGrouper.idl

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