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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_configuration_GroupUpdate_idl__
  29 #define __com_sun_star_configuration_GroupUpdate_idl__
  30
  31 #include <com/sun/star/configuration/GroupAccess.idl>
  32 #include <com/sun/star/container/XNameReplace.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module configuration {
  37
  38 //=============================================================================
  39 /** provides write access to a predefined heterogeneous group of values
  40  and nested trees as part of a hierarchy.
  41
  42  <p>This service extends <type>GroupAccess</type> to support
  43  modifying values.
  44  </p>
  45 */
  46 published service GroupUpdate
  47 {
  48 /** is the basic service providing read access to a group element of the
  49  hierarchy.
  50
  51  <p>Any child and descendant objects support modifying access as well,
  52  unless they represent a read-only tree element as indicated by
  53  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>.
  54  </p>
  55 */
  56     service GroupAccess;
  57
  58 /** allows replacing values.
  59
  60  <p>This service extends the interface
  61  <type scope="com::sun::star::container">XNameAccess</type> supported
  62  by service <type>GroupAccess</type> to allow changing values.
  63  This strongly overlaps with functionality available through
  64  <type>PropertyHierarchy</type> (from <type>GroupAccess</type>), so that
  65  <code>xGroup.setPropertyValue( aName, aValue )</code> is equivalent to
  66  <code>xGroup.replaceByName( aName, aValue )</code>.
  67  </p>
  68
  69  <p>Changes can be observed by registering a listener with interface
  70  <type scope="com::sun::star::beans">XPropertySet</type> or
  71  <type scope="com::sun::star::beans">XMultiPropertySet</type>.
  72  </p>
  73
  74  <p>Elements of this group may be replaced only if they are of simple type.
  75  The type returned by
  76  <member scope="com::sun::star::container">XElementAccess::getElementType()</member>
  77  must not be an interface type. Replacing whole subtrees is not supported.
  78  </p>
  79 */
  80     interface com::sun::star::container::XNameReplace;
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */