offapi/com/sun/star/configuration/GroupElement.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: GroupElement.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_configuration_GroupElement_idl__
  31 #define __com_sun_star_configuration_GroupElement_idl__
  32
  33 #ifndef __com_sun_star_configuration_HierarchyElement_idl__
  34 #include <com/sun/star/configuration/HierarchyElement.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XChild_idl__
  38 #include <com/sun/star/container/XChild.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module configuration {
  44
  45 //=============================================================================
  46 /** provides information about a predefined element contained in a
  47  heterogeneous group of elements within a hierarchy.
  48
  49  <p>Provides information about the element.
  50  Provides access to its containing group object.
  51  </p>
  52
  53  <p>A group element bears a predefined name. It may only exist within a
  54  containing group object.
  55  </p>
  56
  57  @see com::sun::star::configuration::GroupAccess
  58     Parent objects of this service generally implement service GroupAccess.
  59
  60  @see com::sun::star::configuration::SetElement
  61     A complementary service, for elements of a dynamic homogeneous container.
  62
  63  @see com::sun::star::configuration::AccessRootElement
  64     A complementary service, for the root element of a hierarchy.
  65
  66 */
  67 published service GroupElement
  68 {
  69 /** is the basic service for accessing information about an element in the
  70  hierarchy.
  71 */
  72     service HierarchyElement;
  73
  74 /** provides access to the containing group object.
  75
  76  <p>In this service this interface is mandatory</p>
  77
  78  <p><member scope="com::sun::star::container">XChild::getParent()</member>
  79  shall not return NULL.
  80  </p>
  81
  82  <p><em>Setting a different parent is not supported.</em></p>
  83 */
  84     interface com::sun::star::container::XChild;
  85 };
  86
  87 //=============================================================================
  88
  89 }; }; }; };
  90
  91 #endif
  92