udkapi/com/sun/star/registry/NestedRegistry.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
  22  module com {  module sun {  module star {  module registry {
  23
  24 /** supports a shared view on two different registries. The registry
  25     files will be opened in two different modes, registry1 will be opened with read/write
  26     rights and registry2 will be opened read-only.
  27     In the context of this service, the functions <code>open</code>, <code>close</code>,
  28     and <code>destroy</code> from XSimpleRegistry are not supported and
  29     throw an exception if they are used.
  30
  31     Functions of XSimpleRegistry:
  32     <dl>
  33     <dt>    <b>getURL</b>
  34     </dt>
  35     <dd> returns the name of registry1.
  36
  37     </dd>
  38     <dt>    <b>isValid</b>
  39     </dt>
  40     <dd> checks if registry1 is valid. If the interface is not `NULL`
  41     then registry1 should always be valid.
  42
  43     </dd>
  44     <dt>    <b>isReadOnly</b>
  45     </dt>
  46     <dd> checks if registry1 has write protection.
  47     </dd>
  48     <dt>    <b>mergeKey</b>
  49     </dt>
  50     <dd> merges all information from the specified registry in registry1.
  51
  52     </dd>
  53     <dt>    <b>getRootKey</b>
  54     </dt>
  55     <dd> returns a virtual rootkey of both registries.
  56     </dd>
  57     </dl>
  58
  59     Functions of XRegistryKey:
  60     <dl>
  61     <dt> <b>openKey</b>
  62     </dt>
  63     <dd> returns a virtual key which is specified in registry1 or registry2.
  64
  65     </dd>
  66     <dt> <b>deleteKey</b>
  67     </dt>
  68     <dd> deletes the key only if it is present in registry1.
  69
  70     </dd>
  71     <dt> <b>setLongValue, setAsciiValue, setStringValue, setBinaryValue</b>
  72     </dt>
  73     <dd> sets the value at the specified key in registry1.
  74
  75     </dd>
  76     <dt> <b>getLongValue, getAsciiValue, getStringValue, getBinaryValue</b>
  77     </dt>
  78     <dd> returns the value at the specified key in registry1, or if
  79     the value is not present in registry1, it will return the value of registry2.
  80
  81     </dd>
  82     <dt> <b>openKeys</b>
  83     </dt>
  84     <dd> returns a sequence of all subkeys in both registries.
  85
  86     </dd>
  87     <dt> <b>getKeyNames</b>
  88     </dt>
  89     <dd> returns a sequence with the names of all subkeys in both
  90     registries.
  91
  92     </dd>
  93     <dt>
  94     <b>Note: all write functions only work on registry1.</b>
  95     </dt>
  96     </dl>
  97
  98     How to initialize the registries:<br>
  99     Use a sequence of XSimpleRegistry with two elements. The first element must be
 100     the registry which is opened with read/write rights and the second element must be
 101     the read-only one.<br>
 102     Two different ways are possible:<br>
 103     <ul>
 104     <li> use com::sun::star::lang::XMultiServiceFactory::createInstanceWithArguments() to
 105     create an instance of this service where the value of the any parameter must be the sequence with
 106     the two open registries.
 107     <li> use the initialize function of the com::sun::star::lang::XInitialization interface where the value of the
 108     any parameter must be the sequence with the two open registries.
 109     </ul>
 110     <br>
 111
 112
 113     Guarantees:
 114     <ul>
 115     <li>-thread safe</li>
 116     </ul>
 117  */
 118 published service NestedRegistry
 119 {
 120     interface com::sun::star::registry::XSimpleRegistry;
 121     interface com::sun::star::lang::XInitialization;
 122 };
 123
 124
 125 }; }; }; };
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */