udkapi/com/sun/star/registry/DefaultRegistry.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 /** implicitly supports a local registry and a read-only
  25     system registry for global information.
  26     In the context of this service,
  27     the functions <code>open</code>, <code>close</code>, and <code>destroy</code>
  28     from XSimpleRegistry are not supported and throw an exception
  29     if they are used.
  30
  31     Functions of XSimpleRegistry:
  32     <dl>
  33     <dt>    <b>getURL</b>
  34     </dt>
  35     <dd> returns the name of the local registry.
  36     </dd>
  37     <dt>    <b>isValid</b>
  38     </dt>
  39     <dd> checks if the local registry is valid. If the interface is not `NULL`
  40     the local registry should always be valid.
  41     </dd>
  42     <dt>    <b>isReadOnly</b>  </dt>
  43     <dd> checks if the local registry has write protection.
  44     </dd>
  45     <dt>    <b>mergeKey</b>
  46     </dt>
  47     <dd> merges all information from the specified registry in the local registry.
  48     </dd>
  49     <dt>    <b>getRootKey</b>
  50     </dt>
  51     <dd> returns a virtual rootkey of both registries.
  52     </dd>
  53     </dl>
  54
  55     Functions of XRegistryKey:
  56     <dl>
  57     <dt> <b>openKey</b>
  58     </dt>
  59     <dd> returns a virtual key which is specified in the local or the system
  60     registry.
  61     </dd>
  62     <dt> <b>deleteKey</b>
  63     </dt>
  64     <dd> deletes the key only if it is present in the local registry.
  65     </dd>
  66     <dt> <b>setLongValue, setAsciiValue, setStringValue, setBinaryValue</b>
  67     </dt>
  68     <dd> sets the value at the specified key in the local registry.
  69     </dd>
  70     <dt> <b>getLongValue, getAsciiValue, getStringValue, getBinaryValue</b>
  71     </dt>
  72     <dd> returns the value at the specified key in the local registry, or if
  73     the value is not present in the local registry, it will return the value of the
  74     system registry.
  75     </dd>
  76     <dt> <b>openKeys</b>
  77     </dt>
  78     <dd> returns a sequence of all subkeys in both registries.
  79     </dd>
  80     <dt> <b>getKeyNames</b>
  81     </dt>
  82     <dd> returns a sequence with the names of all subkeys in both registries.
  83     </dd>
  84     <dt>
  85     <b>Note: all write functions only work on the local registry.</b>
  86     </dt>
  87     </dl>
  88
  89     How to find the registries:
  90     <dl>
  91     <dt> search for the system registry:
  92     </dt>
  93     <dd> The system registry will always be searched in the same directory as the
  94     executable. The name of the system registry is "applicat.rdb". If the system
  95     registry was not found, then the environment variable STAR_REGISTRY will be checked.
  96     If this variable was set, it must contain a full path to a valid system registry.
  97     </dd>
  98     <dt>    Search for the user registry using the following rules:
  99     </dt>
 100     <dd>
 101     <ol>
 102     <li> 1. (for further use) search in sversion.ini (.sversionrc) for an entry
 103     REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section
 104     [Registry]. If found, then take this value instead of "user.rdb" as "REGISTRY NAME".
 105     </li>
 106     <li> 2. Search in the config directory of the user for a file "REGISTRY NAME". If
 107     found, return the full path and name of the file. If not found, retry this
 108     step with a dot before "REGISTRY NAME".
 109     </li>
 110     <li> 3. If not found, a new user registry with name user.rdb will be created in the user
 111     config directory.
 112     </li>
 113     </ol>
 114     </dd>
 115     </dl>
 116     <h4>Guarantees:</h4>
 117
 118     <ul>
 119     <li>-thread safe</li>
 120     </ul>
 121  */
 122 published service DefaultRegistry
 123 {
 124     interface com::sun::star::registry::XSimpleRegistry;
 125
 126 };
 127
 128
 129 }; }; }; };
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */