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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22  module com {  module sun {  module star {  module drawing {
  23
  24
  25 /** specifies the group/ungroup functionality.
  26  */
  27 published interface XShapeGrouper: com::sun::star::uno::XInterface
  28 {
  29
  30     /** groups the Shapes inside a collection.
  31
  32         <p>Grouping of objects in text documents works only if none
  33         of the objects has an anchor of type
  34         com::sun::star::text::TextContentAnchorType::AS_CHARACTER .
  35         </p>
  36
  37         @param xShapes
  38             the Shapes that will be grouped. They
  39             must all be inserted into the same GenericDrawPage.
  40
  41         @returns
  42             a newly created GroupShape that contains all
  43             Shapes from xShapes and is also added to the
  44             GenericDrawPage of the Shapes
  45             in xShapes.
  46      */
  47     com::sun::star::drawing::XShapeGroup group( [in] com::sun::star::drawing::XShapes xShapes );
  48
  49
  50     /** ungroups a given GroupShape.
  51
  52         @param aGroup
  53             moves all Shapes from this GroupShape
  54             to the parent XShapes of the GroupShape.
  55             The GroupShape is then removed from the
  56             GenericDrawPage and disposed.
  57      */
  58     void ungroup( [in] com::sun::star::drawing::XShapeGroup aGroup );
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */