moved from api

1 files changed, 217 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/registry/DefaultRegistry.idl b/udkapi/com/sun/star/registry/DefaultRegistry.idl
new file mode 100644
index 000000000000..f41f83921ae2
--- /dev/null
+++ b/udkapi/com/sun/star/registry/DefaultRegistry.idl
@@ -0,0 +1,217 @@
+/*************************************************************************
+ *
+ *  $RCSfile: DefaultRegistry.idl,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: mi $ $Date: 2000-11-06 12:21:51 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_registry_DefaultRegistry_idl__
+#define __com_sun_star_registry_DefaultRegistry_idl__
+
+#ifndef __com_sun_star_registry_XSimpleRegistry_idl__
+#include <com/sun/star/registry/XSimpleRegistry.idl>
+#endif
+
+
+//=============================================================================
+
+ module com {  module sun {  module star {  module registry {
+
+//=============================================================================
+
+// DocMerge from xml: service com::sun::star::registry::DefaultRegistry
+/** implicitly supports a local registry and a read-only
+    system registry for global information.
+    In the context of this service,
+    the functions <code>open</code>, <code>close</code> and <code>destroy</code>
+    from <type>XSimpleRegistry</type> are not supported and throw an exception
+    if they are used.
+    <dl>
+    <dt>Functions of <type>XSimpleRegistry</type>:
+    <dl>
+    <dt>    <b>getURL</b>
+    </dt>
+    <dd> returns the name of the local registry.
+    </dd>
+    <dt>    <b>isValid</b>
+    </dt>
+    <dd> checks if the local registry is valid. If the interface is not <null></null>
+    the local registry should always be valid.
+    </dd>
+    <dt>    <b>isReadOnly</b>  </dt>
+    <dd> checks if the local registry has write protection.
+    </dd>
+    <dt>    <b>mergeKey</b>
+    </dt>
+    <dd> merges all information from the specified registry in the local registry.
+    </dd>
+    <dt>    <b>getRootKey</b>
+    </dt>
+    <dd> returns a virtual rootkey of both registries.
+    </dd>
+    </dl>
+
+    <br>
+
+    </dt>
+    <dt>Functions of XRegistryKey:
+    <dl>
+    <dt> <b>openKey</b>
+    </dt>
+    <dd> returns a virtual key which is specified in the local or the sytem
+    registry.
+    </dd>
+    <dt> <b>deleteKey</b>
+    </dt>
+    <dd> deletes the key only if it is present in the local registry.
+    </dd>
+    <dt> <b>setLongValue, setAsciiValue, setStringValue, setBinaryValue</b>
+    </dt>
+    <dd> sets the value at the specified key in the local registry.
+    </dd>
+    <dt> <b>getLongValue, getAsciiValue, getStringValue, getBinaryValue</b>
+    </dt>
+    <dd> returns the value at the specified key in the local registry, or if
+    the value is not present in the local registry, it will return the value of the
+    system registry.
+    </dd>
+    <dt> <b>openKeys</b>
+    </dt>
+    <dd> returns a sequence of all subkeys in both registries.
+    </dd>
+    <dt> <b>getKeyNames</b>
+    </dt>
+    <dd> returns a sequence with the names of all subkeys in both registries.
+    </dd>
+    <dt>
+    <br>
+    <b>Note: all write functions only work on the local registry.</b>
+    </dt>
+    </dl>
+
+    <br>
+
+    </dt>
+    <dt>How to find the registries:
+    <dl>
+    <dt> search for the system registry:
+    </dt>
+    <dd> The system registry will always be searched in the same directory as the
+    executable. The name of the system registry is "applicat.rdb". If the system
+    registry was not found, then the environment variable STAR_REGISTRY will be checked.
+    If this variable was set, it must contain a full path to a valid system registry.
+    </dd>
+    <dt>    Search for the user registry using the following rules:
+    </dt>
+    <dd>
+    <dl>
+    <dt> 1. (for further use) search in sversion.ini (.sversionrc) for an entry
+    REGISTRY_VERSION_STRING (example: UserRegistry 5.0/505=test.rdb) in the section
+    [Registry]. If found, then take this value instead of "user.rdb" as "REGISTRY NAME".
+    </dt>
+    <dt> 2. Search in the config directory of the user for a file "REGISTRY NAME". If
+    found, return the full path and name of the file. If not found, retry this
+    step with a dot before "REGISTRY NAME".
+    </dt>
+    <dt> 3. If not found, a new user registry with name user.rdb will be created in the user
+    config directory.
+    </dt>
+    </dl>
+    </dd>
+    </dl>
+    </dt>
+    </dl>
+    <h4>Guarantees:</h4>
+
+    <ul>
+    <li>-thread safe</li>
+    </ul>
+ */
+service DefaultRegistry
+{
+    // DocMerge: empty anyway
+    interface com::sun::star::registry::XSimpleRegistry;
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+/*=============================================================================
+
+    $Log: not supported by cvs2svn $
+    Revision 1.1  2000/11/03 15:07:29  mi
+    moved from api module
+
+    Revision 1.1.1.1  2000/09/18 23:35:32  hjs
+    initial import
+
+    Revision 1.5  2000/09/11 11:52:37  mi
+    documentation merged from XML
+
+    Revision 1.3  2000/02/23 11:41:16  mi
+    results from proofreading in layouted version
+
+    Revision 1.2  2000/02/21 10:55:48  mi
+    proofreading in layouted version
+
+    Revision 1.1.1.1  1999/11/11 09:48:44  jsc
+    new
+
+
+=============================================================================*/
+#endif