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