offapi/com/sun/star/drawing/framework/XRelocatableResource.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: XRelocatableResource.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_drawing_framework_XRelocatableResource_idl__
  32 #define __com_sun_star_drawing_framework_XRelocatableResource_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module drawing { module framework {
  39
  40 interface XResource;
  41
  42 /** An optional interface that is implemented by resources that are
  43     relocatable to different anchors.
  44 */
  45 interface XRelocatableResource
  46 {
  47     /** Replace the current anchor of the called resource with the given
  48         one.
  49         @param xNewAnchor
  50             The new anchor.
  51         @return
  52             Returns <TRUE/> when the relocation was successfull.
  53     */
  54     boolean relocateToAnchor ([in] XResource xNewAnchor);
  55 };
  56
  57 }; }; }; }; }; // ::com::sun::star::drawing::framework
  58
  59 #endif