LibreOffice: com/sun/star/registry/XSimpleRegistry.idl Source File

LibreOffice LibreOffice 7.0 SDK API Reference

XSimpleRegistry.idl
Go to the documentation of this file.
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_XSimpleRegistry_idl__
20 #define __com_sun_star_registry_XSimpleRegistry_idl__
21
22 #include <com/sun/star/uno/XInterface.idl>
23 #include <com/sun/star/registry/InvalidRegistryException.idl>
24 #include <com/sun/star/registry/XRegistryKey.idl>
25 #include <com/sun/star/registry/MergeConflictException.idl>
26
27
28
29 module com { module sun { module star { module registry {
30
37 published interface XSimpleRegistry: com::sun::star::uno::XInterface
38 {
41 string getURL();
42
63 void open( [in] string rURL,
64 [in] boolean bReadOnly,
65 [in] boolean bCreate )
66 raises( com::sun::star::registry::InvalidRegistryException );
67
70 boolean isValid();
71
77 void close()
78 raises( com::sun::star::registry::InvalidRegistryException );
79
85 void destroy()
86 raises( com::sun::star::registry::InvalidRegistryException );
87
94 com::sun::star::registry::XRegistryKey getRootKey()
95 raises( com::sun::star::registry::InvalidRegistryException );
96
102 boolean isReadOnly()
103 raises( com::sun::star::registry::InvalidRegistryException );
104
119 void mergeKey( [in] string aKeyName,
120 [in] string aUrl )
121 raises( com::sun::star::registry::InvalidRegistryException,
122 com::sun::star::registry::MergeConflictException );
123
124 };
125
126
127 }; }; }; };
128
129 #endif
130
131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
com::sun::star::registry::XRegistryKey
makes structural information (except regarding tree structures) of a single registry key accessible.
Definition: XRegistryKey.idl:40
com::sun::star::registry::XSimpleRegistry::close
void close()
disconnects the registry from the data-source.
com::sun::star::registry::MergeConflictException
is thrown if entries of two registries are contradictory in the context of XSimpleRegistry::mergeKey(...
Definition: MergeConflictException.idl:32
com::sun::star::registry::XSimpleRegistry::open
void open([in] string rURL, [in] boolean bReadOnly, [in] boolean bCreate)
connects the registry to a persistent data source represented by a URL.
XRegistryKey.idl
com::sun::star::registry::InvalidRegistryException
signals that the registry is invalid or an operation on the registry failed.
Definition: InvalidRegistryException.idl:32
MergeConflictException.idl
com
Definition: Ambiguous.idl:22
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
com::sun::star::registry::XSimpleRegistry::isValid
boolean isValid()
checks if the registry points to a valid data-source.
InvalidRegistryException.idl
com::sun::star::registry::XSimpleRegistry::getURL
string getURL()
returns the URL of the current data source of the registry.
com::sun::star::registry::XSimpleRegistry
allows access to a registry (a persistent data source).
Definition: XSimpleRegistry.idl:38