offapi/com/sun/star/configuration/GroupAccess.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_GroupAccess_idl__
  20 #define __com_sun_star_configuration_GroupAccess_idl__
  21
  22 #include <com/sun/star/configuration/HierarchyAccess.idl>
  23 #include <com/sun/star/configuration/PropertyHierarchy.idl>
  24 #include <com/sun/star/beans/XPropertyState.idl>
  25 #include <com/sun/star/beans/XMultiPropertyStates.idl>
  26
  27
  28 module com { module sun { module star { module configuration {
  29
  30 /** provides access to a predefined heterogeneous group of values and nested
  31  trees as part of a hierarchy.
  32
  33  <p>Provides access to, and information about, its children and descendants
  34  viewed either as properties or as contained elements.
  35  </p>
  36
  37  <p><em>Groups</em> are static collections within the hierarchy.</p>
  38
  39  <p>The number and names of contained elements are fixed in advance
  40  and each child may have a different type.
  41  </p>
  42
  43  <p>This service subsumes two alternate ways of accessing child and descendent
  44  elements. These strongly overlap, supporting the basic identity
  45  <code>xGroup.getPropertyValue( aName ) == xGroup.getByName( aName )</code>.
  46  </p>
  47
  48  @see com::sun::star::configuration::GroupElement
  49     Child objects of this service generally implement service GroupElement.
  50
  51  @see com::sun::star::configuration::SetAccess
  52     A complementary service providing for dynamic homogeneous sets of elements.
  53
  54 */
  55 published service GroupAccess
  56 {
  57 /** is the basic service for accessing child and descendent nodes using
  58  a view of the tree as a container of values and structuring elements.
  59 */
  60     service HierarchyAccess;
  61
  62 /** is the basic service for accessing child and descendent nodes using
  63  a view of the tree as a hierarchy of properties and subproperties.
  64
  65  <p>This view is meaningful only for a static fragment of the hierarchy
  66  Object's properties may change, but not which properties they have.
  67  Therefore, dynamic elements of the hierarchy (see <type>SetAccess</type>)
  68  do not implement service <type>PropertyHierarchy</type>.
  69  </p>
  70
  71  <p>If such elements occur as properties or subproperties of an implementation,
  72  it is not specified whether direct subproperty access using
  73  <type scope="com::sun::star::beans">XHierarchicalPropertySet</type> or
  74  <type scope="com::sun::star::beans">XMultiHierarchicalPropertySet</type> can
  75  be used to access descendants of such elements.
  76  </p>
  77
  78  <p>Similarly, information about such descendants may not be available from
  79  the <type scope="com::sun::star::beans">XHierarchicalPropertySetInfo</type>
  80  the implementation provides.
  81  </p>
  82
  83  <p>If an implementation is part of a <em>read-only</em> view of the hierarchy,
  84  all properties and subproperties will be reported as having attribute
  85  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const> set,
  86  and attempts to change property values will fail.
  87  </p>
  88 */
  89     service PropertyHierarchy;
  90
  91 /** provides access to the state of child elements of an implementation. [optional]
  92
  93  <p>This interface should be present, if the hierarchy supports default values
  94  for simple (non-object) properties and the group contains such properties.
  95  </p>
  96
  97  <p>For properties that are objects themselves, the semantic documented for
  98  service <type>HierarchyAccess</type> applies.
  99  </p>
 100  */
 101     [optional] interface com::sun::star::beans::XPropertyState;
 102
 103 /** provides access to the states of multiple child elements of
 104  an implementation. [optional]
 105
 106  <p>This interface should be present, if the hierarchy supports default values
 107  for simple (non-object) properties and the group contains such properties.
 108  </p>
 109
 110  <p>For properties that are objects themselves, the semantic documented for
 111  service <type>HierarchyAccess</type> applies.
 112  </p>
 113 */
 114     [optional] interface com::sun::star::beans::XMultiPropertyStates;
 115 };
 116
 117
 118 }; }; }; };
 119
 120 #endif
 121
 122 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */