udkapi/com/sun/star/container/XChild.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_container_XChild_idl__
  28 #define __com_sun_star_container_XChild_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_NoSupportException_idl__
  35 #include <com/sun/star/lang/NoSupportException.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module container {
  42
  43 //=============================================================================
  44
  45 /** provides access to the parent of the object.
  46
  47     <p>This interface normally is only supported if the objects all have
  48     exactly one dedicated parent container.</p>
  49  */
  50 published interface XChild: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** grants access to the object containing this content.
  55      */
  56     com::sun::star::uno::XInterface getParent();
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** sets the parent to this object.
  61
  62         @throws com::sun::star::lang::NoSupportException
  63             if the name of this object cannot be changed.
  64      */
  65     void setParent( [in] com::sun::star::uno::XInterface Parent )
  66             raises( com::sun::star::lang::NoSupportException );
  67
  68 };
  69
  70 //=============================================================================
  71
  72 }; }; }; };
  73
  74 #endif