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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_configuration_GroupElement_idl__
  20 #define __com_sun_star_configuration_GroupElement_idl__
  21
  22 #include <com/sun/star/configuration/HierarchyElement.idl>
  23 #include <com/sun/star/container/XChild.idl>
  24
  25
  26 module com { module sun { module star { module configuration {
  27
  28 /** provides information about a predefined element contained in a
  29  heterogeneous group of elements within a hierarchy.
  30
  31  <p>Provides information about the element.
  32  Provides access to its containing group object.
  33  </p>
  34
  35  <p>A group element bears a predefined name. It may only exist within a
  36  containing group object.
  37  </p>
  38
  39  @see com::sun::star::configuration::GroupAccess
  40     Parent objects of this service generally implement service GroupAccess.
  41
  42  @see com::sun::star::configuration::SetElement
  43     A complementary service, for elements of a dynamic homogeneous container.
  44
  45  @see com::sun::star::configuration::AccessRootElement
  46     A complementary service, for the root element of a hierarchy.
  47
  48 */
  49 published service GroupElement
  50 {
  51 /** is the basic service for accessing information about an element in the
  52  hierarchy.
  53 */
  54     service HierarchyElement;
  55
  56 /** provides access to the containing group object.
  57
  58  <p>In this service this interface is mandatory</p>
  59
  60  <p>com::sun::star::container::XChild::getParent()
  61  shall not return NULL.
  62  </p>
  63
  64  <p><em>Setting a different parent is not supported.</em></p>
  65 */
  66     interface com::sun::star::container::XChild;
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */