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