offapi/com/sun/star/configuration/GroupUpdate.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: GroupUpdate.idl,v $
  10  * $Revision: 1.8 $
  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_GroupUpdate_idl__
  31 #define __com_sun_star_configuration_GroupUpdate_idl__
  32
  33 #ifndef __com_sun_star_configuration_GroupAccess_idl__
  34 #include <com/sun/star/configuration/GroupAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XNameReplace_idl__
  38 #include <com/sun/star/container/XNameReplace.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module configuration {
  44
  45 //=============================================================================
  46 /** provides write access to a predefined heterogeneous group of values
  47  and nested trees as part of a hierarchy.
  48
  49  <p>This service extends <type>GroupAccess</type> to support
  50  modifying values.
  51  </p>
  52 */
  53 published service GroupUpdate
  54 {
  55 /** is the basic service providing read access to a group element of the
  56  hierarchy.
  57
  58  <p>Any child and descendant objects support modifying access as well,
  59  unless they represent a read-only tree element as indicated by
  60  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>.
  61  </p>
  62 */
  63     service GroupAccess;
  64
  65 /** allows replacing values.
  66
  67  <p>This service extends the interface
  68  <type scope="com::sun::star::container">XNameAccess</type> supported
  69  by service <type>GroupAccess</type> to allow changing values.
  70  This strongly overlaps with functionality available through
  71  <type>PropertyHierarchy</type> (from <type>GroupAccess</type>), so that
  72  <code>xGroup.setPropertyValue( aName, aValue )</code> is equivalent to
  73  <code>xGroup.replaceByName( aName, aValue )</code>.
  74  </p>
  75
  76  <p>Changes can be observed by registering a listener with interface
  77  <type scope="com::sun::star::beans">XPropertySet</type> or
  78  <type scope="com::sun::star::beans">XMultiPropertySet</type>.
  79  </p>
  80
  81  <p>Elements of this group may be replaced only if they are of simple type.
  82  The type returned by
  83  <member scope="com::sun::star::container">XElementAccess::getElementType()</member>
  84  must not be an interface type. Replacing whole subtrees is not supported.
  85  </p>
  86 */
  87     interface com::sun::star::container::XNameReplace;
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif
  96