offapi/com/sun/star/configuration/ConfigurationRegistry.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
  24
  25 /*  provides access to a configuration tree as a registry.
  26
  27     <p>This service is deprecated,
  28     com.sun.star.configuration::ConfigurationProvider should
  29     be used instead.</p>
  30
  31     <p> Using the com::sun::star::registry::XSimpleRegistry
  32     interface, the service can be bound to a subtree within the
  33     configuration tree, as provided by an
  34     com.sun.star.configuration::ConfigurationProvider
  35     service, which must be accessible from the service factory you use for the
  36     creation of this service.
  37     </p>
  38     <p> There are some restrictions when accessing a configuration tree using a registry.
  39     Most of them are implications of the fact that a configuration tree is very static in
  40     it's structure. Removal and addition of sub nodes is allowed only for special
  41     nodes, and even then the new elements have to comply to a given scheme (which is some
  42     kind of attribute of the container node). So for instance the
  43     com.sun.star.registry::XRegistryKey::createKey() method is not allowed
  44     for some nodes.
  45     </p><p>
  46     Thus anybody using this service is strongly advised to read and understand the specification
  47     of a configuration provider (com.sun.star.configuration::ConfigurationProvider)
  48     and all of its aspects.
  49     </p>
  50
  51     @version 1.0 2000/07/06
  52 */
  53
  54 published service ConfigurationRegistry
  55 {
  56     /** controls the binding of the object to a configuration sub tree.
  57         <p>com::sun::star::registry::XSimpleRegistry::open()
  58         is used to open a special subtree within the configuration tree.
  59         </p>
  60         <p>The parameters of this method control the location of the root of the to-be-opened
  61         configuration node and the access mode (read only or updatable).
  62         </p>
  63     */
  64     interface com::sun::star::registry::XSimpleRegistry;
  65
  66     /** is used to commit changes to the configuration.
  67         <p>As specified for the
  68         com::sun::star::configuration::ConfigurationUpdateAccess
  69         service, all changes made to a configuration subtree have to be committed
  70         before they become persistent.
  71         To do this for a configuration accessed as a registry, call
  72         com::sun::star::util::XFlushable::flush().
  73         </p>
  74         <p><strong>Warning:</strong><em>Changes that are not flushed will be
  75         lost.</em>
  76         </p>
  77     */
  78     interface com::sun::star::util::XFlushable;
  79 };
  80
  81
  82
  83 }; }; }; };
  84
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */