offapi/com/sun/star/drawing/XShapeArranger.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: XShapeArranger.idl,v $
  10  * $Revision: 1.8 $
  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_XShapeArranger_idl__
  31 #define __com_sun_star_drawing_XShapeArranger_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_XShapes_idl__
  38 #include <com/sun/star/drawing/XShapes.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_drawing_Arrangement_idl__
  42 #include <com/sun/star/drawing/Arrangement.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_drawing_XShape_idl__
  46 #include <com/sun/star/drawing/XShape.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52  module com {  module sun {  module star {  module drawing {
  53
  54 //=============================================================================
  55
  56 // DocMerge from xml: interface com::sun::star::drawing::XShapeArranger
  57 /** Objects implementing this interface can be used to arrange
  58     <type>Shape</type>s.
  59
  60     @deprecated
  61  */
  62 published interface XShapeArranger: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65
  66     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::arrange
  67     /** applies the specified <type>Arrangement</type> to
  68         the specified collection of <type>Shape</type>s.
  69      */
  70     void arrange( [in] com::sun::star::drawing::XShapes xShapes,
  71              [in] com::sun::star::drawing::Arrangement eType );
  72
  73     //-------------------------------------------------------------------------
  74
  75     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::bringToFront
  76     /** moves the specified <type>Shape</type>s by a specified number
  77         of objects more to the front.
  78      */
  79     void bringToFront( [in] com::sun::star::drawing::XShapes xShapes,
  80              [in] short nSteps );
  81
  82     //-------------------------------------------------------------------------
  83
  84     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::sendToBack
  85     /** moves the specified <type>Shape</type>s
  86         <var>nSteps</var> objects more to the back.
  87      */
  88     void sendToBack( [in] com::sun::star::drawing::XShapes xShapes,
  89              [in] short nSteps );
  90
  91     //-------------------------------------------------------------------------
  92
  93     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setBehindShape
  94     /** moves the specified collection of <type>Shape</type>s
  95         behind the specified single <type>Shape</type>.
  96      */
  97     void setBehindShape( [in] com::sun::star::drawing::XShapes xShapes,
  98              [in] com::sun::star::drawing::XShape xShape );
  99
 100     //-------------------------------------------------------------------------
 101
 102     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::setInFrontOf
 103     /** moves the specified collection of <type>Shape</type>s in
 104         front of the specified single <type>Shape</type>.
 105      */
 106     void setInFrontOf( [in] com::sun::star::drawing::XShapes xShapes,
 107              [in] com::sun::star::drawing::XShape xShape );
 108
 109     //-------------------------------------------------------------------------
 110
 111     // DocMerge from xml: method com::sun::star::drawing::XShapeArranger::reverseOrder
 112     /** reverses the order of the specified collection of
 113         <type>Shape</type>s.
 114      */
 115     void reverseOrder( [in] com::sun::star::drawing::XShapes xShapes );
 116
 117 };
 118
 119 //=============================================================================
 120
 121 }; }; }; };
 122
 123 #endif
 124