offapi/com/sun/star/configuration/GroupUpdate.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
  20
  21 module com { module sun { module star { module configuration {
  22
  23 /** provides write access to a predefined heterogeneous group of values
  24  and nested trees as part of a hierarchy.
  25
  26  <p>This service extends GroupAccess to support
  27  modifying values.
  28  </p>
  29 */
  30 published service GroupUpdate
  31 {
  32 /** is the basic service providing read access to a group element of the
  33  hierarchy.
  34
  35  <p>Any child and descendant objects support modifying access as well,
  36  unless they represent a read-only tree element as indicated by
  37  com::sun::star::beans::PropertyAttribute::READONLY.
  38  </p>
  39 */
  40     service GroupAccess;
  41
  42 /** allows replacing values.
  43
  44  <p>This service extends the interface
  45  com::sun::star::container::XNameAccess supported
  46  by service GroupAccess to allow changing values.
  47  This strongly overlaps with functionality available through
  48  PropertyHierarchy (from GroupAccess), so that
  49  <code>xGroup.setPropertyValue( aName, aValue )</code> is equivalent to
  50  <code>xGroup.replaceByName( aName, aValue )</code>.
  51  </p>
  52
  53  <p>Changes can be observed by registering a listener with interface
  54  com::sun::star::beans::XPropertySet or
  55  com::sun::star::beans::XMultiPropertySet.
  56  </p>
  57
  58  <p>Elements of this group may be replaced only if they are of simple type.
  59  The type returned by
  60  com::sun::star::container::XElementAccess::getElementType()
  61  must not be an interface type. Replacing whole subtrees is not supported.
  62  </p>
  63 */
  64     interface com::sun::star::container::XNameReplace;
  65
  66 };
  67
  68
  69 }; }; }; };
  70
  71 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */