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