offapi/com/sun/star/configuration/GroupElement.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_configuration_GroupElement_idl__
  29 #define __com_sun_star_configuration_GroupElement_idl__
  30
  31 #include <com/sun/star/configuration/HierarchyElement.idl>
  32 #include <com/sun/star/container/XChild.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module configuration {
  37
  38 //=============================================================================
  39 /** provides information about a predefined element contained in a
  40  heterogeneous group of elements within a hierarchy.
  41
  42  <p>Provides information about the element.
  43  Provides access to its containing group object.
  44  </p>
  45
  46  <p>A group element bears a predefined name. It may only exist within a
  47  containing group object.
  48  </p>
  49
  50  @see com::sun::star::configuration::GroupAccess
  51     Parent objects of this service generally implement service GroupAccess.
  52
  53  @see com::sun::star::configuration::SetElement
  54     A complementary service, for elements of a dynamic homogeneous container.
  55
  56  @see com::sun::star::configuration::AccessRootElement
  57     A complementary service, for the root element of a hierarchy.
  58
  59 */
  60 published service GroupElement
  61 {
  62 /** is the basic service for accessing information about an element in the
  63  hierarchy.
  64 */
  65     service HierarchyElement;
  66
  67 /** provides access to the containing group object.
  68
  69  <p>In this service this interface is mandatory</p>
  70
  71  <p><member scope="com::sun::star::container">XChild::getParent()</member>
  72  shall not return NULL.
  73  </p>
  74
  75  <p><em>Setting a different parent is not supported.</em></p>
  76 */
  77     interface com::sun::star::container::XChild;
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */