offapi/com/sun/star/configuration/SetUpdate.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_SetUpdate_idl__
  20 #define __com_sun_star_configuration_SetUpdate_idl__
  21
  22 #include <com/sun/star/configuration/SetAccess.idl>
  23 #include <com/sun/star/configuration/SimpleSetUpdate.idl>
  24
  25
  26 module com { module sun { module star { module configuration {
  27
  28 /** provides write access to a dynamic homogeneous set of values or nested
  29  trees within a hierarchy.
  30
  31  <p>Allows adding and removing elements.
  32  Helps creates new elements to be added.
  33  </p>
  34
  35  <p>This service extends <type>SetAccess</type> to support
  36  modifying the container.
  37  </p>
  38
  39  <p>Any child and descendant objects support modifying access as well,
  40  unless they represent a read-only tree element (as indicated by
  41  <const scope="com::sun::star::beans">PropertyAttribute::READONLY</const>).
  42  </p>
  43 */
  44 published service SetUpdate
  45 {
  46 /** is the basic service providing read access to a <em>set</em> within the
  47  hierarchy.
  48 */
  49     service SetAccess;
  50
  51 /** is the basic service providing modifying access to a
  52  not necessarily hierarchical <em>set</em>.
  53
  54  <p>Changes can be observed by registering a listener with interface
  55  <type scope="com::sun::star::container">XContainer</type>.
  56  </p>
  57
  58  <p>If the elements of this set are of object type, new elements are constructed
  59  to match the tree structure prescribed by the element template of this set, when
  60  using interfaces <type scope="com::sun::star::lang">XSingleServiceFactory</type>
  61  and (if supported) <type scope="com::sun::star::lang">XMultiServiceFactory</type>.
  62  </p>
  63
  64  <p>Objects that are removed from a set can be reinserted into any set supporting
  65  the same template within the same hierarchy. Even under a different name.
  66  </p>
  67
  68  <p>Implementations that support insertion of objects that weren't obtained
  69  from within the hierarchy must reject elements that don't have the correct
  70  structure as described by the template, even if the object returns the
  71  correct template name from <member>XTemplateInstance::getTemplateName()</member>.
  72  </p>
  73
  74  <p>Other ways in which an element may be moved among or within compatible sets
  75  include <member scope="com::sun::star::container">XChild::setParent()</member>
  76  and <member scope="com::sun::star::container">XNamed::setName()</member>, if
  77  the element implements them.
  78  </p>
  79
  80  @see com::sun::star::configuration::SetElement
  81 */
  82     service SimpleSetUpdate;
  83
  84 };
  85
  86
  87 }; }; }; };
  88
  89 #endif
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */