offapi/com/sun/star/drawing/XShapeArranger.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_XShapeArranger_idl__
  20 #define __com_sun_star_drawing_XShapeArranger_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/drawing/XShapes.idl>
  25
  26 #include <com/sun/star/drawing/Arrangement.idl>
  27
  28 #include <com/sun/star/drawing/XShape.idl>
  29
  30
  31
  32  module com {  module sun {  module star {  module drawing {
  33
  34 /** Objects implementing this interface can be used to arrange
  35     Shapes.
  36
  37     @deprecated
  38  */
  39 published interface XShapeArranger: com::sun::star::uno::XInterface
  40 {
  41     /** applies the specified Arrangement to
  42         the specified collection of Shapes.
  43      */
  44     void arrange( [in] com::sun::star::drawing::XShapes xShapes,
  45              [in] com::sun::star::drawing::Arrangement eType );
  46
  47     /** moves the specified Shapes by a specified number
  48         of objects more to the front.
  49      */
  50     void bringToFront( [in] com::sun::star::drawing::XShapes xShapes,
  51              [in] short nSteps );
  52
  53     /** moves the specified Shapes
  54         <var>nSteps</var> objects more to the back.
  55      */
  56     void sendToBack( [in] com::sun::star::drawing::XShapes xShapes,
  57              [in] short nSteps );
  58
  59     /** moves the specified collection of Shapes
  60         behind the specified single Shape.
  61      */
  62     void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes,
  63              [in] com::sun::star::drawing::XShape xShape );
  64
  65     /** moves the specified collection of Shapes in
  66         front of the specified single Shape.
  67      */
  68     void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes,
  69              [in] com::sun::star::drawing::XShape xShape );
  70
  71     /** reverses the order of the specified collection of
  72         Shapes.
  73      */
  74     void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */