offapi/com/sun/star/drawing/XShapeBinder.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 /** connects or breaks the lines of Shapes
  26  */
  27 published interface XShapeBinder: com::sun::star::uno::XInterface
  28 {
  29
  30     /** binds Shapes together.
  31
  32         @param xShapes
  33             a container with Shapes that will be bind together.
  34             All Shapes will be converted to a PolyPolygonBezierShape
  35             and the lines will be connected. The Shapes in xShape will be
  36             removed from the GenericDrawPage and disposed.
  37
  38         @returns
  39             a newly created PolyPolygonBezierShape which contains all
  40             line segment from the supplied Shapes. It is also added
  41             to the GenericDrawPage of the source Shapes.
  42      */
  43     com::sun::star::drawing::XShape bind( [in] com::sun::star::drawing::XShapes xShapes );
  44
  45
  46     /** breaks a Shape into its line segments
  47
  48         @param xShape
  49             the given Shape will be converted to a PolyPolygonBezierShape
  50             and the line segments of this Shape will be used to create
  51             new PolyPolygonBezierShape shapes. The original Shape
  52             will be removed from its GenericDrawPage and disposed.
  53      */
  54     void unbind( [in] com::sun::star::drawing::XShape xShape );
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */