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